Skip to main content

Module results

Module results 

Source
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§

AutomatedSpend
One spend this node made WITHOUT per-transaction approval.
CacheClearResult
control.cache.clear — the clear acknowledgement.
CacheView
The on-disk content-cache view (control.cache.get, and embedded in StatusResult).
CapsuleEntry
One cached capsule of a store, as listed by the hosted-stores methods.
CapsuleFetchResult
control.capsule.fetch — the P2P pull acknowledgement.
ChiaPeerEntry
One tracked Chia full-node peer.
ChiaPeersAddResult
control.chiaPeers.add — the acknowledgement, including the cost that was paid.
ChiaPeersListResult
control.chiaPeers.list — every tracked Chia peer: trusted, discovered and banned alike.
ChiaPeersRemoveResult
control.chiaPeers.remove — the acknowledgement.
CollateralMarginResult
control.collateral.margin.get / .set — the node’s LOCAL safety margin.
ConfigResult
control.config.get — the node’s effective configuration.
HostedStore
One hosted/pinned store (control.hostedStores.list).
HostedStoreStatusResult
control.hostedStores.status — per-store pinned flag + cached capsules.
HostedStoresListResult
control.hostedStores.list — every held/pinned store.
ListSubscriptionsResult
control.listSubscriptions — the node’s persisted subscription set.
MirrorAdvertiseView
The mirror advertise-URL view: embedded in ConfigResult, and embedded in turn in SetMirrorAdvertiseUrlsResult.
MirrorBondEntry
One row of MirrorBondStatesResult: which bond, and what its state is.
MirrorBondKey
The (store_id, root) pair that identifies one mirror bond — the read’s sort key and its cursor.
PairingApproveResult
control.pairing.approve — the mint acknowledgement + the new token’s id.
PairingPollResult
pairing.poll — the pairing poll outcome (OPEN, no token).
PairingRequestResult
pairing.request — the pairing handshake bootstrap (OPEN, no token).
PairingRevokeResult
control.pairing.revoke — the revoke acknowledgement.
PeerCountsResult
control.peerCounts — how many peers this node holds on EACH network.
PeersConnectResult
control.peers.connect — the connected peer’s id.
PeersDisconnectResult
control.peers.disconnect — the dropped peer’s id.
PinResult
control.hostedStores.pin — the pin acknowledgement + the pre-fetch outcome.
ProfileGetBodyResult
control.profile.getBody — the body this node holds at a store id + root, if it holds one.
ProfilePutBodyResult
control.profile.putBody — the acknowledgement that the node accepted and persisted a body.
ReservedCoin
One coin held by a live reservation, and when that hold lapses.
SetCapResult
control.cache.setCap — the applied cap (after the 64 MiB floor).
SetLevelResult
control.log.setLevel — the applied filter directive.
SetMirrorAdvertiseUrlsResult
control.config.setMirrorAdvertiseUrls — the persisted view, plus whether it IS the live answer yet.
SetUpstreamResult
control.config.setUpstream — the persisted override + a restart hint.
SpendAuthority
ON WHOSE AUTHORITY the node signed without asking.
SpendChainReference
A chain reference, paired with whether this node actually OBSERVED it.
SpendsListResult
control.spends.list — one page of the automated-spend audit record.
StatusResult
control.status — a rich node status snapshot.
SubscribeResult
control.subscribe — the subscription acknowledgement.
SyncAvailability
The §21 sync availability flag embedded in StatusResult.
SyncStatusResult
control.sync.status — §21 sync availability + pin coverage.
SyncTriggerResult
control.sync.trigger — the synced-capsule outcome.
UnknownPhaseToken
A phase token this build does not recognise, held so it cannot be confused with one it does.
UnpinResult
control.hostedStores.unpin — the unpin acknowledgement + eviction count.
UnsubscribeResult
control.unsubscribe — the unsubscription acknowledgement.
UrlReconcileObservation
One observation the daily detector (or a manual reconcile) made of this node’s own advertise state — embedded in UrlReconcileStatus::last_observation.
UrlReconcileStatus
This node’s URL-reconciliation standing — the automatic side of control.mirror.reconcile.
WalletArrivalRecord
One confirmed incoming payment, as the node’s arrival ledger recorded it.
WalletArrivalsResult
One page of the arrival ledger (control.wallet.arrivals).
WalletBalanceResult
control.wallet.balance — an address’s balance for one asset, as the node’s chain read saw it.
WalletBroadcastResult
control.wallet.broadcast — the outcome of pushing an already-signed bundle.
WalletCoinByIdResult
control.wallet.coinById — ONE coin, named by its own id, spent or unspent.
WalletCoinRecord
One coin, as the node’s chain read saw it (control.wallet.coins / control.wallet.coinById).
WalletCoinSpend
One coin’s SPEND: the coin that was consumed, plus the two programs that consumed it.
WalletCoinSpendResult
control.wallet.coinSpend — the spend that spent one coin, named by that coin’s id.
WalletCoinsByParentResult
control.wallet.coinsByParent — the DIRECT children created by spending one coin.
WalletCoinsResult
control.wallet.coins — an address’s spendable coins for one asset.
WalletPeakResult
control.wallet.peak — the node’s current chain peak height.
WalletReservationsHeldResult
control.wallet.reservations.held — every coin currently committed to an in-flight spend.
WalletReservationsReleaseResult
control.wallet.reservations.release — what a release actually freed.
WalletReservationsReserveResult
control.wallet.reservations.reserve — the handle for a hold that was taken in full.
WalletResetCoinDbResult
control.wallet.resetCoinDb — how much cache the reset actually discarded.
WalletSyncStatusResult
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?
WalletUnwatchResult
control.wallet.unwatch — the outcome of deregistering public keys.
WalletWatchResult
control.wallet.watch — the outcome of enrolling public keys.
WalletWatchedResult
control.wallet.watched — the public keys the node currently follows.

