115982f5c3
* Persisting Credentials implemented by writing json of keypair and rlnindex to files
* Removing testing files and ignores
* Update waku/v2/protocol/waku_rln_relay/waku_rln_relay_utils.nim
Co-authored-by: Daniel Kaiser <git@kais3r.de>
* Update waku/v2/protocol/waku_rln_relay/waku_rln_relay_utils.nim
Co-authored-by: Daniel Kaiser <git@kais3r.de>
* Comments
* Comments
* Security warning in comments
* Redundant echos. Omitting unused variables.
* Update waku/v2/protocol/waku_rln_relay/waku_rln_relay_utils.nim
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
* Limit line lengths using line breaks and indents
* Membership file paths declared as const
* Const fix
* Rln Credentials Merged.
Reading credentials from file abstracted away.
* Spaces
* Spaces
* Dangling constants removed. Comments position.
* Import sequence.
* Path as argument to readPersistentKeys.
Spaces in comments
* readPersistentKeys test
* Debug and info
* Index check in test
* Update tests/v2/test_waku_rln_relay.nim
Co-authored-by: G. <28568419+s1fr0@users.noreply.github.com>
* Abstracted writeRlnCredentials.
Fix var name in test.
* Usage of writeRlnCredentials in test
* Dnsclient?
* Test reverted to direct call to writeFile.
Abstrated writePersistentRlnCredentials usage causing error,
with readPersistentRlnCredentials
* Indentation
* Revert "Dnsclient?"
This reverts commit
|
||
---|---|---|
.github | ||
ci | ||
docs | ||
examples | ||
metrics | ||
tests | ||
vendor | ||
waku | ||
wrappers | ||
.dockerignore | ||
.gitignore | ||
.gitmodules | ||
CHANGELOG.md | ||
Dockerfile | ||
LICENSE-APACHEv2 | ||
LICENSE-MIT | ||
Makefile | ||
README.md | ||
config.nims | ||
env.sh | ||
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
wakunode
andwakunode2
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.
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.