Expand description
Typed result payloads for the control methods.
Each struct is field-for-field identical to what dig-node emits (snake_case wire fields), so a
client deserializes the node’s real response and re-serializes the same bytes — the property the
conformance KATs pin. Genuinely open/proxied shapes (the updater beacon’s status, the peer-pool
snapshot, the pairing list) stay serde_json::Value on the call’s Output rather than being
frozen into a struct that would drift from the proxied source.
Structs§
- Automated
Spend - One spend this node made WITHOUT per-transaction approval.
- Cache
Clear Result control.cache.clear— the clear acknowledgement.- Cache
View - The on-disk content-cache view (
control.cache.get, and embedded inStatusResult). - Capsule
Entry - One cached capsule of a store, as listed by the hosted-stores methods.
- Capsule
Fetch Result control.capsule.fetch— the P2P pull acknowledgement.- Chia
Peer Entry - One tracked Chia full-node peer.
- Chia
Peers AddResult control.chiaPeers.add— the acknowledgement, including the cost that was paid.- Chia
Peers List Result control.chiaPeers.list— every tracked Chia peer: trusted, discovered and banned alike.- Chia
Peers Remove Result control.chiaPeers.remove— the acknowledgement.- Collateral
Margin Result control.collateral.margin.get/.set— the node’s LOCAL safety margin.- Config
Result control.config.get— the node’s effective configuration.- Hosted
Store - One hosted/pinned store (
control.hostedStores.list). - Hosted
Store Status Result control.hostedStores.status— per-store pinned flag + cached capsules.- Hosted
Stores List Result control.hostedStores.list— every held/pinned store.- List
Subscriptions Result control.listSubscriptions— the node’s persisted subscription set.- Mirror
Advertise View - The mirror advertise-URL view: embedded in
ConfigResult, and embedded in turn inSetMirrorAdvertiseUrlsResult. - Mirror
Bond Entry - One row of
MirrorBondStatesResult: which bond, and what its state is. - Mirror
Bond Key - The
(store_id, root)pair that identifies one mirror bond — the read’s sort key and its cursor. - Pairing
Approve Result control.pairing.approve— the mint acknowledgement + the new token’s id.- Pairing
Poll Result pairing.poll— the pairing poll outcome (OPEN, no token).- Pairing
Request Result pairing.request— the pairing handshake bootstrap (OPEN, no token).- Pairing
Revoke Result control.pairing.revoke— the revoke acknowledgement.- Peer
Counts Result control.peerCounts— how many peers this node holds on EACH network.- Peers
Connect Result control.peers.connect— the connected peer’s id.- Peers
Disconnect Result control.peers.disconnect— the dropped peer’s id.- PinResult
control.hostedStores.pin— the pin acknowledgement + the pre-fetch outcome.- Profile
GetBody Result control.profile.getBody— the body this node holds at a store id + root, if it holds one.- Profile
PutBody Result control.profile.putBody— the acknowledgement that the node accepted and persisted a body.- Reserved
Coin - One coin held by a live reservation, and when that hold lapses.
- SetCap
Result control.cache.setCap— the applied cap (after the 64 MiB floor).- SetLevel
Result control.log.setLevel— the applied filter directive.- SetMirror
Advertise Urls Result control.config.setMirrorAdvertiseUrls— the persisted view, plus whether it IS the live answer yet.- SetUpstream
Result control.config.setUpstream— the persisted override + a restart hint.- Spend
Authority - ON WHOSE AUTHORITY the node signed without asking.
- Spend
Chain Reference - A chain reference, paired with whether this node actually OBSERVED it.
- Spends
List Result control.spends.list— one page of the automated-spend audit record.- Status
Result control.status— a rich node status snapshot.- Subscribe
Result control.subscribe— the subscription acknowledgement.- Sync
Availability - The §21 sync availability flag embedded in
StatusResult. - Sync
Status Result control.sync.status— §21 sync availability + pin coverage.- Sync
Trigger Result control.sync.trigger— the synced-capsule outcome.- Unknown
Phase Token - A phase token this build does not recognise, held so it cannot be confused with one it does.
- Unpin
Result control.hostedStores.unpin— the unpin acknowledgement + eviction count.- Unsubscribe
Result control.unsubscribe— the unsubscription acknowledgement.- UrlReconcile
Observation - One observation the daily detector (or a manual reconcile) made of this node’s own advertise
state — embedded in
UrlReconcileStatus::last_observation. - UrlReconcile
Status - This node’s URL-reconciliation standing — the automatic side of
control.mirror.reconcile. - Wallet
Arrival Record - One confirmed incoming payment, as the node’s arrival ledger recorded it.
- Wallet
Arrivals Result - One page of the arrival ledger (
control.wallet.arrivals). - Wallet
Balance Result control.wallet.balance— an address’s balance for one asset, as the node’s chain read saw it.- Wallet
Broadcast Result control.wallet.broadcast— the outcome of pushing an already-signed bundle.- Wallet
Coin ById Result control.wallet.coinById— ONE coin, named by its own id, spent or unspent.- Wallet
Coin Record - One coin, as the node’s chain read saw it (
control.wallet.coins/control.wallet.coinById). - Wallet
Coin Spend - One coin’s SPEND: the coin that was consumed, plus the two programs that consumed it.
- Wallet
Coin Spend Result control.wallet.coinSpend— the spend that spent one coin, named by that coin’s id.- Wallet
Coins ByParent Result control.wallet.coinsByParent— the DIRECT children created by spending one coin.- Wallet
Coins Result control.wallet.coins— an address’s spendable coins for one asset.- Wallet
Peak Result control.wallet.peak— the node’s current chain peak height.- Wallet
Reservations Held Result control.wallet.reservations.held— every coin currently committed to an in-flight spend.- Wallet
Reservations Release Result control.wallet.reservations.release— what a release actually freed.- Wallet
Reservations Reserve Result control.wallet.reservations.reserve— the handle for a hold that was taken in full.- Wallet
Reset Coin DbResult control.wallet.resetCoinDb— how much cache the reset actually discarded.- Wallet
Sync Status Result control.wallet.syncStatus— is the wallet’s chain replica being kept current, how far has it got, and how many Chia peers is it using?- Wallet
Unwatch Result control.wallet.unwatch— the outcome of deregistering public keys.- Wallet
Watch Result control.wallet.watch— the outcome of enrolling public keys.- Wallet
Watched Result control.wallet.watched— the public keys the node currently follows.
Enums§
- Chia
Peer Removal Outcome - What
control.chiaPeers.removeactually DID. - Collateral
Buffer Result control.collateral.buffer— the $DIG this node recommends holding, and where it stands against that figure.- Collateral
Buffer Unknown Reason - Why a node cannot state its recommended buffer or its funding position.
- Collateral
Funding State - The node’s funding position against its own recommended $DIG buffer.
- Collateral
Requirement Result control.collateral.requirement— this epoch’s per-store collateral requirement, or a named reason the node cannot state it.- Collateral
Unknown Reason - Why a node cannot state this epoch’s collateral requirement.
- Mirror
Advertise State - Which of dig-node#562’s
AdvertiseStateoutcomes produced aMirrorAdvertiseView. - Mirror
Bond State - What this node can say about ONE
(store, root)bond right now. - Mirror
Bond States Result control.mirror.bondStates— the per-(store, root)state of every mirror bond this node holds, and the $DIG those bonds have locked.- Mirror
Bond States Unknown Reason - Why a node cannot state its bond states AT ALL.
- Mirror
Reconcile Refusal - Why
control.mirror.reconcilerefused — and NOTHING was spent. - Mirror
Reconcile Result control.mirror.reconcile— reconcile this node’s mirror coins to its CURRENT advertise URL: reclaim every coin advertising a stale URL, then recreate it advertising the URL this node advertises TODAY. Shared by the manual “reset mirrors” action and the same primitive the node’s DAILY detector runs (dig-node#570) — ONE reconcile primitive, exposed two ways (dig_ecosystem#3203).- Mirror
Reconcile Wallet Capability - Which spending capability
control.mirror.reconcileneeds and cannot use, and why. - Peer
Software - A peer’s advertised SOFTWARE build, as read from the gossip handshake (dig_ecosystem#2215).
- Software
Version Detail - How much of its own build a node reveals when it advertises (dig_ecosystem#2215).
- Spend
Asset - Which asset an automated spend moved.
- Spend
Failure Stage - Where an attempt died.
- Spend
Outcome - Where one automated spend got to.
- Wallet
Operator Address Result - Where the node’s OWN operator wallet lives on chain — the MACHINE wallet, not the user’s.
- Wallet
Operator Address Unavailable Reason - Why a node cannot name its own operator wallet.
- Wallet
Read Source - Which tier answered a wallet read (dig_ecosystem#2233).
- Wallet
Sync Phase - How far the node’s wallet chain replica has got — the states a background sync can be in.