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.
885 Commits 134 Branches 45 Tags 708 MiB
Nim 98.9%
Shell 0.3%
Makefile 0.3%
Groovy 0.2%
Python 0.1%
Other 0.1%
Go to file
Aaryamann Challani 33e9d8b9b2
chore(rln-relay): refactor mounting procedure (#1457) 
* chore(rln-relay): refactor mounting procedure

* fix(rln-relay): tests

* fix(rln-relay|chat2): update mounting proc in chat2, fix args to mountRlnRelay

* fix(rln-relay): remove stale todo
 		2022-12-13 14:56:24 +05:30
.github fix(ci): remove nim doc action temporarily (#1456) 2022-12-12 16:52:46 +05:30
apps chore(rln-relay): refactor mounting procedure (#1457) 2022-12-13 14:56:24 +05:30
ci fix(jenkins): fix typo 2022-12-06 01:18:33 +01:00
docs chore(docs): add docker-compose instructions (#1444) 2022-12-05 16:25:37 +01:00
examples feat(wakunode2): support log format format selection 2022-12-07 12:30:32 +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 chore(rln-relay): refactor mounting procedure (#1457) 2022-12-13 14:56:24 +05:30
tools chore(networkmonitor): Add DNS discovery (#1446) 2022-12-05 20:02:21 +01:00
vendor feat(wakunode2): support log format format selection 2022-12-07 12:30:32 +01:00
waku chore(rln-relay): refactor mounting procedure (#1457) 2022-12-13 14:56:24 +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 feat(rln): use zerokit as static lib (#1385) 2022-12-06 00:33:03 +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 fix(ci): remove nim doc action temporarily (#1456) 2022-12-12 16:52:46 +05:30
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 feat(wakunode2): support log format format selection 2022-12-07 12:30:32 +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.