Skip to content

Commit

Permalink
update the network simulator docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nibty committed Jan 30, 2024
1 parent 19b00d9 commit b015286
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docker/networksimulator/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Simulate a Network

> install deps
## Install Dependencies

First, install [Docker](https://docs.docker.com/engine/install/) and [Docker Compose V2](https://docs.docker.com/compose/install/linux/).

> Install python Deps
```shell
# be in the docker/networksimulator directory
cd docker/networksimulator

pip3 install -r requirements.txt
```

## Run the Simulation

> run the simulated network. Replace NUM_OF_NODES with the number of nodes you want to simulate.
```shell
Expand All @@ -23,6 +29,8 @@ docker-compose up
python3 generate.py 10 && docker compose up --build
```

## Interact with the Network

Give it a few minutes for all the nodes to start up.

> Test the RPC endpoint
Expand Down

0 comments on commit b015286

Please sign in to comment.