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}
58
59/// A dig-node CONTROL method.
60///
61/// `#[non_exhaustive]` so adding a method in a minor release is additive; downstream matches must
62/// carry a `_ => …` arm. Convert to/from the wire name with [`ControlMethod::name`] /
63/// [`ControlMethod::from_name`].
64#[non_exhaustive]
65#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
66pub enum ControlMethod {
67    // ---- Status / config / log (shell-owned) ----
68    /// `control.status` — a rich node status snapshot.
69    Status,
70    /// `control.config.get` — the node's effective configuration.
71    ConfigGet,
72    /// `control.config.setUpstream` — persist an upstream-RPC override (effective on restart).
73    ConfigSetUpstream,
74    /// `control.log.setLevel` — live-swap the running node's tracing level filter.
75    LogSetLevel,
76
77    // ---- Cache (shell-owned) ----
78    /// `control.cache.get` — the on-disk cache view (cap/used/dir/shared).
79    CacheGet,
80    /// `control.cache.setCap` — set the cache size cap (floored at 64 MiB).
81    CacheSetCap,
82    /// `control.cache.clear` — delete all locally cached content.
83    CacheClear,
84
85    // ---- Hosted stores (shell-owned) ----
86    /// `control.hostedStores.list` — every held/pinned store with its cached capsules.
87    HostedStoresList,
88    /// `control.hostedStores.pin` — pin a store (and pre-fetch when a root is given).
89    HostedStoresPin,
90    /// `control.hostedStores.unpin` — unpin a store and evict its cached capsules.
91    HostedStoresUnpin,
92    /// `control.hostedStores.status` — per-store pinned flag + cached capsules.
93    HostedStoresStatus,
94
95    // ---- §21 sync (shell-owned) ----
96    /// `control.sync.status` — whether authenticated whole-store sync is available + pin coverage.
97    SyncStatus,
98    /// `control.sync.trigger` — trigger a §21 sync for one capsule (storeId + root).
99    SyncTrigger,
100
101    // ---- Updater beacon proxy (shell-owned) ----
102    /// `control.updater.status` — the DIG auto-update beacon's current status.
103    UpdaterStatus,
104    /// `control.updater.setChannel` — set the beacon's update channel.
105    UpdaterSetChannel,
106    /// `control.updater.pause` — suspend auto-updates (optionally until a unix time).
107    UpdaterPause,
108    /// `control.updater.resume` — resume auto-updates.
109    UpdaterResume,
110    /// `control.updater.checkNow` — force an immediate update check.
111    UpdaterCheckNow,
112
113    // ---- Pairing administration (shell-owned, MASTER-token only) ----
114    /// `control.pairing.list` — list pending pairing requests + issued paired tokens.
115    PairingList,
116    /// `control.pairing.approve` — approve a pending pairing, minting a scoped token.
117    PairingApprove,
118    /// `control.pairing.revoke` — revoke an issued paired token.
119    PairingRevoke,
120
121    // ---- Peers (delegated to the engine) ----
122    /// `control.peerStatus` — live peer-pool + relay-reservation snapshot.
123    PeerStatus,
124    /// `control.peerCounts` — how many peers this node holds on EACH network (DIG and Chia).
125    PeerCounts,
126    /// `control.peers.connect` — dial a peer by address / resolve a connected peer_id.
127    PeersConnect,
128    /// `control.peers.disconnect` — drop a pooled peer by peer_id.
129    PeersDisconnect,
130
131    // ---- Subscriptions (delegated to the engine) ----
132    /// `control.subscribe` — subscribe the node to a store (watch + gap-fill).
133    Subscribe,
134    /// `control.unsubscribe` — stop watching a store.
135    Unsubscribe,
136    /// `control.listSubscriptions` — the node's persisted subscription set.
137    ListSubscriptions,
138
139    // ---- Wallet chain transport (delegated to the engine) ----
140    /// `control.wallet.balance` — read an address's confirmed spendable balance for an asset.
141    WalletBalance,
142    /// `control.wallet.coins` — read an address's spendable coin records for an asset.
143    WalletCoins,
144    /// `control.wallet.coinById` — read ONE coin record by coin id, spent or unspent.
145    WalletCoinById,
146    /// `control.wallet.peak` — read the node's current chain peak height.
147    WalletPeak,
148    /// `control.wallet.syncStatus` — read whether the wallet's chain replica is being kept current.
149    WalletSyncStatus,
150    /// `control.wallet.broadcast` — push an ALREADY-SIGNED spend bundle to the network.
151    WalletBroadcast,
152
153    // ---- Pairing bootstrap (OPEN — no token) ----
154    /// `pairing.request` — request a control-token pairing (returns a code to compare).
155    PairingRequest,
156    /// `pairing.poll` — poll a pairing; once the operator approves, returns the scoped token once.
157    PairingPoll,
158}
159
160impl ControlMethod {
161    /// The stable JSON-RPC wire name. Never derived from anything else — the published contract.
162    pub const fn name(self) -> &'static str {
163        match self {
164            ControlMethod::Status => "control.status",
165            ControlMethod::ConfigGet => "control.config.get",
166            ControlMethod::ConfigSetUpstream => "control.config.setUpstream",
167            ControlMethod::LogSetLevel => "control.log.setLevel",
168            ControlMethod::CacheGet => "control.cache.get",
169            ControlMethod::CacheSetCap => "control.cache.setCap",
170            ControlMethod::CacheClear => "control.cache.clear",
171            ControlMethod::HostedStoresList => "control.hostedStores.list",
172            ControlMethod::HostedStoresPin => "control.hostedStores.pin",
173            ControlMethod::HostedStoresUnpin => "control.hostedStores.unpin",
174            ControlMethod::HostedStoresStatus => "control.hostedStores.status",
175            ControlMethod::SyncStatus => "control.sync.status",
176            ControlMethod::SyncTrigger => "control.sync.trigger",
177            ControlMethod::UpdaterStatus => "control.updater.status",
178            ControlMethod::UpdaterSetChannel => "control.updater.setChannel",
179            ControlMethod::UpdaterPause => "control.updater.pause",
180            ControlMethod::UpdaterResume => "control.updater.resume",
181            ControlMethod::UpdaterCheckNow => "control.updater.checkNow",
182            ControlMethod::PairingList => "control.pairing.list",
183            ControlMethod::PairingApprove => "control.pairing.approve",
184            ControlMethod::PairingRevoke => "control.pairing.revoke",
185            ControlMethod::PeerStatus => "control.peerStatus",
186            ControlMethod::PeerCounts => "control.peerCounts",
187            ControlMethod::PeersConnect => "control.peers.connect",
188            ControlMethod::PeersDisconnect => "control.peers.disconnect",
189            ControlMethod::Subscribe => "control.subscribe",
190            ControlMethod::Unsubscribe => "control.unsubscribe",
191            ControlMethod::ListSubscriptions => "control.listSubscriptions",
192            ControlMethod::WalletBalance => "control.wallet.balance",
193            ControlMethod::WalletCoins => "control.wallet.coins",
194            ControlMethod::WalletCoinById => "control.wallet.coinById",
195            ControlMethod::WalletPeak => "control.wallet.peak",
196            ControlMethod::WalletSyncStatus => "control.wallet.syncStatus",
197            ControlMethod::WalletBroadcast => "control.wallet.broadcast",
198            ControlMethod::PairingRequest => "pairing.request",
199            ControlMethod::PairingPoll => "pairing.poll",
200        }
201    }
202
203    /// Resolve a wire name back to its [`ControlMethod`], or `None` for an unknown name.
204    pub fn from_name(name: &str) -> Option<ControlMethod> {
205        ControlMethod::ALL
206            .iter()
207            .copied()
208            .find(|m| m.name() == name)
209    }
210
211    /// Does calling this method require the local control token?
212    ///
213    /// Three groups are reachable WITHOUT one, and they are open for two different reasons:
214    ///
215    /// - the pairing bootstrap (`pairing.request` / `pairing.poll`), so a token-less client can
216    ///   obtain a token at all;
217    /// - the PEER COUNTS (`control.peerCounts`), which disclose two integers about this node's own
218    ///   connectivity and no address, endpoint or secret;
219    /// - the wallet CHAIN READS ([`Category::Wallet`] minus the push), because each needs only
220    ///   PUBLIC chain data — an address, or a coin id on `control.wallet.coinById`; never a seed, a
221    ///   key, or a signature — and dig-node has served
222    ///   `control.wallet.balance` open since #1851. A person whose node runs as a service with an
223    ///   unreadable token file can still see their own money.
224    ///
225    /// `control.wallet.broadcast` is deliberately NOT in that second group. It puts bytes on the
226    /// network, so the token is what stands between a local process and a broadcast, and its
227    /// refusal genuinely means *unauthorized* — see [`ControlMethod::is_open_read`].
228    pub const fn requires_auth(self) -> bool {
229        !self.is_open_read()
230            && !matches!(
231                self,
232                ControlMethod::PairingRequest | ControlMethod::PairingPoll
233            )
234    }
235
236    /// Is this an OPEN READ — served without a control token?
237    ///
238    /// Two kinds of method qualify, and they are open for different reasons:
239    ///
240    /// - the wallet CHAIN READS (`control.wallet.balance` / `.coins` / `.coinById` / `.peak` /
241    ///   `.syncStatus`), which need only PUBLIC chain data — an address, or a coin id; never a seed,
242    ///   a key, or a signature;
243    /// - `control.peerCounts`, which is NOT a chain read: it discloses two integers about this
244    ///   node's own connectivity, and no address, endpoint, peer identity or secret. The identity
245    ///   and topology half of the same subject stays gated behind `control.peerStatus`.
246    ///
247    /// Naming both reasons matters more than it looks. The test for membership is *does this
248    /// disclose only data that is already public, or a bare count of this node's own state?* — NOT
249    /// *is it a chain read?* A future method judged against the narrower phrasing, and found to
250    /// contradict a member that was already there, invites widening the predicate by analogy rather
251    /// than against the rule.
252    ///
253    /// Stated on the contract rather than discovered by calling, because the two refusals a client
254    /// can get here demand OPPOSITE remedies. On an open read, `UNAUTHORIZED` can only come from a
255    /// node build that predates the method and gates it generically, so the remedy is an upgrade.
256    /// On a gated method — the push — `UNAUTHORIZED` means exactly what it says, and the remedy is
257    /// the token. A client that maps the two the same way sends somebody to fix the wrong thing.
258    pub const fn is_open_read(self) -> bool {
259        matches!(
260            self,
261            ControlMethod::WalletBalance
262                | ControlMethod::WalletCoins
263                | ControlMethod::WalletCoinById
264                | ControlMethod::WalletPeak
265                | ControlMethod::WalletSyncStatus
266                | ControlMethod::PeerCounts
267        )
268    }
269
270    /// Is this a PAIRING-ADMINISTRATION method that requires the MASTER control token specifically?
271    ///
272    /// A paired (scoped) token can drive ordinary `control.*` mutations but MUST NOT mint more
273    /// tokens or revoke itself — so listing/approving/revoking pairings requires the master token
274    /// (a local file read), never a paired token.
275    pub const fn is_pairing_admin(self) -> bool {
276        matches!(
277            self,
278            ControlMethod::PairingList
279                | ControlMethod::PairingApprove
280                | ControlMethod::PairingRevoke
281        )
282    }
283
284    /// How the node routes this method (shell-owned, engine-delegated, or open bootstrap).
285    pub const fn routing(self) -> Routing {
286        match self {
287            ControlMethod::PeerStatus
288            | ControlMethod::PeerCounts
289            | ControlMethod::PeersConnect
290            | ControlMethod::PeersDisconnect
291            | ControlMethod::Subscribe
292            | ControlMethod::Unsubscribe
293            | ControlMethod::ListSubscriptions
294            | ControlMethod::WalletBalance
295            | ControlMethod::WalletCoins
296            | ControlMethod::WalletCoinById
297            | ControlMethod::WalletPeak
298            | ControlMethod::WalletSyncStatus
299            | ControlMethod::WalletBroadcast => Routing::Delegated,
300            ControlMethod::PairingRequest | ControlMethod::PairingPoll => Routing::OpenBootstrap,
301            _ => Routing::Owned,
302        }
303    }
304
305    /// The functional area this method belongs to.
306    pub const fn category(self) -> Category {
307        match self {
308            ControlMethod::Status => Category::Status,
309            ControlMethod::ConfigGet | ControlMethod::ConfigSetUpstream => Category::Config,
310            ControlMethod::LogSetLevel => Category::Log,
311            ControlMethod::CacheGet | ControlMethod::CacheSetCap | ControlMethod::CacheClear => {
312                Category::Cache
313            }
314            ControlMethod::HostedStoresList
315            | ControlMethod::HostedStoresPin
316            | ControlMethod::HostedStoresUnpin
317            | ControlMethod::HostedStoresStatus => Category::HostedStores,
318            ControlMethod::SyncStatus | ControlMethod::SyncTrigger => Category::Sync,
319            ControlMethod::UpdaterStatus
320            | ControlMethod::UpdaterSetChannel
321            | ControlMethod::UpdaterPause
322            | ControlMethod::UpdaterResume
323            | ControlMethod::UpdaterCheckNow => Category::Updater,
324            ControlMethod::PairingList
325            | ControlMethod::PairingApprove
326            | ControlMethod::PairingRevoke
327            | ControlMethod::PairingRequest
328            | ControlMethod::PairingPoll => Category::Pairing,
329            ControlMethod::PeerStatus
330            | ControlMethod::PeerCounts
331            | ControlMethod::PeersConnect
332            | ControlMethod::PeersDisconnect => Category::Peers,
333            ControlMethod::Subscribe
334            | ControlMethod::Unsubscribe
335            | ControlMethod::ListSubscriptions => Category::Subscriptions,
336            ControlMethod::WalletBalance
337            | ControlMethod::WalletCoins
338            | ControlMethod::WalletCoinById
339            | ControlMethod::WalletPeak
340            | ControlMethod::WalletSyncStatus
341            | ControlMethod::WalletBroadcast => Category::Wallet,
342        }
343    }
344
345    /// A one-line human/agent description for the discovery catalogue.
346    pub const fn summary(self) -> &'static str {
347        match self {
348            ControlMethod::Status => "A rich node status snapshot (version, uptime, addr, cache, hosted/pinned counts, sync availability).",
349            ControlMethod::ConfigGet => "The node's effective configuration (addr/port, upstream + override, cache dir/shared, config path, sync availability).",
350            ControlMethod::ConfigSetUpstream => "Persist an upstream-RPC override; takes effect on next node start (requires_restart).",
351            ControlMethod::LogSetLevel => "Live-swap the running node's tracing EnvFilter directive (not persisted).",
352            ControlMethod::CacheGet => "The on-disk content-cache view: cap_bytes, used_bytes, dir, shared.",
353            ControlMethod::CacheSetCap => "Set the on-disk cache size cap in bytes (floored at 64 MiB).",
354            ControlMethod::CacheClear => "Delete all locally cached DIG content.",
355            ControlMethod::HostedStoresList => "Every held/pinned store, merged, with each store's cached capsules and a pinned flag.",
356            ControlMethod::HostedStoresPin => "Pin a store (storeId[:rootHash]); pre-fetches the capsule when a root is given and §21 sync is available.",
357            ControlMethod::HostedStoresUnpin => "Unpin a store and evict its cached capsules.",
358            ControlMethod::HostedStoresStatus => "Per-store status: pinned flag, cached capsules, total bytes.",
359            ControlMethod::SyncStatus => "Whether authenticated §21 whole-store sync is available, plus pinned-store cache coverage.",
360            ControlMethod::SyncTrigger => "Trigger a §21 sync for one capsule (storeId + root).",
361            ControlMethod::UpdaterStatus => "The DIG auto-update beacon's current status (proxied from dig-updater).",
362            ControlMethod::UpdaterSetChannel => "Set the beacon's update channel (\"nightly\" | \"stable\").",
363            ControlMethod::UpdaterPause => "Suspend the beacon's auto-updates (optionally until a unix time).",
364            ControlMethod::UpdaterResume => "Resume the beacon's auto-updates.",
365            ControlMethod::UpdaterCheckNow => "Force an immediate beacon update check.",
366            ControlMethod::PairingList => "List pending pairing requests and issued paired tokens (MASTER token only).",
367            ControlMethod::PairingApprove => "Approve a pending pairing, minting a scoped token (MASTER token only).",
368            ControlMethod::PairingRevoke => "Revoke an issued paired token by token_id (MASTER token only).",
369            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.",
370            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.",
371            ControlMethod::PeersConnect => "Dial a peer by address, or resolve an already-connected peer_id, via the live gossip pool.",
372            ControlMethod::PeersDisconnect => "Drop a pooled peer by peer_id, closing its mTLS link (idempotent).",
373            ControlMethod::Subscribe => "Subscribe the node to a store it actively watches and gap-fills.",
374            ControlMethod::Unsubscribe => "Stop watching a store.",
375            ControlMethod::ListSubscriptions => "The node's persisted subscription set + count.",
376            ControlMethod::WalletCoins => "READ-only: the spendable coin records for an address + asset, with the tier that answered and the height they reflect.",
377            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.",
378            ControlMethod::WalletPeak => "READ-only: the node's current chain peak height, independent of any address.",
379            ControlMethod::WalletSyncStatus => "READ-only: whether the wallet's CHAIN replica is being kept current (not_started/syncing/synced), 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).",
380            ControlMethod::WalletBroadcast => "Push an ALREADY-SIGNED spend bundle to the network; the node never signs. TOKEN-GATED.",
381            ControlMethod::WalletBalance => "READ-only: the confirmed spendable balance for an address + asset (plus pending, sync freshness, and the peak height it reflects).",
382            ControlMethod::PairingRequest => "OPEN: request a control-token pairing; returns a pairing_id + pairing_code to compare.",
383            ControlMethod::PairingPoll => "OPEN: poll a pairing by id; once the operator approves, returns the scoped token once.",
384        }
385    }
386
387    /// Every catalogued method, in a stable order — the enumeration a machine reads to discover the
388    /// full control surface, and the anchor the conformance KATs pin against.
389    pub const ALL: &'static [ControlMethod] = &[
390        ControlMethod::Status,
391        ControlMethod::ConfigGet,
392        ControlMethod::ConfigSetUpstream,
393        ControlMethod::LogSetLevel,
394        ControlMethod::CacheGet,
395        ControlMethod::CacheSetCap,
396        ControlMethod::CacheClear,
397        ControlMethod::HostedStoresList,
398        ControlMethod::HostedStoresPin,
399        ControlMethod::HostedStoresUnpin,
400        ControlMethod::HostedStoresStatus,
401        ControlMethod::SyncStatus,
402        ControlMethod::SyncTrigger,
403        ControlMethod::UpdaterStatus,
404        ControlMethod::UpdaterSetChannel,
405        ControlMethod::UpdaterPause,
406        ControlMethod::UpdaterResume,
407        ControlMethod::UpdaterCheckNow,
408        ControlMethod::PairingList,
409        ControlMethod::PairingApprove,
410        ControlMethod::PairingRevoke,
411        ControlMethod::PeerStatus,
412        ControlMethod::PeerCounts,
413        ControlMethod::PeersConnect,
414        ControlMethod::PeersDisconnect,
415        ControlMethod::Subscribe,
416        ControlMethod::Unsubscribe,
417        ControlMethod::ListSubscriptions,
418        ControlMethod::WalletBalance,
419        ControlMethod::WalletCoins,
420        ControlMethod::WalletCoinById,
421        ControlMethod::WalletPeak,
422        ControlMethod::WalletSyncStatus,
423        ControlMethod::WalletBroadcast,
424        ControlMethod::PairingRequest,
425        ControlMethod::PairingPoll,
426    ];
427}
428
429#[cfg(test)]
430mod tests {
431    use super::*;
432    use std::collections::BTreeSet;
433
434    #[test]
435    fn every_method_has_a_unique_wire_name() {
436        let names: BTreeSet<&str> = ControlMethod::ALL.iter().map(|m| m.name()).collect();
437        assert_eq!(
438            names.len(),
439            ControlMethod::ALL.len(),
440            "duplicate or missing wire names in the catalog"
441        );
442    }
443
444    #[test]
445    fn from_name_round_trips_every_method() {
446        for &m in ControlMethod::ALL {
447            assert_eq!(ControlMethod::from_name(m.name()), Some(m));
448        }
449        assert_eq!(ControlMethod::from_name("control.nope"), None);
450        assert_eq!(ControlMethod::from_name(""), None);
451    }
452
453    #[test]
454    fn the_token_less_surface_is_exactly_the_bootstrap_plus_the_chain_reads() {
455        // Written out rather than derived from `is_open_read`, so this pins the SET and not the
456        // implementation's opinion of itself. A method added to the open surface must be added
457        // here deliberately -- which is the review step a broadcast must never slip past.
458        let expected_open: BTreeSet<&str> = [
459            "pairing.request",
460            "pairing.poll",
461            "control.wallet.balance",
462            "control.wallet.coins",
463            "control.wallet.coinById",
464            "control.wallet.peak",
465            "control.wallet.syncStatus",
466            "control.peerCounts",
467        ]
468        .into_iter()
469        .collect();
470        assert_eq!(
471            expected_open.len(),
472            8,
473            "the open surface is eight named methods"
474        );
475        let actual_open: BTreeSet<&str> = ControlMethod::ALL
476            .iter()
477            .filter(|m| !m.requires_auth())
478            .map(|m| m.name())
479            .collect();
480        assert_eq!(actual_open, expected_open);
481    }
482
483    /// **The push is token-gated, and no other wallet method is.** The fixture varies one thing --
484    /// which wallet method is asked -- against a category whose other three members ARE open, so an
485    /// implementation that opened the whole category (the nearest wrong one) fails here.
486    #[test]
487    fn the_push_is_the_one_wallet_method_behind_the_token() {
488        let gated: Vec<&str> = ControlMethod::ALL
489            .iter()
490            .filter(|m| m.category() == Category::Wallet && m.requires_auth())
491            .map(|m| m.name())
492            .collect();
493        assert_eq!(gated, vec!["control.wallet.broadcast"]);
494        assert!(!ControlMethod::WalletBroadcast.is_open_read());
495    }
496
497    #[test]
498    fn only_pairing_bootstrap_is_open_bootstrap_routed() {
499        for &m in ControlMethod::ALL {
500            let open_bootstrap = matches!(
501                m,
502                ControlMethod::PairingRequest | ControlMethod::PairingPoll
503            );
504            assert_eq!(
505                m.routing() == Routing::OpenBootstrap,
506                open_bootstrap,
507                "{} routing mismatch",
508                m.name()
509            );
510        }
511    }
512
513    #[test]
514    fn pairing_admin_methods_are_exactly_three() {
515        let admin: Vec<&str> = ControlMethod::ALL
516            .iter()
517            .filter(|m| m.is_pairing_admin())
518            .map(|m| m.name())
519            .collect();
520        assert_eq!(
521            admin,
522            vec![
523                "control.pairing.list",
524                "control.pairing.approve",
525                "control.pairing.revoke"
526            ]
527        );
528    }
529
530    #[test]
531    fn delegated_set_matches_the_engine_surface() {
532        let delegated: BTreeSet<&str> = ControlMethod::ALL
533            .iter()
534            .filter(|m| m.routing() == Routing::Delegated)
535            .map(|m| m.name())
536            .collect();
537        let expected: BTreeSet<&str> = [
538            "control.wallet.coins",
539            "control.wallet.coinById",
540            "control.wallet.peak",
541            "control.wallet.syncStatus",
542            "control.wallet.broadcast",
543            "control.peerStatus",
544            "control.peerCounts",
545            "control.peers.connect",
546            "control.peers.disconnect",
547            "control.subscribe",
548            "control.unsubscribe",
549            "control.listSubscriptions",
550            "control.wallet.balance",
551        ]
552        .into_iter()
553        .collect();
554        assert_eq!(delegated, expected);
555    }
556
557    #[test]
558    fn every_method_has_a_nonempty_summary() {
559        for &m in ControlMethod::ALL {
560            assert!(!m.summary().is_empty(), "{} has no summary", m.name());
561        }
562    }
563}
dig_node_control_interface/method.rs

dig_node_control_interface/
method.rs
