nwaku-compose

Ready to use docker-compose to run your own nwaku full node:

• nwaku node running relay and store protocols with RLN enabled.
• Simple frontend to interact with your node and the network, to publish and receive messages.
• Grafana dashboard for advanced users or node operators.
• Requires docker-compose and git.

Setup and Run

📝 0. Prerequisites

You need:

• Linea Sepolia HTTP endpoint. Get one free from Infura.
• Linea Sepolia account with some balance <0.01 Eth.
• You can get some Linea Sepolia here
• If you have ETH on Sepolia, it can be bridged to Linea Sepolia here.
• A password to protect your rln membership.

docker-compose will read the ./.env file from the filesystem. There is .env.example available for you as a template to use for providing the above values. The process when working with .env files is to copy the .env.example, store it as .env and edit the values there.

cp .env.example .env
${EDITOR} .env

Make sure to NOT place any secrets into .env.example, as they might be unintentionally published in the Git repository.

EXPERIMENTAL - Use wizard script

Run the wizard script. Once the script is done, the node will be started for you, so there is nothing else to do.

The script is experimental, feedback and pull requests are welcome.

./setup_wizard.sh

🔑 1. Register RLN membership

Note: If upgrading from less than v0.36.0, run the following commands before proceeding with the registration:

sudo rm -r rln_tree
sudo rm keystore/keystore.json

The RLN membership is your access key to The Waku Network. Its registration is done on-chain, allowing your nwaku node to send messages in a decentralized and private way, respecting some rate limits. Other peers won't relay messages that exceed the rate limit.

Recommended: Register via rln.waku.org

To register for RLN membership and generate your keystore:

1. Visit https://rln.waku.org.
2. Follow the instructions to register your membership and generate a keystore.json file.
3. Download the generated keystore.json and place it in the keystore/ directory of your nwaku-compose setup (i.e., at keystore/keystore.json).

Alternative: Register locally

You can also register your membership using the provided script, which will store it in keystore/keystore.json. Note that if you just want to relay traffic (not publish), you don't need to perform the registration.

Before registering you need to mint and approve the tokens to pay for the registration. The simplest way is using Foundry's cast tool, which you can install with:

curl -L https://foundry.paradigm.xyz | bash
foundryup

Mint the token used to pay for RLN Membership registration from your Linea Sepolia account (This is a generic ERC20 token used for testnet only): The amount of "5000000000000000000" is how much is needed to register with a rln-relay-user-message-limit of 100

cast send $TOKEN_CONTRACT_ADDRESS "mint(address,uint256)" $ETH_TESTNET_ACCOUNT 5000000000000000000 --private-key $ETH_TESTNET_KEY --rpc-url $RLN_RELAY_ETH_CLIENT_ADDRESS

Approve the RLN contract to spend tokens on behalf of your account:

cast send $TOKEN_CONTRACT_ADDRESS "approve(address,uint256)" $RLN_CONTRACT_ADDRESS 5000000000000000000 --private-key $ETH_TESTNET_KEY --rpc-url $RLN_RELAY_ETH_CLIENT_ADDRESS

This command will register your membership and store it in keystore/keystore.json:

./register_rln.sh

💽 2. Select DB Parameters

Waku runs a PostgreSQL Database to store messages from the network and serve them to other peers. To prevent the database to grow indefinitely, you need to select how much disk space to allocate. You can either run a script that will estimate and set a good value:

./set_storage_retention.sh

Or select your own value. For example, 50GB:

echo "STORAGE_SIZE=50GB" >> .env

Depending on your machine's memory, it may be worth allocating more memory to the Postgres container to ensure heavy queries are served:

./set_postgres_shm.sh

Or select your own value manually, for example, 4g:

echo "POSTGRES_SHM=4g" >> .env

🖥️ 3. Start your node

Start all processes: nwaku node, database and grafana for metrics. Your RLN membership is loaded into nwaku under the hood.

docker-compose up -d

⚠️ The node might take a few minutes the very first time it runs because it needs to build locally the RLN community membership tree.

###🏄🏼‍♂️ 4. Interact with your nwaku node

• See localhost:3000 for node metrics.
• See localhost:4000 for a nice frontend to chat with other users.

📬 4. Use the REST API

Your nwaku node exposes a REST API to interact with it.

# get nwaku version
curl http://127.0.0.1:8645/debug/v1/version
# get nwaku info
curl http://127.0.0.1:8645/debug/v1/info

Publish a message to a contentTopic. Everyone subscribed to it will receive it. Note that payload is base64 encoded.

curl -X POST "http://127.0.0.1:8645/relay/v1/auto/messages" \
 -H "content-type: application/json" \
 -d '{"payload":"'$(echo -n "Hello Waku Network - from Anonymous User" | base64)'","contentTopic":"/my-app/2/chatroom-1/proto"}'

Get messages sent to a contentTopic. Note that any store node in the network is used to reply.

curl -X GET "http://127.0.0.1:8645/store/v1/messages?contentTopics=%2Fmy-app%2F2%2Fchatroom-1%2Fproto&pageSize=50&ascending=true" \
 -H "accept: application/json"

For advanced documentation, refer to ADVANCED.md.

---

How to update to latest version

We regularly announce new available versions in our Discord server.

From v0.29 or older

You will need to delete both the keystore and rln_tree folders, and register your membership again before using the new version by running the following commands:

1. cd nwaku-compose ( go into the root's repository folder )
2. docker-compose down
3. sudo rm -r keystore rln_tree
4. git pull origin master
5. ./register_rln.sh
6. docker-compose up -d

From v0.30 or newer

Updating the node is as simple as running the following:

1. cd nwaku-compose ( go into the root's repository folder )
2. docker-compose down
3. git pull origin master
4. docker-compose up -d

Set size

To improve storage on the network, you can increase the allocated space for the database. To do so, you can simply run:

./set_storage_retention.sh

Check

Once done, check your node is healthy:

./chkhealth.sh 

All good:

02:15:51 - node health status is:

{
  "nodeHealth": "Ready",
  "protocolsHealth": [
    {
      "Rln Relay": "Ready"
    }
  ]
}

If the ./chkhealth.sh script is hanging or returns the following, wait a few minutes and run it again:

02:17:57 - node health status is:

{
  "nodeHealth": "Initializing",
  "protocolsHealth": []
}

Clean-up

Docker artefact can take some precious disk space, run the following commands to free space while your node is running.

Only do this if this machine is solely used for Waku and you have no other docker services.

I repeat, this will clean other docker services and images not running, only do this if this machine is only used for Waku.

# Be sure that your containers **are running**
sudo docker-compose up -d

# Clean docker system files
sudo docker system prune -a

# Delete docker images
sudo docker image prune -a

# Delete docker containers
sudo docker container prune

# Delete docker volumes
sudo docker volume prune

journal

If your /var/log gets quite large:

journalctl --disk-usage
> Archived and active journals take up 1.5G in the file system.

You can cap the size in /etc/systemd/journald.conf with

SystemMaxUse=50M

then restart to apply

systemctl restart systemd-journald

and verify

journalctl --disk-usage
> Archived and active journals take up 55.8M in the file system.

---

FAQ

see