Merge branch 'x1' into x1-txtracing

FairCrypto · Jan 30, 2024 · 8b4ea91 · 8b4ea91
2 parents 0f9a10a + cad15bf
commit 8b4ea91
Show file tree

Hide file tree

Showing 4 changed files with 419 additions and 8 deletions.
diff --git a/.github/workflows/test_build.yml b/.github/workflows/test_build.yml
@@ -20,7 +20,7 @@ jobs:
           go-version: '^1.18'
 
       - name: Run unit tests
-        run: go test -v ./...
+        run: go test ./...
 
       - name: Build
         run: make x1
diff --git a/docker/networksimulator/README.md b/docker/networksimulator/README.md
@@ -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
@@ -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