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}
299
300/// One reachable roster peer device as reported by `status` (the advisory presence read).
301/// ADVISORY — this is a display convenience, never an authorization surface. Surface-clean:
302/// FLAT vocabulary ONLY — a `user_id`, a human `device_label`, its `role` word, and an `online`
303/// boolean. It carries NO EndpointId / pubkey / hash / ALPN or any transport vocabulary.
304#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
305pub struct PresencePeer {
306 pub user_id: String,
307 pub device_label: String,
308 pub role: String, // "primary" | "mirror" (roster vocabulary)
309 /// Whether the device has a live presence heartbeat (advisory — absence never blocks a dial).
310 pub online: bool,
311 /// The device's OPTIONAL embedder-set app metadata (#39) — an opaque ≤256B blob carried
312 /// (signed) on its presence heartbeat, empty when the device set none. Advisory display
313 /// data; never an authz input. Additive: default + skip-if-empty.
314 #[serde(default, skip_serializing_if = "String::is_empty")]
315 pub meta: String,
316}
317
318/// One recently completed INVITER-side pairing, surfaced by `status` so the inviter's human can
319/// read the short authentication code (SAS) and compare it with the redeemer's out-of-band —
320/// the pairing ceremony is "both humans compare the code": the redeemer sees it in its
321/// [`PairResult`]; this is the inviter's porcelain surface for the same words. DISPLAY-ONLY
322/// ceremony state: held in-memory by the daemon (a small ring), lost on restart, NEVER an
323/// authorization input or trust data. Surface-clean: a nickname + the SAS wordlist words +
324/// an epoch — never an EndpointId.
325#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
326pub struct RecentPairing {
327 /// The peer's nickname as stored by the inviter (its local name for the redeemer).
328 pub peer_nickname: String,
329 /// The display-only SAS words (e.g. `"tango-fig-cabbage"`) — the same code the redeemer's
330 /// `PairResult.sas_code` carried. Never checked programmatically.
331 pub sas_code: String,
332 /// When the pairing completed (epoch seconds) — the porcelain renders a friendly age.
333 pub paired_at_epoch: u64,
334}
335
336#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
337pub struct StatusResult {
338 pub stack_version: String,
339 pub services: Vec<ServiceInfo>,
340 pub peers: Vec<PeerInfo>,
341 /// Roster-mode status, absent in a pure-pairing daemon. Additive:
342 /// `#[serde(default, skip_serializing_if = ...)]` so a daemon/client without it round-trips.
343 #[serde(default, skip_serializing_if = "Option::is_none")]
344 pub roster: Option<RosterStatus>,
345 /// The reachable roster peer devices (the advisory presence read), each with an `online`
346 /// flag. Empty in a pure-pairing daemon / when no roster is installed. Additive:
347 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
348 #[serde(default, skip_serializing_if = "Vec::is_empty")]
349 pub presence: Vec<PresencePeer>,
350 /// THIS daemon's own self-sovereign `user_id` (`b64u:<user_pk>`), if it has a user key (auto-
351 /// minted at boot; shared by pairing AND roster mode). Lets the operator see + share their stable
352 /// identity that multiple devices resolve to. `None` only when no user key exists. Additive:
353 /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so an older payload round-trips.
354 #[serde(default, skip_serializing_if = "Option::is_none")]
355 pub self_user_id: Option<String>,
356 /// Recent INVITER-side pairing completions, newest first (display-only pairing-ceremony aids —
357 /// see [`RecentPairing`]; in-memory on the daemon, cleared by a restart). Empty on a daemon
358 /// that has accepted no pairing since it started. Additive:
359 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
360 #[serde(default, skip_serializing_if = "Vec::is_empty")]
361 pub recent_pairings: Vec<RecentPairing>,
362 /// Advisory reachability of paired peers, from the on-demand probe cache. Empty until the
363 /// first probe completes. Additive: default + skip-if-empty.
364 #[serde(default, skip_serializing_if = "Vec::is_empty")]
365 pub reachability: Vec<PeerReachability>,
366 /// This node's EFFECTIVE self-nickname — what a freshly minted invite would present
367 /// (config `[identity].nickname`, else the hostname, else a fingerprint; live-updated by
368 /// `set_nickname`, #37). Empty only in mesh-less control-only mode. Additive: default +
369 /// skip-if-empty so an older payload round-trips.
370 #[serde(default, skip_serializing_if = "String::is_empty")]
371 pub self_nickname: String,
372 /// On-disk footprint of this node's own state (#88), so an embedder can warn a user before
373 /// ENOSPC rather than after — the audit log's write rate is driven by inbound peer traffic,
374 /// and it shares a filesystem with `state.redb` and the device key. A LIVE read (computed
375 /// per `status` call), not a boot-time snapshot. `None` only in mesh-less control-only mode.
376 /// Additive: default + skip-if-none so an older payload round-trips.
377 #[serde(default, skip_serializing_if = "Option::is_none")]
378 pub storage: Option<StorageInfo>,
379 /// THIS node's own reachability posture (#90) — see [`SelfNetwork`]. Computed live per
380 /// call; `None` in mesh-less control-only mode. Additive: default + skip-if-none.
381 #[serde(default, skip_serializing_if = "Option::is_none")]
382 pub self_network: Option<SelfNetwork>,
383}
384
385/// The `status.self_network` block (#90): THIS node's own reachability posture — the first
386/// question in every "my message never arrived" investigation, previously unanswerable from
387/// either side of the API. Self-facing only: everything here is the node's own information
388/// (relay URLs come from its own config, sanitized; direct addresses already ride its invites).
389///
390/// `online` is iroh's own semantics — a home-relay connection is established. In
391/// `relay_mode = "disabled"` it is ALWAYS `false` with an empty `relays` list: that is a
392/// configuration, not an outage — render it as "LAN-only", never as a health warning.
393///
394/// Additive-only.
395///
396/// **`Default` is `{online: false, relays: []}` — which is exactly the shape above meaning
397/// "deliberately LAN-only" (#148).** The porcelain reads it that way and SUPPRESSES the "no relay
398/// connection" line for it. So a fixture built with `..Default::default()` claims a healthy
399/// LAN-only posture, not an unknown one. There is no third value for a `bool`; the honest way to
400/// say "nobody looked" is `StatusResult.self_network: None`, which is what a defaulted
401/// `StatusResult` gives you.
402#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
403pub struct SelfNetwork {
404 /// A home-relay connection is established (iroh's `online` definition). The signal #53's
405 /// `set_relays` never had: when this goes false on a relay-enabled node, the relay set is
406 /// the thing to look at.
407 pub online: bool,
408 /// The CONNECTED home relay's URL, sanitized to scheme + host + port (operator-supplied
409 /// relay URLs can carry userinfo tokens; `status` output gets screenshotted). `None` when
410 /// no relay is connected.
411 #[serde(default, skip_serializing_if = "Option::is_none")]
412 pub home_relay: Option<String>,
413 /// Every known home relay and its current connection state. Empty when no relays are
414 /// configured, or before the endpoint has selected any.
415 #[serde(default, skip_serializing_if = "Vec::is_empty")]
416 pub relays: Vec<RelayInfo>,
417 /// This endpoint's direct (non-relay) socket addresses — its own dialable coordinates.
418 #[serde(default, skip_serializing_if = "Vec::is_empty")]
419 pub direct_addrs: Vec<String>,
420 /// When the daemon's watcher last observed a TRANSITION (epoch seconds) — a change of
421 /// `online`, `home_relay`, or a relay's connection state; `direct_addrs` drift alone does
422 /// not stamp (nor emit a frame). OMITTED (not `null`) until the first observed transition
423 /// after boot, and from a point-in-time computation with no watcher running.
424 #[serde(default, skip_serializing_if = "Option::is_none")]
425 pub last_change_epoch: Option<i64>,
426 /// When the relay last reported that ANOTHER endpoint is presenting this node's identity
427 /// (#134, epoch seconds), or absent if never — the overwhelmingly common case.
428 ///
429 /// Two nodes booted from COPIES of one mesh root share an endpoint id. The relay can serve only
430 /// one, so the displaced node's peers simply go unreachable with nothing saying why; diagnosing
431 /// that cost a downstream real time. This is that missing "why".
432 ///
433 /// **Sticky, and a timestamp rather than a flag.** The condition is announced once, as the
434 /// displaced connection is dropped — it is not a state the relay keeps reporting — so a
435 /// self-clearing flag would read false by the time anyone called `status`. Judge staleness from
436 /// the epoch, exactly as with `last_change_epoch`.
437 ///
438 /// **Absence is not proof of uniqueness.** Detection needs an
439 /// `IdentityConflictLayer` in the process's `tracing` subscriber: the standalone daemon
440 /// installs one at boot, but an EMBEDDED node cannot (a subscriber is global and the host owns
441 /// it) and reports `None` until the host installs it. Never render absence as "identity
442 /// verified unique".
443 ///
444 /// Additive: `#[serde(default, skip_serializing_if = "Option::is_none")]`. `api_minor >= 32`.
445 #[serde(default, skip_serializing_if = "Option::is_none")]
446 pub identity_conflict_epoch: Option<i64>,
447}
448
449/// One home relay's connection state (#90). No latency — per-relay RTT needs iroh's
450/// `net_report`, which is unstable-feature-gated as of 1.0.3; `connected` is the stable truth.
451#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
452pub struct RelayInfo {
453 /// Sanitized (scheme + host + port), like `home_relay`.
454 pub url: String,
455 pub connected: bool,
456}
457
458/// The `status.storage` block (#88): bytes actually on disk, by subsystem. Counts, never
459/// content. Additive-only.
460///
461/// **`Default` is all zeros, which reads as "measured, and found empty" (#148).** It is here so a
462/// fixture can build one field and elide the rest; it is not a way to say "unmeasured". For that,
463/// leave `StatusResult.storage` as `None` — a defaulted `StatusResult` does exactly that.
464#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
465pub struct StorageInfo {
466 /// Summed sizes of the monthly audit files (`<state>/audit/*.jsonl`).
467 pub audit_bytes: u64,
468 /// Size of the peer/trust state store (`state.redb`).
469 pub redb_bytes: u64,
470 /// Total size under the app-blob store directory; 0 when no blob store exists.
471 pub blobs_bytes: u64,
472}
473
474/// Params of [`Request::RegisterService`]: the `[services.*]` entry to write/update.
475#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
476#[serde(deny_unknown_fields)]
477pub struct RegisterServiceParams {
478 pub name: String,
479 pub backend: BackendSpec,
480 pub allow: Vec<String>,
481 /// When true (#36), the registration is EPHEMERAL: kept in daemon memory only, never written
482 /// to the on-disk config, and automatically unregistered when the control connection that
483 /// registered it closes (and gone on daemon restart). For an embedder that serves a
484 /// `socket` backend from a fresh path each run, this removes the need to derive a stable
485 /// socket path solely to keep a persisted registration valid, and the stale-registration
486 /// accumulation that comes with no unregister. Default false = the persistent behavior.
487 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
488 pub ephemeral: bool,
489}
490
491/// Params of [`Request::Invite`]: the services the minted invite grants. Rejects unknown
492/// fields (so `{service: "kb"}` — a singular typo — is a loud error, not a silently
493/// grants-nothing invite), and the daemon additionally rejects an empty/absent `services`
494/// list (an invite that grants nothing is useless — #34).
495#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
496#[serde(deny_unknown_fields)]
497pub struct InviteParams {
498 #[serde(default)]
499 pub services: Vec<String>,
500 /// An OPAQUE, caller-chosen label carried through to the redeemer in the `pair` result (#31).
501 /// mcpmesh never interprets it (not a nickname, never resolved or authorized) — a per-pairing
502 /// metadata slot for the embedder (e.g. its own URN). Capped at the daemon; omit for none.
503 #[serde(default, skip_serializing_if = "Option::is_none")]
504 pub app_label: Option<String>,
505}
506
507/// Params of [`Request::Pair`]: the copyable `mcpmesh-invite:` line. Defaultable — an
508/// absent field reads as an empty line, which simply fails to decode (a clean pair error).
509#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
510#[serde(deny_unknown_fields)]
511pub struct PairParams {
512 #[serde(default)]
513 pub invite_line: String,
514}
515
516/// Params of [`Request::PeerRemove`]: the nickname to unpair.
517#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
518#[serde(deny_unknown_fields)]
519pub struct PeerRemoveParams {
520 pub nickname: String,
521}
522
523/// Params of [`Request::PeerRename`]: the contact to rename — every device sharing `user_id`
524/// when given, else the single provisional `nickname` entry — and the new nickname `to`.
525#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
526#[serde(deny_unknown_fields)]
527pub struct PeerRenameParams {
528 #[serde(default)]
529 pub user_id: Option<String>,
530 #[serde(default)]
531 pub nickname: Option<String>,
532 pub to: String,
533}
534
535/// Params of [`Request::PeerAdd`] (reserved/internal — see the variant): a raw `endpoint_id`
536/// (iroh base32) plus the nickname and service allow list to install it under.
537#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
538#[serde(deny_unknown_fields)]
539pub struct PeerAddParams {
540 pub nickname: String,
541 pub endpoint_id: String,
542 #[serde(default)]
543 pub allow: Vec<String>,
544}
545
546/// Params of [`Request::OpenSession`]: the `peer/service` target to dial. Both fields are
547/// defaultable — an empty target simply fails the dial (a clean `-32055` error).
548#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
549#[serde(deny_unknown_fields)]
550pub struct OpenSessionParams {
551 #[serde(default)]
552 pub peer: String,
553 #[serde(default)]
554 pub service: String,
555}
556
557/// Params of [`Request::RosterInstall`]: the LOCAL roster file `path`, plus the org-root pin
558/// on FIRST install (`b64u:`; omit once pinned — config carries it).
559#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
560#[serde(deny_unknown_fields)]
561pub struct RosterInstallParams {
562 pub path: String,
563 #[serde(default, skip_serializing_if = "Option::is_none")]
564 pub org_root_pk: Option<String>,
565}
566
567/// Params of [`Request::OrgJoin`]: the `[identity]` pin. `user_key` is a LOCAL path — the key
568/// never crosses the API.
569#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
570#[serde(deny_unknown_fields)]
571pub struct OrgJoinParams {
572 pub org_id: String,
573 pub org_root_pk: String,
574 pub user_id: String,
575 pub user_key: String,
576}
577
578/// Params of [`Request::SetAppMetadata`]: this node's opaque app-metadata blob (#39). The
579/// daemon NEVER interprets it — the embedder structures its own bytes (a version string,
580/// small JSON, …). Capped at 256 bytes; `""` clears it. Roster-mode only (it rides the
581/// signed presence heartbeat); a pure-pairing daemon accepts + stores it but never gossips it.
582#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
583#[serde(deny_unknown_fields)]
584pub struct SetAppMetadataParams {
585 pub metadata: String,
586}
587
588/// Params of [`Request::PeerServices`] (#52): the peer to query — a nickname, an `eid:` device
589/// principal, or a `b64u:` user_id.
590#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
591#[serde(deny_unknown_fields)]
592pub struct PeerServicesParams {
593 pub peer: String,
594}
595
596/// Result of [`Request::PeerServices`] (#52): the services the queried peer CURRENTLY grants the
597/// caller — computed authoritatively on the peer (which owns the truth), always current, only
598/// the caller's own admitted services (never the peer's full registry).
599#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
600pub struct PeerServicesResult {
601 pub services: Vec<String>,
602}
603
604/// Params of [`Request::UnregisterService`] (#50): the persistent (or ephemeral) service name
605/// to remove — the deregistration mirror of `register_service`.
606#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
607#[serde(deny_unknown_fields)]
608pub struct UnregisterServiceParams {
609 pub name: String,
610}
611
612/// Params of [`Request::ServiceAllowGrant`] / [`Request::ServiceAllowRevoke`] (#44): toggle a
613/// single stable `principal` (`b64u:`/`eid:`) on a single `service`'s allow list, WITHOUT
614/// unpairing. The per-peer "sharing" switch primitive the embedder drives.
615#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
616#[serde(deny_unknown_fields)]
617pub struct ServiceAllowParams {
618 pub service: String,
619 pub principal: String,
620}
621
622/// Params of [`Request::SetNickname`]: this node's new self-nickname (#37). Display-only
623/// semantics: it names this node in FUTURE invites/presentations; peers keep the nickname
624/// they stored at pairing time until a re-invite.
625#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
626#[serde(deny_unknown_fields)]
627pub struct SetNicknameParams {
628 pub nickname: String,
629}
630
631/// Params of [`Request::SetRosterUrl`]: the HTTPS roster URL to pin.
632#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
633#[serde(deny_unknown_fields)]
634pub struct SetRosterUrlParams {
635 pub url: String,
636}
637
638/// Params of [`Request::SetRelays`] (#53): the node's desired CUSTOM relay set. Declarative —
639/// "make the custom relay set exactly this" — applied as a live insert/remove diff against the
640/// running endpoint (iroh 1.0.3 `Endpoint::insert_relay`/`remove_relay`) when the node is already
641/// in `relay_mode = "custom"`, then persisted to `[network]`. Each entry must parse as an iroh
642/// `RelayUrl`; an empty list is rejected (custom mode requires ≥1 relay — fully disabling relays
643/// is a `relay_mode = "disabled"` restart, not this verb). Switching a node that is currently
644/// `default`/`disabled` onto custom persists the config but needs a restart to take effect (iroh
645/// cannot live-transition the relay MODE) — signalled by [`SetRelaysResult::restart_required`].
646#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
647#[serde(deny_unknown_fields)]
648pub struct SetRelaysParams {
649 pub relay_urls: Vec<String>,
650}
651
652/// Result of [`Request::SetRelays`] (#53).
653#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
654pub struct SetRelaysResult {
655 /// The persisted `relay_urls` differed from the prior config (a no-op edit → `false`).
656 pub changed: bool,
657 /// `true` iff the node's current `relay_mode` is not `custom`, so the new set was persisted
658 /// but NOT applied live — a node restart is required for it to take effect. `false` on the
659 /// live custom→custom path (already applied to the running endpoint).
660 pub restart_required: bool,
661}
662
663/// Params of [`Request::BlobPublish`]: the scope to publish into and the LOCAL file to add.
664#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
665#[serde(deny_unknown_fields)]
666pub struct BlobPublishParams {
667 pub scope: String,
668 pub path: String,
669}
670
671/// Params of [`Request::BlobGrant`]: the scope and the flat-namespace principal to grant it to.
672#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
673#[serde(deny_unknown_fields)]
674pub struct BlobGrantParams {
675 pub scope: String,
676 pub principal: String,
677}
678
679/// Params of [`Request::BlobRevoke`] (#62): the scope and the principals to withdraw from it.
680///
681/// SCOPED, unlike unpair hygiene: only the named scope's grants change. A principal that also holds
682/// grants on other scopes keeps them — withdrawing access to one thing must not silently withdraw
683/// access to everything else.
684#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
685#[serde(deny_unknown_fields)]
686pub struct BlobRevokeParams {
687 pub scope: String,
688 pub principals: Vec<String>,
689}
690
691/// Params of [`Request::BlobUnpublish`] (#62): the scope and the blake3 hex to remove from it.
692///
693/// Removes REACHABILITY, not bytes. The scope gate requires a hash to be listed in some scope, so
694/// this takes effect immediately for authorization — but the bytes stay in the local store, and
695/// there is no reclaim verb yet. Do not surface this to a user as deletion.
696#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
697#[serde(deny_unknown_fields)]
698pub struct BlobUnpublishParams {
699 pub scope: String,
700 pub hash: String,
701}
702
703/// Params of [`Request::BlobRepublish`] (#83): the scope and the blake3 hex to add to it.
704///
705/// The blob must already be held COMPLETE by this daemon — republish makes a fetched blob servable
706/// FROM this node, it does not fetch. A hash that is absent, or only partially present from an
707/// interrupted fetch, is refused with [`ERR_NO_SUCH_BLOB`]: advertising bytes we cannot serve would
708/// turn the original publisher going offline into a hang at every fetcher.
709///
710/// It grants NOBODY. The republisher names a scope they already control; inheriting the original
711/// publisher's grants would be a silent authorization transfer. Share with `blob_grant`.
712#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
713#[serde(deny_unknown_fields)]
714pub struct BlobRepublishParams {
715 pub scope: String,
716 pub hash: String,
717}
718
719/// Params of [`Request::BlobFetch`]: the `mcpmesh/blob/1` ticket and the LOCAL export path.
720#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
721#[serde(deny_unknown_fields)]
722pub struct BlobFetchParams {
723 pub ticket: String,
724 pub dest_path: String,
725}
726
727/// Control-API requests. Serialized as `{ "method": "...", "params": {...} }`
728/// (JSON-RPC-shaped; the id/jsonrpc envelope is added by the transport layer).
729///
730/// Each param-carrying variant wraps its named `*Params` struct — the ONE wire truth for that
731/// method's params, shared by clients (which serialize whole `Request`s) and the daemon (which
732/// deserializes `params` into the same struct after its method-string dispatch). Adjacent
733/// tagging serializes a newtype variant's content as the struct's fields, so the wire shape is
734/// identical to inline variant bodies.
735///
736/// **Servers dispatch on the `method` string and deserialize `params` per-method** — tolerating
737/// omitted / null / empty-object params for parameterless methods — rather than deserializing a
738/// whole message into `Request` (adjacent tagging rejects `params:{}` for unit variants).
739/// This keeps the wire tolerant for third-party clients (the versioned, additive-only surface).
740/// Use [`method_of`] to extract the tag, then match + deserialize `params` per-method.
741#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
742#[serde(tag = "method", content = "params", rename_all = "snake_case")]
743pub enum Request {
744 /// Register/update a `[services.*]` entry idempotently.
745 RegisterService(RegisterServiceParams),
746 Status,
747 /// Mint a one-time pairing invite granting `services`. The daemon
748 /// answers an [`InviteResult`] carrying the copyable `mcpmesh-invite:` line. Tag
749 /// `"invite"` (snake_case). `method_of` needs no per-variant arm — it reads the
750 /// `method` string generically; the tag comes from `rename_all`.
751 Invite(InviteParams),
752 /// Redeem a pairing invite. The daemon dials the inviter named by
753 /// `invite_line` on `mcpmesh/pair/1`, proves the secret, writes the mutual
754 /// (dial-back) `PeerEntry`, and answers a [`PairResult`]. Tag `"pair"`
755 /// (snake_case); `method_of` reads the `method` string generically.
756 ///
757 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
758 Pair(PairParams),
759 /// Remove a paired peer by nickname (`mcpmesh pair --remove`). The daemon drops the
760 /// peer's `PeerEntry` (identity) AND revokes its access by stripping its stable principals from every
761 /// `[services.*].allow` (authorization) — the inverse of the pairing grant. Idempotent: a
762 /// nickname with no entry / no allow membership is a clean no-op. Live in-flight sessions are
763 /// NOT severed here: existing sessions run to completion; the peer only loses the
764 /// ability to establish NEW authorized sessions. Tag `"peer_remove"` (snake_case);
765 /// `method_of` reads the `method` string generically (no per-variant arm).
766 ///
767 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
768 PeerRemove(PeerRemoveParams),
769 /// Rename a contact's nickname (nickname) authoritatively. Renames the
770 /// PERSON — every `PeerEntry` sharing `user_id` when given (one op for all their devices), else the
771 /// single `nickname` entry (a provisional, no-`user_id` contact) — to `to`, AND rewrites the old
772 /// nickname → `to` in every `[services.*].allow` so grants follow the rename. Refuses (error frame)
773 /// when `to` is empty or already names/grants a DIFFERENT identity — the same collision guard the
774 /// pairing rendezvous uses, so a rename can't inherit another peer's access. Tag `"peer_rename"`;
775 /// host-privileged like the other pair ops.
776 PeerRename(PeerRenameParams),
777 /// RESERVED / INTERNAL (`docs/local-protocol.md` "Reserved / internal methods"): install a
778 /// peer directly from a raw `endpoint_id` — the trust-population stand-in for pairing behind
779 /// `mcpmesh internal peer add`. A deliberate, documented exception to the surface discipline
780 /// (raw endpoint identifiers otherwise never cross this socket); NOT part of the stable
781 /// vocabulary — do not build on it. Tag `"peer_add"`.
782 PeerAdd(PeerAddParams),
783 /// Open a mesh session to `peer/service`; the daemon dials and pipes.
784 /// Distinct from the proxy's job: this returns a session the client streams.
785 /// Named `open_session` rather than `connect` to avoid colliding
786 /// with the `connect` porcelain.
787 OpenSession(OpenSessionParams),
788 /// Install a signed roster from a local file (the manual `internal roster install` path).
789 /// `path` is a LOCAL file the same-uid daemon reads (the daemon runs as the caller's own
790 /// uid, so passing a path rather than the bytes crosses no trust boundary). `org_root_pk`
791 /// pins the org root on FIRST install (`b64u:`); omit it
792 /// once pinned (config carries it). Tag `"roster_install"`.
793 RosterInstall(RosterInstallParams),
794 /// Pin the org root on a JOINER — WITHOUT a roster (the joiner has none yet; its poll loop
795 /// fetches the first one). Records `[identity]` org_id / org_root_pk / user_id / user_key.
796 /// `user_key` is a LOCAL path
797 /// (the key never crosses the API). Tag `"org_join"`.
798 OrgJoin(OrgJoinParams),
799 /// Pin the HTTPS roster URL (`[roster].url`) in config. Written by `org create
800 /// --roster-url` (the operator keeps it current) AND by `join` when the org invite carries one —
801 /// so the joiner's poll loop bootstraps its FIRST roster. The daemon writes it under
802 /// `reload_lock` (single-writer), then the poll loop picks it up on the next daemon start. Tag
803 /// `"set_roster_url"`.
804 SetRosterUrl(SetRosterUrlParams),
805 /// Rename this node LIVE (#37): validate + upsert `[identity].nickname` through the
806 /// daemon's own serialized config-write path (no lost-update window against a
807 /// concurrent grant/registration) and update the in-memory name future invites
808 /// present — no restart. Ack result. Tag `"set_nickname"` (snake_case).
809 SetNickname(SetNicknameParams),
810 /// Set this node's opaque app-metadata blob (#39): validated (≤256B) and folded, signed,
811 /// into each outgoing presence heartbeat, so paired roster peers see it in their `status`
812 /// presence — no per-peer session. Ack result. Tag `"set_app_metadata"`. In-memory (lost
813 /// on restart; the embedder re-sets on startup).
814 SetAppMetadata(SetAppMetadataParams),
815 /// Set this node's CUSTOM relay set LIVE (#53): validate each URL as an iroh `RelayUrl`, diff
816 /// against the running endpoint's current custom relays and apply the delta via iroh 1.0.3
817 /// `Endpoint::insert_relay`/`remove_relay` (no endpoint rebuild, no dropped sessions), then
818 /// persist `[network] relay_mode="custom" relay_urls=[…]` under `reload_lock`. When the node
819 /// is currently `default`/`disabled`, the config is persisted but the live mode transition
820 /// isn't possible — [`SetRelaysResult::restart_required`] is `true`. Answers a
821 /// [`SetRelaysResult`]. Tag `"set_relays"`.
822 SetRelays(SetRelaysParams),
823 /// Grant a single stable principal access to a single service's allow (#44) — the per-peer
824 /// "sharing on" toggle, idempotent + serialized under the config lock. Ack result.
825 /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
826 /// Removes the whole `[services.<name>]` entry (allow included) + any ephemeral one, then
827 /// hot-reloads. Idempotent. Ack result.
828 UnregisterService(UnregisterServiceParams),
829 /// Discover which services a paired peer CURRENTLY grants the caller (#52) — dials the peer
830 /// and returns the service names whose allow admits the caller's principal. Answers
831 /// [`PeerServicesResult`].
832 PeerServices(PeerServicesParams),
833 ServiceAllowGrant(ServiceAllowParams),
834 /// Revoke a single stable principal from a single service's allow (#44) — "sharing off"
835 /// WITHOUT unpairing (the peer's identity row is untouched; only NEW sessions are refused).
836 /// Idempotent. Ack result.
837 ServiceAllowRevoke(ServiceAllowParams),
838 /// Publish a LOCAL file INTO a scope: the daemon adds the bytes to its gated
839 /// app-blob store and records the hash in `scope`. `path` is a local file the same-uid daemon
840 /// reads. Answers a [`BlobPublishResult`] carrying the `mcpmesh/blob/1` ticket + hash.
841 /// Tag `"blob_publish"`.
842 BlobPublish(BlobPublishParams),
843 /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id, or a
844 /// nickname (the shared `principal_set` expansion). Tag
845 /// `"blob_grant"`.
846 BlobGrant(BlobGrantParams),
847 /// Tag `"blob_revoke"`: withdraw principals from ONE scope's grants (#62).
848 BlobRevoke(BlobRevokeParams),
849 /// Tag `"blob_unpublish"`: remove a hash from ONE scope (#62). Withdraws reachability, not
850 /// bytes.
851 BlobUnpublish(BlobUnpublishParams),
852 /// #83: make a blob this daemon already holds servable from HERE, in a scope it controls.
853 /// Answers a [`BlobPublishResult`] — same shape as `blob_publish`, so a client can treat the
854 /// two interchangeably after a fetch.
855 BlobRepublish(BlobRepublishParams),
856 /// List the daemon's blob scopes (name → hashes + grants). Tag `"blob_list"`.
857 BlobList(BlobListParams),
858 /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified streaming) and export the
859 /// verified blob to `dest_path` (a local file the same-uid daemon writes). Answers a
860 /// [`BlobFetchResult`] with the verified hash + byte length. Tag `"blob_fetch"`.
861 BlobFetch(BlobFetchParams),
862 /// Summarize this node's LOCAL audit log into per-peer / per-service SESSION counts
863 /// (local-only — the daemon reads its OWN audit dir, nothing is transmitted). The host Mesh surface
864 /// renders these as "who serves me / whom I serve / session counts". Parameterless (like `Status`);
865 /// the server dispatches on the `method` string. Tag `"audit_summary"` (snake_case);
866 /// `method_of` reads the `method` string generically (no per-variant arm).
867 AuditSummary,
868 /// Delete audit months strictly older than `before` (#88) — the retention lever the log
869 /// never had. Local-only and owner-only (the control socket is the daemon owner's). Answers
870 /// [`AuditPruneResult`]. Tag `"audit_prune"`.
871 AuditPrune(AuditPruneParams),
872 /// Read this node's LOCAL audit records, filtered and paged (#88) — the "show me everything
873 /// you hold about me" verb. Local-only; nothing is transmitted. Answers
874 /// [`AuditListResult`]. Tag `"audit_list"`.
875 AuditList(AuditListParams),
876 /// Open a live event stream (pairing liveness & health telemetry). Like `open_session`, the
877 /// connection STOPS being request/response after this call and becomes a one-way push stream
878 /// of `StreamFrame`s. Parameterless. Tag `"subscribe"`.
879 Subscribe,
880}
881
882/// Result of [`Request::OrgJoin`] — the pinned org id echoed back (surface-clean; the fingerprint is
883/// computed porcelain-side from the invite's org_root_pk). Additive-only.
884#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
885pub struct OrgJoinResult {
886 pub org_id: String,
887}
888
889/// Result of a [`Request::RosterInstall`] request (the manual install path): the installed roster's
890/// org id + serial (roster-status vocabulary the confirmation line is permitted to render) plus how
891/// many live sessions the install severed. Surface-clean: NO keys / EndpointIds / paths.
892///
893/// Additive-only: any future field MUST land as
894/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
895#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
896pub struct RosterInstallResult {
897 pub org_id: String,
898 pub serial: u64,
899 /// How many live sessions were severed, for the porcelain's confirmation line.
900 #[serde(default)]
901 pub severed: u32,
902}
903
904/// Result of [`Request::BlobPublish`]: the copyable `mcpmesh/blob/1` ticket + the blob's blake3 hash.
905/// A ticket/hash here is blob-reference vocabulary (NOT a transport-vocab leak — the same
906/// carve-out as the pairing invite line). Additive-only.
907#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
908pub struct BlobPublishResult {
909 pub ticket: String,
910 pub hash: String, // bare blake3 hex
911}
912
913/// One scope in a [`BlobScopeList`]: its name + the hashes it contains + the principals it
914/// grants. Flat vocabulary ONLY — no EndpointId/pubkey/ALPN. Additive-only.
915#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
916pub struct ScopeInfo {
917 pub name: String,
918 pub hashes: Vec<String>,
919 pub grants: Vec<String>,
920 /// Hashes deliberately WITHDRAWN from this scope (#107): `blob_unpublish` was called, and
921 /// `blob_republish` of these into THIS scope is refused with [`ERR_BLOB_WITHDRAWN`]. Cleared
922 /// only by a deliberate `blob_publish {scope, path}`. Additive — omitted when empty, so a
923 /// pre-`api_minor` 19 client sees exactly what it saw before.
924 #[serde(default, skip_serializing_if = "Vec::is_empty")]
925 pub withdrawn: Vec<String>,
926 /// Size of `hashes` — always present, even when `counts_only` empties the vector (#84b).
927 #[serde(default)]
928 pub hash_count: usize,
929 /// Size of `grants`.
930 #[serde(default)]
931 pub grant_count: usize,
932 /// Size of `withdrawn`.
933 #[serde(default)]
934 pub withdrawn_count: usize,
935}
936
937/// Params of [`Request::BlobList`] (#84b). ALL optional — `blob_list {}` still works, which
938/// matters because the verb took no params before `api_minor` 20.
939///
940/// A DEFAULT LIMIT applies when `limit` is absent. Deliberate: unpaged, `blob_list` renders every
941/// scope into one frame against the 16 MiB cap; past it the CLIENT rejects the frame as malformed.
942/// The control surface carries no strike bound, so the connection survives — but the caller gets an
943/// opaque failure with no way to page, which is unusable rather than merely large.
944#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
945#[serde(default, deny_unknown_fields)]
946pub struct BlobListParams {
947 /// EXACT scope name, never a prefix.
948 pub scope: Option<String>,
949 /// Only scopes containing this hash; the rendering you send is normalized first.
950 pub hash: Option<String>,
951 pub limit: Option<usize>,
952 pub offset: Option<usize>,
953 /// Omit `hashes`/`grants`/`withdrawn`, keep the counts.
954 pub counts_only: bool,
955}
956
957/// Result of [`Request::BlobList`]: the daemon's scopes. Additive-only.
958#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
959pub struct BlobScopeList {
960 pub scopes: Vec<ScopeInfo>,
961 /// Scopes matching the filter BEFORE `limit`/`offset` (#84b). Without this you cannot tell a
962 /// complete answer from a clipped one.
963 #[serde(default)]
964 pub total: usize,
965 /// True when more scopes matched than were returned. Page with `offset` to see the rest.
966 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
967 pub truncated: bool,
968}
969
970/// Result of [`Request::BlobFetch`]: the verified hash + byte length written to `dest_path`.
971/// Additive-only.
972#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
973pub struct BlobFetchResult {
974 pub hash: String,
975 pub bytes_len: u64,
976}
977
978/// Params of [`Request::AuditPrune`] (#88): delete monthly audit files STRICTLY older than
979/// `before` (that month itself is kept — delete-before, not delete-including). Rejects unknown
980/// fields, and the daemon validates the `YYYY-MM` shape up front: a malformed month errors
981/// loudly instead of string-comparing to nothing and reporting a clean no-op.
982#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
983#[serde(deny_unknown_fields)]
984pub struct AuditPruneParams {
985 /// A zero-padded `YYYY-MM` month key.
986 pub before: String,
987}
988
989/// Result of [`Request::AuditPrune`]: the month keys actually deleted, ascending. Empty when
990/// nothing was older than `before` (idempotent).
991#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
992pub struct AuditPruneResult {
993 pub deleted_months: Vec<String>,
994}
995
996/// Params of [`Request::AuditList`] (#88). All filters optional and AND-combined; every field
997/// absent lists everything (paged). Rejects unknown fields — a typo'd filter that silently
998/// matched everything would let a "what do you hold about X" answer overclaim.
999#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1000#[serde(deny_unknown_fields)]
1001pub struct AuditListParams {
1002 /// Inclusive `YYYY-MM` lower bound — month-file granularity (the rotation unit), so an
1003 /// out-of-range month is skipped without parsing it.
1004 #[serde(default, skip_serializing_if = "Option::is_none")]
1005 pub since: Option<String>,
1006 /// Inclusive `YYYY-MM` upper bound.
1007 #[serde(default, skip_serializing_if = "Option::is_none")]
1008 pub until: Option<String>,
1009 /// One of the wire kind strings (`session_open` / `session_close` / `request` /
1010 /// `blob_fetch` / `trust`). An UNKNOWN string is an error, never silently-all.
1011 #[serde(default, skip_serializing_if = "Option::is_none")]
1012 pub kind: Option<String>,
1013 /// The record's attributed peer nickname.
1014 #[serde(default, skip_serializing_if = "Option::is_none")]
1015 pub peer: Option<String>,
1016 /// Page size, default 500, clamped to 1000 — a month file can be arbitrarily large and the
1017 /// response is ONE JSON frame under the transport's frame cap, so the clamp is load-bearing
1018 /// (the same lesson as `blob_list`'s, minor 20).
1019 #[serde(default, skip_serializing_if = "Option::is_none")]
1020 pub limit: Option<u32>,
1021 /// Records to skip (after filtering), for paging.
1022 #[serde(default, skip_serializing_if = "Option::is_none")]
1023 pub offset: Option<u32>,
1024}
1025
1026/// Result of [`Request::AuditList`]: one page of matching records in chronological order
1027/// (oldest month first, in-file order within a month), plus the TOTAL match count so a caller
1028/// can page without a second counting call. `total` counts ALL matches, not the page.
1029#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1030pub struct AuditListResult {
1031 pub records: Vec<AuditRecord>,
1032 pub total: u64,
1033}
1034
1035/// Result of [`Request::AuditSummary`]: LOCAL per-peer / per-service session counts
1036/// aggregated from this node's OWN audit log — NEVER transmitted (local-only). Surface-clean:
1037/// peer names are nicknames / user_ids (NEVER EndpointIds), service names are the registered
1038/// service names (NEVER transport vocabulary). A "session" is one `SessionOpen` record. `per_peer` /
1039/// `per_service` are sorted ascending by name (deterministic). Tuples mirror kb's
1040/// `InsightResponse::per_peer_contribution` — `["bob", 2]` on the wire.
1041///
1042/// Additive-only: any future field MUST land as
1043/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
1044#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1045pub struct AuditSummaryResult {
1046 /// Sessions opened per peer (nickname). A session with no attributed peer is NOT counted here (no
1047 /// peer to attribute) but IS in `total_sessions`.
1048 pub per_peer: Vec<(String, u64)>,
1049 /// Sessions opened per registered service name.
1050 pub per_service: Vec<(String, u64)>,
1051 /// Total sessions opened (every `SessionOpen` record, including peer-less ones).
1052 #[serde(default)]
1053 pub total_sessions: u64,
1054}
1055
1056/// Result of an [`Request::Invite`] request: the copyable `mcpmesh-invite:` artifact
1057/// (the ONE pairing artifact deliberately carved out of the
1058/// transport-vocabulary blocklist, so this is NOT a transport-vocab leak) plus its
1059/// absolute expiry in epoch seconds (≤ now + 24h).
1060///
1061/// `invite` returns BEFORE any redemption, so the SAS — which is derived from the redeemer's
1062/// endpoint id, unknown until they redeem — cannot appear here. The inviter reads its side of
1063/// the SAS from [`StatusResult::recent_pairings`] once a redemption completes (a `trust`/`pair`
1064/// frame on the live [`StreamFrame`] stream signals that moment). See the "embedding the pairing
1065/// ceremony" note in `docs/local-protocol.md` (#35).
1066///
1067/// Additive-only: any future field MUST land as `#[serde(default, skip_serializing_if = ...)]`
1068/// so older payloads still deserialize.
1069#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1070pub struct InviteResult {
1071 /// The `mcpmesh-invite:<base32>` line, copied out-of-band to the redeemer.
1072 pub invite_line: String,
1073 /// When the invite expires (epoch seconds); the daemon burns it at redemption or expiry.
1074 pub expires_at_epoch: u64,
1075}
1076
1077/// Result of a [`Request::Pair`] request: the inviter's suggested nickname (the
1078/// redeemer's local name for the new peer) plus the display-only short authentication
1079/// code (SAS) — a few words the human reads aloud to a second channel to
1080/// catch a whole-invite forgery / address-swap MITM. The SAS is a pairing-ceremony
1081/// artifact (like the invite line), NOT a transport-vocabulary leak.
1082///
1083/// Additive-only: any future field MUST land as
1084/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
1085#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1086pub struct PairResult {
1087 /// The inviter's suggested nickname (from the invite) — the redeemer's local name for it.
1088 pub peer_nickname: String,
1089 /// The display-only short authentication code (e.g. `"tango-fig-42"`), shown on both
1090 /// sides for the out-of-band human check. Never sent on the wire, never checked
1091 /// programmatically.
1092 pub sas_code: String,
1093 /// The services this pairing granted the redeemer — each mountable as `<peer>/<service>`.
1094 /// Populated from the invite (`invite.services`) by the redeemer-side `redeem_invite`, so
1095 /// the porcelain can print the "You can mount: alice/notes" line without re-decoding the
1096 /// invite. Additive: `#[serde(default, skip_serializing_if = ...)]` so a `PairResult`
1097 /// minted by an older daemon (which omits `services`) still deserializes — to an empty list.
1098 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1099 pub services: Vec<String>,
1100 /// The opaque `app_label` the inviter attached at `invite` time (#31), echoed verbatim — or
1101 /// absent if none was set. mcpmesh never interprets it; the embedder does. Additive.
1102 #[serde(default, skip_serializing_if = "Option::is_none")]
1103 pub app_label: Option<String>,
1104 /// The inviter's proven self-sovereign `user_id` (`b64u:<user_pk>`), when it presented a
1105 /// device→user binding at pairing (#30). This is the STABLE, portable identity the redeemer
1106 /// can align with its own — and the same value it may later pass to `open_session` to dial
1107 /// this peer by identity rather than by local nickname. `None` if the inviter presented no
1108 /// binding (a legacy/keyless peer). Additive.
1109 #[serde(default, skip_serializing_if = "Option::is_none")]
1110 pub peer_user_id: Option<String>,
1111}
1112
1113/// The event class of an [`AuditRecord`] (the four audit event classes). An additive discriminant on
1114/// top of the base record schema: it removes no field and makes the JSONL self-describing so
1115/// a consumer can filter by class without guessing from which optional fields are present.
1116#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1117#[serde(rename_all = "snake_case")]
1118pub enum AuditKind {
1119 /// A mesh session opened (a backend was selected for an authenticated peer).
1120 /// (A `session_open` with `status:"error"` is a synthesized FAILED-dial marker — no backend
1121 /// was reached; it records an attempted-and-failed reach for the telemetry stream.)
1122 SessionOpen,
1123 /// A mesh session closed (the backend returned / the session tore down).
1124 SessionClose,
1125 /// One proxied MCP request line (method + tool NAME + args_hash). NEVER carries raw arguments.
1126 Request,
1127 /// A peer fetched a blob from this node's gated provider (peer + hash + allow/deny).
1128 BlobFetch,
1129 /// A trust mutation (pair, unpair, roster install/swap, revoke).
1130 Trust,
1131}
1132
1133/// One audit record — the union of the event classes, and the `record` payload of a
1134/// [`StreamFrame::Event`]. ONE schema for the on-disk JSONL log and the live stream. Every field
1135/// beyond `ts`/`kind` is optional and elided when absent (`skip_serializing_if`), so each class
1136/// serializes to just its relevant keys (a session record has no `method`; a trust record has no
1137/// `bytes_out`).
1138///
1139/// PRIVACY: the proxied-request record carries `method` + `tool` (NAME only) +
1140/// `args_hash` (`"blake3:<hex>"`), and NEVER the raw arguments, the request/response content, or
1141/// any tool-output bytes — only a `bytes_out` COUNT and a `status`.
1142#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1143pub struct AuditRecord {
1144 /// RFC3339 UTC with millisecond precision, e.g. `"2026-07-03T14:02:11.480Z"`. The `YYYY-MM`
1145 /// prefix also selects the monthly file (the rotation boundary), so it is always present.
1146 pub ts: String,
1147 pub kind: AuditKind,
1148 /// The gate-resolved authenticated peer (attributed by the endpoint_id-keyed trust gate). Absent on
1149 /// local-only events with no remote peer (a manual roster install).
1150 #[serde(skip_serializing_if = "Option::is_none")]
1151 pub peer: Option<String>,
1152 #[serde(skip_serializing_if = "Option::is_none")]
1153 pub service: Option<String>,
1154 #[serde(skip_serializing_if = "Option::is_none")]
1155 pub method: Option<String>,
1156 /// The tool NAME only (never its arguments or output) — e.g. `"read_file"` for a `tools/call`.
1157 #[serde(skip_serializing_if = "Option::is_none")]
1158 pub tool: Option<String>,
1159 /// `"blake3:<hex>"` of the request arguments. The raw arguments are NEVER stored.
1160 #[serde(skip_serializing_if = "Option::is_none")]
1161 pub args_hash: Option<String>,
1162 /// Byte COUNT of the response sent back to the peer — a count, never the content.
1163 #[serde(skip_serializing_if = "Option::is_none")]
1164 pub bytes_out: Option<u64>,
1165 /// `"ok"` / `"error"` (proxied request) or `"ok"` / `"denied"` (blob fetch).
1166 #[serde(skip_serializing_if = "Option::is_none")]
1167 pub status: Option<String>,
1168 #[serde(skip_serializing_if = "Option::is_none")]
1169 pub latency_ms: Option<u64>,
1170 /// Trust-event verb: `"pair"` / `"unpair"` / `"roster_install"` / `"revoke"` (kind == Trust).
1171 #[serde(skip_serializing_if = "Option::is_none")]
1172 pub event: Option<String>,
1173 /// A reference, NEVER content: a blob hash (`BlobFetch`) or a trust-event target such as a
1174 /// nickname or `org/serial` (`Trust`).
1175 #[serde(skip_serializing_if = "Option::is_none")]
1176 pub target: Option<String>,
1177 /// The subject's STABLE principal, from the same gate resolution that produced `peer`
1178 /// (#57, `api_minor >= 29`). `peer` is a display name and collides — two devices under one
1179 /// nickname were indistinguishable in the stream and the on-disk log. Same argument and
1180 /// shape as `PeerInfo` (#41), `PeerReachability` (#42), and `ActiveSession` (#73).
1181 ///
1182 /// TWO NAMESPACES, deliberately: session/request/blob records attribute the DEVICE
1183 /// (`eid:<hex>`, like `ActiveSession` — the exact authenticated endpoint), while the trust
1184 /// `pair` record carries the value the grant appended to the allow (`b64u:<pk>` when the
1185 /// device presented a user binding, else `eid:`, #38). Joining a bound peer's sessions to
1186 /// its allow entry therefore goes through the `status` peers list (which carries BOTH the
1187 /// device principal and the `user_id`), not string equality on this field alone.
1188 ///
1189 /// Deliberately absent on: `unpair` (may tear down several devices — no single subject),
1190 /// `roster_install` (purely local), and the failed-outbound-dial session record (our own
1191 /// dial, not a gate-resolved caller). Absent on every record written before 0.24.0.
1192 #[serde(default, skip_serializing_if = "Option::is_none")]
1193 pub principal: Option<String>,
1194}
1195
1196impl AuditRecord {
1197 fn base(ts: String, kind: AuditKind) -> Self {
1198 Self {
1199 ts,
1200 kind,
1201 peer: None,
1202 service: None,
1203 method: None,
1204 tool: None,
1205 args_hash: None,
1206 bytes_out: None,
1207 status: None,
1208 latency_ms: None,
1209 event: None,
1210 target: None,
1211 principal: None,
1212 }
1213 }
1214
1215 /// `principal` is an EXPLICIT parameter on every constructor (#57, kept from the original
1216 /// #72 design): a builder would let a call site silently omit it and reintroduce the
1217 /// collapsed-identity bug for that one event class. Pass `None` only for the documented
1218 /// no-single-subject records (see the field doc).
1219 pub fn session_open(
1220 ts: String,
1221 peer: Option<String>,
1222 service: String,
1223 principal: Option<String>,
1224 ) -> Self {
1225 let mut r = Self::base(ts, AuditKind::SessionOpen);
1226 r.peer = peer;
1227 r.service = Some(service);
1228 r.principal = principal;
1229 r
1230 }
1231
1232 /// Set the record's `status` (`"ok"`/`"error"`/`"denied"`), returning `self` for chaining.
1233 /// Marks a synthesized failure record — e.g. the `session_open` for a FAILED dial, which
1234 /// reaches no backend and so is never audited by the far side's session guard — without a
1235 /// dedicated constructor. DRY: reuses the existing optional `status` field.
1236 pub fn with_status(mut self, status: &str) -> Self {
1237 self.status = Some(status.into());
1238 self
1239 }
1240
1241 pub fn session_close(
1242 ts: String,
1243 peer: Option<String>,
1244 service: String,
1245 principal: Option<String>,
1246 ) -> Self {
1247 let mut r = Self::base(ts, AuditKind::SessionClose);
1248 r.peer = peer;
1249 r.service = Some(service);
1250 r.principal = principal;
1251 r
1252 }
1253
1254 /// A completed (request→response correlated) proxied line: method + tool NAME + args_hash, plus
1255 /// the response's `bytes_out` COUNT, `status`, and `latency_ms`. PRIVACY: `args_hash` is a digest;
1256 /// no raw arguments, request/response content, or tool-output bytes are ever passed in.
1257 #[allow(clippy::too_many_arguments)]
1258 pub fn proxied_request(
1259 ts: String,
1260 peer: Option<String>,
1261 service: String,
1262 method: String,
1263 tool: Option<String>,
1264 args_hash: String,
1265 bytes_out: u64,
1266 status: String,
1267 latency_ms: u64,
1268 principal: Option<String>,
1269 ) -> Self {
1270 let mut r = Self::base(ts, AuditKind::Request);
1271 r.peer = peer;
1272 r.service = Some(service);
1273 r.method = Some(method);
1274 r.tool = tool;
1275 r.args_hash = Some(args_hash);
1276 r.bytes_out = Some(bytes_out);
1277 r.status = Some(status);
1278 r.latency_ms = Some(latency_ms);
1279 r.principal = principal;
1280 r
1281 }
1282
1283 /// A proxied NOTIFICATION line (no `id`, so no response correlates): method + tool + args_hash,
1284 /// no `bytes_out`/`status`/`latency_ms`. The line is still recorded — every proxied request is audited.
1285 pub fn proxied_notification(
1286 ts: String,
1287 peer: Option<String>,
1288 service: String,
1289 method: String,
1290 tool: Option<String>,
1291 args_hash: String,
1292 principal: Option<String>,
1293 ) -> Self {
1294 let mut r = Self::base(ts, AuditKind::Request);
1295 r.peer = peer;
1296 r.service = Some(service);
1297 r.method = Some(method);
1298 r.tool = tool;
1299 r.args_hash = Some(args_hash);
1300 r.principal = principal;
1301 r
1302 }
1303
1304 pub fn blob_fetch(
1305 ts: String,
1306 peer: Option<String>,
1307 hash: String,
1308 status: String,
1309 principal: Option<String>,
1310 ) -> Self {
1311 let mut r = Self::base(ts, AuditKind::BlobFetch);
1312 r.peer = peer;
1313 r.target = Some(hash);
1314 r.status = Some(status);
1315 r.principal = principal;
1316 r
1317 }
1318
1319 pub fn trust(
1320 ts: String,
1321 event: String,
1322 target: Option<String>,
1323 principal: Option<String>,
1324 ) -> Self {
1325 let mut r = Self::base(ts, AuditKind::Trust);
1326 r.event = Some(event);
1327 r.target = target;
1328 r.principal = principal;
1329 r
1330 }
1331}
1332
1333/// One live mesh session, in a [`StreamFrame::Snapshot`]. Surface-clean: `peer` is the
1334/// user_id-or-nickname the audit records carry, never an endpoint-id. `opened_at` is epoch seconds.
1335#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1336pub struct ActiveSession {
1337 pub peer: String,
1338 pub service: String,
1339 pub opened_at: i64,
1340 /// The caller's STABLE device principal, `eid:<hex>` (#73).
1341 ///
1342 /// `peer` is a display nickname and collides: two devices under one nickname, or two contacts
1343 /// sharing a display name, are indistinguishable in the live-session view. So "who is using my
1344 /// service right now", per-peer session counts, and any UI that lets a user act on a live
1345 /// session (revoke, disconnect, inspect) were all keyed on a collidable string.
1346 ///
1347 /// Same argument and same shape as [`PeerInfo`] (#41) and [`PeerReachability`] (#42).
1348 /// Nicknames NEVER authorize; this is the value to key on.
1349 ///
1350 /// **Snapshot only, for now.** `ActiveSession` appears in [`StreamFrame::Snapshot`] — there is
1351 /// no `active_sessions` on `StatusResult`. A client that keeps its view current by applying
1352 /// subsequent `session_open`/`session_close` events still has a collision problem: those are
1353 /// [`AuditRecord`]s and carry no principal (#57, unmerged). So the snapshot distinguishes two
1354 /// same-nickname devices and the next `session_close` for that nickname does not say which row
1355 /// to drop. Re-subscribe for an authoritative view until #57 lands.
1356 ///
1357 /// Always present for a real row — `Option` only so an older client round-trips. Additive.
1358 #[serde(default, skip_serializing_if = "Option::is_none")]
1359 pub principal: Option<String>,
1360}
1361
1362/// One frame of the [`Request::Subscribe`] stream (pairing liveness & health telemetry). Tagged on
1363/// `type` (snake_case), so a frame is `{"type":"snapshot",...}` / `{"type":"event",...}` /
1364/// `{"type":"lagged",...}`. `Event.record` is the [`AuditRecord`] verbatim, so the stream and the
1365/// on-disk log carry ONE schema. The daemon serializes these; an embedding consumer deserializes
1366/// them (see `docs/local-protocol.md` "Live event stream").
1367/// **`#[non_exhaustive]`**: a future frame kind must not break a downstream `match`. Adding
1368/// `Reachability` in 0.13.0 DID break exhaustive matches — which is why that release is a MINOR,
1369/// per `RELEASING.md`'s pre-1.0 rule that breaking changes bump the minor. Consumers now write a
1370/// `_ =>` arm and later additions are additive for Rust as well as for JSON.
1371#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1372#[serde(tag = "type", rename_all = "snake_case")]
1373#[non_exhaustive]
1374pub enum StreamFrame {
1375 /// The FIRST frame: a point-in-time picture of the mesh (open sessions + paired-peer
1376 /// reachability) so a fresh subscriber renders immediately without replaying history.
1377 Snapshot {
1378 active_sessions: Vec<ActiveSession>,
1379 reachability: Vec<PeerReachability>,
1380 /// THIS node's own reachability posture (#90), so a fresh subscriber renders it without
1381 /// a `status` poll. `None` in mesh-less control-only mode. Additive: default +
1382 /// skip-if-none so an older payload round-trips.
1383 #[serde(default, skip_serializing_if = "Option::is_none")]
1384 self_network: Option<SelfNetwork>,
1385 },
1386 /// A live audit event (session open/close, request, blob fetch, trust) — the tap on the hub.
1387 /// Boxed so this (much larger) variant does not bloat every frame; serde delegates through the
1388 /// `Box`, so the wire shape is the record's fields verbatim.
1389 Event { record: Box<AuditRecord> },
1390 /// A peer's reachability TRANSITIONED (#58): it became reachable, became unreachable, or was
1391 /// probed for the first time. Pushed so an embedder does not have to poll `status` for a live
1392 /// online/offline indicator — and so work queued for an unreachable peer can flush the moment
1393 /// it returns, rather than on the next poll tick.
1394 ///
1395 /// Emitted on a change of `reachable` **or of `path`**. A refresh with the same verdict AND the
1396 /// same path emits nothing, so a peer that stays up does not produce a frame per TTL refresh;
1397 /// `rtt_ms`/`meta`/`services` drift is advisory detail and is not a transition. `age_secs` is
1398 /// `0` — the observation just completed.
1399 ///
1400 /// **Do not treat this as an up/down toggle.** It carried that meaning through 0.18, and this
1401 /// doc said "on a CHANGE of `reachable` only" until 1.22 — which stopped being true in 0.19.0
1402 /// (#92 item 1), when `path` joined the transition rule. A consumer that assumed same-verdict
1403 /// frames were impossible was reading a stale guarantee.
1404 ///
1405 /// Two producers, as of API 1.22 — and since 1.30 `source` says WHICH ONE, so the distinction
1406 /// is readable rather than inferred:
1407 ///
1408 /// - [`ReachabilitySource::Probe`] — a probe completing (`status`/`subscribe` refreshing a
1409 /// stale entry). It describes a throwaway dial, not anyone's live connection.
1410 /// - [`ReachabilitySource::Session`] — a live session whose selected path changed under it
1411 /// (#92 item 2). A claim about the link in use.
1412 ///
1413 /// The second producer is why `path` is trustworthy for a long-lived session: a session that
1414 /// degrades Direct→Relay mid-call now says so when it happens, rather than staying silently
1415 /// mislabelled until something probes. `path` is a truth claim about where user data went, so
1416 /// `Unknown` means "we do not know" and must never be rendered as private.
1417 ///
1418 /// **`rtt_ms` is not a discriminator, and never was** (#150). Until 1.30 this doc said a
1419 /// session-sourced frame carries `rtt_ms: None` — true only of a FIRST observation, where no
1420 /// round trip was measured and none is invented. A session-sourced frame for an
1421 /// already-probed peer carries that probe's `rtt_ms: Some(..)`, because the path watcher
1422 /// deliberately leaves `rtt_ms`/`meta`/`probed_at` alone (refreshing them would stamp a stale
1423 /// RTT as fresh and suppress the corrective probe — #92 review). That is the common case for a
1424 /// peer probed at pairing time and then watched through a long call. Read `source`.
1425 Reachability {
1426 peer: PeerReachability,
1427 /// Which producer emitted this frame (#150). `api_minor >= 30`.
1428 ///
1429 /// Additive: `#[serde(default)]`, landing on [`ReachabilitySource::Unknown`] — NOT on
1430 /// `Probe`. A daemon at `api_minor` 22–29 already has both producers, so an absent field
1431 /// genuinely does not say which one ran; defaulting to `Probe` would assert the wrong
1432 /// producer for every session-sourced frame such a daemon emits, which is the exact
1433 /// ambiguity this field exists to remove.
1434 #[serde(default)]
1435 source: ReachabilitySource,
1436 },
1437 /// THIS node's own network posture CHANGED (#90): `online` flipped, the home relay moved,
1438 /// or a relay's connection state changed — pushed so an embedder learns "you just went
1439 /// unreachable" the moment it happens instead of on a poll tick, and so #53's `set_relays`
1440 /// finally has a signal telling someone to use it. `direct_addrs` drift alone does not
1441 /// emit (address churn is chatty and not a decision point; it rides the next frame).
1442 /// `api_minor >= 28`.
1443 SelfNetwork { self_network: SelfNetwork },
1444 /// The subscriber fell `dropped` records behind the broadcast ring; the stream continues (a
1445 /// fresh reconnect would re-`Snapshot`). Never drops the subscriber — lag is reported, never fatal.
1446 Lagged { dropped: u64 },
1447}
1448
1449/// Extract the `method` tag from a raw request value without deserializing the whole
1450/// message. The daemon's dispatcher uses this: match on the method string, then deserialize
1451/// `params` per-method — which tolerates omitted / null / `{}` params for parameterless
1452/// methods (adjacent tagging rejects `params:{}` on unit variants).
1453pub fn method_of(v: &serde_json::Value) -> Option<&str> {
1454 v.get("method").and_then(serde_json::Value::as_str)
1455}
1456
1457/// How a service is answered. Mirrors the config `[services.*]` *kinds*;
1458/// Config→BackendSpec is a hand-written match, not a serde passthrough.
1459#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1460#[serde(rename_all = "snake_case")]
1461pub enum BackendSpec {
1462 Run {
1463 cmd: Vec<String>,
1464 /// Per-service environment variables (#51) for the spawned child. Overlaid on the
1465 /// daemon's inherited env; the injected `MCPMESH_PEER_*` identity vars ALWAYS win over
1466 /// these (identity is not spoofable by a service definition). Default empty.
1467 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
1468 env: BTreeMap<String, String>,
1469 /// Working directory to spawn the child in (#51). Default: inherit the daemon's cwd.
1470 #[serde(default, skip_serializing_if = "Option::is_none")]
1471 cwd: Option<String>,
1472 },
1473 Socket {
1474 path: String,
1475 },
1476}
1477
1478/// Control-API error code: the named service exists in neither `config.toml` nor the ephemeral
1479/// registry (#55). Distinct from the generic `-32000` so a caller can BRANCH on "no such service"
1480/// instead of parsing a message — `service_allow_grant`/`service_allow_revoke` previously answered
1481/// `{}` (success) for an unknown name, which silently included every ephemeral service.
1482pub const ERR_NO_SUCH_SERVICE: i64 = -32040;
1483/// The named blob is not held COMPLETE by this daemon (#83, `blob_republish`). Distinct from
1484/// [`ERR_NO_SUCH_SERVICE`] because the remedy differs: fetch the blob first.
1485pub const ERR_NO_SUCH_BLOB: i64 = -32041;
1486/// The blob was deliberately withdrawn from this scope (#107). Distinct from
1487/// [`ERR_NO_SUCH_BLOB`]: that means "fetch it first", this means "someone un-shared this on
1488/// purpose — `blob_publish` from the file if the re-share is intended".
1489pub const ERR_BLOB_WITHDRAWN: i64 = -32042;
1490/// `pair` was refused because the redeemer's nickname is already held by a DIFFERENT paired peer
1491/// (#87), so an embedder can branch on the one refusal that has a self-service remedy — rename and
1492/// redeem the same invite again — without reading the prose (#147).
1493///
1494/// Reading the prose was the only option before this code, and it does not survive translation: the
1495/// message is generated on the INVITER's side and travels to the redeemer, so the embedder that
1496/// DISPLAYS it cannot rewrite it into its own vocabulary except by substring-matching our copy.
1497/// Branch on this and write your own sentence naming your own rename affordance.
1498///
1499/// Deliberately narrow. It rides ONLY this refusal, which is sent exclusively to a caller that
1500/// proved possession of a live invite secret. The generic refusal keeps `-32000` and its opaque
1501/// reason: distinguishing unknown-vs-expired-vs-wrong-secret would be a redemption oracle.
1502pub const ERR_NICKNAME_TAKEN: i64 = -32043;
1503
1504pub const API_NAME: &str = "mcpmesh-local/1";
1505/// The protocol-compatibility version as `"MAJOR.MINOR"`, distinct from the crate/stack version.
1506///
1507/// - **MAJOR** matches the `/N` in [`API_NAME`] and changes only on a breaking wire change (the
1508/// transport already rejects a mismatched `api`, so an equality check on that is redundant).
1509/// - **MINOR** ([`API_MINOR`]) increments on a surface change within a major — additive fields, new
1510/// methods, or a strictness change like params validation — bumped in the same change that makes
1511/// it. A client can guard with `api_minor >= N` for a feature it needs, or refuse a daemon older
1512/// than a minor it requires. It never resets except on a MAJOR bump.
1513///
1514/// It also bumps for a change to what a field MEANS with no change to its shape — six of the
1515/// thirty have, see [`API_MINOR`]'s history. "Every surface change" is what this line used
1516/// to claim, and it was wrong in both directions: minor 9's entry records surface changes that
1517/// shipped WITHOUT a bump, and six bumps changed no type at all. Read the history, not the rule.
1518pub const API_VERSION: &str = "1.32";
1519/// The integer MINOR of [`API_VERSION`] — see there. Bumped from 0 to 1 when params validation
1520/// became strict (#34); to 2 with the `set_nickname` verb + `StatusResult.self_nickname` (#37);
1521/// to 3 when `allow`/grant strings became STABLE principals — `b64u:`/`eid:`/roster names,
1522/// never nicknames (#38); to 4 with the `set_app_metadata` verb + `PresencePeer.meta` (#39);
1523/// to 5 with `PeerReachability.meta` — pairing-mode app metadata on the probe pong (#40);
1524/// to 6 with `PeerInfo.principal` — the peer's eid: device principal on `status` (#41);
1525/// to 7 with `PeerReachability.principal` — the same on reachability rows (#42); to 8 with the
1526/// `service_allow_grant`/`service_allow_revoke` per-peer access verbs (#44); to 9 covering the
1527/// `unregister_service` (#50) / `peer_services` (#52) / Run `env`+`cwd` (#51) surface that shipped
1528/// in 0.10.1 without a bump, PLUS the `set_relays` live relay-set verb (#53); to 10 when
1529/// `service_allow_revoke`/`peer_remove` became IMMEDIATE — no verb shape changed, but their
1530/// observable contract did: a revoked principal's next session is refused even on a connection it
1531/// already holds, and its live connections are severed. Previously both waited for the peer to
1532/// disconnect on its own, which is unbounded (#54). A consumer can guard on
1533/// `api_minor >= 10` before telling a user that revocation has taken effect; to 11 when
1534/// `service_allow_grant`/`service_allow_revoke` gained EPHEMERAL-service support and became strict
1535/// about an unknown service name — a name in neither the config nor the ephemeral registry now
1536/// answers [`ERR_NO_SUCH_SERVICE`] instead of a silent `{}` (#55, #69); to 12 with the pushed
1537/// [`StreamFrame::Reachability`] liveness transition frame (#58); to 13 with
1538/// [`PeerReachability::path`] — direct-vs-relay attribution on every reachability row (#64); to 14
1539/// with the `run`-backend `MCPMESH_PEER_EID` identity var — the caller's stable device principal,
1540/// unconditionally present, so a `run` server can scope per caller without keying on a nickname
1541/// (#60); to 15 with the `blob_revoke` / `blob_unpublish` verbs — per-scope withdrawal of a grant
1542/// and of a published hash, so un-sharing a file no longer requires unpairing the person (#62); to
1543/// 16 when the app-blob provider became available in PAIRING mode — the blob verbs previously
1544/// errored on any daemon without an org root key, though their scope gate never needed one (#61);
1545/// to 17 when the service answer began coming from the LIVE registry rather than config + overlay,
1546/// so a grant the accept path would refuse is no longer advertised. Three surfaces share that
1547/// resolver and all changed together: `status`'s `services[].allow`, `peer_services`' name list,
1548/// and the `mcpmesh/ping/1` probe's `services`. No wire shape changed, only the source of truth —
1549/// exactly the class of change a downstream cannot see in a type diff (#100); to 18 with `blob_republish`, so a fetched blob can
1550/// be re-served and every recipient becomes a source (#83); to 19 with durable blob revocation — an
1551/// unpublish now survives a later republish via a per-scope withdrawal set, and
1552/// [`ERR_BLOB_WITHDRAWN`] distinguishes "deliberately withdrawn" from "never had it" (#107); to 20
1553/// with `blob_list` filters + paging AND a DEFAULT limit of 256 scopes (the clamp is 4096) — a
1554/// daemon with more scopes than that previously answered with
1555/// everything, and past the 16 MiB frame cap the CLIENT rejected the response as malformed, leaving
1556/// the caller an opaque failure with no way to page. The connection survived: the control surface
1557/// carries no strike bound. This is a behaviour change for existing callers, detectable via the new
1558/// `total`/`truncated` (#84b); to 21 when a
1559/// PATH change became a reachability transition — [`StreamFrame::Reachability`] stopped being an
1560/// up/down toggle and same-verdict frames became possible (#92); to 22 with a SECOND producer for
1561/// that frame: a live per-session watcher that pushes when a session's selected path changes,
1562/// rather than waiting for a probe, at a cadence probes never had (#92); to 23 when
1563/// [`PeerReachability::rtt_ms`] stopped including the path-settle window — a relayed peer could
1564/// previously never report under 600ms, so "relayed AND fast" was unreachable by construction
1565/// (#123); to 24 when `reachable` stopped sharing a deadline with path classification — a relayed
1566/// peer whose pong arrived after ~2.4s was reported OFFLINE while it was answering (#128); to 25
1567/// with [`ActiveSession::principal`] — the live-session view was keyed on a display nickname, so
1568/// two devices under one nickname were indistinguishable and any UI acting on a session (revoke,
1569/// disconnect, inspect) keyed on a collidable string (#73); to 26 when a
1570/// rate-limited inbound NOTIFICATION stopped being silently dropped and became a recorded audit
1571/// event — no type changed; the observable audit stream did (#76, #139); to 27 with the `audit_prune` /
1572/// `audit_list` verbs, `StatusResult::storage`, and the opt-in `[limits].audit_retain_months`
1573/// boot retention — the audit log stopped being a permanent, unbounded, unreadable record (#88);
1574/// to 28 with `StatusResult::self_network` / `StreamFrame::SelfNetwork` / the snapshot's copy —
1575/// the node's OWN reachability posture, previously unanswerable from either side of the API
1576/// (#90); to 29 with [`AuditRecord::principal`] — stable identity on the event stream and the
1577/// on-disk log, resolving #57's parked docs conflict in favour of the #41/#42/#73 line (the
1578/// audit surface bans secrets and raw hex, not the prefixed principal rendering); to 30 with
1579/// [`StreamFrame::Reachability`]'s `source` — the frame has had TWO producers since 22 with no way
1580/// to tell them apart, so an embedder could not distinguish "a throwaway dial went via a relay"
1581/// from "the link this call is on just degraded", and had to hedge every message down to the
1582/// weaker claim. `rtt_ms: None` was never the discriminator the doc implied (#150); to 31 with
1583/// [`ERR_NICKNAME_TAKEN`] — the nickname-collision `pair` refusal is branchable instead of
1584/// `-32000`, so an embedder writes its own recovery copy rather than substring-matching ours. The
1585/// prose changed with it: it named the `set_nickname` CONTROL VERB as the remedy, which a GUI user
1586/// cannot type, and the refusal is generated inviter-side so the embedder displaying it could not
1587/// rewrite it (#147); to 32 with [`SelfNetwork::identity_conflict_epoch`] — two nodes booted from
1588/// COPIES of one mesh root share an endpoint id, and the displaced one's peers went unreachable
1589/// with nothing saying why. The relay reports it and iroh only `warn!`s it, so the fact existed
1590/// and was unreadable (#134).
1591///
1592/// **Not every semantic change gets a minor, and that is the gap to watch (#122).** A minor marks a
1593/// change to this *surface*. A change to behaviour BEHIND the surface — same fields, same shapes,
1594/// different meaning — may not bump it, and is invisible to a type diff. 17 and 24 above happen to
1595/// be that class and did bump; do not infer from them that every such change will. When bumping
1596/// several minors at once, read this block end to end AND the release notes, not the diff.
1597///
1598/// That class is bigger than it looks: **10, 17, 21, 22, 23 and 24 all shipped with no change to
1599/// any type in this file** — they moved meaning, not shape. Six of the thirty. A downstream
1600/// that diffs types across a multi-minor bump sees nothing for any of them.
1601pub const API_MINOR: u32 = 32;
1602
1603#[cfg(test)]
1604mod tests {
1605 use super::*;
1606
1607 /// #64: the path field's wire shape, and its ADDITIVE default. A row from an older daemon has
1608 /// no `path` key at all and must land on `Unknown` — never on `Direct`, which would invent a
1609 /// privacy guarantee that daemon never made.
1610 #[test]
1611 fn peer_path_tags_and_defaults_to_unknown() {
1612 let tagged = |p: PeerPath| serde_json::to_value(p).unwrap();
1613 assert_eq!(tagged(PeerPath::Direct)["kind"], "direct");
1614 assert_eq!(tagged(PeerPath::Unknown)["kind"], "unknown");
1615 let relay = tagged(PeerPath::Relay {
1616 url: Some("https://relay.example/".into()),
1617 });
1618 assert_eq!(relay["kind"], "relay");
1619 assert_eq!(relay["url"], "https://relay.example/");
1620 // A relay whose URL we do not know still tags as relay, with the key elided.
1621 let bare = tagged(PeerPath::Relay { url: None });
1622 assert_eq!(bare["kind"], "relay");
1623 assert!(bare.get("url").is_none(), "elided, not null: {bare}");
1624
1625 // #64 review: a path kind from a NEWER daemon must degrade to Unknown, not fail the whole
1626 // row. Without `#[serde(other)]` an unknown `kind` errors out of
1627 // `PeerReachability` entirely, so one new variant would break every `status` read an
1628 // older pinned client does.
1629 let future: PeerPath =
1630 serde_json::from_value(serde_json::json!({"kind": "quantum", "id": "x"})).unwrap();
1631 assert_eq!(future, PeerPath::Unknown);
1632 let row: PeerReachability = serde_json::from_value(serde_json::json!({
1633 "name": "bob", "reachable": true, "path": {"kind": "quantum"}
1634 }))
1635 .expect("an unknown path kind must not fail the whole row");
1636 assert_eq!(row.path, PeerPath::Unknown);
1637 assert!(row.reachable, "the rest of the row survives");
1638
1639 // A pre-#64 row: no `path` key.
1640 let old = serde_json::json!({"name": "bob", "reachable": true});
1641 let parsed: PeerReachability = serde_json::from_value(old).unwrap();
1642 assert_eq!(
1643 parsed.path,
1644 PeerPath::Unknown,
1645 "an older daemon's row must never imply a direct path"
1646 );
1647 }
1648
1649 /// #58: the pushed liveness frame tags as `{"type":"reachability","peer":{…}}` and carries a
1650 /// whole `PeerReachability` row — the SAME shape the opening snapshot's list holds, so a
1651 /// consumer projects both through one code path.
1652 #[test]
1653 fn reachability_frame_tags_and_round_trips() {
1654 let frame = StreamFrame::Reachability {
1655 peer: PeerReachability {
1656 name: "bob".into(),
1657 reachable: true,
1658 rtt_ms: Some(12),
1659 age_secs: Some(0),
1660 meta: String::new(),
1661 principal: Some("eid:beef".into()),
1662 path: Default::default(),
1663 },
1664 source: ReachabilitySource::Probe,
1665 };
1666 let v = serde_json::to_value(&frame).unwrap();
1667 assert_eq!(v["type"], "reachability");
1668 assert_eq!(v["peer"]["name"], "bob");
1669 assert_eq!(v["peer"]["reachable"], true);
1670 assert_eq!(
1671 v["peer"]["age_secs"], 0,
1672 "a transition frame is fresh by construction: {v}"
1673 );
1674 assert_eq!(v["source"], "probe", "#150: the producer is named: {v}");
1675 let back: StreamFrame = serde_json::from_value(v).unwrap();
1676 assert_eq!(back, frame);
1677 }
1678
1679 /// #150: the frame's `source` wire shape, and the two ways it must degrade.
1680 ///
1681 /// The default is the load-bearing part. An absent key comes from a daemon at `api_minor`
1682 /// 22–29, which ALREADY has both producers — so it must land on `Unknown`, never on `Probe`.
1683 /// Defaulting to `Probe` would tell a consumer "a throwaway dial saw this" about frames that
1684 /// were a live session degrading, which is the ambiguity the field exists to remove.
1685 #[test]
1686 fn reachability_source_tags_and_defaults_to_unknown() {
1687 let tagged = |s: ReachabilitySource| serde_json::to_value(s).unwrap();
1688 assert_eq!(tagged(ReachabilitySource::Probe), "probe");
1689 assert_eq!(tagged(ReachabilitySource::Session), "session");
1690 assert_eq!(tagged(ReachabilitySource::Unknown), "unknown");
1691 for s in [
1692 ReachabilitySource::Probe,
1693 ReachabilitySource::Session,
1694 ReachabilitySource::Unknown,
1695 ] {
1696 let back: ReachabilitySource = serde_json::from_value(tagged(s)).unwrap();
1697 assert_eq!(back, s, "round trip");
1698 }
1699
1700 let peer = serde_json::json!({"name": "bob", "reachable": true});
1701
1702 // A pre-#150 frame: no `source` key at all.
1703 let old: StreamFrame =
1704 serde_json::from_value(serde_json::json!({"type": "reachability", "peer": peer}))
1705 .expect("an older daemon's frame must still parse");
1706 let StreamFrame::Reachability { source, .. } = old else {
1707 panic!("expected a reachability frame");
1708 };
1709 assert_eq!(
1710 source,
1711 ReachabilitySource::Unknown,
1712 "an api_minor 22-29 daemon has BOTH producers, so an absent key must not claim Probe"
1713 );
1714
1715 // A producer from a NEWER daemon must degrade to Unknown, not fail the whole frame — the
1716 // same stake `PeerPath` buys with `#[serde(other)]`. Without the hand-written Deserialize
1717 // a third producer would break every Reachability frame an older pinned client reads.
1718 let future: StreamFrame = serde_json::from_value(
1719 serde_json::json!({"type": "reachability", "peer": peer, "source": "telemetry"}),
1720 )
1721 .expect("an unknown producer must not fail the whole frame");
1722 let StreamFrame::Reachability { source, peer } = future else {
1723 panic!("expected a reachability frame");
1724 };
1725 assert_eq!(source, ReachabilitySource::Unknown);
1726 assert!(peer.reachable, "the rest of the frame survives");
1727 }
1728
1729 /// #148: a defaulted status is EMPTY and honest — the fixture ergonomic an embedder gets in
1730 /// exchange for us adding fields.
1731 ///
1732 /// Its content is the load-bearing part. A downstream test that omits a field must not thereby
1733 /// assert something: no phantom peers or services, and the optional blocks absent rather than
1734 /// zeroed. `storage: Some(StorageInfo::default())` would read as "0 bytes on disk", which is a
1735 /// measurement nobody took.
1736 #[test]
1737 fn a_defaulted_status_is_empty_and_claims_nothing() {
1738 let d = StatusResult::default();
1739 assert!(d.peers.is_empty() && d.services.is_empty(), "{d:?}");
1740 assert!(d.reachability.is_empty() && d.presence.is_empty(), "{d:?}");
1741 assert!(d.recent_pairings.is_empty(), "{d:?}");
1742 assert_eq!(d.roster, None, "no roster is not an empty roster");
1743 assert_eq!(d.storage, None, "absent, not 0 bytes — nobody measured");
1744 assert_eq!(d.self_network, None, "absent, not offline — nobody looked");
1745 assert_eq!(d.self_user_id, None);
1746 assert!(
1747 d.stack_version.is_empty() && d.self_nickname.is_empty(),
1748 "{d:?}"
1749 );
1750
1751 // The pattern the issue actually asks for: additive growth stops breaking fixtures.
1752 let fixture = StatusResult {
1753 peers: vec![PeerInfo {
1754 name: "bob".into(),
1755 ..Default::default()
1756 }],
1757 ..Default::default()
1758 };
1759 assert_eq!(fixture.peers[0].name, "bob");
1760 assert!(fixture.services.is_empty());
1761
1762 // A default round-trips, so the elide-vs-null discipline holds for one too.
1763 let v = serde_json::to_value(&d).unwrap();
1764 assert!(v.get("roster").is_none(), "elided, not null: {v}");
1765 assert!(v.get("storage").is_none(), "elided, not null: {v}");
1766 let back: StatusResult = serde_json::from_value(v).unwrap();
1767 assert_eq!(back, d);
1768 }
1769
1770 /// #148: a defaulted reachability row is NOT reachable and makes NO path claim.
1771 ///
1772 /// This is the one default where a wrong choice would be a false guarantee rather than a
1773 /// harmless placeholder — the same trap `PeerPath`'s `#[default] Unknown` exists to avoid
1774 /// (#64), now reachable through a second door. A fixture that forgot to set `path` must not
1775 /// thereby assert the peer was reached directly, and one that forgot `reachable` must not
1776 /// claim it was up.
1777 #[test]
1778 fn a_defaulted_reachability_row_asserts_nothing_about_the_peer() {
1779 let d = PeerReachability::default();
1780 assert!(!d.reachable, "an unset row must not claim the peer is up");
1781 assert_eq!(
1782 d.path,
1783 PeerPath::Unknown,
1784 "an unset path must never read as Direct — that is a privacy claim no one made"
1785 );
1786 assert_eq!(d.rtt_ms, None, "no measurement was taken");
1787 assert_eq!(d.age_secs, None, "never probed");
1788 assert_eq!(d.principal, None);
1789 assert!(d.name.is_empty() && d.meta.is_empty());
1790 }
1791
1792 /// #148 gate: the REST of the new defaults, which the first pass left entirely unasserted —
1793 /// moving `BackendKind`'s `#[default]` to `Socket` failed nothing across the whole workspace.
1794 ///
1795 /// Each assertion below is the conservative reading of a field that could otherwise let a
1796 /// fixture assert something by omission.
1797 #[test]
1798 fn the_remaining_defaults_are_conservative() {
1799 let s = ServiceInfo::default();
1800 assert!(
1801 s.allow.is_empty(),
1802 "an unset allow must admit NOBODY — empty is deny (the gate's `any()` is false on an \
1803 empty list), and a permissive default here would be an authz hole reachable from a \
1804 fixture"
1805 );
1806 assert!(s.allow_display.is_empty() && s.name.is_empty());
1807 assert!(
1808 !s.ephemeral,
1809 "persistent is the conservative reading, and matches the wire default"
1810 );
1811 assert_eq!(
1812 s.backend,
1813 BackendKind::Run,
1814 "the documented choice — a convenience, not a claim; pinned so it cannot drift \
1815 silently out of step with its own rustdoc"
1816 );
1817 assert_eq!(BackendKind::default(), BackendKind::Run);
1818
1819 let p = PeerInfo::default();
1820 assert!(p.name.is_empty() && p.services.is_empty());
1821 assert_eq!(p.user_id, None, "no identity was proven");
1822 assert_eq!(p.principal, None);
1823
1824 // The gate's finding: this default is the documented "deliberately LAN-only" posture,
1825 // which the porcelain renders as healthy and NOT as a warning. It is unavoidable (a bool
1826 // has no third state) but it must stay deliberate, so it is pinned rather than left to
1827 // be rediscovered by whoever writes the next fixture.
1828 let n = SelfNetwork::default();
1829 assert!(!n.online, "no relay connection is established");
1830 assert!(
1831 n.relays.is_empty() && n.home_relay.is_none(),
1832 "and none are known — which the renderer reads as LAN-BY-CONFIGURATION, not as an \
1833 outage; say 'nobody looked' with StatusResult.self_network: None instead"
1834 );
1835 assert_eq!(n.last_change_epoch, None, "no transition was observed");
1836
1837 let r = RelayInfo::default();
1838 assert!(
1839 !r.connected,
1840 "an unset relay must not claim a live connection"
1841 );
1842
1843 let st = StorageInfo::default();
1844 assert_eq!(
1845 (st.audit_bytes, st.redb_bytes, st.blobs_bytes),
1846 (0, 0, 0),
1847 "zeros read as MEASURED-and-empty; `StatusResult.storage: None` is 'unmeasured'"
1848 );
1849
1850 let ro = RosterStatus::default();
1851 assert!(
1852 ro.state.is_empty(),
1853 "not a valid state word, deliberately — `doctor` warns on an unknown state rather \
1854 than reporting a healthy roster"
1855 );
1856 assert_eq!(ro.serial, 0);
1857
1858 let pp = PresencePeer::default();
1859 assert!(
1860 !pp.online,
1861 "an unset presence row must not claim the device is up"
1862 );
1863 assert!(pp.role.is_empty() && pp.user_id.is_empty());
1864
1865 let rp = RecentPairing::default();
1866 assert_eq!(rp.paired_at_epoch, 0);
1867 assert!(rp.sas_code.is_empty(), "no ceremony produced a code");
1868 }
1869
1870 /// #150 gate: "an unrecognized value reads as `unknown`" must hold for any VALUE, not just an
1871 /// unrecognized string.
1872 ///
1873 /// `#[serde(default)]` covers an absent key and nothing else, so `"source": null` — what a
1874 /// proxy or non-Rust daemon that normalizes optional fields produces — went through the
1875 /// deserializer and failed the WHOLE frame, silently dropping a liveness transition while the
1876 /// protocol doc promised the field could not break a parse. The container shapes matter
1877 /// separately: a visitor that answers without draining a map/seq desynchronizes the parser and
1878 /// fails the frame anyway, which looks identical from outside.
1879 #[test]
1880 fn a_malformed_source_degrades_instead_of_failing_the_frame() {
1881 let peer = serde_json::json!({"name": "bob", "reachable": true});
1882 for bad in [
1883 serde_json::Value::Null,
1884 serde_json::json!(7),
1885 serde_json::json!(-1),
1886 serde_json::json!(1.5),
1887 serde_json::json!(true),
1888 serde_json::json!({"kind": "probe", "nested": {"deep": [1, 2]}}),
1889 serde_json::json!(["probe", "session"]),
1890 ] {
1891 let frame: StreamFrame = serde_json::from_value(
1892 serde_json::json!({"type": "reachability", "peer": peer, "source": bad}),
1893 )
1894 .unwrap_or_else(|e| panic!("`source: {bad}` must not fail the whole frame: {e}"));
1895 let StreamFrame::Reachability { source, peer } = frame else {
1896 panic!("expected a reachability frame");
1897 };
1898 assert_eq!(source, ReachabilitySource::Unknown, "for source: {bad}");
1899 assert!(peer.reachable, "the rest of the frame survives: {bad}");
1900 }
1901 }
1902
1903 /// #90: the self-network frame tags as `{"type":"self_network","self_network":{…}}` — the
1904 /// SAME block `status` and the snapshot carry. Pinned explicitly (like the reachability
1905 /// tag) so a variant rename cannot slip past a suite whose two ends share the type while
1906 /// breaking every doc-following third-party client.
1907 #[test]
1908 fn self_network_frame_tags_and_round_trips() {
1909 let frame = StreamFrame::SelfNetwork {
1910 self_network: SelfNetwork {
1911 online: true,
1912 home_relay: Some("https://relay.example:443".into()),
1913 relays: vec![RelayInfo {
1914 url: "https://relay.example:443".into(),
1915 connected: true,
1916 }],
1917 direct_addrs: vec!["192.168.1.2:4444".into()],
1918 last_change_epoch: Some(1_753_842_000),
1919 identity_conflict_epoch: None,
1920 },
1921 };
1922 let v = serde_json::to_value(&frame).unwrap();
1923 assert_eq!(v["type"], "self_network");
1924 assert_eq!(v["self_network"]["online"], true);
1925 assert_eq!(v["self_network"]["home_relay"], "https://relay.example:443");
1926 assert_eq!(v["self_network"]["relays"][0]["connected"], true);
1927 let back: StreamFrame = serde_json::from_value(v).unwrap();
1928 assert_eq!(back, frame);
1929 }
1930
1931 #[test]
1932 fn peer_reachability_serde_is_additive() {
1933 let r = PeerReachability {
1934 name: "bob".into(),
1935 reachable: true,
1936 rtt_ms: Some(42),
1937 age_secs: Some(3),
1938 meta: String::new(),
1939 principal: None,
1940 path: Default::default(),
1941 };
1942 let v = serde_json::to_value(&r).unwrap();
1943 assert_eq!(v["name"], "bob");
1944 assert_eq!(v["reachable"], true);
1945 assert_eq!(v["rtt_ms"], 42);
1946 assert_eq!(v["age_secs"], 3);
1947 // Never-probed peer: optionals elided, not null.
1948 let unknown = PeerReachability {
1949 name: "carol".into(),
1950 reachable: false,
1951 rtt_ms: None,
1952 age_secs: None,
1953 meta: String::new(),
1954 principal: None,
1955 path: Default::default(),
1956 };
1957 let uv = serde_json::to_value(&unknown).unwrap();
1958 assert!(uv.get("rtt_ms").is_none() && uv.get("age_secs").is_none());
1959 // An older StatusResult (no reachability field) still deserializes.
1960 let old = serde_json::json!({"stack_version":"0.1.0","services":[],"peers":[]});
1961 let s: StatusResult = serde_json::from_value(old).unwrap();
1962 assert!(s.reachability.is_empty());
1963 }
1964
1965 #[test]
1966 fn subscribe_method_tag_resolves() {
1967 let req = serde_json::to_value(Request::Subscribe).unwrap();
1968 assert_eq!(method_of(&req), Some("subscribe"));
1969 }
1970
1971 // --- #34: params structs reject unknown fields (the `{service: "kb"}` silent-accept bug) ---
1972
1973 #[test]
1974 fn invite_params_reject_singular_service_typo() {
1975 // The reported bug: `{"service":"kb"}` (singular) used to deserialize to
1976 // InviteParams { services: [] } and mint a grants-nothing invite that looked
1977 // successful. With deny_unknown_fields the typo is a loud parse error instead.
1978 let err = serde_json::from_value::<InviteParams>(serde_json::json!({"service": "kb"}));
1979 assert!(
1980 err.is_err(),
1981 "an unknown `service` key must be rejected, not silently ignored"
1982 );
1983 // The correct plural shape still parses.
1984 let ok: InviteParams =
1985 serde_json::from_value(serde_json::json!({"services": ["kb"]})).unwrap();
1986 assert_eq!(ok.services, vec!["kb".to_string()]);
1987 }
1988
1989 #[test]
1990 fn open_session_params_reject_unknown_field() {
1991 let err = serde_json::from_value::<OpenSessionParams>(
1992 serde_json::json!({"peer": "a", "service": "b", "nonsense": 1}),
1993 );
1994 assert!(err.is_err(), "unknown params keys must be rejected");
1995 }
1996
1997 #[test]
1998 fn set_app_metadata_request_carries_the_method_tag() {
1999 let r = Request::SetAppMetadata(SetAppMetadataParams {
2000 metadata: "v=1.2.3".into(),
2001 });
2002 let v = serde_json::to_value(&r).unwrap();
2003 assert_eq!(v["method"], "set_app_metadata");
2004 assert_eq!(v["params"]["metadata"], "v=1.2.3");
2005 assert_eq!(method_of(&v), Some("set_app_metadata"));
2006 }
2007
2008 #[test]
2009 fn set_app_metadata_params_reject_unknown_field() {
2010 let err = serde_json::from_value::<SetAppMetadataParams>(
2011 serde_json::json!({"metadata": "x", "nonsense": 1}),
2012 );
2013 assert!(err.is_err(), "unknown params keys must be rejected");
2014 }
2015
2016 /// `PresencePeer.meta` is additive — an older payload (no meta) still deserializes, and an
2017 /// empty meta does not serialize.
2018 #[test]
2019 fn peer_info_principal_is_additive() {
2020 // An older payload (no principal) still deserializes; empty does not serialize.
2021 let old = serde_json::json!({"name": "bob", "services": ["notes"]});
2022 let p: PeerInfo = serde_json::from_value(old).unwrap();
2023 assert_eq!(p.principal, None);
2024 assert!(serde_json::to_value(&p).unwrap().get("principal").is_none());
2025 // A bound peer carries BOTH the person user_id AND the device principal (#41).
2026 let full = PeerInfo {
2027 name: "bob".into(),
2028 services: vec!["notes".into()],
2029 user_id: Some("b64u:BOB".into()),
2030 principal: Some("eid:0707".into()),
2031 };
2032 let back: PeerInfo = serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
2033 assert_eq!(back.user_id.as_deref(), Some("b64u:BOB"));
2034 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
2035 }
2036
2037 #[test]
2038 fn active_session_principal_is_additive() {
2039 // An OLD payload (no `principal`) must still deserialize — #73 is additive.
2040 let old: ActiveSession =
2041 serde_json::from_str(r#"{"peer":"bob","service":"notes","opened_at":7}"#).unwrap();
2042 assert_eq!(old.principal, None, "serde(default) supplies it");
2043
2044 // And a `None` must not serialize, so an old client sees the shape it expects.
2045 let json = serde_json::to_string(&old).unwrap();
2046 assert!(
2047 !json.contains("principal"),
2048 "skip_serializing_if must omit it: {json}"
2049 );
2050
2051 // A real row round-trips the principal.
2052 let new = ActiveSession {
2053 peer: "bob".into(),
2054 service: "notes".into(),
2055 opened_at: 7,
2056 principal: Some("eid:1f0a".into()),
2057 };
2058 let back: ActiveSession =
2059 serde_json::from_str(&serde_json::to_string(&new).unwrap()).unwrap();
2060 assert_eq!(back.principal.as_deref(), Some("eid:1f0a"));
2061 }
2062
2063 #[test]
2064 fn peer_reachability_principal_is_additive() {
2065 // Older payload (no principal) still deserializes; empty does not serialize; a set
2066 // value round-trips alongside the #40 meta so an embedder joins on the principal.
2067 let old = serde_json::json!({"name": "bob", "reachable": true});
2068 let r: PeerReachability = serde_json::from_value(old).unwrap();
2069 assert_eq!(r.principal, None);
2070 assert!(serde_json::to_value(&r).unwrap().get("principal").is_none());
2071 let full = PeerReachability {
2072 name: "bob".into(),
2073 reachable: true,
2074 rtt_ms: Some(12),
2075 age_secs: Some(3),
2076 meta: "v=1.2.3".into(),
2077 principal: Some("eid:0707".into()),
2078 path: Default::default(),
2079 };
2080 let back: PeerReachability =
2081 serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
2082 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
2083 assert_eq!(back.meta, "v=1.2.3");
2084 }
2085
2086 #[test]
2087 fn peer_reachability_meta_is_additive() {
2088 // An older payload (no meta) still deserializes; an empty meta does not serialize.
2089 let old = serde_json::json!({"name": "bob", "reachable": true});
2090 let r: PeerReachability = serde_json::from_value(old).unwrap();
2091 assert_eq!(r.meta, "");
2092 assert!(serde_json::to_value(&r).unwrap().get("meta").is_none());
2093 // A set value round-trips.
2094 let with = PeerReachability {
2095 name: "bob".into(),
2096 reachable: true,
2097 rtt_ms: Some(12),
2098 age_secs: Some(3),
2099 meta: "v=1.2.3".into(),
2100 principal: None,
2101 path: Default::default(),
2102 };
2103 let back: PeerReachability =
2104 serde_json::from_value(serde_json::to_value(&with).unwrap()).unwrap();
2105 assert_eq!(back.meta, "v=1.2.3");
2106 }
2107
2108 #[test]
2109 fn presence_peer_meta_is_additive() {
2110 let old = serde_json::json!({
2111 "user_id": "b64u:A", "device_label": "laptop", "role": "primary", "online": true
2112 });
2113 let p: PresencePeer = serde_json::from_value(old).unwrap();
2114 assert_eq!(p.meta, "");
2115 assert!(serde_json::to_value(&p).unwrap().get("meta").is_none());
2116 }
2117
2118 #[test]
2119 fn set_nickname_request_carries_the_method_tag() {
2120 let r = Request::SetNickname(SetNicknameParams {
2121 nickname: "workbench".into(),
2122 });
2123 let v = serde_json::to_value(&r).unwrap();
2124 assert_eq!(v["method"], "set_nickname");
2125 assert_eq!(v["params"]["nickname"], "workbench");
2126 assert_eq!(method_of(&v), Some("set_nickname"));
2127 }
2128
2129 #[test]
2130 fn set_nickname_params_reject_unknown_field() {
2131 let err = serde_json::from_value::<SetNicknameParams>(
2132 serde_json::json!({"nickname": "x", "nonsense": 1}),
2133 );
2134 assert!(err.is_err(), "unknown params keys must be rejected");
2135 }
2136
2137 /// An OLDER daemon's status payload (no `self_nickname`) must still deserialize —
2138 /// the additive-only contract — and an empty name must not serialize at all.
2139 #[test]
2140 fn status_self_nickname_is_additive() {
2141 let old = serde_json::json!({
2142 "stack_version": "0.7.0", "services": [], "peers": []
2143 });
2144 let s: StatusResult = serde_json::from_value(old).unwrap();
2145 assert_eq!(s.self_nickname, "");
2146 let v = serde_json::to_value(&s).unwrap();
2147 assert!(v.get("self_nickname").is_none(), "empty name is skipped");
2148 }
2149
2150 #[test]
2151 fn api_minor_is_present_and_monotonic_from_hello() {
2152 // #34 part 2: a machine-comparable protocol-compat minor, distinct from the
2153 // crate/stack version, additive on the Hello frame.
2154 let h = Hello {
2155 api: API_NAME.into(),
2156 api_version: API_VERSION.into(),
2157 api_minor: API_MINOR,
2158 stack_version: "9.9.9".into(),
2159 };
2160 let v = serde_json::to_value(&h).unwrap();
2161 assert_eq!(v["api_minor"], API_MINOR);
2162 // An OLD Hello without api_minor still deserializes (additive contract).
2163 let old = serde_json::json!({
2164 "api": API_NAME, "api_version": "1.0", "stack_version": "0.4.0"
2165 });
2166 let back: Hello = serde_json::from_value(old).unwrap();
2167 assert_eq!(back.api_minor, 0, "absent api_minor defaults to 0");
2168 }
2169
2170 #[test]
2171 fn hello_result_roundtrips() {
2172 let h = Hello {
2173 api: "mcpmesh-local/1".into(),
2174 api_version: "1.0".into(),
2175 api_minor: 0,
2176 stack_version: "0.1.0".into(),
2177 };
2178 let v = serde_json::to_value(&h).unwrap();
2179 assert_eq!(v["api"], "mcpmesh-local/1");
2180 let back: Hello = serde_json::from_value(v).unwrap();
2181 assert_eq!(back, h);
2182 }
2183
2184 #[test]
2185 fn request_tagged_by_method() {
2186 let r = Request::Status;
2187 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "status");
2188 let r = Request::OpenSession(OpenSessionParams {
2189 peer: "alice".into(),
2190 service: "notes".into(),
2191 });
2192 let v = serde_json::to_value(&r).unwrap();
2193 assert_eq!(v["method"], "open_session");
2194 assert_eq!(v["params"]["peer"], "alice");
2195 }
2196
2197 #[test]
2198 fn parameterless_method_tolerates_params_forms() {
2199 // Omitted and null params deserialize straight into the unit variant.
2200 let omitted: Request =
2201 serde_json::from_value(serde_json::json!({"method": "status"})).unwrap();
2202 assert_eq!(omitted, Request::Status);
2203 let null: Request =
2204 serde_json::from_value(serde_json::json!({"method": "status", "params": null}))
2205 .unwrap();
2206 assert_eq!(null, Request::Status);
2207
2208 // Known limitation: adjacent tagging rejects `params:{}` for a unit variant, so
2209 // the server MUST dispatch on the method string rather than deserialize the whole
2210 // message into `Request`. This is the pattern the daemon's dispatcher uses.
2211 let empty = serde_json::json!({"method": "status", "params": {}});
2212 assert!(serde_json::from_value::<Request>(empty.clone()).is_err());
2213 match method_of(&empty) {
2214 Some("status") => {} // dispatcher resolves Status via the method string
2215 other => panic!("method_of failed to resolve status: {other:?}"),
2216 }
2217 }
2218
2219 #[test]
2220 fn backend_spec_roundtrips() {
2221 let run = BackendSpec::Run {
2222 cmd: vec!["notes-mcp".into(), "--stdio".into()],
2223 env: Default::default(),
2224 cwd: None,
2225 };
2226 let v = serde_json::to_value(&run).unwrap();
2227 assert_eq!(v["run"]["cmd"][0], "notes-mcp");
2228 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), run);
2229
2230 let sock = BackendSpec::Socket {
2231 path: "/run/notes.sock".into(),
2232 };
2233 let v = serde_json::to_value(&sock).unwrap();
2234 assert_eq!(v["socket"]["path"], "/run/notes.sock");
2235 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), sock);
2236 }
2237
2238 #[test]
2239 fn register_service_wire_shape() {
2240 let r = Request::RegisterService(RegisterServiceParams {
2241 name: "notes".into(),
2242 backend: BackendSpec::Run {
2243 cmd: vec!["notes-mcp".into()],
2244 env: Default::default(),
2245 cwd: None,
2246 },
2247 allow: vec!["alice".into()],
2248 ephemeral: false,
2249 });
2250 let v = serde_json::to_value(&r).unwrap();
2251 assert_eq!(
2252 v,
2253 serde_json::json!({
2254 "method": "register_service",
2255 "params": {
2256 "name": "notes",
2257 "backend": {"run": {"cmd": ["notes-mcp"]}},
2258 "allow": ["alice"],
2259 }
2260 })
2261 );
2262 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2263 }
2264
2265 #[test]
2266 fn invite_request_and_result_roundtrip() {
2267 // Request::Invite → `{ "method": "invite", "params": { "services": [...] } }`.
2268 let r = Request::Invite(InviteParams {
2269 services: vec!["notes".into(), "kb".into()],
2270 app_label: None,
2271 });
2272 let v = serde_json::to_value(&r).unwrap();
2273 assert_eq!(v["method"], "invite");
2274 assert_eq!(v["params"]["services"][0], "notes");
2275 assert_eq!(v["params"]["services"][1], "kb");
2276 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2277 // method_of resolves the tag generically (no per-variant arm).
2278 assert_eq!(
2279 method_of(&serde_json::json!({"method": "invite", "params": {"services": []}})),
2280 Some("invite")
2281 );
2282
2283 // InviteResult carries the copyable line + expiry (surface #2 pairing artifact).
2284 let res = InviteResult {
2285 invite_line: "mcpmesh-invite:ABCDEF".into(),
2286 expires_at_epoch: 1_800_000_000,
2287 };
2288 let v = serde_json::to_value(&res).unwrap();
2289 assert_eq!(v["invite_line"], "mcpmesh-invite:ABCDEF");
2290 assert_eq!(v["expires_at_epoch"], 1_800_000_000u64);
2291 assert_eq!(serde_json::from_value::<InviteResult>(v).unwrap(), res);
2292 }
2293
2294 #[test]
2295 fn pair_request_and_result_roundtrip() {
2296 // Request::Pair → `{ "method": "pair", "params": { "invite_line": "..." } }`.
2297 let r = Request::Pair(PairParams {
2298 invite_line: "mcpmesh-invite:ABCDEF".into(),
2299 });
2300 let v = serde_json::to_value(&r).unwrap();
2301 assert_eq!(v["method"], "pair");
2302 assert_eq!(v["params"]["invite_line"], "mcpmesh-invite:ABCDEF");
2303 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2304 // method_of resolves the tag generically (no per-variant arm).
2305 assert_eq!(
2306 method_of(&serde_json::json!({"method": "pair", "params": {"invite_line": "x"}})),
2307 Some("pair")
2308 );
2309
2310 // PairResult carries the inviter's suggested nickname + the display-only SAS words +
2311 // the granted services (the porcelain renders each as `<peer>/<service>`).
2312 let res = PairResult {
2313 peer_nickname: "alice".into(),
2314 sas_code: "tango-fig-cabbage".into(),
2315 services: vec!["notes".into(), "kb".into()],
2316 app_label: None,
2317 peer_user_id: None,
2318 };
2319 let v = serde_json::to_value(&res).unwrap();
2320 assert_eq!(v["peer_nickname"], "alice");
2321 assert_eq!(v["sas_code"], "tango-fig-cabbage");
2322 assert_eq!(v["services"][0], "notes");
2323 assert_eq!(v["services"][1], "kb");
2324 assert_eq!(serde_json::from_value::<PairResult>(v).unwrap(), res);
2325
2326 // Additive-only: a PairResult minted by an older daemon (no `services` key) still
2327 // deserializes — the `#[serde(default)]` fills it with an empty list.
2328 let old_shape = serde_json::json!({
2329 "peer_nickname": "alice",
2330 "sas_code": "tango-fig-cabbage",
2331 });
2332 let back: PairResult = serde_json::from_value(old_shape).unwrap();
2333 assert_eq!(back.peer_nickname, "alice");
2334 assert!(back.services.is_empty());
2335 }
2336
2337 #[test]
2338 fn roster_install_request_and_result_roundtrip() {
2339 // Request::RosterInstall → `{ "method": "roster_install", "params": { "path": ...,
2340 // "org_root_pk": ... } }`. The optional pk is present on the first-install shape.
2341 let r = Request::RosterInstall(RosterInstallParams {
2342 path: "/tmp/roster.json".into(),
2343 org_root_pk: Some("b64u:AAAA".into()),
2344 });
2345 let v = serde_json::to_value(&r).unwrap();
2346 assert_eq!(v["method"], "roster_install");
2347 assert_eq!(v["params"]["path"], "/tmp/roster.json");
2348 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
2349 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2350 // method_of resolves the tag generically (no per-variant arm).
2351 assert_eq!(
2352 method_of(&serde_json::json!({"method": "roster_install", "params": {"path": "/x"}})),
2353 Some("roster_install")
2354 );
2355
2356 // When the pk is omitted (a subsequent install using the pinned value), it is
2357 // `skip_serializing_if`-dropped from the wire and deserializes back to `None`.
2358 let omit = Request::RosterInstall(RosterInstallParams {
2359 path: "/tmp/roster.json".into(),
2360 org_root_pk: None,
2361 });
2362 let v = serde_json::to_value(&omit).unwrap();
2363 assert!(
2364 v["params"].get("org_root_pk").is_none(),
2365 "an omitted org_root_pk must not appear on the wire: {v}"
2366 );
2367 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), omit);
2368
2369 // RosterInstallResult carries org_id + serial + severed count (roster-status vocabulary).
2370 let res = RosterInstallResult {
2371 org_id: "acme".into(),
2372 serial: 42,
2373 severed: 1,
2374 };
2375 let v = serde_json::to_value(&res).unwrap();
2376 assert_eq!(v["org_id"], "acme");
2377 assert_eq!(v["serial"], 42u64);
2378 assert_eq!(v["severed"], 1u32);
2379 assert_eq!(
2380 serde_json::from_value::<RosterInstallResult>(v).unwrap(),
2381 res
2382 );
2383
2384 // Additive-only: a result minted by an older daemon (no `severed` key) still
2385 // deserializes — the `#[serde(default)]` fills it with 0.
2386 let old_shape = serde_json::json!({ "org_id": "acme", "serial": 7 });
2387 let back: RosterInstallResult = serde_json::from_value(old_shape).unwrap();
2388 assert_eq!(back.serial, 7);
2389 assert_eq!(back.severed, 0);
2390 }
2391
2392 #[test]
2393 fn org_join_request_and_result_roundtrip() {
2394 // Request::OrgJoin → `{ "method": "org_join", "params": { org_id, org_root_pk, user_id,
2395 // user_key } }`. `user_key` is a LOCAL path string (the key never crosses the API).
2396 let r = Request::OrgJoin(OrgJoinParams {
2397 org_id: "acme".into(),
2398 org_root_pk: "b64u:AAAA".into(),
2399 user_id: "alice".into(),
2400 user_key: "/home/alice/.config/mcpmesh/user.key".into(),
2401 });
2402 let v = serde_json::to_value(&r).unwrap();
2403 assert_eq!(v["method"], "org_join");
2404 assert_eq!(v["params"]["org_id"], "acme");
2405 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
2406 assert_eq!(v["params"]["user_id"], "alice");
2407 assert_eq!(
2408 v["params"]["user_key"],
2409 "/home/alice/.config/mcpmesh/user.key"
2410 );
2411 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2412 // method_of resolves the tag generically (no per-variant arm).
2413 assert_eq!(
2414 method_of(&serde_json::json!({"method": "org_join", "params": {"org_id": "x"}})),
2415 Some("org_join")
2416 );
2417
2418 // OrgJoinResult echoes the pinned org id (surface-clean; the fingerprint is porcelain-side).
2419 let res = OrgJoinResult {
2420 org_id: "acme".into(),
2421 };
2422 let v = serde_json::to_value(&res).unwrap();
2423 assert_eq!(v["org_id"], "acme");
2424 assert_eq!(serde_json::from_value::<OrgJoinResult>(v).unwrap(), res);
2425 }
2426
2427 #[test]
2428 fn set_roster_url_request_roundtrip() {
2429 // Request::SetRosterUrl → `{ "method": "set_roster_url", "params": { "url": "..." } }`.
2430 let r = Request::SetRosterUrl(SetRosterUrlParams {
2431 url: "https://intranet.acme.com/roster.json".into(),
2432 });
2433 let v = serde_json::to_value(&r).unwrap();
2434 assert_eq!(v["method"], "set_roster_url");
2435 assert_eq!(v["params"]["url"], "https://intranet.acme.com/roster.json");
2436 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2437 assert_eq!(
2438 method_of(&serde_json::json!({"method": "set_roster_url", "params": {"url": "x"}})),
2439 Some("set_roster_url")
2440 );
2441 }
2442
2443 #[test]
2444 fn peer_remove_request_roundtrip() {
2445 // Request::PeerRemove → `{ "method": "peer_remove", "params": { "nickname": "..." } }`.
2446 let r = Request::PeerRemove(PeerRemoveParams {
2447 nickname: "bob".into(),
2448 });
2449 let v = serde_json::to_value(&r).unwrap();
2450 assert_eq!(v["method"], "peer_remove");
2451 assert_eq!(v["params"]["nickname"], "bob");
2452 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2453 // method_of resolves the tag generically (no per-variant arm).
2454 assert_eq!(
2455 method_of(&serde_json::json!({"method": "peer_remove", "params": {"nickname": "bob"}})),
2456 Some("peer_remove")
2457 );
2458 }
2459
2460 /// The reserved/internal `peer_add` rides the SAME typed vocabulary as every other method —
2461 /// `{ "method": "peer_add", "params": { nickname, endpoint_id, allow } }` — with `allow`
2462 /// defaulting to empty when absent.
2463 #[test]
2464 fn peer_add_request_roundtrip() {
2465 let r = Request::PeerAdd(PeerAddParams {
2466 nickname: "bob".into(),
2467 endpoint_id: "96246d3f".into(),
2468 allow: vec!["notes".into()],
2469 });
2470 let v = serde_json::to_value(&r).unwrap();
2471 assert_eq!(v["method"], "peer_add");
2472 assert_eq!(v["params"]["nickname"], "bob");
2473 assert_eq!(v["params"]["endpoint_id"], "96246d3f");
2474 assert_eq!(v["params"]["allow"][0], "notes");
2475 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2476 // An absent allow list deserializes to empty (the server-side tolerance).
2477 let p: PeerAddParams =
2478 serde_json::from_value(serde_json::json!({"nickname": "bob", "endpoint_id": "x"}))
2479 .unwrap();
2480 assert!(p.allow.is_empty());
2481 }
2482
2483 #[test]
2484 fn peer_rename_request_roundtrip() {
2485 // By user_id (renames all of a person's devices in one op).
2486 let r = Request::PeerRename(PeerRenameParams {
2487 user_id: Some("b64u:BOB".into()),
2488 nickname: None,
2489 to: "Bobby".into(),
2490 });
2491 let v = serde_json::to_value(&r).unwrap();
2492 assert_eq!(v["method"], "peer_rename");
2493 assert_eq!(v["params"]["user_id"], "b64u:BOB");
2494 assert_eq!(v["params"]["to"], "Bobby");
2495 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2496 // A provisional contact is renamed by nickname; omitted user_id defaults to None.
2497 assert_eq!(
2498 method_of(
2499 &serde_json::json!({"method": "peer_rename", "params": {"nickname": "carol", "to": "Carol"}})
2500 ),
2501 Some("peer_rename")
2502 );
2503 }
2504
2505 #[test]
2506 fn status_result_roundtrips() {
2507 // Pure-pairing daemon: `roster` is None — absent from the wire (skip_serializing_if) and an
2508 // older payload with no `roster` key still deserializes to None (serde default).
2509 let s = StatusResult {
2510 stack_version: "0.1.0".into(),
2511 services: vec![ServiceInfo {
2512 name: "notes".into(),
2513 allow: vec!["alice".into()],
2514 allow_display: vec![],
2515 backend: BackendKind::Run,
2516 ephemeral: false,
2517 }],
2518 peers: vec![PeerInfo {
2519 name: "alice".into(),
2520 services: vec!["notes".into()],
2521 // A paired peer that proved a self-sovereign user_id at pairing (surface-clean id).
2522 user_id: Some("b64u:alicepk".into()),
2523 principal: None,
2524 }],
2525 roster: None,
2526 presence: vec![],
2527 self_user_id: Some("b64u:selfpk".into()),
2528 recent_pairings: vec![],
2529 reachability: vec![],
2530 self_nickname: String::new(),
2531 storage: None,
2532 self_network: None,
2533 };
2534 let v = serde_json::to_value(&s).unwrap();
2535 assert_eq!(v["services"][0]["backend"], "run");
2536 // The additive identity fields ride the wire when present.
2537 assert_eq!(v["peers"][0]["user_id"], "b64u:alicepk");
2538 assert_eq!(v["self_user_id"], "b64u:selfpk");
2539 assert!(
2540 v.get("roster").is_none(),
2541 "an absent roster must not appear on the wire: {v}"
2542 );
2543 assert!(
2544 v.get("presence").is_none(),
2545 "an empty presence must not appear on the wire: {v}"
2546 );
2547 assert!(
2548 v.get("recent_pairings").is_none(),
2549 "an empty recent_pairings must not appear on the wire: {v}"
2550 );
2551 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
2552
2553 // A payload minted by an older daemon (no `roster`/`presence`/identity keys) still
2554 // deserializes — the identity fields default to None / a nickname-only peer.
2555 let old_shape = serde_json::json!({
2556 "stack_version": "0.1.0",
2557 "services": [],
2558 "peers": [{ "name": "bob", "services": [] }],
2559 });
2560 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
2561 assert!(back.roster.is_none());
2562 assert!(back.presence.is_empty());
2563 assert!(back.self_user_id.is_none());
2564 assert!(back.peers[0].user_id.is_none());
2565 assert!(back.recent_pairings.is_empty());
2566
2567 // Roster daemon: a Some(RosterStatus) + an advisory presence list round-trip. `presence`
2568 // carries FLAT vocabulary only (user_id/device_label/role/online) — no EndpointId/key.
2569 let s = StatusResult {
2570 stack_version: "0.1.0".into(),
2571 services: vec![],
2572 peers: vec![],
2573 roster: Some(RosterStatus {
2574 org_id: "acme".into(),
2575 serial: 42,
2576 state: "approved".into(),
2577 org_root_fingerprint: "tango-fig-cabbage-anchor".into(),
2578 }),
2579 presence: vec![
2580 PresencePeer {
2581 user_id: "alice".into(),
2582 device_label: "laptop".into(),
2583 role: "primary".into(),
2584 online: true,
2585 meta: String::new(),
2586 },
2587 PresencePeer {
2588 user_id: "alice".into(),
2589 device_label: "desktop".into(),
2590 role: "mirror".into(),
2591 online: false,
2592 meta: String::new(),
2593 },
2594 ],
2595 self_user_id: None,
2596 recent_pairings: vec![],
2597 reachability: vec![],
2598 self_nickname: String::new(),
2599 storage: None,
2600 self_network: None,
2601 };
2602 let v = serde_json::to_value(&s).unwrap();
2603 assert_eq!(v["roster"]["org_id"], "acme");
2604 assert_eq!(v["roster"]["serial"], 42u64);
2605 assert_eq!(v["roster"]["state"], "approved");
2606 assert_eq!(
2607 v["roster"]["org_root_fingerprint"],
2608 "tango-fig-cabbage-anchor"
2609 );
2610 assert_eq!(v["presence"][0]["user_id"], "alice");
2611 assert_eq!(v["presence"][0]["device_label"], "laptop");
2612 assert_eq!(v["presence"][0]["role"], "primary");
2613 assert_eq!(v["presence"][0]["online"], true);
2614 assert_eq!(v["presence"][1]["online"], false);
2615 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
2616 }
2617
2618 /// The `recent_pairings` status field is ADDITIVE: a populated list round-trips with
2619 /// the flat `{peer_nickname, sas_code, paired_at_epoch}` shape (nickname + SAS words + epoch —
2620 /// never an EndpointId), an empty list is dropped from the wire, and a payload minted by an
2621 /// older daemon (no key at all) still deserializes to empty.
2622 #[test]
2623 fn recent_pairings_are_additive_on_status() {
2624 let s = StatusResult {
2625 stack_version: "0.1.0".into(),
2626 services: vec![],
2627 peers: vec![],
2628 roster: None,
2629 presence: vec![],
2630 self_user_id: None,
2631 recent_pairings: vec![RecentPairing {
2632 peer_nickname: "bob".into(),
2633 sas_code: "tango-fig-cabbage".into(),
2634 paired_at_epoch: 1_800_000_000,
2635 }],
2636 reachability: vec![],
2637 self_nickname: String::new(),
2638 storage: None,
2639 self_network: None,
2640 };
2641 let v = serde_json::to_value(&s).unwrap();
2642 assert_eq!(v["recent_pairings"][0]["peer_nickname"], "bob");
2643 assert_eq!(v["recent_pairings"][0]["sas_code"], "tango-fig-cabbage");
2644 assert_eq!(v["recent_pairings"][0]["paired_at_epoch"], 1_800_000_000u64);
2645 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
2646
2647 // A payload minted by an OLDER daemon (no `recent_pairings` key) still deserializes —
2648 // the `#[serde(default)]` fills it with an empty list.
2649 let old_shape = serde_json::json!({
2650 "stack_version": "0.1.0",
2651 "services": [],
2652 "peers": [],
2653 });
2654 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
2655 assert!(back.recent_pairings.is_empty());
2656 }
2657
2658 #[test]
2659 fn blob_requests_and_results_roundtrip() {
2660 // BlobPublish → { method, params: { scope, path } }.
2661 let r = Request::BlobPublish(BlobPublishParams {
2662 scope: "docs".into(),
2663 path: "/tmp/a.bin".into(),
2664 });
2665 let v = serde_json::to_value(&r).unwrap();
2666 assert_eq!(v["method"], "blob_publish");
2667 assert_eq!(v["params"]["scope"], "docs");
2668 assert_eq!(v["params"]["path"], "/tmp/a.bin");
2669 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2670
2671 // BlobGrant → { method, params: { scope, principal } }.
2672 // #62: the two withdrawal verbs' wire tags. A wrong dispatch string or a swapped param
2673 // would otherwise ship undetected — the e2e test calls the provider directly and never
2674 // crosses JSON-RPC.
2675 let rev = Request::BlobRevoke(BlobRevokeParams {
2676 scope: "photos".into(),
2677 principals: vec!["alice".into()],
2678 });
2679 let v = serde_json::to_value(&rev).unwrap();
2680 assert_eq!(v["method"], "blob_revoke");
2681 assert_eq!(v["params"]["principals"][0], "alice");
2682 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), rev);
2683
2684 let unp = Request::BlobUnpublish(BlobUnpublishParams {
2685 scope: "photos".into(),
2686 hash: "abc123".into(),
2687 });
2688 let v = serde_json::to_value(&unp).unwrap();
2689 assert_eq!(v["method"], "blob_unpublish");
2690 assert_eq!(v["params"]["hash"], "abc123");
2691 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), unp);
2692
2693 let r = Request::BlobGrant(BlobGrantParams {
2694 scope: "docs".into(),
2695 principal: "alice".into(),
2696 });
2697 let v = serde_json::to_value(&r).unwrap();
2698 assert_eq!(v["method"], "blob_grant");
2699 assert_eq!(v["params"]["principal"], "alice");
2700 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2701
2702 // BlobList is parameterless (method_of resolves it).
2703 assert_eq!(
2704 method_of(&serde_json::json!({"method": "blob_list"})),
2705 Some("blob_list")
2706 );
2707
2708 // BlobFetch → { method, params: { ticket, dest_path } }.
2709 let r = Request::BlobFetch(BlobFetchParams {
2710 ticket: "blobAAA".into(),
2711 dest_path: "/tmp/out.bin".into(),
2712 });
2713 let v = serde_json::to_value(&r).unwrap();
2714 assert_eq!(v["method"], "blob_fetch");
2715 assert_eq!(v["params"]["ticket"], "blobAAA");
2716 assert_eq!(v["params"]["dest_path"], "/tmp/out.bin");
2717 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
2718
2719 // BlobPublishResult carries the ticket + hash (blob-reference vocabulary).
2720 let res = BlobPublishResult {
2721 ticket: "blobAAA".into(),
2722 hash: "ab".repeat(32),
2723 };
2724 let v = serde_json::to_value(&res).unwrap();
2725 assert_eq!(v["ticket"], "blobAAA");
2726 assert_eq!(serde_json::from_value::<BlobPublishResult>(v).unwrap(), res);
2727
2728 // BlobScopeList carries flat (name, hashes, grants) — no EndpointId/key leakage.
2729 let res = BlobScopeList {
2730 scopes: vec![ScopeInfo {
2731 name: "docs".into(),
2732 hashes: vec!["ab".repeat(32)],
2733 grants: vec!["alice".into()],
2734 withdrawn: vec![],
2735 hash_count: 1,
2736 grant_count: 1,
2737 withdrawn_count: 0,
2738 }],
2739 total: 1,
2740 truncated: false,
2741 };
2742 let v = serde_json::to_value(&res).unwrap();
2743 assert_eq!(v["scopes"][0]["name"], "docs");
2744 assert_eq!(v["scopes"][0]["grants"][0], "alice");
2745 assert_eq!(serde_json::from_value::<BlobScopeList>(v).unwrap(), res);
2746
2747 // BlobFetchResult carries the verified hash + byte length.
2748 let res = BlobFetchResult {
2749 hash: "ab".repeat(32),
2750 bytes_len: 4194304,
2751 };
2752 let v = serde_json::to_value(&res).unwrap();
2753 assert_eq!(v["bytes_len"], 4194304u64);
2754 assert_eq!(serde_json::from_value::<BlobFetchResult>(v).unwrap(), res);
2755 }
2756
2757 /// The three `subscribe` frame shapes round-trip with the documented `type`-tagged wire form
2758 /// (docs/local-protocol.md "Live event stream"): `snapshot` carries the flat session/reachability
2759 /// lists, `event` delegates through the `Box` so the record's fields sit VERBATIM under
2760 /// `record` (one schema with the JSONL log), and `lagged` carries the dropped count.
2761 #[test]
2762 fn stream_frames_roundtrip_with_the_documented_tags() {
2763 let snap = StreamFrame::Snapshot {
2764 self_network: None,
2765 active_sessions: vec![ActiveSession {
2766 peer: "bob".into(),
2767 service: "notes".into(),
2768 opened_at: 1_751_760_000,
2769 principal: None,
2770 }],
2771 reachability: vec![PeerReachability {
2772 name: "bob".into(),
2773 reachable: true,
2774 rtt_ms: Some(42),
2775 age_secs: Some(3),
2776 meta: String::new(),
2777 principal: None,
2778 path: Default::default(),
2779 }],
2780 };
2781 let v = serde_json::to_value(&snap).unwrap();
2782 assert_eq!(v["type"], "snapshot");
2783 assert_eq!(v["active_sessions"][0]["peer"], "bob");
2784 assert_eq!(v["active_sessions"][0]["opened_at"], 1_751_760_000i64);
2785 assert_eq!(v["reachability"][0]["name"], "bob");
2786 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), snap);
2787
2788 let event = StreamFrame::Event {
2789 record: Box::new(AuditRecord::session_open(
2790 "2026-07-03T14:02:11.480Z".into(),
2791 Some("bob".into()),
2792 "notes".into(),
2793 None,
2794 )),
2795 };
2796 let v = serde_json::to_value(&event).unwrap();
2797 assert_eq!(v["type"], "event");
2798 // The record's fields ride verbatim under `record` — no Box indirection on the wire.
2799 assert_eq!(v["record"]["kind"], "session_open");
2800 assert_eq!(v["record"]["peer"], "bob");
2801 assert_eq!(v["record"]["service"], "notes");
2802 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), event);
2803
2804 let lagged = StreamFrame::Lagged { dropped: 12 };
2805 let v = serde_json::to_value(&lagged).unwrap();
2806 assert_eq!(v, serde_json::json!({ "type": "lagged", "dropped": 12 }));
2807 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), lagged);
2808 }
2809
2810 /// A frame minted by a NEWER daemon (an unknown `type`) fails to deserialize rather than
2811 /// mis-parsing — the typed stream surface is closed; a forward-compatible consumer reads the
2812 /// raw `Value` stream instead (`ControlClient::open_stream`).
2813 #[test]
2814 fn unknown_stream_frame_type_is_rejected() {
2815 let future = serde_json::json!({ "type": "future_kind", "x": 1 });
2816 assert!(serde_json::from_value::<StreamFrame>(future).is_err());
2817 }
2818
2819 #[test]
2820 fn audit_summary_request_and_result_roundtrip() {
2821 // Request::AuditSummary is parameterless → `{ "method": "audit_summary" }`. Like Status, it
2822 // tolerates omitted/null params; the server dispatches on the method string (method_of).
2823 let r = Request::AuditSummary;
2824 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "audit_summary");
2825 assert_eq!(
2826 method_of(&serde_json::json!({"method": "audit_summary"})),
2827 Some("audit_summary")
2828 );
2829
2830 // AuditSummaryResult carries LOCAL per-peer / per-service session counts (nicknames + service
2831 // names only — never endpoints/transport terms) + a total. Tuples mirror kb's
2832 // InsightResponse.per_peer_contribution: `["bob", 2]` on the wire.
2833 let res = AuditSummaryResult {
2834 per_peer: vec![("alice".into(), 1), ("bob".into(), 2)],
2835 per_service: vec![("kb".into(), 1), ("notes".into(), 3)],
2836 total_sessions: 4,
2837 };
2838 let v = serde_json::to_value(&res).unwrap();
2839 assert_eq!(v["per_peer"][1][0], "bob");
2840 assert_eq!(v["per_peer"][1][1], 2u64);
2841 assert_eq!(v["per_service"][1][0], "notes");
2842 assert_eq!(v["total_sessions"], 4u64);
2843 assert_eq!(
2844 serde_json::from_value::<AuditSummaryResult>(v).unwrap(),
2845 res
2846 );
2847
2848 // Additive-only: a result minted by an older daemon (no `total_sessions` key) still
2849 // deserializes — the `#[serde(default)]` fills it with 0.
2850 let old_shape = serde_json::json!({ "per_peer": [], "per_service": [] });
2851 let back: AuditSummaryResult = serde_json::from_value(old_shape).unwrap();
2852 assert_eq!(back.total_sessions, 0);
2853 assert!(back.per_peer.is_empty());
2854 }
2855}