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