Nwaku

Introduction

The nwaku 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 allow 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:

• Waku v1
• Waku v2

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

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 wakunode1 wakunode2

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

For more on how to run wakunode2, refer to:

• Run using binaries
• Run using docker
• Run using docker-compose

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 Waku Discord server.