waku-org
/
waku-simulator
mirror of https://github.com/waku-org/waku-simulator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Tool to simulate a waku network with multiple nodes, traffic and users https://simulator.waku.org
42 Commits 7 Branches 0 Tags 2.8 MiB
Shell 61.5%
Python 38.5%
Go to file
Tanya S a802c8b852
Add pubsub-topic and cluster-id config to fix peer connectivity (#49) 
* add pubsub-topic and cluster-id config to fix peer connectivity

* add pubsub-topic and cluster-id to run_nwaku.sh
 		2024-05-15 16:44:33 +02:00
monitoring removing all uses and references to gowaku (#35) 2024-04-18 16:07:55 +02:00
.gitignore add wakusim.env file for wakusim.misc host (#9) 2023-09-27 08:55:16 +02:00
.gitmodules Rln membership registration implementation (#23) 2024-03-14 13:35:25 +02:00
Dockerfile.rest-traffic Feat adding rln to waku simulator (#12) 2023-10-31 16:17:35 +01:00
README.md removing all uses and references to gowaku (#35) 2024-04-18 16:07:55 +02:00
deploy_rln_contract.sh Adding rln contract deployment script (#30) 2024-03-26 10:41:52 +02:00
docker-compose.yml removing all uses and references to gowaku (#35) 2024-04-18 16:07:55 +02:00
run_bootstrap.sh Add pubsub-topic and cluster-id config to fix peer connectivity (#49) 2024-05-15 16:44:33 +02:00
run_nwaku.sh Add pubsub-topic and cluster-id config to fix peer connectivity (#49) 2024-05-15 16:44:33 +02:00
run_wakupublisher.sh deprecating rpc (#25) 2024-03-12 05:02:04 -06:00
traffic.py Feat adding rln to waku simulator (#12) 2023-10-31 16:17:35 +01:00
wakusim.env remove gowaku parameters from wakusim.env (#47) 2024-04-30 11:25:02 +02:00

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 NWAKU_IMAGE=wakuorg/nwaku:v0.21.2-rc.0
export NUM_NWAKU_NODES=5
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 nodes with specific versions.
  • spin up a rest-traffic 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

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.