33e9d8b9b2
* chore(rln-relay): refactor mounting procedure * fix(rln-relay): tests * fix(rln-relay|chat2): update mounting proc in chat2, fix args to mountRlnRelay * fix(rln-relay): remove stale todo |
||
|---|---|---|
| .github | ||
| apps | ||
| ci | ||
| docs | ||
| examples | ||
| metrics | ||
| migrations | ||
| tests | ||
| tools | ||
| vendor | ||
| waku | ||
| wrappers | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| LICENSE-APACHEv2 | ||
| LICENSE-MIT | ||
| Makefile | ||
| README.md | ||
| config.nims | ||
| env.sh | ||
| shell.nix | ||
| waku.nimble | ||
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
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
For more on how to run wakunode2, refer to:
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.
Tools
Different tools and their corresponding how-to guides can be found in the tools folder.
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.