Skip to content

Commit

Permalink
p2p: document diffusionMode for local root peers
Browse files Browse the repository at this point in the history
  • Loading branch information
coot committed Jan 30, 2025
1 parent 46bf5ce commit 8ac1d1c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/get-started/cardano-node/topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ A minimal version of this file looks like this:
"advertise": false,
"valency": 1,
"warmValency": 2,
"trustable": true
"trustable": true,
"diffusionMode": "InitiatorAndResponder"
}
],
"useLedgerAfterSlot": 128908821,
Expand Down Expand Up @@ -92,6 +93,15 @@ A minimal version of this file looks like this:
Check [this issue](https://github.com/intersectmbo/ouroboros-network/issues/4565) for more context on this `WarmValency` option.


* The `diffusionMode` is an optional field available since `cardano-node-10.2`.
It can either be `"InitiatorAndResponder"` (the default value) or `"InitiatorOnly"` (similar to `DiffusionMode` in the configuration file).
If `"InitiatorOnly"` is set, then all local roots in this group will negotiate initiator-only diffusion mode, e.g. the TCP connection will be used as a unidirectional connection.

The topology setting overwrites `DiffusionMode` from the configuration file for given local root peers.
It is meant to overwrite the diffusion mode when a node is running in `InitiatorAndResponder` mode (the default).
The other way is also possible, but note that when the option in the configuration file is set to `InitiatorOnly`, the node will not run the accept loop.


* The `advertise` parameter instructs a node about the acceptability of sharing addresses through *peer sharing* (which we'll explain in more detail in a subsequent section).
If a node has activated peer sharing, it can receive requests from other nodes seeking peers.
However, it will only disclose those peers for which it has both local and remote permissions.
Expand Down

0 comments on commit 8ac1d1c

Please sign in to comment.