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