From ea62fa4af40185292e52967093ff0fb1cebc4905 Mon Sep 17 00:00:00 2001 From: darshankabariya Date: Sat, 11 Apr 2026 01:10:35 +0530 Subject: [PATCH] chore : another fix --- README.md | 14 +++++++++----- src/deploy-waku-network.md | 12 ++++++++---- src/intro-logos-delivery-simulator.md | 2 +- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fb86b93..dfd2890 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ A self-contained protocol simulator for [logos-delivery](https://github.com/logos-messaging/logos-delivery) — the Nim implementation of a libp2p protocol suite for private, censorship-resistant peer-to-peer messaging. -On `docker compose up`, the simulator orchestrates a network of `logos-delivery` nodes inside Docker (default 5, upper bound around 200), launches a private Anvil blockchain, deploys an RLN contract, registers an RLN membership for every node, and brings up a Grafana + Prometheus + cAdvisor + Epirus block-explorer stack pre-wired to the network. The whole thing runs on an isolated Docker bridge with cluster id `66`, so it cannot accidentally talk to any production fleet. +On `docker-compose up`, the simulator orchestrates a network of `logos-delivery` nodes inside Docker (default 5, upper bound around 200), launches a private Anvil blockchain, deploys an RLN contract, registers an RLN membership for every node, and brings up a Grafana + Prometheus + cAdvisor + Epirus block-explorer stack pre-wired to the network. The whole thing runs on an isolated Docker bridge with cluster id `66`, so it cannot accidentally talk to any production fleet. 📖 Full tutorials live in **[The Logos Delivery Simulator Book](https://logos-messaging.github.io/logos-delivery-simulator/)**. ## Prerequisites -- `docker` and `docker compose` v2 (tested with v2.28.1; v1 is **not** supported) +- `docker` and `docker-compose` v2 (tested with v2.28.1; v1 is **not** supported) - Linux or macOS host with at least a few GB of free RAM (scales with `NUM_LD_NODES`) ## Quickstart @@ -18,7 +18,7 @@ git clone https://github.com/logos-messaging/logos-delivery-simulator.git cd logos-delivery-simulator ``` -Configure the simulation. Either `export` the variables in your shell or drop them in a local `.env` file (gitignored) — `docker compose` picks `.env` up automatically. +Configure the simulation. Either `export` the variables in your shell or drop them in a local `.env` file (gitignored) — `docker-compose` picks `.env` up automatically. ```bash # Image & network size @@ -42,7 +42,7 @@ export ETH_FROM=0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266 Bring everything up: ```bash -docker compose up -d +docker-compose up -d ``` After a couple of minutes the stack is ready. Open: @@ -56,7 +56,11 @@ After a couple of minutes the stack is ready. Open: To follow logs from a specific node: ```bash -docker logs logos-delivery-simulator_nwaku_1 --follow +# Stream all nwaku replicas merged +docker-compose logs -f nwaku + +# Or a specific replica (index = the N in logos-delivery-simulator_nwaku_N) +docker-compose logs -f --index=1 nwaku ``` ## What you can do with it diff --git a/src/deploy-waku-network.md b/src/deploy-waku-network.md index b0d5638..ce667f4 100644 --- a/src/deploy-waku-network.md +++ b/src/deploy-waku-network.md @@ -1,6 +1,6 @@ # Deploy a Logos Delivery network -This page deploys a self-contained network of [logos-delivery](https://github.com/logos-messaging/logos-delivery) nodes (the `wakunode2` binary, distributed as a Docker image) on a single machine. It requires `docker` and `docker compose`. Configuration is exposed through environment variables — if a knob you need is missing, PRs are welcome. +This page deploys a self-contained network of [logos-delivery](https://github.com/logos-messaging/logos-delivery) nodes (the `wakunode2` binary, distributed as a Docker image) on a single machine. It requires `docker` and `docker-compose`. Configuration is exposed through environment variables — if a knob you need is missing, PRs are welcome. The most important parameters are: @@ -36,14 +36,18 @@ After a couple of minutes, everything should be running at: For greater observability, one can access each node logs as follows: ```bash -docker logs logos-delivery-simulator_nwaku_1 -docker logs logos-delivery-simulator_nwaku_2 +# All nwaku replicas at once +docker-compose logs nwaku + +# A specific replica (e.g. index 1 or 2) +docker-compose logs --index=1 nwaku +docker-compose logs --index=2 nwaku ``` Or if you want to follow the logs ```bash -docker logs logos-delivery-simulator_nwaku_1 --follow +docker-compose logs -f --index=1 nwaku ``` Once the network of `logos-delivery` nodes is up and running we can use it to perform different tests, connecting other nodes that we fully control with specific characteristics. This ranges from connecting spammer nodes, light clients, store nodes, and in the future unsynced nodes, etc. diff --git a/src/intro-logos-delivery-simulator.md b/src/intro-logos-delivery-simulator.md index 154f134..b81fd16 100644 --- a/src/intro-logos-delivery-simulator.md +++ b/src/intro-logos-delivery-simulator.md @@ -4,7 +4,7 @@ The [logos-delivery-simulator](https://github.com/logos-messaging/logos-delivery ## What it does -The simulator orchestrates a network of `logos-delivery` nodes inside Docker, on a single machine, so you can exercise the protocol stack end-to-end without depending on any public network. Concretely, on `docker compose up` it: +The simulator orchestrates a network of `logos-delivery` nodes inside Docker, on a single machine, so you can exercise the protocol stack end-to-end without depending on any public network. Concretely, on `docker-compose up` it: - spins up a configurable number of `logos-delivery` nodes (default: 5, upper bound around 200) all connected through a single bootstrap node via discv5, - launches a private Anvil blockchain ([foundry](https://github.com/foundry-rs/foundry)) under your full control,