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