Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
nimbledeps/*
*.exe
shadow/network_topology.gml
shadow/shadow.yaml
shadow/main
shadow/latencies*
shadow/shadowlog*
shadow/stats*
shadow/shadow.data/
shadow/rust/target/
shadow/rust/.cargo/
shadow/rust/Cargo.lock


62 changes: 47 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,56 @@
# dst-gossipsub-test-node

* DST gossipsub test node
* DST gossipsub test node for nim-libp2p, go-libp2p, rust-libp2p
* incl shadow simulation setup
* incl awk scripts for detailed analysis

## Shadow example
## Shadow example (nim-libp2p)

./nimrun.sh <runs> <nodes> <Message_size> <num_fragment> <num_publishers> <min_bandwidth> <max_bandwidth>
<min_latency> <max_latency> <anchor_stages> <packet_loss> <publisher_id> <inter_message_delay>

The following sample command runs simulation 1 time, for a 1000 node network. Each published message size \
is 15KB single-message (no-fragmentation). A total of 10 messages are transmitted in the network. \
Peer bandwidth varies between 50-150 Mbps, Latency between 40-130ms, and bandwidth/latency is roughly \
distributed in five different groups. No packet loss is introduced on edges. Peer 4 publishes all messages \
with 4000 ms inter-packet delay. see the generated network_topology.gml and shadow.yaml for peers/edges details

```sh
nimble install -dy
cd shadow
# the default shadow.yml will start 5k nodes, you might want to change that by removing
# lines and setting PEERS to the number of instances
./run.sh
# the output is a "latencies" file, or you can find each host output in the
# data.shadow folder

# you can use the plotter tool to extract useful metrics & generate a graph
cd ../tools
nim -d:release c plotter
./plotter ../shadow/latencies "Clever graph name"
# will output averages, and generate a "test.svg" graph
./nimrun.sh 1 1000 15000 1 10 50 150 40 130 5 0.0 4 4000
```

The dependencies will be installed in the `nimbledeps` folder, which enables easy tweaking

## Shadow example (go-libp2p)

./gorun.sh <runs> <nodes> <Message_size> <num_fragment> <num_publishers> <min_bandwidth> <max_bandwidth>
<min_latency> <max_latency> <anchor_stages> <packet_loss> <publisher_id> <inter_message_delay> <D_Announce>

The following sample command runs simulation 1 time, for a 1000 node network. Each published message size \
is 15KB single-message (no-fragmentation). A total of 10 messages are transmitted in the network. \
Peer bandwidth varies between 50-150 Mbps, Latency between 40-130ms, and bandwidth/latency is roughly \
distributed in five different groups. No packet loss is introduced on edges. Peer 4 publishes all messages \
with 4000 ms inter-packet delay. see the generated network_topology.gml and shadow.yaml for peers/edges details.
D_announce flag is only intended for experimental go-GossipSubv2.0 (can be left 0 otherwise)

```sh
cd shadow
./gorun.sh 1 1000 15000 1 10 50 150 40 130 5 0.0 4 4000 7
```


## Shadow example (rust-libp2p)

./rustrun.sh <runs> <nodes> <Message_size> <num_fragment> <num_publishers> <min_bandwidth> <max_bandwidth>
<min_latency> <max_latency> <anchor_stages> <packet_loss> <publisher_id> <inter_message_delay>

The following sample command runs simulation 1 time, for a 1000 node network. Each published message size \
is 15KB single-message (no-fragmentation). A total of 10 messages are transmitted in the network. \
Peer bandwidth varies between 50-150 Mbps, Latency between 40-130ms, and bandwidth/latency is roughly \
distributed in five different groups. No packet loss is introduced on edges. Peer 4 publishes all messages \
with 4000 ms inter-packet delay. see the generated network_topology.gml and shadow.yaml for peers/edges details.

```sh
cd shadow
./rustrun.sh 1 1000 15000 1 10 50 150 40 130 5 0.0 4 4000 7
```
117 changes: 117 additions & 0 deletions shadow/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
module main

go 1.23.6

require (
github.com/btcsuite/btcd/btcec/v2 v2.3.4
github.com/ethereum/go-ethereum v1.15.2
github.com/libp2p/go-libp2p v0.40.0
github.com/libp2p/go-libp2p-pubsub v0.13.0
github.com/multiformats/go-multiaddr v0.14.0
)

require (
github.com/benbjohnson/clock v1.3.5 // indirect
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/containerd/cgroups v1.1.0 // indirect
github.com/coreos/go-systemd/v22 v22.5.0 // indirect
github.com/davidlazar/go-crypto v0.0.0-20200604182044-b73af7476f6c // indirect
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/elastic/gosigar v0.14.3 // indirect
github.com/flynn/noise v1.1.0 // indirect
github.com/francoispqt/gojay v1.2.13 // indirect
github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
github.com/godbus/dbus/v5 v5.1.0 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/google/gopacket v1.1.19 // indirect
github.com/google/pprof v0.0.0-20250208200701-d0013a598941 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/gorilla/websocket v1.5.3 // indirect
github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
github.com/holiman/uint256 v1.3.2 // indirect
github.com/huin/goupnp v1.3.0 // indirect
github.com/ipfs/go-cid v0.5.0 // indirect
github.com/ipfs/go-log/v2 v2.5.1 // indirect
github.com/jackpal/go-nat-pmp v1.0.2 // indirect
github.com/jbenet/go-temp-err-catcher v0.1.0 // indirect
github.com/klauspost/compress v1.17.11 // indirect
github.com/klauspost/cpuid/v2 v2.2.9 // indirect
github.com/koron/go-ssdp v0.0.5 // indirect
github.com/libp2p/go-buffer-pool v0.1.0 // indirect
github.com/libp2p/go-flow-metrics v0.2.0 // indirect
github.com/libp2p/go-libp2p-asn-util v0.4.1 // indirect
github.com/libp2p/go-msgio v0.3.0 // indirect
github.com/libp2p/go-nat v0.2.0 // indirect
github.com/libp2p/go-netroute v0.2.2 // indirect
github.com/libp2p/go-reuseport v0.4.0 // indirect
github.com/libp2p/go-yamux/v5 v5.0.0 // indirect
github.com/marten-seemann/tcp v0.0.0-20210406111302-dfbc87cc63fd // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/miekg/dns v1.1.63 // indirect
github.com/mikioh/tcpinfo v0.0.0-20190314235526-30a79bb1804b // indirect
github.com/mikioh/tcpopt v0.0.0-20190314235656-172688c1accc // indirect
github.com/minio/sha256-simd v1.0.1 // indirect
github.com/mr-tron/base58 v1.2.0 // indirect
github.com/multiformats/go-base32 v0.1.0 // indirect
github.com/multiformats/go-base36 v0.2.0 // indirect
github.com/multiformats/go-multiaddr-dns v0.4.1 // indirect
github.com/multiformats/go-multiaddr-fmt v0.1.0 // indirect
github.com/multiformats/go-multibase v0.2.0 // indirect
github.com/multiformats/go-multicodec v0.9.0 // indirect
github.com/multiformats/go-multihash v0.2.3 // indirect
github.com/multiformats/go-multistream v0.6.0 // indirect
github.com/multiformats/go-varint v0.0.7 // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/onsi/ginkgo/v2 v2.22.2 // indirect
github.com/opencontainers/runtime-spec v1.2.0 // indirect
github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect
github.com/pion/datachannel v1.5.10 // indirect
github.com/pion/dtls/v2 v2.2.12 // indirect
github.com/pion/dtls/v3 v3.0.4 // indirect
github.com/pion/ice/v4 v4.0.6 // indirect
github.com/pion/interceptor v0.1.37 // indirect
github.com/pion/logging v0.2.3 // indirect
github.com/pion/mdns/v2 v2.0.7 // indirect
github.com/pion/randutil v0.1.0 // indirect
github.com/pion/rtcp v1.2.15 // indirect
github.com/pion/rtp v1.8.11 // indirect
github.com/pion/sctp v1.8.35 // indirect
github.com/pion/sdp/v3 v3.0.10 // indirect
github.com/pion/srtp/v3 v3.0.4 // indirect
github.com/pion/stun v0.6.1 // indirect
github.com/pion/stun/v3 v3.0.0 // indirect
github.com/pion/transport/v2 v2.2.10 // indirect
github.com/pion/transport/v3 v3.0.7 // indirect
github.com/pion/turn/v4 v4.0.0 // indirect
github.com/pion/webrtc/v4 v4.0.9 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/prometheus/client_golang v1.20.5 // indirect
github.com/prometheus/client_model v0.6.1 // indirect
github.com/prometheus/common v0.62.0 // indirect
github.com/prometheus/procfs v0.15.1 // indirect
github.com/quic-go/qpack v0.5.1 // indirect
github.com/quic-go/quic-go v0.49.0 // indirect
github.com/quic-go/webtransport-go v0.8.1-0.20241018022711-4ac2c9250e66 // indirect
github.com/raulk/go-watchdog v1.3.0 // indirect
github.com/spaolacci/murmur3 v1.1.0 // indirect
github.com/wlynxg/anet v0.0.5 // indirect
go.uber.org/dig v1.18.0 // indirect
go.uber.org/fx v1.23.0 // indirect
go.uber.org/mock v0.5.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/crypto v0.33.0 // indirect
golang.org/x/exp v0.0.0-20250210185358-939b2ce775ac // indirect
golang.org/x/mod v0.23.0 // indirect
golang.org/x/net v0.35.0 // indirect
golang.org/x/sync v0.11.0 // indirect
golang.org/x/sys v0.30.0 // indirect
golang.org/x/text v0.22.0 // indirect
golang.org/x/tools v0.30.0 // indirect
google.golang.org/protobuf v1.36.5 // indirect
lukechampine.com/blake3 v1.3.0 // indirect
)
replace github.com/libp2p/go-libp2p-pubsub => github.com/ppopth/go-libp2p-pubsub v0.11.1-0.20250305042130-cfecb8a59877

Loading