logos-messaging/logos-messaging-simulator
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-simulator.git synced 2026-01-16 21:03:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
logos-messaging-simulator/README.md
stubbsta d7faeb440b
debugging fetch fail at >600 registrations
2026-01-16 07:52:06 +02:00

2.6 KiB
Raw Blame History

waku-simulator

Check 📖 The Waku Simulator Book📖

Also see: AI_CONTEXT.md for a concise, structured overview suitable for AI tools.

Quickstart

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=quay.io/wakuorg/nwaku-pr:2759-rln-v2
export NUM_NWAKU_NODES=5
export TRAFFIC_DELAY_SECONDS=15
export MSG_SIZE_KBYTES=10
export PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
export ETH_FROM=0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
export RLN_RELAY_EPOCH_SEC=10
export RLN_RELAY_MSG_LIMIT=2
export MAX_MESSAGE_LIMIT=100  # Contract's message limit. Needs to be higher or equal than RLN_RELAY_MSG_LIMIT, otherwise nodes won't start correctly.

Run the following command

docker compose up -d

(tested with Docker Compose version v2.28.1. Notice that we don't support docker compose v1)

Timed run + log capture (optional helper)

You can run the whole simulation for a fixed duration and automatically collect per-node logs using the Python helper:

python3 tools/run_simulation.py --duration 10m --logs-dir ./logs

Notes:

  • Requires docker compose v2.
  • Creates a timestamped folder under --logs-dir with nwaku-<i>.log per replica and bootstrap.log.
  • The script derives the Compose project name from the repo folder unless --project-name or COMPOSE_PROJECT_NAME is set.
  • Pass --no-down if you want to keep the stack running after log collection.

Analyze existing logs only (no containers started):

python3 tools/run_simulation.py --analyze-only ./logs/run_YYYYmmdd_HHMMSS

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.

The deployed branch is deploy-wakusim.