diff options
| author | tv <tv@krebsco.de> | 2026-11-19 13:33:51 +0000 |
|---|---|---|
| committer | tv <tv@krebsco.de> | 2026-11-19 14:39:52 +0100 |
| commit | 7a5aeb02024ddff71ba60f40913555cd21a633ad (patch) | |
| tree | d3d0f1bafd3d39dab02c89a902162c829d6c79f7 /docs/operations.md | |
| parent | 03105d40322dff9c18f0571872ab0f643aded0f7 (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/operations.md')
| -rw-r--r-- | docs/operations.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/operations.md b/docs/operations.md index e1b8e79..4b42992 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -98,10 +98,15 @@ One node at a time, restarting each with its files. What to know: * **The wire format.** Each change to it bumps a version byte, and nodes ignore messages of another version. Across such a change, upgraded nodes and the others don't talk: the swarm is split until every node is upgraded, both sides go on - writing, and they merge then. Mycelium logs it (`Peer speaks another wire version - (another build); ignoring its messages`, warn, once per peer); libp2p and Tor at debug - only (`Dropping a message that doesn't decode`). Until the first release, assume - every upgrade is such a change, and upgrade all nodes close together. + writing, and they merge then. Each logs it (`Peer speaks another wire version + (another build); ignoring its messages`, warn, once per peer). With each handshake, a + node says which versions it speaks, and the newest revision of the federation it knows + (SPEAKS, outside the versions; [`peers.md`](peers.md), + [Handshake and join](peers.md#handshake-and-join)); a build from before SPEAKS logs it + as that warning, `version=0`, once of the peer, and reads the peer's other messages + where they are of its version. + Until the first release, assume every upgrade is such a change, and upgrade all nodes + close together. * **Automerge.** A remake needs every node to build the same snapshot, byte for byte, so the same Automerge version everywhere; a node with another one rejoins instead of switching ([`remakes.md`](remakes.md), [Limits](remakes.md#limits)). Don't remake while @@ -246,7 +251,8 @@ And from the log, at warn or error: read-only disk; * `The … file is readable by others than its owner; chmod 600 it`; * `Peer speaks another wire version (another build); ignoring its messages`: a node on - another build. + another build; with `version=0`, only a newer build's SPEAKS, which this build doesn't + read. ## What a node uses |