Enums§

ChiaPeerRemovalOutcome
What control.chiaPeers.remove actually DID.
CollateralBufferResult
control.collateral.buffer — the $DIG this node recommends holding, and where it stands against that figure.
CollateralBufferUnknownReason
Why a node cannot state its recommended buffer or its funding position.
CollateralFundingState
The node’s funding position against its own recommended $DIG buffer.
CollateralRequirementResult
control.collateral.requirement — this epoch’s per-store collateral requirement, or a named reason the node cannot state it.
CollateralUnknownReason
Why a node cannot state this epoch’s collateral requirement.
MirrorAdvertiseState
Which of dig-node#562’s AdvertiseState outcomes produced a MirrorAdvertiseView.
MirrorBondState
What this node can say about ONE (store, root) bond right now.
MirrorBondStatesResult
control.mirror.bondStates — the per-(store, root) state of every mirror bond this node holds, and the $DIG those bonds have locked.
MirrorBondStatesUnknownReason
Why a node cannot state its bond states AT ALL.
MirrorReconcileRefusal
Why control.mirror.reconcile refused — and NOTHING was spent.
MirrorReconcileResult
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).
MirrorReconcileWalletCapability
Which spending capability control.mirror.reconcile needs and cannot use, and why.
PeerSoftware
A peer’s advertised SOFTWARE build, as read from the gossip handshake (dig_ecosystem#2215).
SoftwareVersionDetail
How much of its own build a node reveals when it advertises (dig_ecosystem#2215).
SpendAsset
Which asset an automated spend moved.
SpendFailureStage
Where an attempt died.
SpendOutcome
Where one automated spend got to.
WalletOperatorAddressResult
Where the node’s OWN operator wallet lives on chain — the MACHINE wallet, not the user’s.
WalletOperatorAddressUnavailableReason
Why a node cannot name its own operator wallet.
WalletReadSource
Which tier answered a wallet read (dig_ecosystem#2233).
WalletSyncPhase
How far the node’s wallet chain replica has got — the states a background sync can be in.