Waku node and protocol.
Go to file
Daniel Kaiser ec0a46b65b
feat(jsonrpc): add ENR to debug_v1_info call (#918)
2022-03-30 15:10:15 +02:00
.github/workflows ci(windows): disable windows CI (#895) 2022-03-16 15:17:48 +02:00
ci ci: add commit as label to Docker image 2022-02-21 18:25:14 +01:00
docs docs(rpc-api-tutorial): fix broken links in JSON-RPC API tutorial (#920) 2022-03-29 15:40:11 +02:00
examples Tutorial for rln-relay live testnet (#898) 2022-03-18 15:51:26 -07:00
metrics Update default fleet metrics dashboard (#844) 2022-02-08 12:22:06 +01:00
tests feat(relay): add support for gossipsub peer exchange (#911) 2022-03-29 10:09:48 +02:00
vendor chore: update submodules (#905) 2022-03-23 15:20:07 +02:00
waku feat(jsonrpc): add ENR to debug_v1_info call (#918) 2022-03-30 15:10:15 +02: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 use discv5 feature branch in status-im/nim-eth (#884) 2022-03-11 15:51:14 +01:00
CHANGELOG.md fix(store): capacity limit for persistent message store (#900) 2022-03-28 20:27:14 +02:00
Dockerfile chore: bumps up the alpine version to 3.15 (#923) 2022-03-29 12:27:12 -07: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 chore(rln): add cleanrln make rule + docu (#910) 2022-03-25 16:08:13 +01:00
README.md docs: added bug reporting section to main readme (#912) 2022-03-28 14:17:50 +02:00
config.nims fix: building on Apple clang and M1 (#907) 2022-03-28 15:21:02 +02:00
env.sh Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
waku.nimble discv5 stage1 testnet (#863) 2022-03-01 17:12:23 +01: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.

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.