Waku node and protocol.
Go to file
Alvaro Revuelta ea31b531b5
Add utils to Dockerfile (#1991)
2023-09-05 15:50:54 +02:00
.github chore(ci): use commit instead of master for docker image (#1990) 2023-09-05 11:58:01 +02:00
.sv4git/templates feat: add release-notes target (#1734) 2023-05-18 14:45:45 +02:00
apps feat(relay): ordered validator execution (#1966) 2023-09-05 14:35:07 +05:30
ci chore: remove references to v2 (#1898) 2023-08-09 18:11:50 +01:00
docker/binaries Add utils to Dockerfile (#1991) 2023-09-05 15:50:54 +02:00
docs Removing bridge.md tutorial as v1 doc was removed (#1954) 2023-08-28 10:09:42 +02:00
examples chore(cbindings): Thread-safe libwaku. WakuNode instance created directly from the Waku Thread (#1957) 2023-09-01 08:37:02 +02:00
library chore(cbindings): Thread-safe libwaku. WakuNode instance created directly from the Waku Thread (#1957) 2023-09-01 08:37:02 +02:00
metrics chore(rln-relay): update metrics dashboard (#1745) 2023-05-19 16:24:53 +05:30
migrations chore(migrations): move migration scripts to project root 2022-11-03 17:58:05 +01:00
scripts fix(rln-relay): bump zerokit to v0.3.2 (#1951) 2023-08-25 13:44:57 +05:30
tests feat(relay): ordered validator execution (#1966) 2023-09-05 14:35:07 +05:30
tools/rln_keystore_generator chore(rln-keystore-generator): log out the membership index upon registration (#1963) 2023-08-30 11:50:20 +05:30
vendor fix(rln-relay): bump zerokit to v0.3.2 (#1951) 2023-08-25 13:44:57 +05:30
waku feat(relay): ordered validator execution (#1966) 2023-09-05 14:35:07 +05:30
.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: Rest API interface for legacy (v1) filter service. (#1851) 2023-08-04 11:34:22 +02:00
.gitmodules fix(rln-relay): bump zerokit to v0.3.2 (#1951) 2023-08-25 13:44:57 +05:30
.sv4git.yml chore(ci): extend and rename nightly workflow to support RC builds (#1784) 2023-06-08 17:13:40 +02:00
CHANGELOG.md chore(release): update changelog for delayed v0.19.0 release (#1911) 2023-08-16 14:44:33 +02:00
Dockerfile Dockerfile: forcing a particular heaptrack version to avoid build issues (#1979) 2023-09-01 08:17:12 +02: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(Makefile): invalid path to crate build (#1981) 2023-09-01 16:50:55 +05:30
README.md chore: remove Waku v1 and wakubridge code (#1874) 2023-08-07 15:11:46 +01:00
config.nims chore(ci): properly set os and architecture for nightly and release (#1780) 2023-06-06 17:41:41 +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(rln): init rln_keystore_generator (#1925) 2023-08-22 19:53:05 +05:30

README.md

Nwaku

Introduction

The nwaku repository implements Waku, and provides tools related to it.

  • A Nim implementation of the Waku (v2) protocol.
  • CLI application wakunode2 that allows you to run a Waku node.
  • Examples of Waku usage.
  • Various tests of above.

For more details see the source code

How to Build & Run

These instructions are generic. For more detailed instructions, see the Waku source code above.

Prerequisites

The standard developer tools, including a C compiler, GNU Make, Bash, and Git. More information on these installations 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 updated.
make wakunode2

# See available command line options
./build/wakunode2 --help

For more on how to run wakunode2, refer to:

Waku Protocol Test Suite

# Run all the Waku tests
make test

Examples

Examples can be found in the examples folder. This includes 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 Waku Discord server.