How the simulation is done

The following simulation structure was prepared for testing the Store protocol from nWaku. This structure will added to the Waku regresion tests that are done monthly with each version, allowing us to check the results of the store protocol in a more specific manner.

Simulation components:

Nwaku:

• 3 nWaku bootstrap nodes
  • Params: --relay=false --rest=true --rest-address=0.0.0.0 --max-connections=500 --discv5-discovery=true --discv5-enr-auto-update=True --log-level=INFO --metrics-server=True --metrics-server-address=0.0.0.0 --nat=extip:$IP --cluster-id=2
• 5 nWaku store nodes
  • Params: --relay=true --max-connections=150 --rest=true --rest-admin=true --rest-address=0.0.0.0 --discv5-discovery=true --discv5-enr-auto-update=True --log-level=INFO --metrics-server=True --metrics-server-address=0.0.0.0 --discv5-bootstrap-node=$ENR1 --discv5-bootstrap-node=$ENR2 --discv5-bootstrap-node=$ENR3 --nat=extip:${IP} --cluster-id=2 --store=true --store-message-db-url=${POSTGRES_URL}
• 1000 nWaku relay nodes
  • Params: --relay=true --max-connections=150 --rest=true --rest-admin=true --rest-address=0.0.0.0 --discv5-discovery=true --discv5-enr-auto-update=True --log-level=INFO --metrics-server=True --metrics-server-address=0.0.0.0 --discv5-bootstrap-node=$ENR1 --discv5-bootstrap-node=$ENR2 --discv5-bootstrap-node=$ENR3 --nat=extip:${IP} --cluster-id=2

Other:

• Waku publisher script
  • Params: --messages=100 --msg-size-kbytes=1 --delay-seconds=1
• Waku message store retrieval script

Procedure:

1. Deploy all nWaku nodes and wait until the mesh is healthy. This means that all nodes have between d_low and d_high peers.
2. Start publisher.
   1. For each message, the publisher will use the REST API of a random node to publish it.
3. Once all messages are injected, a script will retrieve messages from a random store node.
4. The simulation is finished.
5. A script will analyze the logs of the nWaku nodes.
   1. It will be checked that ALL nodes received ALL messages.
   2. It will be checked that the messages retrieved by the store match those messages.
6. Metrics are downloaded and analyzed.