waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Waku node and protocol.
874 Commits 149 Branches 46 Tags 1.2 GiB
Nim 98.8%
Shell 0.4%
Makefile 0.2%
Python 0.2%
Groovy 0.2%
Other 0.1%
Go to file
Alvaro Revuelta a7a87f1f10
chore(networkmonitor): Add DNS discovery (#1446) 
* chore(networkmonitor): add dns disc to networkmonitor tool

* chore(networkmonitor): decouple ip api calls from main loop

* chore(networkmonitor): add timeout flag
 		2022-12-05 20:02:21 +01:00
.github ci: merge test1 and tes2 github workflows 2022-12-01 14:33:59 +01:00
apps chore(networkmonitor): Add DNS discovery (#1446) 2022-12-05 20:02:21 +01:00
ci ci(jenkins): split dockerfile into production and experimental stages 2022-12-01 12:45:06 +01:00
docs chore(docs): add docker-compose instructions (#1444) 2022-12-05 16:25:37 +01:00
examples refactor: reuse nim-libp2p peerstore + move peermanager logic (#1383) 2022-11-24 14:11:23 +01:00
metrics chore(metrics): add plot with traffic + update to latest grafana dashboard (#1433) 2022-11-29 16:15:55 +01:00
migrations chore(migrations): move migration scripts to project root 2022-11-03 17:58:05 +01:00
tests feat(peerstore): store peer direction (#1424) 2022-11-29 17:35:25 +01:00
tools chore(networkmonitor): Add DNS discovery (#1446) 2022-12-05 20:02:21 +01:00
vendor chore(deps): upgrade nim-eth to latest version 2022-11-30 16:12:58 +01:00
waku chore(rln-relay): re-enable root validation (#1445) 2022-12-05 23:52:54 +05:30
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
.editorconfig chore: add editorconfig file 2022-11-21 09:31:03 +01:00
.gitignore feat(rln-relay): process blocks atomically (#1349) 2022-11-10 22:28:31 +05:30
.gitmodules fix: replace nim's std/nre with nim-regex library 2022-11-02 15:55:09 +01:00
CHANGELOG.md docs: release v0.13.0 (#1378) 2022-11-15 11:17:34 +02:00
Dockerfile ci(jenkins): split dockerfile into production and experimental stages 2022-12-01 12:45:06 +01: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 ci(jenkins): split dockerfile into production and experimental stages 2022-12-01 12:45:06 +01:00
README.md chore(docs): add docker-compose instructions (#1444) 2022-12-05 16:25:37 +01: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
shell.nix feat(store): simplify wakunode2 configuration options 2022-10-26 17:10:30 +02:00
waku.nimble chore(networkmonitor): tool to discover and provide metrics on peers (#1290) 2022-11-10 10:29:34 +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

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.