Tool to simulate a waku network with multiple nodes, traffic and users
https://simulator.waku.org
d6fb3e56e5
* add anvil config and volume to remember state and output account info; nwaku config to register rln membership * modify run_nwaku.sh for onchain rln * add script for rln membership registration * run_nwaku update, removed rln membership index and added other rln parameters * merged run_register_rln with the run_nwaku script * added environment variables for rln-contract registration * removed rpc related flags and added rest flags for sake of completeness, also updated BOOTSTRAP_ENR query * removed rpc flags, added cred-path and -password * added keystore volume and 8645 port * removed keystore volume and keystore parent directory * remove unused service from docker-compose |
||
|---|---|---|
| monitoring | ||
| submodules | ||
| .gitignore | ||
| .gitmodules | ||
| Dockerfile.rest-traffic | ||
| README.md | ||
| docker-compose.yml | ||
| run_bootstrap.sh | ||
| run_gowaku.sh | ||
| run_nwaku.sh | ||
| run_wakupublisher.sh | ||
| traffic.py | ||
| wakusim.env | ||
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=wakuorg/go-waku:latest
export NWAKU_IMAGE=wakuorg/nwaku:v0.21.2-rc.0
export NUM_NWAKU_NODES=5
export NUM_GOWAKU_NODES=0
export TRAFFIC_DELAY_SECONDS=15
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
rest-trafficinstance 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
Compose V2 users should spin up the containers with the following command:
docker-compose --compatibility up -d
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.
The deployed branch is deploy-wakusim.