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(BlobListParams),
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 /// Size of `hashes` — always present, even when `counts_only` empties the vector (#84b).
685 #[serde(default)]
686 pub hash_count: usize,
687 /// Size of `grants`.
688 #[serde(default)]
689 pub grant_count: usize,
690 /// Size of `withdrawn`.
691 #[serde(default)]
692 pub withdrawn_count: usize,
693}
694
695/// Params of [`Request::BlobList`] (#84b). ALL optional — `blob_list {}` still works, which
696/// matters because the verb took no params before `api_minor` 20.
697///
698/// A DEFAULT LIMIT applies when `limit` is absent. Deliberate: unpaged, `blob_list` renders every
699/// scope into one frame against the 16 MiB cap; past it the CLIENT rejects the frame as malformed.
700/// The control surface carries no strike bound, so the connection survives — but the caller gets an
701/// opaque failure with no way to page, which is unusable rather than merely large.
702#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
703#[serde(default, deny_unknown_fields)]
704pub struct BlobListParams {
705 /// EXACT scope name, never a prefix.
706 pub scope: Option<String>,
707 /// Only scopes containing this hash; the rendering you send is normalized first.
708 pub hash: Option<String>,
709 pub limit: Option<usize>,
710 pub offset: Option<usize>,
711 /// Omit `hashes`/`grants`/`withdrawn`, keep the counts.
712 pub counts_only: bool,
713}
714
715/// Result of [`Request::BlobList`]: the daemon's scopes. Additive-only.
716#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
717pub struct BlobScopeList {
718 pub scopes: Vec<ScopeInfo>,
719 /// Scopes matching the filter BEFORE `limit`/`offset` (#84b). Without this you cannot tell a
720 /// complete answer from a clipped one.
721 #[serde(default)]
722 pub total: usize,
723 /// True when more scopes matched than were returned. Page with `offset` to see the rest.
724 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
725 pub truncated: bool,
726}
727
728/// Result of [`Request::BlobFetch`]: the verified hash + byte length written to `dest_path`.
729/// Additive-only.
730#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
731pub struct BlobFetchResult {
732 pub hash: String,
733 pub bytes_len: u64,
734}
735
736/// Result of [`Request::AuditSummary`]: LOCAL per-peer / per-service session counts
737/// aggregated from this node's OWN audit log — NEVER transmitted (local-only). Surface-clean:
738/// peer names are nicknames / user_ids (NEVER EndpointIds), service names are the registered
739/// service names (NEVER transport vocabulary). A "session" is one `SessionOpen` record. `per_peer` /
740/// `per_service` are sorted ascending by name (deterministic). Tuples mirror kb's
741/// `InsightResponse::per_peer_contribution` — `["bob", 2]` on the wire.
742///
743/// Additive-only: any future field MUST land as
744/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
745#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
746pub struct AuditSummaryResult {
747 /// Sessions opened per peer (nickname). A session with no attributed peer is NOT counted here (no
748 /// peer to attribute) but IS in `total_sessions`.
749 pub per_peer: Vec<(String, u64)>,
750 /// Sessions opened per registered service name.
751 pub per_service: Vec<(String, u64)>,
752 /// Total sessions opened (every `SessionOpen` record, including peer-less ones).
753 #[serde(default)]
754 pub total_sessions: u64,
755}
756
757/// Result of an [`Request::Invite`] request: the copyable `mcpmesh-invite:` artifact
758/// (the ONE pairing artifact deliberately carved out of the
759/// transport-vocabulary blocklist, so this is NOT a transport-vocab leak) plus its
760/// absolute expiry in epoch seconds (≤ now + 24h).
761///
762/// `invite` returns BEFORE any redemption, so the SAS — which is derived from the redeemer's
763/// endpoint id, unknown until they redeem — cannot appear here. The inviter reads its side of
764/// the SAS from [`StatusResult::recent_pairings`] once a redemption completes (a `trust`/`pair`
765/// frame on the live [`StreamFrame`] stream signals that moment). See the "embedding the pairing
766/// ceremony" note in `docs/local-protocol.md` (#35).
767///
768/// Additive-only: any future field MUST land as `#[serde(default, skip_serializing_if = ...)]`
769/// so older payloads still deserialize.
770#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
771pub struct InviteResult {
772 /// The `mcpmesh-invite:<base32>` line, copied out-of-band to the redeemer.
773 pub invite_line: String,
774 /// When the invite expires (epoch seconds); the daemon burns it at redemption or expiry.
775 pub expires_at_epoch: u64,
776}
777
778/// Result of a [`Request::Pair`] request: the inviter's suggested nickname (the
779/// redeemer's local name for the new peer) plus the display-only short authentication
780/// code (SAS) — a few words the human reads aloud to a second channel to
781/// catch a whole-invite forgery / address-swap MITM. The SAS is a pairing-ceremony
782/// artifact (like the invite line), NOT a transport-vocabulary leak.
783///
784/// Additive-only: any future field MUST land as
785/// `#[serde(default, skip_serializing_if = ...)]` so older payloads still deserialize.
786#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
787pub struct PairResult {
788 /// The inviter's suggested nickname (from the invite) — the redeemer's local name for it.
789 pub peer_nickname: String,
790 /// The display-only short authentication code (e.g. `"tango-fig-42"`), shown on both
791 /// sides for the out-of-band human check. Never sent on the wire, never checked
792 /// programmatically.
793 pub sas_code: String,
794 /// The services this pairing granted the redeemer — each mountable as `<peer>/<service>`.
795 /// Populated from the invite (`invite.services`) by the redeemer-side `redeem_invite`, so
796 /// the porcelain can print the "You can mount: alice/notes" line without re-decoding the
797 /// invite. Additive: `#[serde(default, skip_serializing_if = ...)]` so a `PairResult`
798 /// minted by an older daemon (which omits `services`) still deserializes — to an empty list.
799 #[serde(default, skip_serializing_if = "Vec::is_empty")]
800 pub services: Vec<String>,
801 /// The opaque `app_label` the inviter attached at `invite` time (#31), echoed verbatim — or
802 /// absent if none was set. mcpmesh never interprets it; the embedder does. Additive.
803 #[serde(default, skip_serializing_if = "Option::is_none")]
804 pub app_label: Option<String>,
805 /// The inviter's proven self-sovereign `user_id` (`b64u:<user_pk>`), when it presented a
806 /// device→user binding at pairing (#30). This is the STABLE, portable identity the redeemer
807 /// can align with its own — and the same value it may later pass to `open_session` to dial
808 /// this peer by identity rather than by local nickname. `None` if the inviter presented no
809 /// binding (a legacy/keyless peer). Additive.
810 #[serde(default, skip_serializing_if = "Option::is_none")]
811 pub peer_user_id: Option<String>,
812}
813
814/// The event class of an [`AuditRecord`] (the four audit event classes). An additive discriminant on
815/// top of the base record schema: it removes no field and makes the JSONL self-describing so
816/// a consumer can filter by class without guessing from which optional fields are present.
817#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
818#[serde(rename_all = "snake_case")]
819pub enum AuditKind {
820 /// A mesh session opened (a backend was selected for an authenticated peer).
821 /// (A `session_open` with `status:"error"` is a synthesized FAILED-dial marker — no backend
822 /// was reached; it records an attempted-and-failed reach for the telemetry stream.)
823 SessionOpen,
824 /// A mesh session closed (the backend returned / the session tore down).
825 SessionClose,
826 /// One proxied MCP request line (method + tool NAME + args_hash). NEVER carries raw arguments.
827 Request,
828 /// A peer fetched a blob from this node's gated provider (peer + hash + allow/deny).
829 BlobFetch,
830 /// A trust mutation (pair, unpair, roster install/swap, revoke).
831 Trust,
832}
833
834/// One audit record — the union of the event classes, and the `record` payload of a
835/// [`StreamFrame::Event`]. ONE schema for the on-disk JSONL log and the live stream. Every field
836/// beyond `ts`/`kind` is optional and elided when absent (`skip_serializing_if`), so each class
837/// serializes to just its relevant keys (a session record has no `method`; a trust record has no
838/// `bytes_out`).
839///
840/// PRIVACY: the proxied-request record carries `method` + `tool` (NAME only) +
841/// `args_hash` (`"blake3:<hex>"`), and NEVER the raw arguments, the request/response content, or
842/// any tool-output bytes — only a `bytes_out` COUNT and a `status`.
843#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
844pub struct AuditRecord {
845 /// RFC3339 UTC with millisecond precision, e.g. `"2026-07-03T14:02:11.480Z"`. The `YYYY-MM`
846 /// prefix also selects the monthly file (the rotation boundary), so it is always present.
847 pub ts: String,
848 pub kind: AuditKind,
849 /// The gate-resolved authenticated peer (attributed by the endpoint_id-keyed trust gate). Absent on
850 /// local-only events with no remote peer (a manual roster install).
851 #[serde(skip_serializing_if = "Option::is_none")]
852 pub peer: Option<String>,
853 #[serde(skip_serializing_if = "Option::is_none")]
854 pub service: Option<String>,
855 #[serde(skip_serializing_if = "Option::is_none")]
856 pub method: Option<String>,
857 /// The tool NAME only (never its arguments or output) — e.g. `"read_file"` for a `tools/call`.
858 #[serde(skip_serializing_if = "Option::is_none")]
859 pub tool: Option<String>,
860 /// `"blake3:<hex>"` of the request arguments. The raw arguments are NEVER stored.
861 #[serde(skip_serializing_if = "Option::is_none")]
862 pub args_hash: Option<String>,
863 /// Byte COUNT of the response sent back to the peer — a count, never the content.
864 #[serde(skip_serializing_if = "Option::is_none")]
865 pub bytes_out: Option<u64>,
866 /// `"ok"` / `"error"` (proxied request) or `"ok"` / `"denied"` (blob fetch).
867 #[serde(skip_serializing_if = "Option::is_none")]
868 pub status: Option<String>,
869 #[serde(skip_serializing_if = "Option::is_none")]
870 pub latency_ms: Option<u64>,
871 /// Trust-event verb: `"pair"` / `"unpair"` / `"roster_install"` / `"revoke"` (kind == Trust).
872 #[serde(skip_serializing_if = "Option::is_none")]
873 pub event: Option<String>,
874 /// A reference, NEVER content: a blob hash (`BlobFetch`) or a trust-event target such as a
875 /// nickname or `org/serial` (`Trust`).
876 #[serde(skip_serializing_if = "Option::is_none")]
877 pub target: Option<String>,
878}
879
880impl AuditRecord {
881 fn base(ts: String, kind: AuditKind) -> Self {
882 Self {
883 ts,
884 kind,
885 peer: None,
886 service: None,
887 method: None,
888 tool: None,
889 args_hash: None,
890 bytes_out: None,
891 status: None,
892 latency_ms: None,
893 event: None,
894 target: None,
895 }
896 }
897
898 pub fn session_open(ts: String, peer: Option<String>, service: String) -> Self {
899 let mut r = Self::base(ts, AuditKind::SessionOpen);
900 r.peer = peer;
901 r.service = Some(service);
902 r
903 }
904
905 /// Set the record's `status` (`"ok"`/`"error"`/`"denied"`), returning `self` for chaining.
906 /// Marks a synthesized failure record — e.g. the `session_open` for a FAILED dial, which
907 /// reaches no backend and so is never audited by the far side's session guard — without a
908 /// dedicated constructor. DRY: reuses the existing optional `status` field.
909 pub fn with_status(mut self, status: &str) -> Self {
910 self.status = Some(status.into());
911 self
912 }
913
914 pub fn session_close(ts: String, peer: Option<String>, service: String) -> Self {
915 let mut r = Self::base(ts, AuditKind::SessionClose);
916 r.peer = peer;
917 r.service = Some(service);
918 r
919 }
920
921 /// A completed (request→response correlated) proxied line: method + tool NAME + args_hash, plus
922 /// the response's `bytes_out` COUNT, `status`, and `latency_ms`. PRIVACY: `args_hash` is a digest;
923 /// no raw arguments, request/response content, or tool-output bytes are ever passed in.
924 #[allow(clippy::too_many_arguments)]
925 pub fn proxied_request(
926 ts: String,
927 peer: Option<String>,
928 service: String,
929 method: String,
930 tool: Option<String>,
931 args_hash: String,
932 bytes_out: u64,
933 status: String,
934 latency_ms: u64,
935 ) -> Self {
936 let mut r = Self::base(ts, AuditKind::Request);
937 r.peer = peer;
938 r.service = Some(service);
939 r.method = Some(method);
940 r.tool = tool;
941 r.args_hash = Some(args_hash);
942 r.bytes_out = Some(bytes_out);
943 r.status = Some(status);
944 r.latency_ms = Some(latency_ms);
945 r
946 }
947
948 /// A proxied NOTIFICATION line (no `id`, so no response correlates): method + tool + args_hash,
949 /// no `bytes_out`/`status`/`latency_ms`. The line is still recorded — every proxied request is audited.
950 pub fn proxied_notification(
951 ts: String,
952 peer: Option<String>,
953 service: String,
954 method: String,
955 tool: Option<String>,
956 args_hash: String,
957 ) -> Self {
958 let mut r = Self::base(ts, AuditKind::Request);
959 r.peer = peer;
960 r.service = Some(service);
961 r.method = Some(method);
962 r.tool = tool;
963 r.args_hash = Some(args_hash);
964 r
965 }
966
967 pub fn blob_fetch(ts: String, peer: Option<String>, hash: String, status: String) -> Self {
968 let mut r = Self::base(ts, AuditKind::BlobFetch);
969 r.peer = peer;
970 r.target = Some(hash);
971 r.status = Some(status);
972 r
973 }
974
975 pub fn trust(ts: String, event: String, target: Option<String>) -> Self {
976 let mut r = Self::base(ts, AuditKind::Trust);
977 r.event = Some(event);
978 r.target = target;
979 r
980 }
981}
982
983/// One live mesh session, in a [`StreamFrame::Snapshot`]. Surface-clean: `peer` is the
984/// user_id-or-nickname the audit records carry, never an endpoint-id. `opened_at` is epoch seconds.
985#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
986pub struct ActiveSession {
987 pub peer: String,
988 pub service: String,
989 pub opened_at: i64,
990}
991
992/// One frame of the [`Request::Subscribe`] stream (pairing liveness & health telemetry). Tagged on
993/// `type` (snake_case), so a frame is `{"type":"snapshot",...}` / `{"type":"event",...}` /
994/// `{"type":"lagged",...}`. `Event.record` is the [`AuditRecord`] verbatim, so the stream and the
995/// on-disk log carry ONE schema. The daemon serializes these; an embedding consumer deserializes
996/// them (see `docs/local-protocol.md` "Live event stream").
997/// **`#[non_exhaustive]`**: a future frame kind must not break a downstream `match`. Adding
998/// `Reachability` in 0.13.0 DID break exhaustive matches — which is why that release is a MINOR,
999/// per `RELEASING.md`'s pre-1.0 rule that breaking changes bump the minor. Consumers now write a
1000/// `_ =>` arm and later additions are additive for Rust as well as for JSON.
1001#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
1002#[serde(tag = "type", rename_all = "snake_case")]
1003#[non_exhaustive]
1004pub enum StreamFrame {
1005 /// The FIRST frame: a point-in-time picture of the mesh (open sessions + paired-peer
1006 /// reachability) so a fresh subscriber renders immediately without replaying history.
1007 Snapshot {
1008 active_sessions: Vec<ActiveSession>,
1009 reachability: Vec<PeerReachability>,
1010 },
1011 /// A live audit event (session open/close, request, blob fetch, trust) — the tap on the hub.
1012 /// Boxed so this (much larger) variant does not bloat every frame; serde delegates through the
1013 /// `Box`, so the wire shape is the record's fields verbatim.
1014 Event { record: Box<AuditRecord> },
1015 /// A peer's reachability TRANSITIONED (#58): it became reachable, became unreachable, or was
1016 /// probed for the first time. Pushed so an embedder does not have to poll `status` for a live
1017 /// online/offline indicator — and so work queued for an unreachable peer can flush the moment
1018 /// it returns, rather than on the next poll tick.
1019 ///
1020 /// Emitted on a change of `reachable` **or of `path`**. A refresh with the same verdict AND the
1021 /// same path emits nothing, so a peer that stays up does not produce a frame per TTL refresh;
1022 /// `rtt_ms`/`meta`/`services` drift is advisory detail and is not a transition. `age_secs` is
1023 /// `0` — the observation just completed.
1024 ///
1025 /// **Do not treat this as an up/down toggle.** It carried that meaning through 0.18, and this
1026 /// doc said "on a CHANGE of `reachable` only" until 1.22 — which stopped being true in 0.19.0
1027 /// (#92 item 1), when `path` joined the transition rule. A consumer that assumed same-verdict
1028 /// frames were impossible was reading a stale guarantee.
1029 ///
1030 /// Two producers, as of API 1.22:
1031 ///
1032 /// - a **probe** completing (`status`/`subscribe` refreshing a stale entry), which carries a
1033 /// measured `rtt_ms`; and
1034 /// - a **live session** whose selected path changed under it (#92 item 2), which carries
1035 /// `rtt_ms: None` on a first observation — no round trip was measured and none is invented.
1036 ///
1037 /// The second producer is why `path` is trustworthy for a long-lived session: a session that
1038 /// degrades Direct→Relay mid-call now says so when it happens, rather than staying silently
1039 /// mislabelled until something probes. `path` is a truth claim about where user data went, so
1040 /// `Unknown` means "we do not know" and must never be rendered as private.
1041 Reachability { peer: PeerReachability },
1042 /// The subscriber fell `dropped` records behind the broadcast ring; the stream continues (a
1043 /// fresh reconnect would re-`Snapshot`). Never drops the subscriber — lag is reported, never fatal.
1044 Lagged { dropped: u64 },
1045}
1046
1047/// Extract the `method` tag from a raw request value without deserializing the whole
1048/// message. The daemon's dispatcher uses this: match on the method string, then deserialize
1049/// `params` per-method — which tolerates omitted / null / `{}` params for parameterless
1050/// methods (adjacent tagging rejects `params:{}` on unit variants).
1051pub fn method_of(v: &serde_json::Value) -> Option<&str> {
1052 v.get("method").and_then(serde_json::Value::as_str)
1053}
1054
1055/// How a service is answered. Mirrors the config `[services.*]` *kinds*;
1056/// Config→BackendSpec is a hand-written match, not a serde passthrough.
1057#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1058#[serde(rename_all = "snake_case")]
1059pub enum BackendSpec {
1060 Run {
1061 cmd: Vec<String>,
1062 /// Per-service environment variables (#51) for the spawned child. Overlaid on the
1063 /// daemon's inherited env; the injected `MCPMESH_PEER_*` identity vars ALWAYS win over
1064 /// these (identity is not spoofable by a service definition). Default empty.
1065 #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
1066 env: BTreeMap<String, String>,
1067 /// Working directory to spawn the child in (#51). Default: inherit the daemon's cwd.
1068 #[serde(default, skip_serializing_if = "Option::is_none")]
1069 cwd: Option<String>,
1070 },
1071 Socket {
1072 path: String,
1073 },
1074}
1075
1076/// Control-API error code: the named service exists in neither `config.toml` nor the ephemeral
1077/// registry (#55). Distinct from the generic `-32000` so a caller can BRANCH on "no such service"
1078/// instead of parsing a message — `service_allow_grant`/`service_allow_revoke` previously answered
1079/// `{}` (success) for an unknown name, which silently included every ephemeral service.
1080pub const ERR_NO_SUCH_SERVICE: i64 = -32040;
1081/// The named blob is not held COMPLETE by this daemon (#83, `blob_republish`). Distinct from
1082/// [`ERR_NO_SUCH_SERVICE`] because the remedy differs: fetch the blob first.
1083pub const ERR_NO_SUCH_BLOB: i64 = -32041;
1084/// The blob was deliberately withdrawn from this scope (#107). Distinct from
1085/// [`ERR_NO_SUCH_BLOB`]: that means "fetch it first", this means "someone un-shared this on
1086/// purpose — `blob_publish` from the file if the re-share is intended".
1087pub const ERR_BLOB_WITHDRAWN: i64 = -32042;
1088
1089pub const API_NAME: &str = "mcpmesh-local/1";
1090/// The protocol-compatibility version as `"MAJOR.MINOR"`, distinct from the crate/stack version.
1091///
1092/// - **MAJOR** matches the `/N` in [`API_NAME`] and changes only on a breaking wire change (the
1093/// transport already rejects a mismatched `api`, so an equality check on that is redundant).
1094/// - **MINOR** ([`API_MINOR`]) increments on EVERY surface change within a major — additive fields,
1095/// new methods, or a strictness change like params validation — bumped in the same change that
1096/// makes it. A client can guard with `api_minor >= N` for a feature it needs, or refuse a daemon
1097/// older than a minor it requires. It never resets except on a MAJOR bump.
1098pub const API_VERSION: &str = "1.22";
1099/// The integer MINOR of [`API_VERSION`] — see there. Bumped from 0 to 1 when params validation
1100/// became strict (#34); to 2 with the `set_nickname` verb + `StatusResult.self_nickname` (#37);
1101/// to 3 when `allow`/grant strings became STABLE principals — `b64u:`/`eid:`/roster names,
1102/// never nicknames (#38); to 4 with the `set_app_metadata` verb + `PresencePeer.meta` (#39);
1103/// to 5 with `PeerReachability.meta` — pairing-mode app metadata on the probe pong (#40);
1104/// to 6 with `PeerInfo.principal` — the peer's eid: device principal on `status` (#41);
1105/// to 7 with `PeerReachability.principal` — the same on reachability rows (#42); to 8 with the
1106/// `service_allow_grant`/`service_allow_revoke` per-peer access verbs (#44); to 9 covering the
1107/// `unregister_service` (#50) / `peer_services` (#52) / Run `env`+`cwd` (#51) surface that shipped
1108/// in 0.10.1 without a bump, PLUS the `set_relays` live relay-set verb (#53); to 10 when
1109/// `service_allow_revoke`/`peer_remove` became IMMEDIATE — no verb shape changed, but their
1110/// observable contract did: a revoked principal's next session is refused even on a connection it
1111/// already holds, and its live connections are severed. Previously both waited for the peer to
1112/// disconnect on its own, which is unbounded (#54). A consumer can guard on
1113/// `api_minor >= 10` before telling a user that revocation has taken effect; to 11 when
1114/// `service_allow_grant`/`service_allow_revoke` gained EPHEMERAL-service support and became strict
1115/// about an unknown service name — a name in neither the config nor the ephemeral registry now
1116/// answers [`ERR_NO_SUCH_SERVICE`] instead of a silent `{}` (#55, #69); to 12 with the pushed
1117/// [`StreamFrame::Reachability`] liveness transition frame (#58); to 13 with
1118/// [`PeerReachability::path`] — direct-vs-relay attribution on every reachability row (#64); to 14
1119/// with the `run`-backend `MCPMESH_PEER_EID` identity var — the caller's stable device principal,
1120/// unconditionally present, so a `run` server can scope per caller without keying on a nickname
1121/// (#60); to 15 with the `blob_revoke` / `blob_unpublish` verbs — per-scope withdrawal of a grant
1122/// and of a published hash, so un-sharing a file no longer requires unpairing the person (#62); to
1123/// 16 when the app-blob provider became available in PAIRING mode — the blob verbs previously
1124/// errored on any daemon without an org root key, though their scope gate never needed one (#61).
1125pub const API_MINOR: u32 = 22;
1126
1127#[cfg(test)]
1128mod tests {
1129 use super::*;
1130
1131 /// #64: the path field's wire shape, and its ADDITIVE default. A row from an older daemon has
1132 /// no `path` key at all and must land on `Unknown` — never on `Direct`, which would invent a
1133 /// privacy guarantee that daemon never made.
1134 #[test]
1135 fn peer_path_tags_and_defaults_to_unknown() {
1136 let tagged = |p: PeerPath| serde_json::to_value(p).unwrap();
1137 assert_eq!(tagged(PeerPath::Direct)["kind"], "direct");
1138 assert_eq!(tagged(PeerPath::Unknown)["kind"], "unknown");
1139 let relay = tagged(PeerPath::Relay {
1140 url: Some("https://relay.example/".into()),
1141 });
1142 assert_eq!(relay["kind"], "relay");
1143 assert_eq!(relay["url"], "https://relay.example/");
1144 // A relay whose URL we do not know still tags as relay, with the key elided.
1145 let bare = tagged(PeerPath::Relay { url: None });
1146 assert_eq!(bare["kind"], "relay");
1147 assert!(bare.get("url").is_none(), "elided, not null: {bare}");
1148
1149 // #64 review: a path kind from a NEWER daemon must degrade to Unknown, not fail the whole
1150 // row. Without `#[serde(other)]` an unknown `kind` errors out of
1151 // `PeerReachability` entirely, so one new variant would break every `status` read an
1152 // older pinned client does.
1153 let future: PeerPath =
1154 serde_json::from_value(serde_json::json!({"kind": "quantum", "id": "x"})).unwrap();
1155 assert_eq!(future, PeerPath::Unknown);
1156 let row: PeerReachability = serde_json::from_value(serde_json::json!({
1157 "name": "bob", "reachable": true, "path": {"kind": "quantum"}
1158 }))
1159 .expect("an unknown path kind must not fail the whole row");
1160 assert_eq!(row.path, PeerPath::Unknown);
1161 assert!(row.reachable, "the rest of the row survives");
1162
1163 // A pre-#64 row: no `path` key.
1164 let old = serde_json::json!({"name": "bob", "reachable": true});
1165 let parsed: PeerReachability = serde_json::from_value(old).unwrap();
1166 assert_eq!(
1167 parsed.path,
1168 PeerPath::Unknown,
1169 "an older daemon's row must never imply a direct path"
1170 );
1171 }
1172
1173 /// #58: the pushed liveness frame tags as `{"type":"reachability","peer":{…}}` and carries a
1174 /// whole `PeerReachability` row — the SAME shape the opening snapshot's list holds, so a
1175 /// consumer projects both through one code path.
1176 #[test]
1177 fn reachability_frame_tags_and_round_trips() {
1178 let frame = StreamFrame::Reachability {
1179 peer: PeerReachability {
1180 name: "bob".into(),
1181 reachable: true,
1182 rtt_ms: Some(12),
1183 age_secs: Some(0),
1184 meta: String::new(),
1185 principal: Some("eid:beef".into()),
1186 path: Default::default(),
1187 },
1188 };
1189 let v = serde_json::to_value(&frame).unwrap();
1190 assert_eq!(v["type"], "reachability");
1191 assert_eq!(v["peer"]["name"], "bob");
1192 assert_eq!(v["peer"]["reachable"], true);
1193 assert_eq!(
1194 v["peer"]["age_secs"], 0,
1195 "a transition frame is fresh by construction: {v}"
1196 );
1197 let back: StreamFrame = serde_json::from_value(v).unwrap();
1198 assert_eq!(back, frame);
1199 }
1200
1201 #[test]
1202 fn peer_reachability_serde_is_additive() {
1203 let r = PeerReachability {
1204 name: "bob".into(),
1205 reachable: true,
1206 rtt_ms: Some(42),
1207 age_secs: Some(3),
1208 meta: String::new(),
1209 principal: None,
1210 path: Default::default(),
1211 };
1212 let v = serde_json::to_value(&r).unwrap();
1213 assert_eq!(v["name"], "bob");
1214 assert_eq!(v["reachable"], true);
1215 assert_eq!(v["rtt_ms"], 42);
1216 assert_eq!(v["age_secs"], 3);
1217 // Never-probed peer: optionals elided, not null.
1218 let unknown = PeerReachability {
1219 name: "carol".into(),
1220 reachable: false,
1221 rtt_ms: None,
1222 age_secs: None,
1223 meta: String::new(),
1224 principal: None,
1225 path: Default::default(),
1226 };
1227 let uv = serde_json::to_value(&unknown).unwrap();
1228 assert!(uv.get("rtt_ms").is_none() && uv.get("age_secs").is_none());
1229 // An older StatusResult (no reachability field) still deserializes.
1230 let old = serde_json::json!({"stack_version":"0.1.0","services":[],"peers":[]});
1231 let s: StatusResult = serde_json::from_value(old).unwrap();
1232 assert!(s.reachability.is_empty());
1233 }
1234
1235 #[test]
1236 fn subscribe_method_tag_resolves() {
1237 let req = serde_json::to_value(Request::Subscribe).unwrap();
1238 assert_eq!(method_of(&req), Some("subscribe"));
1239 }
1240
1241 // --- #34: params structs reject unknown fields (the `{service: "kb"}` silent-accept bug) ---
1242
1243 #[test]
1244 fn invite_params_reject_singular_service_typo() {
1245 // The reported bug: `{"service":"kb"}` (singular) used to deserialize to
1246 // InviteParams { services: [] } and mint a grants-nothing invite that looked
1247 // successful. With deny_unknown_fields the typo is a loud parse error instead.
1248 let err = serde_json::from_value::<InviteParams>(serde_json::json!({"service": "kb"}));
1249 assert!(
1250 err.is_err(),
1251 "an unknown `service` key must be rejected, not silently ignored"
1252 );
1253 // The correct plural shape still parses.
1254 let ok: InviteParams =
1255 serde_json::from_value(serde_json::json!({"services": ["kb"]})).unwrap();
1256 assert_eq!(ok.services, vec!["kb".to_string()]);
1257 }
1258
1259 #[test]
1260 fn open_session_params_reject_unknown_field() {
1261 let err = serde_json::from_value::<OpenSessionParams>(
1262 serde_json::json!({"peer": "a", "service": "b", "nonsense": 1}),
1263 );
1264 assert!(err.is_err(), "unknown params keys must be rejected");
1265 }
1266
1267 #[test]
1268 fn set_app_metadata_request_carries_the_method_tag() {
1269 let r = Request::SetAppMetadata(SetAppMetadataParams {
1270 metadata: "v=1.2.3".into(),
1271 });
1272 let v = serde_json::to_value(&r).unwrap();
1273 assert_eq!(v["method"], "set_app_metadata");
1274 assert_eq!(v["params"]["metadata"], "v=1.2.3");
1275 assert_eq!(method_of(&v), Some("set_app_metadata"));
1276 }
1277
1278 #[test]
1279 fn set_app_metadata_params_reject_unknown_field() {
1280 let err = serde_json::from_value::<SetAppMetadataParams>(
1281 serde_json::json!({"metadata": "x", "nonsense": 1}),
1282 );
1283 assert!(err.is_err(), "unknown params keys must be rejected");
1284 }
1285
1286 /// `PresencePeer.meta` is additive — an older payload (no meta) still deserializes, and an
1287 /// empty meta does not serialize.
1288 #[test]
1289 fn peer_info_principal_is_additive() {
1290 // An older payload (no principal) still deserializes; empty does not serialize.
1291 let old = serde_json::json!({"name": "bob", "services": ["notes"]});
1292 let p: PeerInfo = serde_json::from_value(old).unwrap();
1293 assert_eq!(p.principal, None);
1294 assert!(serde_json::to_value(&p).unwrap().get("principal").is_none());
1295 // A bound peer carries BOTH the person user_id AND the device principal (#41).
1296 let full = PeerInfo {
1297 name: "bob".into(),
1298 services: vec!["notes".into()],
1299 user_id: Some("b64u:BOB".into()),
1300 principal: Some("eid:0707".into()),
1301 };
1302 let back: PeerInfo = serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
1303 assert_eq!(back.user_id.as_deref(), Some("b64u:BOB"));
1304 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
1305 }
1306
1307 #[test]
1308 fn peer_reachability_principal_is_additive() {
1309 // Older payload (no principal) still deserializes; empty does not serialize; a set
1310 // value round-trips alongside the #40 meta so an embedder joins on the principal.
1311 let old = serde_json::json!({"name": "bob", "reachable": true});
1312 let r: PeerReachability = serde_json::from_value(old).unwrap();
1313 assert_eq!(r.principal, None);
1314 assert!(serde_json::to_value(&r).unwrap().get("principal").is_none());
1315 let full = PeerReachability {
1316 name: "bob".into(),
1317 reachable: true,
1318 rtt_ms: Some(12),
1319 age_secs: Some(3),
1320 meta: "v=1.2.3".into(),
1321 principal: Some("eid:0707".into()),
1322 path: Default::default(),
1323 };
1324 let back: PeerReachability =
1325 serde_json::from_value(serde_json::to_value(&full).unwrap()).unwrap();
1326 assert_eq!(back.principal.as_deref(), Some("eid:0707"));
1327 assert_eq!(back.meta, "v=1.2.3");
1328 }
1329
1330 #[test]
1331 fn peer_reachability_meta_is_additive() {
1332 // An older payload (no meta) still deserializes; an empty meta does not serialize.
1333 let old = serde_json::json!({"name": "bob", "reachable": true});
1334 let r: PeerReachability = serde_json::from_value(old).unwrap();
1335 assert_eq!(r.meta, "");
1336 assert!(serde_json::to_value(&r).unwrap().get("meta").is_none());
1337 // A set value round-trips.
1338 let with = PeerReachability {
1339 name: "bob".into(),
1340 reachable: true,
1341 rtt_ms: Some(12),
1342 age_secs: Some(3),
1343 meta: "v=1.2.3".into(),
1344 principal: None,
1345 path: Default::default(),
1346 };
1347 let back: PeerReachability =
1348 serde_json::from_value(serde_json::to_value(&with).unwrap()).unwrap();
1349 assert_eq!(back.meta, "v=1.2.3");
1350 }
1351
1352 #[test]
1353 fn presence_peer_meta_is_additive() {
1354 let old = serde_json::json!({
1355 "user_id": "b64u:A", "device_label": "laptop", "role": "primary", "online": true
1356 });
1357 let p: PresencePeer = serde_json::from_value(old).unwrap();
1358 assert_eq!(p.meta, "");
1359 assert!(serde_json::to_value(&p).unwrap().get("meta").is_none());
1360 }
1361
1362 #[test]
1363 fn set_nickname_request_carries_the_method_tag() {
1364 let r = Request::SetNickname(SetNicknameParams {
1365 nickname: "workbench".into(),
1366 });
1367 let v = serde_json::to_value(&r).unwrap();
1368 assert_eq!(v["method"], "set_nickname");
1369 assert_eq!(v["params"]["nickname"], "workbench");
1370 assert_eq!(method_of(&v), Some("set_nickname"));
1371 }
1372
1373 #[test]
1374 fn set_nickname_params_reject_unknown_field() {
1375 let err = serde_json::from_value::<SetNicknameParams>(
1376 serde_json::json!({"nickname": "x", "nonsense": 1}),
1377 );
1378 assert!(err.is_err(), "unknown params keys must be rejected");
1379 }
1380
1381 /// An OLDER daemon's status payload (no `self_nickname`) must still deserialize —
1382 /// the additive-only contract — and an empty name must not serialize at all.
1383 #[test]
1384 fn status_self_nickname_is_additive() {
1385 let old = serde_json::json!({
1386 "stack_version": "0.7.0", "services": [], "peers": []
1387 });
1388 let s: StatusResult = serde_json::from_value(old).unwrap();
1389 assert_eq!(s.self_nickname, "");
1390 let v = serde_json::to_value(&s).unwrap();
1391 assert!(v.get("self_nickname").is_none(), "empty name is skipped");
1392 }
1393
1394 #[test]
1395 fn api_minor_is_present_and_monotonic_from_hello() {
1396 // #34 part 2: a machine-comparable protocol-compat minor, distinct from the
1397 // crate/stack version, additive on the Hello frame.
1398 let h = Hello {
1399 api: API_NAME.into(),
1400 api_version: API_VERSION.into(),
1401 api_minor: API_MINOR,
1402 stack_version: "9.9.9".into(),
1403 };
1404 let v = serde_json::to_value(&h).unwrap();
1405 assert_eq!(v["api_minor"], API_MINOR);
1406 // An OLD Hello without api_minor still deserializes (additive contract).
1407 let old = serde_json::json!({
1408 "api": API_NAME, "api_version": "1.0", "stack_version": "0.4.0"
1409 });
1410 let back: Hello = serde_json::from_value(old).unwrap();
1411 assert_eq!(back.api_minor, 0, "absent api_minor defaults to 0");
1412 }
1413
1414 #[test]
1415 fn hello_result_roundtrips() {
1416 let h = Hello {
1417 api: "mcpmesh-local/1".into(),
1418 api_version: "1.0".into(),
1419 api_minor: 0,
1420 stack_version: "0.1.0".into(),
1421 };
1422 let v = serde_json::to_value(&h).unwrap();
1423 assert_eq!(v["api"], "mcpmesh-local/1");
1424 let back: Hello = serde_json::from_value(v).unwrap();
1425 assert_eq!(back, h);
1426 }
1427
1428 #[test]
1429 fn request_tagged_by_method() {
1430 let r = Request::Status;
1431 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "status");
1432 let r = Request::OpenSession(OpenSessionParams {
1433 peer: "alice".into(),
1434 service: "notes".into(),
1435 });
1436 let v = serde_json::to_value(&r).unwrap();
1437 assert_eq!(v["method"], "open_session");
1438 assert_eq!(v["params"]["peer"], "alice");
1439 }
1440
1441 #[test]
1442 fn parameterless_method_tolerates_params_forms() {
1443 // Omitted and null params deserialize straight into the unit variant.
1444 let omitted: Request =
1445 serde_json::from_value(serde_json::json!({"method": "status"})).unwrap();
1446 assert_eq!(omitted, Request::Status);
1447 let null: Request =
1448 serde_json::from_value(serde_json::json!({"method": "status", "params": null}))
1449 .unwrap();
1450 assert_eq!(null, Request::Status);
1451
1452 // Known limitation: adjacent tagging rejects `params:{}` for a unit variant, so
1453 // the server MUST dispatch on the method string rather than deserialize the whole
1454 // message into `Request`. This is the pattern the daemon's dispatcher uses.
1455 let empty = serde_json::json!({"method": "status", "params": {}});
1456 assert!(serde_json::from_value::<Request>(empty.clone()).is_err());
1457 match method_of(&empty) {
1458 Some("status") => {} // dispatcher resolves Status via the method string
1459 other => panic!("method_of failed to resolve status: {other:?}"),
1460 }
1461 }
1462
1463 #[test]
1464 fn backend_spec_roundtrips() {
1465 let run = BackendSpec::Run {
1466 cmd: vec!["notes-mcp".into(), "--stdio".into()],
1467 env: Default::default(),
1468 cwd: None,
1469 };
1470 let v = serde_json::to_value(&run).unwrap();
1471 assert_eq!(v["run"]["cmd"][0], "notes-mcp");
1472 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), run);
1473
1474 let sock = BackendSpec::Socket {
1475 path: "/run/notes.sock".into(),
1476 };
1477 let v = serde_json::to_value(&sock).unwrap();
1478 assert_eq!(v["socket"]["path"], "/run/notes.sock");
1479 assert_eq!(serde_json::from_value::<BackendSpec>(v).unwrap(), sock);
1480 }
1481
1482 #[test]
1483 fn register_service_wire_shape() {
1484 let r = Request::RegisterService(RegisterServiceParams {
1485 name: "notes".into(),
1486 backend: BackendSpec::Run {
1487 cmd: vec!["notes-mcp".into()],
1488 env: Default::default(),
1489 cwd: None,
1490 },
1491 allow: vec!["alice".into()],
1492 ephemeral: false,
1493 });
1494 let v = serde_json::to_value(&r).unwrap();
1495 assert_eq!(
1496 v,
1497 serde_json::json!({
1498 "method": "register_service",
1499 "params": {
1500 "name": "notes",
1501 "backend": {"run": {"cmd": ["notes-mcp"]}},
1502 "allow": ["alice"],
1503 }
1504 })
1505 );
1506 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1507 }
1508
1509 #[test]
1510 fn invite_request_and_result_roundtrip() {
1511 // Request::Invite → `{ "method": "invite", "params": { "services": [...] } }`.
1512 let r = Request::Invite(InviteParams {
1513 services: vec!["notes".into(), "kb".into()],
1514 app_label: None,
1515 });
1516 let v = serde_json::to_value(&r).unwrap();
1517 assert_eq!(v["method"], "invite");
1518 assert_eq!(v["params"]["services"][0], "notes");
1519 assert_eq!(v["params"]["services"][1], "kb");
1520 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1521 // method_of resolves the tag generically (no per-variant arm).
1522 assert_eq!(
1523 method_of(&serde_json::json!({"method": "invite", "params": {"services": []}})),
1524 Some("invite")
1525 );
1526
1527 // InviteResult carries the copyable line + expiry (surface #2 pairing artifact).
1528 let res = InviteResult {
1529 invite_line: "mcpmesh-invite:ABCDEF".into(),
1530 expires_at_epoch: 1_800_000_000,
1531 };
1532 let v = serde_json::to_value(&res).unwrap();
1533 assert_eq!(v["invite_line"], "mcpmesh-invite:ABCDEF");
1534 assert_eq!(v["expires_at_epoch"], 1_800_000_000u64);
1535 assert_eq!(serde_json::from_value::<InviteResult>(v).unwrap(), res);
1536 }
1537
1538 #[test]
1539 fn pair_request_and_result_roundtrip() {
1540 // Request::Pair → `{ "method": "pair", "params": { "invite_line": "..." } }`.
1541 let r = Request::Pair(PairParams {
1542 invite_line: "mcpmesh-invite:ABCDEF".into(),
1543 });
1544 let v = serde_json::to_value(&r).unwrap();
1545 assert_eq!(v["method"], "pair");
1546 assert_eq!(v["params"]["invite_line"], "mcpmesh-invite:ABCDEF");
1547 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1548 // method_of resolves the tag generically (no per-variant arm).
1549 assert_eq!(
1550 method_of(&serde_json::json!({"method": "pair", "params": {"invite_line": "x"}})),
1551 Some("pair")
1552 );
1553
1554 // PairResult carries the inviter's suggested nickname + the display-only SAS words +
1555 // the granted services (the porcelain renders each as `<peer>/<service>`).
1556 let res = PairResult {
1557 peer_nickname: "alice".into(),
1558 sas_code: "tango-fig-cabbage".into(),
1559 services: vec!["notes".into(), "kb".into()],
1560 app_label: None,
1561 peer_user_id: None,
1562 };
1563 let v = serde_json::to_value(&res).unwrap();
1564 assert_eq!(v["peer_nickname"], "alice");
1565 assert_eq!(v["sas_code"], "tango-fig-cabbage");
1566 assert_eq!(v["services"][0], "notes");
1567 assert_eq!(v["services"][1], "kb");
1568 assert_eq!(serde_json::from_value::<PairResult>(v).unwrap(), res);
1569
1570 // Additive-only: a PairResult minted by an older daemon (no `services` key) still
1571 // deserializes — the `#[serde(default)]` fills it with an empty list.
1572 let old_shape = serde_json::json!({
1573 "peer_nickname": "alice",
1574 "sas_code": "tango-fig-cabbage",
1575 });
1576 let back: PairResult = serde_json::from_value(old_shape).unwrap();
1577 assert_eq!(back.peer_nickname, "alice");
1578 assert!(back.services.is_empty());
1579 }
1580
1581 #[test]
1582 fn roster_install_request_and_result_roundtrip() {
1583 // Request::RosterInstall → `{ "method": "roster_install", "params": { "path": ...,
1584 // "org_root_pk": ... } }`. The optional pk is present on the first-install shape.
1585 let r = Request::RosterInstall(RosterInstallParams {
1586 path: "/tmp/roster.json".into(),
1587 org_root_pk: Some("b64u:AAAA".into()),
1588 });
1589 let v = serde_json::to_value(&r).unwrap();
1590 assert_eq!(v["method"], "roster_install");
1591 assert_eq!(v["params"]["path"], "/tmp/roster.json");
1592 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
1593 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1594 // method_of resolves the tag generically (no per-variant arm).
1595 assert_eq!(
1596 method_of(&serde_json::json!({"method": "roster_install", "params": {"path": "/x"}})),
1597 Some("roster_install")
1598 );
1599
1600 // When the pk is omitted (a subsequent install using the pinned value), it is
1601 // `skip_serializing_if`-dropped from the wire and deserializes back to `None`.
1602 let omit = Request::RosterInstall(RosterInstallParams {
1603 path: "/tmp/roster.json".into(),
1604 org_root_pk: None,
1605 });
1606 let v = serde_json::to_value(&omit).unwrap();
1607 assert!(
1608 v["params"].get("org_root_pk").is_none(),
1609 "an omitted org_root_pk must not appear on the wire: {v}"
1610 );
1611 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), omit);
1612
1613 // RosterInstallResult carries org_id + serial + severed count (roster-status vocabulary).
1614 let res = RosterInstallResult {
1615 org_id: "acme".into(),
1616 serial: 42,
1617 severed: 1,
1618 };
1619 let v = serde_json::to_value(&res).unwrap();
1620 assert_eq!(v["org_id"], "acme");
1621 assert_eq!(v["serial"], 42u64);
1622 assert_eq!(v["severed"], 1u32);
1623 assert_eq!(
1624 serde_json::from_value::<RosterInstallResult>(v).unwrap(),
1625 res
1626 );
1627
1628 // Additive-only: a result minted by an older daemon (no `severed` key) still
1629 // deserializes — the `#[serde(default)]` fills it with 0.
1630 let old_shape = serde_json::json!({ "org_id": "acme", "serial": 7 });
1631 let back: RosterInstallResult = serde_json::from_value(old_shape).unwrap();
1632 assert_eq!(back.serial, 7);
1633 assert_eq!(back.severed, 0);
1634 }
1635
1636 #[test]
1637 fn org_join_request_and_result_roundtrip() {
1638 // Request::OrgJoin → `{ "method": "org_join", "params": { org_id, org_root_pk, user_id,
1639 // user_key } }`. `user_key` is a LOCAL path string (the key never crosses the API).
1640 let r = Request::OrgJoin(OrgJoinParams {
1641 org_id: "acme".into(),
1642 org_root_pk: "b64u:AAAA".into(),
1643 user_id: "alice".into(),
1644 user_key: "/home/alice/.config/mcpmesh/user.key".into(),
1645 });
1646 let v = serde_json::to_value(&r).unwrap();
1647 assert_eq!(v["method"], "org_join");
1648 assert_eq!(v["params"]["org_id"], "acme");
1649 assert_eq!(v["params"]["org_root_pk"], "b64u:AAAA");
1650 assert_eq!(v["params"]["user_id"], "alice");
1651 assert_eq!(
1652 v["params"]["user_key"],
1653 "/home/alice/.config/mcpmesh/user.key"
1654 );
1655 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1656 // method_of resolves the tag generically (no per-variant arm).
1657 assert_eq!(
1658 method_of(&serde_json::json!({"method": "org_join", "params": {"org_id": "x"}})),
1659 Some("org_join")
1660 );
1661
1662 // OrgJoinResult echoes the pinned org id (surface-clean; the fingerprint is porcelain-side).
1663 let res = OrgJoinResult {
1664 org_id: "acme".into(),
1665 };
1666 let v = serde_json::to_value(&res).unwrap();
1667 assert_eq!(v["org_id"], "acme");
1668 assert_eq!(serde_json::from_value::<OrgJoinResult>(v).unwrap(), res);
1669 }
1670
1671 #[test]
1672 fn set_roster_url_request_roundtrip() {
1673 // Request::SetRosterUrl → `{ "method": "set_roster_url", "params": { "url": "..." } }`.
1674 let r = Request::SetRosterUrl(SetRosterUrlParams {
1675 url: "https://intranet.acme.com/roster.json".into(),
1676 });
1677 let v = serde_json::to_value(&r).unwrap();
1678 assert_eq!(v["method"], "set_roster_url");
1679 assert_eq!(v["params"]["url"], "https://intranet.acme.com/roster.json");
1680 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1681 assert_eq!(
1682 method_of(&serde_json::json!({"method": "set_roster_url", "params": {"url": "x"}})),
1683 Some("set_roster_url")
1684 );
1685 }
1686
1687 #[test]
1688 fn peer_remove_request_roundtrip() {
1689 // Request::PeerRemove → `{ "method": "peer_remove", "params": { "nickname": "..." } }`.
1690 let r = Request::PeerRemove(PeerRemoveParams {
1691 nickname: "bob".into(),
1692 });
1693 let v = serde_json::to_value(&r).unwrap();
1694 assert_eq!(v["method"], "peer_remove");
1695 assert_eq!(v["params"]["nickname"], "bob");
1696 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1697 // method_of resolves the tag generically (no per-variant arm).
1698 assert_eq!(
1699 method_of(&serde_json::json!({"method": "peer_remove", "params": {"nickname": "bob"}})),
1700 Some("peer_remove")
1701 );
1702 }
1703
1704 /// The reserved/internal `peer_add` rides the SAME typed vocabulary as every other method —
1705 /// `{ "method": "peer_add", "params": { nickname, endpoint_id, allow } }` — with `allow`
1706 /// defaulting to empty when absent.
1707 #[test]
1708 fn peer_add_request_roundtrip() {
1709 let r = Request::PeerAdd(PeerAddParams {
1710 nickname: "bob".into(),
1711 endpoint_id: "96246d3f".into(),
1712 allow: vec!["notes".into()],
1713 });
1714 let v = serde_json::to_value(&r).unwrap();
1715 assert_eq!(v["method"], "peer_add");
1716 assert_eq!(v["params"]["nickname"], "bob");
1717 assert_eq!(v["params"]["endpoint_id"], "96246d3f");
1718 assert_eq!(v["params"]["allow"][0], "notes");
1719 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1720 // An absent allow list deserializes to empty (the server-side tolerance).
1721 let p: PeerAddParams =
1722 serde_json::from_value(serde_json::json!({"nickname": "bob", "endpoint_id": "x"}))
1723 .unwrap();
1724 assert!(p.allow.is_empty());
1725 }
1726
1727 #[test]
1728 fn peer_rename_request_roundtrip() {
1729 // By user_id (renames all of a person's devices in one op).
1730 let r = Request::PeerRename(PeerRenameParams {
1731 user_id: Some("b64u:BOB".into()),
1732 nickname: None,
1733 to: "Bobby".into(),
1734 });
1735 let v = serde_json::to_value(&r).unwrap();
1736 assert_eq!(v["method"], "peer_rename");
1737 assert_eq!(v["params"]["user_id"], "b64u:BOB");
1738 assert_eq!(v["params"]["to"], "Bobby");
1739 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1740 // A provisional contact is renamed by nickname; omitted user_id defaults to None.
1741 assert_eq!(
1742 method_of(
1743 &serde_json::json!({"method": "peer_rename", "params": {"nickname": "carol", "to": "Carol"}})
1744 ),
1745 Some("peer_rename")
1746 );
1747 }
1748
1749 #[test]
1750 fn status_result_roundtrips() {
1751 // Pure-pairing daemon: `roster` is None — absent from the wire (skip_serializing_if) and an
1752 // older payload with no `roster` key still deserializes to None (serde default).
1753 let s = StatusResult {
1754 stack_version: "0.1.0".into(),
1755 services: vec![ServiceInfo {
1756 name: "notes".into(),
1757 allow: vec!["alice".into()],
1758 allow_display: vec![],
1759 backend: BackendKind::Run,
1760 ephemeral: false,
1761 }],
1762 peers: vec![PeerInfo {
1763 name: "alice".into(),
1764 services: vec!["notes".into()],
1765 // A paired peer that proved a self-sovereign user_id at pairing (surface-clean id).
1766 user_id: Some("b64u:alicepk".into()),
1767 principal: None,
1768 }],
1769 roster: None,
1770 presence: vec![],
1771 self_user_id: Some("b64u:selfpk".into()),
1772 recent_pairings: vec![],
1773 reachability: vec![],
1774 self_nickname: String::new(),
1775 };
1776 let v = serde_json::to_value(&s).unwrap();
1777 assert_eq!(v["services"][0]["backend"], "run");
1778 // The additive identity fields ride the wire when present.
1779 assert_eq!(v["peers"][0]["user_id"], "b64u:alicepk");
1780 assert_eq!(v["self_user_id"], "b64u:selfpk");
1781 assert!(
1782 v.get("roster").is_none(),
1783 "an absent roster must not appear on the wire: {v}"
1784 );
1785 assert!(
1786 v.get("presence").is_none(),
1787 "an empty presence must not appear on the wire: {v}"
1788 );
1789 assert!(
1790 v.get("recent_pairings").is_none(),
1791 "an empty recent_pairings must not appear on the wire: {v}"
1792 );
1793 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1794
1795 // A payload minted by an older daemon (no `roster`/`presence`/identity keys) still
1796 // deserializes — the identity fields default to None / a nickname-only peer.
1797 let old_shape = serde_json::json!({
1798 "stack_version": "0.1.0",
1799 "services": [],
1800 "peers": [{ "name": "bob", "services": [] }],
1801 });
1802 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
1803 assert!(back.roster.is_none());
1804 assert!(back.presence.is_empty());
1805 assert!(back.self_user_id.is_none());
1806 assert!(back.peers[0].user_id.is_none());
1807 assert!(back.recent_pairings.is_empty());
1808
1809 // Roster daemon: a Some(RosterStatus) + an advisory presence list round-trip. `presence`
1810 // carries FLAT vocabulary only (user_id/device_label/role/online) — no EndpointId/key.
1811 let s = StatusResult {
1812 stack_version: "0.1.0".into(),
1813 services: vec![],
1814 peers: vec![],
1815 roster: Some(RosterStatus {
1816 org_id: "acme".into(),
1817 serial: 42,
1818 state: "approved".into(),
1819 org_root_fingerprint: "tango-fig-cabbage-anchor".into(),
1820 }),
1821 presence: vec![
1822 PresencePeer {
1823 user_id: "alice".into(),
1824 device_label: "laptop".into(),
1825 role: "primary".into(),
1826 online: true,
1827 meta: String::new(),
1828 },
1829 PresencePeer {
1830 user_id: "alice".into(),
1831 device_label: "desktop".into(),
1832 role: "mirror".into(),
1833 online: false,
1834 meta: String::new(),
1835 },
1836 ],
1837 self_user_id: None,
1838 recent_pairings: vec![],
1839 reachability: vec![],
1840 self_nickname: String::new(),
1841 };
1842 let v = serde_json::to_value(&s).unwrap();
1843 assert_eq!(v["roster"]["org_id"], "acme");
1844 assert_eq!(v["roster"]["serial"], 42u64);
1845 assert_eq!(v["roster"]["state"], "approved");
1846 assert_eq!(
1847 v["roster"]["org_root_fingerprint"],
1848 "tango-fig-cabbage-anchor"
1849 );
1850 assert_eq!(v["presence"][0]["user_id"], "alice");
1851 assert_eq!(v["presence"][0]["device_label"], "laptop");
1852 assert_eq!(v["presence"][0]["role"], "primary");
1853 assert_eq!(v["presence"][0]["online"], true);
1854 assert_eq!(v["presence"][1]["online"], false);
1855 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1856 }
1857
1858 /// The `recent_pairings` status field is ADDITIVE: a populated list round-trips with
1859 /// the flat `{peer_nickname, sas_code, paired_at_epoch}` shape (nickname + SAS words + epoch —
1860 /// never an EndpointId), an empty list is dropped from the wire, and a payload minted by an
1861 /// older daemon (no key at all) still deserializes to empty.
1862 #[test]
1863 fn recent_pairings_are_additive_on_status() {
1864 let s = StatusResult {
1865 stack_version: "0.1.0".into(),
1866 services: vec![],
1867 peers: vec![],
1868 roster: None,
1869 presence: vec![],
1870 self_user_id: None,
1871 recent_pairings: vec![RecentPairing {
1872 peer_nickname: "bob".into(),
1873 sas_code: "tango-fig-cabbage".into(),
1874 paired_at_epoch: 1_800_000_000,
1875 }],
1876 reachability: vec![],
1877 self_nickname: String::new(),
1878 };
1879 let v = serde_json::to_value(&s).unwrap();
1880 assert_eq!(v["recent_pairings"][0]["peer_nickname"], "bob");
1881 assert_eq!(v["recent_pairings"][0]["sas_code"], "tango-fig-cabbage");
1882 assert_eq!(v["recent_pairings"][0]["paired_at_epoch"], 1_800_000_000u64);
1883 assert_eq!(serde_json::from_value::<StatusResult>(v).unwrap(), s);
1884
1885 // A payload minted by an OLDER daemon (no `recent_pairings` key) still deserializes —
1886 // the `#[serde(default)]` fills it with an empty list.
1887 let old_shape = serde_json::json!({
1888 "stack_version": "0.1.0",
1889 "services": [],
1890 "peers": [],
1891 });
1892 let back: StatusResult = serde_json::from_value(old_shape).unwrap();
1893 assert!(back.recent_pairings.is_empty());
1894 }
1895
1896 #[test]
1897 fn blob_requests_and_results_roundtrip() {
1898 // BlobPublish → { method, params: { scope, path } }.
1899 let r = Request::BlobPublish(BlobPublishParams {
1900 scope: "docs".into(),
1901 path: "/tmp/a.bin".into(),
1902 });
1903 let v = serde_json::to_value(&r).unwrap();
1904 assert_eq!(v["method"], "blob_publish");
1905 assert_eq!(v["params"]["scope"], "docs");
1906 assert_eq!(v["params"]["path"], "/tmp/a.bin");
1907 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1908
1909 // BlobGrant → { method, params: { scope, principal } }.
1910 // #62: the two withdrawal verbs' wire tags. A wrong dispatch string or a swapped param
1911 // would otherwise ship undetected — the e2e test calls the provider directly and never
1912 // crosses JSON-RPC.
1913 let rev = Request::BlobRevoke(BlobRevokeParams {
1914 scope: "photos".into(),
1915 principals: vec!["alice".into()],
1916 });
1917 let v = serde_json::to_value(&rev).unwrap();
1918 assert_eq!(v["method"], "blob_revoke");
1919 assert_eq!(v["params"]["principals"][0], "alice");
1920 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), rev);
1921
1922 let unp = Request::BlobUnpublish(BlobUnpublishParams {
1923 scope: "photos".into(),
1924 hash: "abc123".into(),
1925 });
1926 let v = serde_json::to_value(&unp).unwrap();
1927 assert_eq!(v["method"], "blob_unpublish");
1928 assert_eq!(v["params"]["hash"], "abc123");
1929 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), unp);
1930
1931 let r = Request::BlobGrant(BlobGrantParams {
1932 scope: "docs".into(),
1933 principal: "alice".into(),
1934 });
1935 let v = serde_json::to_value(&r).unwrap();
1936 assert_eq!(v["method"], "blob_grant");
1937 assert_eq!(v["params"]["principal"], "alice");
1938 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1939
1940 // BlobList is parameterless (method_of resolves it).
1941 assert_eq!(
1942 method_of(&serde_json::json!({"method": "blob_list"})),
1943 Some("blob_list")
1944 );
1945
1946 // BlobFetch → { method, params: { ticket, dest_path } }.
1947 let r = Request::BlobFetch(BlobFetchParams {
1948 ticket: "blobAAA".into(),
1949 dest_path: "/tmp/out.bin".into(),
1950 });
1951 let v = serde_json::to_value(&r).unwrap();
1952 assert_eq!(v["method"], "blob_fetch");
1953 assert_eq!(v["params"]["ticket"], "blobAAA");
1954 assert_eq!(v["params"]["dest_path"], "/tmp/out.bin");
1955 assert_eq!(serde_json::from_value::<Request>(v).unwrap(), r);
1956
1957 // BlobPublishResult carries the ticket + hash (blob-reference vocabulary).
1958 let res = BlobPublishResult {
1959 ticket: "blobAAA".into(),
1960 hash: "ab".repeat(32),
1961 };
1962 let v = serde_json::to_value(&res).unwrap();
1963 assert_eq!(v["ticket"], "blobAAA");
1964 assert_eq!(serde_json::from_value::<BlobPublishResult>(v).unwrap(), res);
1965
1966 // BlobScopeList carries flat (name, hashes, grants) — no EndpointId/key leakage.
1967 let res = BlobScopeList {
1968 scopes: vec![ScopeInfo {
1969 name: "docs".into(),
1970 hashes: vec!["ab".repeat(32)],
1971 grants: vec!["alice".into()],
1972 withdrawn: vec![],
1973 hash_count: 1,
1974 grant_count: 1,
1975 withdrawn_count: 0,
1976 }],
1977 total: 1,
1978 truncated: false,
1979 };
1980 let v = serde_json::to_value(&res).unwrap();
1981 assert_eq!(v["scopes"][0]["name"], "docs");
1982 assert_eq!(v["scopes"][0]["grants"][0], "alice");
1983 assert_eq!(serde_json::from_value::<BlobScopeList>(v).unwrap(), res);
1984
1985 // BlobFetchResult carries the verified hash + byte length.
1986 let res = BlobFetchResult {
1987 hash: "ab".repeat(32),
1988 bytes_len: 4194304,
1989 };
1990 let v = serde_json::to_value(&res).unwrap();
1991 assert_eq!(v["bytes_len"], 4194304u64);
1992 assert_eq!(serde_json::from_value::<BlobFetchResult>(v).unwrap(), res);
1993 }
1994
1995 /// The three `subscribe` frame shapes round-trip with the documented `type`-tagged wire form
1996 /// (docs/local-protocol.md "Live event stream"): `snapshot` carries the flat session/reachability
1997 /// lists, `event` delegates through the `Box` so the record's fields sit VERBATIM under
1998 /// `record` (one schema with the JSONL log), and `lagged` carries the dropped count.
1999 #[test]
2000 fn stream_frames_roundtrip_with_the_documented_tags() {
2001 let snap = StreamFrame::Snapshot {
2002 active_sessions: vec![ActiveSession {
2003 peer: "bob".into(),
2004 service: "notes".into(),
2005 opened_at: 1_751_760_000,
2006 }],
2007 reachability: vec![PeerReachability {
2008 name: "bob".into(),
2009 reachable: true,
2010 rtt_ms: Some(42),
2011 age_secs: Some(3),
2012 meta: String::new(),
2013 principal: None,
2014 path: Default::default(),
2015 }],
2016 };
2017 let v = serde_json::to_value(&snap).unwrap();
2018 assert_eq!(v["type"], "snapshot");
2019 assert_eq!(v["active_sessions"][0]["peer"], "bob");
2020 assert_eq!(v["active_sessions"][0]["opened_at"], 1_751_760_000i64);
2021 assert_eq!(v["reachability"][0]["name"], "bob");
2022 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), snap);
2023
2024 let event = StreamFrame::Event {
2025 record: Box::new(AuditRecord::session_open(
2026 "2026-07-03T14:02:11.480Z".into(),
2027 Some("bob".into()),
2028 "notes".into(),
2029 )),
2030 };
2031 let v = serde_json::to_value(&event).unwrap();
2032 assert_eq!(v["type"], "event");
2033 // The record's fields ride verbatim under `record` — no Box indirection on the wire.
2034 assert_eq!(v["record"]["kind"], "session_open");
2035 assert_eq!(v["record"]["peer"], "bob");
2036 assert_eq!(v["record"]["service"], "notes");
2037 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), event);
2038
2039 let lagged = StreamFrame::Lagged { dropped: 12 };
2040 let v = serde_json::to_value(&lagged).unwrap();
2041 assert_eq!(v, serde_json::json!({ "type": "lagged", "dropped": 12 }));
2042 assert_eq!(serde_json::from_value::<StreamFrame>(v).unwrap(), lagged);
2043 }
2044
2045 /// A frame minted by a NEWER daemon (an unknown `type`) fails to deserialize rather than
2046 /// mis-parsing — the typed stream surface is closed; a forward-compatible consumer reads the
2047 /// raw `Value` stream instead (`ControlClient::open_stream`).
2048 #[test]
2049 fn unknown_stream_frame_type_is_rejected() {
2050 let future = serde_json::json!({ "type": "future_kind", "x": 1 });
2051 assert!(serde_json::from_value::<StreamFrame>(future).is_err());
2052 }
2053
2054 #[test]
2055 fn audit_summary_request_and_result_roundtrip() {
2056 // Request::AuditSummary is parameterless → `{ "method": "audit_summary" }`. Like Status, it
2057 // tolerates omitted/null params; the server dispatches on the method string (method_of).
2058 let r = Request::AuditSummary;
2059 assert_eq!(serde_json::to_value(&r).unwrap()["method"], "audit_summary");
2060 assert_eq!(
2061 method_of(&serde_json::json!({"method": "audit_summary"})),
2062 Some("audit_summary")
2063 );
2064
2065 // AuditSummaryResult carries LOCAL per-peer / per-service session counts (nicknames + service
2066 // names only — never endpoints/transport terms) + a total. Tuples mirror kb's
2067 // InsightResponse.per_peer_contribution: `["bob", 2]` on the wire.
2068 let res = AuditSummaryResult {
2069 per_peer: vec![("alice".into(), 1), ("bob".into(), 2)],
2070 per_service: vec![("kb".into(), 1), ("notes".into(), 3)],
2071 total_sessions: 4,
2072 };
2073 let v = serde_json::to_value(&res).unwrap();
2074 assert_eq!(v["per_peer"][1][0], "bob");
2075 assert_eq!(v["per_peer"][1][1], 2u64);
2076 assert_eq!(v["per_service"][1][0], "notes");
2077 assert_eq!(v["total_sessions"], 4u64);
2078 assert_eq!(
2079 serde_json::from_value::<AuditSummaryResult>(v).unwrap(),
2080 res
2081 );
2082
2083 // Additive-only: a result minted by an older daemon (no `total_sessions` key) still
2084 // deserializes — the `#[serde(default)]` fills it with 0.
2085 let old_shape = serde_json::json!({ "per_peer": [], "per_service": [] });
2086 let back: AuditSummaryResult = serde_json::from_value(old_shape).unwrap();
2087 assert_eq!(back.total_sessions, 0);
2088 assert!(back.per_peer.is_empty());
2089 }
2090}