mirror of
https://github.com/waku-org/nwaku.git
synced 2025-02-05 03:25:04 +00:00
a5f8b90c23
* compiles RLN if CI is defined * minor ineffective change * minor * removes excess space * resolves namespace conflicts * moves pubsub import under compiler flag * disables rln on-chain tests * brings back the on-chain tests and fixes a name mismatch * adds a debug log message * minor formating * kills ganache-cli procces on windows * wip: adds a line to kill ganache-cli on windows * disables rln-relay tests that depend on ganache-cli * disables ganache-cli installation * introduces onchain rln flag * fixes a flaky test * enables onchain test in non-windows CIs * moves variables around it seems detected_os is undefined, hence the compiler flag onchain_rln, which is conditioned to the os, does not get added * limits onchain rln to macOS
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
wakunodeandwakunode2that 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.