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