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