Skip to main content

Module params

Module params 

Source
Expand description

Typed request params for the control methods, each bound to its method + result via crate::traits::ControlCall.

One params type per method (even where two methods share the same field shape, e.g. the four { store } methods) so the compile-time method↔params↔result binding is exact: a caller passes PinParams { store } and the type system yields a PinResult. Field names are the exact wire names dig-node reads.

Structs§

ApproveParams
control.pairing.approve params.
AssetId
A CAT asset id — the TAIL hash that names one token on the Chia chain.
CacheClearParams
control.cache.clear params (none).
CacheGetParams
control.cache.get params (none).
CapsuleFetchParams
control.capsule.fetch params: WHICH capsule to pull, named by store id + root — the same two-field shape as ProfileGetBodyParams, not the colon-joined store string PinParams/SyncTriggerParams use, because the caller always knows both parts already (there is no store-level-only fetch).
ChiaPeersAddParams
control.chiaPeers.add params — the Chia full node to start TRUSTING.
ChiaPeersRemoveParams
control.chiaPeers.remove params — the Chia full node to stop trusting.
CollateralBufferParams
control.collateral.buffer params (none).
CollateralMarginGetParams
control.collateral.margin.get params (none).
CollateralMarginSetParams
control.collateral.margin.set params.
CollateralRequirementParams
control.collateral.requirement params (none).
ConfigGetParams
control.config.get params (none).
HostedStoreStatusParams
control.hostedStores.status params.
HostedStoresListParams
control.hostedStores.list params (none).
ListSubscriptionsParams
control.listSubscriptions params (none).
MirrorBondStatesParams
control.mirror.bondStates params — one page of this node’s mirror bond states.
MirrorReconcileParams
control.mirror.reconcile params: reconcile this node’s mirror coins to its CURRENT advertise URL.
PairingListParams
control.pairing.list params (none). Result is the pending + issued-token list.
PauseParams
control.updater.pause params.
PeerCountsParams
control.peerCounts params — none.
PeerStatusParams
control.peerStatus params (none). Result is the peer-pool snapshot.
PeersConnectParams
control.peers.connect params.
PeersDisconnectParams
control.peers.disconnect params.
PinParams
control.hostedStores.pin params.
PollParams
pairing.poll params (OPEN — no token).
ProfileGetBodyParams
control.profile.getBody params: WHICH profile body to read, named by store id + root.
ProfilePutBodyParams
control.profile.putBody params: the profile body a confirmed chain root commits to.
RequestParams
pairing.request params (OPEN — no token).
RevokeParams
control.pairing.revoke params.
SetCapParams
control.cache.setCap params.
SetChannelParams
control.updater.setChannel params.
SetLevelParams
control.log.setLevel params.
SetMirrorAdvertiseUrlsParams
control.config.setMirrorAdvertiseUrls params.
SetUpstreamParams
control.config.setUpstream params.
SpendsListParams
control.spends.list params: WHICH automated spends to read, and how much of the record at once.
StatusParams
control.status params (none).
SubscribeParams
control.subscribe params.
SyncStatusParams
control.sync.status params (none).
SyncTriggerParams
control.sync.trigger params.
UnpinParams
control.hostedStores.unpin params.
UnsubscribeParams
control.unsubscribe params.
UpdaterCheckNowParams
control.updater.checkNow params (none).
UpdaterResumeParams
control.updater.resume params (none).
UpdaterStatusParams
control.updater.status params (none). Result is the proxied beacon status.
WalletArrivalsParams
control.wallet.arrivals — confirmed INCOMING funds recorded since a cursor position.
WalletBalanceParams
control.wallet.balance params: which address + asset to read the balance of.
WalletBroadcastParams
control.wallet.broadcast params: an ALREADY-SIGNED spend bundle to push.
WalletCoinByIdParams
control.wallet.coinById params: WHICH coin, named by its own id.
WalletCoinSpendParams
control.wallet.coinSpend params: WHICH coin’s spend to read, named by that coin’s own id.
WalletCoinsByParentParams
control.wallet.coinsByParent params: WHICH coin’s direct children to read.
WalletCoinsParams
control.wallet.coins params: which address + asset to read spendable coins for, and which PAGE of them.
WalletOperatorAddressParams
control.wallet.operatorAddress params — none.
WalletPeakParams
control.wallet.peak params — none.
WalletReservationsHeldParams
control.wallet.reservations.held params — none.
WalletReservationsReleaseParams
control.wallet.reservations.release params: free one reservation now, ahead of its TTL.
WalletReservationsReserveParams
control.wallet.reservations.reserve params: take EVERY named coin, or take none.
WalletResetCoinDbParams
control.wallet.resetCoinDb params: discard the cached coin database and re-sync from chain.
WalletSyncStatusParams
control.wallet.syncStatus params — none.
WalletUnwatchParams
control.wallet.unwatch params: which PUBLIC keys the node should stop following.
WalletWatchParams
control.wallet.watch params: which PUBLIC keys the node should follow.
WalletWatchedParams
control.wallet.watched params — none.

Enums§

Asset
The asset a wallet balance/coin read is denominated in: native XCH, or any CAT by asset id.
AssetIdParseError
Why an asset id could not be parsed. Deliberately small — an id is either 32 bytes of hex or it is not an id, and guessing at a near-miss is how a wallet ends up reading the wrong token.
SubscriptionKind
WHAT a subscription follows: ordinary content, or a dig-profile.

Constants§

ASSET_ID_HEX_LEN
The length of a CAT asset id (TAIL hash) in hex characters: a 32-byte hash.
COINS_BY_PARENT_DEFAULT_LIMIT
The page size control.wallet.coinsByParent uses when the caller names none.
COINS_BY_PARENT_MAX_LIMIT
The largest page control.wallet.coinsByParent will accept, derived from the transport’s own frame limit rather than chosen for feel.
COINS_DEFAULT_LIMIT
The page size control.wallet.coins uses when the caller names none (dig-node#381).
COINS_MAX_LIMIT
The largest page control.wallet.coins will accept — the same frame-derived ceiling COINS_BY_PARENT_MAX_LIMIT documents the arithmetic for, and pinned to it for the reason COINS_DEFAULT_LIMIT gives.
DEFAULT_BUFFER_HORIZON_EPOCHS
The horizon, in future epochs, a node covers when it recommends a buffer without being told otherwise — 4.
DEFAULT_SAFETY_MARGIN_BP
The default local safety margin, in basis points — +1%.
ESCALATION_UP_STEP_DENOM
The per-epoch escalation step denominator — 8, i.e. the requirement can rise by at most +1/8 (+12.5%) in one epoch.
MAX_BANNED_CHIA_PEERS
The maximum number of BANNED Chia peers a conforming node persists.
MAX_BODY_BYTES
The largest dig-profile body the control plane accepts or returns, in bytes: 4 MiB.
MAX_SAFETY_MARGIN_BP
The largest safety margin a node accepts, in basis points — 10_000, i.e. +100%.
MIRROR_BOND_STATES_DEFAULT_LIMIT
The page size control.mirror.bondStates returns when a caller names none.
MIRROR_BOND_STATES_MAX_LIMIT
The largest page control.mirror.bondStates will return.
SPENDS_LIST_DEFAULT_LIMIT
The page size control.spends.list uses when the caller names none.
SPENDS_LIST_MAX_LIMIT
The largest page control.spends.list will serve.

Functions§

canonical_peer_ip
The CANONICAL textual form of a Chia peer address, or an INVALID_PARAMS error.
chia_peer_endpoint
Join a canonical peer ip to a port, bracketing IPv6 as RFC 3986 requires.