waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Waku node and protocol.
449 Commits 134 Branches 45 Tags 708 MiB
Nim 98.9%
Shell 0.3%
Makefile 0.3%
Groovy 0.2%
Python 0.1%
Other 0.1%
Go to file
Sanaz Taheri Boshrooyeh 696f41e12a
Rln-Relay: Change tree depth to 20 (#726) 
* adds instructions on how to generate parameters for a different tree size

* updates the depth of tree

* modifies the Merkle root

* updates parameters for the new tree size

* fixes failing tests

* updates the comment
 		2021-09-28 12:03:53 -07:00
.github/workflows Add GH project board automation (#666) 2021-07-15 13:49:50 +08:00
ci ci: build and test only what changed 2021-07-02 11:09:09 +02:00
docs Add basic tutorial for Waku v2 DNS-based discovery (#711) 2021-08-30 11:08:00 +02:00
examples Restructuring Rln-Relay mounting process (#722) 2021-09-24 10:32:45 -07:00
metrics Added waku fleet dashboard (#704) 2021-08-19 09:57:53 +02:00
tests Rln-Relay: Change tree depth to 20 (#726) 2021-09-28 12:03:53 -07:00
vendor Integrate DNS resolution (#709) 2021-08-25 13:57:35 +02:00
waku Rln-Relay: Change tree depth to 20 (#726) 2021-09-28 12:03:53 -07:00
wrappers Refactor wakunode2.nim (#664) 2021-07-14 19:58:46 +02:00
.dockerignore add a Dockerfile for creating nim-waku images 2020-05-27 12:51:20 +02:00
.gitignore Improve libwaku and C wrappers (#613) 2021-06-13 20:50:10 +08:00
.gitmodules Integrate DNS resolution (#709) 2021-08-25 13:57:35 +02:00
CHANGELOG.md Add basic tutorial for Waku v2 DNS-based discovery (#711) 2021-08-30 11:08:00 +02:00
Dockerfile Fix: Remove rln file from Docker image (#606) 2021-06-10 09:18:52 +02:00
LICENSE-APACHEv2 Fix name in licence (#517) 2021-04-28 20:00:45 +10:00
LICENSE-MIT Fix name in licence (#517) 2021-04-28 20:00:45 +10:00
Makefile Whisper tests (#678) 2021-07-19 17:54:36 +08:00
README.md Remove PCRE dependency from general Waku Prerequisites 2021-06-17 14:43:10 +02:00
config.nims Remove the need for pcre (#623) 2021-06-15 09:51:09 +02:00
env.sh Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
waku.nimble Whisper tests (#678) 2021-07-19 17:54:36 +08:00

README.md

nim-waku

Introduction

The nim-waku repository implements Waku v1 and v2, and provides tools related to it.

  • A Nim implementation of the Waku v1 protocol.
  • A Nim implementation of the Waku v2 protocol.
  • CLI applications wakunode and wakunode2 that allows you to run a Waku v1 or v2 node.
  • Examples of Waku v1 and v2 usage.
  • Various tests of above.

For more details on Waku v1 and v2, see their respective home folders:

How to Build & Run

These instructions are generic and apply to both Waku v1 and v2. For more detailed instructions, see Waku v1 and v2 home above.

Prerequisites

  • GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
  • Rust

More information on the installation of these can be found here.

Wakunode

# The first `make` invocation will update all Git submodules.
# You'll run `make update` after each `git pull`, in the future, to keep those submodules up to date.
make wakunode1 wakunode2

# See available command line options
./build/wakunode --help
./build/wakunode2 --help

# Connect the client directly with the Status test fleet
./build/wakunode --log-level:debug --discovery:off --fleet:test --log-metrics
# TODO Equivalent for v2

Waku Protocol Test Suite

# Run all the Waku v1 and v2 tests
make test

Examples

Examples can be found in the examples folder. For Waku v2, there is a fully featured chat example.