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.
563 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
Daniel Kaiser 51cbc39d49
feat(config): add config file support (#953) 
including

* bump vendor/nim-confutils
* add nim-toml-serialization submodule
* feat(config): add example config file
* add new feature to CHANGELOG
 		2022-05-17 17:48:08 +02:00
.github/workflows fix: release assets do not work (#926) 2022-03-30 17:29:12 +02:00
ci fix(Jenkins): remove caching (#945) 2022-04-19 12:51:27 +02:00
docs docs(rpc-api-tutorial): fix broken links in JSON-RPC API tutorial (#920) 2022-03-29 15:40:11 +02:00
examples feat(config): add config file support (#953) 2022-05-17 17:48:08 +02:00
metrics Update default fleet metrics dashboard (#844) 2022-02-08 12:22:06 +01:00
tests chore|feat (waku-rln-relay): modules reorganization|Initial test for capturing events using nim-web3 (#941) 2022-05-10 14:09:18 -07:00
vendor feat(config): add config file support (#953) 2022-05-17 17:48:08 +02:00
waku feat(config): add config file support (#953) 2022-05-17 17:48:08 +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 feat(config): add config file support (#953) 2022-05-17 17:48:08 +02:00
CHANGELOG.md feat(config): add config file support (#953) 2022-05-17 17:48:08 +02:00
Dockerfile feat: make the rln-relay protocol available in the waku docker image (#924) 2022-03-31 13:15:00 -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 feat(jsonrpc): add call returning git version (#919) 2022-03-30 17:17:21 +02: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 Nimble fix: The repo doesn't use a src folder 2022-05-12 14:25:02 +03: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.