Skip to main content

Module model

Module model 

Source
Expand description

Shared local API models, with archive-only capabilities kept in this crate.

Structs§

ArchiveConfig
The application start is independent of the chain genesis and header anchor. There is deliberately no implicit tip-minus-N or checkpoint-based default.
ArchiveStatus
Status structs are non_exhaustive: build them from Default and assign fields, so additive fields stay non-breaking.
ArchivedRecord
BookEntry
One peer-book entry as served by GET /v1/overlay/book: an untrusted routing hint. Addresses carry no terminal /p2p; peer_id is set once a dial has authenticated it. Times are Unix seconds.
CacheReceipt
Historical receipt of one atomic cache maintenance step. Later admissions, pins and reorgs can change usage. Protected evidence and SQLite/WAL overhead are outside this metric; disabled enforcement does not imply an empty archive.
ChainPoint
CommitSourceStatus
DiscoveryStatus
Peer book and discovery counters. reached counts entries whose last dial succeeded, reached_ever entries with any past successful dial; a dial proves an identity answered, not honesty.
ObjectStatus
A successful complete reconstruction, distinct from interval coverage. Counts describe the current archive snapshot. A reorg can leave all bytes available locally while some memberships no longer belong to the selected chain.
Omission
A selected record placement a peer’s coverage claimed but did not list.
OverlayPeerStatus
OverlayStatus
Public overlay facts; never secrets. Counters cover this service run.
PinReceipt
Acknowledges a local pin operation at its commit point. This is not a promise of current chain selection, object availability forever, or peer trust.
PruneReceipt
Explicit local cache maintenance. Counts removed child records, not raw transactions or bytes; unpruned archives return zero without eviction.
RecordPackage
Transport data, never trusted merely because it came from another node. The receiver selects the header independently before verifying this proof. commit authenticates the exact prevout through its TXID; this package does NOT assert the commit’s inclusion, ordering, or witness authenticity. Names must obtain independently anchored commit placement before applying a record.
RecordReceipt
Local evidence at one archive generation. Selective admission establishes membership and the URMA proof, never a full-block scan or interval coverage.
ScanTicket
A capability issued by this archive for a particular selected block. The epoch changes on a reorg; a worker cannot commit using an old ticket.
ServiceStatus
Operator-reported service state. Every last_*_error describes the latest attempt of that worker; *_at is when it was recorded, in Unix seconds.

Enums§

BookOrigin
How a peer-book entry entered the book. Ordered by precedence: learning never downgrades an entry, and manual and seed entries are never evicted.
Retention

Constants§

API_VERSION
SCAN_RULES_VERSION