7.3 KiB
| title | hide_table_of_contents |
|---|---|
| Run a Nwaku Node | true |
Nwaku is a lightweight and robust Nim client for running a Waku node, equipped with tools to monitor and maintain a running node. Nwaku is highly configurable, enabling operators to select the protocols they want to support based on their needs, motivations, and available resources.
This guide provides detailed steps to download, build, configure, and connect a nwaku node to the Waku Network. It also includes interacting with the node and finding its addresses.
:::info
We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient.
:::
Get the node binary
To run a node, you must have the nwaku binary. Nwaku provides multiple options for running a node:
Run nwaku in Docker (recommended)
We recommend using Docker Compose to run a node because it's the simplest and fastest way to configure and run one:
| Description | Documentation | |
|---|---|---|
| Docker Compose | Run a nwaku node with Docker Compose |
Run Nwaku with Docker Compose |
| Docker Container | Run a nwaku node in a Docker Container |
Run Nwaku in a Docker Container |
Download the binary
| Description | Documentation | |
|---|---|---|
| Precompiled Binary | Download a precompiled binary of the nwaku node |
Download Nwaku Binary |
| Nightly Release | Try the latest nwaku updates without compiling the binaries |
Download Nightly Release |
Build the binary
| Description | Documentation | |
|---|---|---|
| Build from Source | Build the node from the nwaku source code | Build Nwaku from Source |
:::tip
You can run the nwaku binaries and Docker images on cloud service providers like Google Cloud, Microsoft Azure, Amazon Web Services, and DigitalOcean.
:::
Run the node
Once you have gotten the nwaku binary, run it using the default configuration:
# Run the Docker Compose
docker-compose up -d
# Run the standalone binary
./build/wakunode2
:::tip
To learn how to customise the configuration of a nwaku node, have a look at the Node Configuration Methods and Node Configuration Examples guides.
:::
Bootstrap the node
To join the Waku Network, nodes must bootstrap for an entry point before discovering more peers. Nwaku provides multiple peer discovery mechanisms:
| Description | Documentation | |
|---|---|---|
| Static Peers | Configure the bootstrap nodes that nwaku should establish connections upon startup |
Configure Static Peers |
| DNS Discovery | Enable nwaku to bootstrap nodes using the DNS Discovery mechanism |
Configure DNS Discovery |
| Discv5 | Enable nwaku to discover peers using the Discv5 mechanism |
Configure Discv5 |
| Peer Exchange | Enable Peer Exchange protocol for light nodes to request peers from your nwaku node |
Configure Peer Exchange |
:::tip We suggest configuring WebSocket transport for your node to enable support and serving of browser peers using @waku/sdk. :::
Interact with the node
You can interact with a running nwaku node through the REST API, such as querying the node information using the Get node info endpoint:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
curl --location 'http://127.0.0.1:8645/debug/v1/info' \
--header 'Accept: application/json'
{
"listenAddresses": [
"/ip4/0.0.0.0/tcp/60000/p2p/16Uiu2HAmUbPquFQqje3jiqoB5YoiUbBya59NB4qqEzeiTNGHeA6w"
],
"enrUri": "enr:-Iu4QCQZXZDb_JsYmLoYor0F5E_95HbIywgO_wgx2rIdDbmCJZkTzmlCr0wmMzV47lgik_tVwww5mIng90Ris83TisMBgmlkgnY0gmlwhAAAAACJc2VjcDI1NmsxoQPszztG-Ev52ZB7tk0jF8s6Md4KvyY_rhzNZokaaB_ABIN0Y3CC6mCFd2FrdTIB"
}
:::info
The listenAddresses field stores the node's listening addresses, while the enrUri field stores the discoverable ENR URI for peer discovery.
:::
Check the node health status
You can check the health status of the node by calling the Get node health status endpoint of the REST API:
curl --location 'http://127.0.0.1:8645/health' \
--header 'Accept: text/plain'
Node is healthy
:::tip If you encounter issues running your node or require assistance with anything, please visit the #node-help channel on our Discord. :::
:::tip Congratulations!
You have successfully started, configured, and connected a nwaku node to the Waku Network. Have a look at the Node Configuration Examples guide to learn how to configure nwaku for different use cases.
:::