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§
- Approve
Params control.pairing.approveparams.- AssetId
- A CAT asset id — the TAIL hash that names one token on the Chia chain.
- Cache
Clear Params control.cache.clearparams (none).- Cache
GetParams control.cache.getparams (none).- Capsule
Fetch Params control.capsule.fetchparams: WHICH capsule to pull, named by store id + root — the same two-field shape asProfileGetBodyParams, not the colon-joinedstorestringPinParams/SyncTriggerParamsuse, because the caller always knows both parts already (there is no store-level-only fetch).- Chia
Peers AddParams control.chiaPeers.addparams — the Chia full node to start TRUSTING.- Chia
Peers Remove Params control.chiaPeers.removeparams — the Chia full node to stop trusting.- Collateral
Buffer Params control.collateral.bufferparams (none).- Collateral
Margin GetParams control.collateral.margin.getparams (none).- Collateral
Margin SetParams control.collateral.margin.setparams.- Collateral
Requirement Params control.collateral.requirementparams (none).- Config
GetParams control.config.getparams (none).- Hosted
Store Status Params control.hostedStores.statusparams.- Hosted
Stores List Params control.hostedStores.listparams (none).- List
Subscriptions Params control.listSubscriptionsparams (none).- Mirror
Bond States Params control.mirror.bondStatesparams — one page of this node’s mirror bond states.- Mirror
Reconcile Params control.mirror.reconcileparams: reconcile this node’s mirror coins to its CURRENT advertise URL.- Pairing
List Params control.pairing.listparams (none). Result is the pending + issued-token list.- Pause
Params control.updater.pauseparams.- Peer
Counts Params control.peerCountsparams — none.- Peer
Status Params control.peerStatusparams (none). Result is the peer-pool snapshot.- Peers
Connect Params control.peers.connectparams.- Peers
Disconnect Params control.peers.disconnectparams.- PinParams
control.hostedStores.pinparams.- Poll
Params pairing.pollparams (OPEN — no token).- Profile
GetBody Params control.profile.getBodyparams: WHICH profile body to read, named by store id + root.- Profile
PutBody Params control.profile.putBodyparams: the profile body a confirmed chain root commits to.- Request
Params pairing.requestparams (OPEN — no token).- Revoke
Params control.pairing.revokeparams.- SetCap
Params control.cache.setCapparams.- SetChannel
Params control.updater.setChannelparams.- SetLevel
Params control.log.setLevelparams.- SetMirror
Advertise Urls Params control.config.setMirrorAdvertiseUrlsparams.- SetUpstream
Params control.config.setUpstreamparams.- Spends
List Params control.spends.listparams: WHICH automated spends to read, and how much of the record at once.- Status
Params control.statusparams (none).- Subscribe
Params control.subscribeparams.- Sync
Status Params control.sync.statusparams (none).- Sync
Trigger Params control.sync.triggerparams.- Unpin
Params control.hostedStores.unpinparams.- Unsubscribe
Params control.unsubscribeparams.- Updater
Check NowParams control.updater.checkNowparams (none).- Updater
Resume Params control.updater.resumeparams (none).- Updater
Status Params control.updater.statusparams (none). Result is the proxied beacon status.- Wallet
Arrivals Params control.wallet.arrivals— confirmed INCOMING funds recorded since a cursor position.- Wallet
Balance Params control.wallet.balanceparams: which address + asset to read the balance of.- Wallet
Broadcast Params control.wallet.broadcastparams: an ALREADY-SIGNED spend bundle to push.- Wallet
Coin ById Params control.wallet.coinByIdparams: WHICH coin, named by its own id.- Wallet
Coin Spend Params control.wallet.coinSpendparams: WHICH coin’s spend to read, named by that coin’s own id.- Wallet
Coins ByParent Params control.wallet.coinsByParentparams: WHICH coin’s direct children to read.- Wallet
Coins Params control.wallet.coinsparams: which address + asset to read spendable coins for, and which PAGE of them.- Wallet
Operator Address Params control.wallet.operatorAddressparams — none.- Wallet
Peak Params control.wallet.peakparams — none.- Wallet
Reservations Held Params control.wallet.reservations.heldparams — none.- Wallet
Reservations Release Params control.wallet.reservations.releaseparams: free one reservation now, ahead of its TTL.- Wallet
Reservations Reserve Params control.wallet.reservations.reserveparams: take EVERY named coin, or take none.- Wallet
Reset Coin DbParams control.wallet.resetCoinDbparams: discard the cached coin database and re-sync from chain.- Wallet
Sync Status Params control.wallet.syncStatusparams — none.- Wallet
Unwatch Params control.wallet.unwatchparams: which PUBLIC keys the node should stop following.- Wallet
Watch Params control.wallet.watchparams: which PUBLIC keys the node should follow.- Wallet
Watched Params control.wallet.watchedparams — none.
Enums§
- Asset
- The asset a wallet balance/coin read is denominated in: native XCH, or any CAT by asset id.
- Asset
IdParse Error - 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.
- Subscription
Kind - 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.coinsByParentuses when the caller names none. - COINS_
BY_ PARENT_ MAX_ LIMIT - The largest page
control.wallet.coinsByParentwill accept, derived from the transport’s own frame limit rather than chosen for feel. - COINS_
DEFAULT_ LIMIT - The page size
control.wallet.coinsuses when the caller names none (dig-node#381). - COINS_
MAX_ LIMIT - The largest page
control.wallet.coinswill accept — the same frame-derived ceilingCOINS_BY_PARENT_MAX_LIMITdocuments the arithmetic for, and pinned to it for the reasonCOINS_DEFAULT_LIMITgives. - 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.bondStatesreturns when a caller names none. - MIRROR_
BOND_ STATES_ MAX_ LIMIT - The largest page
control.mirror.bondStateswill return. - SPENDS_
LIST_ DEFAULT_ LIMIT - The page size
control.spends.listuses when the caller names none. - SPENDS_
LIST_ MAX_ LIMIT - The largest page
control.spends.listwill serve.
Functions§
- canonical_
peer_ ip - The CANONICAL textual form of a Chia peer address, or an
INVALID_PARAMSerror. - chia_
peer_ endpoint - Join a canonical peer
ipto a port, bracketing IPv6 as RFC 3986 requires.