Expand description
Request/response wire types for every DIG-node RPC method.
Each type is serde-derived and models a method’s params or result
field-for-field with the canonical implementation (the digstore dig-node
crate). Fields that appear only in one profile or only on the first window of
a paged stream are Option and doc-flagged.
Hex-encoded identifiers (store_id, root, retrieval_key, peer_id) are
carried as String on the wire — lower-case 64-hex — because the interface
crate does no crypto and imposes no byte-array dependency. Callers validate
length/charset at their boundary.
§Two content profiles, one chunk type
ContentChunk models both the node profile (dig.getContent on the local
dig-node) and the network profile (rpc.dig.net). The network-profile-only
fields — total_length,
length, program_hash,
offset — are Option so one type serves both
surfaces with no silent split.
Structs§
- Anchored
Root - Result for
dig.getAnchoredRoot— the store’s current chain-anchored tip root. - Announce
Ack - Result for
dig.announce. - Announce
Params - Params for
dig.announce. - Availability
Answer - One availability answer. Only the fields relevant to the query’s granularity are populated.
- Availability
Batch - Result for
dig.getAvailability— one answer per query item, in order. - Availability
Query - One availability query item. Granularity is inferred from which fields are
present:
store_idonly ⇒ which roots are held;+root⇒ a capsule;+root +retrieval_key⇒ a resource. - Cache
Config - Result for
cache.getConfig. - Cache
Stats - Result for
cache.stats— cache telemetry besidecache.getConfig: the reserved cap + live usage, the cached-capsule count + total on-disk bytes, and the session eviction + content-cache counters. - Cached
Capsule - One durable cached-module entry.
- Cached
List - Result for
cache.listCached. - Capsule
Key - Params for a capsule-keyed cache op
(
cache.removeCached,cache.fetchAndCache). - Collection
- Result for
dig.getCollection— collection-level facts computed from DIG’s own coinset data. - Collection
Item - One resolved collection item — its current on-chain owner, royalty, and CHIP-0007 metadata.
- Collection
Items Page - Result for
dig.listCollectionItems— a page of resolved items. - Content
Cache Counters - The decoded-content cache hit/miss counters carried in
CacheStats. - Content
Chunk - One window of a resource’s ciphertext — the chunk wire object.
- Content
Ref - The content item a redirect points at:
store_id[+root[+retrieval_key]], each lower-case 64-hex — the exact item to re-request. - Fetch
AndCache Result - Result for
cache.fetchAndCache. - Fetch
Module Range Params - Params for
dig.fetchModuleRange— a single range frame of the whole.digmodule blob for(store, root). - Fetch
Range Params - Params for
dig.fetchRange— a single range frame of a resource this node holds. - GetAnchored
Root Params - Params for
dig.getAnchoredRoot. - GetAvailability
Params - Params for
dig.getAvailability. - GetCollection
Params - Params for
dig.getCollection. - GetContent
Params - Params for
dig.getContent— a verified resource-window read. - GetModule
Info Params - Params for
dig.getModuleInfo— the handshake a peer reads before range-pulling a whole.digmodule for(store, root). - GetReward
Distributor Params - Params for
dig.getRewardDistributor. - GetReward
Distributor Result - Result for
dig.getRewardDistributor— SPEC §2.6, third method: chain-derived distributor state only, never the local prover loop’s own state (seeRewardProverStatusfor that). - GetReward
Prover Status Params - Params for
dig.getRewardProverStatus. - GetReward
Prover Status Result - Result for
dig.getRewardProverStatus. - Health
- Result for
dig.health— liveness + a capability summary. - List
Collection Items Params - Params for
dig.listCollectionItems. - List
Inventory Params - Params for
dig.listInventory. - List
Reward Distributor Commitments Params - Params for
dig.listRewardDistributorCommitments. - List
Reward Distributor Commitments Result - Result for
dig.listRewardDistributorCommitments— SPEC §7.4 clause 5: per-epoch commitment slots, never a single balance figure. - List
Reward Distributors Result - Result for
dig.listRewardDistributors— SPEC §2.6: “the distributors this node funds, and the distributors this node has a claim to as a mirror”. - Methods
- Result for
dig.methods— the method names this node implements (agent self-describe). - Module
Info - Result for
dig.getModuleInfo— the transfer descriptor of a whole.digmodule. - Network
Info - Result for
dig.getNetworkInfo— this node’s own peer-network posture. - NftMetadata
- CHIP-0007 NFT metadata for one collection item.
- Payee
Claim Status - Result for
dig.getPayeeRewardClaimStatus— the claim-side posture of the node answering, as a payee. - Peer
Address - A peer’s dialable network endpoint.
- Peer
Connect Params - Params for
control.peers.connectandcontrol.peers.disconnect. - Peer
Connect Result - Result for
control.peers.connect. - Peer
Disconnect Result - Result for
control.peers.disconnect. - Peer
Status Snapshot - Result for
control.peerStatus— a snapshot of the node’s L7 peer network. Always safe to call; reportsrunning: falseon the FFI path. - Peers
List - Result for
dig.getPeers— the peers this node currently knows (peer exchange over RPC). - Prover
Counters - The reward prover loop’s running counters — SPEC §2.3.
- Provider
- A content provider: a holder’s stable
peer_idplus its candidate addresses. - Range
Frame - One range frame of a resource: a byte window, plus the per-resource verification metadata that makes the window independently checkable.
- Redirect
Info - The
error.data.redirectpayload of aContentRedirect(-32008). - Relay
Status - The node’s relay reservation posture.
- Remove
Cached Result - Result for
cache.removeCached. - Reward
Distributor Commitment - One clawback commitment slot for a distributor epoch — SPEC §7.4 clause 5.
- Reward
Distributor Ref - A minimal distributor reference — SPEC §2.6.
- Reward
Prover Status - One distributor’s prover-loop status — SPEC §2.3 / §2.4.
- SetCap
Bytes Params - Params for
cache.setCapBytes. - SetCap
Bytes Result - Result for
cache.setCapBytes. - Stage
Params - Params for
dig.stage— compile a local folder into a capsule.digmodule in-process. - Stage
Result - Result for
dig.stage— the compiled capsule. - Subscribe
Params - Params for
control.subscribeandcontrol.unsubscribe. - Subscribe
Result - Result for
control.subscribe. - Subscriptions
List - Result for
control.listSubscriptions. - Unsubscribe
Result - Result for
control.unsubscribe.
Enums§
- Claim
LogObservation - What a node can say about its own claim log: it read the log and has a count, or it did not read the log and has no count to give.
- Half
- One collection a responder either consulted — and can therefore answer for — or did not: dig-rewards-coin SPEC §12.5 clause 6.
- Inventory
- Result for
dig.listInventory. - Payee
Subject - The subject of a payee-side status answer.
- Prover
State - The always-on reward prover loop’s state — SPEC §2.3, the closed set.
Type Aliases§
- HexId
- A lower-case 64-hex identifier on the wire (e.g. a
store_id,root,retrieval_key, orpeer_id). A type alias for documentation; validation is the boundary’s job.