Waku node instruction

System Requirements

For successful installation and operation of the Waku node, the following system requirements are recommended:

Component
Minimum Requirements
Recommended Requirements

OS

Ubuntu 18.04 or newer

Ubuntu 20.04 or newer

Processor

2 cores

4 cores

Memory

4 GB

8 GB

Disk

50 GB SSD

100 GB SSD

Prerequisites

Ensure that you have the following components installed:

  • Nim: The programming language used for Nwaku.

  • C Compiler, GNU Make, Bash, and Git: Essential tools for building the node.

Installation Steps

  1. Clone the Nwaku Repository:

    git clone https://github.com/waku-org/nwaku.git
    cd nwaku
  2. Build the Node:

    • First, update all Git submodules:

      make update
    • Then, build the node:

      make wakunode2
  3. Run the Node:

    • Start the node using DNS discovery:

      ./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL
    • To see available command-line options, use:

      ./build/wakunode2 --help

Configuration Options

Parameter
Description

Static Peers

Configure bootstrap nodes for initial connections.

DNS Discovery

Enable DNS-based peer discovery.

Discv5

Use the Discv5 mechanism for peer discovery.

Peer Exchange

Allow light nodes to request peers from your node.

Running in Docker

For simplicity, it is recommended to run the node using Docker Compose:

  1. Create a docker-compose.yml file with the necessary configuration.

  2. Start the node:

    docker-compose up -d

Monitoring and Interaction

You can interact with the running node via the REST API. For example, to get information about the node, use:

curl --location 'http://127.0.0.1:8545/debug/v1/info' --header 'Accept: application/json'

Last updated