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.
291 Commits 150 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
Hanno Cornelius 307a49bb78
Fix Docker image - missing librln.so file (#406) 		2021-03-04 17:55:27 +02:00
.github/workflows Update docs.yml 2020-12-21 12:34:30 +01:00
docs Further chat2 improvements (#405) 2021-03-04 09:19:21 +02:00
examples Further chat2 improvements (#405) 2021-03-04 09:19:21 +02:00
metrics Fixed grafana dashboard to view Waku v2 metrics (#357) 2021-02-03 17:49:34 +02:00
tests Swap redeem cheque and update accounting state accordingly (#397) 2021-03-01 13:55:20 +08:00
vendor Adds rln as a submodule (#402) 2021-03-02 12:57:48 -08:00
waku Further chat2 improvements (#405) 2021-03-04 09:19:21 +02:00
.dockerignore add a Dockerfile for creating nim-waku images 2020-05-27 12:51:20 +02:00
.gitignore chat2 improvements (#403) 2021-03-03 10:40:19 +02:00
.gitmodules Adds rln as a submodule (#402) 2021-03-02 12:57:48 -08:00
CHANGELOG.md Removed local peer sets for filter, swap and store (#375) 2021-02-11 10:58:25 +02:00
Dockerfile Fix Docker image - missing librln.so file (#406) 2021-03-04 17:55:27 +02:00
Jenkinsfile ci: add MAKE_TARGET parameter, remove default from IMAGE_TAG 2020-12-04 11:18:31 +01:00
LICENSE-APACHEv2 Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
LICENSE-MIT Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
Makefile Adds rln as a submodule (#402) 2021-03-02 12:57:48 -08:00
README.md Folder restructure (#274) 2020-11-17 17:34:53 +08:00
config.nims bump vendor/nimbus-build-system (#36) 2020-07-01 09:43:23 +02:00
env.sh Set up repo to make use of nimbus-build-system 2020-05-01 11:29:16 +02:00
waku.nimble chat2 improvements (#403) 2021-03-03 10:40:19 +02: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.
  • PCRE

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.