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 ( Linux, MacOS & WSL )

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

# Build with custom compilation flags. Do not use NIM_PARAMS unless you know what you are doing.
# Replace with your own flags
make wakunode2 NIMFLAGS="-d:chronicles_colors:none -d:disableMarchNative"

# Run with DNS bootstrapping
./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL

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

To join the network, you need to know the address of at least one bootstrap node. Please refer to the Waku README for more information.

For more on how to run wakunode2, refer to:

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

Issues

WSL

If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the /mnt/ directory.

How to Build & Run ( Windows )

Note: This is a work in progress. The current setup procedure is as follows: Goal: Get rid of windows specific procedures and make the build process the same as linux/macos.

The current setup procedure is as follows:

1. Clone the repository and checkout master branch
2. Ensure prerequisites are installed (Make, GCC, MSYS2/MinGW)
3. Run scripts/windows_setup.sh

Developing

Nim Runtime

This repository is bundled with a Nim runtime that includes the necessary dependencies for the project.

Before you can utilise the runtime you'll need to build the project, as detailed in a previous section. This will generate a vendor directory containing various dependencies, including the nimbus-build-system which has the bundled nim runtime.

After successfully building the project, you may bring the bundled runtime into scope by running:

source env.sh

If everything went well, you should see your prompt suffixed with [Nimbus env]$. Now you can run nim commands as usual.

Waku Protocol Test Suite

# Run all the Waku tests
make test

Building single test files

During development it is handful to build and run a single test file. To support this make has a specific target:

targets:

• build/<relative path to your test file.nim>
• test/<relative path to your test file.nim>

Binary will be created as <path to your test file.nim>.bin under the build directory .

# Build and run your test file separately
make test/tests/common/test_enr_builder.nim

Formatting

Nim files are expected to be formatted using the nph version present in vendor/nph.

You can easily format file with the make nph/<relative path to nim> file command. For example:

make nph/waku/waku_core.nim

A convenient git hook is provided to automatically format file at commit time. Run the following command to install it:

make install-nph

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.

Docs

• REST API Documentation