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.
814 Commits 134 Branches 46 Tags 708 MiB
Nim 98.9%
Shell 0.3%
Makefile 0.3%
Groovy 0.2%
Python 0.1%
Other 0.1%
Go to file
G 17d71faf67
chore(rln): update ganache (#1347) 
* chore: build rln dependecies only when building v2

* chore(rln): deprecate ganache-cli; move installation from makefile to test + uninstall; gracefully terminate ganache

* chore: add package.json to gitignore

* fix(rln): move ganache package to build folder and remove package once uninstalled

* refactor(rln): (un)install/run/stop ganache with separate procs

Co-authored-by: Lorenzo Delgado <lorenzo@status.im>
Co-authored-by: Aaryamann Challani <43716372+rymnc@users.noreply.github.com>
 		2022-11-08 14:28:11 +01:00
.github ci: run ci test workflows selectively 2022-10-20 18:44:22 +02:00
apps fix(rln-relay): remove dependency on applications' configuration 2022-11-08 12:53:47 +01:00
ci ci(jenkins): use MAKEFLAGS and NIMFLAGS pipeline params in build and test stages 2022-10-25 16:58:52 +02:00
docs docs(operator-trial): add rln instructions (#1311) 2022-10-31 21:07:15 +05:30
examples chore: rename protocols rpc_codec procs from init to decode 2022-11-07 16:24:16 +01:00
metrics feat(rln-relay): add metrics dashboard (#1275) 2022-10-19 15:08:15 +05:30
migrations chore(migrations): move migration scripts to project root 2022-11-03 17:58:05 +01:00
tests chore(rln): update ganache (#1347) 2022-11-08 14:28:11 +01:00
tools chore: build rln dependecies only when building v2 2022-11-07 09:14:21 +01:00
vendor fix: replace nim's std/nre with nim-regex library 2022-11-02 15:55:09 +01:00
waku fix(rln-relay): remove dependency on applications' configuration 2022-11-08 12:53:47 +01: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 chore(rln): update ganache (#1347) 2022-11-08 14:28:11 +01:00
.gitmodules fix: replace nim's std/nre with nim-regex library 2022-11-02 15:55:09 +01:00
CHANGELOG.md docs: release v0.12.0 (#1231) 2022-10-06 17:29:58 +01:00
Dockerfile ci: fix path to migrations in Dockerfile 2022-11-04 13:37:02 +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 chore(rln): update ganache (#1347) 2022-11-08 14:28:11 +01:00
README.md chore(wakucanary): add canary tool (#1205) 2022-10-11 05:58:44 +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
shell.nix feat(store): simplify wakunode2 configuration options 2022-10-26 17:10:30 +02:00
waku.nimble chore(examples): add pubsub example with production env (#1333) 2022-11-04 13:40:24 +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.

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.