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