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