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 /// The org's DECLARED group namespace, in roster document order (#93). `api_minor >= 46`.
299 ///
300 /// The set an `allow` entry may name — a roster is refused if any user carries a group outside
301 /// it — so this is what a UI offers when assigning membership. Without it an embedder in roster
302 /// mode had managed group membership it could not enumerate, and the only way to learn the
303 /// groups was to hand-parse the daemon-owned `roster.json`.
304 ///
305 /// Display/authoring input, never an authorization answer: naming a group grants nothing.
306 /// Additive — a payload from an older daemon reads as an empty list.
307 #[serde(default, skip_serializing_if = "Vec::is_empty")]
308 pub groups: Vec<String>,
309}
310
311/// One reachable roster peer device as reported by `status` (the advisory presence read).
312/// ADVISORY — this is a display convenience, never an authorization surface. Surface-clean:
313/// FLAT vocabulary ONLY — a `user_id`, a human `device_label`, its `role` word, and an `online`
314/// boolean. It carries NO EndpointId / pubkey / hash / ALPN or any transport vocabulary.
315#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
316pub struct PresencePeer {
317 pub user_id: String,
318 /// The person's human display name from the roster (#93). `api_minor >= 46`.
319 ///
320 /// `user_id` is an authorization handle; this is what a UI puts next to a face. The roster
321 /// carried it all along and the control seam dropped it, so an embedder had a presence list it
322 /// could only label with an opaque id. Display-only — never an authz input.
323 ///
324 /// Additive: absent from an older daemon's payload, and empty when the roster's own field is.
325 #[serde(default, skip_serializing_if = "String::is_empty")]
326 pub display_name: String,
327 /// The groups this person belongs to (#93). `api_minor >= 46`.
328 ///
329 /// The same strings an `allow` entry names, so a UI can show why someone is admitted without
330 /// re-deriving it. Advisory display data: the gate reads the roster, never this. Additive.
331 #[serde(default, skip_serializing_if = "Vec::is_empty")]
332 pub groups: Vec<String>,
333 pub device_label: String,
334 pub role: String, // "primary" | "mirror" (roster vocabulary)
335 /// Whether the device has a live presence heartbeat (advisory — absence never blocks a dial).
336 pub online: bool,
337 /// The device's OPTIONAL embedder-set app metadata (#39) — an opaque ≤256B blob carried
338 /// (signed) on its presence heartbeat, empty when the device set none. Advisory display
339 /// data; never an authz input. Additive: default + skip-if-empty.
340 #[serde(default, skip_serializing_if = "String::is_empty")]
341 pub meta: String,
342}
343
344/// One recently completed INVITER-side pairing, surfaced by `status` so the inviter's human can
345/// read the short authentication code (SAS) and compare it with the redeemer's out-of-band —
346/// the pairing ceremony is "both humans compare the code": the redeemer sees it in its
347/// [`PairResult`]; this is the inviter's porcelain surface for the same words. DISPLAY-ONLY
348/// ceremony state: held in-memory by the daemon (a small ring), lost on restart, NEVER an
349/// authorization input or trust data. Surface-clean: a nickname + the SAS wordlist words +
350/// an epoch — never an EndpointId.
351#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
352pub struct RecentPairing {
353 /// The peer's nickname as stored by the inviter (its local name for the redeemer).
354 pub peer_nickname: String,
355 /// The display-only SAS words (e.g. `"tango-fig-cabbage"`) — the same code the redeemer's
356 /// `PairResult.sas_code` carried. Never checked programmatically.
357 pub sas_code: String,
358 /// When the pairing completed (epoch seconds) — the porcelain renders a friendly age.
359 pub paired_at_epoch: u64,
360}
361
362#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
363pub struct StatusResult {
364 pub stack_version: String,
365 pub services: Vec<ServiceInfo>,
366 pub peers: Vec<PeerInfo>,
367 /// Roster-mode status, absent in a pure-pairing daemon. Additive:
368 /// `#[serde(default, skip_serializing_if = ...)]` so a daemon/client without it round-trips.
369 #[serde(default, skip_serializing_if = "Option::is_none")]
370 pub roster: Option<RosterStatus>,
371 /// The reachable roster peer devices (the advisory presence read), each with an `online`
372 /// flag. Empty in a pure-pairing daemon / when no roster is installed. Additive:
373 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
374 #[serde(default, skip_serializing_if = "Vec::is_empty")]
375 pub presence: Vec<PresencePeer>,
376 /// THIS daemon's own self-sovereign `user_id` (`b64u:<user_pk>`), if it has a user key (auto-
377 /// minted at boot; shared by pairing AND roster mode). Lets the operator see + share their stable
378 /// identity that multiple devices resolve to. `None` only when no user key exists. Additive:
379 /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so an older payload round-trips.
380 #[serde(default, skip_serializing_if = "Option::is_none")]
381 pub self_user_id: Option<String>,
382 /// Recent INVITER-side pairing completions, newest first (display-only pairing-ceremony aids —
383 /// see [`RecentPairing`]; in-memory on the daemon, cleared by a restart). Empty on a daemon
384 /// that has accepted no pairing since it started. Additive:
385 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
386 #[serde(default, skip_serializing_if = "Vec::is_empty")]
387 pub recent_pairings: Vec<RecentPairing>,
388 /// Advisory reachability of paired peers, from the on-demand probe cache. Empty until the
389 /// first probe completes. Additive: default + skip-if-empty.
390 #[serde(default, skip_serializing_if = "Vec::is_empty")]
391 pub reachability: Vec<PeerReachability>,
392 /// This node's EFFECTIVE self-nickname — what a freshly minted invite would present
393 /// (config `[identity].nickname`, else the hostname, else a fingerprint; live-updated by
394 /// `set_nickname`, #37). Empty only in mesh-less control-only mode. Additive: default +
395 /// skip-if-empty so an older payload round-trips.
396 #[serde(default, skip_serializing_if = "String::is_empty")]
397 pub self_nickname: String,
398 /// On-disk footprint of this node's own state (#88), so an embedder can warn a user before
399 /// ENOSPC rather than after — the audit log's write rate is driven by inbound peer traffic,
400 /// and it shares a filesystem with `state.redb` and the device key. A LIVE read (computed
401 /// per `status` call), not a boot-time snapshot. `None` only in mesh-less control-only mode.
402 /// Additive: default + skip-if-none so an older payload round-trips.
403 #[serde(default, skip_serializing_if = "Option::is_none")]
404 pub storage: Option<StorageInfo>,
405 /// Endpoints this node currently REFUSES (#85 ask 4, `api_minor >= 51`), local or signed.
406 ///
407 /// Present because a revocation is otherwise invisible: a peer that has been cut off simply
408 /// stops working, and neither side can tell that from a network fault. Empty on the
409 /// overwhelming majority of nodes, so it is elided rather than serialized as `[]`.
410 #[serde(default, skip_serializing_if = "Vec::is_empty")]
411 pub revoked: Vec<RevokedEndpoint>,
412 /// THIS node's own reachability posture (#90) — see [`SelfNetwork`]. Computed live per
413 /// call; `None` in mesh-less control-only mode. Additive: default + skip-if-none.
414 #[serde(default, skip_serializing_if = "Option::is_none")]
415 pub self_network: Option<SelfNetwork>,
416}
417
418/// The `status.self_network` block (#90): THIS node's own reachability posture — the first
419/// question in every "my message never arrived" investigation, previously unanswerable from
420/// either side of the API. Self-facing only: everything here is the node's own information
421/// (relay URLs come from its own config, sanitized; direct addresses already ride its invites).
422///
423/// `online` is iroh's own semantics — a home-relay connection is established. In
424/// `relay_mode = "disabled"` it is ALWAYS `false` with an empty `relays` list: that is a
425/// configuration, not an outage — render it as "LAN-only", never as a health warning.
426///
427/// Additive-only.
428///
429/// **`Default` is `{online: false, relays: []}` — which is exactly the shape above meaning
430/// "deliberately LAN-only" (#148).** The porcelain reads it that way and SUPPRESSES the "no relay
431/// connection" line for it. So a fixture built with `..Default::default()` claims a healthy
432/// LAN-only posture, not an unknown one. There is no third value for a `bool`; the honest way to
433/// say "nobody looked" is `StatusResult.self_network: None`, which is what a defaulted
434/// `StatusResult` gives you.
435#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
436pub struct SelfNetwork {
437 /// A home-relay connection is established (iroh's `online` definition). The signal #53's
438 /// `set_relays` never had: when this goes false on a relay-enabled node, the relay set is
439 /// the thing to look at.
440 pub online: bool,
441 /// The CONNECTED home relay's URL, sanitized to scheme + host + port (operator-supplied
442 /// relay URLs can carry userinfo tokens; `status` output gets screenshotted). `None` when
443 /// no relay is connected.
444 #[serde(default, skip_serializing_if = "Option::is_none")]
445 pub home_relay: Option<String>,
446 /// Every known home relay and its current connection state. Empty when no relays are
447 /// configured, or before the endpoint has selected any.
448 #[serde(default, skip_serializing_if = "Vec::is_empty")]
449 pub relays: Vec<RelayInfo>,
450 /// This endpoint's direct (non-relay) socket addresses — its own dialable coordinates.
451 #[serde(default, skip_serializing_if = "Vec::is_empty")]
452 pub direct_addrs: Vec<String>,
453 /// When the daemon's watcher last observed a TRANSITION (epoch seconds) — a change of
454 /// `online`, `home_relay`, or a relay's connection state; `direct_addrs` drift alone does
455 /// not stamp (nor emit a frame). OMITTED (not `null`) until the first observed transition
456 /// after boot, and from a point-in-time computation with no watcher running.
457 #[serde(default, skip_serializing_if = "Option::is_none")]
458 pub last_change_epoch: Option<i64>,
459 /// This node's `[network].presence_mode` (#89): `"paired"` | `"granted"` | `"off"` — who
460 /// currently gets an answer to the `mcpmesh/ping/1` reachability probe.
461 ///
462 /// Reported because the setting was otherwise **unobservable**: an operator who set it had no
463 /// way to confirm it took effect, and a product backing a privacy switch with it could not show
464 /// the user its real state. Always present from `api_minor >= 38`.
465 ///
466 /// **It is not "appear offline".** It withholds the pong payload and makes our own probe report
467 /// this node unreachable; it does not hide that the node is running (a QUIC application close
468 /// implies a completed handshake, and `mcpmesh/pair/1` answers any stranger by design). Do not
469 /// render it to users as invisibility.
470 #[serde(default, skip_serializing_if = "Option::is_none")]
471 pub presence_mode: Option<String>,
472 /// This node's `[network].local_discovery` (#68): `"off"` | `"on"` | `"resolve"` — whether it
473 /// finds peers on the local link with no internet, and whether it announces itself there.
474 ///
475 /// Reported for the same reason `presence_mode` is: the setting is otherwise unobservable, and
476 /// this one has two questions behind it. "Why can these two machines on one LAN not find each
477 /// other" is answered by `"off"`; and **`"on"` means this node is multicasting its endpoint id
478 /// and addresses to every device on the link**, which a product backing a privacy switch has to
479 /// be able to show the user. `"resolve"` never publishes this node's identity or addresses,
480 /// but still emits a service query roughly once a second — quieter than `"on"`, not silent.
481 ///
482 /// Always present from `api_minor >= 50`; absent below it, and absent without a mesh.
483 #[serde(default, skip_serializing_if = "Option::is_none")]
484 pub local_discovery: Option<String>,
485 /// When the relay last reported that ANOTHER endpoint is presenting this node's identity
486 /// (#134, epoch seconds), or absent if never — the overwhelmingly common case.
487 ///
488 /// Two nodes booted from COPIES of one mesh root share an endpoint id. The relay can serve only
489 /// one, so the displaced node's peers simply go unreachable with nothing saying why; diagnosing
490 /// that cost a downstream real time. This is that missing "why".
491 ///
492 /// **Sticky, and a timestamp rather than a flag.** The condition is announced once, as the
493 /// displaced connection is dropped — it is not a state the relay keeps reporting — so a
494 /// self-clearing flag would read false by the time anyone called `status`. Judge staleness from
495 /// the epoch, exactly as with `last_change_epoch`.
496 ///
497 /// **Absence is not proof of uniqueness.** Detection needs an
498 /// `IdentityConflictLayer` in the process's `tracing` subscriber: the standalone daemon
499 /// installs one at boot, but an EMBEDDED node cannot (a subscriber is global and the host owns
500 /// it) and reports `None` until the host installs it. Never render absence as "identity
501 /// verified unique".
502 ///
503 /// Additive: `#[serde(default, skip_serializing_if = "Option::is_none")]`. `api_minor >= 32`.
504 #[serde(default, skip_serializing_if = "Option::is_none")]
505 pub identity_conflict_epoch: Option<i64>,
506}
507
508/// One home relay's connection state (#90). No latency — per-relay RTT needs iroh's
509/// `net_report`, which is unstable-feature-gated as of 1.0.3; `connected` is the stable truth.
510#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
511pub struct RelayInfo {
512 /// Sanitized (scheme + host + port), like `home_relay`.
513 pub url: String,
514 pub connected: bool,
515}
516
517/// One entry of `status.revoked` (#85 ask 4).
518#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
519pub struct RevokedEndpoint {
520 /// The `eid:` device principal that is refused.
521 pub principal: String,
522 /// When THIS node applied it, epoch seconds.
523 pub revoked_at_epoch: u64,
524 /// `"local"` — this operator's own decision about someone else's device — or `"signed"`, a
525 /// statement the device's OWNER issued about their own. Two different claims, and an operator
526 /// reading this list needs to tell them apart: only the second is evidence that the person
527 /// themselves declared the device dead.
528 pub source: String,
529 /// For `"signed"`: the verified `b64u:` that signed it.
530 #[serde(default, skip_serializing_if = "Option::is_none")]
531 pub signer_user_id: Option<String>,
532 /// Free-text operator note, never interpreted.
533 #[serde(default, skip_serializing_if = "Option::is_none")]
534 pub reason: Option<String>,
535 /// The local nickname this endpoint still has a pair row under, if any. Revocation does not
536 /// delete the row, so this is usually present — and it is what makes the list readable.
537 #[serde(default, skip_serializing_if = "Option::is_none")]
538 pub nickname: Option<String>,
539}
540
541/// The `status.storage` block (#88): bytes actually on disk, by subsystem. Counts, never
542/// content. Additive-only.
543///
544/// **`Default` is all zeros, which reads as "measured, and found empty" (#148).** It is here so a
545/// fixture can build one field and elide the rest; it is not a way to say "unmeasured". For that,
546/// leave `StatusResult.storage` as `None` — a defaulted `StatusResult` does exactly that.
547#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
548pub struct StorageInfo {
549 /// Summed sizes of the monthly audit files (`<state>/audit/*.jsonl`).
550 pub audit_bytes: u64,
551 /// Size of the peer/trust state store (`state.redb`).
552 pub redb_bytes: u64,
553 /// Total size under the app-blob store directory; 0 when no blob store exists.
554 pub blobs_bytes: u64,
555 /// Blob garbage collection (#80), or `None` when it is not configured — which is the default
556 /// and the behavior of every release up to 0.42.0.
557 ///
558 /// `None` means "not collecting", NOT "collecting and idle": a configured collector reports
559 /// `Some` with `runs: 0` until its first sweep.
560 #[serde(default, skip_serializing_if = "Option::is_none")]
561 pub blobs_gc: Option<BlobsGcInfo>,
562}
563
564/// The `status.storage.blobs_gc` block (#80): what the background app-blob collector has done.
565///
566/// **There is deliberately no `bytes_reclaimed`.** iroh-blobs calls back only BEFORE a sweep, never
567/// after, so any byte count here would be a guess. `blobs_bytes` is measured by walking the store
568/// directory; an operator reads reclaim off that, over time.
569#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
570pub struct BlobsGcInfo {
571 /// The interval the store is actually running on, in seconds.
572 pub interval_secs: u64,
573 /// Runs STARTED. iroh-blobs offers no completion callback, so this counts sweeps begun.
574 ///
575 /// **Watch this number.** Upstream's collector `break`s its loop on the first sweep error
576 /// rather than continuing, so one failure silently ends collection until the daemon restarts. A
577 /// `runs` that stops advancing across several intervals is the only signal that happened.
578 ///
579 /// Also: the collector SLEEPS before its first run, so a node with a 24h interval reports
580 /// `runs: 0` for its first 24 hours. That is not a fault.
581 pub runs: u64,
582 /// Unix seconds at the start of the most recent run; `None` before the first.
583 pub last_run_epoch: Option<i64>,
584 /// Hashes protected on the most recent run — the size of the liveness root the scope table
585 /// produced.
586 pub last_protected: u64,
587 /// Runs ABORTED because the liveness root could not be read. Each one swept nothing, which is
588 /// the intended fail-safe; a number that climbs means collection is not happening.
589 pub aborted: u64,
590}
591
592/// Params of [`Request::RegisterService`]: the `[services.*]` entry to write/update.
593#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
594#[serde(deny_unknown_fields)]
595pub struct RegisterServiceParams {
596 pub name: String,
597 pub backend: BackendSpec,
598 pub allow: Vec<String>,
599 /// When true (#36), the registration is EPHEMERAL: kept in daemon memory only, never written
600 /// to the on-disk config, and automatically unregistered when the control connection that
601 /// registered it closes (and gone on daemon restart). For an embedder that serves a
602 /// `socket` backend from a fresh path each run, this removes the need to derive a stable
603 /// socket path solely to keep a persisted registration valid, and the stale-registration
604 /// accumulation that comes with no unregister. Default false = the persistent behavior.
605 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
606 pub ephemeral: bool,
607 /// Per-service proxied-request rate (#63), falling back to `[limits].rate_limit_per_min`.
608 ///
609 /// **CLAMPED, never honoured upward.** `[limits].rate_limit_per_min` is a hard ceiling: a
610 /// larger value here is reduced to it, so a control call cannot uncap a service. Before #63
611 /// every service a peer could reach drew from one shared bucket, so a noisy service starved a
612 /// quiet one; buckets are now per `(service, endpoint)`.
613 ///
614 /// `0` is rejected rather than silently blocking every request. `api_minor >= 40`.
615 #[serde(default, skip_serializing_if = "Option::is_none")]
616 pub rate_limit_per_min: Option<u32>,
617}
618
619/// Params of [`Request::Invite`]: the services the minted invite grants. Rejects unknown
620/// fields (so `{service: "kb"}` — a singular typo — is a loud error, not a silently
621/// grants-nothing invite), and the daemon additionally rejects an empty/absent `services`
622/// list (an invite that grants nothing is useless — #34).
623#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
624#[serde(deny_unknown_fields)]
625pub struct InviteParams {
626 #[serde(default)]
627 pub services: Vec<String>,
628 /// An OPAQUE, caller-chosen label carried through to the redeemer in the `pair` result (#31).
629 /// mcpmesh never interprets it (not a nickname, never resolved or authorized) — a per-pairing
630 /// metadata slot for the embedder (e.g. its own URN). Capped at the daemon; omit for none.
631 #[serde(default, skip_serializing_if = "Option::is_none")]
632 pub app_label: Option<String>,
633 /// How many times this invite may be redeemed (#87). Absent = **1**, the single-use behaviour
634 /// every existing caller already gets.
635 ///
636 /// Each redemption runs its OWN SAS ceremony and writes its own mutual peer rows — this is not
637 /// a shared or group identity, it is N independent pairings that happen to share one secret.
638 /// Onboarding a team stops being N mint-and-send rounds.
639 ///
640 /// Clamped to [`MAX_INVITE_USES`]; `0` is rejected rather than silently meaning "unusable". A
641 /// bearer credential's blast radius is `max_uses` × TTL, so it is opt-in and capped on purpose.
642 /// The value actually applied comes back in [`InviteResult::uses_remaining`] — read that rather
643 /// than assuming you got what you asked for.
644 ///
645 /// **`api_minor >= 35`, and sending it to an older daemon FAILS rather than degrading.**
646 /// `InviteParams` is `deny_unknown_fields`, so an `api_minor < 35` daemon answers `-32602
647 /// unknown field 'max_uses'` — it does not quietly mint a single-use invite. Loud is the right
648 /// behaviour; omit the field entirely when talking to one.
649 #[serde(default, skip_serializing_if = "Option::is_none")]
650 pub max_uses: Option<u32>,
651 /// YOUR local name for whoever redeems this invite (#87), overriding the nickname they claim
652 /// for themselves in the ceremony.
653 ///
654 /// The redeemer's self-claimed name is usually its hostname, so two same-model laptops collide
655 /// and the pairing is refused with [`ERR_NICKNAME_TAKEN`]. Before this field the only fixes
656 /// were to ask the other person to rename their machine, or to unpair whoever holds the name.
657 /// This lets you just call them something else.
658 ///
659 /// Local only: it is never sent to the peer and never affects what they call themselves or
660 /// you. It does **not** bypass the collision check — an alias that itself collides is refused
661 /// identically, because a duplicate display name makes your own `<peer>/<service>` routing
662 /// ambiguous whoever chose it.
663 ///
664 /// **Rejected with `max_uses > 1`:** one alias applied to every redeemer of a multi-use invite
665 /// would collide on the second redemption, so it is refused at MINT rather than producing an
666 /// invite that works exactly once. `api_minor >= 39`.
667 #[serde(default, skip_serializing_if = "Option::is_none")]
668 pub peer_nickname: Option<String>,
669 /// Mint a SELF-ENROLLMENT invite (#86): the redeemer becomes another device of **you**, not a
670 /// peer.
671 ///
672 /// The ceremony is the ordinary one — same secret, same SAS. What differs is the outcome:
673 /// neither side writes a peer row and nothing is granted, and the inviter signs a device→user
674 /// binding for the redeemer's authenticated endpoint. Both devices then present the same
675 /// `user_pk`, so every peer resolves them to ONE `user_id`.
676 ///
677 /// **The private key never moves.** The enrolling device signs a binding for the new device's
678 /// endpoint and hands over only that signature, so a second copy of the identity never exists.
679 /// The consequence: an enrolled device cannot enroll a third — enroll every device from the one
680 /// that holds the key.
681 ///
682 /// **The SAS matters more here than anywhere else.** The inviter signs a binding for whichever
683 /// endpoint redeems, so a redemption by an impostor mints *that impostor* a binding for your
684 /// identity. Requires `max_uses = 1` and an empty `services`, both refused otherwise.
685 /// `api_minor >= 43`.
686 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
687 pub as_self: bool,
688}
689
690/// The ceiling on [`InviteParams::max_uses`] (#87). Comfortably above "a team", far below "a
691/// fleet": one leaked invite line must not be able to enroll an unbounded number of devices for the
692/// whole 24h TTL.
693pub const MAX_INVITE_USES: u32 = 64;
694
695/// Params of [`Request::Pair`]: the copyable `mcpmesh-invite:` line. Defaultable — an
696/// absent field reads as an empty line, which simply fails to decode (a clean pair error).
697#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
698#[serde(deny_unknown_fields)]
699pub struct PairParams {
700 #[serde(default)]
701 pub invite_line: String,
702 /// YOUR local name for the inviter (#87), overriding the nickname their invite suggests.
703 ///
704 /// An invite carries the inviter's suggestion for what you should call them — usually their
705 /// hostname. If you already use that name for a different peer, the pairing is refused with
706 /// [`ERR_INVITE_NAME_CONFLICT`] and the message tells you to go ask them for a new invite.
707 /// This lets you resolve it yourself, without `set_nickname` (which rewrites your own GLOBAL
708 /// self-name — not what anyone wants in order to add one colleague).
709 ///
710 /// Local only: never sent to the inviter. It does **not** bypass the collision check — an alias
711 /// that itself collides is refused identically, because a duplicate display name makes your own
712 /// `<peer>/<service>` routing ambiguous whoever chose it. `api_minor >= 39`.
713 #[serde(default, skip_serializing_if = "Option::is_none")]
714 pub as_nickname: Option<String>,
715 /// Consent to complete a SELF-ENROLLMENT (#178): a `mcpmesh-enroll:` line is refused with
716 /// [`ERR_SELF_ENROLL_NOT_OFFERED`] unless this is set.
717 ///
718 /// Defaults to `false`, which is the whole point. #86 gave self-enrollment its own scheme so a
719 /// version-skewed redeemer refuses rather than pairing wrongly — but a CURRENT caller that only
720 /// ever meant to pair still ran the ceremony to completion, and learned which one it had run
721 /// from [`PairResult::enrolled_as_self`] only AFTER the device→user binding was written. That
722 /// binding admits this device to everyone who trusts the inviter's `user_id`, and it is
723 /// irrevocable short of rotating that user key — so "observe it afterwards" is not a place a
724 /// caller can refuse from.
725 ///
726 /// Set it when the ceremony is one your UI actually OFFERED ("add another of my devices"). Leave
727 /// it unset on an ordinary "join / add a contact" field: the refusal costs nothing, the invite is
728 /// untouched (nothing is dialled and nothing is burned), and the same line still works if the
729 /// person is then offered the real choice.
730 ///
731 /// To decide BEFORE calling — to show the right prompt rather than recover from a refusal — use
732 /// `mcpmesh_node::pairing::is_enrollment_line`. `api_minor >= 45`.
733 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
734 pub allow_self_enroll: bool,
735}
736
737/// Params of [`Request::AttestTo`] (#85 ask 3).
738#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
739#[serde(deny_unknown_fields)]
740pub struct AttestToParams {
741 /// A `mcpmesh-attest:` line from the peer that will admit this device.
742 pub offer: String,
743}
744
745/// Result of [`Request::AttestOffer`] (#85 ask 3).
746#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
747pub struct AttestOfferResult {
748 /// The `mcpmesh-attest:` line. Hand it to your other device.
749 pub offer: String,
750}
751
752/// Params of [`Request::PeerRevoke`] (#85 ask 4).
753#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
754#[serde(deny_unknown_fields)]
755pub struct PeerRevokeParams {
756 /// A nickname, an `eid:` device principal, or a `b64u:` user_id. A `b64u:` revokes EVERY
757 /// endpoint this node associates with that person.
758 pub peer: String,
759 /// Free-text operator note, stored and shown in `status`. Never interpreted.
760 #[serde(default, skip_serializing_if = "Option::is_none")]
761 pub reason: Option<String>,
762}
763
764/// Result of [`Request::PeerRevoke`].
765#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
766pub struct PeerRevokeResult {
767 /// The `eid:` principals now revoked. Empty means the name resolved to no endpoint — an ERROR
768 /// is returned instead in that case, so an empty list here never reads as success.
769 pub revoked: Vec<String>,
770 /// Live connections severed by this call. `0` is normal (the peer may be offline) and is NOT a
771 /// failure — but a non-zero count is the evidence that revocation was immediate rather than
772 /// deferred to the peer's next disconnect.
773 pub severed: usize,
774}
775
776/// Params of [`Request::PeerUnrevoke`] (#85 ask 4).
777#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
778#[serde(deny_unknown_fields)]
779pub struct PeerUnrevokeParams {
780 /// Nickname, `eid:`, or `b64u:` — the same vocabulary as `peer_revoke`.
781 pub peer: String,
782}
783
784/// Result of [`Request::PeerUnrevoke`].
785#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
786pub struct PeerUnrevokeResult {
787 /// The `eid:` principals whose revocation was lifted. Empty = none were revoked (idempotent).
788 pub unrevoked: Vec<String>,
789}
790
791/// Params of [`Request::DeviceRevoke`] (#85 ask 4).
792#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
793#[serde(deny_unknown_fields)]
794pub struct DeviceRevokeParams {
795 /// The `eid:` principal of the device being revoked — one of THIS person's own.
796 ///
797 /// Explicit rather than "this node", because the device you are revoking is usually the one you
798 /// no longer have: you issue the token from your replacement machine, naming the lost one.
799 pub endpoint: String,
800 #[serde(default, skip_serializing_if = "Option::is_none")]
801 pub reason: Option<String>,
802}
803
804/// Result of [`Request::DeviceRevoke`]: the portable token, and what it says.
805#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
806pub struct DeviceRevokeResult {
807 /// The signed statement, `mcpmesh-revoke:<base64url>`. Hand this to your peers.
808 ///
809 /// Not a secret — it authorizes nothing and grants nothing; it only asks that an endpoint be
810 /// treated as dead, and only peers who already trust the signer will act on it.
811 pub token: String,
812 /// The `eid:` it revokes, echoed so a caller can confirm they named the device they meant.
813 pub endpoint: String,
814 /// The signing `b64u:` user_id — the identity your peers already pinned.
815 pub user_id: String,
816}
817
818/// Params of [`Request::DeviceRevocationImport`] (#85 ask 4).
819#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
820#[serde(deny_unknown_fields)]
821pub struct DeviceRevocationImportParams {
822 /// A `mcpmesh-revoke:` token from a peer.
823 pub token: String,
824}
825
826/// Result of [`Request::DeviceRevocationImport`].
827#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
828pub struct DeviceRevocationImportResult {
829 /// The `eid:` now revoked.
830 pub endpoint: String,
831 /// The `b64u:` that signed it — verified, not claimed.
832 pub user_id: String,
833 /// `false` when an equal-or-newer revocation for this endpoint was already held: the import is
834 /// idempotent, and a replayed OLDER token must not overwrite a newer one.
835 pub applied: bool,
836 /// Live connections severed. See `PeerRevokeResult::severed`.
837 pub severed: usize,
838}
839
840/// Params of [`Request::PeerRemove`]: the nickname to unpair.
841#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
842#[serde(deny_unknown_fields)]
843pub struct PeerRemoveParams {
844 pub nickname: String,
845}
846
847/// Params of [`Request::PeerRename`]: the contact to rename — every device sharing `user_id`
848/// when given, else the single provisional `nickname` entry — and the new nickname `to`.
849#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
850#[serde(deny_unknown_fields)]
851pub struct PeerRenameParams {
852 #[serde(default)]
853 pub user_id: Option<String>,
854 #[serde(default)]
855 pub nickname: Option<String>,
856 pub to: String,
857}
858
859/// Params of [`Request::PeerAdd`] (reserved/internal — see the variant): a raw `endpoint_id`
860/// (iroh base32) plus the nickname and service allow list to install it under.
861#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
862#[serde(deny_unknown_fields)]
863pub struct PeerAddParams {
864 pub nickname: String,
865 pub endpoint_id: String,
866 #[serde(default)]
867 pub allow: Vec<String>,
868}
869
870/// Params of [`Request::PeerEndorse`] (#65): vouch for a peer so a third party can install them.
871#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
872#[serde(deny_unknown_fields)]
873pub struct PeerEndorseParams {
874 /// The subject's endpoint id, `eid:<hex>` — usually a peer you are paired with, though the
875 /// daemon does not require that: an endorsement is YOUR statement, and the recipient decides
876 /// what it is worth.
877 pub subject: String,
878 /// The subject's user key, `b64u:`, when you are also vouching for that. The recipient will
879 /// additionally require the SUBJECT's own device binding before trusting it — see
880 /// [`PeerIntroduceParams::subject_binding`].
881 #[serde(default, skip_serializing_if = "Option::is_none")]
882 pub subject_user_id: Option<String>,
883}
884
885/// Result of [`Request::PeerEndorse`] (#65) — hand both fields to the recipient.
886#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
887pub struct PeerEndorseResult {
888 /// YOUR user id, `b64u:` — what the recipient passes as `endorsed_by`. They must already be
889 /// paired with you for it to resolve.
890 pub endorsed_by: String,
891 /// The signature, `b64u:` — what the recipient passes as `evidence`.
892 pub evidence: String,
893}
894
895/// Params of [`Request::PeerIntroduce`] (#65): install a peer vouched for by someone you are
896/// already paired with.
897///
898/// The endorsement replaces pairing's SAS with the endorser's signature, so you are trusting that
899/// endorser's judgment and key hygiene as well as their identity. It buys identity resolution only
900/// — see [`Request::PeerIntroduce`].
901#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
902#[serde(deny_unknown_fields)]
903pub struct PeerIntroduceParams {
904 /// The subject's endpoint id, `eid:<hex>` — who is being introduced.
905 pub subject: String,
906 /// The endorser's user public key, `b64u:`. MUST be the `user_id` of a CURRENTLY paired peer:
907 /// the chain has to terminate at someone you paired with yourself, so an endorsement from a
908 /// stranger — or from someone you have since unpaired — is refused.
909 pub endorsed_by: String,
910 /// The endorser's signature over the domain-separated preimage, `b64u:`.
911 pub evidence: String,
912 /// The subject's OWN user key, `b64u:`, so several of the subject's devices resolve to one
913 /// person. Part of the endorser's signed statement, so it cannot be added or removed after
914 /// the fact.
915 ///
916 /// **Requires `subject_binding` too, and is REFUSED without it.** A `user_id` is
917 /// authorization-bearing — service `allow` lists match on it — so the endorser vouching for it
918 /// is not enough: an endorser could otherwise name a *victim's* `user_id` (which is public, on
919 /// `status` and every audit record) for an attacker's endpoint, and the attacker would inherit
920 /// that victim's grants. The subject must prove the key is theirs.
921 #[serde(default, skip_serializing_if = "Option::is_none")]
922 pub subject_user_id: Option<String>,
923 /// The SUBJECT's own device→user binding for `subject_user_id`, `b64u:` — the same signature a
924 /// peer presents at pairing (`mcpmesh/join/device-binding/1`), proving *it* controls that user
925 /// key and that the key is bound to *this* endpoint.
926 ///
927 /// Two independent signatures are required for a `user_id`, and they say different things: the
928 /// endorser's says "I vouch for this endpoint", the subject's says "this user key is mine".
929 /// Neither alone is sufficient.
930 #[serde(default, skip_serializing_if = "Option::is_none")]
931 pub subject_binding: Option<String>,
932 /// YOUR local name for the subject. Same rules and the same collision guard as pairing (#87).
933 pub nickname: String,
934}
935
936/// Params of [`Request::OpenSession`]: the `peer/service` target to dial. Both fields are
937/// defaultable — an empty target simply fails the dial (a clean `-32055` error).
938#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
939#[serde(deny_unknown_fields)]
940pub struct OpenSessionParams {
941 #[serde(default)]
942 pub peer: String,
943 #[serde(default)]
944 pub service: String,
945 /// A QUIC idle timeout for THIS session only, in seconds (#166, `api_minor >= 54`).
946 ///
947 /// Absent inherits `[network].idle_timeout_secs`, i.e. today's behaviour. `0` means "no idle
948 /// timeout from this side" — the same meaning the node-wide knob gives it, so the two cannot be
949 /// read differently.
950 ///
951 /// **Only LOWERING is unilateral.** QUIC negotiates `max_idle_timeout` to the MINIMUM of the
952 /// two peers' values (RFC 9000 §10.1), so this can always make a session die sooner when it
953 /// goes quiet and can never make it outlive what the peer allows. Raising needs both peers
954 /// configured — which was already true of the node-wide knob, and which no per-connection seam
955 /// changes.
956 ///
957 /// **Outbound only, and that is not half a feature.** An accepted session uses the node-wide
958 /// value, because iroh gives the server config no per-connection seam — but the direction that
959 /// CAN work one-sidedly is available here, and the direction that cannot never worked anywhere.
960 /// A node wanting a shorter timeout on a session it did not initiate can dial instead.
961 ///
962 /// **Ignored on a RACING dial**, because that opens connections it then abandons. The precise
963 /// rule, since the first version of this sentence was wrong in both directions:
964 ///
965 /// - A **roster person** races whenever the roster lists them with ANY device — including
966 /// exactly one — so a `user_id` naming a rostered person never gets it.
967 /// - A pairing-mode **`b64u:`** races only with TWO OR MORE stored devices; with exactly one it
968 /// falls through to the single-entry path and DOES get it.
969 ///
970 /// The node logs at `warn!` when it drops the value, naming the peer — a caller cannot know how
971 /// many devices a peer has, so a silent drop would be unattributable. Name one device with
972 /// `eid:` to be certain.
973 ///
974 /// No per-connection KEEPALIVE: iroh caps the per-path keepalive at 5s and discards larger
975 /// values, so one could only make pings more frequent — the node-wide knob already refuses that
976 /// direction (#56).
977 #[serde(default, skip_serializing_if = "Option::is_none")]
978 pub idle_timeout_secs: Option<u64>,
979}
980
981/// Params of [`Request::RosterInstall`]: the LOCAL roster file `path`, plus the org-root pin
982/// on FIRST install (`b64u:`; omit once pinned — config carries it).
983#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
984#[serde(deny_unknown_fields)]
985pub struct RosterInstallParams {
986 pub path: String,
987 #[serde(default, skip_serializing_if = "Option::is_none")]
988 pub org_root_pk: Option<String>,
989}
990
991/// Params of [`Request::OrgJoin`]: the `[identity]` pin. `user_key` is a LOCAL path — the key
992/// never crosses the API.
993#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
994#[serde(deny_unknown_fields)]
995pub struct OrgJoinParams {
996 pub org_id: String,
997 pub org_root_pk: String,
998 pub user_id: String,
999 pub user_key: String,
1000}
1001
1002/// Params of [`Request::SetAppMetadata`]: this node's opaque app-metadata blob (#39). The
1003/// daemon NEVER interprets it — the embedder structures its own bytes (a version string,
1004/// small JSON, …). Capped at 256 bytes; `""` clears it. Roster-mode only (it rides the
1005/// signed presence heartbeat); a pure-pairing daemon accepts + stores it but never gossips it.
1006#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1007#[serde(deny_unknown_fields)]
1008pub struct SetAppMetadataParams {
1009 pub metadata: String,
1010}
1011
1012/// Params of [`Request::PeerServices`] (#52): the peer to query — a nickname, an `eid:` device
1013/// principal, or a `b64u:` user_id.
1014#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1015#[serde(deny_unknown_fields)]
1016pub struct PeerServicesParams {
1017 pub peer: String,
1018}
1019
1020/// Result of [`Request::PeerServices`] (#52): the services the queried peer CURRENTLY grants the
1021/// caller — computed authoritatively on the peer (which owns the truth), always current, only
1022/// the caller's own admitted services (never the peer's full registry).
1023#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1024pub struct PeerServicesResult {
1025 pub services: Vec<String>,
1026}
1027
1028/// Params of [`Request::PeerDiagnostics`] (#140): the peer to dump — a nickname or an `eid:`
1029/// device principal.
1030#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1031#[serde(deny_unknown_fields)]
1032pub struct PeerDiagnosticsParams {
1033 pub peer: String,
1034}
1035
1036/// Result of [`Request::PeerDiagnostics`] (#140): the DURABLE per-peer state this node carries,
1037/// for diagnosing why a specific long-lived pairing behaves differently from a fresh one.
1038///
1039/// **This surface carries a PEER's transport coordinates on purpose.** The rendered porcelain is
1040/// address-free everywhere — nicknames and path KINDS — because that discipline keeps a peer's
1041/// coordinates out of screenshots. (`SelfNetwork.direct_addrs` already returns this node's OWN
1042/// addresses on `status`; what is new here is another endpoint's.) The question this answers is
1043/// "what address is this node about to dial, and where did it come from", which has no answer
1044/// without the address. It is your own store's record of your own paired peers. Do not render it
1045/// in ordinary porcelain, and read it before pasting it anywhere public.
1046///
1047/// The intended use is a paired capture: run it on BOTH ends of a stuck pairing and compare the
1048/// stored hint against the live path each side reports.
1049#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1050pub struct PeerDiagnosticsResult {
1051 /// The peer's nickname as this node stores it.
1052 pub nickname: String,
1053 /// The peer's stable `eid:` device principal.
1054 pub principal: String,
1055 /// The peer's `b64u:` user_id if it proved a device→user binding at pairing.
1056 #[serde(default, skip_serializing_if = "Option::is_none")]
1057 pub user_id: Option<String>,
1058 /// When the pairing was written (epoch seconds as a string), if recorded. A LONG-LIVED pairing
1059 /// is exactly what #140 is about, so the age is part of the evidence.
1060 #[serde(default, skip_serializing_if = "Option::is_none")]
1061 pub paired_at: Option<String>,
1062 /// The persisted dial HINT, verbatim as stored — the durable state a freshly paired identity
1063 /// does not have. `None` for a peer added without one.
1064 ///
1065 /// It is MERGED with discovery rather than replacing it — iroh inserts it as one more
1066 /// candidate path (`Source::App`) and then triggers address lookup.
1067 ///
1068 /// **But that lookup is skipped when a path is already selected.** iroh's
1069 /// `trigger_address_lookup` returns early if `selected_path.is_some()`, and a selected path is
1070 /// cleared only when the last connection to that peer closes. So on a pair that already holds
1071 /// an open RELAYED connection — live sessions, dial-backs, a working relay — discovery does
1072 /// NOT re-run, and this hint is the only addressing the dial contributes. Do not read "merged,
1073 /// so a stale hint is harmless" as unconditional; it is least true in exactly the state a
1074 /// stuck pairing is in.
1075 ///
1076 /// It is the only durable per-peer state ON THIS NODE'S DISK that the dial path reads, which
1077 /// is what makes it the first thing to compare between two ends. It is not the only durable
1078 /// state a long-lived identity carries — a published discovery record under the same key, and
1079 /// [`SelfNetwork::identity_conflict_epoch`], live elsewhere.
1080 #[serde(default, skip_serializing_if = "Option::is_none")]
1081 pub last_addr: Option<String>,
1082 /// The addresses parsed out of `last_addr`, for reading without a JSON round trip: IP
1083 /// addresses verbatim, relay URLs as `relay <url>` and SANITIZED to scheme+host+port (an
1084 /// operator's relay URL can carry a userinfo token, and this output is meant to be pasted into
1085 /// an issue). Empty when the hint is absent, unparseable, or for a different endpoint — all of
1086 /// which degrade to an id-only dial.
1087 ///
1088 /// A `relay …` entry with no IP alongside it is worth noticing: that hint can never punch.
1089 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1090 pub hint_addrs: Vec<String>,
1091 /// Whether the stored hint actually contributes anything to a dial. `false` with a present
1092 /// `last_addr` means it is being silently discarded — because it does not parse, because its
1093 /// embedded id is a different peer, or (since 0.53.0, #203) because every address in it is one
1094 /// that can never be a QUIC peer and was filtered out. `last_addr` is reported verbatim above,
1095 /// so comparing it against `hint_addrs` distinguishes the three.
1096 pub hint_usable: bool,
1097 /// This node's LIVE view of the peer, read straight from the reachability cache — the same
1098 /// values `status` reports, repeated here so one capture holds both the durable and the live
1099 /// side. `None` when this peer has **never been probed**, which is the honest answer on a
1100 /// freshly restarted daemon; it is not the same as unreachable.
1101 ///
1102 /// Read from the cache rather than through `status`'s projection deliberately: that projection
1103 /// spawns a background probe for every stale peer, which would make this diagnostic a
1104 /// participant in the reproduction it is meant to observe.
1105 #[serde(default, skip_serializing_if = "Option::is_none")]
1106 pub reachability: Option<PeerReachability>,
1107 /// What **iroh** currently holds for this endpoint, as opposed to what this node stored
1108 /// (#140, `api_minor >= 56`). The other half of the capture, and the half the standing
1109 /// hypothesis lives in.
1110 ///
1111 /// Everything above describes our own disk. Until this field there was no way to see what iroh
1112 /// made of it — whether the hint's addresses are in its remote map at all, whether discovery
1113 /// contributed anything alongside them, or which address is carrying traffic. Read straight off
1114 /// `Endpoint::remote_info`, a point read of the remote map: no dial, no probe, no address
1115 /// lookup, so this stays safe to run ON a live reproduction.
1116 ///
1117 /// **`None` means iroh currently holds NO ENTRY — which is not the same as an empty list, and
1118 /// is not the same as "never heard of".** iroh reaps a remote's state about 60 seconds after
1119 /// the last connection to it closes (`ACTOR_MAX_IDLE_TIMEOUT`), so `None` is the normal answer
1120 /// both for a peer never dialled AND for one talked to a few minutes ago. An empty list means
1121 /// iroh has an entry and holds no address in it.
1122 ///
1123 /// This distinction matters most to the question #140 is asking, which is about durability over
1124 /// time: reading `None` as "iroh never knew this peer" would be wrong on any daemon that has
1125 /// been idle, which is most of them.
1126 #[serde(default, skip_serializing_if = "Option::is_none")]
1127 pub known_addrs: Option<Vec<KnownAddr>>,
1128 /// Addresses in [`hint_addrs`](Self::hint_addrs) that iroh does **not** currently hold.
1129 ///
1130 /// The hint is written whole: `set_last_addr` REPLACES the stored value with one built from the
1131 /// live connection's open IP paths, so these are not accumulated cruft — they are addresses
1132 /// that were real at the last successful connection and are absent from iroh's view now. (An
1133 /// earlier version of this doc said #124 "amends but never removes"; that is false, and
1134 /// `dial_hint.rs` says so in as many words.)
1135 ///
1136 /// **Empty whenever [`known_addrs`](Self::known_addrs) is `None`**, because there is no view to
1137 /// difference against. Reporting the whole hint as unknown when iroh simply has no entry would
1138 /// call a current, correct hint stale on every idle daemon.
1139 ///
1140 /// INFERRED by set difference, not read: iroh 1.0.3's `TransportAddrInfo` carries no
1141 /// provenance, so "did this come from our hint or from discovery?" cannot be answered directly.
1142 /// Naming it an inference is the honest version.
1143 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1144 pub hint_addrs_unknown_to_iroh: Vec<String>,
1145 /// The converse: what iroh holds that our stored hint does not name — inferred the same way,
1146 /// and empty for the same reason when [`known_addrs`](Self::known_addrs) is `None`.
1147 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1148 pub iroh_addrs_not_in_hint: Vec<String>,
1149}
1150
1151/// One address iroh holds for a peer (#140, `api_minor >= 56`).
1152///
1153/// Rendered by the SAME labelling [`PeerDiagnosticsResult::hint_addrs`] uses — IPs verbatim, relays
1154/// as `relay <url>` sanitized to scheme+host+port — because the two lists exist to be read side by
1155/// side, and differently-formatted addresses would make a formatting difference look like a real
1156/// one. The sanitization is not optional here either: this output is meant to be pasted into a
1157/// public issue, and an operator's relay URL can carry a userinfo token.
1158#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1159pub struct KnownAddr {
1160 /// The address, labelled as above.
1161 pub addr: String,
1162 /// Whether iroh reports this address as in ACTIVE use, as opposed to merely known.
1163 ///
1164 /// **One bit, and it collapses three states.** iroh maps only `PathStatus::Open` to active;
1165 /// `Inactive`, `Unusable` ("we attempted holepunching and it didn't work") and `Unknown` ("we
1166 /// have not yet attempted holepunching") all render `false`. So an idle direct address beside an
1167 /// active relay is *consistent with* #140's selected-path hypothesis and equally consistent with
1168 /// an ordinary failed hole-punch — which is a NAT diagnosis, the opposite conclusion. This field
1169 /// cannot discriminate them; it says what is carrying traffic and no more.
1170 pub active: bool,
1171}
1172
1173/// Params of [`Request::PeerHintClear`] (#140): whose stored dial hint to forget.
1174#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1175#[serde(deny_unknown_fields)]
1176pub struct PeerHintClearParams {
1177 /// Nickname / `eid:` / `b64u:` — the same vocabulary every other peer verb takes.
1178 pub peer: String,
1179}
1180
1181/// Result of [`Request::PeerHintClear`] (#140).
1182#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1183pub struct PeerHintClearResult {
1184 /// How many hints were removed. A `b64u:` user_id names EVERY device of that person and the
1185 /// racing dial path attaches a hint for each, so clearing "the" hint would leave the pairing
1186 /// still addressing from stored state while reporting success. Every device is cleared, and the
1187 /// count says how many actually had one.
1188 ///
1189 /// `0` means nothing was stored — already the state this verb produces, so a no-op, not an error.
1190 pub cleared: usize,
1191 /// The raw hints removed, verbatim, in the order the devices resolved.
1192 ///
1193 /// **This is the undo.** There is no `peer_hint_set`, and on the pairing this verb targets the
1194 /// hint may never be rewritten on its own: `dial_hint::refresh` is the only writer outside
1195 /// pairing, and it deliberately declines to store anything for a RELAY-ONLY connection — which
1196 /// is the defining property of a stuck pair. Keep this value; re-pairing is otherwise the only
1197 /// way back.
1198 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1199 pub forgotten: Vec<String>,
1200}
1201
1202/// Params of [`Request::UnregisterService`] (#50): the persistent (or ephemeral) service name
1203/// to remove — the deregistration mirror of `register_service`.
1204#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1205#[serde(deny_unknown_fields)]
1206pub struct UnregisterServiceParams {
1207 pub name: String,
1208}
1209
1210/// Params of [`Request::ServiceAllowGrant`] / [`Request::ServiceAllowRevoke`] (#44): toggle a
1211/// single stable `principal` (`b64u:`/`eid:`) on a single `service`'s allow list, WITHOUT
1212/// unpairing. The per-peer "sharing" switch primitive the embedder drives.
1213#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1214#[serde(deny_unknown_fields)]
1215pub struct ServiceAllowParams {
1216 pub service: String,
1217 pub principal: String,
1218}
1219
1220/// Params of [`Request::SetNickname`]: this node's new self-nickname (#37). Display-only
1221/// semantics: it names this node in FUTURE invites/presentations; peers keep the nickname
1222/// they stored at pairing time until a re-invite.
1223#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1224#[serde(deny_unknown_fields)]
1225pub struct SetNicknameParams {
1226 pub nickname: String,
1227}
1228
1229/// Params of [`Request::SetRosterUrl`]: the HTTPS roster URL to pin.
1230#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1231#[serde(deny_unknown_fields)]
1232pub struct SetRosterUrlParams {
1233 pub url: String,
1234}
1235
1236/// Params of [`Request::SetRelays`] (#53): the node's desired CUSTOM relay set. Declarative —
1237/// "make the custom relay set exactly this" — applied as a live insert/remove diff against the
1238/// running endpoint (iroh 1.0.3 `Endpoint::insert_relay`/`remove_relay`) when the node is already
1239/// in `relay_mode = "custom"`, then persisted to `[network]`. Each entry must parse as an iroh
1240/// `RelayUrl`; an empty list is rejected (custom mode requires ≥1 relay — fully disabling relays
1241/// is a `relay_mode = "disabled"` restart, not this verb). Switching a node that is currently
1242/// `default`/`disabled` onto custom persists the config but needs a restart to take effect (iroh
1243/// cannot live-transition the relay MODE) — signalled by [`SetRelaysResult::restart_required`].
1244#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1245#[serde(deny_unknown_fields)]
1246pub struct SetRelaysParams {
1247 pub relay_urls: Vec<String>,
1248}
1249
1250/// Result of [`Request::SetRelays`] (#53).
1251#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1252pub struct SetRelaysResult {
1253 /// The persisted `relay_urls` differed from the prior config (a no-op edit → `false`).
1254 pub changed: bool,
1255 /// `true` iff the node's current `relay_mode` is not `custom`, so the new set was persisted
1256 /// but NOT applied live — a node restart is required for it to take effect. `false` on the
1257 /// live custom→custom path (already applied to the running endpoint).
1258 pub restart_required: bool,
1259}
1260
1261/// Params of [`Request::BlobPublish`]: the scope to publish into and the LOCAL file to add.
1262#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1263#[serde(deny_unknown_fields)]
1264pub struct BlobPublishParams {
1265 pub scope: String,
1266 pub path: String,
1267}
1268
1269/// Params of [`Request::BlobGrant`]: the scope and the flat-namespace principal to grant it to.
1270#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1271#[serde(deny_unknown_fields)]
1272pub struct BlobGrantParams {
1273 pub scope: String,
1274 pub principal: String,
1275}
1276
1277/// Params of [`Request::BlobRevoke`] (#62): the scope and the principals to withdraw from it.
1278///
1279/// SCOPED, unlike unpair hygiene: only the named scope's grants change. A principal that also holds
1280/// grants on other scopes keeps them — withdrawing access to one thing must not silently withdraw
1281/// access to everything else.
1282#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1283#[serde(deny_unknown_fields)]
1284pub struct BlobRevokeParams {
1285 pub scope: String,
1286 pub principals: Vec<String>,
1287}
1288
1289/// Params of [`Request::BlobUnpublish`] (#62): the scope and the blake3 hex to remove from it.
1290///
1291/// Removes REACHABILITY, not bytes. The scope gate requires a hash to be listed in some scope, so
1292/// this takes effect immediately for authorization — but the bytes stay in the local store until a
1293/// GARBAGE-COLLECTION sweep reclaims them, and only a node that set `[blobs].gc_interval` runs one
1294/// (#80, `api_minor >= 49`). There is no reclaim VERB — collection is periodic and configured at
1295/// store construction, so "deleted" means "deleted within an interval" at best. On a node with no
1296/// interval configured — the default — the bytes stay forever. Do not surface this to a user as
1297/// deletion unless you know the node collects.
1298#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1299#[serde(deny_unknown_fields)]
1300pub struct BlobUnpublishParams {
1301 pub scope: String,
1302 pub hash: String,
1303}
1304
1305/// Params of [`Request::BlobRepublish`] (#83): the scope and the blake3 hex to add to it.
1306///
1307/// The blob must already be held COMPLETE by this daemon — republish makes a fetched blob servable
1308/// FROM this node, it does not fetch. A hash that is absent, or only partially present from an
1309/// interrupted fetch, is refused with [`ERR_NO_SUCH_BLOB`]: advertising bytes we cannot serve would
1310/// turn the original publisher going offline into a hang at every fetcher.
1311///
1312/// It grants NOBODY. The republisher names a scope they already control; inheriting the original
1313/// publisher's grants would be a silent authorization transfer. Share with `blob_grant`.
1314#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1315#[serde(deny_unknown_fields)]
1316pub struct BlobRepublishParams {
1317 pub scope: String,
1318 pub hash: String,
1319}
1320
1321/// Params of [`Request::BlobFetch`]: the `mcpmesh/blob/1` ticket and the LOCAL export path.
1322#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1323#[serde(deny_unknown_fields)]
1324pub struct BlobFetchParams {
1325 pub ticket: String,
1326 pub dest_path: String,
1327 /// ADDITIONAL sources to try if the ticket's publisher does not answer (#83).
1328 /// `api_minor >= 47`.
1329 ///
1330 /// Content addressing makes every recipient a potential source, and without this the control
1331 /// API made that unusable: a ticket names ONE address, so a file shared with a room became
1332 /// unfetchable the moment the sender closed their laptop — even though other people in the room
1333 /// already held the identical, verified bytes.
1334 ///
1335 /// Each entry is a stable principal (`eid:` device, `b64u:` user_id) or a paired nickname —
1336 /// the same vocabulary `open_session` takes. They are preferred **in order, after** the ticket's
1337 /// own address, so the publisher stays the first choice and a live one costs nothing —
1338 /// alternates are not dialled at all when it answers.
1339 ///
1340 /// Since 0.49.1 the dials are **hedged**: an alternate starts about a second after a source has
1341 /// failed to answer, rather than after that source's full dial timeout. A source unreachable at
1342 /// the head of the list therefore costs about a second, not twenty, and a long `from` list is no
1343 /// longer a long wait. Each source is still dialled at most once.
1344 ///
1345 /// **An alternate only works if it can serve you.** The bytes are BLAKE3-verified against the
1346 /// ticket's hash whoever supplies them, so a hostile alternate cannot substitute content — but
1347 /// it must have republished the hash into a scope that grants you, or it answers with a
1348 /// permission refusal and the fetch moves on. Every failure mode falls through, not only an
1349 /// unreachable dial: a refusal, a missing hash, a mid-stream reset, and a stalled transfer all
1350 /// move to the next source.
1351 ///
1352 /// Additive: absent from an older caller's payload and read as empty, which is the
1353 /// single-source behaviour.
1354 /// Capped at [`MAX_BLOB_SOURCES`]; more is an error rather than a silent truncation.
1355 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1356 pub from: Vec<String>,
1357}
1358
1359/// The ceiling on [`BlobFetchParams::from`] (#83).
1360///
1361/// Naming a PERSON expands to every device of theirs, so the list a caller writes is not the number
1362/// of dials it buys. Comfortably above "everyone in a room", far below anything that turns a fetch
1363/// into an hour.
1364///
1365/// **The justification changed in 0.49.1 and the number did not.** Until then sources were tried
1366/// strictly in turn, each costing up to a dial timeout, so the cap bounded a WAIT. Dials are now
1367/// hedged, which bounds the wait by roughly a second per unresponsive source instead — but the cap
1368/// still bounds the WORK: a fetch holds one of the connection's [`MAX_INFLIGHT`] slots, and a long
1369/// list is a long list of other people's machines being asked to answer.
1370///
1371/// Exceeding it is an ERROR, not a truncation: silently dropping the tail would make a fetch fail
1372/// while the source that had the blob sat unused, which is exactly what this feature exists to
1373/// prevent.
1374pub const MAX_BLOB_SOURCES: usize = 32;
1375
1376/// Params of [`Request::BlobFetchCancel`] (#172): stop every in-flight [`Request::BlobFetch`] of
1377/// this blob.
1378///
1379/// Keyed by HASH, not by JSON-RPC id, and the reason is not aesthetic: [`crate::ControlClient`]
1380/// borrows `&mut self` for a request's whole duration, so a client physically cannot send an
1381/// id-keyed cancel down the connection whose request it would name. A hash is reachable from
1382/// anywhere — including a fresh connection — and it is already the key a consumer holds, since
1383/// every [`crate::StreamFrame::BlobTransfer`] carries it.
1384#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1385#[serde(deny_unknown_fields)]
1386pub struct BlobFetchCancelParams {
1387 /// The blob's BLAKE3 hash, hex — as it appears on `BlobTransfer` frames and `BlobFetchResult`.
1388 pub hash: String,
1389}
1390
1391/// Control-API requests. Serialized as `{ "method": "...", "params": {...} }`
1392/// (JSON-RPC-shaped; the id/jsonrpc envelope is added by the transport layer).
1393///
1394/// Each param-carrying variant wraps its named `*Params` struct — the ONE wire truth for that
1395/// method's params, shared by clients (which serialize whole `Request`s) and the daemon (which
1396/// deserializes `params` into the same struct after its method-string dispatch). Adjacent
1397/// tagging serializes a newtype variant's content as the struct's fields, so the wire shape is
1398/// identical to inline variant bodies.
1399///
1400/// **Servers dispatch on the `method` string and deserialize `params` per-method** — tolerating
1401/// omitted / null / empty-object params for parameterless methods — rather than deserializing a
1402/// whole message into `Request` (adjacent tagging rejects `params:{}` for unit variants).
1403/// This keeps the wire tolerant for third-party clients (the versioned, additive-only surface).
1404/// Use [`method_of`] to extract the tag, then match + deserialize `params` per-method.
1405#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1406#[serde(tag = "method", content = "params", rename_all = "snake_case")]
1407pub enum Request {
1408 /// Register/update a `[services.*]` entry idempotently.
1409 RegisterService(RegisterServiceParams),
1410 Status,
1411 /// Mint a pairing invite granting `services` — single-use unless `max_uses` says otherwise
1412 /// (#87). The daemon
1413 /// answers an [`InviteResult`] carrying the copyable `mcpmesh-invite:` line. Tag
1414 /// `"invite"` (snake_case). `method_of` needs no per-variant arm — it reads the
1415 /// `method` string generically; the tag comes from `rename_all`.
1416 Invite(InviteParams),
1417 /// Redeem a pairing invite. The daemon dials the inviter named by
1418 /// `invite_line` on `mcpmesh/pair/1`, proves the secret, writes the mutual
1419 /// (dial-back) `PeerEntry`, and answers a [`PairResult`]. Tag `"pair"`
1420 /// (snake_case); `method_of` reads the `method` string generically.
1421 ///
1422 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
1423 Pair(PairParams),
1424 /// Remove a paired peer by nickname (`mcpmesh pair --remove`). The daemon drops the
1425 /// peer's `PeerEntry` (identity) AND revokes its access by stripping its stable principals from every
1426 /// `[services.*].allow` (authorization) — the inverse of the pairing grant. Idempotent: a
1427 /// nickname with no entry / no allow membership is a clean no-op. Live in-flight sessions are
1428 /// NOT severed here: existing sessions run to completion; the peer only loses the
1429 /// ability to establish NEW authorized sessions. Tag `"peer_remove"` (snake_case);
1430 /// `method_of` reads the `method` string generically (no per-variant arm).
1431 ///
1432 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
1433 PeerRemove(PeerRemoveParams),
1434 /// Rename a contact's nickname (nickname) authoritatively. Renames the
1435 /// PERSON — every `PeerEntry` sharing `user_id` when given (one op for all their devices), else the
1436 /// single `nickname` entry (a provisional, no-`user_id` contact) — to `to`, AND rewrites the old
1437 /// nickname → `to` in every `[services.*].allow` so grants follow the rename. Refuses (error frame)
1438 /// when `to` is empty or already names/grants a DIFFERENT identity — the same collision guard the
1439 /// pairing rendezvous uses, so a rename can't inherit another peer's access. Tag `"peer_rename"`;
1440 /// host-privileged like the other pair ops.
1441 PeerRename(PeerRenameParams),
1442 /// Mint an attestation OFFER (#85 ask 3): a `mcpmesh-attest:` line telling another device of a
1443 /// person you already pair with where to dial. Tag `"attest_offer"`.
1444 ///
1445 /// **Carries nothing secret** — the offering node's id and address, both of which an invite
1446 /// line already carries in the clear. It exists because a device freshly restored from a
1447 /// recovery phrase holds no rows and so has no way to find anyone.
1448 ///
1449 /// Refused unless this node has `[identity].admit_attested_devices` on: an offer it would not
1450 /// honour is worse than no offer.
1451 AttestOffer,
1452 /// Present THIS device's identity to a peer, using their `mcpmesh-attest:` line (#85 ask 3).
1453 /// Tag `"attest_to"`.
1454 ///
1455 /// The recovery path's second half: `user_key_import` restores the `b64u:` your peers pinned,
1456 /// and this is what gets the machine holding it ADMITTED. Requires a user key — with none there
1457 /// is nothing to attest.
1458 ///
1459 /// The peer admits this device only if it already holds a row for this person, has opted in,
1460 /// and has revoked neither this endpoint nor the IDENTITY. It cannot admit a stranger.
1461 AttestTo(AttestToParams),
1462 /// REVOKE an endpoint locally: "I no longer trust this device" (#85 ask 4). Tag
1463 /// `"peer_revoke"`.
1464 ///
1465 /// **Not the same act as [`PeerRemove`](Self::PeerRemove), deliberately.** Removal is routine —
1466 /// we are not working together any more — and re-pairing afterwards is normal. Revocation is a
1467 /// claim about COMPROMISE, and it outlives the pair row: a revoked endpoint is refused whether
1468 /// or not it is in the allowlist, so it cannot be undone by a fresh pairing. Making them one
1469 /// verb would either make removal irreversible or make revocation weak.
1470 ///
1471 /// Takes effect IMMEDIATELY, like `service_allow_revoke` (#54): live sessions are severed
1472 /// rather than left to end on their own, which for long-lived MCP sessions is unbounded.
1473 ///
1474 /// A `b64u:` principal revokes EVERY endpoint this node associates with that person — the "not
1475 /// on any of their devices" case, which an operator will otherwise get wrong doing it device by
1476 /// device.
1477 ///
1478 /// Reversible with [`PeerUnrevoke`](Self::PeerUnrevoke): this list is LOCAL and not
1479 /// authoritative for anyone else, so an operator mistake has to be fixable. Both directions are
1480 /// audited.
1481 PeerRevoke(PeerRevokeParams),
1482 /// Lift a local revocation (#85 ask 4). Tag `"peer_unrevoke"`. Idempotent.
1483 ///
1484 /// Restores the peer only if its pair row still exists — revocation never deleted it. A
1485 /// revocation applied from a SIGNED statement can be lifted too: the signature proved who asked,
1486 /// not that this node must obey forever.
1487 PeerUnrevoke(PeerUnrevokeParams),
1488 /// Sign a revocation of one of THIS node's own endpoints with THIS node's user key (#85 ask 4),
1489 /// producing a portable token. Tag `"device_revoke"`.
1490 ///
1491 /// The direction that matters, and the one local revocation cannot express: my laptop was
1492 /// stolen, and my peers cannot discover that by themselves. I have to tell them, and they have
1493 /// to be able to verify it was me.
1494 ///
1495 /// Requires a user key — a node with none has no authority to speak for its person.
1496 /// **Distribution is out of band**: pairing mode has no gossip, so getting the token to your
1497 /// peers is the same problem as getting them an invite line, and has the same answer.
1498 DeviceRevoke(DeviceRevokeParams),
1499 /// Apply a signed device revocation from a peer (#85 ask 4). Tag `"device_revocation_import"`.
1500 ///
1501 /// Refused unless this node ALREADY trusts the signing `user_id` (holds a paired entry carrying
1502 /// it) **and** the revoked endpoint is one this node associates with that same person, or is
1503 /// entirely unknown to it. That bound is what keeps this from being an "mark any endpoint dead"
1504 /// primitive: a peer may kill their OWN devices in your node, and nothing else.
1505 DeviceRevocationImport(DeviceRevocationImportParams),
1506 /// RESERVED / INTERNAL (`docs/local-protocol.md` "Reserved / internal methods"): install a
1507 /// peer directly from a raw `endpoint_id` — the trust-population stand-in for pairing behind
1508 /// `mcpmesh internal peer add`. A deliberate, documented exception to the surface discipline
1509 /// (raw endpoint identifiers otherwise never cross this socket); NOT part of the stable
1510 /// vocabulary — do not build on it. Tag `"peer_add"`.
1511 PeerAdd(PeerAddParams),
1512 /// Install a peer from a SIGNED endorsement by someone you are already paired with (#65) —
1513 /// O(N) onboarding for a small group, without a fresh two-human SAS ceremony per pair.
1514 ///
1515 /// **It installs IDENTITY, never AUTHORIZATION.** The subject becomes resolvable; it is granted
1516 /// nothing. Service access stays principal-keyed in config (#38) and an explicit, separate act.
1517 /// That is what bounds the feature: a compromised endorser can make you KNOW about an attacker,
1518 /// it cannot make you SERVE one.
1519 ///
1520 /// Unlike [`PeerAdd`](Self::PeerAdd) — which is reserved precisely because the caller merely
1521 /// ASSERTS an id — this is verifiable: the endorsement is checked against a user key you
1522 /// already hold from pairing with the endorser. Tag `"peer_introduce"`.
1523 PeerIntroduce(PeerIntroduceParams),
1524 /// PRODUCE an endorsement of a peer, for someone else to redeem with
1525 /// [`PeerIntroduce`](Self::PeerIntroduce) (#65). The other half of an introduction: without it
1526 /// nothing can generate `evidence`, and the install half is unusable.
1527 ///
1528 /// Signs with THIS node's user key, so the result is only meaningful to someone who has paired
1529 /// with you. Endorsing does not change your own trust in the subject. Tag `"peer_endorse"`.
1530 PeerEndorse(PeerEndorseParams),
1531 /// Open a mesh session to `peer/service`; the daemon dials and pipes.
1532 /// Distinct from the proxy's job: this returns a session the client streams.
1533 /// Named `open_session` rather than `connect` to avoid colliding
1534 /// with the `connect` porcelain.
1535 OpenSession(OpenSessionParams),
1536 /// Install a signed roster from a local file (the manual `internal roster install` path).
1537 /// `path` is a LOCAL file the same-uid daemon reads (the daemon runs as the caller's own
1538 /// uid, so passing a path rather than the bytes crosses no trust boundary). `org_root_pk`
1539 /// pins the org root on FIRST install (`b64u:`); omit it
1540 /// once pinned (config carries it). Tag `"roster_install"`.
1541 RosterInstall(RosterInstallParams),
1542 /// Read the installed roster's MEMBERSHIP: the declared groups, and every person with their
1543 /// display name, groups, and devices (#93). Parameterless. Tag `"roster_members"`.
1544 ///
1545 /// The read half of roster mode. `status` reports that a roster exists (`RosterStatus`) and who
1546 /// is currently online (`PresencePeer`); neither answered "who is in this org" — a person with
1547 /// no live device appeared nowhere at all, so an embedder could not draw a member list, and
1548 /// the only route to one was hand-parsing the daemon-owned `roster.json`.
1549 ///
1550 /// ADVISORY and display-oriented, like `status`: the gate reads the roster document, never
1551 /// this. Empty in a pure-pairing daemon or before the first roster is installed.
1552 RosterMembers,
1553 /// AUTHOR an org: mint this node's org root key, sign an empty roster (serial 1), install it
1554 /// (which pins the root), and return the copyable org invite (#66). Tag `"org_create"`.
1555 ///
1556 /// One-time per node — a second call is refused rather than replacing the key, because
1557 /// replacing it would orphan every roster it has signed.
1558 OrgCreate(OrgCreateParams),
1559 /// APPROVE a join code into the roster: verify its device→user-key binding, upsert the member
1560 /// with the given groups, bump the serial, re-sign, install (#66). Tag `"org_approve"`.
1561 ///
1562 /// The cryptographic half of the ceremony. Verifying that the code came from the PERSON you
1563 /// think it did stays an out-of-band human step, and `join_code_fingerprint` in the result is
1564 /// what the two humans compare.
1565 OrgApprove(OrgApproveParams),
1566 /// ROTATE the org root (#93 ask c). Tag `"org_rotate"`.
1567 ///
1568 /// The org's trust anchor is one pinned key, and nothing could move it: an operator laptop that
1569 /// died took the org with it 90 days later, when the roster expired — and the delay is what
1570 /// made that hard to diagnose. Recovery was O(N) fresh ceremonies with every member.
1571 ///
1572 /// Publishes a roster signed by the SUCCESSOR carrying a cross-signature by the CURRENT root, so
1573 /// a member still pinned to the current key adopts the successor with the key it already has.
1574 /// The bridge rides every subsequent roster, so a member offline for one publication catches up
1575 /// — but one two rotations behind needs a fresh `org_join`.
1576 ///
1577 /// **This is not escrow.** If the current root key is LOST there is nothing to sign the bridge
1578 /// with. Copying `org-root.key` to a second operator machine already works and remains the
1579 /// answer for that.
1580 OrgRotate(OrgRotateParams),
1581 /// INSPECT a join code without approving it (#66): who it claims to be, and the fingerprint the
1582 /// two humans compare. Read-only — nothing is signed, installed, or persisted.
1583 /// Tag `"org_join_code"`.
1584 ///
1585 /// This is what makes an "approve this person" button correct rather than merely possible. The
1586 /// fingerprint has to be shown and confirmed out-of-band BEFORE the approval, because a
1587 /// substituted code is caught there or not at all — and reading it off `OrgApprove`'s result
1588 /// is too late, the member is already in the signed roster. The CLI always had this (it
1589 /// decoded the code locally); an embedder could not, since the join-code format lives in
1590 /// `mcpmesh-node` and not on this seam.
1591 OrgJoinCode(OrgJoinCodeParams),
1592 /// REVOKE from the roster: remove a person, one device, or a person's user key, then bump,
1593 /// re-sign, and install — which severs the cut devices' live sessions (#66).
1594 /// Tag `"org_revoke"`.
1595 OrgRevoke(OrgRevokeParams),
1596 /// EXPORT this node's user key as a recovery phrase (#85 ask 2). Parameterless.
1597 /// Tag `"user_key_export"`.
1598 ///
1599 /// **The phrase IS the private key**, in a form a human can write down. Anyone who reads it can
1600 /// present this identity. It is deliberately not logged, not audited, and not echoed anywhere
1601 /// but this response.
1602 UserKeyExport,
1603 /// IMPORT a user key from a recovery phrase (#85 ask 2), so a person's `b64u:` survives the
1604 /// hardware. Tag `"user_key_import"`.
1605 UserKeyImport(UserKeyImportParams),
1606 /// Pin the org root on a JOINER — WITHOUT a roster (the joiner has none yet; its poll loop
1607 /// fetches the first one). Records `[identity]` org_id / org_root_pk / user_id / user_key.
1608 /// `user_key` is a LOCAL path
1609 /// (the key never crosses the API). Tag `"org_join"`.
1610 OrgJoin(OrgJoinParams),
1611 /// Pin the HTTPS roster URL (`[roster].url`) in config. Written by `org create
1612 /// --roster-url` (the operator keeps it current) AND by `join` when the org invite carries one —
1613 /// so the joiner's poll loop bootstraps its FIRST roster. The daemon writes it under
1614 /// `reload_lock` (single-writer), then the poll loop picks it up on the next daemon start. Tag
1615 /// `"set_roster_url"`.
1616 SetRosterUrl(SetRosterUrlParams),
1617 /// Rename this node LIVE (#37): validate + upsert `[identity].nickname` through the
1618 /// daemon's own serialized config-write path (no lost-update window against a
1619 /// concurrent grant/registration) and update the in-memory name future invites
1620 /// present — no restart. Ack result. Tag `"set_nickname"` (snake_case).
1621 SetNickname(SetNicknameParams),
1622 /// Set this node's opaque app-metadata blob (#39): validated (≤256B) and folded, signed,
1623 /// into each outgoing presence heartbeat, so paired roster peers see it in their `status`
1624 /// presence — no per-peer session. Ack result. Tag `"set_app_metadata"`. In-memory (lost
1625 /// on restart; the embedder re-sets on startup).
1626 SetAppMetadata(SetAppMetadataParams),
1627 /// Set this node's CUSTOM relay set LIVE (#53): validate each URL as an iroh `RelayUrl`, diff
1628 /// against the running endpoint's current custom relays and apply the delta via iroh 1.0.3
1629 /// `Endpoint::insert_relay`/`remove_relay` (no endpoint rebuild, no dropped sessions), then
1630 /// persist `[network] relay_mode="custom" relay_urls=[…]` under `reload_lock`. When the node
1631 /// is currently `default`/`disabled`, the config is persisted but the live mode transition
1632 /// isn't possible — [`SetRelaysResult::restart_required`] is `true`. Answers a
1633 /// [`SetRelaysResult`]. Tag `"set_relays"`.
1634 SetRelays(SetRelaysParams),
1635 /// Grant a single stable principal access to a single service's allow (#44) — the per-peer
1636 /// "sharing on" toggle, idempotent + serialized under the config lock. Ack result.
1637 /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
1638 /// Removes the whole `[services.<name>]` entry (allow included) + any ephemeral one, then
1639 /// hot-reloads. Idempotent. Ack result.
1640 UnregisterService(UnregisterServiceParams),
1641 /// Discover which services a paired peer CURRENTLY grants the caller (#52) — dials the peer
1642 /// and returns the service names whose allow admits the caller's principal. Answers
1643 /// [`PeerServicesResult`].
1644 PeerServices(PeerServicesParams),
1645 /// Dump the DURABLE per-peer state this node carries for one peer (#140) — the persisted dial
1646 /// hint, the pairing stamp, and the live reachability row, in one capture. A DIAGNOSTIC verb:
1647 /// unlike every other surface it carries transport vocabulary on purpose. Answers with
1648 /// [`PeerDiagnosticsResult`]. `api_minor >= 33`.
1649 PeerDiagnostics(PeerDiagnosticsParams),
1650 /// FORGET the persisted dial hint for one peer (#140) — `api_minor >= 59`.
1651 ///
1652 /// An experiment tool, and a workaround. `PeerEntry.last_addr` is the only durable per-peer
1653 /// state on this node's disk that the dial path reads, and it is the ONLY thing a long-lived
1654 /// pairing carries that a freshly paired identity does not. Nothing invalidates it: a
1655 /// relay-only connection deliberately declines to overwrite it (persisting a relay URL over a
1656 /// direct candidate was #124's own bug), and "learned nothing" means leave alone. So a hint
1657 /// written before a network change can persist indefinitely on a pair whose every connection
1658 /// since has been relayed.
1659 ///
1660 /// Clearing it makes an existing pairing **addressing-equivalent to a fresh identity**, which
1661 /// is exactly the difference #140 is about — a pair that cannot punch as a long-lived pairing
1662 /// while punching in 23ms with fresh identities on the same hardware.
1663 ///
1664 /// **Advisory, never authorization.** A hint is addressing; its absence is a supported state
1665 /// (the dial degrades to id-only, which is what every peer does before its first refresh). The
1666 /// worst case is one slower dial while discovery runs. The peer row, its `user_id`, its
1667 /// services and its pairing stamp are untouched.
1668 ///
1669 /// Nothing clears a hint automatically — choosing an invalidation policy before the data exists
1670 /// is what produced a fix that helped one peer and not this one. Answers
1671 /// [`PeerHintClearResult`].
1672 PeerHintClear(PeerHintClearParams),
1673 ServiceAllowGrant(ServiceAllowParams),
1674 /// Revoke a single stable principal from a single service's allow (#44) — "sharing off"
1675 /// WITHOUT unpairing (the peer's identity row is untouched; only NEW sessions are refused).
1676 /// Idempotent. Ack result.
1677 ServiceAllowRevoke(ServiceAllowParams),
1678 /// Publish a LOCAL file INTO a scope: the daemon adds the bytes to its gated
1679 /// app-blob store and records the hash in `scope`. `path` is a local file the same-uid daemon
1680 /// reads. Answers a [`BlobPublishResult`] carrying the `mcpmesh/blob/1` ticket + hash.
1681 /// Tag `"blob_publish"`.
1682 BlobPublish(BlobPublishParams),
1683 /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id, or a
1684 /// nickname (the shared `principal_set` expansion). Tag
1685 /// `"blob_grant"`.
1686 BlobGrant(BlobGrantParams),
1687 /// Tag `"blob_revoke"`: withdraw principals from ONE scope's grants (#62).
1688 BlobRevoke(BlobRevokeParams),
1689 /// Tag `"blob_unpublish"`: remove a hash from ONE scope (#62). Withdraws reachability, not
1690 /// bytes.
1691 BlobUnpublish(BlobUnpublishParams),
1692 /// #83: make a blob this daemon already holds servable from HERE, in a scope it controls.
1693 /// Answers a [`BlobPublishResult`] — same shape as `blob_publish`, so a client can treat the
1694 /// two interchangeably after a fetch.
1695 BlobRepublish(BlobRepublishParams),
1696 /// List the daemon's blob scopes (name → hashes + grants). Tag `"blob_list"`.
1697 BlobList(BlobListParams),
1698 /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified streaming) and export the
1699 /// verified blob to `dest_path` (a local file the same-uid daemon writes). Answers a
1700 /// [`BlobFetchResult`] with the verified hash + byte length. Tag `"blob_fetch"`.
1701 BlobFetch(BlobFetchParams),
1702 /// Cancel every in-flight [`BlobFetch`](Self::BlobFetch) of one hash (#172). Answers a
1703 /// [`BlobFetchCancelResult`]; the cancelled fetches themselves answer [`ERR_CANCELLED`].
1704 /// Tag `"blob_fetch_cancel"`.
1705 BlobFetchCancel(BlobFetchCancelParams),
1706 /// Summarize this node's LOCAL audit log into per-peer / per-service SESSION counts
1707 /// (local-only — the daemon reads its OWN audit dir, nothing is transmitted). The host Mesh surface
1708 /// renders these as "who serves me / whom I serve / session counts". Parameterless (like `Status`);
1709 /// the server dispatches on the `method` string. Tag `"audit_summary"` (snake_case);
1710 /// `method_of` reads the `method` string generically (no per-variant arm).
1711 AuditSummary,
1712 /// Delete audit months strictly older than `before` (#88) — the retention lever the log
1713 /// never had. Local-only and owner-only (the control socket is the daemon owner's). Answers
1714 /// [`AuditPruneResult`]. Tag `"audit_prune"`.
1715 AuditPrune(AuditPruneParams),
1716 /// Read this node's LOCAL audit records, filtered and paged (#88) — the "show me everything
1717 /// you hold about me" verb. Local-only; nothing is transmitted. Answers
1718 /// [`AuditListResult`]. Tag `"audit_list"`.
1719 AuditList(AuditListParams),
1720 /// Open a live event stream (pairing liveness & health telemetry). Like `open_session`, the
1721 /// connection STOPS being request/response after this call and becomes a one-way push stream
1722 /// of `StreamFrame`s. Parameterless. Tag `"subscribe"`.
1723 Subscribe,
1724}
1725
1726/// Result of [`Request::OrgJoin`] — the pinned org id echoed back (surface-clean; the fingerprint is
1727/// computed porcelain-side from the invite's org_root_pk). Additive-only.
1728#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1729pub struct OrgJoinResult {
1730 pub org_id: String,
1731 /// `true` when the org root was pinned but this node's ROSTER TRANSPORT is not running, so the
1732 /// join is only half in effect until the daemon restarts (#93). `api_minor >= 46`.
1733 ///
1734 /// Roster mode is decided at BOOT: it fixes the ALPN set bound on the endpoint and whether
1735 /// gossip, presence and app-blobs are constructed at all. The roster GATE hot-swaps live. So a
1736 /// node that booted in pairing mode and then joins an org reaches a state where MCP sessions to
1737 /// org members work as soon as a roster arrives, while `status.presence` stays permanently
1738 /// empty and every blob verb hard-closes with `blobs not enabled` — succeeding partially, with
1739 /// no error anywhere, which a caller previously had no way to detect.
1740 ///
1741 /// **What to do with it:** if `true`, tell the user the join succeeded and the node must
1742 /// restart before presence and file sharing work. Do not treat it as a failure — nothing was
1743 /// left half-written; the pin is durable and the restart is sufficient.
1744 ///
1745 /// `false` when the transport is already composed (the node booted with an org root pinned), or
1746 /// on a re-join of an org this node is already in.
1747 ///
1748 /// Same shape as [`SetRelaysResult::restart_required`] (#53), for the same reason. Additive:
1749 /// absent from an older daemon's payload and reads as `false` — which was that daemon's
1750 /// implicit, and wrong, answer.
1751 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1752 pub restart_required: bool,
1753}
1754
1755/// Result of a [`Request::RosterInstall`] request (the manual install path): the installed roster's
1756/// org id + serial (roster-status vocabulary the confirmation line is permitted to render) plus how
1757/// many live sessions the install severed. Surface-clean: NO keys / EndpointIds / paths.
1758///
1759/// Additive-only: any future field MUST land as
1760/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
1761#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1762pub struct RosterInstallResult {
1763 pub org_id: String,
1764 pub serial: u64,
1765 /// How many live sessions were severed, for the porcelain's confirmation line.
1766 #[serde(default)]
1767 pub severed: u32,
1768}
1769
1770/// Params of [`Request::OrgCreate`] (#66).
1771#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1772#[serde(deny_unknown_fields)]
1773pub struct OrgCreateParams {
1774 /// The org's name — its `org_id`, the value every member's roster carries.
1775 pub name: String,
1776 /// How long the signed roster stays valid, in seconds. Omit for the 90-day default.
1777 ///
1778 /// This is an operator-grade default and a sharp edge at small scale: past it the roster
1779 /// degrades and the group stops working, which for a handful of laptops can arrive days after
1780 /// one of them was closed for a long weekend. A small team should pass a long value here
1781 /// deliberately rather than discover the default later.
1782 #[serde(default, skip_serializing_if = "Option::is_none")]
1783 pub expires_secs: Option<i64>,
1784 /// An HTTPS URL where the signed roster will be published. Carried in the org invite (so a
1785 /// joiner bootstraps its first roster) AND pinned in this operator's `[roster].url`.
1786 #[serde(default, skip_serializing_if = "Option::is_none")]
1787 pub roster_url: Option<String>,
1788}
1789
1790/// Result of [`Request::OrgCreate`] (#66).
1791#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1792pub struct OrgCreateResult {
1793 pub org_id: String,
1794 pub serial: u64,
1795 /// The copyable `mcpmesh-org:` invite to hand a joiner — one of the two permitted opaque
1796 /// artifacts on this surface, the same carve-out the pairing invite line takes.
1797 pub org_invite: String,
1798 /// The org root's fingerprint in short words, for the out-of-band read-back that anchors every
1799 /// joiner's trust. NOT the key.
1800 pub org_root_fingerprint: String,
1801}
1802
1803/// Params of [`Request::OrgRotate`] (#93 ask c).
1804#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1805#[serde(deny_unknown_fields)]
1806pub struct OrgRotateParams {
1807 /// Where to read or write the successor key. Omit for `<config>/org_root_next.key`.
1808 ///
1809 /// Reused if it already exists, so a rotation can be prepared on a machine that is not the one
1810 /// publishing it.
1811 #[serde(default, skip_serializing_if = "Option::is_none")]
1812 pub new_key_path: Option<String>,
1813}
1814
1815/// Result of [`Request::OrgRotate`] (#93 ask c).
1816#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
1817pub struct OrgRotateResult {
1818 pub org_id: String,
1819 pub serial: u64,
1820 /// The new anchor, `b64u:`. Members adopt it as they receive the roster.
1821 pub new_root_pk: String,
1822 /// Short fingerprints, for an operator to read out when telling members what changed.
1823 pub old_root_fingerprint: String,
1824 pub new_root_fingerprint: String,
1825}
1826
1827/// Params of [`Request::OrgApprove`] (#66).
1828#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1829#[serde(deny_unknown_fields)]
1830pub struct OrgApproveParams {
1831 /// The `mcpmesh-join:` code the joiner sent.
1832 pub join_code: String,
1833 /// The groups to grant. Each must be DECLARED in the roster (see
1834 /// [`RosterMembersResult::groups`]) — an undeclared one is refused, because it would make an
1835 /// `allow` entry naming it ambiguous.
1836 #[serde(default)]
1837 pub groups: Vec<String>,
1838 /// Override the `user_id` the joiner requested. Omit to accept theirs.
1839 ///
1840 /// Worth using: the requested id is chosen by the person being approved, and it is the string
1841 /// every `allow` entry will name.
1842 #[serde(default, skip_serializing_if = "Option::is_none")]
1843 pub user_id: Option<String>,
1844}
1845
1846/// Result of [`Request::OrgApprove`] (#66).
1847#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1848pub struct OrgApproveResult {
1849 pub user_id: String,
1850 pub groups: Vec<String>,
1851 pub org_id: String,
1852 pub serial: u64,
1853 /// The join code's fingerprint in short words — the enrollment analogue of the pairing SAS.
1854 ///
1855 /// **Show this to the operator and have them confirm it out-of-band before trusting the
1856 /// approval.** Nothing else binds the person to the `user_pk` in the code, so a substituted
1857 /// code is caught here or not at all. Returned rather than checked, because only the human can
1858 /// check it.
1859 pub join_code_fingerprint: String,
1860}
1861
1862/// Params of [`Request::UserKeyImport`] (#85 ask 2).
1863#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
1864#[serde(deny_unknown_fields)]
1865pub struct UserKeyImportParams {
1866 /// The recovery phrase, as written down. Whitespace and case are forgiven; a wrong word, the
1867 /// wrong count, or a failed checksum are refused by position rather than guessed at.
1868 pub recovery_phrase: String,
1869 /// Replace an EXISTING user key. Defaults to `false`, and the refusal is the point: importing
1870 /// over a live key discards the identity this node currently presents, which is irreversible
1871 /// without that key's own phrase.
1872 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1873 pub replace: bool,
1874}
1875
1876/// Result of [`Request::UserKeyExport`] (#85 ask 2).
1877///
1878/// **`recovery_phrase` is the private key.** Show it to the person who owns it, once, and do not
1879/// persist it anywhere your application would not persist the key file itself.
1880#[derive(Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1881pub struct UserKeyExportResult {
1882 /// 33 words. Write them down in order.
1883 pub recovery_phrase: String,
1884 /// The `b64u:` identity this phrase restores — safe to display and to record, unlike the
1885 /// phrase. Compare it after an import to confirm the right identity came back.
1886 pub user_id: String,
1887}
1888
1889/// REDACTING `Debug` — the phrase is a private key, and a derived one would put it in any
1890/// `tracing::debug!(?params)` a future change adds to the dispatch, or in an embedder's `dbg!`.
1891/// Three lines to make that leak unrepresentable rather than merely absent today.
1892impl std::fmt::Debug for UserKeyImportParams {
1893 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1894 f.debug_struct("UserKeyImportParams")
1895 .field("recovery_phrase", &"<redacted>")
1896 .field("replace", &self.replace)
1897 .finish()
1898 }
1899}
1900
1901/// REDACTING `Debug` — see [`UserKeyImportParams`]. The `user_id` is safe and is kept, because a
1902/// `{:?}` with nothing in it is worse for debugging than one with the non-secret half.
1903impl std::fmt::Debug for UserKeyExportResult {
1904 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1905 f.debug_struct("UserKeyExportResult")
1906 .field("recovery_phrase", &"<redacted>")
1907 .field("user_id", &self.user_id)
1908 .finish()
1909 }
1910}
1911
1912/// Result of [`Request::UserKeyImport`] (#85 ask 2).
1913#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1914pub struct UserKeyImportResult {
1915 /// The `b64u:` identity now in effect. **Compare it against the one you are recovering** — the
1916 /// phrase's checksum catches most transcription errors, but a `user_id` that does not match is
1917 /// the definitive answer, and the only one that distinguishes "restored the wrong key" from
1918 /// "peers have not seen me yet".
1919 pub user_id: String,
1920 /// `true` when this discarded a REAL identity — a user key the node had loaded from disk,
1921 /// rather than one it minted at this boot and had never presented to anyone.
1922 ///
1923 /// The distinction is the useful one: a fresh node always has a key on disk before an import
1924 /// can run (its own boot mints one), so "a file existed" would be `true` for every recovery on
1925 /// new hardware and would have a UI warn that something was destroyed when nothing was.
1926 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1927 pub replaced: bool,
1928}
1929
1930/// Params of [`Request::OrgJoinCode`] (#66).
1931#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1932#[serde(deny_unknown_fields)]
1933pub struct OrgJoinCodeParams {
1934 /// The `mcpmesh-join:` code to inspect.
1935 pub join_code: String,
1936}
1937
1938/// Result of [`Request::OrgJoinCode`] (#66): what a join code claims, plus the fingerprint that
1939/// decides whether to believe it.
1940///
1941/// The claims are ATTACKER-CONTROLLED — they come out of a code someone handed you. `display_name`
1942/// and `requested_user_id` are what the sender asked for, not facts. What is verified is the
1943/// device→user-key binding (a bad one is refused rather than reported), and what is *checkable* is
1944/// `join_code_fingerprint`.
1945#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1946pub struct OrgJoinCodeResult {
1947 /// The human name the code carries. Sender-chosen — render it, do not trust it.
1948 pub display_name: String,
1949 /// The `user_id` the sender is asking for. Sender-chosen, and it is what every `allow` entry
1950 /// would name, so it is worth an operator's attention before approving.
1951 pub requested_user_id: String,
1952 /// The label of the device being enrolled. Sender-chosen.
1953 pub device_label: String,
1954 /// The fingerprint in short words — the enrollment analogue of the pairing SAS.
1955 ///
1956 /// **Show this and have the operator confirm it out-of-band before calling
1957 /// [`Request::OrgApprove`].** Nothing in a join code binds it to a person; a substituted code
1958 /// carries a different `user_pk` and so diverges here. This is the entire check.
1959 pub join_code_fingerprint: String,
1960}
1961
1962/// Params of [`Request::OrgRevoke`] (#66).
1963#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1964#[serde(deny_unknown_fields)]
1965pub struct OrgRevokeParams {
1966 /// Who or what to revoke: a `user_id` (the person and every device), or `"<user_id>/<label>"`
1967 /// (one device).
1968 pub target: String,
1969 /// Treat this as a USER-KEY rotation instead: remove the person but leave their devices
1970 /// un-revoked, so the same hardware re-enrolls under a fresh user key and is re-approved with
1971 /// the same `user_id`.
1972 ///
1973 /// The distinction is the point — a departure must revoke the devices, a rotation must not.
1974 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
1975 pub user_key: bool,
1976}
1977
1978/// Result of [`Request::OrgRevoke`] (#66).
1979#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1980pub struct OrgRevokeResult {
1981 pub target: String,
1982 /// `"person"` | `"device"` | `"user-key-rotation"` — which grammar the target resolved to, so a
1983 /// caller can confirm the destructive reading it got was the one it meant.
1984 pub mode: String,
1985 pub org_id: String,
1986 pub serial: u64,
1987 /// Live sessions severed by the install. Revocation is IMMEDIATE (#54): a cut device's existing
1988 /// connections are closed, not left to drain.
1989 #[serde(default)]
1990 pub severed: u32,
1991}
1992
1993/// Result of [`Request::RosterMembers`]: the org's membership as an embedder renders it (#93).
1994///
1995/// Distinct from `status.presence` in what it enumerates: that lists reachable DEVICES and omits a
1996/// person entirely when none of their devices is up. This lists every person the roster carries,
1997/// online or not — a member list, not a presence list — with `online` per device so a UI can draw
1998/// both from one read.
1999///
2000/// ADVISORY. Every field here is display or authoring input; nothing in it is an authorization
2001/// answer. The gate reads the signed roster.
2002#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2003pub struct RosterMembersResult {
2004 /// The org's declared group namespace, in document order — the set an `allow` entry may name.
2005 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2006 pub groups: Vec<String>,
2007 /// Every person in the roster, ordered by `user_id` for a stable display.
2008 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2009 pub users: Vec<RosterMember>,
2010}
2011
2012/// One person in a [`RosterMembersResult`] (#93).
2013#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2014pub struct RosterMember {
2015 /// The stable authorization handle — what an `allow` entry names.
2016 pub user_id: String,
2017 /// The human name, for display. Empty if the roster's own field is.
2018 #[serde(default, skip_serializing_if = "String::is_empty")]
2019 pub display_name: String,
2020 /// The groups this person belongs to, each declared in [`RosterMembersResult::groups`].
2021 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2022 pub groups: Vec<String>,
2023 /// Their ACTIVE devices — revoked ones are absent, exactly as the gate sees it. Ordered
2024 /// primary-before-mirror, then by label.
2025 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2026 pub devices: Vec<RosterMemberDevice>,
2027}
2028
2029/// One device of a [`RosterMember`] (#93).
2030#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2031pub struct RosterMemberDevice {
2032 /// The device's human label.
2033 pub label: String,
2034 /// `"primary"` | `"mirror"` — the advisory dial-ordering hint, never a security property.
2035 pub role: String,
2036 /// The device's stable `eid:` principal — the SAME vocabulary [`PeerInfo::principal`] carries,
2037 /// and what a per-device `allow` entry names.
2038 ///
2039 /// Included where `PresencePeer` deliberately omits it, because this surface exists to be
2040 /// ACTED on: an embedder granting or revoking one device of a person needs the handle to name
2041 /// it, and the alternative is a nickname that does not exist in roster mode.
2042 pub principal: String,
2043 /// Whether the device has a live presence heartbeat. Advisory — absence never blocks a dial,
2044 /// and never removes a dial candidate.
2045 pub online: bool,
2046}
2047
2048/// Result of [`Request::BlobPublish`]: the copyable `mcpmesh/blob/1` ticket + the blob's blake3 hash.
2049/// A ticket/hash here is blob-reference vocabulary (NOT a transport-vocab leak — the same
2050/// carve-out as the pairing invite line). Additive-only.
2051#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2052pub struct BlobPublishResult {
2053 pub ticket: String,
2054 pub hash: String, // bare blake3 hex
2055}
2056
2057/// One scope in a [`BlobScopeList`]: its name + the hashes it contains + the principals it
2058/// grants. Flat vocabulary ONLY — no EndpointId/pubkey/ALPN. Additive-only.
2059#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2060pub struct ScopeInfo {
2061 pub name: String,
2062 pub hashes: Vec<String>,
2063 pub grants: Vec<String>,
2064 /// Hashes deliberately WITHDRAWN from this scope (#107): `blob_unpublish` was called, and
2065 /// `blob_republish` of these into THIS scope is refused with [`ERR_BLOB_WITHDRAWN`]. Cleared
2066 /// only by a deliberate `blob_publish {scope, path}`. Additive — omitted when empty, so a
2067 /// pre-`api_minor` 19 client sees exactly what it saw before.
2068 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2069 pub withdrawn: Vec<String>,
2070 /// Size of `hashes` — always present, even when `counts_only` empties the vector (#84b).
2071 #[serde(default)]
2072 pub hash_count: usize,
2073 /// Size of `grants`.
2074 #[serde(default)]
2075 pub grant_count: usize,
2076 /// Size of `withdrawn`.
2077 #[serde(default)]
2078 pub withdrawn_count: usize,
2079}
2080
2081/// Params of [`Request::BlobList`] (#84b). ALL optional — `blob_list {}` still works, which
2082/// matters because the verb took no params before `api_minor` 20.
2083///
2084/// A DEFAULT LIMIT applies when `limit` is absent. Deliberate: unpaged, `blob_list` renders every
2085/// scope into one frame against the 16 MiB cap; past it the CLIENT rejects the frame as malformed.
2086/// The control surface carries no strike bound, so the connection survives — but the caller gets an
2087/// opaque failure with no way to page, which is unusable rather than merely large.
2088#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2089#[serde(default, deny_unknown_fields)]
2090pub struct BlobListParams {
2091 /// EXACT scope name, never a prefix.
2092 pub scope: Option<String>,
2093 /// Only scopes containing this hash; the rendering you send is normalized first.
2094 pub hash: Option<String>,
2095 pub limit: Option<usize>,
2096 pub offset: Option<usize>,
2097 /// Omit `hashes`/`grants`/`withdrawn`, keep the counts.
2098 pub counts_only: bool,
2099}
2100
2101/// Result of [`Request::BlobList`]: the daemon's scopes. Additive-only.
2102#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2103pub struct BlobScopeList {
2104 pub scopes: Vec<ScopeInfo>,
2105 /// Scopes matching the filter BEFORE `limit`/`offset` (#84b). Without this you cannot tell a
2106 /// complete answer from a clipped one.
2107 #[serde(default)]
2108 pub total: usize,
2109 /// True when more scopes matched than were returned. Page with `offset` to see the rest.
2110 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
2111 pub truncated: bool,
2112}
2113
2114/// Result of [`Request::BlobFetch`]: the verified hash + byte length written to `dest_path`.
2115/// Additive-only.
2116#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2117pub struct BlobFetchResult {
2118 pub hash: String,
2119 pub bytes_len: u64,
2120}
2121
2122/// Result of [`Request::BlobFetchCancel`] (#172).
2123#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2124pub struct BlobFetchCancelResult {
2125 /// True when a fetch of that hash was in flight and has been told to stop. False is NOT an
2126 /// error — it means nothing was fetching that blob here, which is also what a caller sees when
2127 /// it races a fetch that just finished.
2128 pub cancelled: bool,
2129}
2130
2131/// Params of [`Request::AuditPrune`] (#88): delete monthly audit files STRICTLY older than
2132/// `before` (that month itself is kept — delete-before, not delete-including). Rejects unknown
2133/// fields, and the daemon validates the `YYYY-MM` shape up front: a malformed month errors
2134/// loudly instead of string-comparing to nothing and reporting a clean no-op.
2135#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2136#[serde(deny_unknown_fields)]
2137pub struct AuditPruneParams {
2138 /// A zero-padded `YYYY-MM` month key.
2139 pub before: String,
2140}
2141
2142/// Result of [`Request::AuditPrune`]: the month keys actually deleted, ascending. Empty when
2143/// nothing was older than `before` (idempotent).
2144#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2145pub struct AuditPruneResult {
2146 pub deleted_months: Vec<String>,
2147}
2148
2149/// Params of [`Request::AuditList`] (#88). All filters optional and AND-combined; every field
2150/// absent lists everything (paged). Rejects unknown fields — a typo'd filter that silently
2151/// matched everything would let a "what do you hold about X" answer overclaim.
2152#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
2153#[serde(deny_unknown_fields)]
2154pub struct AuditListParams {
2155 /// Inclusive `YYYY-MM` lower bound — month-file granularity (the rotation unit), so an
2156 /// out-of-range month is skipped without parsing it.
2157 #[serde(default, skip_serializing_if = "Option::is_none")]
2158 pub since: Option<String>,
2159 /// Inclusive `YYYY-MM` upper bound.
2160 #[serde(default, skip_serializing_if = "Option::is_none")]
2161 pub until: Option<String>,
2162 /// One of the wire kind strings (`session_open` / `session_close` / `request` /
2163 /// `blob_fetch` / `trust`). An UNKNOWN string is an error, never silently-all.
2164 #[serde(default, skip_serializing_if = "Option::is_none")]
2165 pub kind: Option<String>,
2166 /// The record's attributed peer nickname.
2167 #[serde(default, skip_serializing_if = "Option::is_none")]
2168 pub peer: Option<String>,
2169 /// Page size, default 500, clamped to 1000 — a month file can be arbitrarily large and the
2170 /// response is ONE JSON frame under the transport's frame cap, so the clamp is load-bearing
2171 /// (the same lesson as `blob_list`'s, minor 20).
2172 #[serde(default, skip_serializing_if = "Option::is_none")]
2173 pub limit: Option<u32>,
2174 /// Records to skip (after filtering), for paging.
2175 #[serde(default, skip_serializing_if = "Option::is_none")]
2176 pub offset: Option<u32>,
2177}
2178
2179/// Result of [`Request::AuditList`]: one page of matching records in chronological order
2180/// (oldest month first, in-file order within a month), plus the TOTAL match count so a caller
2181/// can page without a second counting call. `total` counts ALL matches, not the page.
2182#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2183pub struct AuditListResult {
2184 pub records: Vec<AuditRecord>,
2185 pub total: u64,
2186}
2187
2188/// Result of [`Request::AuditSummary`]: LOCAL per-peer / per-service session counts
2189/// aggregated from this node's OWN audit log — NEVER transmitted (local-only). Surface-clean:
2190/// peer names are nicknames / user_ids (NEVER EndpointIds), service names are the registered
2191/// service names (NEVER transport vocabulary). A "session" is one `SessionOpen` record. `per_peer` /
2192/// `per_service` are sorted ascending by name (deterministic). Tuples mirror kb's
2193/// `InsightResponse::per_peer_contribution` — `["bob", 2]` on the wire.
2194///
2195/// Additive-only: any future field MUST land as
2196/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
2197#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2198pub struct AuditSummaryResult {
2199 /// Sessions opened per peer (nickname). A session with no attributed peer is NOT counted here (no
2200 /// peer to attribute) but IS in `total_sessions`.
2201 pub per_peer: Vec<(String, u64)>,
2202 /// Sessions opened per registered service name.
2203 pub per_service: Vec<(String, u64)>,
2204 /// Total sessions opened (every `SessionOpen` record, including peer-less ones).
2205 #[serde(default)]
2206 pub total_sessions: u64,
2207}
2208
2209/// Result of an [`Request::Invite`] request: the copyable `mcpmesh-invite:` artifact
2210/// (the ONE pairing artifact deliberately carved out of the
2211/// transport-vocabulary blocklist, so this is NOT a transport-vocab leak) plus its
2212/// absolute expiry in epoch seconds (≤ now + 24h).
2213///
2214/// `invite` returns BEFORE any redemption, so the SAS — which is derived from the redeemer's
2215/// endpoint id, unknown until they redeem — cannot appear here. The inviter reads its side of
2216/// the SAS from [`StatusResult::recent_pairings`] once a redemption completes (a `trust`/`pair`
2217/// frame on the live [`StreamFrame`] stream signals that moment). See the "embedding the pairing
2218/// ceremony" note in `docs/local-protocol.md` (#35).
2219///
2220/// Additive-only: any future field MUST land as `#[serde(default, skip_serializing_if = ...)]`
2221/// so older payloads still deserialize.
2222#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2223pub struct InviteResult {
2224 /// The `mcpmesh-invite:<base32>` line, copied out-of-band to the redeemer.
2225 pub invite_line: String,
2226 /// When the invite expires (epoch seconds); the daemon burns it at redemption or expiry.
2227 pub expires_at_epoch: u64,
2228 /// How many redemptions this invite has left (#87) — **the value actually applied**, after the
2229 /// [`MAX_INVITE_USES`] clamp. `1` for an ordinary single-use invite.
2230 ///
2231 /// Reported so a caller that asked for more than the cap is told what it got rather than
2232 /// discovering it when the fourth colleague fails. Additive: `#[serde(default = "one")]`, so a
2233 /// response from an older daemon reads as single-use. `api_minor >= 35`.
2234 #[serde(default = "one_use")]
2235 pub uses_remaining: u32,
2236}
2237
2238/// The serde default for a `uses_remaining` field absent from an older payload or invite line: one
2239/// redemption, which is what every pre-#87 invite is.
2240pub fn one_use() -> u32 {
2241 1
2242}
2243
2244/// Result of a [`Request::Pair`] request: the inviter's suggested nickname (the
2245/// redeemer's local name for the new peer) plus the display-only short authentication
2246/// code (SAS) — a few words the human reads aloud to a second channel to
2247/// catch a whole-invite forgery / address-swap MITM. The SAS is a pairing-ceremony
2248/// artifact (like the invite line), NOT a transport-vocabulary leak.
2249///
2250/// Additive-only: any future field MUST land as
2251/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
2252#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2253pub struct PairResult {
2254 /// The inviter's suggested nickname (from the invite) — the redeemer's local name for it.
2255 pub peer_nickname: String,
2256 /// The display-only short authentication code (e.g. `"tango-fig-42"`), shown on both
2257 /// sides for the out-of-band human check. Never sent on the wire, never checked
2258 /// programmatically.
2259 pub sas_code: String,
2260 /// TRUE when this redemption was a SELF-ENROLLMENT (#86): you are now another device of the
2261 /// inviter's person, not their peer. No peer row was written and nothing was granted.
2262 ///
2263 /// Reported so a caller can tell the two outcomes apart without inspecting its own store.
2264 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
2265 pub enrolled_as_self: bool,
2266 /// The services this pairing granted the redeemer — each mountable as `<peer>/<service>`.
2267 /// Populated from the invite (`invite.services`) by the redeemer-side `redeem_invite`, so
2268 /// the porcelain can print the "You can mount: alice/notes" line without re-decoding the
2269 /// invite. Additive: `#[serde(default, skip_serializing_if = ...)]` so a `PairResult`
2270 /// minted by an older daemon (which omits `services`) still deserializes — to an empty list.
2271 #[serde(default, skip_serializing_if = "Vec::is_empty")]
2272 pub services: Vec<String>,
2273 /// The opaque `app_label` the inviter attached at `invite` time (#31), echoed verbatim — or
2274 /// absent if none was set. mcpmesh never interprets it; the embedder does. Additive.
2275 #[serde(default, skip_serializing_if = "Option::is_none")]
2276 pub app_label: Option<String>,
2277 /// The inviter's proven self-sovereign `user_id` (`b64u:<user_pk>`), when it presented a
2278 /// device→user binding at pairing (#30). This is the STABLE, portable identity the redeemer
2279 /// can align with its own — and the same value it may later pass to `open_session` to dial
2280 /// this peer by identity rather than by local nickname. `None` if the inviter presented no
2281 /// binding (a legacy/keyless peer). Additive.
2282 #[serde(default, skip_serializing_if = "Option::is_none")]
2283 pub peer_user_id: Option<String>,
2284}
2285
2286/// The event class of an [`AuditRecord`] (the four audit event classes). An additive discriminant on
2287/// top of the base record schema: it removes no field and makes the JSONL self-describing so
2288/// a consumer can filter by class without guessing from which optional fields are present.
2289#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2290#[serde(rename_all = "snake_case")]
2291pub enum AuditKind {
2292 /// A mesh session opened (a backend was selected for an authenticated peer).
2293 /// (A `session_open` with `status:"error"` is a synthesized FAILED-dial marker — no backend
2294 /// was reached; it records an attempted-and-failed reach for the telemetry stream.)
2295 SessionOpen,
2296 /// A mesh session closed (the backend returned / the session tore down).
2297 SessionClose,
2298 /// One proxied MCP request line (method + tool NAME + args_hash). NEVER carries raw arguments.
2299 Request,
2300 /// A peer fetched a blob from this node's gated provider (peer + hash + allow/deny).
2301 BlobFetch,
2302 /// A trust mutation (pair, unpair, roster install/swap, revoke).
2303 Trust,
2304}
2305
2306/// One audit record — the union of the event classes, and the `record` payload of a
2307/// [`StreamFrame::Event`]. ONE schema for the on-disk JSONL log and the live stream. Every field
2308/// beyond `ts`/`kind` is optional and elided when absent (`skip_serializing_if`), so each class
2309/// serializes to just its relevant keys (a session record has no `method`; a trust record has no
2310/// `bytes_out`).
2311///
2312/// PRIVACY: the proxied-request record carries `method` + `tool` (NAME only) +
2313/// `args_hash` (`"blake3:<hex>"`), and NEVER the raw arguments, the request/response content, or
2314/// any tool-output bytes — only a `bytes_out` COUNT and a `status`.
2315#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2316pub struct AuditRecord {
2317 /// RFC3339 UTC with millisecond precision, e.g. `"2026-07-03T14:02:11.480Z"`. The `YYYY-MM`
2318 /// prefix also selects the monthly file (the rotation boundary), so it is always present.
2319 pub ts: String,
2320 pub kind: AuditKind,
2321 /// The gate-resolved authenticated peer (attributed by the endpoint_id-keyed trust gate). Absent on
2322 /// local-only events with no remote peer (a manual roster install).
2323 #[serde(skip_serializing_if = "Option::is_none")]
2324 pub peer: Option<String>,
2325 #[serde(skip_serializing_if = "Option::is_none")]
2326 pub service: Option<String>,
2327 #[serde(skip_serializing_if = "Option::is_none")]
2328 pub method: Option<String>,
2329 /// The tool NAME only (never its arguments or output) — e.g. `"read_file"` for a `tools/call`.
2330 #[serde(skip_serializing_if = "Option::is_none")]
2331 pub tool: Option<String>,
2332 /// `"blake3:<hex>"` of the request arguments. The raw arguments are NEVER stored.
2333 #[serde(skip_serializing_if = "Option::is_none")]
2334 pub args_hash: Option<String>,
2335 /// Byte COUNT of the response sent back to the peer — a count, never the content.
2336 #[serde(skip_serializing_if = "Option::is_none")]
2337 pub bytes_out: Option<u64>,
2338 /// `"ok"` / `"error"` (proxied request) or `"ok"` / `"denied"` (blob fetch).
2339 #[serde(skip_serializing_if = "Option::is_none")]
2340 pub status: Option<String>,
2341 #[serde(skip_serializing_if = "Option::is_none")]
2342 pub latency_ms: Option<u64>,
2343 /// Trust-event verb: `"pair"` / `"unpair"` / `"roster_install"` / `"revoke"` (kind == Trust).
2344 #[serde(skip_serializing_if = "Option::is_none")]
2345 pub event: Option<String>,
2346 /// A reference, NEVER content: a blob hash (`BlobFetch`) or a trust-event target such as a
2347 /// nickname or `org/serial` (`Trust`).
2348 #[serde(skip_serializing_if = "Option::is_none")]
2349 pub target: Option<String>,
2350 /// The subject's STABLE principal, from the same gate resolution that produced `peer`
2351 /// (#57, `api_minor >= 29`). `peer` is a display name and collides — two devices under one
2352 /// nickname were indistinguishable in the stream and the on-disk log. Same argument and
2353 /// shape as `PeerInfo` (#41), `PeerReachability` (#42), and `ActiveSession` (#73).
2354 ///
2355 /// TWO NAMESPACES, deliberately: session/request/blob records attribute the DEVICE
2356 /// (`eid:<hex>`, like `ActiveSession` — the exact authenticated endpoint), while the trust
2357 /// `pair` record carries the value the grant appended to the allow (`b64u:<pk>` when the
2358 /// device presented a user binding, else `eid:`, #38). Joining a bound peer's sessions to
2359 /// its allow entry therefore goes through the `status` peers list (which carries BOTH the
2360 /// device principal and the `user_id`), not string equality on this field alone.
2361 ///
2362 /// **`peer_introduce` (#65) is the one exception, deliberately:** it carries the ENDORSER, not
2363 /// the subject. An introduction's whole security question is *who vouched for this peer*, and
2364 /// the subject is already in `target`. So `audit_list --peer <endorser>` finds the
2365 /// introductions that endorser caused, which is the query an operator actually runs.
2366 ///
2367 /// Deliberately absent on: `unpair` (may tear down several devices — no single subject),
2368 /// `roster_install` (purely local), and the failed-outbound-dial session record (our own
2369 /// dial, not a gate-resolved caller). Absent on every record written before 0.24.0.
2370 #[serde(default, skip_serializing_if = "Option::is_none")]
2371 pub principal: Option<String>,
2372}
2373
2374impl AuditRecord {
2375 fn base(ts: String, kind: AuditKind) -> Self {
2376 Self {
2377 ts,
2378 kind,
2379 peer: None,
2380 service: None,
2381 method: None,
2382 tool: None,
2383 args_hash: None,
2384 bytes_out: None,
2385 status: None,
2386 latency_ms: None,
2387 event: None,
2388 target: None,
2389 principal: None,
2390 }
2391 }
2392
2393 /// `principal` is an EXPLICIT parameter on every constructor (#57, kept from the original
2394 /// #72 design): a builder would let a call site silently omit it and reintroduce the
2395 /// collapsed-identity bug for that one event class. Pass `None` only for the documented
2396 /// no-single-subject records (see the field doc).
2397 pub fn session_open(
2398 ts: String,
2399 peer: Option<String>,
2400 service: String,
2401 principal: Option<String>,
2402 ) -> Self {
2403 let mut r = Self::base(ts, AuditKind::SessionOpen);
2404 r.peer = peer;
2405 r.service = Some(service);
2406 r.principal = principal;
2407 r
2408 }
2409
2410 /// Set the record's `status` (`"ok"`/`"error"`/`"denied"`), returning `self` for chaining.
2411 /// Marks a synthesized failure record — e.g. the `session_open` for a FAILED dial, which
2412 /// reaches no backend and so is never audited by the far side's session guard — without a
2413 /// dedicated constructor. DRY: reuses the existing optional `status` field.
2414 pub fn with_status(mut self, status: &str) -> Self {
2415 self.status = Some(status.into());
2416 self
2417 }
2418
2419 pub fn session_close(
2420 ts: String,
2421 peer: Option<String>,
2422 service: String,
2423 principal: Option<String>,
2424 ) -> Self {
2425 let mut r = Self::base(ts, AuditKind::SessionClose);
2426 r.peer = peer;
2427 r.service = Some(service);
2428 r.principal = principal;
2429 r
2430 }
2431
2432 /// A completed (request→response correlated) proxied line: method + tool NAME + args_hash, plus
2433 /// the response's `bytes_out` COUNT, `status`, and `latency_ms`. PRIVACY: `args_hash` is a digest;
2434 /// no raw arguments, request/response content, or tool-output bytes are ever passed in.
2435 #[allow(clippy::too_many_arguments)]
2436 pub fn proxied_request(
2437 ts: String,
2438 peer: Option<String>,
2439 service: String,
2440 method: String,
2441 tool: Option<String>,
2442 args_hash: String,
2443 bytes_out: u64,
2444 status: String,
2445 latency_ms: u64,
2446 principal: Option<String>,
2447 ) -> Self {
2448 let mut r = Self::base(ts, AuditKind::Request);
2449 r.peer = peer;
2450 r.service = Some(service);
2451 r.method = Some(method);
2452 r.tool = tool;
2453 r.args_hash = Some(args_hash);
2454 r.bytes_out = Some(bytes_out);
2455 r.status = Some(status);
2456 r.latency_ms = Some(latency_ms);
2457 r.principal = principal;
2458 r
2459 }
2460
2461 /// A proxied NOTIFICATION line (no `id`, so no response correlates): method + tool + args_hash,
2462 /// no `bytes_out`/`status`/`latency_ms`. The line is still recorded — every proxied request is audited.
2463 pub fn proxied_notification(
2464 ts: String,
2465 peer: Option<String>,
2466 service: String,
2467 method: String,
2468 tool: Option<String>,
2469 args_hash: String,
2470 principal: Option<String>,
2471 ) -> Self {
2472 let mut r = Self::base(ts, AuditKind::Request);
2473 r.peer = peer;
2474 r.service = Some(service);
2475 r.method = Some(method);
2476 r.tool = tool;
2477 r.args_hash = Some(args_hash);
2478 r.principal = principal;
2479 r
2480 }
2481
2482 pub fn blob_fetch(
2483 ts: String,
2484 peer: Option<String>,
2485 hash: String,
2486 status: String,
2487 principal: Option<String>,
2488 ) -> Self {
2489 let mut r = Self::base(ts, AuditKind::BlobFetch);
2490 r.peer = peer;
2491 r.target = Some(hash);
2492 r.status = Some(status);
2493 r.principal = principal;
2494 r
2495 }
2496
2497 pub fn trust(
2498 ts: String,
2499 event: String,
2500 target: Option<String>,
2501 principal: Option<String>,
2502 ) -> Self {
2503 let mut r = Self::base(ts, AuditKind::Trust);
2504 r.event = Some(event);
2505 r.target = target;
2506 r.principal = principal;
2507 r
2508 }
2509}
2510
2511/// One live mesh session, in a [`StreamFrame::Snapshot`]. Surface-clean: `peer` is the
2512/// user_id-or-nickname the audit records carry, never an endpoint-id. `opened_at` is epoch seconds.
2513#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2514pub struct ActiveSession {
2515 pub peer: String,
2516 pub service: String,
2517 pub opened_at: i64,
2518 /// The caller's STABLE device principal, `eid:<hex>` (#73).
2519 ///
2520 /// `peer` is a display nickname and collides: two devices under one nickname, or two contacts
2521 /// sharing a display name, are indistinguishable in the live-session view. So "who is using my
2522 /// service right now", per-peer session counts, and any UI that lets a user act on a live
2523 /// session (revoke, disconnect, inspect) were all keyed on a collidable string.
2524 ///
2525 /// Same argument and same shape as [`PeerInfo`] (#41) and [`PeerReachability`] (#42).
2526 /// Nicknames NEVER authorize; this is the value to key on.
2527 ///
2528 /// **Snapshot only, for now.** `ActiveSession` appears in [`StreamFrame::Snapshot`] — there is
2529 /// no `active_sessions` on `StatusResult`. A client that keeps its view current by applying
2530 /// subsequent `session_open`/`session_close` events still has a collision problem: those are
2531 /// [`AuditRecord`]s and carry no principal (#57, unmerged). So the snapshot distinguishes two
2532 /// same-nickname devices and the next `session_close` for that nickname does not say which row
2533 /// to drop. Re-subscribe for an authoritative view until #57 lands.
2534 ///
2535 /// Always present for a real row — `Option` only so an older client round-trips. Additive.
2536 #[serde(default, skip_serializing_if = "Option::is_none")]
2537 pub principal: Option<String>,
2538}
2539
2540/// Which side of an app-blob transfer a [`StreamFrame::BlobTransfer`] describes (#82).
2541#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2542#[serde(rename_all = "snake_case")]
2543pub enum BlobDirection {
2544 /// We are SERVING bytes to a peer that dialed our app-blob ALPN.
2545 Serve,
2546 /// We are FETCHING bytes from a peer, via `blob_fetch`.
2547 Fetch,
2548}
2549
2550/// Where an app-blob transfer is in its life (#82).
2551#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
2552#[serde(rename_all = "snake_case")]
2553pub enum BlobTransferState {
2554 /// The transfer began; `bytes_total` is known from here on.
2555 Started,
2556 /// Bytes advanced. COALESCED — see [`StreamFrame::BlobTransfer`].
2557 Progress,
2558 /// Finished successfully. Carries the FINAL byte count.
2559 Completed,
2560 /// Ended without completing (peer went away, refused, or the store errored).
2561 Aborted,
2562}
2563
2564/// One frame of the [`Request::Subscribe`] stream (pairing liveness & health telemetry). Tagged on
2565/// `type` (snake_case), so a frame is `{"type":"snapshot",...}` / `{"type":"event",...}` /
2566/// `{"type":"lagged",...}`. `Event.record` is the [`AuditRecord`] verbatim, so the stream and the
2567/// on-disk log carry ONE schema. The daemon serializes these; an embedding consumer deserializes
2568/// them (see `docs/local-protocol.md` "Live event stream").
2569///
2570/// **`#[non_exhaustive]`**: a future frame kind must not break a downstream `match`. Adding
2571/// `Reachability` in 0.13.0 DID break exhaustive matches — which is why that release is a MINOR,
2572/// per `RELEASING.md`'s pre-1.0 rule that breaking changes bump the minor. Consumers now write a
2573/// `_ =>` arm and later additions are additive for Rust.
2574///
2575/// **They are NOT additive for JSON, and this line claimed they were until 1.55.** The enum is
2576/// `#[serde(tag = "type")]` with no catch-all variant, so an unrecognised tag is a hard
2577/// deserialization error: [`StreamSubscription::next`](crate::StreamSubscription::next) surfaces a
2578/// newer daemon's frame as [`ClientError::Malformed`](crate::ClientError::Malformed) and a consumer
2579/// that propagates it loses the whole stream. `#[non_exhaustive]` is a Rust-`match` property and
2580/// does nothing for serde. A consumer that must survive a daemon newer than its `mcpmesh-local-api`
2581/// reads raw frames via [`ControlClient::open_stream`](crate::ControlClient::open_stream) and
2582/// ignores tags it does not know — that is the only forward-compatible path, and the crates ship in
2583/// lockstep precisely because of this.
2584#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
2585#[serde(tag = "type", rename_all = "snake_case")]
2586#[non_exhaustive]
2587pub enum StreamFrame {
2588 /// The FIRST frame: a point-in-time picture of the mesh (open sessions + paired-peer
2589 /// reachability) so a fresh subscriber renders immediately without replaying history.
2590 Snapshot {
2591 active_sessions: Vec<ActiveSession>,
2592 reachability: Vec<PeerReachability>,
2593 /// THIS node's own reachability posture (#90), so a fresh subscriber renders it without
2594 /// a `status` poll. `None` in mesh-less control-only mode. Additive: default +
2595 /// skip-if-none so an older payload round-trips.
2596 #[serde(default, skip_serializing_if = "Option::is_none")]
2597 self_network: Option<SelfNetwork>,
2598 },
2599 /// A live audit event (session open/close, request, blob fetch, trust) — the tap on the hub.
2600 /// Boxed so this (much larger) variant does not bloat every frame; serde delegates through the
2601 /// `Box`, so the wire shape is the record's fields verbatim.
2602 Event { record: Box<AuditRecord> },
2603 /// A peer's reachability TRANSITIONED (#58): it became reachable, became unreachable, or was
2604 /// probed for the first time. Pushed so an embedder does not have to poll `status` for a live
2605 /// online/offline indicator — and so work queued for an unreachable peer can flush the moment
2606 /// it returns, rather than on the next poll tick.
2607 ///
2608 /// Emitted on a change of `reachable` **or of `path`**. A refresh with the same verdict AND the
2609 /// same path emits nothing, so a peer that stays up does not produce a frame per TTL refresh;
2610 /// `rtt_ms`/`meta`/`services` drift is advisory detail and is not a transition. `age_secs` is
2611 /// `0` — the observation just completed.
2612 ///
2613 /// **Do not treat this as an up/down toggle.** It carried that meaning through 0.18, and this
2614 /// doc said "on a CHANGE of `reachable` only" until 1.22 — which stopped being true in 0.19.0
2615 /// (#92 item 1), when `path` joined the transition rule. A consumer that assumed same-verdict
2616 /// frames were impossible was reading a stale guarantee.
2617 ///
2618 /// Two producers, as of API 1.22 — and since 1.30 `source` says WHICH ONE, so the distinction
2619 /// is readable rather than inferred:
2620 ///
2621 /// - [`ReachabilitySource::Probe`] — a probe completing (`status`/`subscribe` refreshing a
2622 /// stale entry). It describes a throwaway dial, not anyone's live connection.
2623 /// - [`ReachabilitySource::Session`] — a live session whose selected path changed under it
2624 /// (#92 item 2). A claim about the link in use.
2625 ///
2626 /// The second producer is why `path` is trustworthy for a long-lived session: a session that
2627 /// degrades Direct→Relay mid-call now says so when it happens, rather than staying silently
2628 /// mislabelled until something probes. `path` is a truth claim about where user data went, so
2629 /// `Unknown` means "we do not know" and must never be rendered as private.
2630 ///
2631 /// **`rtt_ms` is not a discriminator, and never was** (#150). Until 1.30 this doc said a
2632 /// session-sourced frame carries `rtt_ms: None` — true only of a FIRST observation, where no
2633 /// round trip was measured and none is invented. A session-sourced frame for an
2634 /// already-probed peer carries that probe's `rtt_ms: Some(..)`, because the path watcher
2635 /// deliberately leaves `rtt_ms`/`meta`/`probed_at` alone (refreshing them would stamp a stale
2636 /// RTT as fresh and suppress the corrective probe — #92 review). That is the common case for a
2637 /// peer probed at pairing time and then watched through a long call. Read `source`.
2638 Reachability {
2639 peer: PeerReachability,
2640 /// Which producer emitted this frame (#150). `api_minor >= 30`.
2641 ///
2642 /// Additive: `#[serde(default)]`, landing on [`ReachabilitySource::Unknown`] — NOT on
2643 /// `Probe`. A daemon at `api_minor` 22–29 already has both producers, so an absent field
2644 /// genuinely does not say which one ran; defaulting to `Probe` would assert the wrong
2645 /// producer for every session-sourced frame such a daemon emits, which is the exact
2646 /// ambiguity this field exists to remove.
2647 #[serde(default)]
2648 source: ReachabilitySource,
2649 },
2650 /// THIS node's own network posture CHANGED (#90): `online` flipped, the home relay moved,
2651 /// or a relay's connection state changed — pushed so an embedder learns "you just went
2652 /// unreachable" the moment it happens instead of on a poll tick, and so #53's `set_relays`
2653 /// finally has a signal telling someone to use it. `direct_addrs` drift alone does not
2654 /// emit (address churn is chatty and not a decision point; it rides the next frame).
2655 /// `api_minor >= 28`.
2656 SelfNetwork { self_network: SelfNetwork },
2657 /// This machine was SUSPENDED and has just resumed (#167 ask 2) — a closed laptop lid, a sleep,
2658 /// a hibernate. `api_minor >= 55`.
2659 ///
2660 /// The signal an embedder holding long-lived sessions actually needs. While a machine is
2661 /// suspended it sends nothing, so the *peer's* idle timer runs out and tears the connection down
2662 /// before the lid is even reopened; `keep_alive_secs` cannot help, because a suspended process
2663 /// emits no PINGs. Without this frame the first thing an app learns is a failed send, which is
2664 /// the worst possible moment to find out. With it, the app can tear down and re-dial
2665 /// deliberately.
2666 ///
2667 /// **Detected as clock skew, not guessed.** Rust's `Instant` is `CLOCK_MONOTONIC` on Linux and
2668 /// `CLOCK_UPTIME_RAW` on Apple targets, and neither advances across a suspend while the wall
2669 /// clock does. A tick where the wall clock outran the monotonic clock by more than the threshold is a
2670 /// suspend; a tick where BOTH ran long is a starved runtime and emits nothing. That distinction
2671 /// is deliberate — a signal that fired under load would train consumers to ignore it.
2672 ///
2673 /// **It names no session.** The daemon cannot know which of an embedder's sessions survived —
2674 /// a short suspend may well leave one intact. It means "this machine was away for N seconds;
2675 /// re-check what you hold".
2676 ///
2677 /// **A forward wall-clock STEP also emits, and cannot be told apart from a sleep.** A board with
2678 /// no RTC that boots with a bogus epoch and is then stepped months forward by NTP produces a
2679 /// frame claiming a multi-year suspend. Read `suspended_secs` as "wall time ran this much
2680 /// further than this process did", which is what is actually measured; the frame's advice
2681 /// survives either cause, but the number is not a measurement of sleep alone. Distinguishing
2682 /// them needs a continuous clock (`CLOCK_BOOTTIME` / `mach_continuous_time`), which is a
2683 /// per-platform dependency this does not take.
2684 ///
2685 /// Not retroactive, and — unlike the other transitions — with **nothing in `Snapshot` to
2686 /// recover it from.** [`Reachability`](StreamFrame::Reachability) and
2687 /// [`SelfNetwork`](StreamFrame::SelfNetwork) missed frames are recoverable because `Snapshot`
2688 /// carries `reachability` and `self_network`; there is no resume field, because "was this
2689 /// machine recently asleep" is not a state the daemon holds. A subscriber that attaches after a
2690 /// wake cannot learn one happened. If you reconnect, assume you missed events and re-check what
2691 /// you hold — the same advice this frame carries.
2692 Resumed {
2693 /// How long the machine was away, in seconds — the number that decides whether to re-dial
2694 /// everything or nothing. It is the wall-clock/monotonic skew, so it measures the suspend
2695 /// itself and not the time since the last frame.
2696 suspended_secs: u64,
2697 /// Wall-clock epoch seconds at which the resume was DETECTED (up to one tick after the
2698 /// machine actually woke).
2699 at_epoch: i64,
2700 },
2701 /// The subscriber fell `dropped` records behind the broadcast ring; the stream continues (a
2702 /// fresh reconnect would re-`Snapshot`). Never drops the subscriber — lag is reported, never fatal.
2703 Lagged { dropped: u64 },
2704 /// An app-blob transfer advanced (#82). Emitted on BOTH sides: `Serve` while we send bytes to
2705 /// a peer, `Fetch` while `blob_fetch` pulls them.
2706 ///
2707 /// **`Progress` is COALESCED, deliberately.** iroh-blobs reports progress per ~16 KiB chunk, so
2708 /// a 4 GiB transfer would push ~262k frames through a bounded ring and every subscriber would
2709 /// see `Lagged` — losing the audit events that share it. A frame is emitted on `Started`, on
2710 /// `Completed`/`Aborted`, and on `Progress` only after at least `max(1 MiB, total/100)` more
2711 /// bytes, so a transfer costs at most ~102 frames whatever its size.
2712 ///
2713 /// **Do not treat the last `Progress` as the total** — the final stride is usually skipped.
2714 /// `Completed` carries the final `bytes_done`.
2715 BlobTransfer {
2716 direction: BlobDirection,
2717 /// The blob's hash, hex.
2718 hash: String,
2719 bytes_done: u64,
2720 /// Known from `Started` onward; `None` only if the size was never reported.
2721 #[serde(default, skip_serializing_if = "Option::is_none")]
2722 bytes_total: Option<u64>,
2723 state: BlobTransferState,
2724 /// SERVING side only: the STABLE `eid:` device principal we are serving (#38 — never a
2725 /// display nickname). Always `eid:<hex>`: this comes from the authenticated endpoint, so it
2726 /// is NOT the same namespace as a grant written as a user_id or roster name. Absent when fetching, where the counterparty is named
2727 /// by the ticket rather than by a resolved identity.
2728 #[serde(default, skip_serializing_if = "Option::is_none")]
2729 peer: Option<String>,
2730 },
2731}
2732
2733/// Extract the `method` tag from a raw request value without deserializing the whole
2734/// message. The daemon's dispatcher uses this: match on the method string, then deserialize
2735/// `params` per-method — which tolerates omitted / null / `{}` params for parameterless
2736/// methods (adjacent tagging rejects `params:{}` on unit variants).
2737pub fn method_of(v: &serde_json::Value) -> Option<&str> {
2738 v.get("method").and_then(serde_json::Value::as_str)
2739}
2740
2741/// How a service is answered. Mirrors the config `[services.*]` *kinds*;
2742/// Config→BackendSpec is a hand-written match, not a serde passthrough.
2743#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2744#[serde(rename_all = "snake_case")]
2745pub enum BackendSpec {
2746 Run {
2747 cmd: Vec<String>,
2748 /// Per-service environment variables (#51) for the spawned child. Overlaid on the
2749 /// daemon's inherited env; the injected `MCPMESH_PEER_*` identity vars ALWAYS win over
2750 /// these (identity is not spoofable by a service definition). Default empty.
2751 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
2752 env: BTreeMap<String, String>,
2753 /// Working directory to spawn the child in (#51). Default: inherit the daemon's cwd.
2754 #[serde(default, skip_serializing_if = "Option::is_none")]
2755 cwd: Option<String>,
2756 },
2757 Socket {
2758 path: String,
2759 },
2760}
2761
2762/// Control-API error code: the named service exists in neither `config.toml` nor the ephemeral
2763/// registry (#55). Distinct from the generic `-32000` so a caller can BRANCH on "no such service"
2764/// instead of parsing a message — `service_allow_grant`/`service_allow_revoke` previously answered
2765/// `{}` (success) for an unknown name, which silently included every ephemeral service.
2766pub const ERR_NO_SUCH_SERVICE: i64 = -32040;
2767/// The named blob is not held COMPLETE by this daemon (#83, `blob_republish`). Distinct from
2768/// [`ERR_NO_SUCH_SERVICE`] because the remedy differs: fetch the blob first.
2769pub const ERR_NO_SUCH_BLOB: i64 = -32041;
2770/// The blob was deliberately withdrawn from this scope (#107). Distinct from
2771/// [`ERR_NO_SUCH_BLOB`]: that means "fetch it first", this means "someone un-shared this on
2772/// purpose — `blob_publish` from the file if the re-share is intended".
2773pub const ERR_BLOB_WITHDRAWN: i64 = -32042;
2774/// `pair` was refused because the redeemer's nickname is already held by a DIFFERENT paired peer
2775/// (#87), so an embedder can branch on the one refusal that has a self-service remedy — rename and
2776/// redeem the same invite again — without reading the prose (#147).
2777///
2778/// Reading the prose was the only option before this code, and it does not survive translation: the
2779/// message is generated on the INVITER's side and travels to the redeemer, so the embedder that
2780/// DISPLAYS it cannot rewrite it into its own vocabulary except by substring-matching our copy.
2781/// Branch on this and write your own sentence naming your own rename affordance.
2782///
2783/// Deliberately narrow. It rides ONLY this refusal, which is sent exclusively to a caller that
2784/// proved possession of a live invite secret. The generic refusal keeps `-32000` and its opaque
2785/// reason: distinguishing unknown-vs-expired-vs-wrong-secret would be a redemption oracle.
2786pub const ERR_NICKNAME_TAKEN: i64 = -32043;
2787
2788/// The invite line's own `expires_at_epoch` has passed (#159). Decided LOCALLY, before dialing —
2789/// this says nothing about the inviter's state. Remedy: ask for a fresh invite.
2790pub const ERR_INVITE_EXPIRED: i64 = -32044;
2791
2792/// The inviter has **no outstanding invite at all** — its accept gate fast-closed the dial (#159).
2793///
2794/// This is as close to "expired or already used" as we can safely get, and the distinction matters:
2795/// it is a fact about the INVITER, not about the secret presented. Answering per-secret would be a
2796/// redemption oracle — a prober would learn which guessed secrets were ever real — which is why
2797/// [`ERR_INVITE_REFUSED`] stays deliberately undifferentiated. Remedy: ask for a fresh invite.
2798pub const ERR_INVITE_NOT_LIVE: i64 = -32045;
2799
2800/// The inviter's address could not be dialed at all (#159) — offline, asleep, or unroutable.
2801/// Remedy: check they are running, then retry the same invite; it is untouched.
2802pub const ERR_INVITER_UNREACHABLE: i64 = -32046;
2803
2804/// **The address-swap defense fired**: the TLS-authenticated peer is not the endpoint the invite
2805/// names (#159).
2806///
2807/// The one refusal here that must NOT be rendered as "try again". Something answered in place of
2808/// the machine the invite identifies — a substituted address, or a forged invite. An embedder that
2809/// treats every pairing failure as a friendly retry papers over exactly the attack this check
2810/// exists to catch. Remedy: do not retry; get the invite again through a channel you trust.
2811pub const ERR_INVITER_MISMATCH: i64 = -32047;
2812
2813/// The invite asks to be called a name this node already uses for a DIFFERENT peer (#159).
2814///
2815/// The redeemer-side mirror of [`ERR_NICKNAME_TAKEN`], and a distinct condition: that one is the
2816/// inviter refusing the redeemer's name, this is the redeemer refusing the inviter's suggestion.
2817/// Nothing is granted either way — a name confers no access (#38) — so this protects this node's
2818/// own display and routing clarity. Remedy: ask for an invite suggesting a different name.
2819pub const ERR_INVITE_NAME_CONFLICT: i64 = -32048;
2820
2821/// The inviter refused, and the cause is **deliberately withheld** (#159).
2822///
2823/// Unknown secret, expired secret, and wrong secret are one answer on purpose: telling them apart
2824/// is a redemption oracle. The code carries exactly as much as the prose already did — "that invite
2825/// did not work" — so a consumer can branch without parsing, and without learning anything a
2826/// prober could use. Remedy: ask for a fresh invite.
2827pub const ERR_INVITE_REFUSED: i64 = -32049;
2828
2829/// The request was stopped on purpose before it finished (#172) — today, a `blob_fetch` that
2830/// [`Request::BlobFetchCancel`] tripped.
2831///
2832/// A cancelled request still ANSWERS. Cancellation is cooperative rather than a task abort
2833/// precisely so this code can be delivered: an aborted task returns nothing, and the caller waits
2834/// forever on work that already stopped. Distinct from `-32000` because it is not a failure — the
2835/// caller (or its user) asked for it. Remedy: none; retry the fetch if the cancel was a mistake.
2836///
2837/// **What it does not promise:** partial chunks already streamed into the blob store stay there,
2838/// unlisted and unreclaimable, exactly as they do when a fetch fails. That is #80's reclaim gap,
2839/// unchanged by cancellation.
2840pub const ERR_CANCELLED: i64 = -32050;
2841
2842/// This control connection already has [`MAX_INFLIGHT`] requests running, so this one was refused
2843/// without being started (#172).
2844///
2845/// **Retryable, and cheap to retry** — retry after any response lands, or spread the load over a
2846/// second control connection. It is refused rather than queued deliberately: a queue is invisible
2847/// backpressure that a caller cannot tell apart from a slow daemon, and waiting for a permit inside
2848/// the read loop would reintroduce the head-of-line blocking concurrent dispatch exists to remove.
2849///
2850/// Not a security boundary — the control socket is the daemon owner's. It bounds the work one
2851/// connection can have outstanding so a buggy client cannot spawn unboundedly.
2852pub const ERR_TOO_MANY_INFLIGHT: i64 = -32051;
2853
2854/// The invite line is a SELF-ENROLLMENT (`mcpmesh-enroll:`) and the caller did not offer that
2855/// ceremony — [`PairParams::allow_self_enroll`] was unset (#178).
2856///
2857/// Decided from the line in hand, BEFORE any dial: nothing was contacted, no secret was revealed,
2858/// and the invite is untouched. Like [`ERR_INVITE_EXPIRED`] it therefore reveals nothing about the
2859/// inviter and is safe to name precisely.
2860///
2861/// Distinct from [`ERR_INVITE_REFUSED`] in the direction it points: that one is the inviter turning
2862/// US down, this one is US declining a ceremony we were never asked to run. Remedy: if the person
2863/// meant to add another of their OWN devices, offer that explicitly and retry the SAME line with
2864/// `allow_self_enroll`; otherwise they pasted the wrong link and want an ordinary
2865/// `mcpmesh-invite:` one.
2866pub const ERR_SELF_ENROLL_NOT_OFFERED: i64 = -32052;
2867
2868/// How many requests one control connection may have in flight at once (#172), after which it
2869/// answers [`ERR_TOO_MANY_INFLIGHT`]. Per connection, not per daemon.
2870pub const MAX_INFLIGHT: usize = 32;
2871
2872pub const API_NAME: &str = "mcpmesh-local/1";
2873/// The protocol-compatibility version as `"MAJOR.MINOR"`, distinct from the crate/stack version.
2874///
2875/// - **MAJOR** matches the `/N` in [`API_NAME`] and changes only on a breaking wire change (the
2876/// transport already rejects a mismatched `api`, so an equality check on that is redundant).
2877/// - **MINOR** ([`API_MINOR`]) increments on a surface change within a major — additive fields, new
2878/// methods, or a strictness change like params validation — bumped in the same change that makes
2879/// it. A client can guard with `api_minor >= N` for a feature it needs, or refuse a daemon older
2880/// than a minor it requires. It never resets except on a MAJOR bump.
2881///
2882/// It also bumps for a change to what a field MEANS with no change to its shape — six of the
2883/// thirty have, see [`API_MINOR`]'s history. "Every surface change" is what this line used
2884/// to claim, and it was wrong in both directions: minor 9's entry records surface changes that
2885/// shipped WITHOUT a bump, and six bumps changed no type at all. Read the history, not the rule.
2886pub const API_VERSION: &str = "1.59";
2887/// The integer MINOR of [`API_VERSION`] — see there. Bumped from 0 to 1 when params validation
2888/// became strict (#34); to 2 with the `set_nickname` verb + `StatusResult.self_nickname` (#37);
2889/// to 3 when `allow`/grant strings became STABLE principals — `b64u:`/`eid:`/roster names,
2890/// never nicknames (#38); to 4 with the `set_app_metadata` verb + `PresencePeer.meta` (#39);
2891/// to 5 with `PeerReachability.meta` — pairing-mode app metadata on the probe pong (#40);
2892/// to 6 with `PeerInfo.principal` — the peer's eid: device principal on `status` (#41);
2893/// to 7 with `PeerReachability.principal` — the same on reachability rows (#42); to 8 with the
2894/// `service_allow_grant`/`service_allow_revoke` per-peer access verbs (#44); to 9 covering the
2895/// `unregister_service` (#50) / `peer_services` (#52) / Run `env`+`cwd` (#51) surface that shipped
2896/// in 0.10.1 without a bump, PLUS the `set_relays` live relay-set verb (#53); to 10 when
2897/// `service_allow_revoke`/`peer_remove` became IMMEDIATE — no verb shape changed, but their
2898/// observable contract did: a revoked principal's next session is refused even on a connection it
2899/// already holds, and its live connections are severed. Previously both waited for the peer to
2900/// disconnect on its own, which is unbounded (#54). A consumer can guard on
2901/// `api_minor >= 10` before telling a user that revocation has taken effect; to 11 when
2902/// `service_allow_grant`/`service_allow_revoke` gained EPHEMERAL-service support and became strict
2903/// about an unknown service name — a name in neither the config nor the ephemeral registry now
2904/// answers [`ERR_NO_SUCH_SERVICE`] instead of a silent `{}` (#55, #69); to 12 with the pushed
2905/// [`StreamFrame::Reachability`] liveness transition frame (#58); to 13 with
2906/// [`PeerReachability::path`] — direct-vs-relay attribution on every reachability row (#64); to 14
2907/// with the `run`-backend `MCPMESH_PEER_EID` identity var — the caller's stable device principal,
2908/// unconditionally present, so a `run` server can scope per caller without keying on a nickname
2909/// (#60); to 15 with the `blob_revoke` / `blob_unpublish` verbs — per-scope withdrawal of a grant
2910/// and of a published hash, so un-sharing a file no longer requires unpairing the person (#62); to
2911/// 16 when the app-blob provider became available in PAIRING mode — the blob verbs previously
2912/// errored on any daemon without an org root key, though their scope gate never needed one (#61);
2913/// to 17 when the service answer began coming from the LIVE registry rather than config + overlay,
2914/// so a grant the accept path would refuse is no longer advertised. Three surfaces share that
2915/// resolver and all changed together: `status`'s `services[].allow`, `peer_services`' name list,
2916/// and the `mcpmesh/ping/1` probe's `services`. No wire shape changed, only the source of truth —
2917/// exactly the class of change a downstream cannot see in a type diff (#100); to 18 with `blob_republish`, so a fetched blob can
2918/// be re-served and every recipient becomes a source (#83); to 19 with durable blob revocation — an
2919/// unpublish now survives a later republish via a per-scope withdrawal set, and
2920/// [`ERR_BLOB_WITHDRAWN`] distinguishes "deliberately withdrawn" from "never had it" (#107); to 20
2921/// with `blob_list` filters + paging AND a DEFAULT limit of 256 scopes (the clamp is 4096) — a
2922/// daemon with more scopes than that previously answered with
2923/// everything, and past the 16 MiB frame cap the CLIENT rejected the response as malformed, leaving
2924/// the caller an opaque failure with no way to page. The connection survived: the control surface
2925/// carries no strike bound. This is a behaviour change for existing callers, detectable via the new
2926/// `total`/`truncated` (#84b); to 21 when a
2927/// PATH change became a reachability transition — [`StreamFrame::Reachability`] stopped being an
2928/// up/down toggle and same-verdict frames became possible (#92); to 22 with a SECOND producer for
2929/// that frame: a live per-session watcher that pushes when a session's selected path changes,
2930/// rather than waiting for a probe, at a cadence probes never had (#92); to 23 when
2931/// [`PeerReachability::rtt_ms`] stopped including the path-settle window — a relayed peer could
2932/// previously never report under 600ms, so "relayed AND fast" was unreachable by construction
2933/// (#123); to 24 when `reachable` stopped sharing a deadline with path classification — a relayed
2934/// peer whose pong arrived after ~2.4s was reported OFFLINE while it was answering (#128); to 25
2935/// with [`ActiveSession::principal`] — the live-session view was keyed on a display nickname, so
2936/// two devices under one nickname were indistinguishable and any UI acting on a session (revoke,
2937/// disconnect, inspect) keyed on a collidable string (#73); to 26 when a
2938/// rate-limited inbound NOTIFICATION stopped being silently dropped and became a recorded audit
2939/// event — no type changed; the observable audit stream did (#76, #139); to 27 with the `audit_prune` /
2940/// `audit_list` verbs, `StatusResult::storage`, and the opt-in `[limits].audit_retain_months`
2941/// boot retention — the audit log stopped being a permanent, unbounded, unreadable record (#88);
2942/// to 28 with `StatusResult::self_network` / `StreamFrame::SelfNetwork` / the snapshot's copy —
2943/// the node's OWN reachability posture, previously unanswerable from either side of the API
2944/// (#90); to 29 with [`AuditRecord::principal`] — stable identity on the event stream and the
2945/// on-disk log, resolving #57's parked docs conflict in favour of the #41/#42/#73 line (the
2946/// audit surface bans secrets and raw hex, not the prefixed principal rendering); to 30 with
2947/// [`StreamFrame::Reachability`]'s `source` — the frame has had TWO producers since 22 with no way
2948/// to tell them apart, so an embedder could not distinguish "a throwaway dial went via a relay"
2949/// from "the link this call is on just degraded", and had to hedge every message down to the
2950/// weaker claim. `rtt_ms: None` was never the discriminator the doc implied (#150); to 31 with
2951/// [`ERR_NICKNAME_TAKEN`] — the nickname-collision `pair` refusal is branchable instead of
2952/// `-32000`, so an embedder writes its own recovery copy rather than substring-matching ours. The
2953/// prose changed with it: it named the `set_nickname` CONTROL VERB as the remedy, which a GUI user
2954/// cannot type, and the refusal is generated inviter-side so the embedder displaying it could not
2955/// rewrite it (#147); to 32 with [`SelfNetwork::identity_conflict_epoch`] — two nodes booted from
2956/// COPIES of one mesh root share an endpoint id, and the displaced one's peers went unreachable
2957/// with nothing saying why. The relay reports it and iroh only `warn!`s it, so the fact existed
2958/// and was unreadable (#134); to 33 with the `peer_diagnostics` verb — a long-lived pairing that
2959/// cannot hole-punch while a fresh identity on the same hardware can differs only in DURABLE
2960/// per-peer state, and none of it was readable from outside the daemon (#140); to 34 when
2961/// outstanding invites became DURABLE — `invite.expires_at_epoch` changed meaning from an upper
2962/// bound on the daemon's process lifetime to the real lifetime, and `invite` gained an error where
2963/// it previously always succeeded. No shape changed, which is exactly the class minor 10 records:
2964/// guard on `api_minor >= 34` before telling a user their invite will still be good tomorrow
2965/// (#87b); to 35 with `InviteParams.max_uses` + `InviteResult.uses_remaining` — a bounded
2966/// multi-use invite, so onboarding a team is one link rather than one ceremony per person. Each
2967/// redemption still runs its own SAS and writes its own peer rows; it is N pairings sharing a
2968/// secret, never a group identity (#87); to 36 with branchable codes for the rest of the ONBOARDING
2969/// refusals — expired line, no live invite, inviter unreachable, id mismatch, name conflict, and
2970/// the deliberately-opaque refusal. `ERR_NICKNAME_TAKEN` had been the only coded pairing failure,
2971/// so every other one arrived as `-32000` and an embedder could either forward our prose to end
2972/// users or substring-match it (#159); to 59 with [`Request::PeerHintClear`] — FORGET one peer's
2973/// persisted dial hint (#140). An experiment tool and a workaround, not a policy change: nothing
2974/// clears a hint automatically. `PeerEntry.last_addr` is the only durable per-peer state on a node's
2975/// disk that the dial path reads and the only thing a long-lived pairing carries that a freshly
2976/// paired identity does not, so clearing it makes the pairing ADDRESSING-EQUIVALENT to a fresh one —
2977/// which is exactly the difference #140 is about. Advisory, never authorization: the row, its
2978/// `user_id`, its services and its pairing stamp are untouched, and an absent hint is a supported
2979/// state. Guard on `>= 59`; to 58 with the REVERSE-DNS `_meta` key spellings
2980/// `tech.counterpunch.mcpmesh/{service,peer}` alongside the legacy `mcpmesh/{service,peer}` (#49,
2981/// SEP-1788's SHOULD). No shape changed, and **no peer or backend has to change what it READS**:
2982/// both spellings are WRITTEN with identical values and EITHER is accepted, which is why this did
2983/// not need the coordinated wire change #49 assumed. A backend reading `mcpmesh/peer` keeps working.
2984///
2985/// **It is not a no-op for every backend, though.** A handler that rejects unknown `_meta` keys —
2986/// `deny_unknown_fields`, `additionalProperties: false` — now sees a second one and will refuse
2987/// requests it accepted at 57, the same class of break that made 0.50.0 a MINOR. Both prefixes are stripped from caller frames, because a
2988/// prefix mcpmesh writes but does not strip is one a caller can forge. A caller sending the two
2989/// service spellings with DIFFERENT values is REFUSED rather than reconciled. The reserved-key
2990/// enumeration in the 2026-07-28 grammar is `progressToken`, `io.modelcontextprotocol/*`, and bare
2991/// `traceparent`/`tracestate`/`baggage`; a prefixed key is reserved only by its SECOND label, so
2992/// neither of our spellings ever collided. **The legacy
2993/// `mcpmesh/*` spellings are deprecated as of 0.51.0 and will be removed at 1.0** — migrate reads to
2994/// the reverse-DNS form. Guard on `>= 58` only if you need the new spelling to be present; to 57
2995/// when `_meta["mcpmesh/peer"]` began being injected on
2996/// EVERY proxied request rather than only the handshake (#45 ask 2). **No shape changed** — this is
2997/// the same class as 37, on the same field: what changed is WHEN a backend can rely on the value
2998/// being there. Before 57 a served backend learned its caller on the session's first frame and on
2999/// any later `initialize`, and saw nothing on frames 2..N; from 57 every request carrying a `method`
3000/// is attributed. A backend that authorizes per-request rather than binding at session start must
3001/// guard on `>= 57`, exactly as 37's note says to guard before trusting the value at all. Positional
3002/// (array) params are the one exception and are deliberately left un-attributed — see
3003/// `docs/local-protocol.md`. Guard on `>= 57`; to 56 with [`PeerDiagnosticsResult::known_addrs`] and its two
3004/// set-difference companions — IROH's own view of a peer's addresses alongside the hint we stored
3005/// (#140). The verb dumped this node's disk and nothing about what iroh made of it, which is the
3006/// half the standing hypothesis lives in: iroh skips address lookup while a path is selected, so a
3007/// pair holding a relayed connection never re-discovers and the stale hint is the only addressing
3008/// the dial contributes. Read-only (a point read of the remote map), so it stays safe to run on a
3009/// live reproduction — though it does reset iroh's ~60s per-remote idle timer, so polling it keeps
3010/// state alive that would otherwise be reaped. `known_addrs` ABSENT means iroh holds no entry right
3011/// now, which is neither an empty list nor "never heard of": iroh reaps a remote ~60s after its last
3012/// connection closes. Guard on `>= 56`; to 55 with [`StreamFrame::Resumed`] — a SUSPEND/RESUME
3013/// signal on `subscribe` (#167 ask 2). A suspended machine sends nothing, so the peer's idle timer
3014/// tears the connection down before the lid reopens and `keep_alive_secs` cannot help; the frame is
3015/// what lets an embedder re-dial deliberately instead of discovering it on the next send. Detected
3016/// as wall-clock/monotonic skew, so a starved runtime (both clocks run long) does NOT emit. It names
3017/// no session — the daemon cannot know which survived. Guard on `>= 55`; to 54 with
3018/// [`OpenSessionParams::idle_timeout_secs`] — a
3019/// PER-CONNECTION QUIC idle timeout on the dial path (#166). The node-wide `[network]` knob made a
3020/// chat session, a bulk blob transfer and a media flow share one compromise. Only LOWERING is
3021/// unilateral (QUIC negotiates the minimum of both peers), which is also why the absence of an
3022/// accept-side twin is a missing symmetry rather than a missing half: the direction that can work
3023/// one-sidedly is available, and the direction that cannot never worked anywhere. Ignored on a
3024/// RACING dial, which abandons connections (logged at `warn!`, since a caller cannot know how many
3025/// devices a peer has). No per-connection keepalive — iroh caps the per-path
3026/// interval at 5s, so one could only make pings more frequent. Guard on `>= 54`; to 53 with `org_rotate` and the roster's
3027/// `successor_root_pk`/`successor_sig` — ORG ROOT ROTATION (#93 ask c). The schema pinned exactly
3028/// one signature slot against one key, so an operator laptop that died took the org with it 90 days
3029/// later when the roster expired, and the delay is what made it undiagnosable; recovery was O(N)
3030/// fresh ceremonies with every member. A roster now carries a successor root cross-signed by its
3031/// predecessor, and the bridge rides EVERY subsequent roster — so a member offline for the
3032/// announcing publication still catches up, which the obvious one-shot design does not give you. A
3033/// successor is adopted only when the pinned key no longer signs directly, only on a statement that
3034/// key signed, and never resets rollback protection. **A rotated roster declares
3035/// `mcpmesh-roster/2`**, so EVERY member must be on 0.47.0+ before an org rotates — an older binary
3036/// refuses the closed-schema document and stops receiving membership changes entirely; an org that
3037/// never rotates keeps producing `/1` byte-identically. NOT escrow: a LOST root cannot sign a bridge —
3038/// copy `org-root.key` to a second operator machine for that. Guard on `>= 53`; to 52 with `attest_offer` and the DEVICE ATTESTATION
3039/// ceremony (#85 ask 3) — a peer that already holds your `b64u:` admits a replacement device on the
3040/// strength of a user-key binding, with no fresh SAS ceremony with everyone you ever paired with.
3041/// `PeerEntry.user_id` was written once at pairing and never refreshed, so a machine restored from
3042/// a recovery phrase (ask 2) was still a complete stranger. **OFF by default**
3043/// (`[identity].admit_attested_devices`): it changes what a pairing MEANS, from admitting a device
3044/// to admitting a person and their future devices, and that should be chosen rather than inherited
3045/// on upgrade. An attestation cannot admit a stranger — the receiver must already hold a row for
3046/// that `user_id` — cannot resurrect a REVOKED endpoint OR a revoked IDENTITY (ask 4, which is why
3047/// it shipped first; `peer_revoke` on a `b64u:` now revokes the person, because a thief holding the
3048/// disk holds the user key and can mint a fresh endpoint id at will), and
3049/// grants the INTERSECTION of that person's existing services, never the union. Guard on `>= 52`;
3050/// to 51 with the PAIRING-MODE REVOCATION verbs —
3051/// `peer_revoke` / `peer_unrevoke` / `device_revoke` / `device_revocation_import`, plus
3052/// [`StatusResult::revoked`] (#85 ask 4). `revoked_endpoints` was roster-only, so in pairing mode
3053/// the only remedy for a stolen device was every peer independently running `peer_remove`, with
3054/// nothing telling them they should — until the last one did, whoever held the disk authenticated
3055/// as its owner and every message they sent was cryptographically indistinguishable. Two
3056/// directions, deliberately not one verb: `peer_revoke` is MY local decision about YOUR device;
3057/// `device_revoke` signs a portable statement about MY OWN, which is the half my peers cannot
3058/// discover for themselves. An import is honoured only from a `user_id` this node already pairs
3059/// with, and only for that person's OWN devices — a signature proves who asked, not that the
3060/// endpoint was ever theirs. Revocation is IMMEDIATE (live sessions severed, #54) and outlives the
3061/// pair row, so it cannot be undone by re-pairing. Guard on `>= 51`; to 50 with [`SelfNetwork::local_discovery`] — LOCAL (mDNS)
3062/// peer discovery, off unless `[network].local_discovery` asks for it (#68). Peer resolution
3063/// otherwise needs external infrastructure, so two machines on one LAN with no uplink could not
3064/// find each other though the path between them was fine. Three modes: `"off"` (default), `"on"`
3065/// (resolve AND announce), `"resolve"` (resolve without publishing this node's identity — it still
3066/// QUERIES about once a second, so it is quieter, not silent). Reported on `status` because the
3067/// setting was
3068/// otherwise unobservable and because **`"on"` means this node multicasts its endpoint id and
3069/// addresses to every device on the link** — a product backing a privacy switch has to be able to
3070/// show that. Deliberately NOT on by default, against what #68 asked for: pkarr publishes a signed
3071/// record you must already know the endpoint id to look up, while mDNS announces to strangers on a
3072/// café or hotel network, and a multicast packet cannot be un-sent. Guard on `>= 50`; to 49 with [`StorageInfo::blobs_gc`] — app-blob GARBAGE
3073/// COLLECTION, off unless `[blobs].gc_interval` is set (#80). `blob_unpublish` and `blob_revoke`
3074/// closed the AUTHORIZATION half at 15; neither reclaimed a byte, so `<data_dir>/blobs/` grew
3075/// monotonically for the life of the node and an embedder that had told a user "this file is
3076/// deleted" could not deliver that. Opt-in, because a sweep also reclaims blobs this node FETCHED
3077/// and never republished — reclaimable in themselves (the fetch already wrote the caller's
3078/// `dest_path`) but it means `blob_republish` of a hash fetched more than one interval ago fails.
3079/// `blobs_gc` is `None` when collection is not configured, `Some` with `runs: 0` when it is
3080/// configured and has not swept yet — a distinction worth reading, because the collector sleeps a
3081/// full interval before its first run. WATCH `runs`: iroh-blobs ends collection for the process on
3082/// its first sweep error, so a counter that stops advancing is the only signal. Guard on `>= 49`;
3083/// to 48 with `user_key_export` / `user_key_import` — a
3084/// RECOVERY PHRASE for the user key, so a person's `b64u:` survives the hardware (#85 ask 2). It
3085/// lived in one file on one machine with no export, import or escrow verb anywhere, so replacing a
3086/// laptop destroyed the identity peers pin, kb audiences key on, and a roster names — recovery was
3087/// an in-person SAS ceremony with everyone you had ever paired with. **The export response carries
3088/// a PRIVATE KEY**: it is deliberately absent from the audit log, from `status`, and from every
3089/// other surface. Import refuses to overwrite an existing key unless asked, because doing so
3090/// discards a live identity irreversibly. What it does NOT do: get a device admitted. Peers
3091/// authorize per DEVICE, and a restored user key puts this endpoint in nobody's allowlist — that is
3092/// #85 ask 3, unshipped, and the reason a recovered person still pairs. Guard on `>= 48`; to 47 with `BlobFetchParams::from` — ADDITIONAL sources a
3093/// fetch falls back to when the ticket's publisher does not answer (#83). Content addressing makes
3094/// every recipient a potential source, and a one-address ticket made that unusable: a file shared
3095/// with a room became unfetchable the moment the sender closed their laptop, though others in the
3096/// room already held the identical verified bytes. Additive and absent-tolerant — an older caller's
3097/// payload reads as empty, which is the single-source behaviour — so guard on `>= 47` only before
3098/// SENDING the field (`deny_unknown_fields` rejects the whole request below it). The bytes stay
3099/// BLAKE3-verified against the ticket's hash whoever serves them, so an alternate can refuse but
3100/// never substitute; it must have republished the hash into a scope granting the caller
3101/// (`blob_republish`, `api_minor >= 18`). What did NOT land: multi-source PARALLEL fetch — sources
3102/// are tried in order, so an offline publisher costs one dial timeout; to 46 with the roster-mode embedding surface (#66, #93):
3103/// the `org_create` / `org_approve` / `org_revoke` AUTHORING verbs, the `roster_members` read,
3104/// `PresencePeer::display_name` + `groups`, `RosterStatus::groups`, and
3105/// `OrgJoinResult::restart_required`. Two gaps close together. Authoring existed only as CLI
3106/// porcelain, so an embedded node could CONSUME a roster and never author one — no "approve this
3107/// person" button without shelling out to a second binary. And the roster's own contents never
3108/// crossed the seam: an embedder had managed group membership it could not display, and the only
3109/// route to a member list was hand-parsing the daemon-owned `roster.json`. `roster_members` is a
3110/// different question from `status.presence` — that lists reachable DEVICES and omits a person
3111/// whose devices are all down. `restart_required` closes a silent partial success: `roster_mode` is
3112/// a BOOT decision fixing the bound ALPNs and whether gossip/presence/blobs exist at all, so a
3113/// pairing-mode node that ran `org_join` got working MCP sessions with permanently empty presence
3114/// and no way to detect it. Guard on `>= 46` before offering org authoring in a UI; the read fields
3115/// are additive and degrade to empty. What did NOT land: org root ROTATION (#93c) — an operator
3116/// laptop that dies still takes the org with it once the roster expires; to 45 with [`PairParams::allow_self_enroll`] +
3117/// [`ERR_SELF_ENROLL_NOT_OFFERED`] — `pair` now REFUSES a `mcpmesh-enroll:` line unless the caller
3118/// asked for that ceremony. A behaviour change for existing callers, deliberately: at 43-44 a caller
3119/// whose UI only ever offered "add a contact" completed a self-enrollment and learned which
3120/// ceremony it had run from `enrolled_as_self` afterwards — by which point the device→user binding
3121/// was written and irrevocable short of rotating the user key (#178). The refusal is decided from
3122/// the line before any dial, so the invite survives it and the same line works once the ceremony is
3123/// actually offered. Guard on `>= 45` before sending the field — below it `deny_unknown_fields`
3124/// rejects the whole request. Note what the guard means: a daemon BELOW 45 gives a caller no way to
3125/// decline, so a UI that does not offer device enrollment should require `>= 45` rather than pair
3126/// without it; to 44 when control responses stopped arriving in REQUEST
3127/// order and the `blob_fetch_cancel` verb landed (#172). The daemon now dispatches each request
3128/// CONCURRENTLY on its connection, so a `blob_fetch` no longer stalls every other verb behind it —
3129/// and responses arrive in COMPLETION order. JSON-RPC ids make that legal and the in-tree
3130/// `ControlClient` cannot observe it (one request at a time, by construction), but a hand-rolled
3131/// client that pipelines and matches responses POSITIONALLY breaks. A connection also caps
3132/// in-flight requests and refuses over it with [`ERR_TOO_MANY_INFLIGHT`], and closing a control
3133/// connection now genuinely ABORTS its in-flight work rather than letting it run to completion
3134/// unread. Guard on `>= 44` before pipelining, before sending `blob_fetch_cancel`, and before
3135/// treating [`ERR_CANCELLED`] as unexpected; to 43 with `InviteParams::as_self` — SELF-ENROLLMENT, so one
3136/// person's devices share a `user_id` instead of appearing as unrelated strangers (#86). The
3137/// ceremony is ordinary pairing; the outcome is a device→user binding rather than a peer row, and
3138/// the private key never moves. Guard on `>= 43`. What this entry did NOT say, and 45 fixed: the
3139/// distinct scheme closes the version-SKEW hazard (a pre-43 redeemer silently over-granting) and
3140/// closes nothing for a CURRENT redeemer, which had no way to decline a ceremony it never offered
3141/// (#178); to 42 with the `peer_introduce` + `peer_endorse`
3142/// verbs — install a peer from a
3143/// SIGNED endorsement by someone you are already paired with, so a small group onboards in O(N)
3144/// instead of O(N²) two-human ceremonies (#65). It installs IDENTITY only and grants nothing, which
3145/// is what bounds it. Guard on `>= 42`; to 41 with `StreamFrame::BlobTransfer` — live app-blob
3146/// transfer progress on both the serving and fetching side (#82 ask 2), so an embedder can draw a
3147/// real progress bar instead of an indeterminate spinner. Guard on `>= 41` before expecting the
3148/// frame. NOTE what it did NOT bring, and 44 did: at 41 `blob_fetch` still blocked its whole
3149/// control connection for the transfer and nothing could cancel it (#172) — progress arrived on the
3150/// SUBSCRIBE connection, which is a different one; to 40 with `[services.<name>].rate_limit_per_min` +
3151/// `RegisterServiceParams::rate_limit_per_min` — proxied-request buckets became per
3152/// `(service, endpoint)` instead of one shared per-endpoint bucket, so a noisy service can no
3153/// longer starve a quiet one (#63). `-32053` changes meaning with it: it is now per-service, so a
3154/// consumer that backs off globally on one is backing off further than it needs to. Guard on
3155/// `>= 40` before sending the field or narrowing a back-off; to 39 with `PairParams::as_nickname` +
3156/// `InviteParams::peer_nickname` — LOCAL aliases for the other party, so a nickname collision is
3157/// resolvable by the person who hit it instead of requiring the other human to rename a machine or
3158/// re-mint. #147 made the collision diagnosable; this makes it fixable. Guard on `>= 39` before
3159/// offering an alias field in a UI: below it `deny_unknown_fields` rejects the whole request
3160/// (#87); to 38 with `[network].presence_mode` + `SelfNetwork.
3161/// presence_mode` — `reachable: false` gained a new meaning ("up, paired, and deliberately not
3162/// answering"), and `peer_services` flips from "reachable, empty list" to "unreachable" for a
3163/// caller holding no grant. A consumer must guard on `api_minor >= 38` before telling a user their
3164/// peer is offline, since below it that verdict could not mean this (#89); to 37 when the reserved
3165/// `mcpmesh/*` `_meta` namespace began
3166/// being enforced on EVERY proxied frame rather than the session's first. `run_session` treats
3167/// frame 1 as the `initialize` whatever its method is, so a caller could send any other method
3168/// first and put its real `initialize` — with a forged `mcpmesh/peer` naming another principal,
3169/// forged `groups` and all — in frame 2, where nothing stripped or injected. No shape changed;
3170/// what changed is whether `_meta["mcpmesh/peer"]` can be trusted, which is the entire reason a
3171/// backend reads it. Guard on `api_minor >= 37` before keying authorization on that value (#164).
3172///
3173/// **Not every semantic change gets a minor, and that is the gap to watch (#122).** A minor marks a
3174/// change to this *surface*. A change to behaviour BEHIND the surface — same fields, same shapes,
3175/// different meaning — may not bump it, and is invisible to a type diff. 17 and 24 above happen to
3176/// be that class and did bump; do not infer from them that every such change will. When bumping
3177/// several minors at once, read this block end to end AND the release notes, not the diff.
3178///
3179/// That class is bigger than it looks: **10, 17, 21, 22, 23, 24 and 37 all shipped with no change
3180/// to any type in this file** — they moved meaning, not shape. Seven of the forty, and 37 is
3181/// a SECURITY fix, which is the case where a consumer most needs the guard. 38 adds a field, but
3182/// its REAL content is a meaning change to `reachable` — the field exists so the new meaning is
3183/// observable at all. A downstream
3184/// that diffs types across a multi-minor bump sees nothing for any of them.
3185pub const API_MINOR: u32 = 59;
3186
3187#[cfg(test)]
3188mod tests {
3189 use super::*;
3190
3191 /// #64: the path field's wire shape, and its ADDITIVE default. A row from an older daemon has
3192 /// no `path` key at all and must land on `Unknown` — never on `Direct`, which would invent a
3193 /// privacy guarantee that daemon never made.
3194 #[test]
3195 fn peer_path_tags_and_defaults_to_unknown() {
3196 let tagged = |p: PeerPath| serde_json::to_value(p).unwrap();
3197 assert_eq!(tagged(PeerPath::Direct)["kind"], "direct");
3198 assert_eq!(tagged(PeerPath::Unknown)["kind"], "unknown");
3199 let relay = tagged(PeerPath::Relay {
3200 url: Some("https://relay.example/".into()),
3201 });
3202 assert_eq!(relay["kind"], "relay");
3203 assert_eq!(relay["url"], "https://relay.example/");
3204 // A relay whose URL we do not know still tags as relay, with the key elided.
3205 let bare = tagged(PeerPath::Relay { url: None });
3206 assert_eq!(bare["kind"], "relay");
3207 assert!(bare.get("url").is_none(), "elided, not null: {bare}");
3208
3209 // #64 review: a path kind from a NEWER daemon must degrade to Unknown, not fail the whole
3210 // row. Without `#[serde(other)]` an unknown `kind` errors out of
3211 // `PeerReachability` entirely, so one new variant would break every `status` read an
3212 // older pinned client does.
3213 let future: PeerPath =
3214 serde_json::from_value(serde_json::json!({"kind": "quantum", "id": "x"})).unwrap();
3215 assert_eq!(future, PeerPath::Unknown);
3216 let row: PeerReachability = serde_json::from_value(serde_json::json!({
3217 "name": "bob", "reachable": true, "path": {"kind": "quantum"}
3218 }))
3219 .expect("an unknown path kind must not fail the whole row");
3220 assert_eq!(row.path, PeerPath::Unknown);
3221 assert!(row.reachable, "the rest of the row survives");
3222
3223 // A pre-#64 row: no `path` key.
3224 let old = serde_json::json!({"name": "bob", "reachable": true});
3225 let parsed: PeerReachability = serde_json::from_value(old).unwrap();
3226 assert_eq!(
3227 parsed.path,
3228 PeerPath::Unknown,
3229 "an older daemon's row must never imply a direct path"
3230 );
3231 }
3232
3233 /// #58: the pushed liveness frame tags as `{"type":"reachability","peer":{…}}` and carries a
3234 /// whole `PeerReachability` row — the SAME shape the opening snapshot's list holds, so a
3235 /// consumer projects both through one code path.
3236 #[test]
3237 fn reachability_frame_tags_and_round_trips() {
3238 let frame = StreamFrame::Reachability {
3239 peer: PeerReachability {
3240 name: "bob".into(),
3241 reachable: true,
3242 rtt_ms: Some(12),
3243 age_secs: Some(0),
3244 meta: String::new(),
3245 principal: Some("eid:beef".into()),
3246 path: Default::default(),
3247 },
3248 source: ReachabilitySource::Probe,
3249 };
3250 let v = serde_json::to_value(&frame).unwrap();
3251 assert_eq!(v["type"], "reachability");
3252 assert_eq!(v["peer"]["name"], "bob");
3253 assert_eq!(v["peer"]["reachable"], true);
3254 assert_eq!(
3255 v["peer"]["age_secs"], 0,
3256 "a transition frame is fresh by construction: {v}"
3257 );
3258 assert_eq!(v["source"], "probe", "#150: the producer is named: {v}");
3259 let back: StreamFrame = serde_json::from_value(v).unwrap();
3260 assert_eq!(back, frame);
3261 }
3262
3263 /// #150: the frame's `source` wire shape, and the two ways it must degrade.
3264 ///
3265 /// The default is the load-bearing part. An absent key comes from a daemon at `api_minor`
3266 /// 22–29, which ALREADY has both producers — so it must land on `Unknown`, never on `Probe`.
3267 /// Defaulting to `Probe` would tell a consumer "a throwaway dial saw this" about frames that
3268 /// were a live session degrading, which is the ambiguity the field exists to remove.
3269 /// #140: `known_addrs` absent, empty, and populated are three DIFFERENT wire shapes.
3270 ///
3271 /// The distinction is the field's whole reason for existing, and it is carried by
3272 /// `skip_serializing_if` — so it lives on the wire, not in Rust. An embedder checking
3273 /// `known_addrs === null` gets `undefined`, which is why the absent case is asserted as a
3274 /// MISSING KEY rather than a null.
3275 #[test]
3276 fn known_addrs_distinguishes_absent_from_empty_on_the_wire() {
3277 let base = PeerDiagnosticsResult {
3278 nickname: "jetson".into(),
3279 principal: "eid:beef".into(),
3280 hint_usable: true,
3281 ..Default::default()
3282 };
3283
3284 // Absent: the key is OMITTED, never serialized as null.
3285 let v = serde_json::to_value(&base).unwrap();
3286 assert!(
3287 v.get("known_addrs").is_none(),
3288 "an absent iroh entry elides the key — a consumer must test presence, not null: {v}"
3289 );
3290
3291 // Empty: iroh HAS an entry and holds no address. A real, different state.
3292 let empty = PeerDiagnosticsResult {
3293 known_addrs: Some(vec![]),
3294 ..base.clone()
3295 };
3296 let v = serde_json::to_value(&empty).unwrap();
3297 assert_eq!(
3298 v["known_addrs"],
3299 serde_json::json!([]),
3300 "an empty list must survive as `[]` rather than collapsing back to absent: {v}"
3301 );
3302 assert_eq!(
3303 serde_json::from_value::<PeerDiagnosticsResult>(v).unwrap(),
3304 empty,
3305 "and round-trip back to Some(vec![]), not None"
3306 );
3307
3308 // Populated, with the `active` flag per address.
3309 let full = PeerDiagnosticsResult {
3310 known_addrs: Some(vec![
3311 KnownAddr {
3312 addr: "192.168.1.77:4433".into(),
3313 active: true,
3314 },
3315 KnownAddr {
3316 addr: "relay https://r.example:8443".into(),
3317 active: false,
3318 },
3319 ]),
3320 hint_addrs_unknown_to_iroh: vec!["10.0.0.9:4433".into()],
3321 ..base
3322 };
3323 let v = serde_json::to_value(&full).unwrap();
3324 assert_eq!(v["known_addrs"][0]["addr"], "192.168.1.77:4433");
3325 assert_eq!(v["known_addrs"][0]["active"], true);
3326 assert_eq!(v["known_addrs"][1]["active"], false);
3327 assert_eq!(
3328 v["hint_addrs_unknown_to_iroh"],
3329 serde_json::json!(["10.0.0.9:4433"])
3330 );
3331 assert!(
3332 v.get("iroh_addrs_not_in_hint").is_none(),
3333 "an empty difference elides rather than shipping `[]` noise in every capture: {v}"
3334 );
3335 assert_eq!(
3336 serde_json::from_value::<PeerDiagnosticsResult>(v).unwrap(),
3337 full
3338 );
3339 }
3340
3341 #[test]
3342 fn reachability_source_tags_and_defaults_to_unknown() {
3343 let tagged = |s: ReachabilitySource| serde_json::to_value(s).unwrap();
3344 assert_eq!(tagged(ReachabilitySource::Probe), "probe");
3345 assert_eq!(tagged(ReachabilitySource::Session), "session");
3346 assert_eq!(tagged(ReachabilitySource::Unknown), "unknown");
3347 for s in [
3348 ReachabilitySource::Probe,
3349 ReachabilitySource::Session,
3350 ReachabilitySource::Unknown,
3351 ] {
3352 let back: ReachabilitySource = serde_json::from_value(tagged(s)).unwrap();
3353 assert_eq!(back, s, "round trip");
3354 }
3355
3356 let peer = serde_json::json!({"name": "bob", "reachable": true});
3357
3358 // A pre-#150 frame: no `source` key at all.
3359 let old: StreamFrame =
3360 serde_json::from_value(serde_json::json!({"type": "reachability", "peer": peer}))
3361 .expect("an older daemon's frame must still parse");
3362 let StreamFrame::Reachability { source, .. } = old else {
3363 panic!("expected a reachability frame");
3364 };
3365 assert_eq!(
3366 source,
3367 ReachabilitySource::Unknown,
3368 "an api_minor 22-29 daemon has BOTH producers, so an absent key must not claim Probe"
3369 );
3370
3371 // A producer from a NEWER daemon must degrade to Unknown, not fail the whole frame — the
3372 // same stake `PeerPath` buys with `#[serde(other)]`. Without the hand-written Deserialize
3373 // a third producer would break every Reachability frame an older pinned client reads.
3374 let future: StreamFrame = serde_json::from_value(
3375 serde_json::json!({"type": "reachability", "peer": peer, "source": "telemetry"}),
3376 )
3377 .expect("an unknown producer must not fail the whole frame");
3378 let StreamFrame::Reachability { source, peer } = future else {
3379 panic!("expected a reachability frame");
3380 };
3381 assert_eq!(source, ReachabilitySource::Unknown);
3382 assert!(peer.reachable, "the rest of the frame survives");
3383 }
3384
3385 /// #148: a defaulted status is EMPTY and honest — the fixture ergonomic an embedder gets in
3386 /// exchange for us adding fields.
3387 ///
3388 /// Its content is the load-bearing part. A downstream test that omits a field must not thereby
3389 /// assert something: no phantom peers or services, and the optional blocks absent rather than
3390 /// zeroed. `storage: Some(StorageInfo::default())` would read as "0 bytes on disk", which is a
3391 /// measurement nobody took.
3392 #[test]
3393 fn a_defaulted_status_is_empty_and_claims_nothing() {
3394 let d = StatusResult::default();
3395 assert!(d.peers.is_empty() && d.services.is_empty(), "{d:?}");
3396 assert!(d.reachability.is_empty() && d.presence.is_empty(), "{d:?}");
3397 assert!(d.recent_pairings.is_empty(), "{d:?}");
3398 assert_eq!(d.roster, None, "no roster is not an empty roster");
3399 assert_eq!(d.storage, None, "absent, not 0 bytes — nobody measured");
3400 assert_eq!(d.self_network, None, "absent, not offline — nobody looked");
3401 assert_eq!(d.self_user_id, None);
3402 assert!(
3403 d.stack_version.is_empty() && d.self_nickname.is_empty(),
3404 "{d:?}"
3405 );
3406
3407 // The pattern the issue actually asks for: additive growth stops breaking fixtures.
3408 let fixture = StatusResult {
3409 peers: vec![PeerInfo {
3410 name: "bob".into(),
3411 ..Default::default()
3412 }],
3413 ..Default::default()
3414 };
3415 assert_eq!(fixture.peers[0].name, "bob");
3416 assert!(fixture.services.is_empty());
3417
3418 // A default round-trips, so the elide-vs-null discipline holds for one too.
3419 let v = serde_json::to_value(&d).unwrap();
3420 assert!(v.get("roster").is_none(), "elided, not null: {v}");
3421 assert!(v.get("storage").is_none(), "elided, not null: {v}");
3422 let back: StatusResult = serde_json::from_value(v).unwrap();
3423 assert_eq!(back, d);
3424 }
3425
3426 /// #148: a defaulted reachability row is NOT reachable and makes NO path claim.
3427 ///
3428 /// This is the one default where a wrong choice would be a false guarantee rather than a
3429 /// harmless placeholder — the same trap `PeerPath`'s `#[default] Unknown` exists to avoid
3430 /// (#64), now reachable through a second door. A fixture that forgot to set `path` must not
3431 /// thereby assert the peer was reached directly, and one that forgot `reachable` must not
3432 /// claim it was up.
3433 #[test]
3434 fn a_defaulted_reachability_row_asserts_nothing_about_the_peer() {
3435 let d = PeerReachability::default();
3436 assert!(!d.reachable, "an unset row must not claim the peer is up");
3437 assert_eq!(
3438 d.path,
3439 PeerPath::Unknown,
3440 "an unset path must never read as Direct — that is a privacy claim no one made"
3441 );
3442 assert_eq!(d.rtt_ms, None, "no measurement was taken");
3443 assert_eq!(d.age_secs, None, "never probed");
3444 assert_eq!(d.principal, None);
3445 assert!(d.name.is_empty() && d.meta.is_empty());
3446 }
3447
3448 /// #148 gate: the REST of the new defaults, which the first pass left entirely unasserted —
3449 /// moving `BackendKind`'s `#[default]` to `Socket` failed nothing across the whole workspace.
3450 ///
3451 /// Each assertion below is the conservative reading of a field that could otherwise let a
3452 /// fixture assert something by omission.
3453 #[test]
3454 fn the_remaining_defaults_are_conservative() {
3455 let s = ServiceInfo::default();
3456 assert!(
3457 s.allow.is_empty(),
3458 "an unset allow must admit NOBODY — empty is deny (the gate's `any()` is false on an \
3459 empty list), and a permissive default here would be an authz hole reachable from a \
3460 fixture"
3461 );
3462 assert!(s.allow_display.is_empty() && s.name.is_empty());
3463 assert!(
3464 !s.ephemeral,
3465 "persistent is the conservative reading, and matches the wire default"
3466 );
3467 assert_eq!(
3468 s.backend,
3469 BackendKind::Run,
3470 "the documented choice — a convenience, not a claim; pinned so it cannot drift \
3471 silently out of step with its own rustdoc"
3472 );
3473 assert_eq!(BackendKind::default(), BackendKind::Run);
3474
3475 let p = PeerInfo::default();
3476 assert!(p.name.is_empty() && p.services.is_empty());
3477 assert_eq!(p.user_id, None, "no identity was proven");
3478 assert_eq!(p.principal, None);
3479
3480 // The gate's finding: this default is the documented "deliberately LAN-only" posture,
3481 // which the porcelain renders as healthy and NOT as a warning. It is unavoidable (a bool
3482 // has no third state) but it must stay deliberate, so it is pinned rather than left to
3483 // be rediscovered by whoever writes the next fixture.
3484 let n = SelfNetwork::default();
3485 assert!(!n.online, "no relay connection is established");
3486 assert!(
3487 n.relays.is_empty() && n.home_relay.is_none(),
3488 "and none are known — which the renderer reads as LAN-BY-CONFIGURATION, not as an \
3489 outage; say 'nobody looked' with StatusResult.self_network: None instead"
3490 );
3491 assert_eq!(n.last_change_epoch, None, "no transition was observed");
3492
3493 let r = RelayInfo::default();
3494 assert!(
3495 !r.connected,
3496 "an unset relay must not claim a live connection"
3497 );
3498
3499 let st = StorageInfo::default();
3500 assert_eq!(
3501 (st.audit_bytes, st.redb_bytes, st.blobs_bytes),
3502 (0, 0, 0),
3503 "zeros read as MEASURED-and-empty; `StatusResult.storage: None` is 'unmeasured'"
3504 );
3505
3506 let ro = RosterStatus::default();
3507 assert!(
3508 ro.state.is_empty(),
3509 "not a valid state word, deliberately — `doctor` warns on an unknown state rather \
3510 than reporting a healthy roster"
3511 );
3512 assert_eq!(ro.serial, 0);
3513
3514 let pp = PresencePeer::default();
3515 assert!(
3516 !pp.online,
3517 "an unset presence row must not claim the device is up"
3518 );
3519 assert!(pp.role.is_empty() && pp.user_id.is_empty());
3520
3521 let rp = RecentPairing::default();
3522 assert_eq!(rp.paired_at_epoch, 0);
3523 assert!(rp.sas_code.is_empty(), "no ceremony produced a code");
3524 }
3525
3526 /// #150 gate: "an unrecognized value reads as `unknown`" must hold for any VALUE, not just an
3527 /// unrecognized string.
3528 ///
3529 /// `#[serde(default)]` covers an absent key and nothing else, so `"source": null` — what a
3530 /// proxy or non-Rust daemon that normalizes optional fields produces — went through the
3531 /// deserializer and failed the WHOLE frame, silently dropping a liveness transition while the
3532 /// protocol doc promised the field could not break a parse. The container shapes matter
3533 /// separately: a visitor that answers without draining a map/seq desynchronizes the parser and
3534 /// fails the frame anyway, which looks identical from outside.
3535 #[test]
3536 fn a_malformed_source_degrades_instead_of_failing_the_frame() {
3537 let peer = serde_json::json!({"name": "bob", "reachable": true});
3538 for bad in [
3539 serde_json::Value::Null,
3540 serde_json::json!(7),
3541 serde_json::json!(-1),
3542 serde_json::json!(1.5),
3543 serde_json::json!(true),
3544 serde_json::json!({"kind": "probe", "nested": {"deep": [1, 2]}}),
3545 serde_json::json!(["probe", "session"]),
3546 ] {
3547 let frame: StreamFrame = serde_json::from_value(
3548 serde_json::json!({"type": "reachability", "peer": peer, "source": bad}),
3549 )
3550 .unwrap_or_else(|e| panic!("`source: {bad}` must not fail the whole frame: {e}"));
3551 let StreamFrame::Reachability { source, peer } = frame else {
3552 panic!("expected a reachability frame");
3553 };
3554 assert_eq!(source, ReachabilitySource::Unknown, "for source: {bad}");
3555 assert!(peer.reachable, "the rest of the frame survives: {bad}");
3556 }
3557 }
3558
3559 /// #90: the self-network frame tags as `{"type":"self_network","self_network":{…}}` — the
3560 /// SAME block `status` and the snapshot carry. Pinned explicitly (like the reachability
3561 /// tag) so a variant rename cannot slip past a suite whose two ends share the type while
3562 /// breaking every doc-following third-party client.
3563 #[test]
3564 fn self_network_frame_tags_and_round_trips() {
3565 let frame = StreamFrame::SelfNetwork {
3566 self_network: SelfNetwork {
3567 online: true,
3568 home_relay: Some("https://relay.example:443".into()),
3569 relays: vec![RelayInfo {
3570 url: "https://relay.example:443".into(),
3571 connected: true,
3572 }],
3573 direct_addrs: vec!["192.168.1.2:4444".into()],
3574 last_change_epoch: Some(1_753_842_000),
3575 identity_conflict_epoch: None,
3576 // #89: seeded NON-default so the round-trip actually carries it — an empty value
3577 // here would round-trip through a `skip_serializing_if` and prove nothing.
3578 presence_mode: Some("granted".into()),
3579 // #68: seeded `"resolve"`, deliberately NOT the `"off"` default — a fixture equal
3580 // to the default would round-trip identically whether or not the field was carried
3581 // at all, and the assertion below would measure nothing.
3582 local_discovery: Some("resolve".into()),
3583 },
3584 };
3585 let v = serde_json::to_value(&frame).unwrap();
3586 assert_eq!(v["type"], "self_network");
3587 assert_eq!(v["self_network"]["online"], true);
3588 assert_eq!(v["self_network"]["home_relay"], "https://relay.example:443");
3589 assert_eq!(v["self_network"]["relays"][0]["connected"], true);
3590 assert_eq!(
3591 v["self_network"]["presence_mode"], "granted",
3592 "#89: the live presence mode must reach the wire — it is the only way an operator can \
3593 confirm the knob took effect, and a product's privacy switch has nothing to render \
3594 without it"
3595 );
3596 assert_eq!(
3597 v["self_network"]["local_discovery"], "resolve",
3598 "#68: the live local-discovery mode must reach the wire — `\"on\"` means this node is \
3599 multicasting its endpoint id to every device on the link, and a privacy switch has \
3600 nothing to render without it"
3601 );
3602 let back: StreamFrame = serde_json::from_value(v).unwrap();
3603 assert_eq!(back, frame);
3604 }
3605
3606 #[test]
3607 fn peer_reachability_serde_is_additive() {
3608 let r = PeerReachability {
3609 name: "bob".into(),
3610 reachable: true,
3611 rtt_ms: Some(42),
3612 age_secs: Some(3),
3613 meta: String::new(),
3614 principal: None,
3615 path: Default::default(),
3616 };
3617 let v = serde_json::to_value(&r).unwrap();
3618 assert_eq!(v["name"], "bob");
3619 assert_eq!(v["reachable"], true);
3620 assert_eq!(v["rtt_ms"], 42);
3621 assert_eq!(v["age_secs"], 3);
3622 // Never-probed peer: optionals elided, not null.
3623 let unknown = PeerReachability {
3624 name: "carol".into(),
3625 reachable: false,
3626 rtt_ms: None,
3627 age_secs: None,
3628 meta: String::new(),
3629 principal: None,
3630 path: Default::default(),
3631 };
3632 let uv = serde_json::to_value(&unknown).unwrap();
3633 assert!(uv.get("rtt_ms").is_none() && uv.get("age_secs").is_none());
3634 // An older StatusResult (no reachability field) still deserializes.
3635 let old = serde_json::json!({"stack_version":"0.1.0","services":[],"peers":[]});
3636 let s: StatusResult = serde_json::from_value(old).unwrap();
3637 assert!(s.reachability.is_empty());
3638 }
3639
3640 #[test]
3641 fn subscribe_method_tag_resolves() {
3642 let req = serde_json::to_value(Request::Subscribe).unwrap();
3643 assert_eq!(method_of(&req), Some("subscribe"));
3644 }
3645
3646 // --- #34: params structs reject unknown fields (the `{service: "kb"}` silent-accept bug) ---
3647
3648 #[test]
3649 fn invite_params_reject_singular_service_typo() {
3650 // The reported bug: `{"service":"kb"}` (singular) used to deserialize to
3651 // `InviteParams { services: [] }` and mint a grants-nothing invite that looked
3652 // successful. With deny_unknown_fields the typo is a loud parse error instead.
3653 let err = serde_json::from_value::<InviteParams>(serde_json::json!({"service": "kb"}));
3654 assert!(
3655 err.is_err(),
3656 "an unknown `service` key must be rejected, not silently ignored"
3657 );
3658 // The correct plural shape still parses.
3659 let ok: InviteParams =
3660 serde_json::from_value(serde_json::json!({"services": ["kb"]})).unwrap();
3661 assert_eq!(ok.services, vec!["kb".to_string()]);
3662 }
3663
3664 #[test]
3665 fn open_session_params_reject_unknown_field() {
3666 let err = serde_json::from_value::<OpenSessionParams>(
3667 serde_json::json!({"peer": "a", "service": "b", "nonsense": 1}),
3668 );
3669 assert!(err.is_err(), "unknown params keys must be rejected");
3670 }
3671
3672 #[test]
3673 fn set_app_metadata_request_carries_the_method_tag() {
3674 let r = Request::SetAppMetadata(SetAppMetadataParams {
3675 metadata: "v=1.2.3".into(),
3676 });
3677 let v = serde_json::to_value(&r).unwrap();
3678 assert_eq!(v["method"], "set_app_metadata");
3679 assert_eq!(v["params"]["metadata"], "v=1.2.3");
3680 assert_eq!(method_of(&v), Some("set_app_metadata"));
3681 }
3682
3683 #[test]
3684 fn set_app_metadata_params_reject_unknown_field() {
3685 let err = serde_json::from_value::<SetAppMetadataParams>(
3686 serde_json::json!({"metadata": "x", "nonsense": 1}),
3687 );
3688 assert!(err.is_err(), "unknown params keys must be rejected");
3689 }
3690
3691 /// `PresencePeer.meta` is additive — an older payload (no meta) still deserializes, and an
3692 /// empty meta does not serialize.
3693 #[test]
3694 fn peer_info_principal_is_additive() {
3695 // An older payload (no principal) still deserializes; empty does not serialize.
3696 let old = serde_json::json!({"name": "bob", "services": ["notes"]});
3697 let p: PeerInfo = serde_json::from_value(old).unwrap();
3698 assert_eq!(p.principal, None);
3699 assert!(serde_json::to_value(&p).unwrap().get("principal").is_none());
3700 // A bound peer carries BOTH the person user_id AND the device principal (#41).
3701 let full = PeerInfo {
3702 name: "bob".into(),
3703 services: vec!["notes".into()],
3704 user_id: Some("b64u:BOB".into()),
3705 principal: Some("eid:0707".into()),
3706 };
3707 let back: PeerInfo = serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
3708 assert_eq!(back.user_id.as_deref(), Some("b64u:BOB"));
3709 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
3710 }
3711
3712 #[test]
3713 fn active_session_principal_is_additive() {
3714 // An OLD payload (no `principal`) must still deserialize — #73 is additive.
3715 let old: ActiveSession =
3716 serde_json::from_str(r#"{"peer":"bob","service":"notes","opened_at":7}"#).unwrap();
3717 assert_eq!(old.principal, None, "serde(default) supplies it");
3718
3719 // And a `None` must not serialize, so an old client sees the shape it expects.
3720 let json = serde_json::to_string(&old).unwrap();
3721 assert!(
3722 !json.contains("principal"),
3723 "skip_serializing_if must omit it: {json}"
3724 );
3725
3726 // A real row round-trips the principal.
3727 let new = ActiveSession {
3728 peer: "bob".into(),
3729 service: "notes".into(),
3730 opened_at: 7,
3731 principal: Some("eid:1f0a".into()),
3732 };
3733 let back: ActiveSession =
3734 serde_json::from_str(&serde_json::to_string(&new).unwrap()).unwrap();
3735 assert_eq!(back.principal.as_deref(), Some("eid:1f0a"));
3736 }
3737
3738 #[test]
3739 fn peer_reachability_principal_is_additive() {
3740 // Older payload (no principal) still deserializes; empty does not serialize; a set
3741 // value round-trips alongside the #40 meta so an embedder joins on the principal.
3742 let old = serde_json::json!({"name": "bob", "reachable": true});
3743 let r: PeerReachability = serde_json::from_value(old).unwrap();
3744 assert_eq!(r.principal, None);
3745 assert!(serde_json::to_value(&r).unwrap().get("principal").is_none());
3746 let full = PeerReachability {
3747 name: "bob".into(),
3748 reachable: true,
3749 rtt_ms: Some(12),
3750 age_secs: Some(3),
3751 meta: "v=1.2.3".into(),
3752 principal: Some("eid:0707".into()),
3753 path: Default::default(),
3754 };
3755 let back: PeerReachability =
3756 serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
3757 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
3758 assert_eq!(back.meta, "v=1.2.3");
3759 }
3760
3761 #[test]
3762 fn peer_reachability_meta_is_additive() {
3763 // An older payload (no meta) still deserializes; an empty meta does not serialize.
3764 let old = serde_json::json!({"name": "bob", "reachable": true});
3765 let r: PeerReachability = serde_json::from_value(old).unwrap();
3766 assert_eq!(r.meta, "");
3767 assert!(serde_json::to_value(&r).unwrap().get("meta").is_none());
3768 // A set value round-trips.
3769 let with = PeerReachability {
3770 name: "bob".into(),
3771 reachable: true,
3772 rtt_ms: Some(12),
3773 age_secs: Some(3),
3774 meta: "v=1.2.3".into(),
3775 principal: None,
3776 path: Default::default(),
3777 };
3778 let back: PeerReachability =
3779 serde_json::from_value(serde_json::to_value(&with).unwrap()).unwrap();
3780 assert_eq!(back.meta, "v=1.2.3");
3781 }
3782
3783 #[test]
3784 fn presence_peer_meta_is_additive() {
3785 let old = serde_json::json!({
3786 "user_id": "b64u:A", "device_label": "laptop", "role": "primary", "online": true
3787 });
3788 let p: PresencePeer = serde_json::from_value(old).unwrap();
3789 assert_eq!(p.meta, "");
3790 assert!(serde_json::to_value(&p).unwrap().get("meta").is_none());
3791 }
3792
3793 #[test]
3794 fn set_nickname_request_carries_the_method_tag() {
3795 let r = Request::SetNickname(SetNicknameParams {
3796 nickname: "workbench".into(),
3797 });
3798 let v = serde_json::to_value(&r).unwrap();
3799 assert_eq!(v["method"], "set_nickname");
3800 assert_eq!(v["params"]["nickname"], "workbench");
3801 assert_eq!(method_of(&v), Some("set_nickname"));
3802 }
3803
3804 #[test]
3805 fn set_nickname_params_reject_unknown_field() {
3806 let err = serde_json::from_value::<SetNicknameParams>(
3807 serde_json::json!({"nickname": "x", "nonsense": 1}),
3808 );
3809 assert!(err.is_err(), "unknown params keys must be rejected");
3810 }
3811
3812 /// An OLDER daemon's status payload (no `self_nickname`) must still deserialize —
3813 /// the additive-only contract — and an empty name must not serialize at all.
3814 #[test]
3815 fn status_self_nickname_is_additive() {
3816 let old = serde_json::json!({
3817 "stack_version": "0.7.0", "services": [], "peers": []
3818 });
3819 let s: StatusResult = serde_json::from_value(old).unwrap();
3820 assert_eq!(s.self_nickname, "");
3821 let v = serde_json::to_value(&s).unwrap();
3822 assert!(v.get("self_nickname").is_none(), "empty name is skipped");
3823 }
3824
3825 #[test]
3826 fn api_minor_is_present_and_monotonic_from_hello() {
3827 // #34 part 2: a machine-comparable protocol-compat minor, distinct from the
3828 // crate/stack version, additive on the Hello frame.
3829 let h = Hello {
3830 api: API_NAME.into(),
3831 api_version: API_VERSION.into(),
3832 api_minor: API_MINOR,
3833 stack_version: "9.9.9".into(),
3834 };
3835 let v = serde_json::to_value(&h).unwrap();
3836 assert_eq!(v["api_minor"], API_MINOR);
3837 // An OLD Hello without api_minor still deserializes (additive contract).
3838 let old = serde_json::json!({
3839 "api": API_NAME, "api_version": "1.0", "stack_version": "0.4.0"
3840 });
3841 let back: Hello = serde_json::from_value(old).unwrap();
3842 assert_eq!(back.api_minor, 0, "absent api_minor defaults to 0");
3843 }
3844
3845 #[test]
3846 fn hello_result_roundtrips() {
3847 let h = Hello {
3848 api: "mcpmesh-local/1".into(),
3849 api_version: "1.0".into(),
3850 api_minor: 0,
3851 stack_version: "0.1.0".into(),
3852 };
3853 let v = serde_json::to_value(&h).unwrap();
3854 assert_eq!(v["api"], "mcpmesh-local/1");
3855 let back: Hello = serde_json::from_value(v).unwrap();
3856 assert_eq!(back, h);
3857 }
3858
3859 #[test]
3860 fn request_tagged_by_method() {
3861 let r = Request::Status;
3862 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "status");
3863 let r = Request::OpenSession(OpenSessionParams {
3864 peer: "alice".into(),
3865 service: "notes".into(),
3866 // #166: seeded NON-default so the round-trip carries it. An absent value would be
3867 // elided by `skip_serializing_if` and the assertion below would prove nothing.
3868 idle_timeout_secs: Some(7),
3869 });
3870 let v = serde_json::to_value(&r).unwrap();
3871 assert_eq!(v["method"], "open_session");
3872 assert_eq!(v["params"]["peer"], "alice");
3873 assert_eq!(v["params"]["idle_timeout_secs"], 7);
3874 // …and an absent one really is absent, so an older daemon sees the payload it always saw.
3875 let bare = serde_json::to_value(Request::OpenSession(OpenSessionParams {
3876 peer: "alice".into(),
3877 service: "notes".into(),
3878 idle_timeout_secs: None,
3879 }))
3880 .unwrap();
3881 assert!(bare["params"].get("idle_timeout_secs").is_none());
3882 }
3883
3884 #[test]
3885 fn parameterless_method_tolerates_params_forms() {
3886 // Omitted and null params deserialize straight into the unit variant.
3887 let omitted: Request =
3888 serde_json::from_value(serde_json::json!({"method": "status"})).unwrap();
3889 assert_eq!(omitted, Request::Status);
3890 let null: Request =
3891 serde_json::from_value(serde_json::json!({"method": "status", "params": null}))
3892 .unwrap();
3893 assert_eq!(null, Request::Status);
3894
3895 // Known limitation: adjacent tagging rejects `params:{}` for a unit variant, so
3896 // the server MUST dispatch on the method string rather than deserialize the whole
3897 // message into `Request`. This is the pattern the daemon's dispatcher uses.
3898 let empty = serde_json::json!({"method": "status", "params": {}});
3899 assert!(serde_json::from_value::<Request>(empty.clone()).is_err());
3900 match method_of(&empty) {
3901 Some("status") => {} // dispatcher resolves Status via the method string
3902 other => panic!("method_of failed to resolve status: {other:?}"),
3903 }
3904 }
3905
3906 #[test]
3907 fn backend_spec_roundtrips() {
3908 let run = BackendSpec::Run {
3909 cmd: vec!["notes-mcp".into(), "--stdio".into()],
3910 env: Default::default(),
3911 cwd: None,
3912 };
3913 let v = serde_json::to_value(&run).unwrap();
3914 assert_eq!(v["run"]["cmd"][0], "notes-mcp");
3915 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), run);
3916
3917 let sock = BackendSpec::Socket {
3918 path: "/run/notes.sock".into(),
3919 };
3920 let v = serde_json::to_value(&sock).unwrap();
3921 assert_eq!(v["socket"]["path"], "/run/notes.sock");
3922 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), sock);
3923 }
3924
3925 #[test]
3926 fn register_service_wire_shape() {
3927 let r = Request::RegisterService(RegisterServiceParams {
3928 name: "notes".into(),
3929 backend: BackendSpec::Run {
3930 cmd: vec!["notes-mcp".into()],
3931 env: Default::default(),
3932 cwd: None,
3933 },
3934 allow: vec!["alice".into()],
3935 ephemeral: false,
3936 rate_limit_per_min: None,
3937 });
3938 let v = serde_json::to_value(&r).unwrap();
3939 assert_eq!(
3940 v,
3941 serde_json::json!({
3942 "method": "register_service",
3943 "params": {
3944 "name": "notes",
3945 "backend": {"run": {"cmd": ["notes-mcp"]}},
3946 "allow": ["alice"],
3947 }
3948 })
3949 );
3950 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
3951 }
3952
3953 #[test]
3954 fn invite_request_and_result_roundtrip() {
3955 // Request::Invite → `{ "method": "invite", "params": { "services": [...] } }`.
3956 let r = Request::Invite(InviteParams {
3957 services: vec!["notes".into(), "kb".into()],
3958 app_label: None,
3959 max_uses: None,
3960 // #87: seeded NON-None so the round-trip actually carries it — `None` rides
3961 // `skip_serializing_if` straight past the assertion and proves nothing.
3962 peer_nickname: Some("laptop-of-alice".into()),
3963 as_self: false,
3964 });
3965 let v = serde_json::to_value(&r).unwrap();
3966 assert_eq!(v["method"], "invite");
3967 assert_eq!(
3968 v["params"]["peer_nickname"], "laptop-of-alice",
3969 "#87: the inviter's local alias for the redeemer must reach the wire"
3970 );
3971 assert_eq!(v["params"]["services"][0], "notes");
3972 assert_eq!(v["params"]["services"][1], "kb");
3973 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
3974 // method_of resolves the tag generically (no per-variant arm).
3975 assert_eq!(
3976 method_of(&serde_json::json!({"method": "invite", "params": {"services": []}})),
3977 Some("invite")
3978 );
3979
3980 // InviteResult carries the copyable line + expiry (surface #2 pairing artifact).
3981 let res = InviteResult {
3982 invite_line: "mcpmesh-invite:ABCDEF".into(),
3983 expires_at_epoch: 1_800_000_000,
3984 uses_remaining: 1,
3985 };
3986 let v = serde_json::to_value(&res).unwrap();
3987 assert_eq!(v["invite_line"], "mcpmesh-invite:ABCDEF");
3988 assert_eq!(v["expires_at_epoch"], 1_800_000_000u64);
3989 assert_eq!(serde_json::from_value::<InviteResult>(v).unwrap(), res);
3990 }
3991
3992 #[test]
3993 fn pair_request_and_result_roundtrip() {
3994 // Request::Pair → `{ "method": "pair", "params": { "invite_line": "..." } }`.
3995 let r = Request::Pair(PairParams {
3996 invite_line: "mcpmesh-invite:ABCDEF".into(),
3997 as_nickname: Some("alice-mbp".into()),
3998 allow_self_enroll: true,
3999 });
4000 let v = serde_json::to_value(&r).unwrap();
4001 assert_eq!(v["method"], "pair");
4002 assert_eq!(v["params"]["invite_line"], "mcpmesh-invite:ABCDEF");
4003 assert_eq!(
4004 v["params"]["as_nickname"], "alice-mbp",
4005 "#87: the redeemer's local alias for the inviter must reach the wire"
4006 );
4007 assert_eq!(
4008 v["params"]["allow_self_enroll"], true,
4009 "#178: the caller's consent to a self-enrollment must reach the wire — the daemon \
4010 refuses the ceremony without it"
4011 );
4012 // An OLD caller's payload — no alias — must still decode. The field is additive.
4013 let legacy: PairParams =
4014 serde_json::from_value(serde_json::json!({"invite_line": "x"})).unwrap();
4015 assert_eq!(legacy.as_nickname, None);
4016 // #178: and the consent defaults to REFUSING. A caller that predates the field, or one that
4017 // simply never set it, must not be read as having offered a device enrollment — that is the
4018 // whole guard, and a `#[serde(default)]` flipping to `true` would silently remove it.
4019 assert!(
4020 !legacy.allow_self_enroll,
4021 "an absent allow_self_enroll must default to false (refuse), never to true"
4022 );
4023 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4024 // method_of resolves the tag generically (no per-variant arm).
4025 assert_eq!(
4026 method_of(&serde_json::json!({"method": "pair", "params": {"invite_line": "x"}})),
4027 Some("pair")
4028 );
4029
4030 // PairResult carries the inviter's suggested nickname + the display-only SAS words +
4031 // the granted services (the porcelain renders each as `<peer>/<service>`).
4032 let res = PairResult {
4033 peer_nickname: "alice".into(),
4034 sas_code: "tango-fig-cabbage".into(),
4035 services: vec!["notes".into(), "kb".into()],
4036 app_label: None,
4037 peer_user_id: None,
4038 enrolled_as_self: false,
4039 };
4040 let v = serde_json::to_value(&res).unwrap();
4041 assert_eq!(v["peer_nickname"], "alice");
4042 assert_eq!(v["sas_code"], "tango-fig-cabbage");
4043 assert_eq!(v["services"][0], "notes");
4044 assert_eq!(v["services"][1], "kb");
4045 assert_eq!(serde_json::from_value::<PairResult>(v).unwrap(), res);
4046
4047 // Additive-only: a PairResult minted by an older daemon (no `services` key) still
4048 // deserializes — the `#[serde(default)]` fills it with an empty list.
4049 let old_shape = serde_json::json!({
4050 "peer_nickname": "alice",
4051 "sas_code": "tango-fig-cabbage",
4052 });
4053 let back: PairResult = serde_json::from_value(old_shape).unwrap();
4054 assert_eq!(back.peer_nickname, "alice");
4055 assert!(back.services.is_empty());
4056 }
4057
4058 #[test]
4059 fn roster_install_request_and_result_roundtrip() {
4060 // Request::RosterInstall → `{ "method": "roster_install", "params": { "path": ...,
4061 // "org_root_pk": ... } }`. The optional pk is present on the first-install shape.
4062 let r = Request::RosterInstall(RosterInstallParams {
4063 path: "/tmp/roster.json".into(),
4064 org_root_pk: Some("b64u:AAAA".into()),
4065 });
4066 let v = serde_json::to_value(&r).unwrap();
4067 assert_eq!(v["method"], "roster_install");
4068 assert_eq!(v["params"]["path"], "/tmp/roster.json");
4069 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
4070 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4071 // method_of resolves the tag generically (no per-variant arm).
4072 assert_eq!(
4073 method_of(&serde_json::json!({"method": "roster_install", "params": {"path": "/x"}})),
4074 Some("roster_install")
4075 );
4076
4077 // When the pk is omitted (a subsequent install using the pinned value), it is
4078 // `skip_serializing_if`-dropped from the wire and deserializes back to `None`.
4079 let omit = Request::RosterInstall(RosterInstallParams {
4080 path: "/tmp/roster.json".into(),
4081 org_root_pk: None,
4082 });
4083 let v = serde_json::to_value(&omit).unwrap();
4084 assert!(
4085 v["params"].get("org_root_pk").is_none(),
4086 "an omitted org_root_pk must not appear on the wire: {v}"
4087 );
4088 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), omit);
4089
4090 // RosterInstallResult carries org_id + serial + severed count (roster-status vocabulary).
4091 let res = RosterInstallResult {
4092 org_id: "acme".into(),
4093 serial: 42,
4094 severed: 1,
4095 };
4096 let v = serde_json::to_value(&res).unwrap();
4097 assert_eq!(v["org_id"], "acme");
4098 assert_eq!(v["serial"], 42u64);
4099 assert_eq!(v["severed"], 1u32);
4100 assert_eq!(
4101 serde_json::from_value::<RosterInstallResult>(v).unwrap(),
4102 res
4103 );
4104
4105 // Additive-only: a result minted by an older daemon (no `severed` key) still
4106 // deserializes — the `#[serde(default)]` fills it with 0.
4107 let old_shape = serde_json::json!({ "org_id": "acme", "serial": 7 });
4108 let back: RosterInstallResult = serde_json::from_value(old_shape).unwrap();
4109 assert_eq!(back.serial, 7);
4110 assert_eq!(back.severed, 0);
4111 }
4112
4113 #[test]
4114 fn org_join_request_and_result_roundtrip() {
4115 // Request::OrgJoin → `{ "method": "org_join", "params": { org_id, org_root_pk, user_id,
4116 // user_key } }`. `user_key` is a LOCAL path string (the key never crosses the API).
4117 let r = Request::OrgJoin(OrgJoinParams {
4118 org_id: "acme".into(),
4119 org_root_pk: "b64u:AAAA".into(),
4120 user_id: "alice".into(),
4121 user_key: "/home/alice/.config/mcpmesh/user.key".into(),
4122 });
4123 let v = serde_json::to_value(&r).unwrap();
4124 assert_eq!(v["method"], "org_join");
4125 assert_eq!(v["params"]["org_id"], "acme");
4126 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
4127 assert_eq!(v["params"]["user_id"], "alice");
4128 assert_eq!(
4129 v["params"]["user_key"],
4130 "/home/alice/.config/mcpmesh/user.key"
4131 );
4132 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4133 // method_of resolves the tag generically (no per-variant arm).
4134 assert_eq!(
4135 method_of(&serde_json::json!({"method": "org_join", "params": {"org_id": "x"}})),
4136 Some("org_join")
4137 );
4138
4139 // OrgJoinResult echoes the pinned org id (surface-clean; the fingerprint is porcelain-side).
4140 let res = OrgJoinResult {
4141 org_id: "acme".into(),
4142 restart_required: true,
4143 };
4144 let v = serde_json::to_value(&res).unwrap();
4145 assert_eq!(v["org_id"], "acme");
4146 assert_eq!(
4147 v["restart_required"], true,
4148 "#93: a half-live join must reach the wire — the caller cannot detect it any other way"
4149 );
4150 // Additive: an older daemon omits it, and absent reads as `false` — which was that
4151 // daemon's implicit answer. Pinned so the default cannot silently flip to `true` and start
4152 // telling every caller to restart.
4153 let legacy: OrgJoinResult =
4154 serde_json::from_value(serde_json::json!({"org_id": "acme"})).unwrap();
4155 assert!(!legacy.restart_required);
4156 // …and the false case must not bloat the payload.
4157 let quiet = serde_json::to_value(OrgJoinResult {
4158 org_id: "acme".into(),
4159 restart_required: false,
4160 })
4161 .unwrap();
4162 assert!(quiet.get("restart_required").is_none());
4163 assert_eq!(serde_json::from_value::<OrgJoinResult>(v).unwrap(), res);
4164 }
4165
4166 #[test]
4167 fn set_roster_url_request_roundtrip() {
4168 // Request::SetRosterUrl → `{ "method": "set_roster_url", "params": { "url": "..." } }`.
4169 let r = Request::SetRosterUrl(SetRosterUrlParams {
4170 url: "https://intranet.acme.com/roster.json".into(),
4171 });
4172 let v = serde_json::to_value(&r).unwrap();
4173 assert_eq!(v["method"], "set_roster_url");
4174 assert_eq!(v["params"]["url"], "https://intranet.acme.com/roster.json");
4175 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4176 assert_eq!(
4177 method_of(&serde_json::json!({"method": "set_roster_url", "params": {"url": "x"}})),
4178 Some("set_roster_url")
4179 );
4180 }
4181
4182 #[test]
4183 fn peer_remove_request_roundtrip() {
4184 // Request::PeerRemove → `{ "method": "peer_remove", "params": { "nickname": "..." } }`.
4185 let r = Request::PeerRemove(PeerRemoveParams {
4186 nickname: "bob".into(),
4187 });
4188 let v = serde_json::to_value(&r).unwrap();
4189 assert_eq!(v["method"], "peer_remove");
4190 assert_eq!(v["params"]["nickname"], "bob");
4191 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4192 // method_of resolves the tag generically (no per-variant arm).
4193 assert_eq!(
4194 method_of(&serde_json::json!({"method": "peer_remove", "params": {"nickname": "bob"}})),
4195 Some("peer_remove")
4196 );
4197 }
4198
4199 /// The reserved/internal `peer_add` rides the SAME typed vocabulary as every other method —
4200 /// `{ "method": "peer_add", "params": { nickname, endpoint_id, allow } }` — with `allow`
4201 /// defaulting to empty when absent.
4202 /// #65: the wire tags for the introduction pair. The serde tag must equal the dispatch string
4203 /// the daemon matches on — nothing else checks that they agree.
4204 #[test]
4205 fn peer_introduce_and_endorse_roundtrip() {
4206 let r = Request::PeerIntroduce(PeerIntroduceParams {
4207 subject: "eid:aa".into(),
4208 endorsed_by: "b64u:carol".into(),
4209 evidence: "b64u:sig".into(),
4210 subject_user_id: Some("b64u:bob".into()),
4211 subject_binding: Some("b64u:bind".into()),
4212 nickname: "bob".into(),
4213 });
4214 let v = serde_json::to_value(&r).unwrap();
4215 assert_eq!(
4216 v["method"], "peer_introduce",
4217 "the tag must match the daemon's dispatch string exactly"
4218 );
4219 assert_eq!(v["params"]["subject"], "eid:aa");
4220 assert_eq!(v["params"]["subject_binding"], "b64u:bind");
4221 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4222
4223 // The two proof fields are OPTIONAL on the wire and omitted when absent.
4224 let minimal = Request::PeerIntroduce(PeerIntroduceParams {
4225 subject: "eid:aa".into(),
4226 endorsed_by: "b64u:carol".into(),
4227 evidence: "b64u:sig".into(),
4228 subject_user_id: None,
4229 subject_binding: None,
4230 nickname: "bob".into(),
4231 });
4232 let v = serde_json::to_value(&minimal).unwrap();
4233 assert!(v["params"].get("subject_user_id").is_none());
4234 assert!(v["params"].get("subject_binding").is_none());
4235 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), minimal);
4236
4237 let e = Request::PeerEndorse(PeerEndorseParams {
4238 subject: "eid:aa".into(),
4239 subject_user_id: None,
4240 });
4241 let v = serde_json::to_value(&e).unwrap();
4242 assert_eq!(v["method"], "peer_endorse");
4243 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), e);
4244
4245 let res = PeerEndorseResult {
4246 endorsed_by: "b64u:me".into(),
4247 evidence: "b64u:sig".into(),
4248 };
4249 let v = serde_json::to_value(&res).unwrap();
4250 assert_eq!(v["endorsed_by"], "b64u:me");
4251 assert_eq!(serde_json::from_value::<PeerEndorseResult>(v).unwrap(), res);
4252 }
4253
4254 #[test]
4255 fn peer_add_request_roundtrip() {
4256 let r = Request::PeerAdd(PeerAddParams {
4257 nickname: "bob".into(),
4258 endpoint_id: "96246d3f".into(),
4259 allow: vec!["notes".into()],
4260 });
4261 let v = serde_json::to_value(&r).unwrap();
4262 assert_eq!(v["method"], "peer_add");
4263 assert_eq!(v["params"]["nickname"], "bob");
4264 assert_eq!(v["params"]["endpoint_id"], "96246d3f");
4265 assert_eq!(v["params"]["allow"][0], "notes");
4266 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4267 // An absent allow list deserializes to empty (the server-side tolerance).
4268 let p: PeerAddParams =
4269 serde_json::from_value(serde_json::json!({"nickname": "bob", "endpoint_id": "x"}))
4270 .unwrap();
4271 assert!(p.allow.is_empty());
4272 }
4273
4274 #[test]
4275 fn peer_rename_request_roundtrip() {
4276 // By user_id (renames all of a person's devices in one op).
4277 let r = Request::PeerRename(PeerRenameParams {
4278 user_id: Some("b64u:BOB".into()),
4279 nickname: None,
4280 to: "Bobby".into(),
4281 });
4282 let v = serde_json::to_value(&r).unwrap();
4283 assert_eq!(v["method"], "peer_rename");
4284 assert_eq!(v["params"]["user_id"], "b64u:BOB");
4285 assert_eq!(v["params"]["to"], "Bobby");
4286 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4287 // A provisional contact is renamed by nickname; omitted user_id defaults to None.
4288 assert_eq!(
4289 method_of(
4290 &serde_json::json!({"method": "peer_rename", "params": {"nickname": "carol", "to": "Carol"}})
4291 ),
4292 Some("peer_rename")
4293 );
4294 }
4295
4296 #[test]
4297 fn status_result_roundtrips() {
4298 // Pure-pairing daemon: `roster` is None — absent from the wire (skip_serializing_if) and an
4299 // older payload with no `roster` key still deserializes to None (serde default).
4300 let s = StatusResult {
4301 stack_version: "0.1.0".into(),
4302 services: vec![ServiceInfo {
4303 name: "notes".into(),
4304 allow: vec!["alice".into()],
4305 allow_display: vec![],
4306 backend: BackendKind::Run,
4307 ephemeral: false,
4308 }],
4309 peers: vec![PeerInfo {
4310 name: "alice".into(),
4311 services: vec!["notes".into()],
4312 // A paired peer that proved a self-sovereign user_id at pairing (surface-clean id).
4313 user_id: Some("b64u:alicepk".into()),
4314 principal: None,
4315 }],
4316 roster: None,
4317 presence: vec![],
4318 self_user_id: Some("b64u:selfpk".into()),
4319 recent_pairings: vec![],
4320 reachability: vec![],
4321 self_nickname: String::new(),
4322 storage: None,
4323 revoked: Vec::new(),
4324 self_network: None,
4325 };
4326 let v = serde_json::to_value(&s).unwrap();
4327 assert_eq!(v["services"][0]["backend"], "run");
4328 // The additive identity fields ride the wire when present.
4329 assert_eq!(v["peers"][0]["user_id"], "b64u:alicepk");
4330 assert_eq!(v["self_user_id"], "b64u:selfpk");
4331 assert!(
4332 v.get("roster").is_none(),
4333 "an absent roster must not appear on the wire: {v}"
4334 );
4335 assert!(
4336 v.get("presence").is_none(),
4337 "an empty presence must not appear on the wire: {v}"
4338 );
4339 assert!(
4340 v.get("recent_pairings").is_none(),
4341 "an empty recent_pairings must not appear on the wire: {v}"
4342 );
4343 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4344
4345 // A payload minted by an older daemon (no `roster`/`presence`/identity keys) still
4346 // deserializes — the identity fields default to None / a nickname-only peer.
4347 let old_shape = serde_json::json!({
4348 "stack_version": "0.1.0",
4349 "services": [],
4350 "peers": [{ "name": "bob", "services": [] }],
4351 });
4352 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
4353 assert!(back.roster.is_none());
4354 assert!(back.presence.is_empty());
4355 assert!(back.self_user_id.is_none());
4356 assert!(back.peers[0].user_id.is_none());
4357 assert!(back.recent_pairings.is_empty());
4358
4359 // Roster daemon: a Some(RosterStatus) + an advisory presence list round-trip. `presence`
4360 // carries FLAT vocabulary only (user_id/device_label/role/online) — no EndpointId/key.
4361 let s = StatusResult {
4362 stack_version: "0.1.0".into(),
4363 services: vec![],
4364 peers: vec![],
4365 roster: Some(RosterStatus {
4366 org_id: "acme".into(),
4367 serial: 42,
4368 state: "approved".into(),
4369 org_root_fingerprint: "tango-fig-cabbage-anchor".into(),
4370 groups: vec!["eng".into(), "ops".into()],
4371 }),
4372 presence: vec![
4373 PresencePeer {
4374 user_id: "alice".into(),
4375 display_name: "Alice Example".into(),
4376 groups: vec!["eng".into()],
4377 device_label: "laptop".into(),
4378 role: "primary".into(),
4379 online: true,
4380 meta: String::new(),
4381 },
4382 PresencePeer {
4383 user_id: "alice".into(),
4384 display_name: "Alice Example".into(),
4385 groups: vec!["eng".into()],
4386 device_label: "desktop".into(),
4387 role: "mirror".into(),
4388 online: false,
4389 meta: String::new(),
4390 },
4391 ],
4392 self_user_id: None,
4393 recent_pairings: vec![],
4394 reachability: vec![],
4395 self_nickname: String::new(),
4396 storage: None,
4397 revoked: Vec::new(),
4398 self_network: None,
4399 };
4400 let v = serde_json::to_value(&s).unwrap();
4401 assert_eq!(v["roster"]["org_id"], "acme");
4402 assert_eq!(v["roster"]["serial"], 42u64);
4403 assert_eq!(v["roster"]["state"], "approved");
4404 assert_eq!(
4405 v["roster"]["org_root_fingerprint"],
4406 "tango-fig-cabbage-anchor"
4407 );
4408 assert_eq!(v["presence"][0]["user_id"], "alice");
4409 assert_eq!(v["presence"][0]["device_label"], "laptop");
4410 assert_eq!(v["presence"][0]["role"], "primary");
4411 assert_eq!(v["presence"][0]["online"], true);
4412 assert_eq!(v["presence"][1]["online"], false);
4413 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4414 }
4415
4416 /// The `recent_pairings` status field is ADDITIVE: a populated list round-trips with
4417 /// the flat `{peer_nickname, sas_code, paired_at_epoch}` shape (nickname + SAS words + epoch —
4418 /// never an EndpointId), an empty list is dropped from the wire, and a payload minted by an
4419 /// older daemon (no key at all) still deserializes to empty.
4420 #[test]
4421 fn recent_pairings_are_additive_on_status() {
4422 let s = StatusResult {
4423 stack_version: "0.1.0".into(),
4424 services: vec![],
4425 peers: vec![],
4426 roster: None,
4427 presence: vec![],
4428 self_user_id: None,
4429 recent_pairings: vec![RecentPairing {
4430 peer_nickname: "bob".into(),
4431 sas_code: "tango-fig-cabbage".into(),
4432 paired_at_epoch: 1_800_000_000,
4433 }],
4434 reachability: vec![],
4435 self_nickname: String::new(),
4436 storage: None,
4437 revoked: Vec::new(),
4438 self_network: None,
4439 };
4440 let v = serde_json::to_value(&s).unwrap();
4441 assert_eq!(v["recent_pairings"][0]["peer_nickname"], "bob");
4442 assert_eq!(v["recent_pairings"][0]["sas_code"], "tango-fig-cabbage");
4443 assert_eq!(v["recent_pairings"][0]["paired_at_epoch"], 1_800_000_000u64);
4444 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
4445
4446 // A payload minted by an OLDER daemon (no `recent_pairings` key) still deserializes —
4447 // the `#[serde(default)]` fills it with an empty list.
4448 let old_shape = serde_json::json!({
4449 "stack_version": "0.1.0",
4450 "services": [],
4451 "peers": [],
4452 });
4453 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
4454 assert!(back.recent_pairings.is_empty());
4455 }
4456
4457 #[test]
4458 fn blob_requests_and_results_roundtrip() {
4459 // BlobPublish → { method, params: { scope, path } }.
4460 let r = Request::BlobPublish(BlobPublishParams {
4461 scope: "docs".into(),
4462 path: "/tmp/a.bin".into(),
4463 });
4464 let v = serde_json::to_value(&r).unwrap();
4465 assert_eq!(v["method"], "blob_publish");
4466 assert_eq!(v["params"]["scope"], "docs");
4467 assert_eq!(v["params"]["path"], "/tmp/a.bin");
4468 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4469
4470 // BlobGrant → { method, params: { scope, principal } }.
4471 // #62: the two withdrawal verbs' wire tags. A wrong dispatch string or a swapped param
4472 // would otherwise ship undetected — the e2e test calls the provider directly and never
4473 // crosses JSON-RPC.
4474 let rev = Request::BlobRevoke(BlobRevokeParams {
4475 scope: "photos".into(),
4476 principals: vec!["alice".into()],
4477 });
4478 let v = serde_json::to_value(&rev).unwrap();
4479 assert_eq!(v["method"], "blob_revoke");
4480 assert_eq!(v["params"]["principals"][0], "alice");
4481 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), rev);
4482
4483 let unp = Request::BlobUnpublish(BlobUnpublishParams {
4484 scope: "photos".into(),
4485 hash: "abc123".into(),
4486 });
4487 let v = serde_json::to_value(&unp).unwrap();
4488 assert_eq!(v["method"], "blob_unpublish");
4489 assert_eq!(v["params"]["hash"], "abc123");
4490 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), unp);
4491
4492 let r = Request::BlobGrant(BlobGrantParams {
4493 scope: "docs".into(),
4494 principal: "alice".into(),
4495 });
4496 let v = serde_json::to_value(&r).unwrap();
4497 assert_eq!(v["method"], "blob_grant");
4498 assert_eq!(v["params"]["principal"], "alice");
4499 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4500
4501 // BlobList is parameterless (method_of resolves it).
4502 assert_eq!(
4503 method_of(&serde_json::json!({"method": "blob_list"})),
4504 Some("blob_list")
4505 );
4506
4507 // BlobFetch → { method, params: { ticket, dest_path, from? } }.
4508 let r = Request::BlobFetch(BlobFetchParams {
4509 ticket: "blobAAA".into(),
4510 dest_path: "/tmp/out.bin".into(),
4511 from: vec!["eid:aa".into(), "b64u:bb".into()],
4512 });
4513 let v = serde_json::to_value(&r).unwrap();
4514 assert_eq!(v["method"], "blob_fetch");
4515 assert_eq!(v["params"]["ticket"], "blobAAA");
4516 assert_eq!(v["params"]["dest_path"], "/tmp/out.bin");
4517 assert_eq!(
4518 v["params"]["from"][0], "eid:aa",
4519 "#83: the alternate sources must reach the wire IN ORDER — the publisher is tried \
4520 first and these follow, so a reordering changes which source answers"
4521 );
4522 assert_eq!(v["params"]["from"][1], "b64u:bb");
4523 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
4524 // Additive: an older caller omits it, and absent reads as EMPTY — the single-source
4525 // behaviour. A default that invented sources would dial peers the caller never named.
4526 let legacy: BlobFetchParams =
4527 serde_json::from_value(serde_json::json!({"ticket": "x", "dest_path": "/tmp/y"}))
4528 .unwrap();
4529 assert!(legacy.from.is_empty());
4530 // …and an empty list must not bloat the payload.
4531 let quiet = serde_json::to_value(Request::BlobFetch(BlobFetchParams {
4532 ticket: "x".into(),
4533 dest_path: "/tmp/y".into(),
4534 from: vec![],
4535 }))
4536 .unwrap();
4537 assert!(quiet["params"].get("from").is_none());
4538
4539 // BlobPublishResult carries the ticket + hash (blob-reference vocabulary).
4540 let res = BlobPublishResult {
4541 ticket: "blobAAA".into(),
4542 hash: "ab".repeat(32),
4543 };
4544 let v = serde_json::to_value(&res).unwrap();
4545 assert_eq!(v["ticket"], "blobAAA");
4546 assert_eq!(serde_json::from_value::<BlobPublishResult>(v).unwrap(), res);
4547
4548 // BlobScopeList carries flat (name, hashes, grants) — no EndpointId/key leakage.
4549 let res = BlobScopeList {
4550 scopes: vec![ScopeInfo {
4551 name: "docs".into(),
4552 hashes: vec!["ab".repeat(32)],
4553 grants: vec!["alice".into()],
4554 withdrawn: vec![],
4555 hash_count: 1,
4556 grant_count: 1,
4557 withdrawn_count: 0,
4558 }],
4559 total: 1,
4560 truncated: false,
4561 };
4562 let v = serde_json::to_value(&res).unwrap();
4563 assert_eq!(v["scopes"][0]["name"], "docs");
4564 assert_eq!(v["scopes"][0]["grants"][0], "alice");
4565 assert_eq!(serde_json::from_value::<BlobScopeList>(v).unwrap(), res);
4566
4567 // BlobFetchResult carries the verified hash + byte length.
4568 let res = BlobFetchResult {
4569 hash: "ab".repeat(32),
4570 bytes_len: 4194304,
4571 };
4572 let v = serde_json::to_value(&res).unwrap();
4573 assert_eq!(v["bytes_len"], 4194304u64);
4574 assert_eq!(serde_json::from_value::<BlobFetchResult>(v).unwrap(), res);
4575 }
4576
4577 /// The three `subscribe` frame shapes round-trip with the documented `type`-tagged wire form
4578 /// (docs/local-protocol.md "Live event stream"): `snapshot` carries the flat session/reachability
4579 /// lists, `event` delegates through the `Box` so the record's fields sit VERBATIM under
4580 /// `record` (one schema with the JSONL log), and `lagged` carries the dropped count.
4581 #[test]
4582 fn stream_frames_roundtrip_with_the_documented_tags() {
4583 let snap = StreamFrame::Snapshot {
4584 self_network: None,
4585 active_sessions: vec![ActiveSession {
4586 peer: "bob".into(),
4587 service: "notes".into(),
4588 opened_at: 1_751_760_000,
4589 principal: None,
4590 }],
4591 reachability: vec![PeerReachability {
4592 name: "bob".into(),
4593 reachable: true,
4594 rtt_ms: Some(42),
4595 age_secs: Some(3),
4596 meta: String::new(),
4597 principal: None,
4598 path: Default::default(),
4599 }],
4600 };
4601 let v = serde_json::to_value(&snap).unwrap();
4602 assert_eq!(v["type"], "snapshot");
4603 assert_eq!(v["active_sessions"][0]["peer"], "bob");
4604 assert_eq!(v["active_sessions"][0]["opened_at"], 1_751_760_000i64);
4605 assert_eq!(v["reachability"][0]["name"], "bob");
4606 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), snap);
4607
4608 let event = StreamFrame::Event {
4609 record: Box::new(AuditRecord::session_open(
4610 "2026-07-03T14:02:11.480Z".into(),
4611 Some("bob".into()),
4612 "notes".into(),
4613 None,
4614 )),
4615 };
4616 let v = serde_json::to_value(&event).unwrap();
4617 assert_eq!(v["type"], "event");
4618 // The record's fields ride verbatim under `record` — no Box indirection on the wire.
4619 assert_eq!(v["record"]["kind"], "session_open");
4620 assert_eq!(v["record"]["peer"], "bob");
4621 assert_eq!(v["record"]["service"], "notes");
4622 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), event);
4623
4624 // #167 ask 2: the resume frame's wire shape. A consumer dispatches on `type`, so the tag
4625 // is part of the contract, and `at_epoch` is signed on purpose — the wire carries epoch
4626 // seconds as i64 everywhere else in this file.
4627 let resumed = StreamFrame::Resumed {
4628 suspended_secs: 7200,
4629 at_epoch: 1_700_007_202,
4630 };
4631 let v = serde_json::to_value(&resumed).unwrap();
4632 assert_eq!(
4633 v,
4634 serde_json::json!({
4635 "type": "resumed",
4636 "suspended_secs": 7200,
4637 "at_epoch": 1_700_007_202i64,
4638 })
4639 );
4640 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), resumed);
4641
4642 let lagged = StreamFrame::Lagged { dropped: 12 };
4643 let v = serde_json::to_value(&lagged).unwrap();
4644 assert_eq!(v, serde_json::json!({ "type": "lagged", "dropped": 12 }));
4645 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), lagged);
4646 }
4647
4648 /// A frame minted by a NEWER daemon (an unknown `type`) fails to deserialize rather than
4649 /// mis-parsing — the typed stream surface is closed; a forward-compatible consumer reads the
4650 /// raw `Value` stream instead (`ControlClient::open_stream`).
4651 #[test]
4652 fn unknown_stream_frame_type_is_rejected() {
4653 let future = serde_json::json!({ "type": "future_kind", "x": 1 });
4654 assert!(serde_json::from_value::<StreamFrame>(future).is_err());
4655 }
4656
4657 #[test]
4658 fn audit_summary_request_and_result_roundtrip() {
4659 // Request::AuditSummary is parameterless → `{ "method": "audit_summary" }`. Like Status, it
4660 // tolerates omitted/null params; the server dispatches on the method string (method_of).
4661 let r = Request::AuditSummary;
4662 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "audit_summary");
4663 assert_eq!(
4664 method_of(&serde_json::json!({"method": "audit_summary"})),
4665 Some("audit_summary")
4666 );
4667
4668 // AuditSummaryResult carries LOCAL per-peer / per-service session counts (nicknames + service
4669 // names only — never endpoints/transport terms) + a total. Tuples mirror kb's
4670 // InsightResponse.per_peer_contribution: `["bob", 2]` on the wire.
4671 let res = AuditSummaryResult {
4672 per_peer: vec![("alice".into(), 1), ("bob".into(), 2)],
4673 per_service: vec![("kb".into(), 1), ("notes".into(), 3)],
4674 total_sessions: 4,
4675 };
4676 let v = serde_json::to_value(&res).unwrap();
4677 assert_eq!(v["per_peer"][1][0], "bob");
4678 assert_eq!(v["per_peer"][1][1], 2u64);
4679 assert_eq!(v["per_service"][1][0], "notes");
4680 assert_eq!(v["total_sessions"], 4u64);
4681 assert_eq!(
4682 serde_json::from_value::<AuditSummaryResult>(v).unwrap(),
4683 res
4684 );
4685
4686 // Additive-only: a result minted by an older daemon (no `total_sessions` key) still
4687 // deserializes — the `#[serde(default)]` fills it with 0.
4688 let old_shape = serde_json::json!({ "per_peer": [], "per_service": [] });
4689 let back: AuditSummaryResult = serde_json::from_value(old_shape).unwrap();
4690 assert_eq!(back.total_sessions, 0);
4691 assert!(back.per_peer.is_empty());
4692 }
4693}