Skip to main content

dig_node_control_interface/
method.rs

1//! The canonical control-method catalog.
2//!
3//! [`ControlMethod`] enumerates every method a client can send to a running dig-node's CONTROL
4//! plane, its stable wire name, whether it requires the local control token, whether it is a
5//! pairing-administration method (which requires the MASTER token specifically), and how the node
6//! routes it (owned by the service shell, delegated to the embedded node engine, or an open
7//! pairing-bootstrap method reachable without a token).
8//!
9//! This is the SINGLE source of truth for "what can be controlled". The node dispatchers, the
10//! client SDKs (CLI `dign`, the extension, dig-app, hub), the OpenRPC/discovery surface, and the
11//! conformance KATs all read this one table, so the method set can never drift between them.
12//!
13//! Mirrors the live dig-node surface: the shell-owned methods in
14//! `dig-node-service/src/control.rs` (`CONTROL_METHODS`) plus the peer/subscription methods
15//! delegated to `dig-node-core` (`control.peerStatus` / `control.peers.*` / `control.subscribe`
16//! / `control.unsubscribe` / `control.listSubscriptions`), and the two OPEN pairing-bootstrap
17//! methods (`pairing.request` / `pairing.poll`) a token-less MV3 extension uses to obtain a
18//! scoped token after local operator approval.
19
20/// How the node resolves a control method — the routing source of truth.
21#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
22pub enum Routing {
23    /// Answered by the dig-node service shell itself (config/status/cache/pins/sync/updater/pairing-admin).
24    Owned,
25    /// Delegated to the embedded dig-node engine's own control surface (peers + subscriptions).
26    Delegated,
27    /// An OPEN bootstrap method reachable WITHOUT the control token (pairing handshake).
28    OpenBootstrap,
29}
30
31/// The functional area a control method belongs to — for grouping in UIs and docs.
32#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
33pub enum Category {
34    /// Node status snapshot.
35    Status,
36    /// Node configuration (upstream override).
37    Config,
38    /// Live log-level control.
39    Log,
40    /// On-disk content cache.
41    Cache,
42    /// Hosted/pinned stores.
43    HostedStores,
44    /// §21 authenticated whole-store sync.
45    Sync,
46    /// The DIG auto-update beacon proxy.
47    Updater,
48    /// Control-token pairing lifecycle.
49    Pairing,
50    /// The L7 peer network: the live pool snapshot, the per-network peer counts, and dial/drop.
51    Peers,
52    /// The node's subscribed-store set.
53    Subscriptions,
54    /// Wallet chain transport: the read-only chain views (balance, coins, one coin by id, peak,
55    /// sync status) plus the push of an already-signed spend bundle.
56    Wallet,
57    /// The automated-spend AUDIT record: what this node signed WITHOUT per-transaction approval.
58    /// Read-only; nothing in this category initiates, signs or alters a spend.
59    Spends,
60    /// dig-profile BODIES: handing the node the bytes a confirmed on-chain root commits to, and
61    /// reading one back. The chain root itself is never written here -- dig-app signs and pushes
62    /// that (§908); this category moves only the bytes an already-confirmed root commits to.
63    Profile,
64}
65
66/// A dig-node CONTROL method.
67///
68/// `#[non_exhaustive]` so adding a method in a minor release is additive; downstream matches must
69/// carry a `_ => …` arm. Convert to/from the wire name with [`ControlMethod::name`] /
70/// [`ControlMethod::from_name`].
71#[non_exhaustive]
72#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
73pub enum ControlMethod {
74    // ---- Status / config / log (shell-owned) ----
75    /// `control.status` — a rich node status snapshot.
76    Status,
77    /// `control.config.get` — the node's effective configuration.
78    ConfigGet,
79    /// `control.config.setUpstream` — persist an upstream-RPC override (effective on restart).
80    ConfigSetUpstream,
81    /// `control.log.setLevel` — live-swap the running node's tracing level filter.
82    LogSetLevel,
83
84    // ---- Cache (shell-owned) ----
85    /// `control.cache.get` — the on-disk cache view (cap/used/dir/shared).
86    CacheGet,
87    /// `control.cache.setCap` — set the cache size cap (floored at 64 MiB).
88    CacheSetCap,
89    /// `control.cache.clear` — delete all locally cached content.
90    CacheClear,
91
92    // ---- Hosted stores (shell-owned) ----
93    /// `control.hostedStores.list` — every held/pinned store with its cached capsules.
94    HostedStoresList,
95    /// `control.hostedStores.pin` — pin a store (and pre-fetch when a root is given).
96    HostedStoresPin,
97    /// `control.hostedStores.unpin` — unpin a store and evict its cached capsules.
98    HostedStoresUnpin,
99    /// `control.hostedStores.status` — per-store pinned flag + cached capsules.
100    HostedStoresStatus,
101    /// `control.capsule.fetch` — start (or report already-cached) a P2P whole-capsule pull for
102    /// one store+root, over the recursive discover-then-dial path rather than the §21 HTTP sync.
103    CapsuleFetch,
104
105    // ---- §21 sync (shell-owned) ----
106    /// `control.sync.status` — whether authenticated whole-store sync is available + pin coverage.
107    SyncStatus,
108    /// `control.sync.trigger` — trigger a §21 sync for one capsule (storeId + root).
109    SyncTrigger,
110
111    // ---- Updater beacon proxy (shell-owned) ----
112    /// `control.updater.status` — the DIG auto-update beacon's current status.
113    UpdaterStatus,
114    /// `control.updater.setChannel` — set the beacon's update channel.
115    UpdaterSetChannel,
116    /// `control.updater.pause` — suspend auto-updates (optionally until a unix time).
117    UpdaterPause,
118    /// `control.updater.resume` — resume auto-updates.
119    UpdaterResume,
120    /// `control.updater.checkNow` — force an immediate update check.
121    UpdaterCheckNow,
122
123    // ---- Pairing administration (shell-owned, MASTER-token only) ----
124    /// `control.pairing.list` — list pending pairing requests + issued paired tokens.
125    PairingList,
126    /// `control.pairing.approve` — approve a pending pairing, minting a scoped token.
127    PairingApprove,
128    /// `control.pairing.revoke` — revoke an issued paired token.
129    PairingRevoke,
130
131    // ---- Peers (delegated to the engine) ----
132    /// `control.peerStatus` — live peer-pool + relay-reservation snapshot.
133    PeerStatus,
134    /// `control.peerCounts` — how many peers this node holds on EACH network (DIG and Chia).
135    PeerCounts,
136    /// `control.peers.connect` — dial a peer by address / resolve a connected peer_id.
137    PeersConnect,
138    /// `control.peers.disconnect` — drop a pooled peer by peer_id.
139    PeersDisconnect,
140
141    // ---- Trusted CHIA full-node peers (shell-owned) ----
142    //
143    // A DIFFERENT network from `control.peers.*` above, which are DIG gossip peers. These name
144    // Chia full nodes the wallet replica will TRUST, and trust here is a real cost: NC-12 makes
145    // dialled peers untrusted precisely so that agreement across several concurrently-queried
146    // peers is what makes a read safe. A trusted peer is exempted from that agreement, so a wrong
147    // or hostile one is believed on its own. Every surface that offers these MUST say so.
148    //
149    // Trust comes from the operator declaring a node THEIR OWN — that is the whole of the
150    // authorisation, and the wording everywhere in this crate says exactly that. It is not
151    // "a node you vouch for": the unbounded authority a trusted peer holds is justified by the
152    // operator controlling both ends, which is false of a stranger's node however well
153    // recommended. A person can be talked into vouching for an address; they cannot be talked
154    // into believing they run it.
155    /// `control.chiaPeers.add` — trust a Chia full node you RUN, bypassing corroboration for it.
156    ChiaPeersAdd,
157    /// `control.chiaPeers.list` — the trusted Chia full-node peers this node tracks.
158    ChiaPeersList,
159    /// `control.chiaPeers.remove` — stop trusting a Chia full node (optionally banning it).
160    ChiaPeersRemove,
161
162    // ---- Subscriptions (delegated to the engine) ----
163    /// `control.subscribe` — subscribe the node to a store (watch + gap-fill).
164    Subscribe,
165    /// `control.unsubscribe` — stop watching a store.
166    Unsubscribe,
167    /// `control.listSubscriptions` — the node's persisted subscription set.
168    ListSubscriptions,
169
170    // ---- Wallet chain transport (delegated to the engine) ----
171    /// `control.wallet.balance` — read an address's confirmed spendable balance for an asset.
172    WalletBalance,
173    /// `control.wallet.coins` — read an address's spendable coin records for an asset.
174    WalletCoins,
175    /// `control.wallet.coinById` — read ONE coin record by coin id, spent or unspent.
176    WalletCoinById,
177    /// `control.wallet.coinSpend` — read the SPEND that spent a coin (puzzle reveal + solution).
178    WalletCoinSpend,
179    /// `control.wallet.coinsByParent` — read the direct children a coin's spend created (one hop).
180    WalletCoinsByParent,
181    /// `control.wallet.arrivals` — read confirmed INCOMING funds since a cursor position.
182    WalletArrivals,
183    /// `control.wallet.peak` — read the node's current chain peak height.
184    WalletPeak,
185    /// `control.wallet.syncStatus` — read whether the wallet's chain replica is being kept current.
186    WalletSyncStatus,
187    /// `control.wallet.broadcast` — push an ALREADY-SIGNED spend bundle to the network.
188    WalletBroadcast,
189    /// `control.wallet.watch` — enrol PUBLIC keys for the node's chain replica to follow.
190    WalletWatch,
191    /// `control.wallet.unwatch` — deregister enrolled public keys, so the following stops.
192    WalletUnwatch,
193    /// `control.wallet.watched` — list the public keys currently enrolled.
194    WalletWatched,
195    /// `control.wallet.reservations.held` — read which coins are committed to in-flight spends.
196    WalletReservationsHeld,
197    /// `control.wallet.reservations.reserve` — atomically hold coins, all of them or none.
198    WalletReservationsReserve,
199    /// `control.wallet.reservations.release` — free a hold now, ahead of its TTL.
200    WalletReservationsRelease,
201
202    // ---- Automated-spend audit record (shell-owned) ----
203    /// `control.spends.list` — read the record of spends this node made WITHOUT asking.
204    SpendsList,
205
206    // ---- dig-profile bodies (delegated to the engine) ----
207    /// `control.profile.putBody` — hand the node the profile body a CONFIRMED chain root commits to.
208    ProfilePutBody,
209    /// `control.profile.getBody` — read back the profile body this node holds at a given root.
210    ProfileGetBody,
211
212    // ---- Pairing bootstrap (OPEN — no token) ----
213    /// `pairing.request` — request a control-token pairing (returns a code to compare).
214    PairingRequest,
215    /// `pairing.poll` — poll a pairing; once the operator approves, returns the scoped token once.
216    PairingPoll,
217}
218
219impl ControlMethod {
220    /// The stable JSON-RPC wire name. Never derived from anything else — the published contract.
221    pub const fn name(self) -> &'static str {
222        match self {
223            ControlMethod::Status => "control.status",
224            ControlMethod::ConfigGet => "control.config.get",
225            ControlMethod::ConfigSetUpstream => "control.config.setUpstream",
226            ControlMethod::LogSetLevel => "control.log.setLevel",
227            ControlMethod::CacheGet => "control.cache.get",
228            ControlMethod::CacheSetCap => "control.cache.setCap",
229            ControlMethod::CacheClear => "control.cache.clear",
230            ControlMethod::HostedStoresList => "control.hostedStores.list",
231            ControlMethod::HostedStoresPin => "control.hostedStores.pin",
232            ControlMethod::HostedStoresUnpin => "control.hostedStores.unpin",
233            ControlMethod::HostedStoresStatus => "control.hostedStores.status",
234            ControlMethod::CapsuleFetch => "control.capsule.fetch",
235            ControlMethod::SyncStatus => "control.sync.status",
236            ControlMethod::SyncTrigger => "control.sync.trigger",
237            ControlMethod::UpdaterStatus => "control.updater.status",
238            ControlMethod::UpdaterSetChannel => "control.updater.setChannel",
239            ControlMethod::UpdaterPause => "control.updater.pause",
240            ControlMethod::UpdaterResume => "control.updater.resume",
241            ControlMethod::UpdaterCheckNow => "control.updater.checkNow",
242            ControlMethod::PairingList => "control.pairing.list",
243            ControlMethod::PairingApprove => "control.pairing.approve",
244            ControlMethod::PairingRevoke => "control.pairing.revoke",
245            ControlMethod::PeerStatus => "control.peerStatus",
246            ControlMethod::PeerCounts => "control.peerCounts",
247            ControlMethod::PeersConnect => "control.peers.connect",
248            ControlMethod::PeersDisconnect => "control.peers.disconnect",
249            ControlMethod::ChiaPeersAdd => "control.chiaPeers.add",
250            ControlMethod::ChiaPeersList => "control.chiaPeers.list",
251            ControlMethod::ChiaPeersRemove => "control.chiaPeers.remove",
252            ControlMethod::Subscribe => "control.subscribe",
253            ControlMethod::Unsubscribe => "control.unsubscribe",
254            ControlMethod::ListSubscriptions => "control.listSubscriptions",
255            ControlMethod::WalletBalance => "control.wallet.balance",
256            ControlMethod::WalletCoins => "control.wallet.coins",
257            ControlMethod::WalletCoinById => "control.wallet.coinById",
258            ControlMethod::WalletCoinSpend => "control.wallet.coinSpend",
259            ControlMethod::WalletCoinsByParent => "control.wallet.coinsByParent",
260            ControlMethod::WalletArrivals => "control.wallet.arrivals",
261            ControlMethod::WalletPeak => "control.wallet.peak",
262            ControlMethod::WalletSyncStatus => "control.wallet.syncStatus",
263            ControlMethod::WalletBroadcast => "control.wallet.broadcast",
264            ControlMethod::WalletWatch => "control.wallet.watch",
265            ControlMethod::WalletUnwatch => "control.wallet.unwatch",
266            ControlMethod::WalletWatched => "control.wallet.watched",
267            ControlMethod::WalletReservationsHeld => "control.wallet.reservations.held",
268            ControlMethod::WalletReservationsReserve => "control.wallet.reservations.reserve",
269            ControlMethod::WalletReservationsRelease => "control.wallet.reservations.release",
270            ControlMethod::SpendsList => "control.spends.list",
271            ControlMethod::ProfilePutBody => "control.profile.putBody",
272            ControlMethod::ProfileGetBody => "control.profile.getBody",
273            ControlMethod::PairingRequest => "pairing.request",
274            ControlMethod::PairingPoll => "pairing.poll",
275        }
276    }
277
278    /// Resolve a wire name back to its [`ControlMethod`], or `None` for an unknown name.
279    pub fn from_name(name: &str) -> Option<ControlMethod> {
280        ControlMethod::ALL
281            .iter()
282            .copied()
283            .find(|m| m.name() == name)
284    }
285
286    /// Does calling this method require the local control token?
287    ///
288    /// Three groups are reachable WITHOUT one, and they are open for two different reasons:
289    ///
290    /// - the pairing bootstrap (`pairing.request` / `pairing.poll`), so a token-less client can
291    ///   obtain a token at all;
292    /// - the PEER COUNTS (`control.peerCounts`), which disclose three integers about this node's
293    ///   own connectivity and no address, endpoint or secret;
294    /// - the wallet CALLER-ADDRESSED CHAIN READS (`control.wallet.balance` / `.coins` /
295    ///   `.coinById` / `.coinSpend` / `.coinsByParent`) and the node's own chain POSITION
296    ///   (`.peak` / `.syncStatus`), because each needs only PUBLIC chain data the CALLER already
297    ///   named — an address, or a coin id; never a seed, a key, or a signature — and dig-node has
298    ///   served `control.wallet.balance` open since #1851. A person whose node runs as a service
299    ///   with an unreadable token file can still see their own money.
300    ///
301    /// Five wallet methods are deliberately NOT in that second group:
302    ///
303    /// - `control.wallet.broadcast` puts bytes on the network, so the token is what stands between
304    ///   a local process and a broadcast — a mutation on the chain state itself;
305    /// - `control.wallet.watch` and `.unwatch` aim what this node follows, so they are mutations
306    ///   of this node's own watched-key set;
307    /// - `control.wallet.arrivals` and `.watched` take nothing from the caller and answer back
308    ///   with this node's OWN state — watched puzzle hashes and enrolled public keys respectively.
309    ///
310    /// See [`ControlMethod::is_open_read`]. On all five, `UNAUTHORIZED` genuinely means
311    /// *unauthorized*.
312    pub const fn requires_auth(self) -> bool {
313        !self.is_open_read()
314            && !matches!(
315                self,
316                ControlMethod::PairingRequest | ControlMethod::PairingPoll
317            )
318    }
319
320    /// Is this an OPEN READ — served without a control token?
321    ///
322    /// Two kinds of method qualify, and they are open for different reasons:
323    ///
324    /// - the wallet CHAIN READS (`control.wallet.balance` / `.coins` / `.coinById` / `.coinSpend` /
325    ///   `.coinsByParent` / `.peak` / `.syncStatus`), which need only PUBLIC chain data — an
326    ///   address, or a coin id; never a seed, a key, or a signature. On the first five the CALLER
327    ///   supplies the address or coin id, so the node relays a public fact and discloses no
328    ///   association with itself; the last two name the node's own chain position and no address
329    ///   at all;
330    /// - `control.peerCounts`, which is NOT a chain read: it discloses three integers about this
331    ///   node's own connectivity, and no address, endpoint, peer identity or secret. The identity
332    ///   and topology half of the same subject stays gated behind `control.peerStatus`.
333    ///
334    /// Naming both reasons matters more than it looks. The test for membership is *does this
335    /// disclose only data that is already public, or a bare count of this node's own state?* — NOT
336    /// *is it a chain read?* A future method judged against the narrower phrasing, and found to
337    /// contradict a member that was already there, invites widening the predicate by analogy rather
338    /// than against the rule.
339    ///
340    /// `control.wallet.arrivals` is the worked example, and it was briefly a member. It passes the
341    /// narrower phrasing — every field it returns is a public chain fact — and fails the rule: the
342    /// caller supplies NOTHING, so the node volunteers its OWN watched puzzle hashes together with
343    /// the full receive history behind them. The individual facts are public; the ASSOCIATION
344    /// between this node and those addresses is not, and that association is the whole answer. A
345    /// token-less caller could then feed those addresses back into the caller-addressed reads.
346    /// Membership turns on *who names the address*, never on whether the bytes are on chain.
347    ///
348    /// Stated on the contract rather than discovered by calling, because the two refusals a client
349    /// can get here demand OPPOSITE remedies. On an open read, `UNAUTHORIZED` can only come from a
350    /// node build that predates the method and gates it generically, so the remedy is an upgrade.
351    /// On a gated method — the push — `UNAUTHORIZED` means exactly what it says, and the remedy is
352    /// the token. A client that maps the two the same way sends somebody to fix the wrong thing.
353    pub const fn is_open_read(self) -> bool {
354        matches!(
355            self,
356            ControlMethod::WalletBalance
357                | ControlMethod::WalletCoins
358                | ControlMethod::WalletCoinById
359                | ControlMethod::WalletCoinSpend
360                | ControlMethod::WalletCoinsByParent
361                | ControlMethod::WalletPeak
362                | ControlMethod::WalletSyncStatus
363                | ControlMethod::PeerCounts
364        )
365    }
366
367    /// Is this a PAIRING-ADMINISTRATION method that requires the MASTER control token specifically?
368    ///
369    /// A paired (scoped) token can drive ordinary `control.*` mutations but MUST NOT mint more
370    /// tokens or revoke itself — so listing/approving/revoking pairings requires the master token
371    /// (a local file read), never a paired token.
372    ///
373    /// This names the pairing LIFECYCLE only. The predicate an auth gate consults is
374    /// [`ControlMethod::requires_master_token`], of which this is a strict subset.
375    pub const fn is_pairing_admin(self) -> bool {
376        matches!(
377            self,
378            ControlMethod::PairingList
379                | ControlMethod::PairingApprove
380                | ControlMethod::PairingRevoke
381        )
382    }
383
384    /// Does this method require the MASTER control token — the local file read — rather than any
385    /// valid token?
386    ///
387    /// **This, not [`ControlMethod::is_pairing_admin`], is the predicate an auth gate consults.**
388    /// The master tier is not "pairing administration"; it is every method whose effect OUTLIVES
389    /// the token that invoked it, and pairing administration is one instance of that shape.
390    ///
391    /// The rule, stated so a later method can be judged against it rather than by analogy: a
392    /// method belongs here when a caller holding a paired token could use it to acquire authority
393    /// it keeps AFTER that token is revoked. `pairing.revoke` is the designated remedy for a
394    /// compromised paired app, so any method that survives it has escaped the remedy.
395    ///
396    /// The two members outside the pairing lifecycle are `control.chiaPeers.add` and
397    /// `control.chiaPeers.remove`, and they are here for exactly that reason. `add` writes a
398    /// standing entry into the peer store the wallet replica reads, and a peer in that set is
399    /// believed WITHOUT corroboration — it can dictate money-bearing chain facts (peak height, and
400    /// therefore confirmation counts). Once written, the caller no longer needs the token at all,
401    /// and revoking the token does not remove the entry. A paired token must therefore not be able
402    /// to write one. `remove` is the only un-trust remedy and is gated with it, so a paired token
403    /// cannot strip the peers an operator deliberately trusts.
404    ///
405    /// `control.chiaPeers.list` deliberately stays on the ordinary token tier: it is a READ, it
406    /// grants nothing that outlives the token, and gating it would leave a paired client unable to
407    /// show the operator the trust state it is subject to. That matches `control.wallet.arrivals`,
408    /// which is gated at the ordinary tier for disclosing an association without conferring
409    /// authority.
410    pub const fn requires_master_token(self) -> bool {
411        self.is_pairing_admin()
412            || matches!(
413                self,
414                ControlMethod::ChiaPeersAdd | ControlMethod::ChiaPeersRemove
415            )
416    }
417
418    /// How the node routes this method (shell-owned, engine-delegated, or open bootstrap).
419    pub const fn routing(self) -> Routing {
420        match self {
421            ControlMethod::PeerStatus
422            | ControlMethod::PeerCounts
423            | ControlMethod::PeersConnect
424            | ControlMethod::PeersDisconnect
425            | ControlMethod::Subscribe
426            | ControlMethod::Unsubscribe
427            | ControlMethod::ListSubscriptions
428            | ControlMethod::WalletBalance
429            | ControlMethod::WalletCoins
430            | ControlMethod::WalletCoinById
431            | ControlMethod::WalletCoinSpend
432            | ControlMethod::WalletCoinsByParent
433            | ControlMethod::WalletArrivals
434            | ControlMethod::WalletPeak
435            | ControlMethod::WalletSyncStatus
436            | ControlMethod::WalletBroadcast
437            | ControlMethod::WalletWatch
438            | ControlMethod::WalletUnwatch
439            | ControlMethod::WalletWatched
440            | ControlMethod::WalletReservationsHeld
441            | ControlMethod::WalletReservationsReserve
442            | ControlMethod::WalletReservationsRelease
443            | ControlMethod::ProfilePutBody
444            | ControlMethod::ProfileGetBody => Routing::Delegated,
445            ControlMethod::PairingRequest | ControlMethod::PairingPoll => Routing::OpenBootstrap,
446            _ => Routing::Owned,
447        }
448    }
449
450    /// The functional area this method belongs to.
451    pub const fn category(self) -> Category {
452        match self {
453            ControlMethod::Status => Category::Status,
454            ControlMethod::ConfigGet | ControlMethod::ConfigSetUpstream => Category::Config,
455            ControlMethod::LogSetLevel => Category::Log,
456            ControlMethod::CacheGet | ControlMethod::CacheSetCap | ControlMethod::CacheClear => {
457                Category::Cache
458            }
459            ControlMethod::HostedStoresList
460            | ControlMethod::HostedStoresPin
461            | ControlMethod::HostedStoresUnpin
462            | ControlMethod::HostedStoresStatus
463            | ControlMethod::CapsuleFetch => Category::HostedStores,
464            ControlMethod::SyncStatus | ControlMethod::SyncTrigger => Category::Sync,
465            ControlMethod::UpdaterStatus
466            | ControlMethod::UpdaterSetChannel
467            | ControlMethod::UpdaterPause
468            | ControlMethod::UpdaterResume
469            | ControlMethod::UpdaterCheckNow => Category::Updater,
470            ControlMethod::PairingList
471            | ControlMethod::PairingApprove
472            | ControlMethod::PairingRevoke
473            | ControlMethod::PairingRequest
474            | ControlMethod::PairingPoll => Category::Pairing,
475            ControlMethod::PeerStatus
476            | ControlMethod::PeerCounts
477            | ControlMethod::PeersConnect
478            | ControlMethod::PeersDisconnect
479            | ControlMethod::ChiaPeersAdd
480            | ControlMethod::ChiaPeersList
481            | ControlMethod::ChiaPeersRemove => Category::Peers,
482            ControlMethod::Subscribe
483            | ControlMethod::Unsubscribe
484            | ControlMethod::ListSubscriptions => Category::Subscriptions,
485            ControlMethod::WalletBalance
486            | ControlMethod::WalletCoins
487            | ControlMethod::WalletCoinById
488            | ControlMethod::WalletCoinSpend
489            | ControlMethod::WalletCoinsByParent
490            | ControlMethod::WalletArrivals
491            | ControlMethod::WalletPeak
492            | ControlMethod::WalletSyncStatus
493            | ControlMethod::WalletBroadcast
494            | ControlMethod::WalletWatch
495            | ControlMethod::WalletUnwatch
496            | ControlMethod::WalletWatched
497            | ControlMethod::WalletReservationsHeld
498            | ControlMethod::WalletReservationsReserve
499            | ControlMethod::WalletReservationsRelease => Category::Wallet,
500            ControlMethod::SpendsList => Category::Spends,
501            ControlMethod::ProfilePutBody | ControlMethod::ProfileGetBody => Category::Profile,
502        }
503    }
504
505    /// A one-line human/agent description for the discovery catalogue.
506    pub const fn summary(self) -> &'static str {
507        match self {
508            ControlMethod::ChiaPeersAdd => "Trust a Chia full node by IP. A trusted peer BYPASSES CORROBORATION: this node normally believes a chain answer only when several independently-dialled peers agree, and a trusted peer is believed on its own -- so a wrong or hostile one can feed this node a false view of the chain. Add only a node you run yourself.",
509            ControlMethod::ChiaPeersList => "The Chia full-node peers this node tracks, each flagged user_managed: true where a person added it by hand and it is therefore trusted without corroboration.",
510            ControlMethod::ChiaPeersRemove => "Stop trusting a Chia full node, optionally banning it. Removing restores corroboration for that peer: chain answers must once again be agreed by independently-dialled peers.",
511            ControlMethod::Status => "A rich node status snapshot (version, uptime, addr, cache, hosted/pinned counts, sync availability).",
512            ControlMethod::ConfigGet => "The node's effective configuration (addr/port, upstream + override, cache dir/shared, config path, sync availability).",
513            ControlMethod::ConfigSetUpstream => "Persist an upstream-RPC override; takes effect on next node start (requires_restart).",
514            ControlMethod::LogSetLevel => "Live-swap the running node's tracing EnvFilter directive (not persisted).",
515            ControlMethod::CacheGet => "The on-disk content-cache view: cap_bytes, used_bytes, dir, shared.",
516            ControlMethod::CacheSetCap => "Set the on-disk cache size cap in bytes (floored at 64 MiB).",
517            ControlMethod::CacheClear => "Delete all locally cached DIG content.",
518            ControlMethod::HostedStoresList => "Every held/pinned store, merged, with each store's cached capsules and a pinned flag.",
519            ControlMethod::HostedStoresPin => "Pin a store (storeId[:rootHash]); pre-fetches the capsule when a root is given and §21 sync is available.",
520            ControlMethod::HostedStoresUnpin => "Unpin a store and evict its cached capsules.",
521            ControlMethod::HostedStoresStatus => "Per-store status: pinned flag, cached capsules, total bytes.",
522            ControlMethod::CapsuleFetch => "Start a P2P whole-capsule pull for one store+root over the recursive discover-then-dial path (distinct from the §21 HTTP sync `control.sync.trigger` uses). Answers `already_cached` without dialling out when the capsule is already on disk.",
523            ControlMethod::SyncStatus => "Whether authenticated §21 whole-store sync is available, plus pinned-store cache coverage.",
524            ControlMethod::SyncTrigger => "Trigger a §21 sync for one capsule (storeId + root).",
525            ControlMethod::UpdaterStatus => "The DIG auto-update beacon's current status (proxied from dig-updater).",
526            ControlMethod::UpdaterSetChannel => "Set the beacon's update channel (\"nightly\" | \"stable\").",
527            ControlMethod::UpdaterPause => "Suspend the beacon's auto-updates (optionally until a unix time).",
528            ControlMethod::UpdaterResume => "Resume the beacon's auto-updates.",
529            ControlMethod::UpdaterCheckNow => "Force an immediate beacon update check.",
530            ControlMethod::PairingList => "List pending pairing requests and issued paired tokens (MASTER token only).",
531            ControlMethod::PairingApprove => "Approve a pending pairing, minting a scoped token (MASTER token only).",
532            ControlMethod::PairingRevoke => "Revoke an issued paired token by token_id (MASTER token only).",
533            ControlMethod::PeerStatus => "Live peer-pool + relay-reservation snapshot, including the per-peer connected array; each entry carries an always-present `software` field (the peer's advertised build). Its `relay.peer_count` counts peers connected to THE RELAY, not to this node, and is never the answer to \"how many peers does this node have\" -- that is control.peerCounts.",
534            ControlMethod::PeerCounts => "READ-only: how many peers this node holds on EACH network -- dig_peer_count (DIG content/gossip, port 9445) and chia_peer_count (Chia full nodes serving the wallet chain sync). Two unrelated numbers, each named for its network.",
535            ControlMethod::PeersConnect => "Dial a peer by address, or resolve an already-connected peer_id, via the live gossip pool.",
536            ControlMethod::PeersDisconnect => "Drop a pooled peer by peer_id, closing its mTLS link (idempotent).",
537            ControlMethod::Subscribe => "Subscribe the node to a store it actively watches and gap-fills.",
538            ControlMethod::Unsubscribe => "Stop watching a store.",
539            ControlMethod::ListSubscriptions => "The node's persisted subscription set + count.",
540            ControlMethod::WalletCoins => "READ-only: the spendable coin records for an address + asset, with the tier that answered and the height they reflect.",
541            ControlMethod::WalletCoinById => "READ-only: ONE coin record by coin id, spent or unspent, with no address and no asset scope; `coin: null` means the chain holds no such coin.",
542            ControlMethod::WalletCoinSpend => "READ-only: the SPEND that spent a coin -- its puzzle reveal, its solution and the coin itself -- named by the coin's own id. `spend: null` means the consulted chain shows that coin as unspent or unknown; it NEVER means the chain could not be reached, which is an error.",
543            ControlMethod::WalletCoinsByParent => "READ-only: the DIRECT children created by spending one coin, named by that parent's coin id. ONE hop, never a recursive walk: an empty list means the parent created no known children, and a caller wanting a lineage composes hops itself.",
544            ControlMethod::WalletArrivals => "READ-only: confirmed INCOMING funds recorded since a cursor position, oldest first -- the answer to `was I just paid?`, which no balance or coin list can give. Each row is a coin the node determined ARRIVED: confirmed on chain, above the wallet's arrival baseline, not previously reported, and not the wallet's own change. Resume from `cursor` (the last row you were handed), never from `latest`.",
545            ControlMethod::WalletPeak => "READ-only: the node's current chain peak height, independent of any address.",
546            ControlMethod::WalletSyncStatus => "READ-only: whether the wallet's CHAIN replica is being kept current (not_started/syncing/synced/no_wallet_enrolled/wallet_not_unlocked), the replica's own height, and its CHIA full-node peer count -- unrelated to control.sync.status (DIG stores) and to control.peerStatus (DIG peers).",
547            ControlMethod::WalletBroadcast => "Push an ALREADY-SIGNED spend bundle to the network; the node never signs. TOKEN-GATED.",
548            ControlMethod::WalletBalance => "READ-only: the confirmed spendable balance for an address + asset (plus pending, sync freshness, and the peak height it reflects).",
549            ControlMethod::WalletWatch => "Enrol PUBLIC keys (48-byte G1, lowercase 96-hex) for the node's chain replica to follow, so their addresses are synced and readable. IDEMPOTENT: re-enrolling a key already enrolled succeeds and changes nothing. Keys, never puzzle hashes -- the node derives the addresses itself, so one derivation serves every client. TOKEN-GATED.",
550            ControlMethod::WalletUnwatch => "Deregister enrolled public keys, so the node stops following their addresses. IDEMPOTENT: a key that was never enrolled is not an error. TOKEN-GATED.",
551            ControlMethod::SpendsList => "READ-only: the record of spends this node made WITHOUT per-transaction approval -- what moved, when, on whose standing authority, and whether the chain confirmed it. It NEVER initiates, signs, cancels or alters a spend, and there is no verb here that edits an entry. A failed spend is reported WITH the stage it died at, because only a signing failure means the money definitely did not move; a broadcast or confirmation failure is an UNKNOWN outcome, as is `unresolved`. A page is bounded and says so via `complete`; `unreadable_lines` reports entries the node could not parse, so an audit trail that lost rows can never read as a tidy shorter one. TOKEN-GATED although it is a read: the caller supplies no identifier, so the answer is this node's OWN state.",
552            ControlMethod::ProfilePutBody => "Hand the node the dig-profile BODY that a chain root commits to. The node INDEPENDENTLY resolves that root on chain and REFUSES any body whose recomputed root is not the confirmed one -- the caller's `root` is a claim to be checked, never a fact to be trusted, and dig-app is a caller like any other. Bodies are capped at MAX_BODY_BYTES (4 MiB). TOKEN-GATED.",
553            ControlMethod::ProfileGetBody => "READ-only: the dig-profile body this node holds at a given store id + root, or `body: null` when it holds none. `null` NEVER means the body could not be read, which is an error. TOKEN-GATED.",
554            ControlMethod::WalletWatched => "READ-only: the public keys currently enrolled, so a client can reconcile what it asked for against what the node holds. TOKEN-GATED although it is a read -- the caller supplies nothing, so the answer is this node's OWN key set.",
555            ControlMethod::WalletReservationsHeld => "READ-only: every coin currently committed to an in-flight spend, each with the reservation holding it and the unix second that hold lapses, plus the node's own clock. `reserved: []` means NOTHING is held; a set that cannot be read is an error, never an empty list. Narrows what a caller may SELECT; never subtract these from a balance -- the coins are still the user's money. TOKEN-GATED although it is a read: the caller supplies nothing, so the answer is this node's OWN state.",
556            ControlMethod::WalletReservationsReserve => "Atomically hold coins against further selection: EVERY named coin or none. A coin already held refuses the whole call and reserves nothing, as WALLET_COINS_RESERVED -- a WAIT, never a shortfall. Reserving an empty list succeeds with a handle that releases nothing. The requested ttl_secs is clamped by the node, which returns the lifetime it actually applied. Bookkeeping only: it holds no key and authorizes nothing (§908). TOKEN-GATED.",
557            ControlMethod::WalletReservationsRelease => "Free a hold now rather than waiting out its TTL -- call it the moment a spend is known settled or known dead. A handle that names no live reservation is a SUCCESS with released: false, because a caller releasing on confirmation cannot know whether the TTL got there first. Every hold also lapses on its own, so an abandoned reservation is recoverable and never a permanent funds lockout. TOKEN-GATED.",
558            ControlMethod::PairingRequest => "OPEN: request a control-token pairing; returns a pairing_id + pairing_code to compare.",
559            ControlMethod::PairingPoll => "OPEN: poll a pairing by id; once the operator approves, returns the scoped token once.",
560        }
561    }
562
563    /// Every catalogued method, in a stable order — the enumeration a machine reads to discover the
564    /// full control surface, and the anchor the conformance KATs pin against.
565    pub const ALL: &'static [ControlMethod] = &[
566        ControlMethod::Status,
567        ControlMethod::ConfigGet,
568        ControlMethod::ConfigSetUpstream,
569        ControlMethod::LogSetLevel,
570        ControlMethod::CacheGet,
571        ControlMethod::CacheSetCap,
572        ControlMethod::CacheClear,
573        ControlMethod::HostedStoresList,
574        ControlMethod::HostedStoresPin,
575        ControlMethod::HostedStoresUnpin,
576        ControlMethod::HostedStoresStatus,
577        ControlMethod::CapsuleFetch,
578        ControlMethod::SyncStatus,
579        ControlMethod::SyncTrigger,
580        ControlMethod::UpdaterStatus,
581        ControlMethod::UpdaterSetChannel,
582        ControlMethod::UpdaterPause,
583        ControlMethod::UpdaterResume,
584        ControlMethod::UpdaterCheckNow,
585        ControlMethod::PairingList,
586        ControlMethod::PairingApprove,
587        ControlMethod::PairingRevoke,
588        ControlMethod::PeerStatus,
589        ControlMethod::PeerCounts,
590        ControlMethod::PeersConnect,
591        ControlMethod::PeersDisconnect,
592        ControlMethod::ChiaPeersAdd,
593        ControlMethod::ChiaPeersList,
594        ControlMethod::ChiaPeersRemove,
595        ControlMethod::Subscribe,
596        ControlMethod::Unsubscribe,
597        ControlMethod::ListSubscriptions,
598        ControlMethod::WalletBalance,
599        ControlMethod::WalletCoins,
600        ControlMethod::WalletCoinById,
601        ControlMethod::WalletCoinSpend,
602        ControlMethod::WalletCoinsByParent,
603        ControlMethod::WalletArrivals,
604        ControlMethod::WalletPeak,
605        ControlMethod::WalletSyncStatus,
606        ControlMethod::WalletBroadcast,
607        ControlMethod::WalletWatch,
608        ControlMethod::WalletUnwatch,
609        ControlMethod::WalletWatched,
610        ControlMethod::WalletReservationsHeld,
611        ControlMethod::WalletReservationsReserve,
612        ControlMethod::WalletReservationsRelease,
613        ControlMethod::SpendsList,
614        ControlMethod::ProfilePutBody,
615        ControlMethod::ProfileGetBody,
616        ControlMethod::PairingRequest,
617        ControlMethod::PairingPoll,
618    ];
619}
620
621#[cfg(test)]
622mod tests {
623    use super::*;
624    use std::collections::BTreeSet;
625
626    #[test]
627    fn every_method_has_a_unique_wire_name() {
628        let names: BTreeSet<&str> = ControlMethod::ALL.iter().map(|m| m.name()).collect();
629        assert_eq!(
630            names.len(),
631            ControlMethod::ALL.len(),
632            "duplicate or missing wire names in the catalog"
633        );
634    }
635
636    #[test]
637    fn from_name_round_trips_every_method() {
638        for &m in ControlMethod::ALL {
639            assert_eq!(ControlMethod::from_name(m.name()), Some(m));
640        }
641        assert_eq!(ControlMethod::from_name("control.nope"), None);
642        assert_eq!(ControlMethod::from_name(""), None);
643    }
644
645    #[test]
646    fn the_token_less_surface_is_exactly_the_bootstrap_plus_the_chain_reads() {
647        // Written out rather than derived from `is_open_read`, so this pins the SET and not the
648        // implementation's opinion of itself. A method added to the open surface must be added
649        // here deliberately -- which is the review step a broadcast must never slip past.
650        let expected_open: BTreeSet<&str> = [
651            "pairing.request",
652            "pairing.poll",
653            "control.wallet.balance",
654            "control.wallet.coins",
655            "control.wallet.coinById",
656            "control.wallet.coinSpend",
657            "control.wallet.coinsByParent",
658            "control.wallet.peak",
659            "control.wallet.syncStatus",
660            "control.peerCounts",
661        ]
662        .into_iter()
663        .collect();
664        assert_eq!(
665            expected_open.len(),
666            10,
667            "the open surface is ten named methods"
668        );
669        let actual_open: BTreeSet<&str> = ControlMethod::ALL
670            .iter()
671            .filter(|m| !m.requires_auth())
672            .map(|m| m.name())
673            .collect();
674        assert_eq!(actual_open, expected_open);
675    }
676
677    /// **The gated wallet methods are the push, the arrival cursor, the three enrolment methods,
678    /// and the three reservation methods.** The fixture varies one thing -- which wallet method is asked -- against a category
679    /// whose other members ARE open, so both nearest wrong implementations fail here: one that opens
680    /// the whole category (the state this crate shipped in at `1190a18`) and one that gates it
681    /// wholesale.
682    ///
683    /// Written out in catalog order rather than derived, so a method joining the gated side is a
684    /// deliberate edit here -- the review step a broadcast, or an enrolment, must never slip past.
685    #[test]
686    fn the_gated_wallet_methods_are_the_push_the_cursor_and_enrolment() {
687        let gated: Vec<&str> = ControlMethod::ALL
688            .iter()
689            .filter(|m| m.category() == Category::Wallet && m.requires_auth())
690            .map(|m| m.name())
691            .collect();
692        assert_eq!(
693            gated,
694            vec![
695                "control.wallet.arrivals",
696                "control.wallet.broadcast",
697                "control.wallet.watch",
698                "control.wallet.unwatch",
699                "control.wallet.watched",
700                "control.wallet.reservations.held",
701                "control.wallet.reservations.reserve",
702                "control.wallet.reservations.release",
703            ]
704        );
705        assert!(!ControlMethod::WalletBroadcast.is_open_read());
706    }
707
708    /// **The arrival cursor is NOT an open read, and the reason is not "is it a chain read?".**
709    ///
710    /// The rule is *who names the address*. `control.wallet.arrivals` takes only a cursor, so the
711    /// node volunteers its OWN watched puzzle hashes and the receive history behind them -- the
712    /// node-to-address association, which is not public, and which a token-less caller could then
713    /// replay into the caller-addressed reads.
714    ///
715    /// The control keeps `control.wallet.coinById` in the same assertion: it is the neighbour the
716    /// analogy was drawn from, it is still open, and it stays open because its CALLER supplies the
717    /// coin id. Without that control this test would also pass on a wholesale gating of the wallet
718    /// category, which is a different (and wrong) implementation.
719    #[test]
720    fn the_arrival_cursor_is_not_an_open_read() {
721        assert!(
722            !ControlMethod::WalletArrivals.is_open_read(),
723            "control.wallet.arrivals discloses this node's OWN watched puzzle hashes to a caller \
724             that supplied nothing, so it MUST NOT be served token-less"
725        );
726        assert!(ControlMethod::WalletArrivals.requires_auth());
727        assert!(
728            ControlMethod::WalletCoinById.is_open_read(),
729            "the caller-addressed reads stay open -- the fix is the membership rule, not gating \
730             the wallet category"
731        );
732    }
733
734    /// **The control plane names every chain primitive `ChainSource` needs.**
735    ///
736    /// The list is written out rather than derived, because the property under test is a claim about
737    /// ANOTHER crate's trait (`dig-chainsource-interface`'s `ChainSource`) that no compiler here can
738    /// check. Five of its seven methods need a control method of their own. The other two need none:
739    /// `parent_spend` is a trait DEFAULT composed from `coin_record` + `coin_spend`, and
740    /// `resolve_singleton_lineage` is composed CLIENT-side from the primitives below rather than
741    /// served as a walk the node performs.
742    ///
743    /// `block_timestamp` is deliberately ABSENT from the control plane. dig-node's light client
744    /// (`chia-peer`'s `ChiaPeerProvider`) does not index block timestamps and answers `Unsupported`,
745    /// so a control method for it could only ever be refused — a surface that looks live and does
746    /// nothing. A consumer mirrors that refusal honestly; if one ever genuinely needs the value, the
747    /// method is an additive minor at that point.
748    ///
749    /// A missing name here is not a cosmetic gap: a client that cannot answer one of these cannot
750    /// implement the trait at all, which is what made a dig-profile mint structurally impossible
751    /// through the node before these two were added (dig_ecosystem#2572).
752    #[test]
753    fn the_catalog_serves_every_chain_source_primitive() {
754        for wire in [
755            "control.wallet.coinById",      // coin_record
756            "control.wallet.coins",         // coin_records_by_puzzle_hash
757            "control.wallet.peak",          // peak_height
758            "control.wallet.coinsByParent", // coin_records_by_parent
759            "control.wallet.coinSpend",     // coin_spend
760        ] {
761            assert!(
762                ControlMethod::from_name(wire).is_some(),
763                "{wire} is required to implement ChainSource over the control plane"
764            );
765        }
766    }
767
768    /// **The two chain primitives are `coinById`'s neighbours, not `arrivals`'.**
769    ///
770    /// Each takes a caller-supplied coin id and returns a deterministic public chain fact,
771    /// so the membership rule — *who names the subject* — puts them on the open side. The gated
772    /// control in the same assertion is what makes the test load-bearing: without it, a wholesale
773    /// opening of the wallet category would pass, and that is a different (and wrong) implementation.
774    #[test]
775    fn the_chain_primitives_are_caller_named_open_reads() {
776        for method in [
777            ControlMethod::WalletCoinSpend,
778            ControlMethod::WalletCoinsByParent,
779        ] {
780            assert!(
781                method.is_open_read(),
782                "{} names its subject in the request and discloses no node-to-address \
783                 association, exactly like control.wallet.coinById",
784                method.name()
785            );
786            assert!(!method.requires_auth());
787        }
788        assert!(
789            ControlMethod::WalletArrivals.requires_auth(),
790            "the caller-supplies-nothing read stays gated -- the rule is who names the subject, \
791             not whether the bytes are on chain"
792        );
793        assert!(ControlMethod::WalletBroadcast.requires_auth());
794    }
795
796    /// **All three enrolment methods are gated — including the one that only reads.**
797    ///
798    /// `control.wallet.watch` and `.unwatch` aim what the node follows, so they are mutations and the
799    /// question barely arises. `control.wallet.watched` is the one a future reader will be tempted to
800    /// open, because it returns nothing but public keys and every other wallet READ in this catalog is
801    /// open. It stays gated under the SAME rule that gates `control.wallet.arrivals`: the caller
802    /// supplies nothing, so the node volunteers its OWN enrolled keys — the node-to-key association,
803    /// which is not public, and which a token-less caller could replay straight into the
804    /// caller-addressed reads.
805    ///
806    /// The control keeps `control.wallet.coinById` open in the same assertion. Without it this test
807    /// would also pass on a wholesale gating of the wallet category, which is a different (and wrong)
808    /// implementation.
809    #[test]
810    fn the_enrolment_methods_are_gated_including_the_read() {
811        for wire in [
812            "control.wallet.watch",
813            "control.wallet.unwatch",
814            "control.wallet.watched",
815        ] {
816            let method = ControlMethod::from_name(wire)
817                .unwrap_or_else(|| panic!("{wire} must be in the catalog"));
818            assert!(
819                !method.is_open_read(),
820                "{wire} either aims this node's subscriptions or names the keys it already \
821                 follows, so it MUST NOT be served token-less"
822            );
823            assert!(method.requires_auth(), "{wire} must require the token");
824            assert_eq!(method.category(), Category::Wallet);
825            assert_eq!(method.routing(), Routing::Delegated);
826        }
827        assert!(
828            ControlMethod::WalletCoinById.is_open_read(),
829            "the caller-addressed reads stay open -- enrolment is gated by the membership rule, \
830             not by gating the wallet category"
831        );
832    }
833
834    #[test]
835    fn only_pairing_bootstrap_is_open_bootstrap_routed() {
836        for &m in ControlMethod::ALL {
837            let open_bootstrap = matches!(
838                m,
839                ControlMethod::PairingRequest | ControlMethod::PairingPoll
840            );
841            assert_eq!(
842                m.routing() == Routing::OpenBootstrap,
843                open_bootstrap,
844                "{} routing mismatch",
845                m.name()
846            );
847        }
848    }
849
850    #[test]
851    fn pairing_admin_methods_are_exactly_three() {
852        let admin: Vec<&str> = ControlMethod::ALL
853            .iter()
854            .filter(|m| m.is_pairing_admin())
855            .map(|m| m.name())
856            .collect();
857        assert_eq!(
858            admin,
859            vec![
860                "control.pairing.list",
861                "control.pairing.approve",
862                "control.pairing.revoke"
863            ]
864        );
865    }
866
867    /// **The master-token tier is the pairing lifecycle PLUS the trusted-peer mutations.**
868    ///
869    /// The set is asserted whole, because the risk is a method quietly joining or leaving it. The
870    /// two non-pairing members are here for a stated reason — `chiaPeers.add` grants authority
871    /// that SURVIVES `pairing.revoke`, so a paired token holding it escapes the very remedy for a
872    /// compromised paired app.
873    #[test]
874    fn the_master_token_tier_is_pairing_admin_plus_the_trusted_peer_mutations() {
875        let master: BTreeSet<&str> = ControlMethod::ALL
876            .iter()
877            .filter(|m| m.requires_master_token())
878            .map(|m| m.name())
879            .collect();
880        let expected: BTreeSet<&str> = [
881            "control.pairing.list",
882            "control.pairing.approve",
883            "control.pairing.revoke",
884            "control.chiaPeers.add",
885            "control.chiaPeers.remove",
886        ]
887        .into_iter()
888        .collect();
889        assert_eq!(master, expected);
890
891        // Pairing administration is a STRICT subset, not a synonym: a gate that consults
892        // `is_pairing_admin` instead of `requires_master_token` lets a paired token add a peer.
893        for &m in ControlMethod::ALL {
894            assert!(
895                !m.is_pairing_admin() || m.requires_master_token(),
896                "{} is pairing-admin but not master-tier",
897                m.name()
898            );
899        }
900        assert!(
901            master.len()
902                > ControlMethod::ALL
903                    .iter()
904                    .filter(|m| m.is_pairing_admin())
905                    .count(),
906            "the two predicates must not be interchangeable"
907        );
908
909        // Master implies the token is required at all.
910        for &m in ControlMethod::ALL {
911            assert!(
912                !m.requires_master_token() || m.requires_auth(),
913                "{}",
914                m.name()
915            );
916        }
917    }
918
919    /// **The trust wording stays inside NC-12's authorisation: a node the operator RUNS.**
920    ///
921    /// NC-12 permits trust only from "the operator declaring it their own node". Widening that to
922    /// vouching moves the case outside the justification for the unbounded authority the entry
923    /// carries, and "a node you vouch for" is a phrase somebody can be talked into applying to a
924    /// stranger's address.
925    #[test]
926    fn the_add_summary_authorises_only_a_node_the_operator_runs() {
927        let summary = ControlMethod::ChiaPeersAdd.summary().to_lowercase();
928        assert!(
929            summary.contains("a node you run"),
930            "add must name the operator-run scope, got: {summary}"
931        );
932        for widened in ["vouch", "otherwise trust", "trust yourself", "recommend"] {
933            assert!(
934                !summary.contains(widened),
935                "add summary widens operator trust past NC-12 with {widened:?}: {summary}"
936            );
937        }
938    }
939
940    #[test]
941    fn delegated_set_matches_the_engine_surface() {
942        let delegated: BTreeSet<&str> = ControlMethod::ALL
943            .iter()
944            .filter(|m| m.routing() == Routing::Delegated)
945            .map(|m| m.name())
946            .collect();
947        let expected: BTreeSet<&str> = [
948            "control.wallet.coins",
949            "control.wallet.coinById",
950            "control.wallet.coinSpend",
951            "control.wallet.coinsByParent",
952            "control.wallet.arrivals",
953            "control.wallet.peak",
954            "control.wallet.syncStatus",
955            "control.wallet.broadcast",
956            "control.wallet.watch",
957            "control.wallet.unwatch",
958            "control.wallet.watched",
959            "control.wallet.reservations.held",
960            "control.wallet.reservations.reserve",
961            "control.wallet.reservations.release",
962            "control.profile.putBody",
963            "control.profile.getBody",
964            "control.peerStatus",
965            "control.peerCounts",
966            "control.peers.connect",
967            "control.peers.disconnect",
968            "control.subscribe",
969            "control.unsubscribe",
970            "control.listSubscriptions",
971            "control.wallet.balance",
972        ]
973        .into_iter()
974        .collect();
975        assert_eq!(delegated, expected);
976    }
977
978    /// **The trusted-Chia-peer methods are declared, gated, and say what they cost.**
979    ///
980    /// A trusted peer BYPASSES corroboration (NC-12: dialled peers are untrusted and agreement
981    /// across ~5 concurrently-queried peers is what makes a read safe). The catalog is what a
982    /// machine reads before offering the control, so the cost is stated HERE and not only in a
983    /// doc page — a client that surfaces `summary()` surfaces the warning with it.
984    #[test]
985    fn the_trusted_chia_peer_methods_are_gated_and_disclose_the_corroboration_bypass() {
986        let declared: BTreeSet<&str> = ControlMethod::ALL.iter().map(|m| m.name()).collect();
987        for name in [
988            "control.chiaPeers.add",
989            "control.chiaPeers.list",
990            "control.chiaPeers.remove",
991        ] {
992            assert!(declared.contains(name), "{name} is not in the catalog");
993            let m = ControlMethod::from_name(name).expect("from_name round-trips");
994            assert_eq!(m.category(), Category::Peers, "{name} is a peers method");
995            assert_eq!(m.routing(), Routing::Owned, "{name} is served by the shell");
996            assert!(m.requires_auth(), "{name} must require the control token");
997            assert!(!m.is_open_read(), "{name} is not an open read");
998        }
999        // The MUTATIONS need the MASTER token; the READ deliberately does not. `add` writes
1000        // standing, corroboration-free authority that outlives the token that wrote it — a paired
1001        // token must not be able to install it, and `remove` is the only way back out.
1002        assert!(ControlMethod::ChiaPeersAdd.requires_master_token());
1003        assert!(ControlMethod::ChiaPeersRemove.requires_master_token());
1004        assert!(
1005            !ControlMethod::ChiaPeersList.requires_master_token(),
1006            "list grants nothing that outlives the token; gating it would blind a paired client \
1007             to the trust state it is subject to"
1008        );
1009        // The COST, not merely the capability: the two methods that change the trusted set must
1010        // name the bypass. A summary that only described the action would let a client offer the
1011        // control while silently withholding what it gives up.
1012        for name in ["control.chiaPeers.add", "control.chiaPeers.remove"] {
1013            let summary = ControlMethod::from_name(name).unwrap().summary();
1014            assert!(
1015                summary.to_lowercase().contains("corroboration"),
1016                "{name} summary must name the corroboration bypass, got: {summary}"
1017            );
1018        }
1019    }
1020
1021    #[test]
1022    fn every_method_has_a_nonempty_summary() {
1023        for &m in ControlMethod::ALL {
1024            assert!(!m.summary().is_empty(), "{} has no summary", m.name());
1025        }
1026    }
1027}