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