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