github/gossipsub-testground
1
1
Fork 0
mirror of https://github.com/sigp/gossipsub-testground.git synced 2026-01-09 21:48:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

Just Fixing up some docs (#11)

Browse Source 
* Fix doc links

* Docs fixes
This commit is contained in:
Age Manning
2022-11-29 16:20:47 +11:00
committed by GitHub
parent a260f69580
commit 29e12eff9e
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -29,7 +29,7 @@ This is a basic run of a few gossipsub nodes sending messages between
themselves. This serves as a simple example of how rust-gossipsub can be themselves. This serves as a simple example of how rust-gossipsub can be
integrated with testground and a simple simulation can be run. integrated with testground and a simple simulation can be run.
See the [smoke documentation](./smoke/README) for instructions on how to run See the [smoke documentation](./smoke/README.md) for instructions on how to run
the simulation. the simulation.
### [Censoring](./censoring/README.md) ### [Censoring](./censoring/README.md)
@@ -38,7 +38,7 @@ This simulation constructs a network of malicious peers which attempt to censor
messages on the network. The gossipsub scoring parameters are recorded and can messages on the network. The gossipsub scoring parameters are recorded and can
be examined to determine their effectiveness. be examined to determine their effectiveness.
See the [censoring documentation](./censoring/README) for instructions on how to run See the [censoring documentation](./censoring/README.md) for instructions on how to run
the simulation. the simulation.
### [Ethereum Consensus](./eth_consensus/README.md) ### [Ethereum Consensus](./eth_consensus/README.md)
@@ -47,7 +47,7 @@ This is a simulation of the standard gossipsub network for various sizes of the
Ethereum consensus layer. It can be used in some forms to model network traffic Ethereum consensus layer. It can be used in some forms to model network traffic
for the Ethereum consensus layer. for the Ethereum consensus layer.
See the [Ethereum consensus documentation](./eth_consensus/README) for instructions on how to run See the [Ethereum consensus documentation](./eth_consensus/README.md) for instructions on how to run
the simulation. the simulation.
## Dashboards ## Dashboards

8
eth_consensus/README.md
View File

@@ -14,7 +14,9 @@ root directory):
testground run composition -f ./eth_consensus/compositions/composition.toml --wait testground run composition -f ./eth_consensus/compositions/composition.toml --wait
``` ```
Various aspects of the simulation can be modified. Please read the `eth_consensus/manifest.toml` to understand test parameters and `eth_consensus/compositions/composition.toml` to modify them. Various aspects of the simulation can be modified. Please read the
`eth_consensus/manifest.toml` to understand test parameters and
`eth_consensus/compositions/composition.toml` to modify them.
## Influx DB Queries ## Influx DB Queries
@@ -56,9 +58,7 @@ topology for the simulation.
To visualise the topology, a dot file and json file can be produced by running: To visualise the topology, a dot file and json file can be produced by running:
``` ```
cargo run --bin gen_topology_file <seed> <total_validators> cargo run --bin gen_topology_file <seed> <total_validators> <total_node_with_vals> <min_peer_per_node> <max_peer_per_node> <output-dot-file> <output-json-file>
<total_node_with_vals> <min_peer_per_node> <max_peer_per_node>
<output-dot-file> <output-json-file>
``` ```
an example is: an example is: