Skip to main content

mcpmesh_local_api/
protocol.rs

1//! mcpmesh-local/1 protocol types. Shared vocabulary between the daemon
2//! and its clients (porcelain, connect proxy, later the host shell). Wire framing
3//! is the family NDJSON codec — carried by the caller, not defined here.
4//!
5//! Request/response asymmetry: requests are one typed, closed enum (`Request`);
6//! responses are per-method typed structs deserialized from the JSON-RPC `result`
7//! Value — `Status` → [`StatusResult`], `RegisterService` → an ack, `OpenSession` →
8//! no JSON-RPC result at all: the socket STOPS being JSON-RPC and becomes a raw
9//! byte pipe.
10//!
11//! Additive-only: new fields (capabilities on `Hello`, groups/user_id on
12//! `PeerInfo`, device on `OpenSession`) MUST land as
13//! `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
14use std::collections::BTreeMap;
15
16use serde::{Deserialize, Serialize};
17
18/// The first exchange on any `*-local/N` socket (the family's hello convention).
19#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
20pub struct Hello {
21    pub api: String,         // "mcpmesh-local/1"
22    pub api_version: String, // "MAJOR.MINOR" of the protocol surface (see API_MINOR)
23    /// The protocol-compatibility MINOR as an integer, for a trivial machine comparison
24    /// (`api_minor >= N`) without string parsing. Distinct from `stack_version` (the crate
25    /// release train). Additive: an older daemon omits it and it defaults to 0.
26    #[serde(default)]
27    pub api_minor: u32,
28    pub stack_version: String,
29}
30
31/// The kind of backend answering a service — the two valid values, enforced at the
32/// type level and kept in lockstep with `BackendSpec`'s variants. Status reports the
33/// kind only, never the command/path (no transport vocabulary).
34///
35/// **`Default` is a construction convenience, not a claim (#148).** Neither value means "no
36/// backend" — a service has one or the other — so `Run` is chosen because it is the common config
37/// shape, and for no deeper reason. It exists so [`ServiceInfo`] can derive `Default` and a
38/// downstream test fixture stops breaking on every additive field we add.
39///
40/// It cannot mislead a reader of live data: the daemon sets `backend` explicitly on every
41/// `ServiceInfo` it builds, so a defaulted value only ever exists in a fixture whose author
42/// wrote it.
43#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
44#[serde(rename_all = "snake_case")]
45pub enum BackendKind {
46    #[default]
47    Run,
48    Socket,
49}
50
51/// A registered service as reported by `status` (no transport vocabulary).
52#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
53pub struct ServiceInfo {
54    pub name: String,
55    pub allow: Vec<String>, // STABLE principals (b64u:/eid:) or roster names (#38) — never nicknames
56    /// The HUMAN rendering of `allow`, index-aligned: each principal resolved to its peer's
57    /// display nickname by the daemon (which owns the store); an unresolvable stable
58    /// principal renders as a neutral placeholder — porcelain must show THESE, never raw
59    /// ids (surface discipline). Additive: default + skip-if-empty.
60    #[serde(default, skip_serializing_if = "Vec::is_empty")]
61    pub allow_display: Vec<String>,
62    pub backend: BackendKind, // "run" | "socket" (kind only, never the command/path)
63    /// True if this registration is ephemeral (#36): in-memory only, tied to the registering
64    /// control connection's lifetime, absent from config, gone on restart. Additive — an older
65    /// daemon omits it and it reads as `false` (the persistent default).
66    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
67    pub ephemeral: bool,
68}
69
70/// A known peer as reported by `status` (nickname only — never the EndpointId).
71#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
72pub struct PeerInfo {
73    pub name: String,
74    pub services: Vec<String>,
75    /// The peer's PROVEN self-sovereign `user_id` (`b64u:<user_pk>`) if it presented a verified
76    /// device->user binding at pairing (roster peers carry it too), else `None` (nickname-only). This
77    /// is a surface-clean identity (an opaque user id, NOT an EndpointId). Additive:
78    /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so older payloads round-trip.
79    #[serde(default, skip_serializing_if = "Option::is_none")]
80    pub user_id: Option<String>,
81    /// The peer's stable DEVICE principal `eid:<hex>` (#41) — the SAME rendering the socket
82    /// backend injects into `_meta["mcpmesh/peer"]` and that appears in `[services.*].allow`.
83    /// Always present for a real peer (`Option` only for additive round-trip). Distinct from
84    /// `user_id` (the person-level `b64u:`, present only when the peer proved a binding): a
85    /// nickname is not unique, so an embedder keys caller-scoped decisions (dial the caller
86    /// back, "the requester's own data") on THIS, the authenticated endpoint. Machine-surface
87    /// authz vocabulary (like the allow lists) — human porcelain still shows the nickname.
88    /// Additive: `#[serde(default, skip_serializing_if = "Option::is_none")]`.
89    #[serde(default, skip_serializing_if = "Option::is_none")]
90    pub principal: Option<String>,
91}
92
93/// HOW a peer is reached (#64): a direct/hole-punched QUIC path, or through a relay.
94///
95/// `rtt_ms` is NOT a proxy for this — a fast relay beats a slow direct path — and iroh's own
96/// distinction was being dropped at the mcpmesh boundary. Three things depend on it: a truthful
97/// locality claim ("this traffic never left the building"), honest disclosure that a relayed path
98/// depends on third-party infrastructure, and diagnostics, since "slow" has a different cause and
99/// fix in each case.
100///
101/// **Only `Direct` supports a locality claim.** `Unknown` means "we do not know", NOT "private" —
102/// rendering it as private is the one misuse that turns this field into a false privacy statement.
103/// The daemon errs the same way: when a relay path is active it reports [`Relay`](Self::Relay) even
104/// if a direct path is live too, because overstating privacy is worse than understating it.
105///
106/// `#[non_exhaustive]`: iroh already has a third address kind (a custom transport) that could
107/// warrant a variant, and adding one to a public enum later breaks every downstream exhaustive
108/// `match` — the lesson #58 paid for.
109#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
110#[serde(tag = "kind", rename_all = "snake_case")]
111#[non_exhaustive]
112pub enum PeerPath {
113    /// A direct or hole-punched QUIC path: the bytes did not transit a relay.
114    Direct,
115    /// Through a relay server. `url` is the relay in use when known.
116    Relay {
117        #[serde(default, skip_serializing_if = "Option::is_none")]
118        url: Option<String>,
119    },
120    /// Not known: never probed, no selected path, or a transport mcpmesh does not model.
121    ///
122    /// `#[serde(other)]` makes this the landing spot for a `kind` a client has never heard of. That
123    /// is what actually buys wire-additivity: `#[non_exhaustive]` only protects the Rust `match`,
124    /// and without this an older client hits `unknown variant` and fails to deserialize the WHOLE
125    /// `PeerReachability` — one new path kind would break every `status` response it reads.
126    #[default]
127    #[serde(other)]
128    Unknown,
129}
130
131/// Advisory reachability of a paired peer (pairing-mode liveness). Surface-clean: a nickname, a
132/// bool, latency/age NUMBERS, the stable `eid:` principal (#42), and since #64 the PATH KIND —
133/// direct vs relay, plus the relay URL when relayed. Never a socket address, an IP, or a key: the
134/// path field says WHICH KIND of route is in use, never where the peer is.
135#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
136pub struct PeerReachability {
137    pub name: String,    // the peer's nickname
138    pub reachable: bool, // result of the last probe (false if never probed)
139    #[serde(default, skip_serializing_if = "Option::is_none")]
140    /// Last measured round-trip, if reachable: dial + ping/pong, stamped AT THE PONG.
141    ///
142    /// It EXCLUDES the window the daemon spends afterwards determining which path the connection
143    /// settled on. Before 0.20.1 it included that window, so a relayed peer could never report
144    /// under 600ms and most of the figure was a deliberate wait rather than time on the wire —
145    /// an embedder read ~820ms across one LAN hop and reported it as a 66x latency regression
146    /// (#123). It is a wire-latency measurement now, so "relayed AND low rtt_ms" is a reachable
147    /// state and a usable diagnostic.
148    pub rtt_ms: Option<u64>,
149    #[serde(default, skip_serializing_if = "Option::is_none")]
150    pub age_secs: Option<u64>, // None = never probed (consumer shows "checking…")
151    /// The peer's OPTIONAL app metadata (#40) — the same opaque ≤256B blob #39 exposes via
152    /// presence, here carried on the pairing-mode `mcpmesh/ping/1` probe pong so PAIRED peers
153    /// (which have no presence gossip) see it too. Empty when the peer set none. Advisory
154    /// display data; never an authz input. Near-real-time when `status` is read (the probe
155    /// cache has a ~20s TTL), not a steady push. Additive: default + skip-if-empty.
156    #[serde(default, skip_serializing_if = "String::is_empty")]
157    pub meta: String,
158    /// The peer's stable DEVICE principal `eid:<hex>` (#42) — the SAME rendering as
159    /// [`PeerInfo::principal`], so an embedder joins probe result + `meta` (app version) to a
160    /// peer by the AUTHENTICATED endpoint rather than the non-unique nickname. Always present
161    /// for a real row (`Option` only for additive round-trip). Machine-surface authz
162    /// vocabulary — the human `status` reachability line is unchanged. Additive:
163    /// `#[serde(default, skip_serializing_if = "Option::is_none")]`.
164    #[serde(default, skip_serializing_if = "Option::is_none")]
165    pub principal: Option<String>,
166    /// HOW this peer is reached (#64) — see [`PeerPath`]. Captured by the same probe that sets
167    /// `reachable`/`rtt_ms`, so it shares their freshness: one TTL, one `age_secs`. `Unknown` for a
168    /// peer never probed. Additive (`#[serde(default)]`), so older rows and clients are unaffected.
169    #[serde(default)]
170    pub path: PeerPath,
171}
172
173/// WHICH producer emitted a [`StreamFrame::Reachability`] (#150). The two say different things
174/// about the world and license different user-facing statements, and until API 1.30 the frame
175/// carried no way to tell them apart.
176///
177/// Advisory attribution, never an authz input: it says where an observation CAME FROM, never who a
178/// peer is.
179#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize)]
180#[serde(rename_all = "snake_case")]
181#[non_exhaustive]
182pub enum ReachabilitySource {
183    /// A **probe** completed — a fresh throwaway dial (`status`/`subscribe` refreshing a stale
184    /// entry). It describes that dial and nothing else: a `Probe` frame saying `Relay` does NOT
185    /// mean any live connection is relayed.
186    Probe,
187    /// A **live session**'s selected path changed under it (#92 item 2). This is a claim about the
188    /// link a peer's traffic is actually on — the frame an embedder wants when warning that a call
189    /// which WAS direct silently is not any more.
190    Session,
191    /// The daemon did not say (`api_minor < 30`), or it named a producer this client predates.
192    ///
193    /// The DEFAULT, deliberately — see [`StreamFrame::Reachability`]. Like [`PeerPath::Unknown`] it
194    /// means "we do not know" and must never be collapsed into either confident case.
195    #[default]
196    Unknown,
197}
198
199/// Hand-written so an unrecognized producer lands on [`ReachabilitySource::Unknown`] instead of
200/// failing the whole frame. [`PeerPath`] gets this from `#[serde(other)]`, which serde allows only
201/// on an internally/adjacently tagged enum; this one is a plain string, so it is spelled out. The
202/// stakes are the same as there: without it, adding a third producer later would break every
203/// `Reachability` frame an older pinned client reads, not just the new field.
204///
205/// It accepts ANY input, not just an unrecognized string — `null`, a number, an object all read as
206/// `Unknown`. `#[serde(default)]` covers an ABSENT key and nothing else, so without this a proxy or
207/// non-Rust daemon that normalizes optional fields to `null` would fail every reachability frame
208/// while this module's doc promised the field could not break a parse. A degraded attribution is
209/// the fail-safe: `Unknown` already means "we do not know", which is exactly true of a value we
210/// could not read.
211impl<'de> Deserialize<'de> for ReachabilitySource {
212    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
213        struct AnySource;
214
215        /// Every hook answers `Unknown` except `visit_str`, so a shape we do not model degrades
216        /// instead of erroring. `visit_map`/`visit_seq` must DRAIN their input — leaving it
217        /// unconsumed desynchronizes the parser and fails the enclosing frame, which is the
218        /// failure this impl exists to avoid.
219        impl<'de> serde::de::Visitor<'de> for AnySource {
220            type Value = ReachabilitySource;
221
222            fn expecting(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
223                f.write_str("a reachability producer name")
224            }
225
226            fn visit_str<E: serde::de::Error>(self, s: &str) -> Result<Self::Value, E> {
227                Ok(match s {
228                    "probe" => ReachabilitySource::Probe,
229                    "session" => ReachabilitySource::Session,
230                    _ => ReachabilitySource::Unknown,
231                })
232            }
233
234            fn visit_unit<E: serde::de::Error>(self) -> Result<Self::Value, E> {
235                Ok(ReachabilitySource::Unknown)
236            }
237
238            fn visit_none<E: serde::de::Error>(self) -> Result<Self::Value, E> {
239                Ok(ReachabilitySource::Unknown)
240            }
241
242            fn visit_some<D: serde::Deserializer<'de>>(
243                self,
244                d: D,
245            ) -> Result<Self::Value, D::Error> {
246                d.deserialize_any(AnySource)
247            }
248
249            fn visit_bool<E: serde::de::Error>(self, _: bool) -> Result<Self::Value, E> {
250                Ok(ReachabilitySource::Unknown)
251            }
252
253            fn visit_i64<E: serde::de::Error>(self, _: i64) -> Result<Self::Value, E> {
254                Ok(ReachabilitySource::Unknown)
255            }
256
257            fn visit_u64<E: serde::de::Error>(self, _: u64) -> Result<Self::Value, E> {
258                Ok(ReachabilitySource::Unknown)
259            }
260
261            fn visit_f64<E: serde::de::Error>(self, _: f64) -> Result<Self::Value, E> {
262                Ok(ReachabilitySource::Unknown)
263            }
264
265            fn visit_map<A: serde::de::MapAccess<'de>>(
266                self,
267                mut m: A,
268            ) -> Result<Self::Value, A::Error> {
269                while m
270                    .next_entry::<serde::de::IgnoredAny, serde::de::IgnoredAny>()?
271                    .is_some()
272                {}
273                Ok(ReachabilitySource::Unknown)
274            }
275
276            fn visit_seq<A: serde::de::SeqAccess<'de>>(
277                self,
278                mut s: A,
279            ) -> Result<Self::Value, A::Error> {
280                while s.next_element::<serde::de::IgnoredAny>()?.is_some() {}
281                Ok(ReachabilitySource::Unknown)
282            }
283        }
284
285        d.deserialize_any(AnySource)
286    }
287}
288
289/// Roster-mode status. Surface-clean roster VOCABULARY only: org_id, serial, a plain
290/// state word, and the pinned org-root FINGERPRINT in short words — never raw keys/EndpointIds/serials-
291/// as-transport-vocab. Absent in a pure-pairing daemon.
292#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
293pub struct RosterStatus {
294    pub org_id: String,
295    pub serial: u64,
296    pub state: String, // "pending" | "approved" | "degraded" | "stopped"
297    pub org_root_fingerprint: String, // short-word form
298    /// The org's DECLARED group namespace, in roster document order (#93). `api_minor >= 46`.
299    ///
300    /// The set an `allow` entry may name — a roster is refused if any user carries a group outside
301    /// it — so this is what a UI offers when assigning membership. Without it an embedder in roster
302    /// mode had managed group membership it could not enumerate, and the only way to learn the
303    /// groups was to hand-parse the daemon-owned `roster.json`.
304    ///
305    /// Display/authoring input, never an authorization answer: naming a group grants nothing.
306    /// Additive — a payload from an older daemon reads as an empty list.
307    #[serde(default, skip_serializing_if = "Vec::is_empty")]
308    pub groups: Vec<String>,
309}
310
311/// One reachable roster peer device as reported by `status` (the advisory presence read).
312/// ADVISORY — this is a display convenience, never an authorization surface. Surface-clean:
313/// FLAT vocabulary ONLY — a `user_id`, a human `device_label`, its `role` word, and an `online`
314/// boolean. It carries NO EndpointId / pubkey / hash / ALPN or any transport vocabulary.
315#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
316pub struct PresencePeer {
317    pub user_id: String,
318    /// The person's human display name from the roster (#93). `api_minor >= 46`.
319    ///
320    /// `user_id` is an authorization handle; this is what a UI puts next to a face. The roster
321    /// carried it all along and the control seam dropped it, so an embedder had a presence list it
322    /// could only label with an opaque id. Display-only — never an authz input.
323    ///
324    /// Additive: absent from an older daemon's payload, and empty when the roster's own field is.
325    #[serde(default, skip_serializing_if = "String::is_empty")]
326    pub display_name: String,
327    /// The groups this person belongs to (#93). `api_minor >= 46`.
328    ///
329    /// The same strings an `allow` entry names, so a UI can show why someone is admitted without
330    /// re-deriving it. Advisory display data: the gate reads the roster, never this. Additive.
331    #[serde(default, skip_serializing_if = "Vec::is_empty")]
332    pub groups: Vec<String>,
333    pub device_label: String,
334    pub role: String, // "primary" | "mirror" (roster vocabulary)
335    /// Whether the device has a live presence heartbeat (advisory — absence never blocks a dial).
336    pub online: bool,
337    /// The device's OPTIONAL embedder-set app metadata (#39) — an opaque ≤256B blob carried
338    /// (signed) on its presence heartbeat, empty when the device set none. Advisory display
339    /// data; never an authz input. Additive: default + skip-if-empty.
340    #[serde(default, skip_serializing_if = "String::is_empty")]
341    pub meta: String,
342}
343
344/// One recently completed INVITER-side pairing, surfaced by `status` so the inviter's human can
345/// read the short authentication code (SAS) and compare it with the redeemer's out-of-band —
346/// the pairing ceremony is "both humans compare the code": the redeemer sees it in its
347/// [`PairResult`]; this is the inviter's porcelain surface for the same words. DISPLAY-ONLY
348/// ceremony state: held in-memory by the daemon (a small ring), lost on restart, NEVER an
349/// authorization input or trust data. Surface-clean: a nickname + the SAS wordlist words +
350/// an epoch — never an EndpointId.
351#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
352pub struct RecentPairing {
353    /// The peer's nickname as stored by the inviter (its local name for the redeemer).
354    pub peer_nickname: String,
355    /// The display-only SAS words (e.g. `"tango-fig-cabbage"`) — the same code the redeemer's
356    /// `PairResult.sas_code` carried. Never checked programmatically.
357    pub sas_code: String,
358    /// When the pairing completed (epoch seconds) — the porcelain renders a friendly age.
359    pub paired_at_epoch: u64,
360}
361
362#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
363pub struct StatusResult {
364    pub stack_version: String,
365    pub services: Vec<ServiceInfo>,
366    pub peers: Vec<PeerInfo>,
367    /// Roster-mode status, absent in a pure-pairing daemon. Additive:
368    /// `#[serde(default, skip_serializing_if = ...)]` so a daemon/client without it round-trips.
369    #[serde(default, skip_serializing_if = "Option::is_none")]
370    pub roster: Option<RosterStatus>,
371    /// The reachable roster peer devices (the advisory presence read), each with an `online`
372    /// flag. Empty in a pure-pairing daemon / when no roster is installed. Additive:
373    /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
374    #[serde(default, skip_serializing_if = "Vec::is_empty")]
375    pub presence: Vec<PresencePeer>,
376    /// THIS daemon's own self-sovereign `user_id` (`b64u:<user_pk>`), if it has a user key (auto-
377    /// minted at boot; shared by pairing AND roster mode). Lets the operator see + share their stable
378    /// identity that multiple devices resolve to. `None` only when no user key exists. Additive:
379    /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so an older payload round-trips.
380    #[serde(default, skip_serializing_if = "Option::is_none")]
381    pub self_user_id: Option<String>,
382    /// Recent INVITER-side pairing completions, newest first (display-only pairing-ceremony aids —
383    /// see [`RecentPairing`]; in-memory on the daemon, cleared by a restart). Empty on a daemon
384    /// that has accepted no pairing since it started. Additive:
385    /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
386    #[serde(default, skip_serializing_if = "Vec::is_empty")]
387    pub recent_pairings: Vec<RecentPairing>,
388    /// Advisory reachability of paired peers, from the on-demand probe cache. Empty until the
389    /// first probe completes. Additive: default + skip-if-empty.
390    #[serde(default, skip_serializing_if = "Vec::is_empty")]
391    pub reachability: Vec<PeerReachability>,
392    /// This node's EFFECTIVE self-nickname — what a freshly minted invite would present
393    /// (config `[identity].nickname`, else the hostname, else a fingerprint; live-updated by
394    /// `set_nickname`, #37). Empty only in mesh-less control-only mode. Additive: default +
395    /// skip-if-empty so an older payload round-trips.
396    #[serde(default, skip_serializing_if = "String::is_empty")]
397    pub self_nickname: String,
398    /// On-disk footprint of this node's own state (#88), so an embedder can warn a user before
399    /// ENOSPC rather than after — the audit log's write rate is driven by inbound peer traffic,
400    /// and it shares a filesystem with `state.redb` and the device key. A LIVE read (computed
401    /// per `status` call), not a boot-time snapshot. `None` only in mesh-less control-only mode.
402    /// Additive: default + skip-if-none so an older payload round-trips.
403    #[serde(default, skip_serializing_if = "Option::is_none")]
404    pub storage: Option<StorageInfo>,
405    /// Endpoints this node currently REFUSES (#85 ask 4, `api_minor >= 51`), local or signed.
406    ///
407    /// Present because a revocation is otherwise invisible: a peer that has been cut off simply
408    /// stops working, and neither side can tell that from a network fault. Empty on the
409    /// overwhelming majority of nodes, so it is elided rather than serialized as `[]`.
410    #[serde(default, skip_serializing_if = "Vec::is_empty")]
411    pub revoked: Vec<RevokedEndpoint>,
412    /// THIS node's own reachability posture (#90) — see [`SelfNetwork`]. Computed live per
413    /// call; `None` in mesh-less control-only mode. Additive: default + skip-if-none.
414    #[serde(default, skip_serializing_if = "Option::is_none")]
415    pub self_network: Option<SelfNetwork>,
416}
417
418/// The `status.self_network` block (#90): THIS node's own reachability posture — the first
419/// question in every "my message never arrived" investigation, previously unanswerable from
420/// either side of the API. Self-facing only: everything here is the node's own information
421/// (relay URLs come from its own config, sanitized; direct addresses already ride its invites).
422///
423/// `online` is iroh's own semantics — a home-relay connection is established. In
424/// `relay_mode = "disabled"` it is ALWAYS `false` with an empty `relays` list: that is a
425/// configuration, not an outage — render it as "LAN-only", never as a health warning.
426///
427/// Additive-only.
428///
429/// **`Default` is `{online: false, relays: []}` — which is exactly the shape above meaning
430/// "deliberately LAN-only" (#148).** The porcelain reads it that way and SUPPRESSES the "no relay
431/// connection" line for it. So a fixture built with `..Default::default()` claims a healthy
432/// LAN-only posture, not an unknown one. There is no third value for a `bool`; the honest way to
433/// say "nobody looked" is `StatusResult.self_network: None`, which is what a defaulted
434/// `StatusResult` gives you.
435#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
436pub struct SelfNetwork {
437    /// A home-relay connection is established (iroh's `online` definition). The signal #53's
438    /// `set_relays` never had: when this goes false on a relay-enabled node, the relay set is
439    /// the thing to look at.
440    pub online: bool,
441    /// The CONNECTED home relay's URL, sanitized to scheme + host + port (operator-supplied
442    /// relay URLs can carry userinfo tokens; `status` output gets screenshotted). `None` when
443    /// no relay is connected.
444    #[serde(default, skip_serializing_if = "Option::is_none")]
445    pub home_relay: Option<String>,
446    /// Every known home relay and its current connection state. Empty when no relays are
447    /// configured, or before the endpoint has selected any.
448    #[serde(default, skip_serializing_if = "Vec::is_empty")]
449    pub relays: Vec<RelayInfo>,
450    /// This endpoint's direct (non-relay) socket addresses — its own dialable coordinates.
451    #[serde(default, skip_serializing_if = "Vec::is_empty")]
452    pub direct_addrs: Vec<String>,
453    /// When the daemon's watcher last observed a TRANSITION (epoch seconds) — a change of
454    /// `online`, `home_relay`, or a relay's connection state; `direct_addrs` drift alone does
455    /// not stamp (nor emit a frame). OMITTED (not `null`) until the first observed transition
456    /// after boot, and from a point-in-time computation with no watcher running.
457    #[serde(default, skip_serializing_if = "Option::is_none")]
458    pub last_change_epoch: Option<i64>,
459    /// This node's `[network].presence_mode` (#89): `"paired"` | `"granted"` | `"off"` — who
460    /// currently gets an answer to the `mcpmesh/ping/1` reachability probe.
461    ///
462    /// Reported because the setting was otherwise **unobservable**: an operator who set it had no
463    /// way to confirm it took effect, and a product backing a privacy switch with it could not show
464    /// the user its real state. Always present from `api_minor >= 38`.
465    ///
466    /// **It is not "appear offline".** It withholds the pong payload and makes our own probe report
467    /// this node unreachable; it does not hide that the node is running (a QUIC application close
468    /// implies a completed handshake, and `mcpmesh/pair/1` answers any stranger by design). Do not
469    /// render it to users as invisibility.
470    #[serde(default, skip_serializing_if = "Option::is_none")]
471    pub presence_mode: Option<String>,
472    /// This node's `[network].local_discovery` (#68): `"off"` | `"on"` | `"resolve"` — whether it
473    /// finds peers on the local link with no internet, and whether it announces itself there.
474    ///
475    /// Reported for the same reason `presence_mode` is: the setting is otherwise unobservable, and
476    /// this one has two questions behind it. "Why can these two machines on one LAN not find each
477    /// other" is answered by `"off"`; and **`"on"` means this node is multicasting its endpoint id
478    /// and addresses to every device on the link**, which a product backing a privacy switch has to
479    /// be able to show the user. `"resolve"` never publishes this node's identity or addresses,
480    /// but still emits a service query roughly once a second — quieter than `"on"`, not silent.
481    ///
482    /// Always present from `api_minor >= 50`; absent below it, and absent without a mesh.
483    #[serde(default, skip_serializing_if = "Option::is_none")]
484    pub local_discovery: Option<String>,
485    /// When the relay last reported that ANOTHER endpoint is presenting this node's identity
486    /// (#134, epoch seconds), or absent if never — the overwhelmingly common case.
487    ///
488    /// Two nodes booted from COPIES of one mesh root share an endpoint id. The relay can serve only
489    /// one, so the displaced node's peers simply go unreachable with nothing saying why; diagnosing
490    /// that cost a downstream real time. This is that missing "why".
491    ///
492    /// **Sticky, and a timestamp rather than a flag.** The condition is announced once, as the
493    /// displaced connection is dropped — it is not a state the relay keeps reporting — so a
494    /// self-clearing flag would read false by the time anyone called `status`. Judge staleness from
495    /// the epoch, exactly as with `last_change_epoch`.
496    ///
497    /// **Absence is not proof of uniqueness.** Detection needs an
498    /// `IdentityConflictLayer` in the process's `tracing` subscriber: the standalone daemon
499    /// installs one at boot, but an EMBEDDED node cannot (a subscriber is global and the host owns
500    /// it) and reports `None` until the host installs it. Never render absence as "identity
501    /// verified unique".
502    ///
503    /// Additive: `#[serde(default, skip_serializing_if = "Option::is_none")]`. `api_minor >= 32`.
504    #[serde(default, skip_serializing_if = "Option::is_none")]
505    pub identity_conflict_epoch: Option<i64>,
506}
507
508/// One home relay's connection state (#90). No latency — per-relay RTT needs iroh's
509/// `net_report`, which is unstable-feature-gated as of 1.0.3; `connected` is the stable truth.
510#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
511pub struct RelayInfo {
512    /// Sanitized (scheme + host + port), like `home_relay`.
513    pub url: String,
514    pub connected: bool,
515}
516
517/// One entry of `status.revoked` (#85 ask 4).
518#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
519pub struct RevokedEndpoint {
520    /// The `eid:` device principal that is refused.
521    pub principal: String,
522    /// When THIS node applied it, epoch seconds.
523    pub revoked_at_epoch: u64,
524    /// `"local"` — this operator's own decision about someone else's device — or `"signed"`, a
525    /// statement the device's OWNER issued about their own. Two different claims, and an operator
526    /// reading this list needs to tell them apart: only the second is evidence that the person
527    /// themselves declared the device dead.
528    pub source: String,
529    /// For `"signed"`: the verified `b64u:` that signed it.
530    #[serde(default, skip_serializing_if = "Option::is_none")]
531    pub signer_user_id: Option<String>,
532    /// Free-text operator note, never interpreted.
533    #[serde(default, skip_serializing_if = "Option::is_none")]
534    pub reason: Option<String>,
535    /// The local nickname this endpoint still has a pair row under, if any. Revocation does not
536    /// delete the row, so this is usually present — and it is what makes the list readable.
537    #[serde(default, skip_serializing_if = "Option::is_none")]
538    pub nickname: Option<String>,
539}
540
541/// The `status.storage` block (#88): bytes actually on disk, by subsystem. Counts, never
542/// content. Additive-only.
543///
544/// **`Default` is all zeros, which reads as "measured, and found empty" (#148).** It is here so a
545/// fixture can build one field and elide the rest; it is not a way to say "unmeasured". For that,
546/// leave `StatusResult.storage` as `None` — a defaulted `StatusResult` does exactly that.
547#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
548pub struct StorageInfo {
549    /// Summed sizes of the monthly audit files (`<state>/audit/*.jsonl`).
550    pub audit_bytes: u64,
551    /// Size of the peer/trust state store (`state.redb`).
552    pub redb_bytes: u64,
553    /// Total size under the app-blob store directory; 0 when no blob store exists.
554    pub blobs_bytes: u64,
555    /// Blob garbage collection (#80), or `None` when it is not configured — which is the default
556    /// and the behavior of every release up to 0.42.0.
557    ///
558    /// `None` means "not collecting", NOT "collecting and idle": a configured collector reports
559    /// `Some` with `runs: 0` until its first sweep.
560    #[serde(default, skip_serializing_if = "Option::is_none")]
561    pub blobs_gc: Option<BlobsGcInfo>,
562}
563
564/// The `status.storage.blobs_gc` block (#80): what the background app-blob collector has done.
565///
566/// **There is deliberately no `bytes_reclaimed`.** iroh-blobs calls back only BEFORE a sweep, never
567/// after, so any byte count here would be a guess. `blobs_bytes` is measured by walking the store
568/// directory; an operator reads reclaim off that, over time.
569#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
570pub struct BlobsGcInfo {
571    /// The interval the store is actually running on, in seconds.
572    pub interval_secs: u64,
573    /// Runs STARTED. iroh-blobs offers no completion callback, so this counts sweeps begun.
574    ///
575    /// **Watch this number.** Upstream's collector `break`s its loop on the first sweep error
576    /// rather than continuing, so one failure silently ends collection until the daemon restarts. A
577    /// `runs` that stops advancing across several intervals is the only signal that happened.
578    ///
579    /// Also: the collector SLEEPS before its first run, so a node with a 24h interval reports
580    /// `runs: 0` for its first 24 hours. That is not a fault.
581    pub runs: u64,
582    /// Unix seconds at the start of the most recent run; `None` before the first.
583    pub last_run_epoch: Option<i64>,
584    /// Hashes protected on the most recent run — the size of the liveness root the scope table
585    /// produced.
586    pub last_protected: u64,
587    /// Runs ABORTED because the liveness root could not be read. Each one swept nothing, which is
588    /// the intended fail-safe; a number that climbs means collection is not happening.
589    pub aborted: u64,
590}
591
592/// Params of [`Request::RegisterService`]: the `[services.*]` entry to write/update.
593#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
594#[serde(deny_unknown_fields)]
595pub struct RegisterServiceParams {
596    pub name: String,
597    pub backend: BackendSpec,
598    pub allow: Vec<String>,
599    /// When true (#36), the registration is EPHEMERAL: kept in daemon memory only, never written
600    /// to the on-disk config, and automatically unregistered when the control connection that
601    /// registered it closes (and gone on daemon restart). For an embedder that serves a
602    /// `socket` backend from a fresh path each run, this removes the need to derive a stable
603    /// socket path solely to keep a persisted registration valid, and the stale-registration
604    /// accumulation that comes with no unregister. Default false = the persistent behavior.
605    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
606    pub ephemeral: bool,
607    /// Per-service proxied-request rate (#63), falling back to `[limits].rate_limit_per_min`.
608    ///
609    /// **CLAMPED, never honoured upward.** `[limits].rate_limit_per_min` is a hard ceiling: a
610    /// larger value here is reduced to it, so a control call cannot uncap a service. Before #63
611    /// every service a peer could reach drew from one shared bucket, so a noisy service starved a
612    /// quiet one; buckets are now per `(service, endpoint)`.
613    ///
614    /// `0` is rejected rather than silently blocking every request. `api_minor >= 40`.
615    #[serde(default, skip_serializing_if = "Option::is_none")]
616    pub rate_limit_per_min: Option<u32>,
617}
618
619/// Params of [`Request::Invite`]: the services the minted invite grants. Rejects unknown
620/// fields (so `{service: "kb"}` — a singular typo — is a loud error, not a silently
621/// grants-nothing invite), and the daemon additionally rejects an empty/absent `services`
622/// list (an invite that grants nothing is useless — #34).
623#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
624#[serde(deny_unknown_fields)]
625pub struct InviteParams {
626    #[serde(default)]
627    pub services: Vec<String>,
628    /// An OPAQUE, caller-chosen label carried through to the redeemer in the `pair` result (#31).
629    /// mcpmesh never interprets it (not a nickname, never resolved or authorized) — a per-pairing
630    /// metadata slot for the embedder (e.g. its own URN). Capped at the daemon; omit for none.
631    #[serde(default, skip_serializing_if = "Option::is_none")]
632    pub app_label: Option<String>,
633    /// How many times this invite may be redeemed (#87). Absent = **1**, the single-use behaviour
634    /// every existing caller already gets.
635    ///
636    /// Each redemption runs its OWN SAS ceremony and writes its own mutual peer rows — this is not
637    /// a shared or group identity, it is N independent pairings that happen to share one secret.
638    /// Onboarding a team stops being N mint-and-send rounds.
639    ///
640    /// Clamped to [`MAX_INVITE_USES`]; `0` is rejected rather than silently meaning "unusable". A
641    /// bearer credential's blast radius is `max_uses` × TTL, so it is opt-in and capped on purpose.
642    /// The value actually applied comes back in [`InviteResult::uses_remaining`] — read that rather
643    /// than assuming you got what you asked for.
644    ///
645    /// **`api_minor >= 35`, and sending it to an older daemon FAILS rather than degrading.**
646    /// `InviteParams` is `deny_unknown_fields`, so an `api_minor < 35` daemon answers `-32602
647    /// unknown field 'max_uses'` — it does not quietly mint a single-use invite. Loud is the right
648    /// behaviour; omit the field entirely when talking to one.
649    #[serde(default, skip_serializing_if = "Option::is_none")]
650    pub max_uses: Option<u32>,
651    /// YOUR local name for whoever redeems this invite (#87), overriding the nickname they claim
652    /// for themselves in the ceremony.
653    ///
654    /// The redeemer's self-claimed name is usually its hostname, so two same-model laptops collide
655    /// and the pairing is refused with [`ERR_NICKNAME_TAKEN`]. Before this field the only fixes
656    /// were to ask the other person to rename their machine, or to unpair whoever holds the name.
657    /// This lets you just call them something else.
658    ///
659    /// Local only: it is never sent to the peer and never affects what they call themselves or
660    /// you. It does **not** bypass the collision check — an alias that itself collides is refused
661    /// identically, because a duplicate display name makes your own `<peer>/<service>` routing
662    /// ambiguous whoever chose it.
663    ///
664    /// **Rejected with `max_uses > 1`:** one alias applied to every redeemer of a multi-use invite
665    /// would collide on the second redemption, so it is refused at MINT rather than producing an
666    /// invite that works exactly once. `api_minor >= 39`.
667    #[serde(default, skip_serializing_if = "Option::is_none")]
668    pub peer_nickname: Option<String>,
669    /// Mint a SELF-ENROLLMENT invite (#86): the redeemer becomes another device of **you**, not a
670    /// peer.
671    ///
672    /// The ceremony is the ordinary one — same secret, same SAS. What differs is the outcome:
673    /// neither side writes a peer row and nothing is granted, and the inviter signs a device→user
674    /// binding for the redeemer's authenticated endpoint. Both devices then present the same
675    /// `user_pk`, so every peer resolves them to ONE `user_id`.
676    ///
677    /// **The private key never moves.** The enrolling device signs a binding for the new device's
678    /// endpoint and hands over only that signature, so a second copy of the identity never exists.
679    /// The consequence: an enrolled device cannot enroll a third — enroll every device from the one
680    /// that holds the key.
681    ///
682    /// **The SAS matters more here than anywhere else.** The inviter signs a binding for whichever
683    /// endpoint redeems, so a redemption by an impostor mints *that impostor* a binding for your
684    /// identity. Requires `max_uses = 1` and an empty `services`, both refused otherwise.
685    /// `api_minor >= 43`.
686    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
687    pub as_self: bool,
688}
689
690/// The ceiling on [`InviteParams::max_uses`] (#87). Comfortably above "a team", far below "a
691/// fleet": one leaked invite line must not be able to enroll an unbounded number of devices for the
692/// whole 24h TTL.
693pub const MAX_INVITE_USES: u32 = 64;
694
695/// Params of [`Request::Pair`]: the copyable `mcpmesh-invite:` line. Defaultable — an
696/// absent field reads as an empty line, which simply fails to decode (a clean pair error).
697#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
698#[serde(deny_unknown_fields)]
699pub struct PairParams {
700    #[serde(default)]
701    pub invite_line: String,
702    /// YOUR local name for the inviter (#87), overriding the nickname their invite suggests.
703    ///
704    /// An invite carries the inviter's suggestion for what you should call them — usually their
705    /// hostname. If you already use that name for a different peer, the pairing is refused with
706    /// [`ERR_INVITE_NAME_CONFLICT`] and the message tells you to go ask them for a new invite.
707    /// This lets you resolve it yourself, without `set_nickname` (which rewrites your own GLOBAL
708    /// self-name — not what anyone wants in order to add one colleague).
709    ///
710    /// Local only: never sent to the inviter. It does **not** bypass the collision check — an alias
711    /// that itself collides is refused identically, because a duplicate display name makes your own
712    /// `<peer>/<service>` routing ambiguous whoever chose it. `api_minor >= 39`.
713    #[serde(default, skip_serializing_if = "Option::is_none")]
714    pub as_nickname: Option<String>,
715    /// Consent to complete a SELF-ENROLLMENT (#178): a `mcpmesh-enroll:` line is refused with
716    /// [`ERR_SELF_ENROLL_NOT_OFFERED`] unless this is set.
717    ///
718    /// Defaults to `false`, which is the whole point. #86 gave self-enrollment its own scheme so a
719    /// version-skewed redeemer refuses rather than pairing wrongly — but a CURRENT caller that only
720    /// ever meant to pair still ran the ceremony to completion, and learned which one it had run
721    /// from [`PairResult::enrolled_as_self`] only AFTER the device→user binding was written. That
722    /// binding admits this device to everyone who trusts the inviter's `user_id`, and it is
723    /// irrevocable short of rotating that user key — so "observe it afterwards" is not a place a
724    /// caller can refuse from.
725    ///
726    /// Set it when the ceremony is one your UI actually OFFERED ("add another of my devices"). Leave
727    /// it unset on an ordinary "join / add a contact" field: the refusal costs nothing, the invite is
728    /// untouched (nothing is dialled and nothing is burned), and the same line still works if the
729    /// person is then offered the real choice.
730    ///
731    /// To decide BEFORE calling — to show the right prompt rather than recover from a refusal — use
732    /// `mcpmesh_node::pairing::is_enrollment_line`. `api_minor >= 45`.
733    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
734    pub allow_self_enroll: bool,
735}
736
737/// Params of [`Request::AttestTo`] (#85 ask 3).
738#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
739#[serde(deny_unknown_fields)]
740pub struct AttestToParams {
741    /// A `mcpmesh-attest:` line from the peer that will admit this device.
742    pub offer: String,
743}
744
745/// Result of [`Request::AttestOffer`] (#85 ask 3).
746#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
747pub struct AttestOfferResult {
748    /// The `mcpmesh-attest:` line. Hand it to your other device.
749    pub offer: String,
750}
751
752/// Params of [`Request::PeerRevoke`] (#85 ask 4).
753#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
754#[serde(deny_unknown_fields)]
755pub struct PeerRevokeParams {
756    /// A nickname, an `eid:` device principal, or a `b64u:` user_id. A `b64u:` revokes EVERY
757    /// endpoint this node associates with that person.
758    pub peer: String,
759    /// Free-text operator note, stored and shown in `status`. Never interpreted.
760    #[serde(default, skip_serializing_if = "Option::is_none")]
761    pub reason: Option<String>,
762}
763
764/// Result of [`Request::PeerRevoke`].
765#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
766pub struct PeerRevokeResult {
767    /// The `eid:` principals now revoked. Empty means the name resolved to no endpoint — an ERROR
768    /// is returned instead in that case, so an empty list here never reads as success.
769    pub revoked: Vec<String>,
770    /// Live connections severed by this call. `0` is normal (the peer may be offline) and is NOT a
771    /// failure — but a non-zero count is the evidence that revocation was immediate rather than
772    /// deferred to the peer's next disconnect.
773    pub severed: usize,
774}
775
776/// Params of [`Request::PeerUnrevoke`] (#85 ask 4).
777///
778/// A nickname or `eid:` lifts that device's ENDPOINT revocation and reports it in `unrevoked` —
779/// but under a standing IDENTITY revocation (`peer_revoke b64u:`) on the `user_id` its row carries,
780/// that re-admits nothing (#218, `api_minor >= 61`): the gate still refuses the device on the
781/// identity. Unrevoke the `b64u:` to restore every device of the person.
782#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
783#[serde(deny_unknown_fields)]
784pub struct PeerUnrevokeParams {
785    /// Nickname, `eid:`, or `b64u:` — the same vocabulary as `peer_revoke`.
786    pub peer: String,
787}
788
789/// Result of [`Request::PeerUnrevoke`].
790#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
791pub struct PeerUnrevokeResult {
792    /// The `eid:` principals whose revocation was lifted. Empty = none were revoked (idempotent).
793    pub unrevoked: Vec<String>,
794}
795
796/// Params of [`Request::DeviceRevoke`] (#85 ask 4).
797#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
798#[serde(deny_unknown_fields)]
799pub struct DeviceRevokeParams {
800    /// The `eid:` principal of the device being revoked — one of THIS person's own.
801    ///
802    /// Explicit rather than "this node", because the device you are revoking is usually the one you
803    /// no longer have: you issue the token from your replacement machine, naming the lost one.
804    pub endpoint: String,
805    #[serde(default, skip_serializing_if = "Option::is_none")]
806    pub reason: Option<String>,
807}
808
809/// Result of [`Request::DeviceRevoke`]: the portable token, and what it says.
810#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
811pub struct DeviceRevokeResult {
812    /// The signed statement, `mcpmesh-revoke:<base64url>`. Hand this to your peers.
813    ///
814    /// Not a secret — it authorizes nothing and grants nothing; it only asks that an endpoint be
815    /// treated as dead, and only peers who already trust the signer will act on it.
816    pub token: String,
817    /// The `eid:` it revokes, echoed so a caller can confirm they named the device they meant.
818    pub endpoint: String,
819    /// The signing `b64u:` user_id — the identity your peers already pinned.
820    pub user_id: String,
821}
822
823/// Params of [`Request::DeviceRevocationImport`] (#85 ask 4).
824#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
825#[serde(deny_unknown_fields)]
826pub struct DeviceRevocationImportParams {
827    /// A `mcpmesh-revoke:` token from a peer.
828    pub token: String,
829}
830
831/// Result of [`Request::DeviceRevocationImport`].
832#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
833pub struct DeviceRevocationImportResult {
834    /// The `eid:` now revoked.
835    pub endpoint: String,
836    /// The `b64u:` that signed it — verified, not claimed.
837    pub user_id: String,
838    /// `false` when an equal-or-newer revocation for this endpoint was already held: the import is
839    /// idempotent, and a replayed OLDER token must not overwrite a newer one.
840    pub applied: bool,
841    /// Live connections severed. See `PeerRevokeResult::severed`.
842    pub severed: usize,
843}
844
845/// Params of [`Request::PeerRemove`]: the nickname to unpair.
846#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
847#[serde(deny_unknown_fields)]
848pub struct PeerRemoveParams {
849    pub nickname: String,
850}
851
852/// Params of [`Request::PeerRename`]: the contact to rename — every device sharing `user_id`
853/// when given, else the single provisional `nickname` entry — and the new nickname `to`.
854#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
855#[serde(deny_unknown_fields)]
856pub struct PeerRenameParams {
857    #[serde(default)]
858    pub user_id: Option<String>,
859    #[serde(default)]
860    pub nickname: Option<String>,
861    pub to: String,
862}
863
864/// Params of [`Request::PeerAdd`] (reserved/internal — see the variant): a raw `endpoint_id`
865/// (iroh base32) plus the nickname and service allow list to install it under.
866#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
867#[serde(deny_unknown_fields)]
868pub struct PeerAddParams {
869    pub nickname: String,
870    pub endpoint_id: String,
871    #[serde(default)]
872    pub allow: Vec<String>,
873}
874
875/// Params of [`Request::PeerEndorse`] (#65): vouch for a peer so a third party can install them.
876#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
877#[serde(deny_unknown_fields)]
878pub struct PeerEndorseParams {
879    /// The subject's endpoint id, `eid:<hex>` — usually a peer you are paired with, though the
880    /// daemon does not require that: an endorsement is YOUR statement, and the recipient decides
881    /// what it is worth.
882    pub subject: String,
883    /// The subject's user key, `b64u:`, when you are also vouching for that. The recipient will
884    /// additionally require the SUBJECT's own device binding before trusting it — see
885    /// [`PeerIntroduceParams::subject_binding`].
886    #[serde(default, skip_serializing_if = "Option::is_none")]
887    pub subject_user_id: Option<String>,
888}
889
890/// Result of [`Request::PeerEndorse`] (#65) — hand both fields to the recipient.
891#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
892pub struct PeerEndorseResult {
893    /// YOUR user id, `b64u:` — what the recipient passes as `endorsed_by`. They must already be
894    /// paired with you for it to resolve.
895    pub endorsed_by: String,
896    /// The signature, `b64u:` — what the recipient passes as `evidence`.
897    pub evidence: String,
898}
899
900/// Params of [`Request::PeerIntroduce`] (#65): install a peer vouched for by someone you are
901/// already paired with.
902///
903/// The endorsement replaces pairing's SAS with the endorser's signature, so you are trusting that
904/// endorser's judgment and key hygiene as well as their identity. It buys identity resolution only
905/// — see [`Request::PeerIntroduce`].
906#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
907#[serde(deny_unknown_fields)]
908pub struct PeerIntroduceParams {
909    /// The subject's endpoint id, `eid:<hex>` — who is being introduced.
910    pub subject: String,
911    /// The endorser's user public key, `b64u:`. MUST be the `user_id` of a CURRENTLY paired peer:
912    /// the chain has to terminate at someone you paired with yourself, so an endorsement from a
913    /// stranger — or from someone you have since unpaired — is refused.
914    pub endorsed_by: String,
915    /// The endorser's signature over the domain-separated preimage, `b64u:`.
916    pub evidence: String,
917    /// The subject's OWN user key, `b64u:`, so several of the subject's devices resolve to one
918    /// person. Part of the endorser's signed statement, so it cannot be added or removed after
919    /// the fact.
920    ///
921    /// **Requires `subject_binding` too, and is REFUSED without it.** A `user_id` is
922    /// authorization-bearing — service `allow` lists match on it — so the endorser vouching for it
923    /// is not enough: an endorser could otherwise name a *victim's* `user_id` (which is public, on
924    /// `status` and every audit record) for an attacker's endpoint, and the attacker would inherit
925    /// that victim's grants. The subject must prove the key is theirs.
926    #[serde(default, skip_serializing_if = "Option::is_none")]
927    pub subject_user_id: Option<String>,
928    /// The SUBJECT's own device→user binding for `subject_user_id`, `b64u:` — the same signature a
929    /// peer presents at pairing (`mcpmesh/join/device-binding/1`), proving *it* controls that user
930    /// key and that the key is bound to *this* endpoint.
931    ///
932    /// Two independent signatures are required for a `user_id`, and they say different things: the
933    /// endorser's says "I vouch for this endpoint", the subject's says "this user key is mine".
934    /// Neither alone is sufficient.
935    #[serde(default, skip_serializing_if = "Option::is_none")]
936    pub subject_binding: Option<String>,
937    /// YOUR local name for the subject. Same rules and the same collision guard as pairing (#87).
938    pub nickname: String,
939}
940
941/// Params of [`Request::OpenSession`]: the `peer/service` target to dial. Both fields are
942/// defaultable — an empty target simply fails the dial (a clean `-32055` error).
943#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
944#[serde(deny_unknown_fields)]
945pub struct OpenSessionParams {
946    #[serde(default)]
947    pub peer: String,
948    #[serde(default)]
949    pub service: String,
950    /// A QUIC idle timeout for THIS session only, in seconds (#166, `api_minor >= 54`).
951    ///
952    /// Absent inherits `[network].idle_timeout_secs`, i.e. today's behaviour. `0` means "no idle
953    /// timeout from this side" — the same meaning the node-wide knob gives it, so the two cannot be
954    /// read differently.
955    ///
956    /// **Only LOWERING is unilateral.** QUIC negotiates `max_idle_timeout` to the MINIMUM of the
957    /// two peers' values (RFC 9000 §10.1), so this can always make a session die sooner when it
958    /// goes quiet and can never make it outlive what the peer allows. Raising needs both peers
959    /// configured — which was already true of the node-wide knob, and which no per-connection seam
960    /// changes.
961    ///
962    /// **Outbound only, and that is not half a feature.** An accepted session uses the node-wide
963    /// value, because iroh gives the server config no per-connection seam — but the direction that
964    /// CAN work one-sidedly is available here, and the direction that cannot never worked anywhere.
965    /// A node wanting a shorter timeout on a session it did not initiate can dial instead.
966    ///
967    /// **Ignored on a RACING dial**, because that opens connections it then abandons. The precise
968    /// rule, since the first version of this sentence was wrong in both directions:
969    ///
970    /// - A **roster person** races whenever the roster lists them with ANY device — including
971    ///   exactly one — so a `user_id` naming a rostered person never gets it.
972    /// - A pairing-mode **`b64u:`** races only with TWO OR MORE stored devices; with exactly one it
973    ///   falls through to the single-entry path and DOES get it.
974    ///
975    /// The node logs at `warn!` when it drops the value, naming the peer — a caller cannot know how
976    /// many devices a peer has, so a silent drop would be unattributable. Name one device with
977    /// `eid:` to be certain.
978    ///
979    /// No per-connection KEEPALIVE: iroh caps the per-path keepalive at 5s and discards larger
980    /// values, so one could only make pings more frequent — the node-wide knob already refuses that
981    /// direction (#56).
982    #[serde(default, skip_serializing_if = "Option::is_none")]
983    pub idle_timeout_secs: Option<u64>,
984}
985
986/// Params of [`Request::RosterInstall`]: the LOCAL roster file `path`, plus the org-root pin
987/// on FIRST install (`b64u:`; omit once pinned — config carries it).
988#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
989#[serde(deny_unknown_fields)]
990pub struct RosterInstallParams {
991    pub path: String,
992    #[serde(default, skip_serializing_if = "Option::is_none")]
993    pub org_root_pk: Option<String>,
994}
995
996/// Params of [`Request::OrgJoin`]: the `[identity]` pin. `user_key` is a LOCAL path — the key
997/// never crosses the API.
998#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
999#[serde(deny_unknown_fields)]
1000pub struct OrgJoinParams {
1001    pub org_id: String,
1002    pub org_root_pk: String,
1003    pub user_id: String,
1004    pub user_key: String,
1005}
1006
1007/// Params of [`Request::SetAppMetadata`]: this node's opaque app-metadata blob (#39). The
1008/// daemon NEVER interprets it — the embedder structures its own bytes (a version string,
1009/// small JSON, …). Capped at 256 bytes; `""` clears it. Roster-mode only (it rides the
1010/// signed presence heartbeat); a pure-pairing daemon accepts + stores it but never gossips it.
1011#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1012#[serde(deny_unknown_fields)]
1013pub struct SetAppMetadataParams {
1014    pub metadata: String,
1015}
1016
1017/// Params of [`Request::PeerServices`] (#52): the peer to query — a nickname, an `eid:` device
1018/// principal, or a `b64u:` user_id.
1019#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1020#[serde(deny_unknown_fields)]
1021pub struct PeerServicesParams {
1022    pub peer: String,
1023}
1024
1025/// Result of [`Request::PeerServices`] (#52): the services the queried peer CURRENTLY grants the
1026/// caller — computed authoritatively on the peer (which owns the truth), always current, only
1027/// the caller's own admitted services (never the peer's full registry).
1028#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1029pub struct PeerServicesResult {
1030    pub services: Vec<String>,
1031}
1032
1033/// Params of [`Request::PeerDiagnostics`] (#140): the peer to dump — a nickname or an `eid:`
1034/// device principal.
1035#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1036#[serde(deny_unknown_fields)]
1037pub struct PeerDiagnosticsParams {
1038    pub peer: String,
1039}
1040
1041/// Result of [`Request::PeerDiagnostics`] (#140): the DURABLE per-peer state this node carries,
1042/// for diagnosing why a specific long-lived pairing behaves differently from a fresh one.
1043///
1044/// **This surface carries a PEER's transport coordinates on purpose.** The rendered porcelain is
1045/// address-free everywhere — nicknames and path KINDS — because that discipline keeps a peer's
1046/// coordinates out of screenshots. (`SelfNetwork.direct_addrs` already returns this node's OWN
1047/// addresses on `status`; what is new here is another endpoint's.) The question this answers is
1048/// "what address is this node about to dial, and where did it come from", which has no answer
1049/// without the address. It is your own store's record of your own paired peers. Do not render it
1050/// in ordinary porcelain, and read it before pasting it anywhere public.
1051///
1052/// The intended use is a paired capture: run it on BOTH ends of a stuck pairing and compare the
1053/// stored hint against the live path each side reports.
1054#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1055pub struct PeerDiagnosticsResult {
1056    /// The peer's nickname as this node stores it.
1057    pub nickname: String,
1058    /// The peer's stable `eid:` device principal.
1059    pub principal: String,
1060    /// The peer's `b64u:` user_id if it proved a device→user binding at pairing.
1061    #[serde(default, skip_serializing_if = "Option::is_none")]
1062    pub user_id: Option<String>,
1063    /// When the pairing was written (epoch seconds as a string), if recorded. A LONG-LIVED pairing
1064    /// is exactly what #140 is about, so the age is part of the evidence.
1065    #[serde(default, skip_serializing_if = "Option::is_none")]
1066    pub paired_at: Option<String>,
1067    /// The persisted dial HINT, verbatim as stored — the durable state a freshly paired identity
1068    /// does not have. `None` for a peer added without one.
1069    ///
1070    /// It is MERGED with discovery rather than replacing it — iroh inserts it as one more
1071    /// candidate path (`Source::App`) and then triggers address lookup.
1072    ///
1073    /// **But that lookup is skipped when a path is already selected.** iroh's
1074    /// `trigger_address_lookup` returns early if `selected_path.is_some()`, and a selected path is
1075    /// cleared only when the last connection to that peer closes. So on a pair that already holds
1076    /// an open RELAYED connection — live sessions, dial-backs, a working relay — discovery does
1077    /// NOT re-run, and this hint is the only addressing the dial contributes. Do not read "merged,
1078    /// so a stale hint is harmless" as unconditional; it is least true in exactly the state a
1079    /// stuck pairing is in.
1080    ///
1081    /// It is the only durable per-peer state ON THIS NODE'S DISK that the dial path reads, which
1082    /// is what makes it the first thing to compare between two ends. It is not the only durable
1083    /// state a long-lived identity carries — a published discovery record under the same key, and
1084    /// [`SelfNetwork::identity_conflict_epoch`], live elsewhere.
1085    #[serde(default, skip_serializing_if = "Option::is_none")]
1086    pub last_addr: Option<String>,
1087    /// The addresses parsed out of `last_addr`, for reading without a JSON round trip: IP
1088    /// addresses verbatim, relay URLs as `relay <url>` and SANITIZED to scheme+host+port (an
1089    /// operator's relay URL can carry a userinfo token, and this output is meant to be pasted into
1090    /// an issue). Empty when the hint is absent, unparseable, or for a different endpoint — all of
1091    /// which degrade to an id-only dial.
1092    ///
1093    /// A `relay …` entry with no IP alongside it is worth noticing: that hint can never punch.
1094    #[serde(default, skip_serializing_if = "Vec::is_empty")]
1095    pub hint_addrs: Vec<String>,
1096    /// Whether the stored hint actually contributes anything to a dial. `false` with a present
1097    /// `last_addr` means it is being silently discarded — because it does not parse, because its
1098    /// embedded id is a different peer, or (since 0.52.1, #203) because every address in it is one
1099    /// that can never be a QUIC peer and was filtered out. `last_addr` is reported verbatim above,
1100    /// so comparing it against `hint_addrs` distinguishes the three.
1101    pub hint_usable: bool,
1102    /// This node's LIVE view of the peer, read straight from the reachability cache — the same
1103    /// values `status` reports, repeated here so one capture holds both the durable and the live
1104    /// side. `None` when this peer has **never been probed**, which is the honest answer on a
1105    /// freshly restarted daemon; it is not the same as unreachable.
1106    ///
1107    /// Read from the cache rather than through `status`'s projection deliberately: that projection
1108    /// spawns a background probe for every stale peer, which would make this diagnostic a
1109    /// participant in the reproduction it is meant to observe.
1110    #[serde(default, skip_serializing_if = "Option::is_none")]
1111    pub reachability: Option<PeerReachability>,
1112    /// What **iroh** currently holds for this endpoint, as opposed to what this node stored
1113    /// (#140, `api_minor >= 56`). The other half of the capture, and the half the standing
1114    /// hypothesis lives in.
1115    ///
1116    /// Everything above describes our own disk. Until this field there was no way to see what iroh
1117    /// made of it — whether the hint's addresses are in its remote map at all, whether discovery
1118    /// contributed anything alongside them, or which address is carrying traffic. Read straight off
1119    /// `Endpoint::remote_info`, a point read of the remote map: no dial, no probe, no address
1120    /// lookup, so this stays safe to run ON a live reproduction.
1121    ///
1122    /// **`None` means iroh currently holds NO ENTRY — which is not the same as an empty list, and
1123    /// is not the same as "never heard of".** iroh reaps a remote's state about 60 seconds after
1124    /// the last connection to it closes (`ACTOR_MAX_IDLE_TIMEOUT`), so `None` is the normal answer
1125    /// both for a peer never dialled AND for one talked to a few minutes ago. An empty list means
1126    /// iroh has an entry and holds no address in it.
1127    ///
1128    /// This distinction matters most to the question #140 is asking, which is about durability over
1129    /// time: reading `None` as "iroh never knew this peer" would be wrong on any daemon that has
1130    /// been idle, which is most of them.
1131    #[serde(default, skip_serializing_if = "Option::is_none")]
1132    pub known_addrs: Option<Vec<KnownAddr>>,
1133    /// Addresses in [`hint_addrs`](Self::hint_addrs) that iroh does **not** currently hold.
1134    ///
1135    /// The hint is written whole: `set_last_addr` REPLACES the stored value with one built from the
1136    /// live connection's open IP paths, so these are not accumulated cruft — they are addresses
1137    /// that were real at the last successful connection and are absent from iroh's view now. (An
1138    /// earlier version of this doc said #124 "amends but never removes"; that is false, and
1139    /// `dial_hint.rs` says so in as many words.)
1140    ///
1141    /// **Empty whenever [`known_addrs`](Self::known_addrs) is `None`**, because there is no view to
1142    /// difference against. Reporting the whole hint as unknown when iroh simply has no entry would
1143    /// call a current, correct hint stale on every idle daemon.
1144    ///
1145    /// INFERRED by set difference, not read: iroh 1.0.3's `TransportAddrInfo` carries no
1146    /// provenance, so "did this come from our hint or from discovery?" cannot be answered directly.
1147    /// Naming it an inference is the honest version.
1148    #[serde(default, skip_serializing_if = "Vec::is_empty")]
1149    pub hint_addrs_unknown_to_iroh: Vec<String>,
1150    /// The converse: what iroh holds that our stored hint does not name — inferred the same way,
1151    /// and empty for the same reason when [`known_addrs`](Self::known_addrs) is `None`.
1152    ///
1153    /// **A non-empty list here is the NORMAL state of a healthy peer, and a growing one is not
1154    /// evidence that the stored hint has drifted.** The two lists are built from different things
1155    /// and are expected to differ in size:
1156    ///
1157    /// - [`hint_addrs`](Self::hint_addrs) comes from the open **IP** paths of one live connection —
1158    ///   typically one to three addresses.
1159    /// - [`known_addrs`](Self::known_addrs) is iroh's remote map: every address it has learned for
1160    ///   the peer, from discovery and from paths, active or not, **relay URLs included**.
1161    ///
1162    /// So this list grows when **iroh learns more candidates**, which is discovery working. It says
1163    /// nothing about whether the hint is current; [`hint_addrs_unknown_to_iroh`] is the field that
1164    /// speaks to that, in the other direction.
1165    ///
1166    /// A relay URL iroh holds will sit here for as long as a hint whose addresses came from
1167    /// `dial_hint::observed_for` stands: that function filters to IP paths, so a value it produced
1168    /// cannot name a relay. Verified end to end against a **real** relay by
1169    /// `a_live_session_refreshes_the_dial_hint_and_never_stores_a_relay`
1170    /// (`cli/tests/dial_hint_refresh.rs`), which starts a relayed session and asserts the healed
1171    /// hint carries the peer's direct address and no relay.
1172    ///
1173    /// **Sourced-from, not written-when — the distinction is load-bearing.** A stored hint can
1174    /// still name a relay three ways, and each is reported rather than hidden: a legacy row written
1175    /// before 0.52.2; a legacy value *carried forward* by a later write, since `merge_hint` and the
1176    /// attestation admit path preserve a stored value rather than originating one; and a direct
1177    /// `PeerStore::add` by an embedder, `allowlist` being a public module.
1178    ///
1179    /// This warning exists because the reading was gotten wrong in the field, on #140 itself: a
1180    /// reporter read this going 5 -> 8 across an upgrade as the hint drifting from iroh's view.
1181    ///
1182    /// [`hint_addrs_unknown_to_iroh`]: Self::hint_addrs_unknown_to_iroh
1183    #[serde(default, skip_serializing_if = "Vec::is_empty")]
1184    pub iroh_addrs_not_in_hint: Vec<String>,
1185}
1186
1187/// One address iroh holds for a peer (#140, `api_minor >= 56`).
1188///
1189/// Rendered by the SAME labelling [`PeerDiagnosticsResult::hint_addrs`] uses — IPs verbatim, relays
1190/// as `relay <url>` sanitized to scheme+host+port — because the two lists exist to be read side by
1191/// side, and differently-formatted addresses would make a formatting difference look like a real
1192/// one. The sanitization is not optional here either: this output is meant to be pasted into a
1193/// public issue, and an operator's relay URL can carry a userinfo token.
1194#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1195pub struct KnownAddr {
1196    /// The address, labelled as above.
1197    pub addr: String,
1198    /// Whether iroh reports this address as in ACTIVE use, as opposed to merely known.
1199    ///
1200    /// **One bit, and it collapses three states.** iroh maps only `PathStatus::Open` to active;
1201    /// `Inactive`, `Unusable` ("we attempted holepunching and it didn't work") and `Unknown` ("we
1202    /// have not yet attempted holepunching") all render `false`. So an idle direct address beside an
1203    /// active relay is *consistent with* #140's selected-path hypothesis and equally consistent with
1204    /// an ordinary failed hole-punch — which is a NAT diagnosis, the opposite conclusion. This field
1205    /// cannot discriminate them; it says what is carrying traffic and no more.
1206    pub active: bool,
1207}
1208
1209/// Params of [`Request::PeerHintClear`] (#140): whose stored dial hint to forget.
1210#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1211#[serde(deny_unknown_fields)]
1212pub struct PeerHintClearParams {
1213    /// Nickname / `eid:` / `b64u:` — the same vocabulary every other peer verb takes.
1214    pub peer: String,
1215}
1216
1217/// Result of [`Request::PeerHintClear`] (#140).
1218#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1219pub struct PeerHintClearResult {
1220    /// How many hints were removed. A `b64u:` user_id names EVERY device of that person and the
1221    /// racing dial path attaches a hint for each, so clearing "the" hint would leave the pairing
1222    /// still addressing from stored state while reporting success. Every device is cleared, and the
1223    /// count says how many actually had one.
1224    ///
1225    /// `0` means nothing was stored — already the state this verb produces, so a no-op, not an error.
1226    pub cleared: usize,
1227    /// The raw hints removed, verbatim, in the order the devices resolved.
1228    ///
1229    /// **This is the undo, and since 0.52.2 it is the ONLY one.** There is no `peer_hint_set`, and
1230    /// on the pairing this verb targets the hint may never be rewritten on its own: every writer
1231    /// now stores only what a connection OBSERVED, and all of them decline to store anything for a
1232    /// relay-only connection — which is the defining property of a stuck pair. Re-pairing no longer
1233    /// reliably restores it either: the ceremony writes a hint only if it observes a direct path,
1234    /// and on a pair that cannot punch it does not. Keep this value.
1235    #[serde(default, skip_serializing_if = "Vec::is_empty")]
1236    pub forgotten: Vec<String>,
1237}
1238
1239/// Params of [`Request::UnregisterService`] (#50): the persistent (or ephemeral) service name
1240/// to remove — the deregistration mirror of `register_service`.
1241#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1242#[serde(deny_unknown_fields)]
1243pub struct UnregisterServiceParams {
1244    pub name: String,
1245}
1246
1247/// Params of [`Request::ServiceAllowGrant`] / [`Request::ServiceAllowRevoke`] (#44): toggle a
1248/// single stable `principal` (`b64u:`/`eid:`) on a single `service`'s allow list, WITHOUT
1249/// unpairing. The per-peer "sharing" switch primitive the embedder drives.
1250#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1251#[serde(deny_unknown_fields)]
1252pub struct ServiceAllowParams {
1253    pub service: String,
1254    pub principal: String,
1255}
1256
1257/// Params of [`Request::SetNickname`]: this node's new self-nickname (#37). Display-only
1258/// semantics: it names this node in FUTURE invites/presentations; peers keep the nickname
1259/// they stored at pairing time until a re-invite.
1260#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1261#[serde(deny_unknown_fields)]
1262pub struct SetNicknameParams {
1263    pub nickname: String,
1264}
1265
1266/// Params of [`Request::SetRosterUrl`]: the HTTPS roster URL to pin.
1267#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1268#[serde(deny_unknown_fields)]
1269pub struct SetRosterUrlParams {
1270    pub url: String,
1271}
1272
1273/// Params of [`Request::SetRelays`] (#53): the node's desired CUSTOM relay set. Declarative —
1274/// "make the custom relay set exactly this" — applied as a live insert/remove diff against the
1275/// running endpoint (iroh 1.0.3 `Endpoint::insert_relay`/`remove_relay`) when the node is already
1276/// in `relay_mode = "custom"`, then persisted to `[network]`. Each entry must parse as an iroh
1277/// `RelayUrl`; an empty list is rejected (custom mode requires ≥1 relay — fully disabling relays
1278/// is a `relay_mode = "disabled"` restart, not this verb). Switching a node that is currently
1279/// `default`/`disabled` onto custom persists the config but needs a restart to take effect (iroh
1280/// cannot live-transition the relay MODE) — signalled by [`SetRelaysResult::restart_required`].
1281#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1282#[serde(deny_unknown_fields)]
1283pub struct SetRelaysParams {
1284    pub relay_urls: Vec<String>,
1285}
1286
1287/// Result of [`Request::SetRelays`] (#53).
1288#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1289pub struct SetRelaysResult {
1290    /// The persisted `relay_urls` differed from the prior config (a no-op edit → `false`).
1291    pub changed: bool,
1292    /// `true` iff the node's current `relay_mode` is not `custom`, so the new set was persisted
1293    /// but NOT applied live — a node restart is required for it to take effect. `false` on the
1294    /// live custom→custom path (already applied to the running endpoint).
1295    pub restart_required: bool,
1296}
1297
1298/// Params of [`Request::BlobPublish`]: the scope to publish into and the LOCAL file to add.
1299#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1300#[serde(deny_unknown_fields)]
1301pub struct BlobPublishParams {
1302    pub scope: String,
1303    pub path: String,
1304}
1305
1306/// Params of [`Request::BlobGrant`]: the scope and the flat-namespace principal to grant it to.
1307#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1308#[serde(deny_unknown_fields)]
1309pub struct BlobGrantParams {
1310    pub scope: String,
1311    pub principal: String,
1312}
1313
1314/// Params of [`Request::BlobRevoke`] (#62): the scope and the principals to withdraw from it.
1315///
1316/// SCOPED, unlike unpair hygiene: only the named scope's grants change. A principal that also holds
1317/// grants on other scopes keeps them — withdrawing access to one thing must not silently withdraw
1318/// access to everything else.
1319#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1320#[serde(deny_unknown_fields)]
1321pub struct BlobRevokeParams {
1322    pub scope: String,
1323    pub principals: Vec<String>,
1324}
1325
1326/// Params of [`Request::BlobUnpublish`] (#62): the scope and the blake3 hex to remove from it.
1327///
1328/// Removes REACHABILITY, not bytes. The scope gate requires a hash to be listed in some scope, so
1329/// this takes effect immediately for authorization — but the bytes stay in the local store until a
1330/// GARBAGE-COLLECTION sweep reclaims them, and only a node that set `[blobs].gc_interval` runs one
1331/// (#80, `api_minor >= 49`). There is no reclaim VERB — collection is periodic and configured at
1332/// store construction, so "deleted" means "deleted within an interval" at best. On a node with no
1333/// interval configured — the default — the bytes stay forever. Do not surface this to a user as
1334/// deletion unless you know the node collects.
1335#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1336#[serde(deny_unknown_fields)]
1337pub struct BlobUnpublishParams {
1338    pub scope: String,
1339    pub hash: String,
1340}
1341
1342/// Params of [`Request::BlobRepublish`] (#83): the scope and the blake3 hex to add to it.
1343///
1344/// The blob must already be held COMPLETE by this daemon — republish makes a fetched blob servable
1345/// FROM this node, it does not fetch. A hash that is absent, or only partially present from an
1346/// interrupted fetch, is refused with [`ERR_NO_SUCH_BLOB`]: advertising bytes we cannot serve would
1347/// turn the original publisher going offline into a hang at every fetcher.
1348///
1349/// It grants NOBODY. The republisher names a scope they already control; inheriting the original
1350/// publisher's grants would be a silent authorization transfer. Share with `blob_grant`.
1351#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1352#[serde(deny_unknown_fields)]
1353pub struct BlobRepublishParams {
1354    pub scope: String,
1355    pub hash: String,
1356}
1357
1358/// Params of [`Request::BlobFetch`]: the `mcpmesh/blob/1` ticket and the LOCAL export path.
1359#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1360#[serde(deny_unknown_fields)]
1361pub struct BlobFetchParams {
1362    pub ticket: String,
1363    pub dest_path: String,
1364    /// ADDITIONAL sources to try if the ticket's publisher does not answer (#83).
1365    /// `api_minor >= 47`.
1366    ///
1367    /// Content addressing makes every recipient a potential source, and without this the control
1368    /// API made that unusable: a ticket names ONE address, so a file shared with a room became
1369    /// unfetchable the moment the sender closed their laptop — even though other people in the room
1370    /// already held the identical, verified bytes.
1371    ///
1372    /// Each entry is a stable principal (`eid:` device, `b64u:` user_id) or a paired nickname —
1373    /// the same vocabulary `open_session` takes. They are preferred **in order, after** the ticket's
1374    /// own address, so the publisher stays the first choice and a live one costs nothing —
1375    /// alternates are not dialled at all when it answers.
1376    ///
1377    /// Since 0.49.1 the dials are **hedged**: an alternate starts about a second after a source has
1378    /// failed to answer, rather than after that source's full dial timeout. A source unreachable at
1379    /// the head of the list therefore costs about a second, not twenty, and a long `from` list is no
1380    /// longer a long wait. Each source is still dialled at most once.
1381    ///
1382    /// **An alternate only works if it can serve you.** The bytes are BLAKE3-verified against the
1383    /// ticket's hash whoever supplies them, so a hostile alternate cannot substitute content — but
1384    /// it must have republished the hash into a scope that grants you, or it answers with a
1385    /// permission refusal and the fetch moves on. Every failure mode falls through, not only an
1386    /// unreachable dial: a refusal, a missing hash, a mid-stream reset, and a stalled transfer all
1387    /// move to the next source.
1388    ///
1389    /// Additive: absent from an older caller's payload and read as empty, which is the
1390    /// single-source behaviour.
1391    /// Capped at [`MAX_BLOB_SOURCES`]; more is an error rather than a silent truncation.
1392    #[serde(default, skip_serializing_if = "Vec::is_empty")]
1393    pub from: Vec<String>,
1394}
1395
1396/// The ceiling on [`BlobFetchParams::from`] (#83).
1397///
1398/// Naming a PERSON expands to every device of theirs, so the list a caller writes is not the number
1399/// of dials it buys. Comfortably above "everyone in a room", far below anything that turns a fetch
1400/// into an hour.
1401///
1402/// **The justification changed in 0.49.1 and the number did not.** Until then sources were tried
1403/// strictly in turn, each costing up to a dial timeout, so the cap bounded a WAIT. Dials are now
1404/// hedged, which bounds the wait by roughly a second per unresponsive source instead — but the cap
1405/// still bounds the WORK: a fetch holds one of the connection's [`MAX_INFLIGHT`] slots, and a long
1406/// list is a long list of other people's machines being asked to answer.
1407///
1408/// Exceeding it is an ERROR, not a truncation: silently dropping the tail would make a fetch fail
1409/// while the source that had the blob sat unused, which is exactly what this feature exists to
1410/// prevent.
1411pub const MAX_BLOB_SOURCES: usize = 32;
1412
1413/// Params of [`Request::BlobFetchCancel`] (#172): stop every in-flight [`Request::BlobFetch`] of
1414/// this blob.
1415///
1416/// Keyed by HASH, not by JSON-RPC id, and the reason is not aesthetic: [`crate::ControlClient`]
1417/// borrows `&mut self` for a request's whole duration, so a client physically cannot send an
1418/// id-keyed cancel down the connection whose request it would name. A hash is reachable from
1419/// anywhere — including a fresh connection — and it is already the key a consumer holds, since
1420/// every [`crate::StreamFrame::BlobTransfer`] carries it.
1421#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1422#[serde(deny_unknown_fields)]
1423pub struct BlobFetchCancelParams {
1424    /// The blob's BLAKE3 hash, hex — as it appears on `BlobTransfer` frames and `BlobFetchResult`.
1425    pub hash: String,
1426}
1427
1428/// Control-API requests. Serialized as `{ "method": "...", "params": {...} }`
1429/// (JSON-RPC-shaped; the id/jsonrpc envelope is added by the transport layer).
1430///
1431/// Each param-carrying variant wraps its named `*Params` struct — the ONE wire truth for that
1432/// method's params, shared by clients (which serialize whole `Request`s) and the daemon (which
1433/// deserializes `params` into the same struct after its method-string dispatch). Adjacent
1434/// tagging serializes a newtype variant's content as the struct's fields, so the wire shape is
1435/// identical to inline variant bodies.
1436///
1437/// **Servers dispatch on the `method` string and deserialize `params` per-method** — tolerating
1438/// omitted / null / empty-object params for parameterless methods — rather than deserializing a
1439/// whole message into `Request` (adjacent tagging rejects `params:{}` for unit variants).
1440/// This keeps the wire tolerant for third-party clients (the versioned, additive-only surface).
1441/// Use [`method_of`] to extract the tag, then match + deserialize `params` per-method.
1442#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1443#[serde(tag = "method", content = "params", rename_all = "snake_case")]
1444pub enum Request {
1445    /// Register/update a `[services.*]` entry idempotently.
1446    RegisterService(RegisterServiceParams),
1447    Status,
1448    /// Mint a pairing invite granting `services` — single-use unless `max_uses` says otherwise
1449    /// (#87). The daemon
1450    /// answers an [`InviteResult`] carrying the copyable `mcpmesh-invite:` line. Tag
1451    /// `"invite"` (snake_case). `method_of` needs no per-variant arm — it reads the
1452    /// `method` string generically; the tag comes from `rename_all`.
1453    Invite(InviteParams),
1454    /// Redeem a pairing invite. The daemon dials the inviter named by
1455    /// `invite_line` on `mcpmesh/pair/1`, proves the secret, writes the mutual
1456    /// (dial-back) `PeerEntry`, and answers a [`PairResult`]. Tag `"pair"`
1457    /// (snake_case); `method_of` reads the `method` string generically.
1458    ///
1459    /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
1460    Pair(PairParams),
1461    /// Remove a paired peer by nickname (`mcpmesh pair --remove`). The daemon drops the
1462    /// peer's `PeerEntry` (identity) AND revokes its access by stripping its stable principals from every
1463    /// `[services.*].allow` (authorization) — the inverse of the pairing grant. Idempotent: a
1464    /// nickname with no entry / no allow membership is a clean no-op. Live in-flight sessions are
1465    /// NOT severed here: existing sessions run to completion; the peer only loses the
1466    /// ability to establish NEW authorized sessions. Tag `"peer_remove"` (snake_case);
1467    /// `method_of` reads the `method` string generically (no per-variant arm).
1468    ///
1469    /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
1470    PeerRemove(PeerRemoveParams),
1471    /// Rename a contact's nickname (nickname) authoritatively. Renames the
1472    /// PERSON — every `PeerEntry` sharing `user_id` when given (one op for all their devices), else the
1473    /// single `nickname` entry (a provisional, no-`user_id` contact) — to `to`, AND rewrites the old
1474    /// nickname → `to` in every `[services.*].allow` so grants follow the rename. Refuses (error frame)
1475    /// when `to` is empty or already names/grants a DIFFERENT identity — the same collision guard the
1476    /// pairing rendezvous uses, so a rename can't inherit another peer's access. Tag `"peer_rename"`;
1477    /// host-privileged like the other pair ops.
1478    PeerRename(PeerRenameParams),
1479    /// Mint an attestation OFFER (#85 ask 3): a `mcpmesh-attest:` line telling another device of a
1480    /// person you already pair with where to dial. Tag `"attest_offer"`.
1481    ///
1482    /// **Carries nothing secret** — the offering node's id and address, both of which an invite
1483    /// line already carries in the clear. It exists because a device freshly restored from a
1484    /// recovery phrase holds no rows and so has no way to find anyone.
1485    ///
1486    /// Refused unless this node has `[identity].admit_attested_devices` on: an offer it would not
1487    /// honour is worse than no offer.
1488    AttestOffer,
1489    /// Present THIS device's identity to a peer, using their `mcpmesh-attest:` line (#85 ask 3).
1490    /// Tag `"attest_to"`.
1491    ///
1492    /// The recovery path's second half: `user_key_import` restores the `b64u:` your peers pinned,
1493    /// and this is what gets the machine holding it ADMITTED. Requires a user key — with none there
1494    /// is nothing to attest.
1495    ///
1496    /// The peer admits this device only if it already holds a row for this person, has opted in,
1497    /// and has revoked neither this endpoint nor the IDENTITY. It cannot admit a stranger.
1498    AttestTo(AttestToParams),
1499    /// REVOKE an endpoint locally: "I no longer trust this device" (#85 ask 4). Tag
1500    /// `"peer_revoke"`.
1501    ///
1502    /// **Not the same act as [`PeerRemove`](Self::PeerRemove), deliberately.** Removal is routine —
1503    /// we are not working together any more — and re-pairing afterwards is normal. Revocation is a
1504    /// claim about COMPROMISE, and it outlives the pair row: a revoked endpoint is refused whether
1505    /// or not it is in the allowlist, so it cannot be undone by a fresh pairing. Making them one
1506    /// verb would either make removal irreversible or make revocation weak.
1507    ///
1508    /// Takes effect IMMEDIATELY, like `service_allow_revoke` (#54): live sessions are severed
1509    /// rather than left to end on their own, which for long-lived MCP sessions is unbounded.
1510    ///
1511    /// A `b64u:` principal revokes EVERY endpoint this node associates with that person — the "not
1512    /// on any of their devices" case, which an operator will otherwise get wrong doing it device by
1513    /// device.
1514    ///
1515    /// Reversible with [`PeerUnrevoke`](Self::PeerUnrevoke): this list is LOCAL and not
1516    /// authoritative for anyone else, so an operator mistake has to be fixable. Both directions are
1517    /// audited.
1518    PeerRevoke(PeerRevokeParams),
1519    /// Lift a local revocation (#85 ask 4). Tag `"peer_unrevoke"`. Idempotent.
1520    ///
1521    /// Restores the peer only if its pair row still exists — revocation never deleted it. A
1522    /// revocation applied from a SIGNED statement can be lifted too: the signature proved who asked,
1523    /// not that this node must obey forever.
1524    PeerUnrevoke(PeerUnrevokeParams),
1525    /// Sign a revocation of one of THIS node's own endpoints with THIS node's user key (#85 ask 4),
1526    /// producing a portable token. Tag `"device_revoke"`.
1527    ///
1528    /// The direction that matters, and the one local revocation cannot express: my laptop was
1529    /// stolen, and my peers cannot discover that by themselves. I have to tell them, and they have
1530    /// to be able to verify it was me.
1531    ///
1532    /// Requires a user key — a node with none has no authority to speak for its person.
1533    /// **Distribution is out of band**: pairing mode has no gossip, so getting the token to your
1534    /// peers is the same problem as getting them an invite line, and has the same answer.
1535    DeviceRevoke(DeviceRevokeParams),
1536    /// Apply a signed device revocation from a peer (#85 ask 4). Tag `"device_revocation_import"`.
1537    ///
1538    /// Refused unless this node ALREADY trusts the signing `user_id` (holds a paired entry carrying
1539    /// it) **and** the revoked endpoint is one this node associates with that same person, or is
1540    /// entirely unknown to it. That bound is what keeps this from being an "mark any endpoint dead"
1541    /// primitive: a peer may kill their OWN devices in your node, and nothing else.
1542    DeviceRevocationImport(DeviceRevocationImportParams),
1543    /// RESERVED / INTERNAL (`docs/local-protocol.md` "Reserved / internal methods"): install a
1544    /// peer directly from a raw `endpoint_id` — the trust-population stand-in for pairing behind
1545    /// `mcpmesh internal peer add`. A deliberate, documented exception to the surface discipline
1546    /// (raw endpoint identifiers otherwise never cross this socket); NOT part of the stable
1547    /// vocabulary — do not build on it. Tag `"peer_add"`.
1548    PeerAdd(PeerAddParams),
1549    /// Install a peer from a SIGNED endorsement by someone you are already paired with (#65) —
1550    /// O(N) onboarding for a small group, without a fresh two-human SAS ceremony per pair.
1551    ///
1552    /// **It installs IDENTITY, never AUTHORIZATION.** The subject becomes resolvable; it is granted
1553    /// nothing. Service access stays principal-keyed in config (#38) and an explicit, separate act.
1554    /// That is what bounds the feature: a compromised endorser can make you KNOW about an attacker,
1555    /// it cannot make you SERVE one.
1556    ///
1557    /// Unlike [`PeerAdd`](Self::PeerAdd) — which is reserved precisely because the caller merely
1558    /// ASSERTS an id — this is verifiable: the endorsement is checked against a user key you
1559    /// already hold from pairing with the endorser. Tag `"peer_introduce"`.
1560    PeerIntroduce(PeerIntroduceParams),
1561    /// PRODUCE an endorsement of a peer, for someone else to redeem with
1562    /// [`PeerIntroduce`](Self::PeerIntroduce) (#65). The other half of an introduction: without it
1563    /// nothing can generate `evidence`, and the install half is unusable.
1564    ///
1565    /// Signs with THIS node's user key, so the result is only meaningful to someone who has paired
1566    /// with you. Endorsing does not change your own trust in the subject. Tag `"peer_endorse"`.
1567    PeerEndorse(PeerEndorseParams),
1568    /// Open a mesh session to `peer/service`; the daemon dials and pipes.
1569    /// Distinct from the proxy's job: this returns a session the client streams.
1570    /// Named `open_session` rather than `connect` to avoid colliding
1571    /// with the `connect` porcelain.
1572    OpenSession(OpenSessionParams),
1573    /// Install a signed roster from a local file (the manual `internal roster install` path).
1574    /// `path` is a LOCAL file the same-uid daemon reads (the daemon runs as the caller's own
1575    /// uid, so passing a path rather than the bytes crosses no trust boundary). `org_root_pk`
1576    /// pins the org root on FIRST install (`b64u:`); omit it
1577    /// once pinned (config carries it). Tag `"roster_install"`.
1578    RosterInstall(RosterInstallParams),
1579    /// Read the installed roster's MEMBERSHIP: the declared groups, and every person with their
1580    /// display name, groups, and devices (#93). Parameterless. Tag `"roster_members"`.
1581    ///
1582    /// The read half of roster mode. `status` reports that a roster exists (`RosterStatus`) and who
1583    /// is currently online (`PresencePeer`); neither answered "who is in this org" — a person with
1584    /// no live device appeared nowhere at all, so an embedder could not draw a member list, and
1585    /// the only route to one was hand-parsing the daemon-owned `roster.json`.
1586    ///
1587    /// ADVISORY and display-oriented, like `status`: the gate reads the roster document, never
1588    /// this. Empty in a pure-pairing daemon or before the first roster is installed.
1589    RosterMembers,
1590    /// AUTHOR an org: mint this node's org root key, sign an empty roster (serial 1), install it
1591    /// (which pins the root), and return the copyable org invite (#66). Tag `"org_create"`.
1592    ///
1593    /// One-time per node — a second call is refused rather than replacing the key, because
1594    /// replacing it would orphan every roster it has signed.
1595    OrgCreate(OrgCreateParams),
1596    /// APPROVE a join code into the roster: verify its device→user-key binding, upsert the member
1597    /// with the given groups, bump the serial, re-sign, install (#66). Tag `"org_approve"`.
1598    ///
1599    /// The cryptographic half of the ceremony. Verifying that the code came from the PERSON you
1600    /// think it did stays an out-of-band human step, and `join_code_fingerprint` in the result is
1601    /// what the two humans compare.
1602    OrgApprove(OrgApproveParams),
1603    /// ROTATE the org root (#93 ask c). Tag `"org_rotate"`.
1604    ///
1605    /// The org's trust anchor is one pinned key, and nothing could move it: an operator laptop that
1606    /// died took the org with it 90 days later, when the roster expired — and the delay is what
1607    /// made that hard to diagnose. Recovery was O(N) fresh ceremonies with every member.
1608    ///
1609    /// Publishes a roster signed by the SUCCESSOR carrying a cross-signature by the CURRENT root, so
1610    /// a member still pinned to the current key adopts the successor with the key it already has.
1611    /// The bridge rides every subsequent roster, so a member offline for one publication catches up
1612    /// — but one two rotations behind needs a fresh `org_join`.
1613    ///
1614    /// **This is not escrow.** If the current root key is LOST there is nothing to sign the bridge
1615    /// with. Copying `org-root.key` to a second operator machine already works and remains the
1616    /// answer for that.
1617    OrgRotate(OrgRotateParams),
1618    /// INSPECT a join code without approving it (#66): who it claims to be, and the fingerprint the
1619    /// two humans compare. Read-only — nothing is signed, installed, or persisted.
1620    /// Tag `"org_join_code"`.
1621    ///
1622    /// This is what makes an "approve this person" button correct rather than merely possible. The
1623    /// fingerprint has to be shown and confirmed out-of-band BEFORE the approval, because a
1624    /// substituted code is caught there or not at all — and reading it off `OrgApprove`'s result
1625    /// is too late, the member is already in the signed roster. The CLI always had this (it
1626    /// decoded the code locally); an embedder could not, since the join-code format lives in
1627    /// `mcpmesh-node` and not on this seam.
1628    OrgJoinCode(OrgJoinCodeParams),
1629    /// REVOKE from the roster: remove a person, one device, or a person's user key, then bump,
1630    /// re-sign, and install — which severs the cut devices' live sessions (#66).
1631    /// Tag `"org_revoke"`.
1632    OrgRevoke(OrgRevokeParams),
1633    /// EXPORT this node's user key as a recovery phrase (#85 ask 2). Parameterless.
1634    /// Tag `"user_key_export"`.
1635    ///
1636    /// **The phrase IS the private key**, in a form a human can write down. Anyone who reads it can
1637    /// present this identity. It is deliberately not logged, not audited, and not echoed anywhere
1638    /// but this response.
1639    UserKeyExport,
1640    /// IMPORT a user key from a recovery phrase (#85 ask 2), so a person's `b64u:` survives the
1641    /// hardware. Tag `"user_key_import"`.
1642    UserKeyImport(UserKeyImportParams),
1643    /// Pin the org root on a JOINER — WITHOUT a roster (the joiner has none yet; its poll loop
1644    /// fetches the first one). Records `[identity]` org_id / org_root_pk / user_id / user_key.
1645    /// `user_key` is a LOCAL path
1646    /// (the key never crosses the API). Tag `"org_join"`.
1647    OrgJoin(OrgJoinParams),
1648    /// Pin the HTTPS roster URL (`[roster].url`) in config. Written by `org create
1649    /// --roster-url` (the operator keeps it current) AND by `join` when the org invite carries one —
1650    /// so the joiner's poll loop bootstraps its FIRST roster. The daemon writes it under
1651    /// `reload_lock` (single-writer), then the poll loop picks it up on the next daemon start. Tag
1652    /// `"set_roster_url"`.
1653    SetRosterUrl(SetRosterUrlParams),
1654    /// Rename this node LIVE (#37): validate + upsert `[identity].nickname` through the
1655    /// daemon's own serialized config-write path (no lost-update window against a
1656    /// concurrent grant/registration) and update the in-memory name future invites
1657    /// present — no restart. Ack result. Tag `"set_nickname"` (snake_case).
1658    SetNickname(SetNicknameParams),
1659    /// Set this node's opaque app-metadata blob (#39): validated (≤256B) and folded, signed,
1660    /// into each outgoing presence heartbeat, so paired roster peers see it in their `status`
1661    /// presence — no per-peer session. Ack result. Tag `"set_app_metadata"`. In-memory (lost
1662    /// on restart; the embedder re-sets on startup).
1663    SetAppMetadata(SetAppMetadataParams),
1664    /// Set this node's CUSTOM relay set LIVE (#53): validate each URL as an iroh `RelayUrl`, diff
1665    /// against the running endpoint's current custom relays and apply the delta via iroh 1.0.3
1666    /// `Endpoint::insert_relay`/`remove_relay` (no endpoint rebuild, no dropped sessions), then
1667    /// persist `[network] relay_mode="custom" relay_urls=[…]` under `reload_lock`. When the node
1668    /// is currently `default`/`disabled`, the config is persisted but the live mode transition
1669    /// isn't possible — [`SetRelaysResult::restart_required`] is `true`. Answers a
1670    /// [`SetRelaysResult`]. Tag `"set_relays"`.
1671    SetRelays(SetRelaysParams),
1672    /// Grant a single stable principal access to a single service's allow (#44) — the per-peer
1673    /// "sharing on" toggle, idempotent + serialized under the config lock. Ack result.
1674    /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
1675    /// Removes the whole `[services.<name>]` entry (allow included) + any ephemeral one, then
1676    /// hot-reloads. Idempotent. Ack result.
1677    UnregisterService(UnregisterServiceParams),
1678    /// Discover which services a paired peer CURRENTLY grants the caller (#52) — dials the peer
1679    /// and returns the service names whose allow admits the caller's principal. Answers
1680    /// [`PeerServicesResult`].
1681    PeerServices(PeerServicesParams),
1682    /// Dump the DURABLE per-peer state this node carries for one peer (#140) — the persisted dial
1683    /// hint, the pairing stamp, and the live reachability row, in one capture. A DIAGNOSTIC verb:
1684    /// unlike every other surface it carries transport vocabulary on purpose. Answers with
1685    /// [`PeerDiagnosticsResult`]. `api_minor >= 33`.
1686    PeerDiagnostics(PeerDiagnosticsParams),
1687    /// FORGET the persisted dial hint for one peer (#140) — `api_minor >= 59`.
1688    ///
1689    /// An experiment tool, and a workaround. `PeerEntry.last_addr` is the only durable per-peer
1690    /// state on this node's disk that the dial path reads, and it is the ONLY thing a long-lived
1691    /// pairing carries that a freshly paired identity does not. Nothing invalidates it: a
1692    /// relay-only connection deliberately declines to overwrite it (persisting a relay URL over a
1693    /// direct candidate was #124's own bug), and "learned nothing" means leave alone. So a hint
1694    /// written before a network change can persist indefinitely on a pair whose every connection
1695    /// since has been relayed.
1696    ///
1697    /// Clearing it makes an existing pairing **addressing-equivalent to a fresh identity**, which
1698    /// is exactly the difference #140 is about — a pair that cannot punch as a long-lived pairing
1699    /// while punching in 23ms with fresh identities on the same hardware.
1700    ///
1701    /// **Advisory, never authorization.** A hint is addressing; its absence is a supported state
1702    /// (the dial degrades to id-only, which is what every peer does before its first refresh). The
1703    /// worst case is one slower dial while discovery runs. The peer row, its `user_id`, its
1704    /// services and its pairing stamp are untouched.
1705    ///
1706    /// Nothing clears a hint automatically — choosing an invalidation policy before the data exists
1707    /// is what produced a fix that helped one peer and not this one. Answers
1708    /// [`PeerHintClearResult`].
1709    PeerHintClear(PeerHintClearParams),
1710    ServiceAllowGrant(ServiceAllowParams),
1711    /// Revoke a single stable principal from a single service's allow (#44) — "sharing off"
1712    /// WITHOUT unpairing (the peer's identity row is untouched; only NEW sessions are refused).
1713    /// Idempotent. Ack result.
1714    ServiceAllowRevoke(ServiceAllowParams),
1715    /// Publish a LOCAL file INTO a scope: the daemon adds the bytes to its gated
1716    /// app-blob store and records the hash in `scope`. `path` is a local file the same-uid daemon
1717    /// reads. Answers a [`BlobPublishResult`] carrying the `mcpmesh/blob/1` ticket + hash.
1718    /// Tag `"blob_publish"`.
1719    BlobPublish(BlobPublishParams),
1720    /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id, or a
1721    /// nickname (the shared `principal_set` expansion). Tag
1722    /// `"blob_grant"`.
1723    BlobGrant(BlobGrantParams),
1724    /// Tag `"blob_revoke"`: withdraw principals from ONE scope's grants (#62).
1725    BlobRevoke(BlobRevokeParams),
1726    /// Tag `"blob_unpublish"`: remove a hash from ONE scope (#62). Withdraws reachability, not
1727    /// bytes.
1728    BlobUnpublish(BlobUnpublishParams),
1729    /// #83: make a blob this daemon already holds servable from HERE, in a scope it controls.
1730    /// Answers a [`BlobPublishResult`] — same shape as `blob_publish`, so a client can treat the
1731    /// two interchangeably after a fetch.
1732    BlobRepublish(BlobRepublishParams),
1733    /// List the daemon's blob scopes (name → hashes + grants). Tag `"blob_list"`.
1734    BlobList(BlobListParams),
1735    /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified streaming) and export the
1736    /// verified blob to `dest_path` (a local file the same-uid daemon writes). Answers a
1737    /// [`BlobFetchResult`] with the verified hash + byte length. Tag `"blob_fetch"`.
1738    BlobFetch(BlobFetchParams),
1739    /// Cancel every in-flight [`BlobFetch`](Self::BlobFetch) of one hash (#172). Answers a
1740    /// [`BlobFetchCancelResult`]; the cancelled fetches themselves answer [`ERR_CANCELLED`].
1741    /// Tag `"blob_fetch_cancel"`.
1742    BlobFetchCancel(BlobFetchCancelParams),
1743    /// Summarize this node's LOCAL audit log into per-peer / per-service SESSION counts
1744    /// (local-only — the daemon reads its OWN audit dir, nothing is transmitted). The host Mesh surface
1745    /// renders these as "who serves me / whom I serve / session counts". Parameterless (like `Status`);
1746    /// the server dispatches on the `method` string. Tag `"audit_summary"` (snake_case);
1747    /// `method_of` reads the `method` string generically (no per-variant arm).
1748    AuditSummary,
1749    /// Delete audit months strictly older than `before` (#88) — the retention lever the log
1750    /// never had. Local-only and owner-only (the control socket is the daemon owner's). Answers
1751    /// [`AuditPruneResult`]. Tag `"audit_prune"`.
1752    AuditPrune(AuditPruneParams),
1753    /// Read this node's LOCAL audit records, filtered and paged (#88) — the "show me everything
1754    /// you hold about me" verb. Local-only; nothing is transmitted. Answers
1755    /// [`AuditListResult`]. Tag `"audit_list"`.
1756    AuditList(AuditListParams),
1757    /// Open a live event stream (pairing liveness & health telemetry). Like `open_session`, the
1758    /// connection STOPS being request/response after this call and becomes a one-way push stream
1759    /// of `StreamFrame`s. Parameterless. Tag `"subscribe"`.
1760    Subscribe,
1761}
1762
1763/// Result of [`Request::OrgJoin`] — the pinned org id echoed back (surface-clean; the fingerprint is
1764/// computed porcelain-side from the invite's org_root_pk). Additive-only.
1765#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1766pub struct OrgJoinResult {
1767    pub org_id: String,
1768    /// `true` when the org root was pinned but this node's ROSTER TRANSPORT is not running, so the
1769    /// join is only half in effect until the daemon restarts (#93). `api_minor >= 46`.
1770    ///
1771    /// Roster mode is decided at BOOT: it fixes the ALPN set bound on the endpoint and whether
1772    /// gossip, presence and app-blobs are constructed at all. The roster GATE hot-swaps live. So a
1773    /// node that booted in pairing mode and then joins an org reaches a state where MCP sessions to
1774    /// org members work as soon as a roster arrives, while `status.presence` stays permanently
1775    /// empty and every blob verb hard-closes with `blobs not enabled` — succeeding partially, with
1776    /// no error anywhere, which a caller previously had no way to detect.
1777    ///
1778    /// **What to do with it:** if `true`, tell the user the join succeeded and the node must
1779    /// restart before presence and file sharing work. Do not treat it as a failure — nothing was
1780    /// left half-written; the pin is durable and the restart is sufficient.
1781    ///
1782    /// `false` when the transport is already composed (the node booted with an org root pinned), or
1783    /// on a re-join of an org this node is already in.
1784    ///
1785    /// Same shape as [`SetRelaysResult::restart_required`] (#53), for the same reason. Additive:
1786    /// absent from an older daemon's payload and reads as `false` — which was that daemon's
1787    /// implicit, and wrong, answer.
1788    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1789    pub restart_required: bool,
1790}
1791
1792/// Result of a [`Request::RosterInstall`] request (the manual install path): the installed roster's
1793/// org id + serial (roster-status vocabulary the confirmation line is permitted to render) plus how
1794/// many live sessions the install severed. Surface-clean: NO keys / EndpointIds / paths.
1795///
1796/// Additive-only: any future field MUST land as
1797/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
1798#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1799pub struct RosterInstallResult {
1800    pub org_id: String,
1801    pub serial: u64,
1802    /// How many live sessions were severed, for the porcelain's confirmation line.
1803    #[serde(default)]
1804    pub severed: u32,
1805}
1806
1807/// Params of [`Request::OrgCreate`] (#66).
1808#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1809#[serde(deny_unknown_fields)]
1810pub struct OrgCreateParams {
1811    /// The org's name — its `org_id`, the value every member's roster carries.
1812    pub name: String,
1813    /// How long the signed roster stays valid, in seconds. Omit for the 90-day default.
1814    ///
1815    /// This is an operator-grade default and a sharp edge at small scale: past it the roster
1816    /// degrades and the group stops working, which for a handful of laptops can arrive days after
1817    /// one of them was closed for a long weekend. A small team should pass a long value here
1818    /// deliberately rather than discover the default later.
1819    #[serde(default, skip_serializing_if = "Option::is_none")]
1820    pub expires_secs: Option<i64>,
1821    /// An HTTPS URL where the signed roster will be published. Carried in the org invite (so a
1822    /// joiner bootstraps its first roster) AND pinned in this operator's `[roster].url`.
1823    #[serde(default, skip_serializing_if = "Option::is_none")]
1824    pub roster_url: Option<String>,
1825}
1826
1827/// Result of [`Request::OrgCreate`] (#66).
1828#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1829pub struct OrgCreateResult {
1830    pub org_id: String,
1831    pub serial: u64,
1832    /// The copyable `mcpmesh-org:` invite to hand a joiner — one of the two permitted opaque
1833    /// artifacts on this surface, the same carve-out the pairing invite line takes.
1834    pub org_invite: String,
1835    /// The org root's fingerprint in short words, for the out-of-band read-back that anchors every
1836    /// joiner's trust. NOT the key.
1837    pub org_root_fingerprint: String,
1838}
1839
1840/// Params of [`Request::OrgRotate`] (#93 ask c).
1841#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1842#[serde(deny_unknown_fields)]
1843pub struct OrgRotateParams {
1844    /// Where to read or write the successor key. Omit for `<config>/org_root_next.key`.
1845    ///
1846    /// Reused if it already exists, so a rotation can be prepared on a machine that is not the one
1847    /// publishing it.
1848    #[serde(default, skip_serializing_if = "Option::is_none")]
1849    pub new_key_path: Option<String>,
1850}
1851
1852/// Result of [`Request::OrgRotate`] (#93 ask c).
1853#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
1854pub struct OrgRotateResult {
1855    pub org_id: String,
1856    pub serial: u64,
1857    /// The new anchor, `b64u:`. Members adopt it as they receive the roster.
1858    pub new_root_pk: String,
1859    /// Short fingerprints, for an operator to read out when telling members what changed.
1860    pub old_root_fingerprint: String,
1861    pub new_root_fingerprint: String,
1862}
1863
1864/// Params of [`Request::OrgApprove`] (#66).
1865#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1866#[serde(deny_unknown_fields)]
1867pub struct OrgApproveParams {
1868    /// The `mcpmesh-join:` code the joiner sent.
1869    pub join_code: String,
1870    /// The groups to grant. Each must be DECLARED in the roster (see
1871    /// [`RosterMembersResult::groups`]) — an undeclared one is refused, because it would make an
1872    /// `allow` entry naming it ambiguous.
1873    #[serde(default)]
1874    pub groups: Vec<String>,
1875    /// Override the `user_id` the joiner requested. Omit to accept theirs.
1876    ///
1877    /// Worth using: the requested id is chosen by the person being approved, and it is the string
1878    /// every `allow` entry will name.
1879    #[serde(default, skip_serializing_if = "Option::is_none")]
1880    pub user_id: Option<String>,
1881}
1882
1883/// Result of [`Request::OrgApprove`] (#66).
1884#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1885pub struct OrgApproveResult {
1886    pub user_id: String,
1887    pub groups: Vec<String>,
1888    pub org_id: String,
1889    pub serial: u64,
1890    /// The join code's fingerprint in short words — the enrollment analogue of the pairing SAS.
1891    ///
1892    /// **Show this to the operator and have them confirm it out-of-band before trusting the
1893    /// approval.** Nothing else binds the person to the `user_pk` in the code, so a substituted
1894    /// code is caught here or not at all. Returned rather than checked, because only the human can
1895    /// check it.
1896    pub join_code_fingerprint: String,
1897}
1898
1899/// Params of [`Request::UserKeyImport`] (#85 ask 2).
1900#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
1901#[serde(deny_unknown_fields)]
1902pub struct UserKeyImportParams {
1903    /// The recovery phrase, as written down. Whitespace and case are forgiven; a wrong word, the
1904    /// wrong count, or a failed checksum are refused by position rather than guessed at.
1905    pub recovery_phrase: String,
1906    /// Replace an EXISTING user key. Defaults to `false`, and the refusal is the point: importing
1907    /// over a live key discards the identity this node currently presents, which is irreversible
1908    /// without that key's own phrase.
1909    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1910    pub replace: bool,
1911}
1912
1913/// Result of [`Request::UserKeyExport`] (#85 ask 2).
1914///
1915/// **`recovery_phrase` is the private key.** Show it to the person who owns it, once, and do not
1916/// persist it anywhere your application would not persist the key file itself.
1917#[derive(Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1918pub struct UserKeyExportResult {
1919    /// 33 words. Write them down in order.
1920    pub recovery_phrase: String,
1921    /// The `b64u:` identity this phrase restores — safe to display and to record, unlike the
1922    /// phrase. Compare it after an import to confirm the right identity came back.
1923    pub user_id: String,
1924}
1925
1926/// REDACTING `Debug` — the phrase is a private key, and a derived one would put it in any
1927/// `tracing::debug!(?params)` a future change adds to the dispatch, or in an embedder's `dbg!`.
1928/// Three lines to make that leak unrepresentable rather than merely absent today.
1929impl std::fmt::Debug for UserKeyImportParams {
1930    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1931        f.debug_struct("UserKeyImportParams")
1932            .field("recovery_phrase", &"<redacted>")
1933            .field("replace", &self.replace)
1934            .finish()
1935    }
1936}
1937
1938/// REDACTING `Debug` — see [`UserKeyImportParams`]. The `user_id` is safe and is kept, because a
1939/// `{:?}` with nothing in it is worse for debugging than one with the non-secret half.
1940impl std::fmt::Debug for UserKeyExportResult {
1941    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1942        f.debug_struct("UserKeyExportResult")
1943            .field("recovery_phrase", &"<redacted>")
1944            .field("user_id", &self.user_id)
1945            .finish()
1946    }
1947}
1948
1949/// Result of [`Request::UserKeyImport`] (#85 ask 2).
1950#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1951pub struct UserKeyImportResult {
1952    /// The `b64u:` identity now in effect. **Compare it against the one you are recovering** — the
1953    /// phrase's checksum catches most transcription errors, but a `user_id` that does not match is
1954    /// the definitive answer, and the only one that distinguishes "restored the wrong key" from
1955    /// "peers have not seen me yet".
1956    pub user_id: String,
1957    /// `true` when this discarded a REAL identity — a user key the node had loaded from disk,
1958    /// rather than one it minted at this boot and had never presented to anyone.
1959    ///
1960    /// The distinction is the useful one: a fresh node always has a key on disk before an import
1961    /// can run (its own boot mints one), so "a file existed" would be `true` for every recovery on
1962    /// new hardware and would have a UI warn that something was destroyed when nothing was.
1963    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1964    pub replaced: bool,
1965}
1966
1967/// Params of [`Request::OrgJoinCode`] (#66).
1968#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1969#[serde(deny_unknown_fields)]
1970pub struct OrgJoinCodeParams {
1971    /// The `mcpmesh-join:` code to inspect.
1972    pub join_code: String,
1973}
1974
1975/// Result of [`Request::OrgJoinCode`] (#66): what a join code claims, plus the fingerprint that
1976/// decides whether to believe it.
1977///
1978/// The claims are ATTACKER-CONTROLLED — they come out of a code someone handed you. `display_name`
1979/// and `requested_user_id` are what the sender asked for, not facts. What is verified is the
1980/// device→user-key binding (a bad one is refused rather than reported), and what is *checkable* is
1981/// `join_code_fingerprint`.
1982#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1983pub struct OrgJoinCodeResult {
1984    /// The human name the code carries. Sender-chosen — render it, do not trust it.
1985    pub display_name: String,
1986    /// The `user_id` the sender is asking for. Sender-chosen, and it is what every `allow` entry
1987    /// would name, so it is worth an operator's attention before approving.
1988    pub requested_user_id: String,
1989    /// The label of the device being enrolled. Sender-chosen.
1990    pub device_label: String,
1991    /// The fingerprint in short words — the enrollment analogue of the pairing SAS.
1992    ///
1993    /// **Show this and have the operator confirm it out-of-band before calling
1994    /// [`Request::OrgApprove`].** Nothing in a join code binds it to a person; a substituted code
1995    /// carries a different `user_pk` and so diverges here. This is the entire check.
1996    pub join_code_fingerprint: String,
1997}
1998
1999/// Params of [`Request::OrgRevoke`] (#66).
2000#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2001#[serde(deny_unknown_fields)]
2002pub struct OrgRevokeParams {
2003    /// Who or what to revoke: a `user_id` (the person and every device), or `"<user_id>/<label>"`
2004    /// (one device).
2005    pub target: String,
2006    /// Treat this as a USER-KEY rotation instead: remove the person but leave their devices
2007    /// un-revoked, so the same hardware re-enrolls under a fresh user key and is re-approved with
2008    /// the same `user_id`.
2009    ///
2010    /// The distinction is the point — a departure must revoke the devices, a rotation must not.
2011    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
2012    pub user_key: bool,
2013}
2014
2015/// Result of [`Request::OrgRevoke`] (#66).
2016#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2017pub struct OrgRevokeResult {
2018    pub target: String,
2019    /// `"person"` | `"device"` | `"user-key-rotation"` — which grammar the target resolved to, so a
2020    /// caller can confirm the destructive reading it got was the one it meant.
2021    pub mode: String,
2022    pub org_id: String,
2023    pub serial: u64,
2024    /// Live sessions severed by the install. Revocation is IMMEDIATE (#54): a cut device's existing
2025    /// connections are closed, not left to drain.
2026    #[serde(default)]
2027    pub severed: u32,
2028}
2029
2030/// Result of [`Request::RosterMembers`]: the org's membership as an embedder renders it (#93).
2031///
2032/// Distinct from `status.presence` in what it enumerates: that lists reachable DEVICES and omits a
2033/// person entirely when none of their devices is up. This lists every person the roster carries,
2034/// online or not — a member list, not a presence list — with `online` per device so a UI can draw
2035/// both from one read.
2036///
2037/// ADVISORY. Every field here is display or authoring input; nothing in it is an authorization
2038/// answer. The gate reads the signed roster.
2039#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2040pub struct RosterMembersResult {
2041    /// The org's declared group namespace, in document order — the set an `allow` entry may name.
2042    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2043    pub groups: Vec<String>,
2044    /// Every person in the roster, ordered by `user_id` for a stable display.
2045    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2046    pub users: Vec<RosterMember>,
2047}
2048
2049/// One person in a [`RosterMembersResult`] (#93).
2050#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2051pub struct RosterMember {
2052    /// The stable authorization handle — what an `allow` entry names.
2053    pub user_id: String,
2054    /// The human name, for display. Empty if the roster's own field is.
2055    #[serde(default, skip_serializing_if = "String::is_empty")]
2056    pub display_name: String,
2057    /// The groups this person belongs to, each declared in [`RosterMembersResult::groups`].
2058    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2059    pub groups: Vec<String>,
2060    /// Their ACTIVE devices — revoked ones are absent, exactly as the gate sees it. Ordered
2061    /// primary-before-mirror, then by label.
2062    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2063    pub devices: Vec<RosterMemberDevice>,
2064}
2065
2066/// One device of a [`RosterMember`] (#93).
2067#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2068pub struct RosterMemberDevice {
2069    /// The device's human label.
2070    pub label: String,
2071    /// `"primary"` | `"mirror"` — the advisory dial-ordering hint, never a security property.
2072    pub role: String,
2073    /// The device's stable `eid:` principal — the SAME vocabulary [`PeerInfo::principal`] carries,
2074    /// and what a per-device `allow` entry names.
2075    ///
2076    /// Included where `PresencePeer` deliberately omits it, because this surface exists to be
2077    /// ACTED on: an embedder granting or revoking one device of a person needs the handle to name
2078    /// it, and the alternative is a nickname that does not exist in roster mode.
2079    pub principal: String,
2080    /// Whether the device has a live presence heartbeat. Advisory — absence never blocks a dial,
2081    /// and never removes a dial candidate.
2082    pub online: bool,
2083}
2084
2085/// Result of [`Request::BlobPublish`]: the copyable `mcpmesh/blob/1` ticket + the blob's blake3 hash.
2086/// A ticket/hash here is blob-reference vocabulary (NOT a transport-vocab leak — the same
2087/// carve-out as the pairing invite line). Additive-only.
2088#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2089pub struct BlobPublishResult {
2090    pub ticket: String,
2091    pub hash: String, // bare blake3 hex
2092}
2093
2094/// One scope in a [`BlobScopeList`]: its name + the hashes it contains + the principals it
2095/// grants. Flat vocabulary ONLY — no EndpointId/pubkey/ALPN. Additive-only.
2096#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2097pub struct ScopeInfo {
2098    pub name: String,
2099    pub hashes: Vec<String>,
2100    pub grants: Vec<String>,
2101    /// Hashes deliberately WITHDRAWN from this scope (#107): `blob_unpublish` was called, and
2102    /// `blob_republish` of these into THIS scope is refused with [`ERR_BLOB_WITHDRAWN`]. Cleared
2103    /// only by a deliberate `blob_publish {scope, path}`. Additive — omitted when empty, so a
2104    /// pre-`api_minor` 19 client sees exactly what it saw before.
2105    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2106    pub withdrawn: Vec<String>,
2107    /// Size of `hashes` — always present, even when `counts_only` empties the vector (#84b).
2108    #[serde(default)]
2109    pub hash_count: usize,
2110    /// Size of `grants`.
2111    #[serde(default)]
2112    pub grant_count: usize,
2113    /// Size of `withdrawn`.
2114    #[serde(default)]
2115    pub withdrawn_count: usize,
2116}
2117
2118/// Params of [`Request::BlobList`] (#84b). ALL optional — `blob_list {}` still works, which
2119/// matters because the verb took no params before `api_minor` 20.
2120///
2121/// A DEFAULT LIMIT applies when `limit` is absent. Deliberate: unpaged, `blob_list` renders every
2122/// scope into one frame against the 16 MiB cap; past it the CLIENT rejects the frame as malformed.
2123/// The control surface carries no strike bound, so the connection survives — but the caller gets an
2124/// opaque failure with no way to page, which is unusable rather than merely large.
2125#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2126#[serde(default, deny_unknown_fields)]
2127pub struct BlobListParams {
2128    /// EXACT scope name, never a prefix.
2129    pub scope: Option<String>,
2130    /// Only scopes containing this hash; the rendering you send is normalized first.
2131    pub hash: Option<String>,
2132    pub limit: Option<usize>,
2133    pub offset: Option<usize>,
2134    /// Omit `hashes`/`grants`/`withdrawn`, keep the counts.
2135    pub counts_only: bool,
2136}
2137
2138/// Result of [`Request::BlobList`]: the daemon's scopes. Additive-only.
2139#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2140pub struct BlobScopeList {
2141    pub scopes: Vec<ScopeInfo>,
2142    /// Scopes matching the filter BEFORE `limit`/`offset` (#84b). Without this you cannot tell a
2143    /// complete answer from a clipped one.
2144    #[serde(default)]
2145    pub total: usize,
2146    /// True when more scopes matched than were returned. Page with `offset` to see the rest.
2147    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
2148    pub truncated: bool,
2149}
2150
2151/// Result of [`Request::BlobFetch`]: the verified hash + byte length written to `dest_path`.
2152/// Additive-only.
2153#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2154pub struct BlobFetchResult {
2155    pub hash: String,
2156    pub bytes_len: u64,
2157}
2158
2159/// Result of [`Request::BlobFetchCancel`] (#172).
2160#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2161pub struct BlobFetchCancelResult {
2162    /// True when a fetch of that hash was in flight and has been told to stop. False is NOT an
2163    /// error — it means nothing was fetching that blob here, which is also what a caller sees when
2164    /// it races a fetch that just finished.
2165    pub cancelled: bool,
2166}
2167
2168/// Params of [`Request::AuditPrune`] (#88): delete monthly audit files STRICTLY older than
2169/// `before` (that month itself is kept — delete-before, not delete-including). Rejects unknown
2170/// fields, and the daemon validates the `YYYY-MM` shape up front: a malformed month errors
2171/// loudly instead of string-comparing to nothing and reporting a clean no-op.
2172#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2173#[serde(deny_unknown_fields)]
2174pub struct AuditPruneParams {
2175    /// A zero-padded `YYYY-MM` month key.
2176    pub before: String,
2177}
2178
2179/// Result of [`Request::AuditPrune`]: the month keys actually deleted, ascending. Empty when
2180/// nothing was older than `before` (idempotent).
2181#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2182pub struct AuditPruneResult {
2183    pub deleted_months: Vec<String>,
2184}
2185
2186/// Params of [`Request::AuditList`] (#88). All filters optional and AND-combined; every field
2187/// absent lists everything (paged). Rejects unknown fields — a typo'd filter that silently
2188/// matched everything would let a "what do you hold about X" answer overclaim.
2189#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2190#[serde(deny_unknown_fields)]
2191pub struct AuditListParams {
2192    /// Inclusive `YYYY-MM` lower bound — month-file granularity (the rotation unit), so an
2193    /// out-of-range month is skipped without parsing it.
2194    #[serde(default, skip_serializing_if = "Option::is_none")]
2195    pub since: Option<String>,
2196    /// Inclusive `YYYY-MM` upper bound.
2197    #[serde(default, skip_serializing_if = "Option::is_none")]
2198    pub until: Option<String>,
2199    /// One of the wire kind strings (`session_open` / `session_close` / `request` /
2200    /// `blob_fetch` / `trust`). An UNKNOWN string is an error, never silently-all.
2201    #[serde(default, skip_serializing_if = "Option::is_none")]
2202    pub kind: Option<String>,
2203    /// The record's attributed peer nickname.
2204    #[serde(default, skip_serializing_if = "Option::is_none")]
2205    pub peer: Option<String>,
2206    /// Page size, default 500, clamped to 1000 — a month file can be arbitrarily large and the
2207    /// response is ONE JSON frame under the transport's frame cap, so the clamp is load-bearing
2208    /// (the same lesson as `blob_list`'s, minor 20).
2209    #[serde(default, skip_serializing_if = "Option::is_none")]
2210    pub limit: Option<u32>,
2211    /// Records to skip (after filtering), for paging.
2212    #[serde(default, skip_serializing_if = "Option::is_none")]
2213    pub offset: Option<u32>,
2214}
2215
2216/// Result of [`Request::AuditList`]: one page of matching records in chronological order
2217/// (oldest month first, in-file order within a month), plus the TOTAL match count so a caller
2218/// can page without a second counting call. `total` counts ALL matches, not the page.
2219#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2220pub struct AuditListResult {
2221    pub records: Vec<AuditRecord>,
2222    pub total: u64,
2223}
2224
2225/// Result of [`Request::AuditSummary`]: LOCAL per-peer / per-service session counts
2226/// aggregated from this node's OWN audit log — NEVER transmitted (local-only). Surface-clean:
2227/// peer names are nicknames / user_ids (NEVER EndpointIds), service names are the registered
2228/// service names (NEVER transport vocabulary). A "session" is one `SessionOpen` record. `per_peer` /
2229/// `per_service` are sorted ascending by name (deterministic). Tuples mirror kb's
2230/// `InsightResponse::per_peer_contribution` — `["bob", 2]` on the wire.
2231///
2232/// Additive-only: any future field MUST land as
2233/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
2234#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2235pub struct AuditSummaryResult {
2236    /// Sessions opened per peer (nickname). A session with no attributed peer is NOT counted here (no
2237    /// peer to attribute) but IS in `total_sessions`.
2238    pub per_peer: Vec<(String, u64)>,
2239    /// Sessions opened per registered service name.
2240    pub per_service: Vec<(String, u64)>,
2241    /// Total sessions opened (every `SessionOpen` record, including peer-less ones).
2242    #[serde(default)]
2243    pub total_sessions: u64,
2244}
2245
2246/// Result of an [`Request::Invite`] request: the copyable `mcpmesh-invite:` artifact
2247/// (the ONE pairing artifact deliberately carved out of the
2248/// transport-vocabulary blocklist, so this is NOT a transport-vocab leak) plus its
2249/// absolute expiry in epoch seconds (≤ now + 24h).
2250///
2251/// `invite` returns BEFORE any redemption, so the SAS — which is derived from the redeemer's
2252/// endpoint id, unknown until they redeem — cannot appear here. The inviter reads its side of
2253/// the SAS from [`StatusResult::recent_pairings`] once a redemption completes (a `trust`/`pair`
2254/// frame on the live [`StreamFrame`] stream signals that moment). See the "embedding the pairing
2255/// ceremony" note in `docs/local-protocol.md` (#35).
2256///
2257/// Additive-only: any future field MUST land as `#[serde(default, skip_serializing_if = ...)]`
2258/// so older payloads still deserialize.
2259#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2260pub struct InviteResult {
2261    /// The `mcpmesh-invite:<base32>` line, copied out-of-band to the redeemer.
2262    pub invite_line: String,
2263    /// When the invite expires (epoch seconds); the daemon burns it at redemption or expiry.
2264    pub expires_at_epoch: u64,
2265    /// How many redemptions this invite has left (#87) — **the value actually applied**, after the
2266    /// [`MAX_INVITE_USES`] clamp. `1` for an ordinary single-use invite.
2267    ///
2268    /// Reported so a caller that asked for more than the cap is told what it got rather than
2269    /// discovering it when the fourth colleague fails. Additive: `#[serde(default = "one")]`, so a
2270    /// response from an older daemon reads as single-use. `api_minor >= 35`.
2271    #[serde(default = "one_use")]
2272    pub uses_remaining: u32,
2273}
2274
2275/// The serde default for a `uses_remaining` field absent from an older payload or invite line: one
2276/// redemption, which is what every pre-#87 invite is.
2277pub fn one_use() -> u32 {
2278    1
2279}
2280
2281/// Result of a [`Request::Pair`] request: the inviter's suggested nickname (the
2282/// redeemer's local name for the new peer) plus the display-only short authentication
2283/// code (SAS) — a few words the human reads aloud to a second channel to
2284/// catch a whole-invite forgery / address-swap MITM. The SAS is a pairing-ceremony
2285/// artifact (like the invite line), NOT a transport-vocabulary leak.
2286///
2287/// Additive-only: any future field MUST land as
2288/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
2289#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2290pub struct PairResult {
2291    /// The inviter's suggested nickname (from the invite) — the redeemer's local name for it.
2292    pub peer_nickname: String,
2293    /// The display-only short authentication code (e.g. `"tango-fig-42"`), shown on both
2294    /// sides for the out-of-band human check. Never sent on the wire, never checked
2295    /// programmatically.
2296    pub sas_code: String,
2297    /// TRUE when this redemption was a SELF-ENROLLMENT (#86): you are now another device of the
2298    /// inviter's person, not their peer. No peer row was written and nothing was granted.
2299    ///
2300    /// Reported so a caller can tell the two outcomes apart without inspecting its own store.
2301    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
2302    pub enrolled_as_self: bool,
2303    /// The services this pairing granted the redeemer — each mountable as `<peer>/<service>`.
2304    /// Populated from the invite (`invite.services`) by the redeemer-side `redeem_invite`, so
2305    /// the porcelain can print the "You can mount: alice/notes" line without re-decoding the
2306    /// invite. Additive: `#[serde(default, skip_serializing_if = ...)]` so a `PairResult`
2307    /// minted by an older daemon (which omits `services`) still deserializes — to an empty list.
2308    #[serde(default, skip_serializing_if = "Vec::is_empty")]
2309    pub services: Vec<String>,
2310    /// The opaque `app_label` the inviter attached at `invite` time (#31), echoed verbatim — or
2311    /// absent if none was set. mcpmesh never interprets it; the embedder does. Additive.
2312    #[serde(default, skip_serializing_if = "Option::is_none")]
2313    pub app_label: Option<String>,
2314    /// The inviter's proven self-sovereign `user_id` (`b64u:<user_pk>`), when it presented a
2315    /// device→user binding at pairing (#30). This is the STABLE, portable identity the redeemer
2316    /// can align with its own — and the same value it may later pass to `open_session` to dial
2317    /// this peer by identity rather than by local nickname. `None` if the inviter presented no
2318    /// binding (a legacy/keyless peer). Additive.
2319    #[serde(default, skip_serializing_if = "Option::is_none")]
2320    pub peer_user_id: Option<String>,
2321}
2322
2323/// The event class of an [`AuditRecord`] (the four audit event classes). An additive discriminant on
2324/// top of the base record schema: it removes no field and makes the JSONL self-describing so
2325/// a consumer can filter by class without guessing from which optional fields are present.
2326#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2327#[serde(rename_all = "snake_case")]
2328pub enum AuditKind {
2329    /// A mesh session opened (a backend was selected for an authenticated peer).
2330    /// (A `session_open` with `status:"error"` is a synthesized FAILED-dial marker — no backend
2331    /// was reached; it records an attempted-and-failed reach for the telemetry stream.)
2332    SessionOpen,
2333    /// A mesh session closed (the backend returned / the session tore down).
2334    SessionClose,
2335    /// One proxied MCP request line (method + tool NAME + args_hash). NEVER carries raw arguments.
2336    Request,
2337    /// A peer fetched a blob from this node's gated provider (peer + hash + allow/deny).
2338    BlobFetch,
2339    /// A trust mutation (pair, unpair, roster install/swap, revoke).
2340    Trust,
2341}
2342
2343/// One audit record — the union of the event classes, and the `record` payload of a
2344/// [`StreamFrame::Event`]. ONE schema for the on-disk JSONL log and the live stream. Every field
2345/// beyond `ts`/`kind` is optional and elided when absent (`skip_serializing_if`), so each class
2346/// serializes to just its relevant keys (a session record has no `method`; a trust record has no
2347/// `bytes_out`).
2348///
2349/// PRIVACY: the proxied-request record carries `method` + `tool` (NAME only) +
2350/// `args_hash` (`"blake3:<hex>"`), and NEVER the raw arguments, the request/response content, or
2351/// any tool-output bytes — only a `bytes_out` COUNT and a `status`.
2352#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2353pub struct AuditRecord {
2354    /// RFC3339 UTC with millisecond precision, e.g. `"2026-07-03T14:02:11.480Z"`. The `YYYY-MM`
2355    /// prefix also selects the monthly file (the rotation boundary), so it is always present.
2356    pub ts: String,
2357    pub kind: AuditKind,
2358    /// The gate-resolved authenticated peer (attributed by the endpoint_id-keyed trust gate). Absent on
2359    /// local-only events with no remote peer (a manual roster install).
2360    #[serde(skip_serializing_if = "Option::is_none")]
2361    pub peer: Option<String>,
2362    #[serde(skip_serializing_if = "Option::is_none")]
2363    pub service: Option<String>,
2364    #[serde(skip_serializing_if = "Option::is_none")]
2365    pub method: Option<String>,
2366    /// The tool NAME only (never its arguments or output) — e.g. `"read_file"` for a `tools/call`.
2367    #[serde(skip_serializing_if = "Option::is_none")]
2368    pub tool: Option<String>,
2369    /// `"blake3:<hex>"` of the request arguments. The raw arguments are NEVER stored.
2370    #[serde(skip_serializing_if = "Option::is_none")]
2371    pub args_hash: Option<String>,
2372    /// Byte COUNT of the response sent back to the peer — a count, never the content.
2373    #[serde(skip_serializing_if = "Option::is_none")]
2374    pub bytes_out: Option<u64>,
2375    /// `"ok"` / `"error"` (proxied request) or `"ok"` / `"denied"` (blob fetch).
2376    #[serde(skip_serializing_if = "Option::is_none")]
2377    pub status: Option<String>,
2378    #[serde(skip_serializing_if = "Option::is_none")]
2379    pub latency_ms: Option<u64>,
2380    /// Trust-event verb: `"pair"` / `"unpair"` / `"roster_install"` / `"revoke"` (kind == Trust).
2381    #[serde(skip_serializing_if = "Option::is_none")]
2382    pub event: Option<String>,
2383    /// A reference, NEVER content: a blob hash (`BlobFetch`) or a trust-event target such as a
2384    /// nickname or `org/serial` (`Trust`).
2385    #[serde(skip_serializing_if = "Option::is_none")]
2386    pub target: Option<String>,
2387    /// The subject's STABLE principal, from the same gate resolution that produced `peer`
2388    /// (#57, `api_minor >= 29`). `peer` is a display name and collides — two devices under one
2389    /// nickname were indistinguishable in the stream and the on-disk log. Same argument and
2390    /// shape as `PeerInfo` (#41), `PeerReachability` (#42), and `ActiveSession` (#73).
2391    ///
2392    /// TWO NAMESPACES, deliberately: session/request/blob records attribute the DEVICE
2393    /// (`eid:<hex>`, like `ActiveSession` — the exact authenticated endpoint), while the trust
2394    /// `pair` record carries the value the grant appended to the allow (`b64u:<pk>` when the
2395    /// device presented a user binding, else `eid:`, #38). Joining a bound peer's sessions to
2396    /// its allow entry therefore goes through the `status` peers list (which carries BOTH the
2397    /// device principal and the `user_id`), not string equality on this field alone.
2398    ///
2399    /// **`peer_introduce` (#65) is the one exception, deliberately:** it carries the ENDORSER, not
2400    /// the subject. An introduction's whole security question is *who vouched for this peer*, and
2401    /// the subject is already in `target`. So `audit_list --peer <endorser>` finds the
2402    /// introductions that endorser caused, which is the query an operator actually runs.
2403    ///
2404    /// Deliberately absent on: `unpair` (may tear down several devices — no single subject),
2405    /// `roster_install` (purely local), and the failed-outbound-dial session record (our own
2406    /// dial, not a gate-resolved caller). Absent on every record written before 0.24.0.
2407    #[serde(default, skip_serializing_if = "Option::is_none")]
2408    pub principal: Option<String>,
2409}
2410
2411impl AuditRecord {
2412    fn base(ts: String, kind: AuditKind) -> Self {
2413        Self {
2414            ts,
2415            kind,
2416            peer: None,
2417            service: None,
2418            method: None,
2419            tool: None,
2420            args_hash: None,
2421            bytes_out: None,
2422            status: None,
2423            latency_ms: None,
2424            event: None,
2425            target: None,
2426            principal: None,
2427        }
2428    }
2429
2430    /// `principal` is an EXPLICIT parameter on every constructor (#57, kept from the original
2431    /// #72 design): a builder would let a call site silently omit it and reintroduce the
2432    /// collapsed-identity bug for that one event class. Pass `None` only for the documented
2433    /// no-single-subject records (see the field doc).
2434    pub fn session_open(
2435        ts: String,
2436        peer: Option<String>,
2437        service: String,
2438        principal: Option<String>,
2439    ) -> Self {
2440        let mut r = Self::base(ts, AuditKind::SessionOpen);
2441        r.peer = peer;
2442        r.service = Some(service);
2443        r.principal = principal;
2444        r
2445    }
2446
2447    /// Set the record's `status` (`"ok"`/`"error"`/`"denied"`), returning `self` for chaining.
2448    /// Marks a synthesized failure record — e.g. the `session_open` for a FAILED dial, which
2449    /// reaches no backend and so is never audited by the far side's session guard — without a
2450    /// dedicated constructor. DRY: reuses the existing optional `status` field.
2451    pub fn with_status(mut self, status: &str) -> Self {
2452        self.status = Some(status.into());
2453        self
2454    }
2455
2456    pub fn session_close(
2457        ts: String,
2458        peer: Option<String>,
2459        service: String,
2460        principal: Option<String>,
2461    ) -> Self {
2462        let mut r = Self::base(ts, AuditKind::SessionClose);
2463        r.peer = peer;
2464        r.service = Some(service);
2465        r.principal = principal;
2466        r
2467    }
2468
2469    /// A completed (request→response correlated) proxied line: method + tool NAME + args_hash, plus
2470    /// the response's `bytes_out` COUNT, `status`, and `latency_ms`. PRIVACY: `args_hash` is a digest;
2471    /// no raw arguments, request/response content, or tool-output bytes are ever passed in.
2472    #[allow(clippy::too_many_arguments)]
2473    pub fn proxied_request(
2474        ts: String,
2475        peer: Option<String>,
2476        service: String,
2477        method: String,
2478        tool: Option<String>,
2479        args_hash: String,
2480        bytes_out: u64,
2481        status: String,
2482        latency_ms: u64,
2483        principal: Option<String>,
2484    ) -> Self {
2485        let mut r = Self::base(ts, AuditKind::Request);
2486        r.peer = peer;
2487        r.service = Some(service);
2488        r.method = Some(method);
2489        r.tool = tool;
2490        r.args_hash = Some(args_hash);
2491        r.bytes_out = Some(bytes_out);
2492        r.status = Some(status);
2493        r.latency_ms = Some(latency_ms);
2494        r.principal = principal;
2495        r
2496    }
2497
2498    /// A proxied NOTIFICATION line (no `id`, so no response correlates): method + tool + args_hash,
2499    /// no `bytes_out`/`status`/`latency_ms`. The line is still recorded — every proxied request is audited.
2500    pub fn proxied_notification(
2501        ts: String,
2502        peer: Option<String>,
2503        service: String,
2504        method: String,
2505        tool: Option<String>,
2506        args_hash: String,
2507        principal: Option<String>,
2508    ) -> Self {
2509        let mut r = Self::base(ts, AuditKind::Request);
2510        r.peer = peer;
2511        r.service = Some(service);
2512        r.method = Some(method);
2513        r.tool = tool;
2514        r.args_hash = Some(args_hash);
2515        r.principal = principal;
2516        r
2517    }
2518
2519    pub fn blob_fetch(
2520        ts: String,
2521        peer: Option<String>,
2522        hash: String,
2523        status: String,
2524        principal: Option<String>,
2525    ) -> Self {
2526        let mut r = Self::base(ts, AuditKind::BlobFetch);
2527        r.peer = peer;
2528        r.target = Some(hash);
2529        r.status = Some(status);
2530        r.principal = principal;
2531        r
2532    }
2533
2534    pub fn trust(
2535        ts: String,
2536        event: String,
2537        target: Option<String>,
2538        principal: Option<String>,
2539    ) -> Self {
2540        let mut r = Self::base(ts, AuditKind::Trust);
2541        r.event = Some(event);
2542        r.target = target;
2543        r.principal = principal;
2544        r
2545    }
2546}
2547
2548/// One live mesh session, in a [`StreamFrame::Snapshot`]. Surface-clean: `peer` is the
2549/// user_id-or-nickname the audit records carry, never an endpoint-id. `opened_at` is epoch seconds.
2550#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2551pub struct ActiveSession {
2552    pub peer: String,
2553    pub service: String,
2554    pub opened_at: i64,
2555    /// The caller's STABLE device principal, `eid:<hex>` (#73).
2556    ///
2557    /// `peer` is a display nickname and collides: two devices under one nickname, or two contacts
2558    /// sharing a display name, are indistinguishable in the live-session view. So "who is using my
2559    /// service right now", per-peer session counts, and any UI that lets a user act on a live
2560    /// session (revoke, disconnect, inspect) were all keyed on a collidable string.
2561    ///
2562    /// Same argument and same shape as [`PeerInfo`] (#41) and [`PeerReachability`] (#42).
2563    /// Nicknames NEVER authorize; this is the value to key on.
2564    ///
2565    /// **Snapshot only, for now.** `ActiveSession` appears in [`StreamFrame::Snapshot`] — there is
2566    /// no `active_sessions` on `StatusResult`. A client that keeps its view current by applying
2567    /// subsequent `session_open`/`session_close` events still has a collision problem: those are
2568    /// [`AuditRecord`]s and carry no principal (#57, unmerged). So the snapshot distinguishes two
2569    /// same-nickname devices and the next `session_close` for that nickname does not say which row
2570    /// to drop. Re-subscribe for an authoritative view until #57 lands.
2571    ///
2572    /// Always present for a real row — `Option` only so an older client round-trips. Additive.
2573    #[serde(default, skip_serializing_if = "Option::is_none")]
2574    pub principal: Option<String>,
2575}
2576
2577/// Which side of an app-blob transfer a [`StreamFrame::BlobTransfer`] describes (#82).
2578#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2579#[serde(rename_all = "snake_case")]
2580pub enum BlobDirection {
2581    /// We are SERVING bytes to a peer that dialed our app-blob ALPN.
2582    Serve,
2583    /// We are FETCHING bytes from a peer, via `blob_fetch`.
2584    Fetch,
2585}
2586
2587/// Where an app-blob transfer is in its life (#82).
2588#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2589#[serde(rename_all = "snake_case")]
2590pub enum BlobTransferState {
2591    /// The transfer began; `bytes_total` is known from here on.
2592    Started,
2593    /// Bytes advanced. COALESCED — see [`StreamFrame::BlobTransfer`].
2594    Progress,
2595    /// Finished successfully. Carries the FINAL byte count.
2596    Completed,
2597    /// Ended without completing (peer went away, refused, or the store errored).
2598    Aborted,
2599}
2600
2601/// One frame of the [`Request::Subscribe`] stream (pairing liveness & health telemetry). Tagged on
2602/// `type` (snake_case), so a frame is `{"type":"snapshot",...}` / `{"type":"event",...}` /
2603/// `{"type":"lagged",...}`. `Event.record` is the [`AuditRecord`] verbatim, so the stream and the
2604/// on-disk log carry ONE schema. The daemon serializes these; an embedding consumer deserializes
2605/// them (see `docs/local-protocol.md` "Live event stream").
2606///
2607/// **`#[non_exhaustive]`**: a future frame kind must not break a downstream `match`. Adding
2608/// `Reachability` in 0.13.0 DID break exhaustive matches — which is why that release is a MINOR,
2609/// per `RELEASING.md`'s pre-1.0 rule that breaking changes bump the minor. Consumers now write a
2610/// `_ =>` arm and later additions are additive for Rust.
2611///
2612/// **They are NOT additive for JSON, and this line claimed they were until 1.55.** The enum is
2613/// `#[serde(tag = "type")]` with no catch-all variant, so an unrecognised tag is a hard
2614/// deserialization error: [`StreamSubscription::next`](crate::StreamSubscription::next) surfaces a
2615/// newer daemon's frame as [`ClientError::Malformed`](crate::ClientError::Malformed) and a consumer
2616/// that propagates it loses the whole stream. `#[non_exhaustive]` is a Rust-`match` property and
2617/// does nothing for serde. A consumer that must survive a daemon newer than its `mcpmesh-local-api`
2618/// reads raw frames via [`ControlClient::open_stream`](crate::ControlClient::open_stream) and
2619/// ignores tags it does not know — that is the only forward-compatible path, and the crates ship in
2620/// lockstep precisely because of this.
2621#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2622#[serde(tag = "type", rename_all = "snake_case")]
2623#[non_exhaustive]
2624pub enum StreamFrame {
2625    /// The FIRST frame: a point-in-time picture of the mesh (open sessions + paired-peer
2626    /// reachability) so a fresh subscriber renders immediately without replaying history.
2627    Snapshot {
2628        active_sessions: Vec<ActiveSession>,
2629        reachability: Vec<PeerReachability>,
2630        /// THIS node's own reachability posture (#90), so a fresh subscriber renders it without
2631        /// a `status` poll. `None` in mesh-less control-only mode. Additive: default +
2632        /// skip-if-none so an older payload round-trips.
2633        #[serde(default, skip_serializing_if = "Option::is_none")]
2634        self_network: Option<SelfNetwork>,
2635    },
2636    /// A live audit event (session open/close, request, blob fetch, trust) — the tap on the hub.
2637    /// Boxed so this (much larger) variant does not bloat every frame; serde delegates through the
2638    /// `Box`, so the wire shape is the record's fields verbatim.
2639    Event { record: Box<AuditRecord> },
2640    /// A peer's reachability TRANSITIONED (#58): it became reachable, became unreachable, or was
2641    /// probed for the first time. Pushed so an embedder does not have to poll `status` for a live
2642    /// online/offline indicator — and so work queued for an unreachable peer can flush the moment
2643    /// it returns, rather than on the next poll tick.
2644    ///
2645    /// Emitted on a change of `reachable` **or of `path`**. A refresh with the same verdict AND the
2646    /// same path emits nothing, so a peer that stays up does not produce a frame per TTL refresh;
2647    /// `rtt_ms`/`meta`/`services` drift is advisory detail and is not a transition. `age_secs` is
2648    /// `0` — the observation just completed.
2649    ///
2650    /// **Do not treat this as an up/down toggle.** It carried that meaning through 0.18, and this
2651    /// doc said "on a CHANGE of `reachable` only" until 1.22 — which stopped being true in 0.19.0
2652    /// (#92 item 1), when `path` joined the transition rule. A consumer that assumed same-verdict
2653    /// frames were impossible was reading a stale guarantee.
2654    ///
2655    /// Two producers, as of API 1.22 — and since 1.30 `source` says WHICH ONE, so the distinction
2656    /// is readable rather than inferred:
2657    ///
2658    /// - [`ReachabilitySource::Probe`] — a probe completing (`status`/`subscribe` refreshing a
2659    ///   stale entry). It describes a throwaway dial, not anyone's live connection.
2660    /// - [`ReachabilitySource::Session`] — a live session whose selected path changed under it
2661    ///   (#92 item 2). A claim about the link in use.
2662    ///
2663    /// The second producer is why `path` is trustworthy for a long-lived session: a session that
2664    /// degrades Direct→Relay mid-call now says so when it happens, rather than staying silently
2665    /// mislabelled until something probes. `path` is a truth claim about where user data went, so
2666    /// `Unknown` means "we do not know" and must never be rendered as private.
2667    ///
2668    /// **`rtt_ms` is not a discriminator, and never was** (#150). Until 1.30 this doc said a
2669    /// session-sourced frame carries `rtt_ms: None` — true only of a FIRST observation, where no
2670    /// round trip was measured and none is invented. A session-sourced frame for an
2671    /// already-probed peer carries that probe's `rtt_ms: Some(..)`, because the path watcher
2672    /// deliberately leaves `rtt_ms`/`meta`/`probed_at` alone (refreshing them would stamp a stale
2673    /// RTT as fresh and suppress the corrective probe — #92 review). That is the common case for a
2674    /// peer probed at pairing time and then watched through a long call. Read `source`.
2675    Reachability {
2676        peer: PeerReachability,
2677        /// Which producer emitted this frame (#150). `api_minor >= 30`.
2678        ///
2679        /// Additive: `#[serde(default)]`, landing on [`ReachabilitySource::Unknown`] — NOT on
2680        /// `Probe`. A daemon at `api_minor` 22–29 already has both producers, so an absent field
2681        /// genuinely does not say which one ran; defaulting to `Probe` would assert the wrong
2682        /// producer for every session-sourced frame such a daemon emits, which is the exact
2683        /// ambiguity this field exists to remove.
2684        #[serde(default)]
2685        source: ReachabilitySource,
2686    },
2687    /// THIS node's own network posture CHANGED (#90): `online` flipped, the home relay moved,
2688    /// or a relay's connection state changed — pushed so an embedder learns "you just went
2689    /// unreachable" the moment it happens instead of on a poll tick, and so #53's `set_relays`
2690    /// finally has a signal telling someone to use it. `direct_addrs` drift alone does not
2691    /// emit (address churn is chatty and not a decision point; it rides the next frame).
2692    /// `api_minor >= 28`.
2693    SelfNetwork { self_network: SelfNetwork },
2694    /// This machine was SUSPENDED and has just resumed (#167 ask 2) — a closed laptop lid, a sleep,
2695    /// a hibernate. `api_minor >= 55`.
2696    ///
2697    /// The signal an embedder holding long-lived sessions actually needs. While a machine is
2698    /// suspended it sends nothing, so the *peer's* idle timer runs out and tears the connection down
2699    /// before the lid is even reopened; `keep_alive_secs` cannot help, because a suspended process
2700    /// emits no PINGs. Without this frame the first thing an app learns is a failed send, which is
2701    /// the worst possible moment to find out. With it, the app can tear down and re-dial
2702    /// deliberately.
2703    ///
2704    /// **Detected as clock skew, not guessed.** Rust's `Instant` is `CLOCK_MONOTONIC` on Linux and
2705    /// `CLOCK_UPTIME_RAW` on Apple targets, and neither advances across a suspend while the wall
2706    /// clock does. A tick where the wall clock outran the monotonic clock by more than the threshold is a
2707    /// suspend; a tick where BOTH ran long is a starved runtime and emits nothing. That distinction
2708    /// is deliberate — a signal that fired under load would train consumers to ignore it.
2709    ///
2710    /// **It names no session.** The daemon cannot know which of an embedder's sessions survived —
2711    /// a short suspend may well leave one intact. It means "this machine was away for N seconds;
2712    /// re-check what you hold".
2713    ///
2714    /// **A forward wall-clock STEP also emits, and cannot be told apart from a sleep.** A board with
2715    /// no RTC that boots with a bogus epoch and is then stepped months forward by NTP produces a
2716    /// frame claiming a multi-year suspend. Read `suspended_secs` as "wall time ran this much
2717    /// further than this process did", which is what is actually measured; the frame's advice
2718    /// survives either cause, but the number is not a measurement of sleep alone. Distinguishing
2719    /// them needs a continuous clock (`CLOCK_BOOTTIME` / `mach_continuous_time`), which is a
2720    /// per-platform dependency this does not take.
2721    ///
2722    /// Not retroactive, and — unlike the other transitions — with **nothing in `Snapshot` to
2723    /// recover it from.** [`Reachability`](StreamFrame::Reachability) and
2724    /// [`SelfNetwork`](StreamFrame::SelfNetwork) missed frames are recoverable because `Snapshot`
2725    /// carries `reachability` and `self_network`; there is no resume field, because "was this
2726    /// machine recently asleep" is not a state the daemon holds. A subscriber that attaches after a
2727    /// wake cannot learn one happened. If you reconnect, assume you missed events and re-check what
2728    /// you hold — the same advice this frame carries.
2729    Resumed {
2730        /// How long the machine was away, in seconds — the number that decides whether to re-dial
2731        /// everything or nothing. It is the wall-clock/monotonic skew, so it measures the suspend
2732        /// itself and not the time since the last frame.
2733        suspended_secs: u64,
2734        /// Wall-clock epoch seconds at which the resume was DETECTED (up to one tick after the
2735        /// machine actually woke).
2736        at_epoch: i64,
2737    },
2738    /// The subscriber fell `dropped` records behind the broadcast ring; the stream continues (a
2739    /// fresh reconnect would re-`Snapshot`). Never drops the subscriber — lag is reported, never fatal.
2740    Lagged { dropped: u64 },
2741    /// An app-blob transfer advanced (#82). Emitted on BOTH sides: `Serve` while we send bytes to
2742    /// a peer, `Fetch` while `blob_fetch` pulls them.
2743    ///
2744    /// **`Progress` is COALESCED, deliberately.** iroh-blobs reports progress per ~16 KiB chunk, so
2745    /// a 4 GiB transfer would push ~262k frames through a bounded ring and every subscriber would
2746    /// see `Lagged` — losing the audit events that share it. A frame is emitted on `Started`, on
2747    /// `Completed`/`Aborted`, and on `Progress` only after at least `max(1 MiB, total/100)` more
2748    /// bytes, so a transfer costs at most ~102 frames whatever its size.
2749    ///
2750    /// **Do not treat the last `Progress` as the total** — the final stride is usually skipped.
2751    /// `Completed` carries the final `bytes_done`.
2752    BlobTransfer {
2753        direction: BlobDirection,
2754        /// The blob's hash, hex.
2755        hash: String,
2756        bytes_done: u64,
2757        /// Known from `Started` onward; `None` only if the size was never reported.
2758        #[serde(default, skip_serializing_if = "Option::is_none")]
2759        bytes_total: Option<u64>,
2760        state: BlobTransferState,
2761        /// SERVING side only: the STABLE `eid:` device principal we are serving (#38 — never a
2762        /// display nickname). Always `eid:<hex>`: this comes from the authenticated endpoint, so it
2763        /// is NOT the same namespace as a grant written as a user_id or roster name. Absent when fetching, where the counterparty is named
2764        /// by the ticket rather than by a resolved identity.
2765        #[serde(default, skip_serializing_if = "Option::is_none")]
2766        peer: Option<String>,
2767    },
2768}
2769
2770/// Extract the `method` tag from a raw request value without deserializing the whole
2771/// message. The daemon's dispatcher uses this: match on the method string, then deserialize
2772/// `params` per-method — which tolerates omitted / null / `{}` params for parameterless
2773/// methods (adjacent tagging rejects `params:{}` on unit variants).
2774pub fn method_of(v: &serde_json::Value) -> Option<&str> {
2775    v.get("method").and_then(serde_json::Value::as_str)
2776}
2777
2778/// How a service is answered. Mirrors the config `[services.*]` *kinds*;
2779/// Config→BackendSpec is a hand-written match, not a serde passthrough.
2780#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2781#[serde(rename_all = "snake_case")]
2782pub enum BackendSpec {
2783    Run {
2784        cmd: Vec<String>,
2785        /// Per-service environment variables (#51) for the spawned child. Overlaid on the
2786        /// daemon's inherited env; the injected `MCPMESH_PEER_*` identity vars ALWAYS win over
2787        /// these (identity is not spoofable by a service definition). Default empty.
2788        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
2789        env: BTreeMap<String, String>,
2790        /// Working directory to spawn the child in (#51). Default: inherit the daemon's cwd.
2791        #[serde(default, skip_serializing_if = "Option::is_none")]
2792        cwd: Option<String>,
2793    },
2794    Socket {
2795        path: String,
2796    },
2797}
2798
2799/// Control-API error code: the named service exists in neither `config.toml` nor the ephemeral
2800/// registry (#55). Distinct from the generic `-32000` so a caller can BRANCH on "no such service"
2801/// instead of parsing a message — `service_allow_grant`/`service_allow_revoke` previously answered
2802/// `{}` (success) for an unknown name, which silently included every ephemeral service.
2803pub const ERR_NO_SUCH_SERVICE: i64 = -32040;
2804/// The named blob is not held COMPLETE by this daemon (#83, `blob_republish`). Distinct from
2805/// [`ERR_NO_SUCH_SERVICE`] because the remedy differs: fetch the blob first.
2806pub const ERR_NO_SUCH_BLOB: i64 = -32041;
2807/// The blob was deliberately withdrawn from this scope (#107). Distinct from
2808/// [`ERR_NO_SUCH_BLOB`]: that means "fetch it first", this means "someone un-shared this on
2809/// purpose — `blob_publish` from the file if the re-share is intended".
2810pub const ERR_BLOB_WITHDRAWN: i64 = -32042;
2811/// `pair` was refused because the redeemer's nickname is already held by a DIFFERENT paired peer
2812/// (#87), so an embedder can branch on the one refusal that has a self-service remedy — rename and
2813/// redeem the same invite again — without reading the prose (#147).
2814///
2815/// Reading the prose was the only option before this code, and it does not survive translation: the
2816/// message is generated on the INVITER's side and travels to the redeemer, so the embedder that
2817/// DISPLAYS it cannot rewrite it into its own vocabulary except by substring-matching our copy.
2818/// Branch on this and write your own sentence naming your own rename affordance.
2819///
2820/// Deliberately narrow. It rides ONLY this refusal, which is sent exclusively to a caller that
2821/// proved possession of a live invite secret. The generic refusal keeps `-32000` and its opaque
2822/// reason: distinguishing unknown-vs-expired-vs-wrong-secret would be a redemption oracle.
2823pub const ERR_NICKNAME_TAKEN: i64 = -32043;
2824
2825/// The invite line's own `expires_at_epoch` has passed (#159). Decided LOCALLY, before dialing —
2826/// this says nothing about the inviter's state. Remedy: ask for a fresh invite.
2827pub const ERR_INVITE_EXPIRED: i64 = -32044;
2828
2829/// The inviter has **no outstanding invite at all** — its accept gate fast-closed the dial (#159).
2830///
2831/// This is as close to "expired or already used" as we can safely get, and the distinction matters:
2832/// it is a fact about the INVITER, not about the secret presented. Answering per-secret would be a
2833/// redemption oracle — a prober would learn which guessed secrets were ever real — which is why
2834/// [`ERR_INVITE_REFUSED`] stays deliberately undifferentiated. Remedy: ask for a fresh invite.
2835pub const ERR_INVITE_NOT_LIVE: i64 = -32045;
2836
2837/// The inviter's address could not be dialed at all (#159) — offline, asleep, or unroutable.
2838/// Remedy: check they are running, then retry the same invite; it is untouched.
2839pub const ERR_INVITER_UNREACHABLE: i64 = -32046;
2840
2841/// **The address-swap defense fired**: the TLS-authenticated peer is not the endpoint the invite
2842/// names (#159).
2843///
2844/// The one refusal here that must NOT be rendered as "try again". Something answered in place of
2845/// the machine the invite identifies — a substituted address, or a forged invite. An embedder that
2846/// treats every pairing failure as a friendly retry papers over exactly the attack this check
2847/// exists to catch. Remedy: do not retry; get the invite again through a channel you trust.
2848pub const ERR_INVITER_MISMATCH: i64 = -32047;
2849
2850/// The invite asks to be called a name this node already uses for a DIFFERENT peer (#159).
2851///
2852/// The redeemer-side mirror of [`ERR_NICKNAME_TAKEN`], and a distinct condition: that one is the
2853/// inviter refusing the redeemer's name, this is the redeemer refusing the inviter's suggestion.
2854/// Nothing is granted either way — a name confers no access (#38) — so this protects this node's
2855/// own display and routing clarity. Remedy: ask for an invite suggesting a different name.
2856pub const ERR_INVITE_NAME_CONFLICT: i64 = -32048;
2857
2858/// The inviter refused, and the cause is **deliberately withheld** (#159).
2859///
2860/// Unknown secret, expired secret, and wrong secret are one answer on purpose: telling them apart
2861/// is a redemption oracle. The code carries exactly as much as the prose already did — "that invite
2862/// did not work" — so a consumer can branch without parsing, and without learning anything a
2863/// prober could use. Remedy: ask for a fresh invite.
2864pub const ERR_INVITE_REFUSED: i64 = -32049;
2865
2866/// The request was stopped on purpose before it finished (#172) — today, a `blob_fetch` that
2867/// [`Request::BlobFetchCancel`] tripped.
2868///
2869/// A cancelled request still ANSWERS. Cancellation is cooperative rather than a task abort
2870/// precisely so this code can be delivered: an aborted task returns nothing, and the caller waits
2871/// forever on work that already stopped. Distinct from `-32000` because it is not a failure — the
2872/// caller (or its user) asked for it. Remedy: none; retry the fetch if the cancel was a mistake.
2873///
2874/// **What it does not promise:** partial chunks already streamed into the blob store stay there,
2875/// unlisted and unreclaimable, exactly as they do when a fetch fails. That is #80's reclaim gap,
2876/// unchanged by cancellation.
2877pub const ERR_CANCELLED: i64 = -32050;
2878
2879/// This control connection already has [`MAX_INFLIGHT`] requests running, so this one was refused
2880/// without being started (#172).
2881///
2882/// **Retryable, and cheap to retry** — retry after any response lands, or spread the load over a
2883/// second control connection. It is refused rather than queued deliberately: a queue is invisible
2884/// backpressure that a caller cannot tell apart from a slow daemon, and waiting for a permit inside
2885/// the read loop would reintroduce the head-of-line blocking concurrent dispatch exists to remove.
2886///
2887/// Not a security boundary — the control socket is the daemon owner's. It bounds the work one
2888/// connection can have outstanding so a buggy client cannot spawn unboundedly.
2889pub const ERR_TOO_MANY_INFLIGHT: i64 = -32051;
2890
2891/// The invite line is a SELF-ENROLLMENT (`mcpmesh-enroll:`) and the caller did not offer that
2892/// ceremony — [`PairParams::allow_self_enroll`] was unset (#178).
2893///
2894/// Decided from the line in hand, BEFORE any dial: nothing was contacted, no secret was revealed,
2895/// and the invite is untouched. Like [`ERR_INVITE_EXPIRED`] it therefore reveals nothing about the
2896/// inviter and is safe to name precisely.
2897///
2898/// Distinct from [`ERR_INVITE_REFUSED`] in the direction it points: that one is the inviter turning
2899/// US down, this one is US declining a ceremony we were never asked to run. Remedy: if the person
2900/// meant to add another of their OWN devices, offer that explicitly and retry the SAME line with
2901/// `allow_self_enroll`; otherwise they pasted the wrong link and want an ordinary
2902/// `mcpmesh-invite:` one.
2903pub const ERR_SELF_ENROLL_NOT_OFFERED: i64 = -32052;
2904
2905/// `service_allow_grant` — the principal is REVOKED on this node, so the grant was refused before
2906/// anything was written (#212, `api_minor >= 60`). Also `peer_introduce` (#218, `api_minor >= 61`)
2907/// when the SUBJECT proves a `user_id` this node has revoked: the row would be refused on sight.
2908///
2909/// Admission runs two gates: the revocation table first (`peer_revoke`), then the service's
2910/// `allow`. A grant to a revoked principal used to succeed and write a real `allow` entry that the
2911/// first gate would never let a session reach — the caller was told "granted" and `status`
2912/// confirmed it, while every session from that peer was refused. Now the write path consults the
2913/// same table admission does, and answers this instead of `{}`.
2914///
2915/// "Revoked" here means what admission means by it, read live: an `eid:` that `peer_revoke` marked
2916/// dead (locally or by a signed import, or by the installed roster), or a `b64u:` identity that
2917/// `peer_revoke` revoked — every row carrying that `user_id` is refused, whatever the endpoint
2918/// table says about the device (#218). Remedy: `peer_unrevoke` first if the revocation was a
2919/// mistake; otherwise there is nothing to grant.
2920///
2921/// **Numbering:** `-32053`..`-32055` are skipped. They are the SESSION-plane codes
2922/// (`mcpmesh_net::errors`: rate-limited / service refused / unreachable), and `-32053` in particular
2923/// is named by number throughout this file and the docs with its rate-limit meaning. Control codes
2924/// `-32051` and `-32052` already collide with session codes, which is survivable because the two
2925/// planes never share a frame — but a control `-32053` would make "guard on `-32053`" ambiguous on
2926/// the page that documents both. The control family continues from `-32056`.
2927pub const ERR_PRINCIPAL_REVOKED: i64 = -32056;
2928
2929/// `pair` — the INVITER refused because it has revoked YOUR identity (`peer_revoke b64u:` on its
2930/// side) (#218, `api_minor >= 61`).
2931///
2932/// The inviter-side twin of [`ERR_PRINCIPAL_REVOKED`], and a different code because it names a
2933/// different node's table: that one is "this node revoked X, run `peer_unrevoke` here"; this one is
2934/// "the peer revoked me, and nothing on this side lifts it". Before #218 the inviter made no such
2935/// check — the row was written with the revoked `user_id`, the caller was told "paired", and every
2936/// session it opened was refused.
2937///
2938/// The one `pair` refusal besides [`ERR_INVITER_MISMATCH`] that must NOT be rendered as "ask for a
2939/// fresh invite": the invite was consumed, and any invite redeemed by a device presenting that
2940/// identity is refused the same way until the inviter lifts the revocation. What it does NOT do:
2941/// identity revocation refuses a device presenting the identity, and cannot stop a person who stops
2942/// presenting the key — redeeming with no binding (or under a new user key) lands as an ordinary
2943/// `eid:` pairing of an endpoint the inviter never revoked. Coded rather than folded into [`ERR_INVITE_REFUSED`] for the reason #147
2944/// codes anything: a caller that has PROVEN a live secret may be told the truth (the redemption
2945/// oracle that keeps `-32049` opaque is about unproven secrets), and the remedy differs from every
2946/// other refusal's — it is on the other side of the wire.
2947pub const ERR_PAIR_IDENTITY_REVOKED: i64 = -32057;
2948
2949/// How many requests one control connection may have in flight at once (#172), after which it
2950/// answers [`ERR_TOO_MANY_INFLIGHT`]. Per connection, not per daemon.
2951pub const MAX_INFLIGHT: usize = 32;
2952
2953pub const API_NAME: &str = "mcpmesh-local/1";
2954/// The protocol-compatibility version as `"MAJOR.MINOR"`, distinct from the crate/stack version.
2955///
2956/// - **MAJOR** matches the `/N` in [`API_NAME`] and changes only on a breaking wire change (the
2957///   transport already rejects a mismatched `api`, so an equality check on that is redundant).
2958/// - **MINOR** ([`API_MINOR`]) increments on a surface change within a major — additive fields, new
2959///   methods, or a strictness change like params validation — bumped in the same change that makes
2960///   it. A client can guard with `api_minor >= N` for a feature it needs, or refuse a daemon older
2961///   than a minor it requires. It never resets except on a MAJOR bump.
2962///
2963///   It also bumps for a change to what a field MEANS with no change to its shape — six of the
2964///   thirty have, see [`API_MINOR`]'s history. "Every surface change" is what this line used
2965///   to claim, and it was wrong in both directions: minor 9's entry records surface changes that
2966///   shipped WITHOUT a bump, and six bumps changed no type at all. Read the history, not the rule.
2967pub const API_VERSION: &str = "1.61";
2968/// The integer MINOR of [`API_VERSION`] — see there. Bumped from 0 to 1 when params validation
2969/// became strict (#34); to 2 with the `set_nickname` verb + `StatusResult.self_nickname` (#37);
2970/// to 3 when `allow`/grant strings became STABLE principals — `b64u:`/`eid:`/roster names,
2971/// never nicknames (#38); to 4 with the `set_app_metadata` verb + `PresencePeer.meta` (#39);
2972/// to 5 with `PeerReachability.meta` — pairing-mode app metadata on the probe pong (#40);
2973/// to 6 with `PeerInfo.principal` — the peer's eid: device principal on `status` (#41);
2974/// to 7 with `PeerReachability.principal` — the same on reachability rows (#42); to 8 with the
2975/// `service_allow_grant`/`service_allow_revoke` per-peer access verbs (#44); to 9 covering the
2976/// `unregister_service` (#50) / `peer_services` (#52) / Run `env`+`cwd` (#51) surface that shipped
2977/// in 0.10.1 without a bump, PLUS the `set_relays` live relay-set verb (#53); to 10 when
2978/// `service_allow_revoke`/`peer_remove` became IMMEDIATE — no verb shape changed, but their
2979/// observable contract did: a revoked principal's next session is refused even on a connection it
2980/// already holds, and its live connections are severed. Previously both waited for the peer to
2981/// disconnect on its own, which is unbounded (#54). A consumer can guard on
2982/// `api_minor >= 10` before telling a user that revocation has taken effect; to 11 when
2983/// `service_allow_grant`/`service_allow_revoke` gained EPHEMERAL-service support and became strict
2984/// about an unknown service name — a name in neither the config nor the ephemeral registry now
2985/// answers [`ERR_NO_SUCH_SERVICE`] instead of a silent `{}` (#55, #69); to 12 with the pushed
2986/// [`StreamFrame::Reachability`] liveness transition frame (#58); to 13 with
2987/// [`PeerReachability::path`] — direct-vs-relay attribution on every reachability row (#64); to 14
2988/// with the `run`-backend `MCPMESH_PEER_EID` identity var — the caller's stable device principal,
2989/// unconditionally present, so a `run` server can scope per caller without keying on a nickname
2990/// (#60); to 15 with the `blob_revoke` / `blob_unpublish` verbs — per-scope withdrawal of a grant
2991/// and of a published hash, so un-sharing a file no longer requires unpairing the person (#62); to
2992/// 16 when the app-blob provider became available in PAIRING mode — the blob verbs previously
2993/// errored on any daemon without an org root key, though their scope gate never needed one (#61);
2994/// to 17 when the service answer began coming from the LIVE registry rather than config + overlay,
2995/// so a grant the accept path would refuse is no longer advertised. Three surfaces share that
2996/// resolver and all changed together: `status`'s `services[].allow`, `peer_services`' name list,
2997/// and the `mcpmesh/ping/1` probe's `services`. No wire shape changed, only the source of truth —
2998/// exactly the class of change a downstream cannot see in a type diff (#100); to 18 with `blob_republish`, so a fetched blob can
2999/// be re-served and every recipient becomes a source (#83); to 19 with durable blob revocation — an
3000/// unpublish now survives a later republish via a per-scope withdrawal set, and
3001/// [`ERR_BLOB_WITHDRAWN`] distinguishes "deliberately withdrawn" from "never had it" (#107); to 20
3002/// with `blob_list` filters + paging AND a DEFAULT limit of 256 scopes (the clamp is 4096) — a
3003/// daemon with more scopes than that previously answered with
3004/// everything, and past the 16 MiB frame cap the CLIENT rejected the response as malformed, leaving
3005/// the caller an opaque failure with no way to page. The connection survived: the control surface
3006/// carries no strike bound. This is a behaviour change for existing callers, detectable via the new
3007/// `total`/`truncated` (#84b); to 21 when a
3008/// PATH change became a reachability transition — [`StreamFrame::Reachability`] stopped being an
3009/// up/down toggle and same-verdict frames became possible (#92); to 22 with a SECOND producer for
3010/// that frame: a live per-session watcher that pushes when a session's selected path changes,
3011/// rather than waiting for a probe, at a cadence probes never had (#92); to 23 when
3012/// [`PeerReachability::rtt_ms`] stopped including the path-settle window — a relayed peer could
3013/// previously never report under 600ms, so "relayed AND fast" was unreachable by construction
3014/// (#123); to 24 when `reachable` stopped sharing a deadline with path classification — a relayed
3015/// peer whose pong arrived after ~2.4s was reported OFFLINE while it was answering (#128); to 25
3016/// with [`ActiveSession::principal`] — the live-session view was keyed on a display nickname, so
3017/// two devices under one nickname were indistinguishable and any UI acting on a session (revoke,
3018/// disconnect, inspect) keyed on a collidable string (#73); to 26 when a
3019/// rate-limited inbound NOTIFICATION stopped being silently dropped and became a recorded audit
3020/// event — no type changed; the observable audit stream did (#76, #139); to 27 with the `audit_prune` /
3021/// `audit_list` verbs, `StatusResult::storage`, and the opt-in `[limits].audit_retain_months`
3022/// boot retention — the audit log stopped being a permanent, unbounded, unreadable record (#88);
3023/// to 28 with `StatusResult::self_network` / `StreamFrame::SelfNetwork` / the snapshot's copy —
3024/// the node's OWN reachability posture, previously unanswerable from either side of the API
3025/// (#90); to 29 with [`AuditRecord::principal`] — stable identity on the event stream and the
3026/// on-disk log, resolving #57's parked docs conflict in favour of the #41/#42/#73 line (the
3027/// audit surface bans secrets and raw hex, not the prefixed principal rendering); to 30 with
3028/// [`StreamFrame::Reachability`]'s `source` — the frame has had TWO producers since 22 with no way
3029/// to tell them apart, so an embedder could not distinguish "a throwaway dial went via a relay"
3030/// from "the link this call is on just degraded", and had to hedge every message down to the
3031/// weaker claim. `rtt_ms: None` was never the discriminator the doc implied (#150); to 31 with
3032/// [`ERR_NICKNAME_TAKEN`] — the nickname-collision `pair` refusal is branchable instead of
3033/// `-32000`, so an embedder writes its own recovery copy rather than substring-matching ours. The
3034/// prose changed with it: it named the `set_nickname` CONTROL VERB as the remedy, which a GUI user
3035/// cannot type, and the refusal is generated inviter-side so the embedder displaying it could not
3036/// rewrite it (#147); to 32 with [`SelfNetwork::identity_conflict_epoch`] — two nodes booted from
3037/// COPIES of one mesh root share an endpoint id, and the displaced one's peers went unreachable
3038/// with nothing saying why. The relay reports it and iroh only `warn!`s it, so the fact existed
3039/// and was unreadable (#134); to 33 with the `peer_diagnostics` verb — a long-lived pairing that
3040/// cannot hole-punch while a fresh identity on the same hardware can differs only in DURABLE
3041/// per-peer state, and none of it was readable from outside the daemon (#140); to 34 when
3042/// outstanding invites became DURABLE — `invite.expires_at_epoch` changed meaning from an upper
3043/// bound on the daemon's process lifetime to the real lifetime, and `invite` gained an error where
3044/// it previously always succeeded. No shape changed, which is exactly the class minor 10 records:
3045/// guard on `api_minor >= 34` before telling a user their invite will still be good tomorrow
3046/// (#87b); to 35 with `InviteParams.max_uses` + `InviteResult.uses_remaining` — a bounded
3047/// multi-use invite, so onboarding a team is one link rather than one ceremony per person. Each
3048/// redemption still runs its own SAS and writes its own peer rows; it is N pairings sharing a
3049/// secret, never a group identity (#87); to 36 with branchable codes for the rest of the ONBOARDING
3050/// refusals — expired line, no live invite, inviter unreachable, id mismatch, name conflict, and
3051/// the deliberately-opaque refusal. `ERR_NICKNAME_TAKEN` had been the only coded pairing failure,
3052/// so every other one arrived as `-32000` and an embedder could either forward our prose to end
3053/// users or substring-match it (#159); to 61 when an IDENTITY revocation (`peer_revoke b64u:`)
3054/// began to hold at every site (#218): `pair` answers [`ERR_PAIR_IDENTITY_REVOKED`] when the
3055/// inviter has revoked the redeemer's proven `user_id`, `peer_introduce` answers
3056/// [`ERR_PRINCIPAL_REVOKED`] for a subject proving one this node revoked, and admission refuses
3057/// any stored row carrying a revoked `user_id` — as does every OUTBOUND dial: `open_session`,
3058/// `peer_services` and `peer_diagnostics` answer the same "REVOKED" refusal an endpoint-revoked
3059/// device gets, and `pair` REDEEMING an invite from an inviter this node revoked (its endpoint, the
3060/// identity its row carries, or the identity it proves in its reply) answers
3061/// [`ERR_PRINCIPAL_REVOKED`] before writing a row or running the grant-back. Below 61 only device attestation consulted the
3062/// identity table: a fresh invite (or an introduction) landed a row for the person's next device,
3063/// the caller was told "paired", and the row's `services[].allow` grant was honoured — which is
3064/// also why minor 60's "a `b64u:` hides only while EVERY device is refused" no longer holds: a
3065/// per-device `peer_unrevoke` under a standing identity revocation re-admits nothing, and the
3066/// entry stays hidden until the identity itself is unrevoked. Guard on `>= 61` before branching
3067/// on the new code; to 60 when `services[].allow` on `status` became
3068/// REVOCATION-AWARE and `service_allow_grant` began refusing a revoked principal with
3069/// [`ERR_PRINCIPAL_REVOKED`] (#212). No shape changed — minor 17's class again. #100 made
3070/// `services[].allow` answer from the live registry so it could not report a grant the accept path
3071/// refuses, and that claim was one gate short: `peer_revoke` writes only the revocation table, the
3072/// registry's `allow` kept the entry, and `status` copied it out unfiltered. An entry whose
3073/// principal is revoked — as admission defines it — is now omitted from `allow` (and, index-aligned,
3074/// from `allow_display`); for a `peer_revoke` revocation `status.revoked` still lists the principal,
3075/// so the fact is not lost, only moved to the surface that means it (a ROSTER-revoked device is
3076/// omitted too, and its record is the roster's own `revoked_endpoints` — it is absent from
3077/// `roster_members` as well). The write path closed with it: the grant used to succeed and
3078/// write an entry admission would never honour. Guard on `>= 60` before treating an `allow` entry's
3079/// absence as "not granted" rather than "granted but refused", and before branching on the new
3080/// code; below it, join `status.revoked` against `allow` yourself; to 59 with [`Request::PeerHintClear`] — FORGET one peer's
3081/// persisted dial hint (#140). An experiment tool and a workaround, not a policy change: nothing
3082/// clears a hint automatically. `PeerEntry.last_addr` is the only durable per-peer state on a node's
3083/// disk that the dial path reads and the only thing a long-lived pairing carries that a freshly
3084/// paired identity does not, so clearing it makes the pairing ADDRESSING-EQUIVALENT to a fresh one —
3085/// which is exactly the difference #140 is about. Advisory, never authorization: the row, its
3086/// `user_id`, its services and its pairing stamp are untouched, and an absent hint is a supported
3087/// state. Guard on `>= 59`; to 58 with the REVERSE-DNS `_meta` key spellings
3088/// `tech.counterpunch.mcpmesh/{service,peer}` alongside the legacy `mcpmesh/{service,peer}` (#49,
3089/// SEP-1788's SHOULD). No shape changed, and **no peer or backend has to change what it READS**:
3090/// both spellings are WRITTEN with identical values and EITHER is accepted, which is why this did
3091/// not need the coordinated wire change #49 assumed. A backend reading `mcpmesh/peer` keeps working.
3092///
3093/// **It is not a no-op for every backend, though.** A handler that rejects unknown `_meta` keys —
3094/// `deny_unknown_fields`, `additionalProperties: false` — now sees a second one and will refuse
3095/// requests it accepted at 57, the same class of break that made 0.50.0 a MINOR. Both prefixes are stripped from caller frames, because a
3096/// prefix mcpmesh writes but does not strip is one a caller can forge. A caller sending the two
3097/// service spellings with DIFFERENT values is REFUSED rather than reconciled. The reserved-key
3098/// enumeration in the 2026-07-28 grammar is `progressToken`, `io.modelcontextprotocol/*`, and bare
3099/// `traceparent`/`tracestate`/`baggage`; a prefixed key is reserved only by its SECOND label, so
3100/// neither of our spellings ever collided. **The legacy
3101/// `mcpmesh/*` spellings are deprecated as of 0.51.0 and will be removed at 1.0** — migrate reads to
3102/// the reverse-DNS form. Guard on `>= 58` only if you need the new spelling to be present; to 57
3103/// when `_meta["mcpmesh/peer"]` began being injected on
3104/// EVERY proxied request rather than only the handshake (#45 ask 2). **No shape changed** — this is
3105/// the same class as 37, on the same field: what changed is WHEN a backend can rely on the value
3106/// being there. Before 57 a served backend learned its caller on the session's first frame and on
3107/// any later `initialize`, and saw nothing on frames 2..N; from 57 every request carrying a `method`
3108/// is attributed. A backend that authorizes per-request rather than binding at session start must
3109/// guard on `>= 57`, exactly as 37's note says to guard before trusting the value at all. Positional
3110/// (array) params are the one exception and are deliberately left un-attributed — see
3111/// `docs/local-protocol.md`. Guard on `>= 57`; to 56 with [`PeerDiagnosticsResult::known_addrs`] and its two
3112/// set-difference companions — IROH's own view of a peer's addresses alongside the hint we stored
3113/// (#140). The verb dumped this node's disk and nothing about what iroh made of it, which is the
3114/// half the standing hypothesis lives in: iroh skips address lookup while a path is selected, so a
3115/// pair holding a relayed connection never re-discovers and the stale hint is the only addressing
3116/// the dial contributes. Read-only (a point read of the remote map), so it stays safe to run on a
3117/// live reproduction — though it does reset iroh's ~60s per-remote idle timer, so polling it keeps
3118/// state alive that would otherwise be reaped. `known_addrs` ABSENT means iroh holds no entry right
3119/// now, which is neither an empty list nor "never heard of": iroh reaps a remote ~60s after its last
3120/// connection closes. Guard on `>= 56`; to 55 with [`StreamFrame::Resumed`] — a SUSPEND/RESUME
3121/// signal on `subscribe` (#167 ask 2). A suspended machine sends nothing, so the peer's idle timer
3122/// tears the connection down before the lid reopens and `keep_alive_secs` cannot help; the frame is
3123/// what lets an embedder re-dial deliberately instead of discovering it on the next send. Detected
3124/// as wall-clock/monotonic skew, so a starved runtime (both clocks run long) does NOT emit. It names
3125/// no session — the daemon cannot know which survived. Guard on `>= 55`; to 54 with
3126/// [`OpenSessionParams::idle_timeout_secs`] — a
3127/// PER-CONNECTION QUIC idle timeout on the dial path (#166). The node-wide `[network]` knob made a
3128/// chat session, a bulk blob transfer and a media flow share one compromise. Only LOWERING is
3129/// unilateral (QUIC negotiates the minimum of both peers), which is also why the absence of an
3130/// accept-side twin is a missing symmetry rather than a missing half: the direction that can work
3131/// one-sidedly is available, and the direction that cannot never worked anywhere. Ignored on a
3132/// RACING dial, which abandons connections (logged at `warn!`, since a caller cannot know how many
3133/// devices a peer has). No per-connection keepalive — iroh caps the per-path
3134/// interval at 5s, so one could only make pings more frequent. Guard on `>= 54`; to 53 with `org_rotate` and the roster's
3135/// `successor_root_pk`/`successor_sig` — ORG ROOT ROTATION (#93 ask c). The schema pinned exactly
3136/// one signature slot against one key, so an operator laptop that died took the org with it 90 days
3137/// later when the roster expired, and the delay is what made it undiagnosable; recovery was O(N)
3138/// fresh ceremonies with every member. A roster now carries a successor root cross-signed by its
3139/// predecessor, and the bridge rides EVERY subsequent roster — so a member offline for the
3140/// announcing publication still catches up, which the obvious one-shot design does not give you. A
3141/// successor is adopted only when the pinned key no longer signs directly, only on a statement that
3142/// key signed, and never resets rollback protection. **A rotated roster declares
3143/// `mcpmesh-roster/2`**, so EVERY member must be on 0.47.0+ before an org rotates — an older binary
3144/// refuses the closed-schema document and stops receiving membership changes entirely; an org that
3145/// never rotates keeps producing `/1` byte-identically. NOT escrow: a LOST root cannot sign a bridge —
3146/// copy `org-root.key` to a second operator machine for that. Guard on `>= 53`; to 52 with `attest_offer` and the DEVICE ATTESTATION
3147/// ceremony (#85 ask 3) — a peer that already holds your `b64u:` admits a replacement device on the
3148/// strength of a user-key binding, with no fresh SAS ceremony with everyone you ever paired with.
3149/// `PeerEntry.user_id` was written once at pairing and never refreshed, so a machine restored from
3150/// a recovery phrase (ask 2) was still a complete stranger. **OFF by default**
3151/// (`[identity].admit_attested_devices`): it changes what a pairing MEANS, from admitting a device
3152/// to admitting a person and their future devices, and that should be chosen rather than inherited
3153/// on upgrade. An attestation cannot admit a stranger — the receiver must already hold a row for
3154/// that `user_id` — cannot resurrect a REVOKED endpoint OR a revoked IDENTITY (ask 4, which is why
3155/// it shipped first; `peer_revoke` on a `b64u:` now revokes the person, because a thief holding the
3156/// disk holds the user key and can mint a fresh endpoint id at will), and
3157/// grants the INTERSECTION of that person's existing services, never the union. Guard on `>= 52`;
3158/// to 51 with the PAIRING-MODE REVOCATION verbs —
3159/// `peer_revoke` / `peer_unrevoke` / `device_revoke` / `device_revocation_import`, plus
3160/// [`StatusResult::revoked`] (#85 ask 4). `revoked_endpoints` was roster-only, so in pairing mode
3161/// the only remedy for a stolen device was every peer independently running `peer_remove`, with
3162/// nothing telling them they should — until the last one did, whoever held the disk authenticated
3163/// as its owner and every message they sent was cryptographically indistinguishable. Two
3164/// directions, deliberately not one verb: `peer_revoke` is MY local decision about YOUR device;
3165/// `device_revoke` signs a portable statement about MY OWN, which is the half my peers cannot
3166/// discover for themselves. An import is honoured only from a `user_id` this node already pairs
3167/// with, and only for that person's OWN devices — a signature proves who asked, not that the
3168/// endpoint was ever theirs. Revocation is IMMEDIATE (live sessions severed, #54) and outlives the
3169/// pair row, so it cannot be undone by re-pairing. Guard on `>= 51`; to 50 with [`SelfNetwork::local_discovery`] — LOCAL (mDNS)
3170/// peer discovery, off unless `[network].local_discovery` asks for it (#68). Peer resolution
3171/// otherwise needs external infrastructure, so two machines on one LAN with no uplink could not
3172/// find each other though the path between them was fine. Three modes: `"off"` (default), `"on"`
3173/// (resolve AND announce), `"resolve"` (resolve without publishing this node's identity — it still
3174/// QUERIES about once a second, so it is quieter, not silent). Reported on `status` because the
3175/// setting was
3176/// otherwise unobservable and because **`"on"` means this node multicasts its endpoint id and
3177/// addresses to every device on the link** — a product backing a privacy switch has to be able to
3178/// show that. Deliberately NOT on by default, against what #68 asked for: pkarr publishes a signed
3179/// record you must already know the endpoint id to look up, while mDNS announces to strangers on a
3180/// café or hotel network, and a multicast packet cannot be un-sent. Guard on `>= 50`; to 49 with [`StorageInfo::blobs_gc`] — app-blob GARBAGE
3181/// COLLECTION, off unless `[blobs].gc_interval` is set (#80). `blob_unpublish` and `blob_revoke`
3182/// closed the AUTHORIZATION half at 15; neither reclaimed a byte, so `<data_dir>/blobs/` grew
3183/// monotonically for the life of the node and an embedder that had told a user "this file is
3184/// deleted" could not deliver that. Opt-in, because a sweep also reclaims blobs this node FETCHED
3185/// and never republished — reclaimable in themselves (the fetch already wrote the caller's
3186/// `dest_path`) but it means `blob_republish` of a hash fetched more than one interval ago fails.
3187/// `blobs_gc` is `None` when collection is not configured, `Some` with `runs: 0` when it is
3188/// configured and has not swept yet — a distinction worth reading, because the collector sleeps a
3189/// full interval before its first run. WATCH `runs`: iroh-blobs ends collection for the process on
3190/// its first sweep error, so a counter that stops advancing is the only signal. Guard on `>= 49`;
3191/// to 48 with `user_key_export` / `user_key_import` — a
3192/// RECOVERY PHRASE for the user key, so a person's `b64u:` survives the hardware (#85 ask 2). It
3193/// lived in one file on one machine with no export, import or escrow verb anywhere, so replacing a
3194/// laptop destroyed the identity peers pin, kb audiences key on, and a roster names — recovery was
3195/// an in-person SAS ceremony with everyone you had ever paired with. **The export response carries
3196/// a PRIVATE KEY**: it is deliberately absent from the audit log, from `status`, and from every
3197/// other surface. Import refuses to overwrite an existing key unless asked, because doing so
3198/// discards a live identity irreversibly. What it does NOT do: get a device admitted. Peers
3199/// authorize per DEVICE, and a restored user key puts this endpoint in nobody's allowlist — that is
3200/// #85 ask 3, unshipped, and the reason a recovered person still pairs. Guard on `>= 48`; to 47 with `BlobFetchParams::from` — ADDITIONAL sources a
3201/// fetch falls back to when the ticket's publisher does not answer (#83). Content addressing makes
3202/// every recipient a potential source, and a one-address ticket made that unusable: a file shared
3203/// with a room became unfetchable the moment the sender closed their laptop, though others in the
3204/// room already held the identical verified bytes. Additive and absent-tolerant — an older caller's
3205/// payload reads as empty, which is the single-source behaviour — so guard on `>= 47` only before
3206/// SENDING the field (`deny_unknown_fields` rejects the whole request below it). The bytes stay
3207/// BLAKE3-verified against the ticket's hash whoever serves them, so an alternate can refuse but
3208/// never substitute; it must have republished the hash into a scope granting the caller
3209/// (`blob_republish`, `api_minor >= 18`). What did NOT land: multi-source PARALLEL fetch — sources
3210/// are tried in order, so an offline publisher costs one dial timeout; to 46 with the roster-mode embedding surface (#66, #93):
3211/// the `org_create` / `org_approve` / `org_revoke` AUTHORING verbs, the `roster_members` read,
3212/// `PresencePeer::display_name` + `groups`, `RosterStatus::groups`, and
3213/// `OrgJoinResult::restart_required`. Two gaps close together. Authoring existed only as CLI
3214/// porcelain, so an embedded node could CONSUME a roster and never author one — no "approve this
3215/// person" button without shelling out to a second binary. And the roster's own contents never
3216/// crossed the seam: an embedder had managed group membership it could not display, and the only
3217/// route to a member list was hand-parsing the daemon-owned `roster.json`. `roster_members` is a
3218/// different question from `status.presence` — that lists reachable DEVICES and omits a person
3219/// whose devices are all down. `restart_required` closes a silent partial success: `roster_mode` is
3220/// a BOOT decision fixing the bound ALPNs and whether gossip/presence/blobs exist at all, so a
3221/// pairing-mode node that ran `org_join` got working MCP sessions with permanently empty presence
3222/// and no way to detect it. Guard on `>= 46` before offering org authoring in a UI; the read fields
3223/// are additive and degrade to empty. What did NOT land: org root ROTATION (#93c) — an operator
3224/// laptop that dies still takes the org with it once the roster expires; to 45 with [`PairParams::allow_self_enroll`] +
3225/// [`ERR_SELF_ENROLL_NOT_OFFERED`] — `pair` now REFUSES a `mcpmesh-enroll:` line unless the caller
3226/// asked for that ceremony. A behaviour change for existing callers, deliberately: at 43-44 a caller
3227/// whose UI only ever offered "add a contact" completed a self-enrollment and learned which
3228/// ceremony it had run from `enrolled_as_self` afterwards — by which point the device→user binding
3229/// was written and irrevocable short of rotating the user key (#178). The refusal is decided from
3230/// the line before any dial, so the invite survives it and the same line works once the ceremony is
3231/// actually offered. Guard on `>= 45` before sending the field — below it `deny_unknown_fields`
3232/// rejects the whole request. Note what the guard means: a daemon BELOW 45 gives a caller no way to
3233/// decline, so a UI that does not offer device enrollment should require `>= 45` rather than pair
3234/// without it; to 44 when control responses stopped arriving in REQUEST
3235/// order and the `blob_fetch_cancel` verb landed (#172). The daemon now dispatches each request
3236/// CONCURRENTLY on its connection, so a `blob_fetch` no longer stalls every other verb behind it —
3237/// and responses arrive in COMPLETION order. JSON-RPC ids make that legal and the in-tree
3238/// `ControlClient` cannot observe it (one request at a time, by construction), but a hand-rolled
3239/// client that pipelines and matches responses POSITIONALLY breaks. A connection also caps
3240/// in-flight requests and refuses over it with [`ERR_TOO_MANY_INFLIGHT`], and closing a control
3241/// connection now genuinely ABORTS its in-flight work rather than letting it run to completion
3242/// unread. Guard on `>= 44` before pipelining, before sending `blob_fetch_cancel`, and before
3243/// treating [`ERR_CANCELLED`] as unexpected; to 43 with `InviteParams::as_self` — SELF-ENROLLMENT, so one
3244/// person's devices share a `user_id` instead of appearing as unrelated strangers (#86). The
3245/// ceremony is ordinary pairing; the outcome is a device→user binding rather than a peer row, and
3246/// the private key never moves. Guard on `>= 43`. What this entry did NOT say, and 45 fixed: the
3247/// distinct scheme closes the version-SKEW hazard (a pre-43 redeemer silently over-granting) and
3248/// closes nothing for a CURRENT redeemer, which had no way to decline a ceremony it never offered
3249/// (#178); to 42 with the `peer_introduce` + `peer_endorse`
3250/// verbs — install a peer from a
3251/// SIGNED endorsement by someone you are already paired with, so a small group onboards in O(N)
3252/// instead of O(N²) two-human ceremonies (#65). It installs IDENTITY only and grants nothing, which
3253/// is what bounds it. Guard on `>= 42`; to 41 with `StreamFrame::BlobTransfer` — live app-blob
3254/// transfer progress on both the serving and fetching side (#82 ask 2), so an embedder can draw a
3255/// real progress bar instead of an indeterminate spinner. Guard on `>= 41` before expecting the
3256/// frame. NOTE what it did NOT bring, and 44 did: at 41 `blob_fetch` still blocked its whole
3257/// control connection for the transfer and nothing could cancel it (#172) — progress arrived on the
3258/// SUBSCRIBE connection, which is a different one; to 40 with `[services.<name>].rate_limit_per_min` +
3259/// `RegisterServiceParams::rate_limit_per_min` — proxied-request buckets became per
3260/// `(service, endpoint)` instead of one shared per-endpoint bucket, so a noisy service can no
3261/// longer starve a quiet one (#63). `-32053` changes meaning with it: it is now per-service, so a
3262/// consumer that backs off globally on one is backing off further than it needs to. Guard on
3263/// `>= 40` before sending the field or narrowing a back-off; to 39 with `PairParams::as_nickname` +
3264/// `InviteParams::peer_nickname` — LOCAL aliases for the other party, so a nickname collision is
3265/// resolvable by the person who hit it instead of requiring the other human to rename a machine or
3266/// re-mint. #147 made the collision diagnosable; this makes it fixable. Guard on `>= 39` before
3267/// offering an alias field in a UI: below it `deny_unknown_fields` rejects the whole request
3268/// (#87); to 38 with `[network].presence_mode` + `SelfNetwork.
3269/// presence_mode` — `reachable: false` gained a new meaning ("up, paired, and deliberately not
3270/// answering"), and `peer_services` flips from "reachable, empty list" to "unreachable" for a
3271/// caller holding no grant. A consumer must guard on `api_minor >= 38` before telling a user their
3272/// peer is offline, since below it that verdict could not mean this (#89); to 37 when the reserved
3273/// `mcpmesh/*` `_meta` namespace began
3274/// being enforced on EVERY proxied frame rather than the session's first. `run_session` treats
3275/// frame 1 as the `initialize` whatever its method is, so a caller could send any other method
3276/// first and put its real `initialize` — with a forged `mcpmesh/peer` naming another principal,
3277/// forged `groups` and all — in frame 2, where nothing stripped or injected. No shape changed;
3278/// what changed is whether `_meta["mcpmesh/peer"]` can be trusted, which is the entire reason a
3279/// backend reads it. Guard on `api_minor >= 37` before keying authorization on that value (#164).
3280///
3281/// **Not every semantic change gets a minor, and that is the gap to watch (#122).** A minor marks a
3282/// change to this *surface*. A change to behaviour BEHIND the surface — same fields, same shapes,
3283/// different meaning — may not bump it, and is invisible to a type diff. 17 and 24 above happen to
3284/// be that class and did bump; do not infer from them that every such change will. When bumping
3285/// several minors at once, read this block end to end AND the release notes, not the diff.
3286///
3287/// That class is bigger than it looks: **10, 17, 21, 22, 23, 24 and 37 all shipped with no change
3288/// to any type in this file** — they moved meaning, not shape. Seven of the forty, and 37 is
3289/// a SECURITY fix, which is the case where a consumer most needs the guard. 38 adds a field, but
3290/// its REAL content is a meaning change to `reachable` — the field exists so the new meaning is
3291/// observable at all. A downstream
3292/// that diffs types across a multi-minor bump sees nothing for any of them.
3293pub const API_MINOR: u32 = 61;
3294
3295#[cfg(test)]
3296mod tests {
3297    use super::*;
3298
3299    /// #64: the path field's wire shape, and its ADDITIVE default. A row from an older daemon has
3300    /// no `path` key at all and must land on `Unknown` — never on `Direct`, which would invent a
3301    /// privacy guarantee that daemon never made.
3302    #[test]
3303    fn peer_path_tags_and_defaults_to_unknown() {
3304        let tagged = |p: PeerPath| serde_json::to_value(p).unwrap();
3305        assert_eq!(tagged(PeerPath::Direct)["kind"], "direct");
3306        assert_eq!(tagged(PeerPath::Unknown)["kind"], "unknown");
3307        let relay = tagged(PeerPath::Relay {
3308            url: Some("https://relay.example/".into()),
3309        });
3310        assert_eq!(relay["kind"], "relay");
3311        assert_eq!(relay["url"], "https://relay.example/");
3312        // A relay whose URL we do not know still tags as relay, with the key elided.
3313        let bare = tagged(PeerPath::Relay { url: None });
3314        assert_eq!(bare["kind"], "relay");
3315        assert!(bare.get("url").is_none(), "elided, not null: {bare}");
3316
3317        // #64 review: a path kind from a NEWER daemon must degrade to Unknown, not fail the whole
3318        // row. Without `#[serde(other)]` an unknown `kind` errors out of
3319        // `PeerReachability` entirely, so one new variant would break every `status` read an
3320        // older pinned client does.
3321        let future: PeerPath =
3322            serde_json::from_value(serde_json::json!({"kind": "quantum", "id": "x"})).unwrap();
3323        assert_eq!(future, PeerPath::Unknown);
3324        let row: PeerReachability = serde_json::from_value(serde_json::json!({
3325            "name": "bob", "reachable": true, "path": {"kind": "quantum"}
3326        }))
3327        .expect("an unknown path kind must not fail the whole row");
3328        assert_eq!(row.path, PeerPath::Unknown);
3329        assert!(row.reachable, "the rest of the row survives");
3330
3331        // A pre-#64 row: no `path` key.
3332        let old = serde_json::json!({"name": "bob", "reachable": true});
3333        let parsed: PeerReachability = serde_json::from_value(old).unwrap();
3334        assert_eq!(
3335            parsed.path,
3336            PeerPath::Unknown,
3337            "an older daemon's row must never imply a direct path"
3338        );
3339    }
3340
3341    /// #58: the pushed liveness frame tags as `{"type":"reachability","peer":{…}}` and carries a
3342    /// whole `PeerReachability` row — the SAME shape the opening snapshot's list holds, so a
3343    /// consumer projects both through one code path.
3344    #[test]
3345    fn reachability_frame_tags_and_round_trips() {
3346        let frame = StreamFrame::Reachability {
3347            peer: PeerReachability {
3348                name: "bob".into(),
3349                reachable: true,
3350                rtt_ms: Some(12),
3351                age_secs: Some(0),
3352                meta: String::new(),
3353                principal: Some("eid:beef".into()),
3354                path: Default::default(),
3355            },
3356            source: ReachabilitySource::Probe,
3357        };
3358        let v = serde_json::to_value(&frame).unwrap();
3359        assert_eq!(v["type"], "reachability");
3360        assert_eq!(v["peer"]["name"], "bob");
3361        assert_eq!(v["peer"]["reachable"], true);
3362        assert_eq!(
3363            v["peer"]["age_secs"], 0,
3364            "a transition frame is fresh by construction: {v}"
3365        );
3366        assert_eq!(v["source"], "probe", "#150: the producer is named: {v}");
3367        let back: StreamFrame = serde_json::from_value(v).unwrap();
3368        assert_eq!(back, frame);
3369    }
3370
3371    /// #150: the frame's `source` wire shape, and the two ways it must degrade.
3372    ///
3373    /// The default is the load-bearing part. An absent key comes from a daemon at `api_minor`
3374    /// 22–29, which ALREADY has both producers — so it must land on `Unknown`, never on `Probe`.
3375    /// Defaulting to `Probe` would tell a consumer "a throwaway dial saw this" about frames that
3376    /// were a live session degrading, which is the ambiguity the field exists to remove.
3377    /// #140: `known_addrs` absent, empty, and populated are three DIFFERENT wire shapes.
3378    ///
3379    /// The distinction is the field's whole reason for existing, and it is carried by
3380    /// `skip_serializing_if` — so it lives on the wire, not in Rust. An embedder checking
3381    /// `known_addrs === null` gets `undefined`, which is why the absent case is asserted as a
3382    /// MISSING KEY rather than a null.
3383    #[test]
3384    fn known_addrs_distinguishes_absent_from_empty_on_the_wire() {
3385        let base = PeerDiagnosticsResult {
3386            nickname: "jetson".into(),
3387            principal: "eid:beef".into(),
3388            hint_usable: true,
3389            ..Default::default()
3390        };
3391
3392        // Absent: the key is OMITTED, never serialized as null.
3393        let v = serde_json::to_value(&base).unwrap();
3394        assert!(
3395            v.get("known_addrs").is_none(),
3396            "an absent iroh entry elides the key — a consumer must test presence, not null: {v}"
3397        );
3398
3399        // Empty: iroh HAS an entry and holds no address. A real, different state.
3400        let empty = PeerDiagnosticsResult {
3401            known_addrs: Some(vec![]),
3402            ..base.clone()
3403        };
3404        let v = serde_json::to_value(&empty).unwrap();
3405        assert_eq!(
3406            v["known_addrs"],
3407            serde_json::json!([]),
3408            "an empty list must survive as `[]` rather than collapsing back to absent: {v}"
3409        );
3410        assert_eq!(
3411            serde_json::from_value::<PeerDiagnosticsResult>(v).unwrap(),
3412            empty,
3413            "and round-trip back to Some(vec![]), not None"
3414        );
3415
3416        // Populated, with the `active` flag per address.
3417        let full = PeerDiagnosticsResult {
3418            known_addrs: Some(vec![
3419                KnownAddr {
3420                    addr: "192.168.1.77:4433".into(),
3421                    active: true,
3422                },
3423                KnownAddr {
3424                    addr: "relay https://r.example:8443".into(),
3425                    active: false,
3426                },
3427            ]),
3428            hint_addrs_unknown_to_iroh: vec!["10.0.0.9:4433".into()],
3429            ..base
3430        };
3431        let v = serde_json::to_value(&full).unwrap();
3432        assert_eq!(v["known_addrs"][0]["addr"], "192.168.1.77:4433");
3433        assert_eq!(v["known_addrs"][0]["active"], true);
3434        assert_eq!(v["known_addrs"][1]["active"], false);
3435        assert_eq!(
3436            v["hint_addrs_unknown_to_iroh"],
3437            serde_json::json!(["10.0.0.9:4433"])
3438        );
3439        assert!(
3440            v.get("iroh_addrs_not_in_hint").is_none(),
3441            "an empty difference elides rather than shipping `[]` noise in every capture: {v}"
3442        );
3443        assert_eq!(
3444            serde_json::from_value::<PeerDiagnosticsResult>(v).unwrap(),
3445            full
3446        );
3447    }
3448
3449    #[test]
3450    fn reachability_source_tags_and_defaults_to_unknown() {
3451        let tagged = |s: ReachabilitySource| serde_json::to_value(s).unwrap();
3452        assert_eq!(tagged(ReachabilitySource::Probe), "probe");
3453        assert_eq!(tagged(ReachabilitySource::Session), "session");
3454        assert_eq!(tagged(ReachabilitySource::Unknown), "unknown");
3455        for s in [
3456            ReachabilitySource::Probe,
3457            ReachabilitySource::Session,
3458            ReachabilitySource::Unknown,
3459        ] {
3460            let back: ReachabilitySource = serde_json::from_value(tagged(s)).unwrap();
3461            assert_eq!(back, s, "round trip");
3462        }
3463
3464        let peer = serde_json::json!({"name": "bob", "reachable": true});
3465
3466        // A pre-#150 frame: no `source` key at all.
3467        let old: StreamFrame =
3468            serde_json::from_value(serde_json::json!({"type": "reachability", "peer": peer}))
3469                .expect("an older daemon's frame must still parse");
3470        let StreamFrame::Reachability { source, .. } = old else {
3471            panic!("expected a reachability frame");
3472        };
3473        assert_eq!(
3474            source,
3475            ReachabilitySource::Unknown,
3476            "an api_minor 22-29 daemon has BOTH producers, so an absent key must not claim Probe"
3477        );
3478
3479        // A producer from a NEWER daemon must degrade to Unknown, not fail the whole frame — the
3480        // same stake `PeerPath` buys with `#[serde(other)]`. Without the hand-written Deserialize
3481        // a third producer would break every Reachability frame an older pinned client reads.
3482        let future: StreamFrame = serde_json::from_value(
3483            serde_json::json!({"type": "reachability", "peer": peer, "source": "telemetry"}),
3484        )
3485        .expect("an unknown producer must not fail the whole frame");
3486        let StreamFrame::Reachability { source, peer } = future else {
3487            panic!("expected a reachability frame");
3488        };
3489        assert_eq!(source, ReachabilitySource::Unknown);
3490        assert!(peer.reachable, "the rest of the frame survives");
3491    }
3492
3493    /// #148: a defaulted status is EMPTY and honest — the fixture ergonomic an embedder gets in
3494    /// exchange for us adding fields.
3495    ///
3496    /// Its content is the load-bearing part. A downstream test that omits a field must not thereby
3497    /// assert something: no phantom peers or services, and the optional blocks absent rather than
3498    /// zeroed. `storage: Some(StorageInfo::default())` would read as "0 bytes on disk", which is a
3499    /// measurement nobody took.
3500    #[test]
3501    fn a_defaulted_status_is_empty_and_claims_nothing() {
3502        let d = StatusResult::default();
3503        assert!(d.peers.is_empty() && d.services.is_empty(), "{d:?}");
3504        assert!(d.reachability.is_empty() && d.presence.is_empty(), "{d:?}");
3505        assert!(d.recent_pairings.is_empty(), "{d:?}");
3506        assert_eq!(d.roster, None, "no roster is not an empty roster");
3507        assert_eq!(d.storage, None, "absent, not 0 bytes — nobody measured");
3508        assert_eq!(d.self_network, None, "absent, not offline — nobody looked");
3509        assert_eq!(d.self_user_id, None);
3510        assert!(
3511            d.stack_version.is_empty() && d.self_nickname.is_empty(),
3512            "{d:?}"
3513        );
3514
3515        // The pattern the issue actually asks for: additive growth stops breaking fixtures.
3516        let fixture = StatusResult {
3517            peers: vec![PeerInfo {
3518                name: "bob".into(),
3519                ..Default::default()
3520            }],
3521            ..Default::default()
3522        };
3523        assert_eq!(fixture.peers[0].name, "bob");
3524        assert!(fixture.services.is_empty());
3525
3526        // A default round-trips, so the elide-vs-null discipline holds for one too.
3527        let v = serde_json::to_value(&d).unwrap();
3528        assert!(v.get("roster").is_none(), "elided, not null: {v}");
3529        assert!(v.get("storage").is_none(), "elided, not null: {v}");
3530        let back: StatusResult = serde_json::from_value(v).unwrap();
3531        assert_eq!(back, d);
3532    }
3533
3534    /// #148: a defaulted reachability row is NOT reachable and makes NO path claim.
3535    ///
3536    /// This is the one default where a wrong choice would be a false guarantee rather than a
3537    /// harmless placeholder — the same trap `PeerPath`'s `#[default] Unknown` exists to avoid
3538    /// (#64), now reachable through a second door. A fixture that forgot to set `path` must not
3539    /// thereby assert the peer was reached directly, and one that forgot `reachable` must not
3540    /// claim it was up.
3541    #[test]
3542    fn a_defaulted_reachability_row_asserts_nothing_about_the_peer() {
3543        let d = PeerReachability::default();
3544        assert!(!d.reachable, "an unset row must not claim the peer is up");
3545        assert_eq!(
3546            d.path,
3547            PeerPath::Unknown,
3548            "an unset path must never read as Direct — that is a privacy claim no one made"
3549        );
3550        assert_eq!(d.rtt_ms, None, "no measurement was taken");
3551        assert_eq!(d.age_secs, None, "never probed");
3552        assert_eq!(d.principal, None);
3553        assert!(d.name.is_empty() && d.meta.is_empty());
3554    }
3555
3556    /// #148 gate: the REST of the new defaults, which the first pass left entirely unasserted —
3557    /// moving `BackendKind`'s `#[default]` to `Socket` failed nothing across the whole workspace.
3558    ///
3559    /// Each assertion below is the conservative reading of a field that could otherwise let a
3560    /// fixture assert something by omission.
3561    #[test]
3562    fn the_remaining_defaults_are_conservative() {
3563        let s = ServiceInfo::default();
3564        assert!(
3565            s.allow.is_empty(),
3566            "an unset allow must admit NOBODY — empty is deny (the gate's `any()` is false on an \
3567             empty list), and a permissive default here would be an authz hole reachable from a \
3568             fixture"
3569        );
3570        assert!(s.allow_display.is_empty() && s.name.is_empty());
3571        assert!(
3572            !s.ephemeral,
3573            "persistent is the conservative reading, and matches the wire default"
3574        );
3575        assert_eq!(
3576            s.backend,
3577            BackendKind::Run,
3578            "the documented choice — a convenience, not a claim; pinned so it cannot drift \
3579             silently out of step with its own rustdoc"
3580        );
3581        assert_eq!(BackendKind::default(), BackendKind::Run);
3582
3583        let p = PeerInfo::default();
3584        assert!(p.name.is_empty() && p.services.is_empty());
3585        assert_eq!(p.user_id, None, "no identity was proven");
3586        assert_eq!(p.principal, None);
3587
3588        // The gate's finding: this default is the documented "deliberately LAN-only" posture,
3589        // which the porcelain renders as healthy and NOT as a warning. It is unavoidable (a bool
3590        // has no third state) but it must stay deliberate, so it is pinned rather than left to
3591        // be rediscovered by whoever writes the next fixture.
3592        let n = SelfNetwork::default();
3593        assert!(!n.online, "no relay connection is established");
3594        assert!(
3595            n.relays.is_empty() && n.home_relay.is_none(),
3596            "and none are known — which the renderer reads as LAN-BY-CONFIGURATION, not as an \
3597             outage; say 'nobody looked' with StatusResult.self_network: None instead"
3598        );
3599        assert_eq!(n.last_change_epoch, None, "no transition was observed");
3600
3601        let r = RelayInfo::default();
3602        assert!(
3603            !r.connected,
3604            "an unset relay must not claim a live connection"
3605        );
3606
3607        let st = StorageInfo::default();
3608        assert_eq!(
3609            (st.audit_bytes, st.redb_bytes, st.blobs_bytes),
3610            (0, 0, 0),
3611            "zeros read as MEASURED-and-empty; `StatusResult.storage: None` is 'unmeasured'"
3612        );
3613
3614        let ro = RosterStatus::default();
3615        assert!(
3616            ro.state.is_empty(),
3617            "not a valid state word, deliberately — `doctor` warns on an unknown state rather \
3618             than reporting a healthy roster"
3619        );
3620        assert_eq!(ro.serial, 0);
3621
3622        let pp = PresencePeer::default();
3623        assert!(
3624            !pp.online,
3625            "an unset presence row must not claim the device is up"
3626        );
3627        assert!(pp.role.is_empty() && pp.user_id.is_empty());
3628
3629        let rp = RecentPairing::default();
3630        assert_eq!(rp.paired_at_epoch, 0);
3631        assert!(rp.sas_code.is_empty(), "no ceremony produced a code");
3632    }
3633
3634    /// #150 gate: "an unrecognized value reads as `unknown`" must hold for any VALUE, not just an
3635    /// unrecognized string.
3636    ///
3637    /// `#[serde(default)]` covers an absent key and nothing else, so `"source": null` — what a
3638    /// proxy or non-Rust daemon that normalizes optional fields produces — went through the
3639    /// deserializer and failed the WHOLE frame, silently dropping a liveness transition while the
3640    /// protocol doc promised the field could not break a parse. The container shapes matter
3641    /// separately: a visitor that answers without draining a map/seq desynchronizes the parser and
3642    /// fails the frame anyway, which looks identical from outside.
3643    #[test]
3644    fn a_malformed_source_degrades_instead_of_failing_the_frame() {
3645        let peer = serde_json::json!({"name": "bob", "reachable": true});
3646        for bad in [
3647            serde_json::Value::Null,
3648            serde_json::json!(7),
3649            serde_json::json!(-1),
3650            serde_json::json!(1.5),
3651            serde_json::json!(true),
3652            serde_json::json!({"kind": "probe", "nested": {"deep": [1, 2]}}),
3653            serde_json::json!(["probe", "session"]),
3654        ] {
3655            let frame: StreamFrame = serde_json::from_value(
3656                serde_json::json!({"type": "reachability", "peer": peer, "source": bad}),
3657            )
3658            .unwrap_or_else(|e| panic!("`source: {bad}` must not fail the whole frame: {e}"));
3659            let StreamFrame::Reachability { source, peer } = frame else {
3660                panic!("expected a reachability frame");
3661            };
3662            assert_eq!(source, ReachabilitySource::Unknown, "for source: {bad}");
3663            assert!(peer.reachable, "the rest of the frame survives: {bad}");
3664        }
3665    }
3666
3667    /// #90: the self-network frame tags as `{"type":"self_network","self_network":{…}}` — the
3668    /// SAME block `status` and the snapshot carry. Pinned explicitly (like the reachability
3669    /// tag) so a variant rename cannot slip past a suite whose two ends share the type while
3670    /// breaking every doc-following third-party client.
3671    #[test]
3672    fn self_network_frame_tags_and_round_trips() {
3673        let frame = StreamFrame::SelfNetwork {
3674            self_network: SelfNetwork {
3675                online: true,
3676                home_relay: Some("https://relay.example:443".into()),
3677                relays: vec![RelayInfo {
3678                    url: "https://relay.example:443".into(),
3679                    connected: true,
3680                }],
3681                direct_addrs: vec!["192.168.1.2:4444".into()],
3682                last_change_epoch: Some(1_753_842_000),
3683                identity_conflict_epoch: None,
3684                // #89: seeded NON-default so the round-trip actually carries it — an empty value
3685                // here would round-trip through a `skip_serializing_if` and prove nothing.
3686                presence_mode: Some("granted".into()),
3687                // #68: seeded `"resolve"`, deliberately NOT the `"off"` default — a fixture equal
3688                // to the default would round-trip identically whether or not the field was carried
3689                // at all, and the assertion below would measure nothing.
3690                local_discovery: Some("resolve".into()),
3691            },
3692        };
3693        let v = serde_json::to_value(&frame).unwrap();
3694        assert_eq!(v["type"], "self_network");
3695        assert_eq!(v["self_network"]["online"], true);
3696        assert_eq!(v["self_network"]["home_relay"], "https://relay.example:443");
3697        assert_eq!(v["self_network"]["relays"][0]["connected"], true);
3698        assert_eq!(
3699            v["self_network"]["presence_mode"], "granted",
3700            "#89: the live presence mode must reach the wire — it is the only way an operator can \
3701             confirm the knob took effect, and a product's privacy switch has nothing to render \
3702             without it"
3703        );
3704        assert_eq!(
3705            v["self_network"]["local_discovery"], "resolve",
3706            "#68: the live local-discovery mode must reach the wire — `\"on\"` means this node is \
3707             multicasting its endpoint id to every device on the link, and a privacy switch has \
3708             nothing to render without it"
3709        );
3710        let back: StreamFrame = serde_json::from_value(v).unwrap();
3711        assert_eq!(back, frame);
3712    }
3713
3714    #[test]
3715    fn peer_reachability_serde_is_additive() {
3716        let r = PeerReachability {
3717            name: "bob".into(),
3718            reachable: true,
3719            rtt_ms: Some(42),
3720            age_secs: Some(3),
3721            meta: String::new(),
3722            principal: None,
3723            path: Default::default(),
3724        };
3725        let v = serde_json::to_value(&r).unwrap();
3726        assert_eq!(v["name"], "bob");
3727        assert_eq!(v["reachable"], true);
3728        assert_eq!(v["rtt_ms"], 42);
3729        assert_eq!(v["age_secs"], 3);
3730        // Never-probed peer: optionals elided, not null.
3731        let unknown = PeerReachability {
3732            name: "carol".into(),
3733            reachable: false,
3734            rtt_ms: None,
3735            age_secs: None,
3736            meta: String::new(),
3737            principal: None,
3738            path: Default::default(),
3739        };
3740        let uv = serde_json::to_value(&unknown).unwrap();
3741        assert!(uv.get("rtt_ms").is_none() && uv.get("age_secs").is_none());
3742        // An older StatusResult (no reachability field) still deserializes.
3743        let old = serde_json::json!({"stack_version":"0.1.0","services":[],"peers":[]});
3744        let s: StatusResult = serde_json::from_value(old).unwrap();
3745        assert!(s.reachability.is_empty());
3746    }
3747
3748    #[test]
3749    fn subscribe_method_tag_resolves() {
3750        let req = serde_json::to_value(Request::Subscribe).unwrap();
3751        assert_eq!(method_of(&req), Some("subscribe"));
3752    }
3753
3754    // --- #34: params structs reject unknown fields (the `{service: "kb"}` silent-accept bug) ---
3755
3756    #[test]
3757    fn invite_params_reject_singular_service_typo() {
3758        // The reported bug: `{"service":"kb"}` (singular) used to deserialize to
3759        // `InviteParams { services: [] }` and mint a grants-nothing invite that looked
3760        // successful. With deny_unknown_fields the typo is a loud parse error instead.
3761        let err = serde_json::from_value::<InviteParams>(serde_json::json!({"service": "kb"}));
3762        assert!(
3763            err.is_err(),
3764            "an unknown `service` key must be rejected, not silently ignored"
3765        );
3766        // The correct plural shape still parses.
3767        let ok: InviteParams =
3768            serde_json::from_value(serde_json::json!({"services": ["kb"]})).unwrap();
3769        assert_eq!(ok.services, vec!["kb".to_string()]);
3770    }
3771
3772    #[test]
3773    fn open_session_params_reject_unknown_field() {
3774        let err = serde_json::from_value::<OpenSessionParams>(
3775            serde_json::json!({"peer": "a", "service": "b", "nonsense": 1}),
3776        );
3777        assert!(err.is_err(), "unknown params keys must be rejected");
3778    }
3779
3780    #[test]
3781    fn set_app_metadata_request_carries_the_method_tag() {
3782        let r = Request::SetAppMetadata(SetAppMetadataParams {
3783            metadata: "v=1.2.3".into(),
3784        });
3785        let v = serde_json::to_value(&r).unwrap();
3786        assert_eq!(v["method"], "set_app_metadata");
3787        assert_eq!(v["params"]["metadata"], "v=1.2.3");
3788        assert_eq!(method_of(&v), Some("set_app_metadata"));
3789    }
3790
3791    #[test]
3792    fn set_app_metadata_params_reject_unknown_field() {
3793        let err = serde_json::from_value::<SetAppMetadataParams>(
3794            serde_json::json!({"metadata": "x", "nonsense": 1}),
3795        );
3796        assert!(err.is_err(), "unknown params keys must be rejected");
3797    }
3798
3799    /// `PresencePeer.meta` is additive — an older payload (no meta) still deserializes, and an
3800    /// empty meta does not serialize.
3801    #[test]
3802    fn peer_info_principal_is_additive() {
3803        // An older payload (no principal) still deserializes; empty does not serialize.
3804        let old = serde_json::json!({"name": "bob", "services": ["notes"]});
3805        let p: PeerInfo = serde_json::from_value(old).unwrap();
3806        assert_eq!(p.principal, None);
3807        assert!(serde_json::to_value(&p).unwrap().get("principal").is_none());
3808        // A bound peer carries BOTH the person user_id AND the device principal (#41).
3809        let full = PeerInfo {
3810            name: "bob".into(),
3811            services: vec!["notes".into()],
3812            user_id: Some("b64u:BOB".into()),
3813            principal: Some("eid:0707".into()),
3814        };
3815        let back: PeerInfo = serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
3816        assert_eq!(back.user_id.as_deref(), Some("b64u:BOB"));
3817        assert_eq!(back.principal.as_deref(), Some("eid:0707"));
3818    }
3819
3820    #[test]
3821    fn active_session_principal_is_additive() {
3822        // An OLD payload (no `principal`) must still deserialize — #73 is additive.
3823        let old: ActiveSession =
3824            serde_json::from_str(r#"{"peer":"bob","service":"notes","opened_at":7}"#).unwrap();
3825        assert_eq!(old.principal, None, "serde(default) supplies it");
3826
3827        // And a `None` must not serialize, so an old client sees the shape it expects.
3828        let json = serde_json::to_string(&old).unwrap();
3829        assert!(
3830            !json.contains("principal"),
3831            "skip_serializing_if must omit it: {json}"
3832        );
3833
3834        // A real row round-trips the principal.
3835        let new = ActiveSession {
3836            peer: "bob".into(),
3837            service: "notes".into(),
3838            opened_at: 7,
3839            principal: Some("eid:1f0a".into()),
3840        };
3841        let back: ActiveSession =
3842            serde_json::from_str(&serde_json::to_string(&new).unwrap()).unwrap();
3843        assert_eq!(back.principal.as_deref(), Some("eid:1f0a"));
3844    }
3845
3846    #[test]
3847    fn peer_reachability_principal_is_additive() {
3848        // Older payload (no principal) still deserializes; empty does not serialize; a set
3849        // value round-trips alongside the #40 meta so an embedder joins on the principal.
3850        let old = serde_json::json!({"name": "bob", "reachable": true});
3851        let r: PeerReachability = serde_json::from_value(old).unwrap();
3852        assert_eq!(r.principal, None);
3853        assert!(serde_json::to_value(&r).unwrap().get("principal").is_none());
3854        let full = PeerReachability {
3855            name: "bob".into(),
3856            reachable: true,
3857            rtt_ms: Some(12),
3858            age_secs: Some(3),
3859            meta: "v=1.2.3".into(),
3860            principal: Some("eid:0707".into()),
3861            path: Default::default(),
3862        };
3863        let back: PeerReachability =
3864            serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
3865        assert_eq!(back.principal.as_deref(), Some("eid:0707"));
3866        assert_eq!(back.meta, "v=1.2.3");
3867    }
3868
3869    #[test]
3870    fn peer_reachability_meta_is_additive() {
3871        // An older payload (no meta) still deserializes; an empty meta does not serialize.
3872        let old = serde_json::json!({"name": "bob", "reachable": true});
3873        let r: PeerReachability = serde_json::from_value(old).unwrap();
3874        assert_eq!(r.meta, "");
3875        assert!(serde_json::to_value(&r).unwrap().get("meta").is_none());
3876        // A set value round-trips.
3877        let with = PeerReachability {
3878            name: "bob".into(),
3879            reachable: true,
3880            rtt_ms: Some(12),
3881            age_secs: Some(3),
3882            meta: "v=1.2.3".into(),
3883            principal: None,
3884            path: Default::default(),
3885        };
3886        let back: PeerReachability =
3887            serde_json::from_value(serde_json::to_value(&with).unwrap()).unwrap();
3888        assert_eq!(back.meta, "v=1.2.3");
3889    }
3890
3891    #[test]
3892    fn presence_peer_meta_is_additive() {
3893        let old = serde_json::json!({
3894            "user_id": "b64u:A", "device_label": "laptop", "role": "primary", "online": true
3895        });
3896        let p: PresencePeer = serde_json::from_value(old).unwrap();
3897        assert_eq!(p.meta, "");
3898        assert!(serde_json::to_value(&p).unwrap().get("meta").is_none());
3899    }
3900
3901    #[test]
3902    fn set_nickname_request_carries_the_method_tag() {
3903        let r = Request::SetNickname(SetNicknameParams {
3904            nickname: "workbench".into(),
3905        });
3906        let v = serde_json::to_value(&r).unwrap();
3907        assert_eq!(v["method"], "set_nickname");
3908        assert_eq!(v["params"]["nickname"], "workbench");
3909        assert_eq!(method_of(&v), Some("set_nickname"));
3910    }
3911
3912    #[test]
3913    fn set_nickname_params_reject_unknown_field() {
3914        let err = serde_json::from_value::<SetNicknameParams>(
3915            serde_json::json!({"nickname": "x", "nonsense": 1}),
3916        );
3917        assert!(err.is_err(), "unknown params keys must be rejected");
3918    }
3919
3920    /// An OLDER daemon's status payload (no `self_nickname`) must still deserialize —
3921    /// the additive-only contract — and an empty name must not serialize at all.
3922    #[test]
3923    fn status_self_nickname_is_additive() {
3924        let old = serde_json::json!({
3925            "stack_version": "0.7.0", "services": [], "peers": []
3926        });
3927        let s: StatusResult = serde_json::from_value(old).unwrap();
3928        assert_eq!(s.self_nickname, "");
3929        let v = serde_json::to_value(&s).unwrap();
3930        assert!(v.get("self_nickname").is_none(), "empty name is skipped");
3931    }
3932
3933    #[test]
3934    fn api_minor_is_present_and_monotonic_from_hello() {
3935        // #34 part 2: a machine-comparable protocol-compat minor, distinct from the
3936        // crate/stack version, additive on the Hello frame.
3937        let h = Hello {
3938            api: API_NAME.into(),
3939            api_version: API_VERSION.into(),
3940            api_minor: API_MINOR,
3941            stack_version: "9.9.9".into(),
3942        };
3943        let v = serde_json::to_value(&h).unwrap();
3944        assert_eq!(v["api_minor"], API_MINOR);
3945        // An OLD Hello without api_minor still deserializes (additive contract).
3946        let old = serde_json::json!({
3947            "api": API_NAME, "api_version": "1.0", "stack_version": "0.4.0"
3948        });
3949        let back: Hello = serde_json::from_value(old).unwrap();
3950        assert_eq!(back.api_minor, 0, "absent api_minor defaults to 0");
3951    }
3952
3953    #[test]
3954    fn hello_result_roundtrips() {
3955        let h = Hello {
3956            api: "mcpmesh-local/1".into(),
3957            api_version: "1.0".into(),
3958            api_minor: 0,
3959            stack_version: "0.1.0".into(),
3960        };
3961        let v = serde_json::to_value(&h).unwrap();
3962        assert_eq!(v["api"], "mcpmesh-local/1");
3963        let back: Hello = serde_json::from_value(v).unwrap();
3964        assert_eq!(back, h);
3965    }
3966
3967    #[test]
3968    fn request_tagged_by_method() {
3969        let r = Request::Status;
3970        assert_eq!(serde_json::to_value(&r).unwrap()["method"], "status");
3971        let r = Request::OpenSession(OpenSessionParams {
3972            peer: "alice".into(),
3973            service: "notes".into(),
3974            // #166: seeded NON-default so the round-trip carries it. An absent value would be
3975            // elided by `skip_serializing_if` and the assertion below would prove nothing.
3976            idle_timeout_secs: Some(7),
3977        });
3978        let v = serde_json::to_value(&r).unwrap();
3979        assert_eq!(v["method"], "open_session");
3980        assert_eq!(v["params"]["peer"], "alice");
3981        assert_eq!(v["params"]["idle_timeout_secs"], 7);
3982        // …and an absent one really is absent, so an older daemon sees the payload it always saw.
3983        let bare = serde_json::to_value(Request::OpenSession(OpenSessionParams {
3984            peer: "alice".into(),
3985            service: "notes".into(),
3986            idle_timeout_secs: None,
3987        }))
3988        .unwrap();
3989        assert!(bare["params"].get("idle_timeout_secs").is_none());
3990    }
3991
3992    #[test]
3993    fn parameterless_method_tolerates_params_forms() {
3994        // Omitted and null params deserialize straight into the unit variant.
3995        let omitted: Request =
3996            serde_json::from_value(serde_json::json!({"method": "status"})).unwrap();
3997        assert_eq!(omitted, Request::Status);
3998        let null: Request =
3999            serde_json::from_value(serde_json::json!({"method": "status", "params": null}))
4000                .unwrap();
4001        assert_eq!(null, Request::Status);
4002
4003        // Known limitation: adjacent tagging rejects `params:{}` for a unit variant, so
4004        // the server MUST dispatch on the method string rather than deserialize the whole
4005        // message into `Request`. This is the pattern the daemon's dispatcher uses.
4006        let empty = serde_json::json!({"method": "status", "params": {}});
4007        assert!(serde_json::from_value::<Request>(empty.clone()).is_err());
4008        match method_of(&empty) {
4009            Some("status") => {} // dispatcher resolves Status via the method string
4010            other => panic!("method_of failed to resolve status: {other:?}"),
4011        }
4012    }
4013
4014    #[test]
4015    fn backend_spec_roundtrips() {
4016        let run = BackendSpec::Run {
4017            cmd: vec!["notes-mcp".into(), "--stdio".into()],
4018            env: Default::default(),
4019            cwd: None,
4020        };
4021        let v = serde_json::to_value(&run).unwrap();
4022        assert_eq!(v["run"]["cmd"][0], "notes-mcp");
4023        assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), run);
4024
4025        let sock = BackendSpec::Socket {
4026            path: "/run/notes.sock".into(),
4027        };
4028        let v = serde_json::to_value(&sock).unwrap();
4029        assert_eq!(v["socket"]["path"], "/run/notes.sock");
4030        assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), sock);
4031    }
4032
4033    #[test]
4034    fn register_service_wire_shape() {
4035        let r = Request::RegisterService(RegisterServiceParams {
4036            name: "notes".into(),
4037            backend: BackendSpec::Run {
4038                cmd: vec!["notes-mcp".into()],
4039                env: Default::default(),
4040                cwd: None,
4041            },
4042            allow: vec!["alice".into()],
4043            ephemeral: false,
4044            rate_limit_per_min: None,
4045        });
4046        let v = serde_json::to_value(&r).unwrap();
4047        assert_eq!(
4048            v,
4049            serde_json::json!({
4050                "method": "register_service",
4051                "params": {
4052                    "name": "notes",
4053                    "backend": {"run": {"cmd": ["notes-mcp"]}},
4054                    "allow": ["alice"],
4055                }
4056            })
4057        );
4058        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4059    }
4060
4061    #[test]
4062    fn invite_request_and_result_roundtrip() {
4063        // Request::Invite → `{ "method": "invite", "params": { "services": [...] } }`.
4064        let r = Request::Invite(InviteParams {
4065            services: vec!["notes".into(), "kb".into()],
4066            app_label: None,
4067            max_uses: None,
4068            // #87: seeded NON-None so the round-trip actually carries it — `None` rides
4069            // `skip_serializing_if` straight past the assertion and proves nothing.
4070            peer_nickname: Some("laptop-of-alice".into()),
4071            as_self: false,
4072        });
4073        let v = serde_json::to_value(&r).unwrap();
4074        assert_eq!(v["method"], "invite");
4075        assert_eq!(
4076            v["params"]["peer_nickname"], "laptop-of-alice",
4077            "#87: the inviter's local alias for the redeemer must reach the wire"
4078        );
4079        assert_eq!(v["params"]["services"][0], "notes");
4080        assert_eq!(v["params"]["services"][1], "kb");
4081        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4082        // method_of resolves the tag generically (no per-variant arm).
4083        assert_eq!(
4084            method_of(&serde_json::json!({"method": "invite", "params": {"services": []}})),
4085            Some("invite")
4086        );
4087
4088        // InviteResult carries the copyable line + expiry (surface #2 pairing artifact).
4089        let res = InviteResult {
4090            invite_line: "mcpmesh-invite:ABCDEF".into(),
4091            expires_at_epoch: 1_800_000_000,
4092            uses_remaining: 1,
4093        };
4094        let v = serde_json::to_value(&res).unwrap();
4095        assert_eq!(v["invite_line"], "mcpmesh-invite:ABCDEF");
4096        assert_eq!(v["expires_at_epoch"], 1_800_000_000u64);
4097        assert_eq!(serde_json::from_value::<InviteResult>(v).unwrap(), res);
4098    }
4099
4100    #[test]
4101    fn pair_request_and_result_roundtrip() {
4102        // Request::Pair → `{ "method": "pair", "params": { "invite_line": "..." } }`.
4103        let r = Request::Pair(PairParams {
4104            invite_line: "mcpmesh-invite:ABCDEF".into(),
4105            as_nickname: Some("alice-mbp".into()),
4106            allow_self_enroll: true,
4107        });
4108        let v = serde_json::to_value(&r).unwrap();
4109        assert_eq!(v["method"], "pair");
4110        assert_eq!(v["params"]["invite_line"], "mcpmesh-invite:ABCDEF");
4111        assert_eq!(
4112            v["params"]["as_nickname"], "alice-mbp",
4113            "#87: the redeemer's local alias for the inviter must reach the wire"
4114        );
4115        assert_eq!(
4116            v["params"]["allow_self_enroll"], true,
4117            "#178: the caller's consent to a self-enrollment must reach the wire — the daemon \
4118             refuses the ceremony without it"
4119        );
4120        // An OLD caller's payload — no alias — must still decode. The field is additive.
4121        let legacy: PairParams =
4122            serde_json::from_value(serde_json::json!({"invite_line": "x"})).unwrap();
4123        assert_eq!(legacy.as_nickname, None);
4124        // #178: and the consent defaults to REFUSING. A caller that predates the field, or one that
4125        // simply never set it, must not be read as having offered a device enrollment — that is the
4126        // whole guard, and a `#[serde(default)]` flipping to `true` would silently remove it.
4127        assert!(
4128            !legacy.allow_self_enroll,
4129            "an absent allow_self_enroll must default to false (refuse), never to true"
4130        );
4131        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4132        // method_of resolves the tag generically (no per-variant arm).
4133        assert_eq!(
4134            method_of(&serde_json::json!({"method": "pair", "params": {"invite_line": "x"}})),
4135            Some("pair")
4136        );
4137
4138        // PairResult carries the inviter's suggested nickname + the display-only SAS words +
4139        // the granted services (the porcelain renders each as `<peer>/<service>`).
4140        let res = PairResult {
4141            peer_nickname: "alice".into(),
4142            sas_code: "tango-fig-cabbage".into(),
4143            services: vec!["notes".into(), "kb".into()],
4144            app_label: None,
4145            peer_user_id: None,
4146            enrolled_as_self: false,
4147        };
4148        let v = serde_json::to_value(&res).unwrap();
4149        assert_eq!(v["peer_nickname"], "alice");
4150        assert_eq!(v["sas_code"], "tango-fig-cabbage");
4151        assert_eq!(v["services"][0], "notes");
4152        assert_eq!(v["services"][1], "kb");
4153        assert_eq!(serde_json::from_value::<PairResult>(v).unwrap(), res);
4154
4155        // Additive-only: a PairResult minted by an older daemon (no `services` key) still
4156        // deserializes — the `#[serde(default)]` fills it with an empty list.
4157        let old_shape = serde_json::json!({
4158            "peer_nickname": "alice",
4159            "sas_code": "tango-fig-cabbage",
4160        });
4161        let back: PairResult = serde_json::from_value(old_shape).unwrap();
4162        assert_eq!(back.peer_nickname, "alice");
4163        assert!(back.services.is_empty());
4164    }
4165
4166    #[test]
4167    fn roster_install_request_and_result_roundtrip() {
4168        // Request::RosterInstall → `{ "method": "roster_install", "params": { "path": ...,
4169        // "org_root_pk": ... } }`. The optional pk is present on the first-install shape.
4170        let r = Request::RosterInstall(RosterInstallParams {
4171            path: "/tmp/roster.json".into(),
4172            org_root_pk: Some("b64u:AAAA".into()),
4173        });
4174        let v = serde_json::to_value(&r).unwrap();
4175        assert_eq!(v["method"], "roster_install");
4176        assert_eq!(v["params"]["path"], "/tmp/roster.json");
4177        assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
4178        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4179        // method_of resolves the tag generically (no per-variant arm).
4180        assert_eq!(
4181            method_of(&serde_json::json!({"method": "roster_install", "params": {"path": "/x"}})),
4182            Some("roster_install")
4183        );
4184
4185        // When the pk is omitted (a subsequent install using the pinned value), it is
4186        // `skip_serializing_if`-dropped from the wire and deserializes back to `None`.
4187        let omit = Request::RosterInstall(RosterInstallParams {
4188            path: "/tmp/roster.json".into(),
4189            org_root_pk: None,
4190        });
4191        let v = serde_json::to_value(&omit).unwrap();
4192        assert!(
4193            v["params"].get("org_root_pk").is_none(),
4194            "an omitted org_root_pk must not appear on the wire: {v}"
4195        );
4196        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), omit);
4197
4198        // RosterInstallResult carries org_id + serial + severed count (roster-status vocabulary).
4199        let res = RosterInstallResult {
4200            org_id: "acme".into(),
4201            serial: 42,
4202            severed: 1,
4203        };
4204        let v = serde_json::to_value(&res).unwrap();
4205        assert_eq!(v["org_id"], "acme");
4206        assert_eq!(v["serial"], 42u64);
4207        assert_eq!(v["severed"], 1u32);
4208        assert_eq!(
4209            serde_json::from_value::<RosterInstallResult>(v).unwrap(),
4210            res
4211        );
4212
4213        // Additive-only: a result minted by an older daemon (no `severed` key) still
4214        // deserializes — the `#[serde(default)]` fills it with 0.
4215        let old_shape = serde_json::json!({ "org_id": "acme", "serial": 7 });
4216        let back: RosterInstallResult = serde_json::from_value(old_shape).unwrap();
4217        assert_eq!(back.serial, 7);
4218        assert_eq!(back.severed, 0);
4219    }
4220
4221    #[test]
4222    fn org_join_request_and_result_roundtrip() {
4223        // Request::OrgJoin → `{ "method": "org_join", "params": { org_id, org_root_pk, user_id,
4224        // user_key } }`. `user_key` is a LOCAL path string (the key never crosses the API).
4225        let r = Request::OrgJoin(OrgJoinParams {
4226            org_id: "acme".into(),
4227            org_root_pk: "b64u:AAAA".into(),
4228            user_id: "alice".into(),
4229            user_key: "/home/alice/.config/mcpmesh/user.key".into(),
4230        });
4231        let v = serde_json::to_value(&r).unwrap();
4232        assert_eq!(v["method"], "org_join");
4233        assert_eq!(v["params"]["org_id"], "acme");
4234        assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
4235        assert_eq!(v["params"]["user_id"], "alice");
4236        assert_eq!(
4237            v["params"]["user_key"],
4238            "/home/alice/.config/mcpmesh/user.key"
4239        );
4240        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4241        // method_of resolves the tag generically (no per-variant arm).
4242        assert_eq!(
4243            method_of(&serde_json::json!({"method": "org_join", "params": {"org_id": "x"}})),
4244            Some("org_join")
4245        );
4246
4247        // OrgJoinResult echoes the pinned org id (surface-clean; the fingerprint is porcelain-side).
4248        let res = OrgJoinResult {
4249            org_id: "acme".into(),
4250            restart_required: true,
4251        };
4252        let v = serde_json::to_value(&res).unwrap();
4253        assert_eq!(v["org_id"], "acme");
4254        assert_eq!(
4255            v["restart_required"], true,
4256            "#93: a half-live join must reach the wire — the caller cannot detect it any other way"
4257        );
4258        // Additive: an older daemon omits it, and absent reads as `false` — which was that
4259        // daemon's implicit answer. Pinned so the default cannot silently flip to `true` and start
4260        // telling every caller to restart.
4261        let legacy: OrgJoinResult =
4262            serde_json::from_value(serde_json::json!({"org_id": "acme"})).unwrap();
4263        assert!(!legacy.restart_required);
4264        // …and the false case must not bloat the payload.
4265        let quiet = serde_json::to_value(OrgJoinResult {
4266            org_id: "acme".into(),
4267            restart_required: false,
4268        })
4269        .unwrap();
4270        assert!(quiet.get("restart_required").is_none());
4271        assert_eq!(serde_json::from_value::<OrgJoinResult>(v).unwrap(), res);
4272    }
4273
4274    #[test]
4275    fn set_roster_url_request_roundtrip() {
4276        // Request::SetRosterUrl → `{ "method": "set_roster_url", "params": { "url": "..." } }`.
4277        let r = Request::SetRosterUrl(SetRosterUrlParams {
4278            url: "https://intranet.acme.com/roster.json".into(),
4279        });
4280        let v = serde_json::to_value(&r).unwrap();
4281        assert_eq!(v["method"], "set_roster_url");
4282        assert_eq!(v["params"]["url"], "https://intranet.acme.com/roster.json");
4283        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4284        assert_eq!(
4285            method_of(&serde_json::json!({"method": "set_roster_url", "params": {"url": "x"}})),
4286            Some("set_roster_url")
4287        );
4288    }
4289
4290    #[test]
4291    fn peer_remove_request_roundtrip() {
4292        // Request::PeerRemove → `{ "method": "peer_remove", "params": { "nickname": "..." } }`.
4293        let r = Request::PeerRemove(PeerRemoveParams {
4294            nickname: "bob".into(),
4295        });
4296        let v = serde_json::to_value(&r).unwrap();
4297        assert_eq!(v["method"], "peer_remove");
4298        assert_eq!(v["params"]["nickname"], "bob");
4299        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4300        // method_of resolves the tag generically (no per-variant arm).
4301        assert_eq!(
4302            method_of(&serde_json::json!({"method": "peer_remove", "params": {"nickname": "bob"}})),
4303            Some("peer_remove")
4304        );
4305    }
4306
4307    /// The reserved/internal `peer_add` rides the SAME typed vocabulary as every other method —
4308    /// `{ "method": "peer_add", "params": { nickname, endpoint_id, allow } }` — with `allow`
4309    /// defaulting to empty when absent.
4310    /// #65: the wire tags for the introduction pair. The serde tag must equal the dispatch string
4311    /// the daemon matches on — nothing else checks that they agree.
4312    #[test]
4313    fn peer_introduce_and_endorse_roundtrip() {
4314        let r = Request::PeerIntroduce(PeerIntroduceParams {
4315            subject: "eid:aa".into(),
4316            endorsed_by: "b64u:carol".into(),
4317            evidence: "b64u:sig".into(),
4318            subject_user_id: Some("b64u:bob".into()),
4319            subject_binding: Some("b64u:bind".into()),
4320            nickname: "bob".into(),
4321        });
4322        let v = serde_json::to_value(&r).unwrap();
4323        assert_eq!(
4324            v["method"], "peer_introduce",
4325            "the tag must match the daemon's dispatch string exactly"
4326        );
4327        assert_eq!(v["params"]["subject"], "eid:aa");
4328        assert_eq!(v["params"]["subject_binding"], "b64u:bind");
4329        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4330
4331        // The two proof fields are OPTIONAL on the wire and omitted when absent.
4332        let minimal = Request::PeerIntroduce(PeerIntroduceParams {
4333            subject: "eid:aa".into(),
4334            endorsed_by: "b64u:carol".into(),
4335            evidence: "b64u:sig".into(),
4336            subject_user_id: None,
4337            subject_binding: None,
4338            nickname: "bob".into(),
4339        });
4340        let v = serde_json::to_value(&minimal).unwrap();
4341        assert!(v["params"].get("subject_user_id").is_none());
4342        assert!(v["params"].get("subject_binding").is_none());
4343        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), minimal);
4344
4345        let e = Request::PeerEndorse(PeerEndorseParams {
4346            subject: "eid:aa".into(),
4347            subject_user_id: None,
4348        });
4349        let v = serde_json::to_value(&e).unwrap();
4350        assert_eq!(v["method"], "peer_endorse");
4351        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), e);
4352
4353        let res = PeerEndorseResult {
4354            endorsed_by: "b64u:me".into(),
4355            evidence: "b64u:sig".into(),
4356        };
4357        let v = serde_json::to_value(&res).unwrap();
4358        assert_eq!(v["endorsed_by"], "b64u:me");
4359        assert_eq!(serde_json::from_value::<PeerEndorseResult>(v).unwrap(), res);
4360    }
4361
4362    #[test]
4363    fn peer_add_request_roundtrip() {
4364        let r = Request::PeerAdd(PeerAddParams {
4365            nickname: "bob".into(),
4366            endpoint_id: "96246d3f".into(),
4367            allow: vec!["notes".into()],
4368        });
4369        let v = serde_json::to_value(&r).unwrap();
4370        assert_eq!(v["method"], "peer_add");
4371        assert_eq!(v["params"]["nickname"], "bob");
4372        assert_eq!(v["params"]["endpoint_id"], "96246d3f");
4373        assert_eq!(v["params"]["allow"][0], "notes");
4374        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4375        // An absent allow list deserializes to empty (the server-side tolerance).
4376        let p: PeerAddParams =
4377            serde_json::from_value(serde_json::json!({"nickname": "bob", "endpoint_id": "x"}))
4378                .unwrap();
4379        assert!(p.allow.is_empty());
4380    }
4381
4382    #[test]
4383    fn peer_rename_request_roundtrip() {
4384        // By user_id (renames all of a person's devices in one op).
4385        let r = Request::PeerRename(PeerRenameParams {
4386            user_id: Some("b64u:BOB".into()),
4387            nickname: None,
4388            to: "Bobby".into(),
4389        });
4390        let v = serde_json::to_value(&r).unwrap();
4391        assert_eq!(v["method"], "peer_rename");
4392        assert_eq!(v["params"]["user_id"], "b64u:BOB");
4393        assert_eq!(v["params"]["to"], "Bobby");
4394        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4395        // A provisional contact is renamed by nickname; omitted user_id defaults to None.
4396        assert_eq!(
4397            method_of(
4398                &serde_json::json!({"method": "peer_rename", "params": {"nickname": "carol", "to": "Carol"}})
4399            ),
4400            Some("peer_rename")
4401        );
4402    }
4403
4404    #[test]
4405    fn status_result_roundtrips() {
4406        // Pure-pairing daemon: `roster` is None — absent from the wire (skip_serializing_if) and an
4407        // older payload with no `roster` key still deserializes to None (serde default).
4408        let s = StatusResult {
4409            stack_version: "0.1.0".into(),
4410            services: vec![ServiceInfo {
4411                name: "notes".into(),
4412                allow: vec!["alice".into()],
4413                allow_display: vec![],
4414                backend: BackendKind::Run,
4415                ephemeral: false,
4416            }],
4417            peers: vec![PeerInfo {
4418                name: "alice".into(),
4419                services: vec!["notes".into()],
4420                // A paired peer that proved a self-sovereign user_id at pairing (surface-clean id).
4421                user_id: Some("b64u:alicepk".into()),
4422                principal: None,
4423            }],
4424            roster: None,
4425            presence: vec![],
4426            self_user_id: Some("b64u:selfpk".into()),
4427            recent_pairings: vec![],
4428            reachability: vec![],
4429            self_nickname: String::new(),
4430            storage: None,
4431            revoked: Vec::new(),
4432            self_network: None,
4433        };
4434        let v = serde_json::to_value(&s).unwrap();
4435        assert_eq!(v["services"][0]["backend"], "run");
4436        // The additive identity fields ride the wire when present.
4437        assert_eq!(v["peers"][0]["user_id"], "b64u:alicepk");
4438        assert_eq!(v["self_user_id"], "b64u:selfpk");
4439        assert!(
4440            v.get("roster").is_none(),
4441            "an absent roster must not appear on the wire: {v}"
4442        );
4443        assert!(
4444            v.get("presence").is_none(),
4445            "an empty presence must not appear on the wire: {v}"
4446        );
4447        assert!(
4448            v.get("recent_pairings").is_none(),
4449            "an empty recent_pairings must not appear on the wire: {v}"
4450        );
4451        assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4452
4453        // A payload minted by an older daemon (no `roster`/`presence`/identity keys) still
4454        // deserializes — the identity fields default to None / a nickname-only peer.
4455        let old_shape = serde_json::json!({
4456            "stack_version": "0.1.0",
4457            "services": [],
4458            "peers": [{ "name": "bob", "services": [] }],
4459        });
4460        let back: StatusResult = serde_json::from_value(old_shape).unwrap();
4461        assert!(back.roster.is_none());
4462        assert!(back.presence.is_empty());
4463        assert!(back.self_user_id.is_none());
4464        assert!(back.peers[0].user_id.is_none());
4465        assert!(back.recent_pairings.is_empty());
4466
4467        // Roster daemon: a Some(RosterStatus) + an advisory presence list round-trip. `presence`
4468        // carries FLAT vocabulary only (user_id/device_label/role/online) — no EndpointId/key.
4469        let s = StatusResult {
4470            stack_version: "0.1.0".into(),
4471            services: vec![],
4472            peers: vec![],
4473            roster: Some(RosterStatus {
4474                org_id: "acme".into(),
4475                serial: 42,
4476                state: "approved".into(),
4477                org_root_fingerprint: "tango-fig-cabbage-anchor".into(),
4478                groups: vec!["eng".into(), "ops".into()],
4479            }),
4480            presence: vec![
4481                PresencePeer {
4482                    user_id: "alice".into(),
4483                    display_name: "Alice Example".into(),
4484                    groups: vec!["eng".into()],
4485                    device_label: "laptop".into(),
4486                    role: "primary".into(),
4487                    online: true,
4488                    meta: String::new(),
4489                },
4490                PresencePeer {
4491                    user_id: "alice".into(),
4492                    display_name: "Alice Example".into(),
4493                    groups: vec!["eng".into()],
4494                    device_label: "desktop".into(),
4495                    role: "mirror".into(),
4496                    online: false,
4497                    meta: String::new(),
4498                },
4499            ],
4500            self_user_id: None,
4501            recent_pairings: vec![],
4502            reachability: vec![],
4503            self_nickname: String::new(),
4504            storage: None,
4505            revoked: Vec::new(),
4506            self_network: None,
4507        };
4508        let v = serde_json::to_value(&s).unwrap();
4509        assert_eq!(v["roster"]["org_id"], "acme");
4510        assert_eq!(v["roster"]["serial"], 42u64);
4511        assert_eq!(v["roster"]["state"], "approved");
4512        assert_eq!(
4513            v["roster"]["org_root_fingerprint"],
4514            "tango-fig-cabbage-anchor"
4515        );
4516        assert_eq!(v["presence"][0]["user_id"], "alice");
4517        assert_eq!(v["presence"][0]["device_label"], "laptop");
4518        assert_eq!(v["presence"][0]["role"], "primary");
4519        assert_eq!(v["presence"][0]["online"], true);
4520        assert_eq!(v["presence"][1]["online"], false);
4521        assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4522    }
4523
4524    /// The `recent_pairings` status field is ADDITIVE: a populated list round-trips with
4525    /// the flat `{peer_nickname, sas_code, paired_at_epoch}` shape (nickname + SAS words + epoch —
4526    /// never an EndpointId), an empty list is dropped from the wire, and a payload minted by an
4527    /// older daemon (no key at all) still deserializes to empty.
4528    #[test]
4529    fn recent_pairings_are_additive_on_status() {
4530        let s = StatusResult {
4531            stack_version: "0.1.0".into(),
4532            services: vec![],
4533            peers: vec![],
4534            roster: None,
4535            presence: vec![],
4536            self_user_id: None,
4537            recent_pairings: vec![RecentPairing {
4538                peer_nickname: "bob".into(),
4539                sas_code: "tango-fig-cabbage".into(),
4540                paired_at_epoch: 1_800_000_000,
4541            }],
4542            reachability: vec![],
4543            self_nickname: String::new(),
4544            storage: None,
4545            revoked: Vec::new(),
4546            self_network: None,
4547        };
4548        let v = serde_json::to_value(&s).unwrap();
4549        assert_eq!(v["recent_pairings"][0]["peer_nickname"], "bob");
4550        assert_eq!(v["recent_pairings"][0]["sas_code"], "tango-fig-cabbage");
4551        assert_eq!(v["recent_pairings"][0]["paired_at_epoch"], 1_800_000_000u64);
4552        assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4553
4554        // A payload minted by an OLDER daemon (no `recent_pairings` key) still deserializes —
4555        // the `#[serde(default)]` fills it with an empty list.
4556        let old_shape = serde_json::json!({
4557            "stack_version": "0.1.0",
4558            "services": [],
4559            "peers": [],
4560        });
4561        let back: StatusResult = serde_json::from_value(old_shape).unwrap();
4562        assert!(back.recent_pairings.is_empty());
4563    }
4564
4565    #[test]
4566    fn blob_requests_and_results_roundtrip() {
4567        // BlobPublish → { method, params: { scope, path } }.
4568        let r = Request::BlobPublish(BlobPublishParams {
4569            scope: "docs".into(),
4570            path: "/tmp/a.bin".into(),
4571        });
4572        let v = serde_json::to_value(&r).unwrap();
4573        assert_eq!(v["method"], "blob_publish");
4574        assert_eq!(v["params"]["scope"], "docs");
4575        assert_eq!(v["params"]["path"], "/tmp/a.bin");
4576        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4577
4578        // BlobGrant → { method, params: { scope, principal } }.
4579        // #62: the two withdrawal verbs' wire tags. A wrong dispatch string or a swapped param
4580        // would otherwise ship undetected — the e2e test calls the provider directly and never
4581        // crosses JSON-RPC.
4582        let rev = Request::BlobRevoke(BlobRevokeParams {
4583            scope: "photos".into(),
4584            principals: vec!["alice".into()],
4585        });
4586        let v = serde_json::to_value(&rev).unwrap();
4587        assert_eq!(v["method"], "blob_revoke");
4588        assert_eq!(v["params"]["principals"][0], "alice");
4589        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), rev);
4590
4591        let unp = Request::BlobUnpublish(BlobUnpublishParams {
4592            scope: "photos".into(),
4593            hash: "abc123".into(),
4594        });
4595        let v = serde_json::to_value(&unp).unwrap();
4596        assert_eq!(v["method"], "blob_unpublish");
4597        assert_eq!(v["params"]["hash"], "abc123");
4598        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), unp);
4599
4600        let r = Request::BlobGrant(BlobGrantParams {
4601            scope: "docs".into(),
4602            principal: "alice".into(),
4603        });
4604        let v = serde_json::to_value(&r).unwrap();
4605        assert_eq!(v["method"], "blob_grant");
4606        assert_eq!(v["params"]["principal"], "alice");
4607        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4608
4609        // BlobList is parameterless (method_of resolves it).
4610        assert_eq!(
4611            method_of(&serde_json::json!({"method": "blob_list"})),
4612            Some("blob_list")
4613        );
4614
4615        // BlobFetch → { method, params: { ticket, dest_path, from? } }.
4616        let r = Request::BlobFetch(BlobFetchParams {
4617            ticket: "blobAAA".into(),
4618            dest_path: "/tmp/out.bin".into(),
4619            from: vec!["eid:aa".into(), "b64u:bb".into()],
4620        });
4621        let v = serde_json::to_value(&r).unwrap();
4622        assert_eq!(v["method"], "blob_fetch");
4623        assert_eq!(v["params"]["ticket"], "blobAAA");
4624        assert_eq!(v["params"]["dest_path"], "/tmp/out.bin");
4625        assert_eq!(
4626            v["params"]["from"][0], "eid:aa",
4627            "#83: the alternate sources must reach the wire IN ORDER — the publisher is tried \
4628             first and these follow, so a reordering changes which source answers"
4629        );
4630        assert_eq!(v["params"]["from"][1], "b64u:bb");
4631        assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4632        // Additive: an older caller omits it, and absent reads as EMPTY — the single-source
4633        // behaviour. A default that invented sources would dial peers the caller never named.
4634        let legacy: BlobFetchParams =
4635            serde_json::from_value(serde_json::json!({"ticket": "x", "dest_path": "/tmp/y"}))
4636                .unwrap();
4637        assert!(legacy.from.is_empty());
4638        // …and an empty list must not bloat the payload.
4639        let quiet = serde_json::to_value(Request::BlobFetch(BlobFetchParams {
4640            ticket: "x".into(),
4641            dest_path: "/tmp/y".into(),
4642            from: vec![],
4643        }))
4644        .unwrap();
4645        assert!(quiet["params"].get("from").is_none());
4646
4647        // BlobPublishResult carries the ticket + hash (blob-reference vocabulary).
4648        let res = BlobPublishResult {
4649            ticket: "blobAAA".into(),
4650            hash: "ab".repeat(32),
4651        };
4652        let v = serde_json::to_value(&res).unwrap();
4653        assert_eq!(v["ticket"], "blobAAA");
4654        assert_eq!(serde_json::from_value::<BlobPublishResult>(v).unwrap(), res);
4655
4656        // BlobScopeList carries flat (name, hashes, grants) — no EndpointId/key leakage.
4657        let res = BlobScopeList {
4658            scopes: vec![ScopeInfo {
4659                name: "docs".into(),
4660                hashes: vec!["ab".repeat(32)],
4661                grants: vec!["alice".into()],
4662                withdrawn: vec![],
4663                hash_count: 1,
4664                grant_count: 1,
4665                withdrawn_count: 0,
4666            }],
4667            total: 1,
4668            truncated: false,
4669        };
4670        let v = serde_json::to_value(&res).unwrap();
4671        assert_eq!(v["scopes"][0]["name"], "docs");
4672        assert_eq!(v["scopes"][0]["grants"][0], "alice");
4673        assert_eq!(serde_json::from_value::<BlobScopeList>(v).unwrap(), res);
4674
4675        // BlobFetchResult carries the verified hash + byte length.
4676        let res = BlobFetchResult {
4677            hash: "ab".repeat(32),
4678            bytes_len: 4194304,
4679        };
4680        let v = serde_json::to_value(&res).unwrap();
4681        assert_eq!(v["bytes_len"], 4194304u64);
4682        assert_eq!(serde_json::from_value::<BlobFetchResult>(v).unwrap(), res);
4683    }
4684
4685    /// The three `subscribe` frame shapes round-trip with the documented `type`-tagged wire form
4686    /// (docs/local-protocol.md "Live event stream"): `snapshot` carries the flat session/reachability
4687    /// lists, `event` delegates through the `Box` so the record's fields sit VERBATIM under
4688    /// `record` (one schema with the JSONL log), and `lagged` carries the dropped count.
4689    #[test]
4690    fn stream_frames_roundtrip_with_the_documented_tags() {
4691        let snap = StreamFrame::Snapshot {
4692            self_network: None,
4693            active_sessions: vec![ActiveSession {
4694                peer: "bob".into(),
4695                service: "notes".into(),
4696                opened_at: 1_751_760_000,
4697                principal: None,
4698            }],
4699            reachability: vec![PeerReachability {
4700                name: "bob".into(),
4701                reachable: true,
4702                rtt_ms: Some(42),
4703                age_secs: Some(3),
4704                meta: String::new(),
4705                principal: None,
4706                path: Default::default(),
4707            }],
4708        };
4709        let v = serde_json::to_value(&snap).unwrap();
4710        assert_eq!(v["type"], "snapshot");
4711        assert_eq!(v["active_sessions"][0]["peer"], "bob");
4712        assert_eq!(v["active_sessions"][0]["opened_at"], 1_751_760_000i64);
4713        assert_eq!(v["reachability"][0]["name"], "bob");
4714        assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), snap);
4715
4716        let event = StreamFrame::Event {
4717            record: Box::new(AuditRecord::session_open(
4718                "2026-07-03T14:02:11.480Z".into(),
4719                Some("bob".into()),
4720                "notes".into(),
4721                None,
4722            )),
4723        };
4724        let v = serde_json::to_value(&event).unwrap();
4725        assert_eq!(v["type"], "event");
4726        // The record's fields ride verbatim under `record` — no Box indirection on the wire.
4727        assert_eq!(v["record"]["kind"], "session_open");
4728        assert_eq!(v["record"]["peer"], "bob");
4729        assert_eq!(v["record"]["service"], "notes");
4730        assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), event);
4731
4732        // #167 ask 2: the resume frame's wire shape. A consumer dispatches on `type`, so the tag
4733        // is part of the contract, and `at_epoch` is signed on purpose — the wire carries epoch
4734        // seconds as i64 everywhere else in this file.
4735        let resumed = StreamFrame::Resumed {
4736            suspended_secs: 7200,
4737            at_epoch: 1_700_007_202,
4738        };
4739        let v = serde_json::to_value(&resumed).unwrap();
4740        assert_eq!(
4741            v,
4742            serde_json::json!({
4743                "type": "resumed",
4744                "suspended_secs": 7200,
4745                "at_epoch": 1_700_007_202i64,
4746            })
4747        );
4748        assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), resumed);
4749
4750        let lagged = StreamFrame::Lagged { dropped: 12 };
4751        let v = serde_json::to_value(&lagged).unwrap();
4752        assert_eq!(v, serde_json::json!({ "type": "lagged", "dropped": 12 }));
4753        assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), lagged);
4754    }
4755
4756    /// A frame minted by a NEWER daemon (an unknown `type`) fails to deserialize rather than
4757    /// mis-parsing — the typed stream surface is closed; a forward-compatible consumer reads the
4758    /// raw `Value` stream instead (`ControlClient::open_stream`).
4759    #[test]
4760    fn unknown_stream_frame_type_is_rejected() {
4761        let future = serde_json::json!({ "type": "future_kind", "x": 1 });
4762        assert!(serde_json::from_value::<StreamFrame>(future).is_err());
4763    }
4764
4765    #[test]
4766    fn audit_summary_request_and_result_roundtrip() {
4767        // Request::AuditSummary is parameterless → `{ "method": "audit_summary" }`. Like Status, it
4768        // tolerates omitted/null params; the server dispatches on the method string (method_of).
4769        let r = Request::AuditSummary;
4770        assert_eq!(serde_json::to_value(&r).unwrap()["method"], "audit_summary");
4771        assert_eq!(
4772            method_of(&serde_json::json!({"method": "audit_summary"})),
4773            Some("audit_summary")
4774        );
4775
4776        // AuditSummaryResult carries LOCAL per-peer / per-service session counts (nicknames + service
4777        // names only — never endpoints/transport terms) + a total. Tuples mirror kb's
4778        // InsightResponse.per_peer_contribution: `["bob", 2]` on the wire.
4779        let res = AuditSummaryResult {
4780            per_peer: vec![("alice".into(), 1), ("bob".into(), 2)],
4781            per_service: vec![("kb".into(), 1), ("notes".into(), 3)],
4782            total_sessions: 4,
4783        };
4784        let v = serde_json::to_value(&res).unwrap();
4785        assert_eq!(v["per_peer"][1][0], "bob");
4786        assert_eq!(v["per_peer"][1][1], 2u64);
4787        assert_eq!(v["per_service"][1][0], "notes");
4788        assert_eq!(v["total_sessions"], 4u64);
4789        assert_eq!(
4790            serde_json::from_value::<AuditSummaryResult>(v).unwrap(),
4791            res
4792        );
4793
4794        // Additive-only: a result minted by an older daemon (no `total_sessions` key) still
4795        // deserializes — the `#[serde(default)]` fills it with 0.
4796        let old_shape = serde_json::json!({ "per_peer": [], "per_service": [] });
4797        let back: AuditSummaryResult = serde_json::from_value(old_shape).unwrap();
4798        assert_eq!(back.total_sessions, 0);
4799        assert!(back.per_peer.is_empty());
4800    }
4801}