aboutsummaryrefslogtreecommitdiffstats
path: root/docs/peers.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 13:33:51 +0000
committertv <tv@krebsco.de>2026-11-19 14:39:52 +0100
commit7a5aeb02024ddff71ba60f40913555cd21a633ad (patch)
treed3d0f1bafd3d39dab02c89a902162c829d6c79f7 /docs/peers.md
parent03105d40322dff9c18f0571872ab0f643aded0f7 (diff)
transport: SPEAKS, which wire versions a node speaks and what it knows
Before each HELLO and each HELLO_REPLY, a node sends SPEAKS: the oldest and the newest wire version it speaks, and the ID of the newest revision of the federation it knows. It stands outside the wire versions, its first byte 0, which no version is, laid out as no build changes: that byte, the oldest, the newest, then 32 bytes of the revision's ID where there is one; a reader takes those and leaves whatever follows, which a later build may add. So a peer on another build reads it too, and nodes on different builds can say what they run, which a rollout needs. A build from before it takes it for a message of another wire version and logs that once of the peer (version=0), reading the rest of the peer's messages as before: SPEAKS rolls out node by node, with no change of VERSION. The node keeps what each peer said last (`swarm::speaking`, at most 4096 peers). It counts as `hello` traffic. `OLDEST`, the oldest version this build reads, is `VERSION` for now: a range for a later build to widen. operations.md also says what is so of the other-version warning now: every transport logs it once per peer at warn, not Mycelium alone.
Diffstat (limited to 'docs/peers.md')
-rw-r--r--docs/peers.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/peers.md b/docs/peers.md
index e71d726..c63bebe 100644
--- a/docs/peers.md
+++ b/docs/peers.md
@@ -95,6 +95,14 @@ only valid identities (node IDs), and, once it knows the member list, only
its own neighbours; their addresses are hints for its transport, and each gets a
HELLO.
+Before each HELLO and each HELLO_REPLY, a node sends SPEAKS: the wire versions it speaks
+and the newest revision of the federation it knows, as its build has them. It stands
+outside the wire versions, laid out as no build changes, so that a peer on another build
+reads it too, once that peer reads the node's WHO and ME
+([Node IDs and addresses](#node-ids-and-addresses)). A build from before SPEAKS takes it
+for a message of another wire version, and logs that once of the peer
+([`operations.md`](operations.md), [Upgrading](operations.md#upgrading)).
+
Every HELLO carries a random id of the sender's current run, and the HELLO_REPLY echoes
it. A reply with another id answers a HELLO from an earlier run (delivered late, or
queued in Mycelium while the node was down) and is ignored.