waku-simulator/README.md

nwaku-simulator

Requires

• docker
• docker-compose

How to run

git clone https://github.com/waku-org/waku-simulator.git
cd waku-simulator

Configure the simulation parameters. You can place the env variable in an .env file.

export GOWAKU_IMAGE=statusteam/go-waku:latest
export NWAKU_IMAGE=statusteam/nim-waku:v0.18.0-rc.0
export NUM_NWAKU_NODES=5
export NUM_GOWAKU_NODES=5
export MSG_PER_SECOND=10
export MSG_SIZE_KBYTES=10
docker-compose up -d

This will:

• spin up grafana/prometheus for monitoring, see http://localhost:3000.
• spin up a bootstrap nwaku node.
• spin up a given amount of nwaku/gowaku nodes with specific versions.
• spin up a waku-publisher instance that will inject traffic into the network (see flags for rate and msg size)

notes

The default login/password for grafana is admin/admin.

warning

in case arp tables are overflowing:

sysctl net.ipv4.neigh.default.gc_thresh3=32000

Infrastructure

An instance of this service is deployed at https://simulator.waku.org/.

It is configured using wakusim.env file, and new changes to this repository are picked up using a GitHub webhook handler. The docker images used are updated using Watchtower as well.

For details on how it works please read the Ansible role readme file. The original deployment issue can be found here.