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

Add book link

This commit is contained in:
Alvaro Revuelta 2024-06-12 12:51:55 +02:00 committed by GitHub
parent e08c84e8e2
commit f39ac2582d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,10 +1,8 @@
# waku-simulator
## Requires
* docker
* docker-compose
Check 📖 [The Waku Simulator Book](https://waku-org.github.io/waku-simulator/)📖
## How to run
## Quickstart
```
git clone https://github.com/waku-org/waku-simulator.git
@ -26,21 +24,6 @@ export RLN_RELAY_MSG_LIMIT=2
docker-compose --compatibility up -d
```
This will:
* create a private blockchain and attach a block explorer.
* deploy RLN contract to it.
* spin up a bootstrap nwaku node.
* spin up a given amount of nwaku nodes with specific versions.
* register an RLN membership for each nwaku node.
* spin up a `rest-traffic` instance that will inject traffic into the network via the REST API.
* see block-explorer `http://localhost:3000`.
* see grafana with node metrics `http://localhost:3001`.
## notes
The default login/password for grafana is `admin`/`admin`.
## warning
in case arp tables are overflowing: