3befd514e9
* adds wakunode2_types * removes unused imports * adds dynamic rln relay config options * deletes unused imports * replaces static rln-relay with both modes * introduces spamHandler parameter to mountRlnRelay * some debugging info * introduces the config option * adds the eth priv key to the register proc * refactors the code by adding eth private key to the relevant procs * revises config descriptions * minor wording fix * make a minor edit * further edits * adds Eth private key to the config options * calls spam handler when to rln credential is given * defaults to none for the spam handler * updates the membership fee to match the contract * fixes an issue for event subscription * adds eth private key to the transactions made in the tests * adds eth private key for the test of register process * adds comments * deletes lingering echo * displays registration info * removes an echo * removes Goerli testnet from the config descriptions * removes an excess space
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.
Bugs, Questions & Features
For an inquiry, or if you would like to propose new features, feel free to open a general issue.
For bug reports, please tag your issue with the bug label.
If you believe the reported issue requires critical attention, please use the critical label to assist with triaging.
To get help, or participate in the conversation, join the Vac Discord server.