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#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
35#[serde(rename_all = "snake_case")]
36pub enum BackendKind {
37 Run,
38 Socket,
39}
40
41/// A registered service as reported by `status` (no transport vocabulary).
42#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
43pub struct ServiceInfo {
44 pub name: String,
45 pub allow: Vec<String>, // STABLE principals (b64u:/eid:) or roster names (#38) — never nicknames
46 /// The HUMAN rendering of `allow`, index-aligned: each principal resolved to its peer's
47 /// display nickname by the daemon (which owns the store); an unresolvable stable
48 /// principal renders as a neutral placeholder — porcelain must show THESE, never raw
49 /// ids (surface discipline). Additive: default + skip-if-empty.
50 #[serde(default, skip_serializing_if = "Vec::is_empty")]
51 pub allow_display: Vec<String>,
52 pub backend: BackendKind, // "run" | "socket" (kind only, never the command/path)
53 /// True if this registration is ephemeral (#36): in-memory only, tied to the registering
54 /// control connection's lifetime, absent from config, gone on restart. Additive — an older
55 /// daemon omits it and it reads as `false` (the persistent default).
56 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
57 pub ephemeral: bool,
58}
59
60/// A known peer as reported by `status` (nickname only — never the EndpointId).
61#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
62pub struct PeerInfo {
63 pub name: String,
64 pub services: Vec<String>,
65 /// The peer's PROVEN self-sovereign `user_id` (`b64u:<user_pk>`) if it presented a verified
66 /// device->user binding at pairing (roster peers carry it too), else `None` (nickname-only). This
67 /// is a surface-clean identity (an opaque user id, NOT an EndpointId). Additive:
68 /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so older payloads round-trip.
69 #[serde(default, skip_serializing_if = "Option::is_none")]
70 pub user_id: Option<String>,
71 /// The peer's stable DEVICE principal `eid:<hex>` (#41) — the SAME rendering the socket
72 /// backend injects into `_meta["mcpmesh/peer"]` and that appears in `[services.*].allow`.
73 /// Always present for a real peer (`Option` only for additive round-trip). Distinct from
74 /// `user_id` (the person-level `b64u:`, present only when the peer proved a binding): a
75 /// nickname is not unique, so an embedder keys caller-scoped decisions (dial the caller
76 /// back, "the requester's own data") on THIS, the authenticated endpoint. Machine-surface
77 /// authz vocabulary (like the allow lists) — human porcelain still shows the nickname.
78 /// Additive: `#[serde(default, skip_serializing_if = "Option::is_none")]`.
79 #[serde(default, skip_serializing_if = "Option::is_none")]
80 pub principal: Option<String>,
81}
82
83/// HOW a peer is reached (#64): a direct/hole-punched QUIC path, or through a relay.
84///
85/// `rtt_ms` is NOT a proxy for this — a fast relay beats a slow direct path — and iroh's own
86/// distinction was being dropped at the mcpmesh boundary. Three things depend on it: a truthful
87/// locality claim ("this traffic never left the building"), honest disclosure that a relayed path
88/// depends on third-party infrastructure, and diagnostics, since "slow" has a different cause and
89/// fix in each case.
90///
91/// **Only `Direct` supports a locality claim.** `Unknown` means "we do not know", NOT "private" —
92/// rendering it as private is the one misuse that turns this field into a false privacy statement.
93/// The daemon errs the same way: when a relay path is active it reports [`Relay`](Self::Relay) even
94/// if a direct path is live too, because overstating privacy is worse than understating it.
95///
96/// `#[non_exhaustive]`: iroh already has a third address kind (a custom transport) that could
97/// warrant a variant, and adding one to a public enum later breaks every downstream exhaustive
98/// `match` — the lesson #58 paid for.
99#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
100#[serde(tag = "kind", rename_all = "snake_case")]
101#[non_exhaustive]
102pub enum PeerPath {
103 /// A direct or hole-punched QUIC path: the bytes did not transit a relay.
104 Direct,
105 /// Through a relay server. `url` is the relay in use when known.
106 Relay {
107 #[serde(default, skip_serializing_if = "Option::is_none")]
108 url: Option<String>,
109 },
110 /// Not known: never probed, no selected path, or a transport mcpmesh does not model.
111 ///
112 /// `#[serde(other)]` makes this the landing spot for a `kind` a client has never heard of. That
113 /// is what actually buys wire-additivity: `#[non_exhaustive]` only protects the Rust `match`,
114 /// and without this an older client hits `unknown variant` and fails to deserialize the WHOLE
115 /// `PeerReachability` — one new path kind would break every `status` response it reads.
116 #[default]
117 #[serde(other)]
118 Unknown,
119}
120
121/// Advisory reachability of a paired peer (pairing-mode liveness). Surface-clean: a nickname, a
122/// bool, latency/age NUMBERS, the stable `eid:` principal (#42), and since #64 the PATH KIND —
123/// direct vs relay, plus the relay URL when relayed. Never a socket address, an IP, or a key: the
124/// path field says WHICH KIND of route is in use, never where the peer is.
125#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
126pub struct PeerReachability {
127 pub name: String, // the peer's nickname
128 pub reachable: bool, // result of the last probe (false if never probed)
129 #[serde(default, skip_serializing_if = "Option::is_none")]
130 pub rtt_ms: Option<u64>, // last measured round-trip, if reachable
131 #[serde(default, skip_serializing_if = "Option::is_none")]
132 pub age_secs: Option<u64>, // None = never probed (consumer shows "checking…")
133 /// The peer's OPTIONAL app metadata (#40) — the same opaque ≤256B blob #39 exposes via
134 /// presence, here carried on the pairing-mode `mcpmesh/ping/1` probe pong so PAIRED peers
135 /// (which have no presence gossip) see it too. Empty when the peer set none. Advisory
136 /// display data; never an authz input. Near-real-time when `status` is read (the probe
137 /// cache has a ~20s TTL), not a steady push. Additive: default + skip-if-empty.
138 #[serde(default, skip_serializing_if = "String::is_empty")]
139 pub meta: String,
140 /// The peer's stable DEVICE principal `eid:<hex>` (#42) — the SAME rendering as
141 /// [`PeerInfo::principal`], so an embedder joins probe result + `meta` (app version) to a
142 /// peer by the AUTHENTICATED endpoint rather than the non-unique nickname. Always present
143 /// for a real row (`Option` only for additive round-trip). Machine-surface authz
144 /// vocabulary — the human `status` reachability line is unchanged. Additive:
145 /// `#[serde(default, skip_serializing_if = "Option::is_none")]`.
146 #[serde(default, skip_serializing_if = "Option::is_none")]
147 pub principal: Option<String>,
148 /// HOW this peer is reached (#64) — see [`PeerPath`]. Captured by the same probe that sets
149 /// `reachable`/`rtt_ms`, so it shares their freshness: one TTL, one `age_secs`. `Unknown` for a
150 /// peer never probed. Additive (`#[serde(default)]`), so older rows and clients are unaffected.
151 #[serde(default)]
152 pub path: PeerPath,
153}
154
155/// Roster-mode status. Surface-clean roster VOCABULARY only: org_id, serial, a plain
156/// state word, and the pinned org-root FINGERPRINT in short words — never raw keys/EndpointIds/serials-
157/// as-transport-vocab. Absent in a pure-pairing daemon.
158#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
159pub struct RosterStatus {
160 pub org_id: String,
161 pub serial: u64,
162 pub state: String, // "pending" | "approved" | "degraded" | "stopped"
163 pub org_root_fingerprint: String, // short-word form
164}
165
166/// One reachable roster peer device as reported by `status` (the advisory presence read).
167/// ADVISORY — this is a display convenience, never an authorization surface. Surface-clean:
168/// FLAT vocabulary ONLY — a `user_id`, a human `device_label`, its `role` word, and an `online`
169/// boolean. It carries NO EndpointId / pubkey / hash / ALPN or any transport vocabulary.
170#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
171pub struct PresencePeer {
172 pub user_id: String,
173 pub device_label: String,
174 pub role: String, // "primary" | "mirror" (roster vocabulary)
175 /// Whether the device has a live presence heartbeat (advisory — absence never blocks a dial).
176 pub online: bool,
177 /// The device's OPTIONAL embedder-set app metadata (#39) — an opaque ≤256B blob carried
178 /// (signed) on its presence heartbeat, empty when the device set none. Advisory display
179 /// data; never an authz input. Additive: default + skip-if-empty.
180 #[serde(default, skip_serializing_if = "String::is_empty")]
181 pub meta: String,
182}
183
184/// One recently completed INVITER-side pairing, surfaced by `status` so the inviter's human can
185/// read the short authentication code (SAS) and compare it with the redeemer's out-of-band —
186/// the pairing ceremony is "both humans compare the code": the redeemer sees it in its
187/// [`PairResult`]; this is the inviter's porcelain surface for the same words. DISPLAY-ONLY
188/// ceremony state: held in-memory by the daemon (a small ring), lost on restart, NEVER an
189/// authorization input or trust data. Surface-clean: a nickname + the SAS wordlist words +
190/// an epoch — never an EndpointId.
191#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
192pub struct RecentPairing {
193 /// The peer's nickname as stored by the inviter (its local name for the redeemer).
194 pub peer_nickname: String,
195 /// The display-only SAS words (e.g. `"tango-fig-cabbage"`) — the same code the redeemer's
196 /// `PairResult.sas_code` carried. Never checked programmatically.
197 pub sas_code: String,
198 /// When the pairing completed (epoch seconds) — the porcelain renders a friendly age.
199 pub paired_at_epoch: u64,
200}
201
202#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
203pub struct StatusResult {
204 pub stack_version: String,
205 pub services: Vec<ServiceInfo>,
206 pub peers: Vec<PeerInfo>,
207 /// Roster-mode status, absent in a pure-pairing daemon. Additive:
208 /// `#[serde(default, skip_serializing_if = ...)]` so a daemon/client without it round-trips.
209 #[serde(default, skip_serializing_if = "Option::is_none")]
210 pub roster: Option<RosterStatus>,
211 /// The reachable roster peer devices (the advisory presence read), each with an `online`
212 /// flag. Empty in a pure-pairing daemon / when no roster is installed. Additive:
213 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
214 #[serde(default, skip_serializing_if = "Vec::is_empty")]
215 pub presence: Vec<PresencePeer>,
216 /// THIS daemon's own self-sovereign `user_id` (`b64u:<user_pk>`), if it has a user key (auto-
217 /// minted at boot; shared by pairing AND roster mode). Lets the operator see + share their stable
218 /// identity that multiple devices resolve to. `None` only when no user key exists. Additive:
219 /// `#[serde(default, skip_serializing_if = "Option::is_none")]` so an older payload round-trips.
220 #[serde(default, skip_serializing_if = "Option::is_none")]
221 pub self_user_id: Option<String>,
222 /// Recent INVITER-side pairing completions, newest first (display-only pairing-ceremony aids —
223 /// see [`RecentPairing`]; in-memory on the daemon, cleared by a restart). Empty on a daemon
224 /// that has accepted no pairing since it started. Additive:
225 /// `#[serde(default, skip_serializing_if = "Vec::is_empty")]` so an older payload round-trips.
226 #[serde(default, skip_serializing_if = "Vec::is_empty")]
227 pub recent_pairings: Vec<RecentPairing>,
228 /// Advisory reachability of paired peers, from the on-demand probe cache. Empty until the
229 /// first probe completes. Additive: default + skip-if-empty.
230 #[serde(default, skip_serializing_if = "Vec::is_empty")]
231 pub reachability: Vec<PeerReachability>,
232 /// This node's EFFECTIVE self-nickname — what a freshly minted invite would present
233 /// (config `[identity].nickname`, else the hostname, else a fingerprint; live-updated by
234 /// `set_nickname`, #37). Empty only in mesh-less control-only mode. Additive: default +
235 /// skip-if-empty so an older payload round-trips.
236 #[serde(default, skip_serializing_if = "String::is_empty")]
237 pub self_nickname: String,
238}
239
240/// Params of [`Request::RegisterService`]: the `[services.*]` entry to write/update.
241#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
242#[serde(deny_unknown_fields)]
243pub struct RegisterServiceParams {
244 pub name: String,
245 pub backend: BackendSpec,
246 pub allow: Vec<String>,
247 /// When true (#36), the registration is EPHEMERAL: kept in daemon memory only, never written
248 /// to the on-disk config, and automatically unregistered when the control connection that
249 /// registered it closes (and gone on daemon restart). For an embedder that serves a
250 /// `socket` backend from a fresh path each run, this removes the need to derive a stable
251 /// socket path solely to keep a persisted registration valid, and the stale-registration
252 /// accumulation that comes with no unregister. Default false = the persistent behavior.
253 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
254 pub ephemeral: bool,
255}
256
257/// Params of [`Request::Invite`]: the services the minted invite grants. Rejects unknown
258/// fields (so `{service: "kb"}` — a singular typo — is a loud error, not a silently
259/// grants-nothing invite), and the daemon additionally rejects an empty/absent `services`
260/// list (an invite that grants nothing is useless — #34).
261#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
262#[serde(deny_unknown_fields)]
263pub struct InviteParams {
264 #[serde(default)]
265 pub services: Vec<String>,
266 /// An OPAQUE, caller-chosen label carried through to the redeemer in the `pair` result (#31).
267 /// mcpmesh never interprets it (not a nickname, never resolved or authorized) — a per-pairing
268 /// metadata slot for the embedder (e.g. its own URN). Capped at the daemon; omit for none.
269 #[serde(default, skip_serializing_if = "Option::is_none")]
270 pub app_label: Option<String>,
271}
272
273/// Params of [`Request::Pair`]: the copyable `mcpmesh-invite:` line. Defaultable — an
274/// absent field reads as an empty line, which simply fails to decode (a clean pair error).
275#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
276#[serde(deny_unknown_fields)]
277pub struct PairParams {
278 #[serde(default)]
279 pub invite_line: String,
280}
281
282/// Params of [`Request::PeerRemove`]: the nickname to unpair.
283#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
284#[serde(deny_unknown_fields)]
285pub struct PeerRemoveParams {
286 pub nickname: String,
287}
288
289/// Params of [`Request::PeerRename`]: the contact to rename — every device sharing `user_id`
290/// when given, else the single provisional `nickname` entry — and the new nickname `to`.
291#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
292#[serde(deny_unknown_fields)]
293pub struct PeerRenameParams {
294 #[serde(default)]
295 pub user_id: Option<String>,
296 #[serde(default)]
297 pub nickname: Option<String>,
298 pub to: String,
299}
300
301/// Params of [`Request::PeerAdd`] (reserved/internal — see the variant): a raw `endpoint_id`
302/// (iroh base32) plus the nickname and service allow list to install it under.
303#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
304#[serde(deny_unknown_fields)]
305pub struct PeerAddParams {
306 pub nickname: String,
307 pub endpoint_id: String,
308 #[serde(default)]
309 pub allow: Vec<String>,
310}
311
312/// Params of [`Request::OpenSession`]: the `peer/service` target to dial. Both fields are
313/// defaultable — an empty target simply fails the dial (a clean `-32055` error).
314#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
315#[serde(deny_unknown_fields)]
316pub struct OpenSessionParams {
317 #[serde(default)]
318 pub peer: String,
319 #[serde(default)]
320 pub service: String,
321}
322
323/// Params of [`Request::RosterInstall`]: the LOCAL roster file `path`, plus the org-root pin
324/// on FIRST install (`b64u:`; omit once pinned — config carries it).
325#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
326#[serde(deny_unknown_fields)]
327pub struct RosterInstallParams {
328 pub path: String,
329 #[serde(default, skip_serializing_if = "Option::is_none")]
330 pub org_root_pk: Option<String>,
331}
332
333/// Params of [`Request::OrgJoin`]: the `[identity]` pin. `user_key` is a LOCAL path — the key
334/// never crosses the API.
335#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
336#[serde(deny_unknown_fields)]
337pub struct OrgJoinParams {
338 pub org_id: String,
339 pub org_root_pk: String,
340 pub user_id: String,
341 pub user_key: String,
342}
343
344/// Params of [`Request::SetAppMetadata`]: this node's opaque app-metadata blob (#39). The
345/// daemon NEVER interprets it — the embedder structures its own bytes (a version string,
346/// small JSON, …). Capped at 256 bytes; `""` clears it. Roster-mode only (it rides the
347/// signed presence heartbeat); a pure-pairing daemon accepts + stores it but never gossips it.
348#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
349#[serde(deny_unknown_fields)]
350pub struct SetAppMetadataParams {
351 pub metadata: String,
352}
353
354/// Params of [`Request::PeerServices`] (#52): the peer to query — a nickname, an `eid:` device
355/// principal, or a `b64u:` user_id.
356#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
357#[serde(deny_unknown_fields)]
358pub struct PeerServicesParams {
359 pub peer: String,
360}
361
362/// Result of [`Request::PeerServices`] (#52): the services the queried peer CURRENTLY grants the
363/// caller — computed authoritatively on the peer (which owns the truth), always current, only
364/// the caller's own admitted services (never the peer's full registry).
365#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
366pub struct PeerServicesResult {
367 pub services: Vec<String>,
368}
369
370/// Params of [`Request::UnregisterService`] (#50): the persistent (or ephemeral) service name
371/// to remove — the deregistration mirror of `register_service`.
372#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
373#[serde(deny_unknown_fields)]
374pub struct UnregisterServiceParams {
375 pub name: String,
376}
377
378/// Params of [`Request::ServiceAllowGrant`] / [`Request::ServiceAllowRevoke`] (#44): toggle a
379/// single stable `principal` (`b64u:`/`eid:`) on a single `service`'s allow list, WITHOUT
380/// unpairing. The per-peer "sharing" switch primitive the embedder drives.
381#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
382#[serde(deny_unknown_fields)]
383pub struct ServiceAllowParams {
384 pub service: String,
385 pub principal: String,
386}
387
388/// Params of [`Request::SetNickname`]: this node's new self-nickname (#37). Display-only
389/// semantics: it names this node in FUTURE invites/presentations; peers keep the nickname
390/// they stored at pairing time until a re-invite.
391#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
392#[serde(deny_unknown_fields)]
393pub struct SetNicknameParams {
394 pub nickname: String,
395}
396
397/// Params of [`Request::SetRosterUrl`]: the HTTPS roster URL to pin.
398#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
399#[serde(deny_unknown_fields)]
400pub struct SetRosterUrlParams {
401 pub url: String,
402}
403
404/// Params of [`Request::SetRelays`] (#53): the node's desired CUSTOM relay set. Declarative —
405/// "make the custom relay set exactly this" — applied as a live insert/remove diff against the
406/// running endpoint (iroh 1.0.3 `Endpoint::insert_relay`/`remove_relay`) when the node is already
407/// in `relay_mode = "custom"`, then persisted to `[network]`. Each entry must parse as an iroh
408/// `RelayUrl`; an empty list is rejected (custom mode requires ≥1 relay — fully disabling relays
409/// is a `relay_mode = "disabled"` restart, not this verb). Switching a node that is currently
410/// `default`/`disabled` onto custom persists the config but needs a restart to take effect (iroh
411/// cannot live-transition the relay MODE) — signalled by [`SetRelaysResult::restart_required`].
412#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
413#[serde(deny_unknown_fields)]
414pub struct SetRelaysParams {
415 pub relay_urls: Vec<String>,
416}
417
418/// Result of [`Request::SetRelays`] (#53).
419#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
420pub struct SetRelaysResult {
421 /// The persisted `relay_urls` differed from the prior config (a no-op edit → `false`).
422 pub changed: bool,
423 /// `true` iff the node's current `relay_mode` is not `custom`, so the new set was persisted
424 /// but NOT applied live — a node restart is required for it to take effect. `false` on the
425 /// live custom→custom path (already applied to the running endpoint).
426 pub restart_required: bool,
427}
428
429/// Params of [`Request::BlobPublish`]: the scope to publish into and the LOCAL file to add.
430#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
431#[serde(deny_unknown_fields)]
432pub struct BlobPublishParams {
433 pub scope: String,
434 pub path: String,
435}
436
437/// Params of [`Request::BlobGrant`]: the scope and the flat-namespace principal to grant it to.
438#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
439#[serde(deny_unknown_fields)]
440pub struct BlobGrantParams {
441 pub scope: String,
442 pub principal: String,
443}
444
445/// Params of [`Request::BlobRevoke`] (#62): the scope and the principals to withdraw from it.
446///
447/// SCOPED, unlike unpair hygiene: only the named scope's grants change. A principal that also holds
448/// grants on other scopes keeps them — withdrawing access to one thing must not silently withdraw
449/// access to everything else.
450#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
451#[serde(deny_unknown_fields)]
452pub struct BlobRevokeParams {
453 pub scope: String,
454 pub principals: Vec<String>,
455}
456
457/// Params of [`Request::BlobUnpublish`] (#62): the scope and the blake3 hex to remove from it.
458///
459/// Removes REACHABILITY, not bytes. The scope gate requires a hash to be listed in some scope, so
460/// this takes effect immediately for authorization — but the bytes stay in the local store, and
461/// there is no reclaim verb yet. Do not surface this to a user as deletion.
462#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
463#[serde(deny_unknown_fields)]
464pub struct BlobUnpublishParams {
465 pub scope: String,
466 pub hash: String,
467}
468
469/// Params of [`Request::BlobRepublish`] (#83): the scope and the blake3 hex to add to it.
470///
471/// The blob must already be held COMPLETE by this daemon — republish makes a fetched blob servable
472/// FROM this node, it does not fetch. A hash that is absent, or only partially present from an
473/// interrupted fetch, is refused with [`ERR_NO_SUCH_BLOB`]: advertising bytes we cannot serve would
474/// turn the original publisher going offline into a hang at every fetcher.
475///
476/// It grants NOBODY. The republisher names a scope they already control; inheriting the original
477/// publisher's grants would be a silent authorization transfer. Share with `blob_grant`.
478#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
479#[serde(deny_unknown_fields)]
480pub struct BlobRepublishParams {
481 pub scope: String,
482 pub hash: String,
483}
484
485/// Params of [`Request::BlobFetch`]: the `mcpmesh/blob/1` ticket and the LOCAL export path.
486#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
487#[serde(deny_unknown_fields)]
488pub struct BlobFetchParams {
489 pub ticket: String,
490 pub dest_path: String,
491}
492
493/// Control-API requests. Serialized as `{ "method": "...", "params": {...} }`
494/// (JSON-RPC-shaped; the id/jsonrpc envelope is added by the transport layer).
495///
496/// Each param-carrying variant wraps its named `*Params` struct — the ONE wire truth for that
497/// method's params, shared by clients (which serialize whole `Request`s) and the daemon (which
498/// deserializes `params` into the same struct after its method-string dispatch). Adjacent
499/// tagging serializes a newtype variant's content as the struct's fields, so the wire shape is
500/// identical to inline variant bodies.
501///
502/// **Servers dispatch on the `method` string and deserialize `params` per-method** — tolerating
503/// omitted / null / empty-object params for parameterless methods — rather than deserializing a
504/// whole message into `Request` (adjacent tagging rejects `params:{}` for unit variants).
505/// This keeps the wire tolerant for third-party clients (the versioned, additive-only surface).
506/// Use [`method_of`] to extract the tag, then match + deserialize `params` per-method.
507#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
508#[serde(tag = "method", content = "params", rename_all = "snake_case")]
509pub enum Request {
510 /// Register/update a `[services.*]` entry idempotently.
511 RegisterService(RegisterServiceParams),
512 Status,
513 /// Mint a one-time pairing invite granting `services`. The daemon
514 /// answers an [`InviteResult`] carrying the copyable `mcpmesh-invite:` line. Tag
515 /// `"invite"` (snake_case). `method_of` needs no per-variant arm — it reads the
516 /// `method` string generically; the tag comes from `rename_all`.
517 Invite(InviteParams),
518 /// Redeem a pairing invite. The daemon dials the inviter named by
519 /// `invite_line` on `mcpmesh/pair/1`, proves the secret, writes the mutual
520 /// (dial-back) `PeerEntry`, and answers a [`PairResult`]. Tag `"pair"`
521 /// (snake_case); `method_of` reads the `method` string generically.
522 ///
523 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
524 Pair(PairParams),
525 /// Remove a paired peer by nickname (`mcpmesh pair --remove`). The daemon drops the
526 /// peer's `PeerEntry` (identity) AND revokes its access by stripping its stable principals from every
527 /// `[services.*].allow` (authorization) — the inverse of the pairing grant. Idempotent: a
528 /// nickname with no entry / no allow membership is a clean no-op. Live in-flight sessions are
529 /// NOT severed here: existing sessions run to completion; the peer only loses the
530 /// ability to establish NEW authorized sessions. Tag `"peer_remove"` (snake_case);
531 /// `method_of` reads the `method` string generically (no per-variant arm).
532 ///
533 /// `PeerEntry` — the durable allowlist row — lives in the daemon crate.
534 PeerRemove(PeerRemoveParams),
535 /// Rename a contact's nickname (nickname) authoritatively. Renames the
536 /// PERSON — every `PeerEntry` sharing `user_id` when given (one op for all their devices), else the
537 /// single `nickname` entry (a provisional, no-`user_id` contact) — to `to`, AND rewrites the old
538 /// nickname → `to` in every `[services.*].allow` so grants follow the rename. Refuses (error frame)
539 /// when `to` is empty or already names/grants a DIFFERENT identity — the same collision guard the
540 /// pairing rendezvous uses, so a rename can't inherit another peer's access. Tag `"peer_rename"`;
541 /// host-privileged like the other pair ops.
542 PeerRename(PeerRenameParams),
543 /// RESERVED / INTERNAL (`docs/local-protocol.md` "Reserved / internal methods"): install a
544 /// peer directly from a raw `endpoint_id` — the trust-population stand-in for pairing behind
545 /// `mcpmesh internal peer add`. A deliberate, documented exception to the surface discipline
546 /// (raw endpoint identifiers otherwise never cross this socket); NOT part of the stable
547 /// vocabulary — do not build on it. Tag `"peer_add"`.
548 PeerAdd(PeerAddParams),
549 /// Open a mesh session to `peer/service`; the daemon dials and pipes.
550 /// Distinct from the proxy's job: this returns a session the client streams.
551 /// Named `open_session` rather than `connect` to avoid colliding
552 /// with the `connect` porcelain.
553 OpenSession(OpenSessionParams),
554 /// Install a signed roster from a local file (the manual `internal roster install` path).
555 /// `path` is a LOCAL file the same-uid daemon reads (the daemon runs as the caller's own
556 /// uid, so passing a path rather than the bytes crosses no trust boundary). `org_root_pk`
557 /// pins the org root on FIRST install (`b64u:`); omit it
558 /// once pinned (config carries it). Tag `"roster_install"`.
559 RosterInstall(RosterInstallParams),
560 /// Pin the org root on a JOINER — WITHOUT a roster (the joiner has none yet; its poll loop
561 /// fetches the first one). Records `[identity]` org_id / org_root_pk / user_id / user_key.
562 /// `user_key` is a LOCAL path
563 /// (the key never crosses the API). Tag `"org_join"`.
564 OrgJoin(OrgJoinParams),
565 /// Pin the HTTPS roster URL (`[roster].url`) in config. Written by `org create
566 /// --roster-url` (the operator keeps it current) AND by `join` when the org invite carries one —
567 /// so the joiner's poll loop bootstraps its FIRST roster. The daemon writes it under
568 /// `reload_lock` (single-writer), then the poll loop picks it up on the next daemon start. Tag
569 /// `"set_roster_url"`.
570 SetRosterUrl(SetRosterUrlParams),
571 /// Rename this node LIVE (#37): validate + upsert `[identity].nickname` through the
572 /// daemon's own serialized config-write path (no lost-update window against a
573 /// concurrent grant/registration) and update the in-memory name future invites
574 /// present — no restart. Ack result. Tag `"set_nickname"` (snake_case).
575 SetNickname(SetNicknameParams),
576 /// Set this node's opaque app-metadata blob (#39): validated (≤256B) and folded, signed,
577 /// into each outgoing presence heartbeat, so paired roster peers see it in their `status`
578 /// presence — no per-peer session. Ack result. Tag `"set_app_metadata"`. In-memory (lost
579 /// on restart; the embedder re-sets on startup).
580 SetAppMetadata(SetAppMetadataParams),
581 /// Set this node's CUSTOM relay set LIVE (#53): validate each URL as an iroh `RelayUrl`, diff
582 /// against the running endpoint's current custom relays and apply the delta via iroh 1.0.3
583 /// `Endpoint::insert_relay`/`remove_relay` (no endpoint rebuild, no dropped sessions), then
584 /// persist `[network] relay_mode="custom" relay_urls=[…]` under `reload_lock`. When the node
585 /// is currently `default`/`disabled`, the config is persisted but the live mode transition
586 /// isn't possible — [`SetRelaysResult::restart_required`] is `true`. Answers a
587 /// [`SetRelaysResult`]. Tag `"set_relays"`.
588 SetRelays(SetRelaysParams),
589 /// Grant a single stable principal access to a single service's allow (#44) — the per-peer
590 /// "sharing on" toggle, idempotent + serialized under the config lock. Ack result.
591 /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
592 /// Removes the whole `[services.<name>]` entry (allow included) + any ephemeral one, then
593 /// hot-reloads. Idempotent. Ack result.
594 UnregisterService(UnregisterServiceParams),
595 /// Discover which services a paired peer CURRENTLY grants the caller (#52) — dials the peer
596 /// and returns the service names whose allow admits the caller's principal. Answers
597 /// [`PeerServicesResult`].
598 PeerServices(PeerServicesParams),
599 ServiceAllowGrant(ServiceAllowParams),
600 /// Revoke a single stable principal from a single service's allow (#44) — "sharing off"
601 /// WITHOUT unpairing (the peer's identity row is untouched; only NEW sessions are refused).
602 /// Idempotent. Ack result.
603 ServiceAllowRevoke(ServiceAllowParams),
604 /// Publish a LOCAL file INTO a scope: the daemon adds the bytes to its gated
605 /// app-blob store and records the hash in `scope`. `path` is a local file the same-uid daemon
606 /// reads. Answers a [`BlobPublishResult`] carrying the `mcpmesh/blob/1` ticket + hash.
607 /// Tag `"blob_publish"`.
608 BlobPublish(BlobPublishParams),
609 /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id, or a
610 /// nickname (the shared `principal_set` expansion). Tag
611 /// `"blob_grant"`.
612 BlobGrant(BlobGrantParams),
613 /// Tag `"blob_revoke"`: withdraw principals from ONE scope's grants (#62).
614 BlobRevoke(BlobRevokeParams),
615 /// Tag `"blob_unpublish"`: remove a hash from ONE scope (#62). Withdraws reachability, not
616 /// bytes.
617 BlobUnpublish(BlobUnpublishParams),
618 /// #83: make a blob this daemon already holds servable from HERE, in a scope it controls.
619 /// Answers a [`BlobPublishResult`] — same shape as `blob_publish`, so a client can treat the
620 /// two interchangeably after a fetch.
621 BlobRepublish(BlobRepublishParams),
622 /// List the daemon's blob scopes (name → hashes + grants). Tag `"blob_list"`.
623 BlobList,
624 /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified streaming) and export the
625 /// verified blob to `dest_path` (a local file the same-uid daemon writes). Answers a
626 /// [`BlobFetchResult`] with the verified hash + byte length. Tag `"blob_fetch"`.
627 BlobFetch(BlobFetchParams),
628 /// Summarize this node's LOCAL audit log into per-peer / per-service SESSION counts
629 /// (local-only — the daemon reads its OWN audit dir, nothing is transmitted). The host Mesh surface
630 /// renders these as "who serves me / whom I serve / session counts". Parameterless (like `Status`);
631 /// the server dispatches on the `method` string. Tag `"audit_summary"` (snake_case);
632 /// `method_of` reads the `method` string generically (no per-variant arm).
633 AuditSummary,
634 /// Open a live event stream (pairing liveness & health telemetry). Like `open_session`, the
635 /// connection STOPS being request/response after this call and becomes a one-way push stream
636 /// of `StreamFrame`s. Parameterless. Tag `"subscribe"`.
637 Subscribe,
638}
639
640/// Result of [`Request::OrgJoin`] — the pinned org id echoed back (surface-clean; the fingerprint is
641/// computed porcelain-side from the invite's org_root_pk). Additive-only.
642#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
643pub struct OrgJoinResult {
644 pub org_id: String,
645}
646
647/// Result of a [`Request::RosterInstall`] request (the manual install path): the installed roster's
648/// org id + serial (roster-status vocabulary the confirmation line is permitted to render) plus how
649/// many live sessions the install severed. Surface-clean: NO keys / EndpointIds / paths.
650///
651/// Additive-only: any future field MUST land as
652/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
653#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
654pub struct RosterInstallResult {
655 pub org_id: String,
656 pub serial: u64,
657 /// How many live sessions were severed, for the porcelain's confirmation line.
658 #[serde(default)]
659 pub severed: u32,
660}
661
662/// Result of [`Request::BlobPublish`]: the copyable `mcpmesh/blob/1` ticket + the blob's blake3 hash.
663/// A ticket/hash here is blob-reference vocabulary (NOT a transport-vocab leak — the same
664/// carve-out as the pairing invite line). Additive-only.
665#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
666pub struct BlobPublishResult {
667 pub ticket: String,
668 pub hash: String, // bare blake3 hex
669}
670
671/// One scope in a [`BlobScopeList`]: its name + the hashes it contains + the principals it
672/// grants. Flat vocabulary ONLY — no EndpointId/pubkey/ALPN. Additive-only.
673#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
674pub struct ScopeInfo {
675 pub name: String,
676 pub hashes: Vec<String>,
677 pub grants: Vec<String>,
678 /// Hashes deliberately WITHDRAWN from this scope (#107): `blob_unpublish` was called, and
679 /// `blob_republish` of these into THIS scope is refused with [`ERR_BLOB_WITHDRAWN`]. Cleared
680 /// only by a deliberate `blob_publish {scope, path}`. Additive — omitted when empty, so a
681 /// pre-`api_minor` 19 client sees exactly what it saw before.
682 #[serde(default, skip_serializing_if = "Vec::is_empty")]
683 pub withdrawn: Vec<String>,
684}
685
686/// Result of [`Request::BlobList`]: the daemon's scopes. Additive-only.
687#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
688pub struct BlobScopeList {
689 pub scopes: Vec<ScopeInfo>,
690}
691
692/// Result of [`Request::BlobFetch`]: the verified hash + byte length written to `dest_path`.
693/// Additive-only.
694#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
695pub struct BlobFetchResult {
696 pub hash: String,
697 pub bytes_len: u64,
698}
699
700/// Result of [`Request::AuditSummary`]: LOCAL per-peer / per-service session counts
701/// aggregated from this node's OWN audit log — NEVER transmitted (local-only). Surface-clean:
702/// peer names are nicknames / user_ids (NEVER EndpointIds), service names are the registered
703/// service names (NEVER transport vocabulary). A "session" is one `SessionOpen` record. `per_peer` /
704/// `per_service` are sorted ascending by name (deterministic). Tuples mirror kb's
705/// `InsightResponse::per_peer_contribution` — `["bob", 2]` on the wire.
706///
707/// Additive-only: any future field MUST land as
708/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
709#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
710pub struct AuditSummaryResult {
711 /// Sessions opened per peer (nickname). A session with no attributed peer is NOT counted here (no
712 /// peer to attribute) but IS in `total_sessions`.
713 pub per_peer: Vec<(String, u64)>,
714 /// Sessions opened per registered service name.
715 pub per_service: Vec<(String, u64)>,
716 /// Total sessions opened (every `SessionOpen` record, including peer-less ones).
717 #[serde(default)]
718 pub total_sessions: u64,
719}
720
721/// Result of an [`Request::Invite`] request: the copyable `mcpmesh-invite:` artifact
722/// (the ONE pairing artifact deliberately carved out of the
723/// transport-vocabulary blocklist, so this is NOT a transport-vocab leak) plus its
724/// absolute expiry in epoch seconds (≤ now + 24h).
725///
726/// `invite` returns BEFORE any redemption, so the SAS — which is derived from the redeemer's
727/// endpoint id, unknown until they redeem — cannot appear here. The inviter reads its side of
728/// the SAS from [`StatusResult::recent_pairings`] once a redemption completes (a `trust`/`pair`
729/// frame on the live [`StreamFrame`] stream signals that moment). See the "embedding the pairing
730/// ceremony" note in `docs/local-protocol.md` (#35).
731///
732/// Additive-only: any future field MUST land as `#[serde(default, skip_serializing_if = ...)]`
733/// so older payloads still deserialize.
734#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
735pub struct InviteResult {
736 /// The `mcpmesh-invite:<base32>` line, copied out-of-band to the redeemer.
737 pub invite_line: String,
738 /// When the invite expires (epoch seconds); the daemon burns it at redemption or expiry.
739 pub expires_at_epoch: u64,
740}
741
742/// Result of a [`Request::Pair`] request: the inviter's suggested nickname (the
743/// redeemer's local name for the new peer) plus the display-only short authentication
744/// code (SAS) — a few words the human reads aloud to a second channel to
745/// catch a whole-invite forgery / address-swap MITM. The SAS is a pairing-ceremony
746/// artifact (like the invite line), NOT a transport-vocabulary leak.
747///
748/// Additive-only: any future field MUST land as
749/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
750#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
751pub struct PairResult {
752 /// The inviter's suggested nickname (from the invite) — the redeemer's local name for it.
753 pub peer_nickname: String,
754 /// The display-only short authentication code (e.g. `"tango-fig-42"`), shown on both
755 /// sides for the out-of-band human check. Never sent on the wire, never checked
756 /// programmatically.
757 pub sas_code: String,
758 /// The services this pairing granted the redeemer — each mountable as `<peer>/<service>`.
759 /// Populated from the invite (`invite.services`) by the redeemer-side `redeem_invite`, so
760 /// the porcelain can print the "You can mount: alice/notes" line without re-decoding the
761 /// invite. Additive: `#[serde(default, skip_serializing_if = ...)]` so a `PairResult`
762 /// minted by an older daemon (which omits `services`) still deserializes — to an empty list.
763 #[serde(default, skip_serializing_if = "Vec::is_empty")]
764 pub services: Vec<String>,
765 /// The opaque `app_label` the inviter attached at `invite` time (#31), echoed verbatim — or
766 /// absent if none was set. mcpmesh never interprets it; the embedder does. Additive.
767 #[serde(default, skip_serializing_if = "Option::is_none")]
768 pub app_label: Option<String>,
769 /// The inviter's proven self-sovereign `user_id` (`b64u:<user_pk>`), when it presented a
770 /// device→user binding at pairing (#30). This is the STABLE, portable identity the redeemer
771 /// can align with its own — and the same value it may later pass to `open_session` to dial
772 /// this peer by identity rather than by local nickname. `None` if the inviter presented no
773 /// binding (a legacy/keyless peer). Additive.
774 #[serde(default, skip_serializing_if = "Option::is_none")]
775 pub peer_user_id: Option<String>,
776}
777
778/// The event class of an [`AuditRecord`] (the four audit event classes). An additive discriminant on
779/// top of the base record schema: it removes no field and makes the JSONL self-describing so
780/// a consumer can filter by class without guessing from which optional fields are present.
781#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
782#[serde(rename_all = "snake_case")]
783pub enum AuditKind {
784 /// A mesh session opened (a backend was selected for an authenticated peer).
785 /// (A `session_open` with `status:"error"` is a synthesized FAILED-dial marker — no backend
786 /// was reached; it records an attempted-and-failed reach for the telemetry stream.)
787 SessionOpen,
788 /// A mesh session closed (the backend returned / the session tore down).
789 SessionClose,
790 /// One proxied MCP request line (method + tool NAME + args_hash). NEVER carries raw arguments.
791 Request,
792 /// A peer fetched a blob from this node's gated provider (peer + hash + allow/deny).
793 BlobFetch,
794 /// A trust mutation (pair, unpair, roster install/swap, revoke).
795 Trust,
796}
797
798/// One audit record — the union of the event classes, and the `record` payload of a
799/// [`StreamFrame::Event`]. ONE schema for the on-disk JSONL log and the live stream. Every field
800/// beyond `ts`/`kind` is optional and elided when absent (`skip_serializing_if`), so each class
801/// serializes to just its relevant keys (a session record has no `method`; a trust record has no
802/// `bytes_out`).
803///
804/// PRIVACY: the proxied-request record carries `method` + `tool` (NAME only) +
805/// `args_hash` (`"blake3:<hex>"`), and NEVER the raw arguments, the request/response content, or
806/// any tool-output bytes — only a `bytes_out` COUNT and a `status`.
807#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
808pub struct AuditRecord {
809 /// RFC3339 UTC with millisecond precision, e.g. `"2026-07-03T14:02:11.480Z"`. The `YYYY-MM`
810 /// prefix also selects the monthly file (the rotation boundary), so it is always present.
811 pub ts: String,
812 pub kind: AuditKind,
813 /// The gate-resolved authenticated peer (attributed by the endpoint_id-keyed trust gate). Absent on
814 /// local-only events with no remote peer (a manual roster install).
815 #[serde(skip_serializing_if = "Option::is_none")]
816 pub peer: Option<String>,
817 #[serde(skip_serializing_if = "Option::is_none")]
818 pub service: Option<String>,
819 #[serde(skip_serializing_if = "Option::is_none")]
820 pub method: Option<String>,
821 /// The tool NAME only (never its arguments or output) — e.g. `"read_file"` for a `tools/call`.
822 #[serde(skip_serializing_if = "Option::is_none")]
823 pub tool: Option<String>,
824 /// `"blake3:<hex>"` of the request arguments. The raw arguments are NEVER stored.
825 #[serde(skip_serializing_if = "Option::is_none")]
826 pub args_hash: Option<String>,
827 /// Byte COUNT of the response sent back to the peer — a count, never the content.
828 #[serde(skip_serializing_if = "Option::is_none")]
829 pub bytes_out: Option<u64>,
830 /// `"ok"` / `"error"` (proxied request) or `"ok"` / `"denied"` (blob fetch).
831 #[serde(skip_serializing_if = "Option::is_none")]
832 pub status: Option<String>,
833 #[serde(skip_serializing_if = "Option::is_none")]
834 pub latency_ms: Option<u64>,
835 /// Trust-event verb: `"pair"` / `"unpair"` / `"roster_install"` / `"revoke"` (kind == Trust).
836 #[serde(skip_serializing_if = "Option::is_none")]
837 pub event: Option<String>,
838 /// A reference, NEVER content: a blob hash (`BlobFetch`) or a trust-event target such as a
839 /// nickname or `org/serial` (`Trust`).
840 #[serde(skip_serializing_if = "Option::is_none")]
841 pub target: Option<String>,
842}
843
844impl AuditRecord {
845 fn base(ts: String, kind: AuditKind) -> Self {
846 Self {
847 ts,
848 kind,
849 peer: None,
850 service: None,
851 method: None,
852 tool: None,
853 args_hash: None,
854 bytes_out: None,
855 status: None,
856 latency_ms: None,
857 event: None,
858 target: None,
859 }
860 }
861
862 pub fn session_open(ts: String, peer: Option<String>, service: String) -> Self {
863 let mut r = Self::base(ts, AuditKind::SessionOpen);
864 r.peer = peer;
865 r.service = Some(service);
866 r
867 }
868
869 /// Set the record's `status` (`"ok"`/`"error"`/`"denied"`), returning `self` for chaining.
870 /// Marks a synthesized failure record — e.g. the `session_open` for a FAILED dial, which
871 /// reaches no backend and so is never audited by the far side's session guard — without a
872 /// dedicated constructor. DRY: reuses the existing optional `status` field.
873 pub fn with_status(mut self, status: &str) -> Self {
874 self.status = Some(status.into());
875 self
876 }
877
878 pub fn session_close(ts: String, peer: Option<String>, service: String) -> Self {
879 let mut r = Self::base(ts, AuditKind::SessionClose);
880 r.peer = peer;
881 r.service = Some(service);
882 r
883 }
884
885 /// A completed (request→response correlated) proxied line: method + tool NAME + args_hash, plus
886 /// the response's `bytes_out` COUNT, `status`, and `latency_ms`. PRIVACY: `args_hash` is a digest;
887 /// no raw arguments, request/response content, or tool-output bytes are ever passed in.
888 #[allow(clippy::too_many_arguments)]
889 pub fn proxied_request(
890 ts: String,
891 peer: Option<String>,
892 service: String,
893 method: String,
894 tool: Option<String>,
895 args_hash: String,
896 bytes_out: u64,
897 status: String,
898 latency_ms: u64,
899 ) -> Self {
900 let mut r = Self::base(ts, AuditKind::Request);
901 r.peer = peer;
902 r.service = Some(service);
903 r.method = Some(method);
904 r.tool = tool;
905 r.args_hash = Some(args_hash);
906 r.bytes_out = Some(bytes_out);
907 r.status = Some(status);
908 r.latency_ms = Some(latency_ms);
909 r
910 }
911
912 /// A proxied NOTIFICATION line (no `id`, so no response correlates): method + tool + args_hash,
913 /// no `bytes_out`/`status`/`latency_ms`. The line is still recorded — every proxied request is audited.
914 pub fn proxied_notification(
915 ts: String,
916 peer: Option<String>,
917 service: String,
918 method: String,
919 tool: Option<String>,
920 args_hash: String,
921 ) -> Self {
922 let mut r = Self::base(ts, AuditKind::Request);
923 r.peer = peer;
924 r.service = Some(service);
925 r.method = Some(method);
926 r.tool = tool;
927 r.args_hash = Some(args_hash);
928 r
929 }
930
931 pub fn blob_fetch(ts: String, peer: Option<String>, hash: String, status: String) -> Self {
932 let mut r = Self::base(ts, AuditKind::BlobFetch);
933 r.peer = peer;
934 r.target = Some(hash);
935 r.status = Some(status);
936 r
937 }
938
939 pub fn trust(ts: String, event: String, target: Option<String>) -> Self {
940 let mut r = Self::base(ts, AuditKind::Trust);
941 r.event = Some(event);
942 r.target = target;
943 r
944 }
945}
946
947/// One live mesh session, in a [`StreamFrame::Snapshot`]. Surface-clean: `peer` is the
948/// user_id-or-nickname the audit records carry, never an endpoint-id. `opened_at` is epoch seconds.
949#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
950pub struct ActiveSession {
951 pub peer: String,
952 pub service: String,
953 pub opened_at: i64,
954}
955
956/// One frame of the [`Request::Subscribe`] stream (pairing liveness & health telemetry). Tagged on
957/// `type` (snake_case), so a frame is `{"type":"snapshot",...}` / `{"type":"event",...}` /
958/// `{"type":"lagged",...}`. `Event.record` is the [`AuditRecord`] verbatim, so the stream and the
959/// on-disk log carry ONE schema. The daemon serializes these; an embedding consumer deserializes
960/// them (see `docs/local-protocol.md` "Live event stream").
961/// **`#[non_exhaustive]`**: a future frame kind must not break a downstream `match`. Adding
962/// `Reachability` in 0.13.0 DID break exhaustive matches — which is why that release is a MINOR,
963/// per `RELEASING.md`'s pre-1.0 rule that breaking changes bump the minor. Consumers now write a
964/// `_ =>` arm and later additions are additive for Rust as well as for JSON.
965#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
966#[serde(tag = "type", rename_all = "snake_case")]
967#[non_exhaustive]
968pub enum StreamFrame {
969 /// The FIRST frame: a point-in-time picture of the mesh (open sessions + paired-peer
970 /// reachability) so a fresh subscriber renders immediately without replaying history.
971 Snapshot {
972 active_sessions: Vec<ActiveSession>,
973 reachability: Vec<PeerReachability>,
974 },
975 /// A live audit event (session open/close, request, blob fetch, trust) — the tap on the hub.
976 /// Boxed so this (much larger) variant does not bloat every frame; serde delegates through the
977 /// `Box`, so the wire shape is the record's fields verbatim.
978 Event { record: Box<AuditRecord> },
979 /// A peer's reachability TRANSITIONED (#58): it became reachable, became unreachable, or was
980 /// probed for the first time. Pushed so an embedder does not have to poll `status` for a live
981 /// online/offline indicator — and so work queued for an unreachable peer can flush the moment
982 /// it returns, rather than on the next poll tick.
983 ///
984 /// Emitted on a CHANGE of `reachable` only. A refreshed probe with the same verdict emits
985 /// nothing, so a peer that stays up does not produce a frame per TTL refresh; `rtt_ms`/`meta`/
986 /// `services` drift is advisory detail and is not a transition. `age_secs` is `0` — the probe
987 /// just completed.
988 Reachability { peer: PeerReachability },
989 /// The subscriber fell `dropped` records behind the broadcast ring; the stream continues (a
990 /// fresh reconnect would re-`Snapshot`). Never drops the subscriber — lag is reported, never fatal.
991 Lagged { dropped: u64 },
992}
993
994/// Extract the `method` tag from a raw request value without deserializing the whole
995/// message. The daemon's dispatcher uses this: match on the method string, then deserialize
996/// `params` per-method — which tolerates omitted / null / `{}` params for parameterless
997/// methods (adjacent tagging rejects `params:{}` on unit variants).
998pub fn method_of(v: &serde_json::Value) -> Option<&str> {
999 v.get("method").and_then(serde_json::Value::as_str)
1000}
1001
1002/// How a service is answered. Mirrors the config `[services.*]` *kinds*;
1003/// Config→BackendSpec is a hand-written match, not a serde passthrough.
1004#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1005#[serde(rename_all = "snake_case")]
1006pub enum BackendSpec {
1007 Run {
1008 cmd: Vec<String>,
1009 /// Per-service environment variables (#51) for the spawned child. Overlaid on the
1010 /// daemon's inherited env; the injected `MCPMESH_PEER_*` identity vars ALWAYS win over
1011 /// these (identity is not spoofable by a service definition). Default empty.
1012 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
1013 env: BTreeMap<String, String>,
1014 /// Working directory to spawn the child in (#51). Default: inherit the daemon's cwd.
1015 #[serde(default, skip_serializing_if = "Option::is_none")]
1016 cwd: Option<String>,
1017 },
1018 Socket {
1019 path: String,
1020 },
1021}
1022
1023/// Control-API error code: the named service exists in neither `config.toml` nor the ephemeral
1024/// registry (#55). Distinct from the generic `-32000` so a caller can BRANCH on "no such service"
1025/// instead of parsing a message — `service_allow_grant`/`service_allow_revoke` previously answered
1026/// `{}` (success) for an unknown name, which silently included every ephemeral service.
1027pub const ERR_NO_SUCH_SERVICE: i64 = -32040;
1028/// The named blob is not held COMPLETE by this daemon (#83, `blob_republish`). Distinct from
1029/// [`ERR_NO_SUCH_SERVICE`] because the remedy differs: fetch the blob first.
1030pub const ERR_NO_SUCH_BLOB: i64 = -32041;
1031/// The blob was deliberately withdrawn from this scope (#107). Distinct from
1032/// [`ERR_NO_SUCH_BLOB`]: that means "fetch it first", this means "someone un-shared this on
1033/// purpose — `blob_publish` from the file if the re-share is intended".
1034pub const ERR_BLOB_WITHDRAWN: i64 = -32042;
1035
1036pub const API_NAME: &str = "mcpmesh-local/1";
1037/// The protocol-compatibility version as `"MAJOR.MINOR"`, distinct from the crate/stack version.
1038///
1039/// - **MAJOR** matches the `/N` in [`API_NAME`] and changes only on a breaking wire change (the
1040/// transport already rejects a mismatched `api`, so an equality check on that is redundant).
1041/// - **MINOR** ([`API_MINOR`]) increments on EVERY surface change within a major — additive fields,
1042/// new methods, or a strictness change like params validation — bumped in the same change that
1043/// makes it. A client can guard with `api_minor >= N` for a feature it needs, or refuse a daemon
1044/// older than a minor it requires. It never resets except on a MAJOR bump.
1045pub const API_VERSION: &str = "1.19";
1046/// The integer MINOR of [`API_VERSION`] — see there. Bumped from 0 to 1 when params validation
1047/// became strict (#34); to 2 with the `set_nickname` verb + `StatusResult.self_nickname` (#37);
1048/// to 3 when `allow`/grant strings became STABLE principals — `b64u:`/`eid:`/roster names,
1049/// never nicknames (#38); to 4 with the `set_app_metadata` verb + `PresencePeer.meta` (#39);
1050/// to 5 with `PeerReachability.meta` — pairing-mode app metadata on the probe pong (#40);
1051/// to 6 with `PeerInfo.principal` — the peer's eid: device principal on `status` (#41);
1052/// to 7 with `PeerReachability.principal` — the same on reachability rows (#42); to 8 with the
1053/// `service_allow_grant`/`service_allow_revoke` per-peer access verbs (#44); to 9 covering the
1054/// `unregister_service` (#50) / `peer_services` (#52) / Run `env`+`cwd` (#51) surface that shipped
1055/// in 0.10.1 without a bump, PLUS the `set_relays` live relay-set verb (#53); to 10 when
1056/// `service_allow_revoke`/`peer_remove` became IMMEDIATE — no verb shape changed, but their
1057/// observable contract did: a revoked principal's next session is refused even on a connection it
1058/// already holds, and its live connections are severed. Previously both waited for the peer to
1059/// disconnect on its own, which is unbounded (#54). A consumer can guard on
1060/// `api_minor >= 10` before telling a user that revocation has taken effect; to 11 when
1061/// `service_allow_grant`/`service_allow_revoke` gained EPHEMERAL-service support and became strict
1062/// about an unknown service name — a name in neither the config nor the ephemeral registry now
1063/// answers [`ERR_NO_SUCH_SERVICE`] instead of a silent `{}` (#55, #69); to 12 with the pushed
1064/// [`StreamFrame::Reachability`] liveness transition frame (#58); to 13 with
1065/// [`PeerReachability::path`] — direct-vs-relay attribution on every reachability row (#64); to 14
1066/// with the `run`-backend `MCPMESH_PEER_EID` identity var — the caller's stable device principal,
1067/// unconditionally present, so a `run` server can scope per caller without keying on a nickname
1068/// (#60); to 15 with the `blob_revoke` / `blob_unpublish` verbs — per-scope withdrawal of a grant
1069/// and of a published hash, so un-sharing a file no longer requires unpairing the person (#62); to
1070/// 16 when the app-blob provider became available in PAIRING mode — the blob verbs previously
1071/// errored on any daemon without an org root key, though their scope gate never needed one (#61).
1072pub const API_MINOR: u32 = 19;
1073
1074#[cfg(test)]
1075mod tests {
1076 use super::*;
1077
1078 /// #64: the path field's wire shape, and its ADDITIVE default. A row from an older daemon has
1079 /// no `path` key at all and must land on `Unknown` — never on `Direct`, which would invent a
1080 /// privacy guarantee that daemon never made.
1081 #[test]
1082 fn peer_path_tags_and_defaults_to_unknown() {
1083 let tagged = |p: PeerPath| serde_json::to_value(p).unwrap();
1084 assert_eq!(tagged(PeerPath::Direct)["kind"], "direct");
1085 assert_eq!(tagged(PeerPath::Unknown)["kind"], "unknown");
1086 let relay = tagged(PeerPath::Relay {
1087 url: Some("https://relay.example/".into()),
1088 });
1089 assert_eq!(relay["kind"], "relay");
1090 assert_eq!(relay["url"], "https://relay.example/");
1091 // A relay whose URL we do not know still tags as relay, with the key elided.
1092 let bare = tagged(PeerPath::Relay { url: None });
1093 assert_eq!(bare["kind"], "relay");
1094 assert!(bare.get("url").is_none(), "elided, not null: {bare}");
1095
1096 // #64 review: a path kind from a NEWER daemon must degrade to Unknown, not fail the whole
1097 // row. Without `#[serde(other)]` an unknown `kind` errors out of
1098 // `PeerReachability` entirely, so one new variant would break every `status` read an
1099 // older pinned client does.
1100 let future: PeerPath =
1101 serde_json::from_value(serde_json::json!({"kind": "quantum", "id": "x"})).unwrap();
1102 assert_eq!(future, PeerPath::Unknown);
1103 let row: PeerReachability = serde_json::from_value(serde_json::json!({
1104 "name": "bob", "reachable": true, "path": {"kind": "quantum"}
1105 }))
1106 .expect("an unknown path kind must not fail the whole row");
1107 assert_eq!(row.path, PeerPath::Unknown);
1108 assert!(row.reachable, "the rest of the row survives");
1109
1110 // A pre-#64 row: no `path` key.
1111 let old = serde_json::json!({"name": "bob", "reachable": true});
1112 let parsed: PeerReachability = serde_json::from_value(old).unwrap();
1113 assert_eq!(
1114 parsed.path,
1115 PeerPath::Unknown,
1116 "an older daemon's row must never imply a direct path"
1117 );
1118 }
1119
1120 /// #58: the pushed liveness frame tags as `{"type":"reachability","peer":{…}}` and carries a
1121 /// whole `PeerReachability` row — the SAME shape the opening snapshot's list holds, so a
1122 /// consumer projects both through one code path.
1123 #[test]
1124 fn reachability_frame_tags_and_round_trips() {
1125 let frame = StreamFrame::Reachability {
1126 peer: PeerReachability {
1127 name: "bob".into(),
1128 reachable: true,
1129 rtt_ms: Some(12),
1130 age_secs: Some(0),
1131 meta: String::new(),
1132 principal: Some("eid:beef".into()),
1133 path: Default::default(),
1134 },
1135 };
1136 let v = serde_json::to_value(&frame).unwrap();
1137 assert_eq!(v["type"], "reachability");
1138 assert_eq!(v["peer"]["name"], "bob");
1139 assert_eq!(v["peer"]["reachable"], true);
1140 assert_eq!(
1141 v["peer"]["age_secs"], 0,
1142 "a transition frame is fresh by construction: {v}"
1143 );
1144 let back: StreamFrame = serde_json::from_value(v).unwrap();
1145 assert_eq!(back, frame);
1146 }
1147
1148 #[test]
1149 fn peer_reachability_serde_is_additive() {
1150 let r = PeerReachability {
1151 name: "bob".into(),
1152 reachable: true,
1153 rtt_ms: Some(42),
1154 age_secs: Some(3),
1155 meta: String::new(),
1156 principal: None,
1157 path: Default::default(),
1158 };
1159 let v = serde_json::to_value(&r).unwrap();
1160 assert_eq!(v["name"], "bob");
1161 assert_eq!(v["reachable"], true);
1162 assert_eq!(v["rtt_ms"], 42);
1163 assert_eq!(v["age_secs"], 3);
1164 // Never-probed peer: optionals elided, not null.
1165 let unknown = PeerReachability {
1166 name: "carol".into(),
1167 reachable: false,
1168 rtt_ms: None,
1169 age_secs: None,
1170 meta: String::new(),
1171 principal: None,
1172 path: Default::default(),
1173 };
1174 let uv = serde_json::to_value(&unknown).unwrap();
1175 assert!(uv.get("rtt_ms").is_none() && uv.get("age_secs").is_none());
1176 // An older StatusResult (no reachability field) still deserializes.
1177 let old = serde_json::json!({"stack_version":"0.1.0","services":[],"peers":[]});
1178 let s: StatusResult = serde_json::from_value(old).unwrap();
1179 assert!(s.reachability.is_empty());
1180 }
1181
1182 #[test]
1183 fn subscribe_method_tag_resolves() {
1184 let req = serde_json::to_value(Request::Subscribe).unwrap();
1185 assert_eq!(method_of(&req), Some("subscribe"));
1186 }
1187
1188 // --- #34: params structs reject unknown fields (the `{service: "kb"}` silent-accept bug) ---
1189
1190 #[test]
1191 fn invite_params_reject_singular_service_typo() {
1192 // The reported bug: `{"service":"kb"}` (singular) used to deserialize to
1193 // InviteParams { services: [] } and mint a grants-nothing invite that looked
1194 // successful. With deny_unknown_fields the typo is a loud parse error instead.
1195 let err = serde_json::from_value::<InviteParams>(serde_json::json!({"service": "kb"}));
1196 assert!(
1197 err.is_err(),
1198 "an unknown `service` key must be rejected, not silently ignored"
1199 );
1200 // The correct plural shape still parses.
1201 let ok: InviteParams =
1202 serde_json::from_value(serde_json::json!({"services": ["kb"]})).unwrap();
1203 assert_eq!(ok.services, vec!["kb".to_string()]);
1204 }
1205
1206 #[test]
1207 fn open_session_params_reject_unknown_field() {
1208 let err = serde_json::from_value::<OpenSessionParams>(
1209 serde_json::json!({"peer": "a", "service": "b", "nonsense": 1}),
1210 );
1211 assert!(err.is_err(), "unknown params keys must be rejected");
1212 }
1213
1214 #[test]
1215 fn set_app_metadata_request_carries_the_method_tag() {
1216 let r = Request::SetAppMetadata(SetAppMetadataParams {
1217 metadata: "v=1.2.3".into(),
1218 });
1219 let v = serde_json::to_value(&r).unwrap();
1220 assert_eq!(v["method"], "set_app_metadata");
1221 assert_eq!(v["params"]["metadata"], "v=1.2.3");
1222 assert_eq!(method_of(&v), Some("set_app_metadata"));
1223 }
1224
1225 #[test]
1226 fn set_app_metadata_params_reject_unknown_field() {
1227 let err = serde_json::from_value::<SetAppMetadataParams>(
1228 serde_json::json!({"metadata": "x", "nonsense": 1}),
1229 );
1230 assert!(err.is_err(), "unknown params keys must be rejected");
1231 }
1232
1233 /// `PresencePeer.meta` is additive — an older payload (no meta) still deserializes, and an
1234 /// empty meta does not serialize.
1235 #[test]
1236 fn peer_info_principal_is_additive() {
1237 // An older payload (no principal) still deserializes; empty does not serialize.
1238 let old = serde_json::json!({"name": "bob", "services": ["notes"]});
1239 let p: PeerInfo = serde_json::from_value(old).unwrap();
1240 assert_eq!(p.principal, None);
1241 assert!(serde_json::to_value(&p).unwrap().get("principal").is_none());
1242 // A bound peer carries BOTH the person user_id AND the device principal (#41).
1243 let full = PeerInfo {
1244 name: "bob".into(),
1245 services: vec!["notes".into()],
1246 user_id: Some("b64u:BOB".into()),
1247 principal: Some("eid:0707".into()),
1248 };
1249 let back: PeerInfo = serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
1250 assert_eq!(back.user_id.as_deref(), Some("b64u:BOB"));
1251 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
1252 }
1253
1254 #[test]
1255 fn peer_reachability_principal_is_additive() {
1256 // Older payload (no principal) still deserializes; empty does not serialize; a set
1257 // value round-trips alongside the #40 meta so an embedder joins on the principal.
1258 let old = serde_json::json!({"name": "bob", "reachable": true});
1259 let r: PeerReachability = serde_json::from_value(old).unwrap();
1260 assert_eq!(r.principal, None);
1261 assert!(serde_json::to_value(&r).unwrap().get("principal").is_none());
1262 let full = PeerReachability {
1263 name: "bob".into(),
1264 reachable: true,
1265 rtt_ms: Some(12),
1266 age_secs: Some(3),
1267 meta: "v=1.2.3".into(),
1268 principal: Some("eid:0707".into()),
1269 path: Default::default(),
1270 };
1271 let back: PeerReachability =
1272 serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
1273 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
1274 assert_eq!(back.meta, "v=1.2.3");
1275 }
1276
1277 #[test]
1278 fn peer_reachability_meta_is_additive() {
1279 // An older payload (no meta) still deserializes; an empty meta does not serialize.
1280 let old = serde_json::json!({"name": "bob", "reachable": true});
1281 let r: PeerReachability = serde_json::from_value(old).unwrap();
1282 assert_eq!(r.meta, "");
1283 assert!(serde_json::to_value(&r).unwrap().get("meta").is_none());
1284 // A set value round-trips.
1285 let with = PeerReachability {
1286 name: "bob".into(),
1287 reachable: true,
1288 rtt_ms: Some(12),
1289 age_secs: Some(3),
1290 meta: "v=1.2.3".into(),
1291 principal: None,
1292 path: Default::default(),
1293 };
1294 let back: PeerReachability =
1295 serde_json::from_value(serde_json::to_value(&with).unwrap()).unwrap();
1296 assert_eq!(back.meta, "v=1.2.3");
1297 }
1298
1299 #[test]
1300 fn presence_peer_meta_is_additive() {
1301 let old = serde_json::json!({
1302 "user_id": "b64u:A", "device_label": "laptop", "role": "primary", "online": true
1303 });
1304 let p: PresencePeer = serde_json::from_value(old).unwrap();
1305 assert_eq!(p.meta, "");
1306 assert!(serde_json::to_value(&p).unwrap().get("meta").is_none());
1307 }
1308
1309 #[test]
1310 fn set_nickname_request_carries_the_method_tag() {
1311 let r = Request::SetNickname(SetNicknameParams {
1312 nickname: "workbench".into(),
1313 });
1314 let v = serde_json::to_value(&r).unwrap();
1315 assert_eq!(v["method"], "set_nickname");
1316 assert_eq!(v["params"]["nickname"], "workbench");
1317 assert_eq!(method_of(&v), Some("set_nickname"));
1318 }
1319
1320 #[test]
1321 fn set_nickname_params_reject_unknown_field() {
1322 let err = serde_json::from_value::<SetNicknameParams>(
1323 serde_json::json!({"nickname": "x", "nonsense": 1}),
1324 );
1325 assert!(err.is_err(), "unknown params keys must be rejected");
1326 }
1327
1328 /// An OLDER daemon's status payload (no `self_nickname`) must still deserialize —
1329 /// the additive-only contract — and an empty name must not serialize at all.
1330 #[test]
1331 fn status_self_nickname_is_additive() {
1332 let old = serde_json::json!({
1333 "stack_version": "0.7.0", "services": [], "peers": []
1334 });
1335 let s: StatusResult = serde_json::from_value(old).unwrap();
1336 assert_eq!(s.self_nickname, "");
1337 let v = serde_json::to_value(&s).unwrap();
1338 assert!(v.get("self_nickname").is_none(), "empty name is skipped");
1339 }
1340
1341 #[test]
1342 fn api_minor_is_present_and_monotonic_from_hello() {
1343 // #34 part 2: a machine-comparable protocol-compat minor, distinct from the
1344 // crate/stack version, additive on the Hello frame.
1345 let h = Hello {
1346 api: API_NAME.into(),
1347 api_version: API_VERSION.into(),
1348 api_minor: API_MINOR,
1349 stack_version: "9.9.9".into(),
1350 };
1351 let v = serde_json::to_value(&h).unwrap();
1352 assert_eq!(v["api_minor"], API_MINOR);
1353 // An OLD Hello without api_minor still deserializes (additive contract).
1354 let old = serde_json::json!({
1355 "api": API_NAME, "api_version": "1.0", "stack_version": "0.4.0"
1356 });
1357 let back: Hello = serde_json::from_value(old).unwrap();
1358 assert_eq!(back.api_minor, 0, "absent api_minor defaults to 0");
1359 }
1360
1361 #[test]
1362 fn hello_result_roundtrips() {
1363 let h = Hello {
1364 api: "mcpmesh-local/1".into(),
1365 api_version: "1.0".into(),
1366 api_minor: 0,
1367 stack_version: "0.1.0".into(),
1368 };
1369 let v = serde_json::to_value(&h).unwrap();
1370 assert_eq!(v["api"], "mcpmesh-local/1");
1371 let back: Hello = serde_json::from_value(v).unwrap();
1372 assert_eq!(back, h);
1373 }
1374
1375 #[test]
1376 fn request_tagged_by_method() {
1377 let r = Request::Status;
1378 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "status");
1379 let r = Request::OpenSession(OpenSessionParams {
1380 peer: "alice".into(),
1381 service: "notes".into(),
1382 });
1383 let v = serde_json::to_value(&r).unwrap();
1384 assert_eq!(v["method"], "open_session");
1385 assert_eq!(v["params"]["peer"], "alice");
1386 }
1387
1388 #[test]
1389 fn parameterless_method_tolerates_params_forms() {
1390 // Omitted and null params deserialize straight into the unit variant.
1391 let omitted: Request =
1392 serde_json::from_value(serde_json::json!({"method": "status"})).unwrap();
1393 assert_eq!(omitted, Request::Status);
1394 let null: Request =
1395 serde_json::from_value(serde_json::json!({"method": "status", "params": null}))
1396 .unwrap();
1397 assert_eq!(null, Request::Status);
1398
1399 // Known limitation: adjacent tagging rejects `params:{}` for a unit variant, so
1400 // the server MUST dispatch on the method string rather than deserialize the whole
1401 // message into `Request`. This is the pattern the daemon's dispatcher uses.
1402 let empty = serde_json::json!({"method": "status", "params": {}});
1403 assert!(serde_json::from_value::<Request>(empty.clone()).is_err());
1404 match method_of(&empty) {
1405 Some("status") => {} // dispatcher resolves Status via the method string
1406 other => panic!("method_of failed to resolve status: {other:?}"),
1407 }
1408 }
1409
1410 #[test]
1411 fn backend_spec_roundtrips() {
1412 let run = BackendSpec::Run {
1413 cmd: vec!["notes-mcp".into(), "--stdio".into()],
1414 env: Default::default(),
1415 cwd: None,
1416 };
1417 let v = serde_json::to_value(&run).unwrap();
1418 assert_eq!(v["run"]["cmd"][0], "notes-mcp");
1419 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), run);
1420
1421 let sock = BackendSpec::Socket {
1422 path: "/run/notes.sock".into(),
1423 };
1424 let v = serde_json::to_value(&sock).unwrap();
1425 assert_eq!(v["socket"]["path"], "/run/notes.sock");
1426 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), sock);
1427 }
1428
1429 #[test]
1430 fn register_service_wire_shape() {
1431 let r = Request::RegisterService(RegisterServiceParams {
1432 name: "notes".into(),
1433 backend: BackendSpec::Run {
1434 cmd: vec!["notes-mcp".into()],
1435 env: Default::default(),
1436 cwd: None,
1437 },
1438 allow: vec!["alice".into()],
1439 ephemeral: false,
1440 });
1441 let v = serde_json::to_value(&r).unwrap();
1442 assert_eq!(
1443 v,
1444 serde_json::json!({
1445 "method": "register_service",
1446 "params": {
1447 "name": "notes",
1448 "backend": {"run": {"cmd": ["notes-mcp"]}},
1449 "allow": ["alice"],
1450 }
1451 })
1452 );
1453 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1454 }
1455
1456 #[test]
1457 fn invite_request_and_result_roundtrip() {
1458 // Request::Invite → `{ "method": "invite", "params": { "services": [...] } }`.
1459 let r = Request::Invite(InviteParams {
1460 services: vec!["notes".into(), "kb".into()],
1461 app_label: None,
1462 });
1463 let v = serde_json::to_value(&r).unwrap();
1464 assert_eq!(v["method"], "invite");
1465 assert_eq!(v["params"]["services"][0], "notes");
1466 assert_eq!(v["params"]["services"][1], "kb");
1467 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1468 // method_of resolves the tag generically (no per-variant arm).
1469 assert_eq!(
1470 method_of(&serde_json::json!({"method": "invite", "params": {"services": []}})),
1471 Some("invite")
1472 );
1473
1474 // InviteResult carries the copyable line + expiry (surface #2 pairing artifact).
1475 let res = InviteResult {
1476 invite_line: "mcpmesh-invite:ABCDEF".into(),
1477 expires_at_epoch: 1_800_000_000,
1478 };
1479 let v = serde_json::to_value(&res).unwrap();
1480 assert_eq!(v["invite_line"], "mcpmesh-invite:ABCDEF");
1481 assert_eq!(v["expires_at_epoch"], 1_800_000_000u64);
1482 assert_eq!(serde_json::from_value::<InviteResult>(v).unwrap(), res);
1483 }
1484
1485 #[test]
1486 fn pair_request_and_result_roundtrip() {
1487 // Request::Pair → `{ "method": "pair", "params": { "invite_line": "..." } }`.
1488 let r = Request::Pair(PairParams {
1489 invite_line: "mcpmesh-invite:ABCDEF".into(),
1490 });
1491 let v = serde_json::to_value(&r).unwrap();
1492 assert_eq!(v["method"], "pair");
1493 assert_eq!(v["params"]["invite_line"], "mcpmesh-invite:ABCDEF");
1494 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1495 // method_of resolves the tag generically (no per-variant arm).
1496 assert_eq!(
1497 method_of(&serde_json::json!({"method": "pair", "params": {"invite_line": "x"}})),
1498 Some("pair")
1499 );
1500
1501 // PairResult carries the inviter's suggested nickname + the display-only SAS words +
1502 // the granted services (the porcelain renders each as `<peer>/<service>`).
1503 let res = PairResult {
1504 peer_nickname: "alice".into(),
1505 sas_code: "tango-fig-cabbage".into(),
1506 services: vec!["notes".into(), "kb".into()],
1507 app_label: None,
1508 peer_user_id: None,
1509 };
1510 let v = serde_json::to_value(&res).unwrap();
1511 assert_eq!(v["peer_nickname"], "alice");
1512 assert_eq!(v["sas_code"], "tango-fig-cabbage");
1513 assert_eq!(v["services"][0], "notes");
1514 assert_eq!(v["services"][1], "kb");
1515 assert_eq!(serde_json::from_value::<PairResult>(v).unwrap(), res);
1516
1517 // Additive-only: a PairResult minted by an older daemon (no `services` key) still
1518 // deserializes — the `#[serde(default)]` fills it with an empty list.
1519 let old_shape = serde_json::json!({
1520 "peer_nickname": "alice",
1521 "sas_code": "tango-fig-cabbage",
1522 });
1523 let back: PairResult = serde_json::from_value(old_shape).unwrap();
1524 assert_eq!(back.peer_nickname, "alice");
1525 assert!(back.services.is_empty());
1526 }
1527
1528 #[test]
1529 fn roster_install_request_and_result_roundtrip() {
1530 // Request::RosterInstall → `{ "method": "roster_install", "params": { "path": ...,
1531 // "org_root_pk": ... } }`. The optional pk is present on the first-install shape.
1532 let r = Request::RosterInstall(RosterInstallParams {
1533 path: "/tmp/roster.json".into(),
1534 org_root_pk: Some("b64u:AAAA".into()),
1535 });
1536 let v = serde_json::to_value(&r).unwrap();
1537 assert_eq!(v["method"], "roster_install");
1538 assert_eq!(v["params"]["path"], "/tmp/roster.json");
1539 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
1540 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1541 // method_of resolves the tag generically (no per-variant arm).
1542 assert_eq!(
1543 method_of(&serde_json::json!({"method": "roster_install", "params": {"path": "/x"}})),
1544 Some("roster_install")
1545 );
1546
1547 // When the pk is omitted (a subsequent install using the pinned value), it is
1548 // `skip_serializing_if`-dropped from the wire and deserializes back to `None`.
1549 let omit = Request::RosterInstall(RosterInstallParams {
1550 path: "/tmp/roster.json".into(),
1551 org_root_pk: None,
1552 });
1553 let v = serde_json::to_value(&omit).unwrap();
1554 assert!(
1555 v["params"].get("org_root_pk").is_none(),
1556 "an omitted org_root_pk must not appear on the wire: {v}"
1557 );
1558 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), omit);
1559
1560 // RosterInstallResult carries org_id + serial + severed count (roster-status vocabulary).
1561 let res = RosterInstallResult {
1562 org_id: "acme".into(),
1563 serial: 42,
1564 severed: 1,
1565 };
1566 let v = serde_json::to_value(&res).unwrap();
1567 assert_eq!(v["org_id"], "acme");
1568 assert_eq!(v["serial"], 42u64);
1569 assert_eq!(v["severed"], 1u32);
1570 assert_eq!(
1571 serde_json::from_value::<RosterInstallResult>(v).unwrap(),
1572 res
1573 );
1574
1575 // Additive-only: a result minted by an older daemon (no `severed` key) still
1576 // deserializes — the `#[serde(default)]` fills it with 0.
1577 let old_shape = serde_json::json!({ "org_id": "acme", "serial": 7 });
1578 let back: RosterInstallResult = serde_json::from_value(old_shape).unwrap();
1579 assert_eq!(back.serial, 7);
1580 assert_eq!(back.severed, 0);
1581 }
1582
1583 #[test]
1584 fn org_join_request_and_result_roundtrip() {
1585 // Request::OrgJoin → `{ "method": "org_join", "params": { org_id, org_root_pk, user_id,
1586 // user_key } }`. `user_key` is a LOCAL path string (the key never crosses the API).
1587 let r = Request::OrgJoin(OrgJoinParams {
1588 org_id: "acme".into(),
1589 org_root_pk: "b64u:AAAA".into(),
1590 user_id: "alice".into(),
1591 user_key: "/home/alice/.config/mcpmesh/user.key".into(),
1592 });
1593 let v = serde_json::to_value(&r).unwrap();
1594 assert_eq!(v["method"], "org_join");
1595 assert_eq!(v["params"]["org_id"], "acme");
1596 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
1597 assert_eq!(v["params"]["user_id"], "alice");
1598 assert_eq!(
1599 v["params"]["user_key"],
1600 "/home/alice/.config/mcpmesh/user.key"
1601 );
1602 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1603 // method_of resolves the tag generically (no per-variant arm).
1604 assert_eq!(
1605 method_of(&serde_json::json!({"method": "org_join", "params": {"org_id": "x"}})),
1606 Some("org_join")
1607 );
1608
1609 // OrgJoinResult echoes the pinned org id (surface-clean; the fingerprint is porcelain-side).
1610 let res = OrgJoinResult {
1611 org_id: "acme".into(),
1612 };
1613 let v = serde_json::to_value(&res).unwrap();
1614 assert_eq!(v["org_id"], "acme");
1615 assert_eq!(serde_json::from_value::<OrgJoinResult>(v).unwrap(), res);
1616 }
1617
1618 #[test]
1619 fn set_roster_url_request_roundtrip() {
1620 // Request::SetRosterUrl → `{ "method": "set_roster_url", "params": { "url": "..." } }`.
1621 let r = Request::SetRosterUrl(SetRosterUrlParams {
1622 url: "https://intranet.acme.com/roster.json".into(),
1623 });
1624 let v = serde_json::to_value(&r).unwrap();
1625 assert_eq!(v["method"], "set_roster_url");
1626 assert_eq!(v["params"]["url"], "https://intranet.acme.com/roster.json");
1627 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1628 assert_eq!(
1629 method_of(&serde_json::json!({"method": "set_roster_url", "params": {"url": "x"}})),
1630 Some("set_roster_url")
1631 );
1632 }
1633
1634 #[test]
1635 fn peer_remove_request_roundtrip() {
1636 // Request::PeerRemove → `{ "method": "peer_remove", "params": { "nickname": "..." } }`.
1637 let r = Request::PeerRemove(PeerRemoveParams {
1638 nickname: "bob".into(),
1639 });
1640 let v = serde_json::to_value(&r).unwrap();
1641 assert_eq!(v["method"], "peer_remove");
1642 assert_eq!(v["params"]["nickname"], "bob");
1643 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1644 // method_of resolves the tag generically (no per-variant arm).
1645 assert_eq!(
1646 method_of(&serde_json::json!({"method": "peer_remove", "params": {"nickname": "bob"}})),
1647 Some("peer_remove")
1648 );
1649 }
1650
1651 /// The reserved/internal `peer_add` rides the SAME typed vocabulary as every other method —
1652 /// `{ "method": "peer_add", "params": { nickname, endpoint_id, allow } }` — with `allow`
1653 /// defaulting to empty when absent.
1654 #[test]
1655 fn peer_add_request_roundtrip() {
1656 let r = Request::PeerAdd(PeerAddParams {
1657 nickname: "bob".into(),
1658 endpoint_id: "96246d3f".into(),
1659 allow: vec!["notes".into()],
1660 });
1661 let v = serde_json::to_value(&r).unwrap();
1662 assert_eq!(v["method"], "peer_add");
1663 assert_eq!(v["params"]["nickname"], "bob");
1664 assert_eq!(v["params"]["endpoint_id"], "96246d3f");
1665 assert_eq!(v["params"]["allow"][0], "notes");
1666 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1667 // An absent allow list deserializes to empty (the server-side tolerance).
1668 let p: PeerAddParams =
1669 serde_json::from_value(serde_json::json!({"nickname": "bob", "endpoint_id": "x"}))
1670 .unwrap();
1671 assert!(p.allow.is_empty());
1672 }
1673
1674 #[test]
1675 fn peer_rename_request_roundtrip() {
1676 // By user_id (renames all of a person's devices in one op).
1677 let r = Request::PeerRename(PeerRenameParams {
1678 user_id: Some("b64u:BOB".into()),
1679 nickname: None,
1680 to: "Bobby".into(),
1681 });
1682 let v = serde_json::to_value(&r).unwrap();
1683 assert_eq!(v["method"], "peer_rename");
1684 assert_eq!(v["params"]["user_id"], "b64u:BOB");
1685 assert_eq!(v["params"]["to"], "Bobby");
1686 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1687 // A provisional contact is renamed by nickname; omitted user_id defaults to None.
1688 assert_eq!(
1689 method_of(
1690 &serde_json::json!({"method": "peer_rename", "params": {"nickname": "carol", "to": "Carol"}})
1691 ),
1692 Some("peer_rename")
1693 );
1694 }
1695
1696 #[test]
1697 fn status_result_roundtrips() {
1698 // Pure-pairing daemon: `roster` is None — absent from the wire (skip_serializing_if) and an
1699 // older payload with no `roster` key still deserializes to None (serde default).
1700 let s = StatusResult {
1701 stack_version: "0.1.0".into(),
1702 services: vec![ServiceInfo {
1703 name: "notes".into(),
1704 allow: vec!["alice".into()],
1705 allow_display: vec![],
1706 backend: BackendKind::Run,
1707 ephemeral: false,
1708 }],
1709 peers: vec![PeerInfo {
1710 name: "alice".into(),
1711 services: vec!["notes".into()],
1712 // A paired peer that proved a self-sovereign user_id at pairing (surface-clean id).
1713 user_id: Some("b64u:alicepk".into()),
1714 principal: None,
1715 }],
1716 roster: None,
1717 presence: vec![],
1718 self_user_id: Some("b64u:selfpk".into()),
1719 recent_pairings: vec![],
1720 reachability: vec![],
1721 self_nickname: String::new(),
1722 };
1723 let v = serde_json::to_value(&s).unwrap();
1724 assert_eq!(v["services"][0]["backend"], "run");
1725 // The additive identity fields ride the wire when present.
1726 assert_eq!(v["peers"][0]["user_id"], "b64u:alicepk");
1727 assert_eq!(v["self_user_id"], "b64u:selfpk");
1728 assert!(
1729 v.get("roster").is_none(),
1730 "an absent roster must not appear on the wire: {v}"
1731 );
1732 assert!(
1733 v.get("presence").is_none(),
1734 "an empty presence must not appear on the wire: {v}"
1735 );
1736 assert!(
1737 v.get("recent_pairings").is_none(),
1738 "an empty recent_pairings must not appear on the wire: {v}"
1739 );
1740 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1741
1742 // A payload minted by an older daemon (no `roster`/`presence`/identity keys) still
1743 // deserializes — the identity fields default to None / a nickname-only peer.
1744 let old_shape = serde_json::json!({
1745 "stack_version": "0.1.0",
1746 "services": [],
1747 "peers": [{ "name": "bob", "services": [] }],
1748 });
1749 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
1750 assert!(back.roster.is_none());
1751 assert!(back.presence.is_empty());
1752 assert!(back.self_user_id.is_none());
1753 assert!(back.peers[0].user_id.is_none());
1754 assert!(back.recent_pairings.is_empty());
1755
1756 // Roster daemon: a Some(RosterStatus) + an advisory presence list round-trip. `presence`
1757 // carries FLAT vocabulary only (user_id/device_label/role/online) — no EndpointId/key.
1758 let s = StatusResult {
1759 stack_version: "0.1.0".into(),
1760 services: vec![],
1761 peers: vec![],
1762 roster: Some(RosterStatus {
1763 org_id: "acme".into(),
1764 serial: 42,
1765 state: "approved".into(),
1766 org_root_fingerprint: "tango-fig-cabbage-anchor".into(),
1767 }),
1768 presence: vec![
1769 PresencePeer {
1770 user_id: "alice".into(),
1771 device_label: "laptop".into(),
1772 role: "primary".into(),
1773 online: true,
1774 meta: String::new(),
1775 },
1776 PresencePeer {
1777 user_id: "alice".into(),
1778 device_label: "desktop".into(),
1779 role: "mirror".into(),
1780 online: false,
1781 meta: String::new(),
1782 },
1783 ],
1784 self_user_id: None,
1785 recent_pairings: vec![],
1786 reachability: vec![],
1787 self_nickname: String::new(),
1788 };
1789 let v = serde_json::to_value(&s).unwrap();
1790 assert_eq!(v["roster"]["org_id"], "acme");
1791 assert_eq!(v["roster"]["serial"], 42u64);
1792 assert_eq!(v["roster"]["state"], "approved");
1793 assert_eq!(
1794 v["roster"]["org_root_fingerprint"],
1795 "tango-fig-cabbage-anchor"
1796 );
1797 assert_eq!(v["presence"][0]["user_id"], "alice");
1798 assert_eq!(v["presence"][0]["device_label"], "laptop");
1799 assert_eq!(v["presence"][0]["role"], "primary");
1800 assert_eq!(v["presence"][0]["online"], true);
1801 assert_eq!(v["presence"][1]["online"], false);
1802 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1803 }
1804
1805 /// The `recent_pairings` status field is ADDITIVE: a populated list round-trips with
1806 /// the flat `{peer_nickname, sas_code, paired_at_epoch}` shape (nickname + SAS words + epoch —
1807 /// never an EndpointId), an empty list is dropped from the wire, and a payload minted by an
1808 /// older daemon (no key at all) still deserializes to empty.
1809 #[test]
1810 fn recent_pairings_are_additive_on_status() {
1811 let s = StatusResult {
1812 stack_version: "0.1.0".into(),
1813 services: vec![],
1814 peers: vec![],
1815 roster: None,
1816 presence: vec![],
1817 self_user_id: None,
1818 recent_pairings: vec![RecentPairing {
1819 peer_nickname: "bob".into(),
1820 sas_code: "tango-fig-cabbage".into(),
1821 paired_at_epoch: 1_800_000_000,
1822 }],
1823 reachability: vec![],
1824 self_nickname: String::new(),
1825 };
1826 let v = serde_json::to_value(&s).unwrap();
1827 assert_eq!(v["recent_pairings"][0]["peer_nickname"], "bob");
1828 assert_eq!(v["recent_pairings"][0]["sas_code"], "tango-fig-cabbage");
1829 assert_eq!(v["recent_pairings"][0]["paired_at_epoch"], 1_800_000_000u64);
1830 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1831
1832 // A payload minted by an OLDER daemon (no `recent_pairings` key) still deserializes —
1833 // the `#[serde(default)]` fills it with an empty list.
1834 let old_shape = serde_json::json!({
1835 "stack_version": "0.1.0",
1836 "services": [],
1837 "peers": [],
1838 });
1839 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
1840 assert!(back.recent_pairings.is_empty());
1841 }
1842
1843 #[test]
1844 fn blob_requests_and_results_roundtrip() {
1845 // BlobPublish → { method, params: { scope, path } }.
1846 let r = Request::BlobPublish(BlobPublishParams {
1847 scope: "docs".into(),
1848 path: "/tmp/a.bin".into(),
1849 });
1850 let v = serde_json::to_value(&r).unwrap();
1851 assert_eq!(v["method"], "blob_publish");
1852 assert_eq!(v["params"]["scope"], "docs");
1853 assert_eq!(v["params"]["path"], "/tmp/a.bin");
1854 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1855
1856 // BlobGrant → { method, params: { scope, principal } }.
1857 // #62: the two withdrawal verbs' wire tags. A wrong dispatch string or a swapped param
1858 // would otherwise ship undetected — the e2e test calls the provider directly and never
1859 // crosses JSON-RPC.
1860 let rev = Request::BlobRevoke(BlobRevokeParams {
1861 scope: "photos".into(),
1862 principals: vec!["alice".into()],
1863 });
1864 let v = serde_json::to_value(&rev).unwrap();
1865 assert_eq!(v["method"], "blob_revoke");
1866 assert_eq!(v["params"]["principals"][0], "alice");
1867 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), rev);
1868
1869 let unp = Request::BlobUnpublish(BlobUnpublishParams {
1870 scope: "photos".into(),
1871 hash: "abc123".into(),
1872 });
1873 let v = serde_json::to_value(&unp).unwrap();
1874 assert_eq!(v["method"], "blob_unpublish");
1875 assert_eq!(v["params"]["hash"], "abc123");
1876 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), unp);
1877
1878 let r = Request::BlobGrant(BlobGrantParams {
1879 scope: "docs".into(),
1880 principal: "alice".into(),
1881 });
1882 let v = serde_json::to_value(&r).unwrap();
1883 assert_eq!(v["method"], "blob_grant");
1884 assert_eq!(v["params"]["principal"], "alice");
1885 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1886
1887 // BlobList is parameterless (method_of resolves it).
1888 assert_eq!(
1889 method_of(&serde_json::json!({"method": "blob_list"})),
1890 Some("blob_list")
1891 );
1892
1893 // BlobFetch → { method, params: { ticket, dest_path } }.
1894 let r = Request::BlobFetch(BlobFetchParams {
1895 ticket: "blobAAA".into(),
1896 dest_path: "/tmp/out.bin".into(),
1897 });
1898 let v = serde_json::to_value(&r).unwrap();
1899 assert_eq!(v["method"], "blob_fetch");
1900 assert_eq!(v["params"]["ticket"], "blobAAA");
1901 assert_eq!(v["params"]["dest_path"], "/tmp/out.bin");
1902 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1903
1904 // BlobPublishResult carries the ticket + hash (blob-reference vocabulary).
1905 let res = BlobPublishResult {
1906 ticket: "blobAAA".into(),
1907 hash: "ab".repeat(32),
1908 };
1909 let v = serde_json::to_value(&res).unwrap();
1910 assert_eq!(v["ticket"], "blobAAA");
1911 assert_eq!(serde_json::from_value::<BlobPublishResult>(v).unwrap(), res);
1912
1913 // BlobScopeList carries flat (name, hashes, grants) — no EndpointId/key leakage.
1914 let res = BlobScopeList {
1915 scopes: vec![ScopeInfo {
1916 name: "docs".into(),
1917 hashes: vec!["ab".repeat(32)],
1918 grants: vec!["alice".into()],
1919 withdrawn: vec![],
1920 }],
1921 };
1922 let v = serde_json::to_value(&res).unwrap();
1923 assert_eq!(v["scopes"][0]["name"], "docs");
1924 assert_eq!(v["scopes"][0]["grants"][0], "alice");
1925 assert_eq!(serde_json::from_value::<BlobScopeList>(v).unwrap(), res);
1926
1927 // BlobFetchResult carries the verified hash + byte length.
1928 let res = BlobFetchResult {
1929 hash: "ab".repeat(32),
1930 bytes_len: 4194304,
1931 };
1932 let v = serde_json::to_value(&res).unwrap();
1933 assert_eq!(v["bytes_len"], 4194304u64);
1934 assert_eq!(serde_json::from_value::<BlobFetchResult>(v).unwrap(), res);
1935 }
1936
1937 /// The three `subscribe` frame shapes round-trip with the documented `type`-tagged wire form
1938 /// (docs/local-protocol.md "Live event stream"): `snapshot` carries the flat session/reachability
1939 /// lists, `event` delegates through the `Box` so the record's fields sit VERBATIM under
1940 /// `record` (one schema with the JSONL log), and `lagged` carries the dropped count.
1941 #[test]
1942 fn stream_frames_roundtrip_with_the_documented_tags() {
1943 let snap = StreamFrame::Snapshot {
1944 active_sessions: vec![ActiveSession {
1945 peer: "bob".into(),
1946 service: "notes".into(),
1947 opened_at: 1_751_760_000,
1948 }],
1949 reachability: vec![PeerReachability {
1950 name: "bob".into(),
1951 reachable: true,
1952 rtt_ms: Some(42),
1953 age_secs: Some(3),
1954 meta: String::new(),
1955 principal: None,
1956 path: Default::default(),
1957 }],
1958 };
1959 let v = serde_json::to_value(&snap).unwrap();
1960 assert_eq!(v["type"], "snapshot");
1961 assert_eq!(v["active_sessions"][0]["peer"], "bob");
1962 assert_eq!(v["active_sessions"][0]["opened_at"], 1_751_760_000i64);
1963 assert_eq!(v["reachability"][0]["name"], "bob");
1964 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), snap);
1965
1966 let event = StreamFrame::Event {
1967 record: Box::new(AuditRecord::session_open(
1968 "2026-07-03T14:02:11.480Z".into(),
1969 Some("bob".into()),
1970 "notes".into(),
1971 )),
1972 };
1973 let v = serde_json::to_value(&event).unwrap();
1974 assert_eq!(v["type"], "event");
1975 // The record's fields ride verbatim under `record` — no Box indirection on the wire.
1976 assert_eq!(v["record"]["kind"], "session_open");
1977 assert_eq!(v["record"]["peer"], "bob");
1978 assert_eq!(v["record"]["service"], "notes");
1979 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), event);
1980
1981 let lagged = StreamFrame::Lagged { dropped: 12 };
1982 let v = serde_json::to_value(&lagged).unwrap();
1983 assert_eq!(v, serde_json::json!({ "type": "lagged", "dropped": 12 }));
1984 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), lagged);
1985 }
1986
1987 /// A frame minted by a NEWER daemon (an unknown `type`) fails to deserialize rather than
1988 /// mis-parsing — the typed stream surface is closed; a forward-compatible consumer reads the
1989 /// raw `Value` stream instead (`ControlClient::open_stream`).
1990 #[test]
1991 fn unknown_stream_frame_type_is_rejected() {
1992 let future = serde_json::json!({ "type": "future_kind", "x": 1 });
1993 assert!(serde_json::from_value::<StreamFrame>(future).is_err());
1994 }
1995
1996 #[test]
1997 fn audit_summary_request_and_result_roundtrip() {
1998 // Request::AuditSummary is parameterless → `{ "method": "audit_summary" }`. Like Status, it
1999 // tolerates omitted/null params; the server dispatches on the method string (method_of).
2000 let r = Request::AuditSummary;
2001 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "audit_summary");
2002 assert_eq!(
2003 method_of(&serde_json::json!({"method": "audit_summary"})),
2004 Some("audit_summary")
2005 );
2006
2007 // AuditSummaryResult carries LOCAL per-peer / per-service session counts (nicknames + service
2008 // names only — never endpoints/transport terms) + a total. Tuples mirror kb's
2009 // InsightResponse.per_peer_contribution: `["bob", 2]` on the wire.
2010 let res = AuditSummaryResult {
2011 per_peer: vec![("alice".into(), 1), ("bob".into(), 2)],
2012 per_service: vec![("kb".into(), 1), ("notes".into(), 3)],
2013 total_sessions: 4,
2014 };
2015 let v = serde_json::to_value(&res).unwrap();
2016 assert_eq!(v["per_peer"][1][0], "bob");
2017 assert_eq!(v["per_peer"][1][1], 2u64);
2018 assert_eq!(v["per_service"][1][0], "notes");
2019 assert_eq!(v["total_sessions"], 4u64);
2020 assert_eq!(
2021 serde_json::from_value::<AuditSummaryResult>(v).unwrap(),
2022 res
2023 );
2024
2025 // Additive-only: a result minted by an older daemon (no `total_sessions` key) still
2026 // deserializes — the `#[serde(default)]` fills it with 0.
2027 let old_shape = serde_json::json!({ "per_peer": [], "per_service": [] });
2028 let back: AuditSummaryResult = serde_json::from_value(old_shape).unwrap();
2029 assert_eq!(back.total_sessions, 0);
2030 assert!(back.per_peer.is_empty());
2031 }
2032}