Struct ColdStorage 

pub struct ColdStorage<B = ErasedBackend>
where
    B: ColdStorageBackend,
{ /* private fields */ }

Unified handle for interacting with a cold storage backend.

ColdStorage<B> is cheap to Clone — it is just an Arc around the shared inner state. All operations dispatch through semaphore-gated TaskTracker-spawned tasks.

Implementations

impl<B> ColdStorage<B>

where B: ColdStorageBackend,

pub fn new(backend: B, cancel: CancellationToken) -> ColdStorage<B>

Create a new cold storage handle wrapping backend.

A hidden coordinator task watches cancel and, on fire, closes the read/write/stream semaphores and the task tracker. After cancel, all handle methods fail fast with ColdStorageError::TaskTerminated on permit acquisition; in-flight spawned tasks drain to completion bounded by backend timeouts.

pub async fn wait_shutdown(&self)

Close the task tracker and wait for all in-flight tasks to finish.

Idempotent with the shutdown coordinator: safe to call whether or not the cancel token has fired.

pub async fn get_header( &self, spec: HeaderSpecifier, ) -> Result<Option<Sealed<Header>>, ColdStorageError>

Get a header by specifier.

pub async fn get_header_by_number( &self, block: u64, ) -> Result<Option<Sealed<Header>>, ColdStorageError>

Get a header by block number.

pub async fn get_header_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Sealed<Header>>, ColdStorageError>

Get a header by block hash.

pub async fn get_headers( &self, specs: Vec<HeaderSpecifier>, ) -> Result<Vec<Option<Sealed<Header>>>, ColdStorageError>

Get multiple headers by specifiers.

pub async fn get_transaction( &self, spec: TransactionSpecifier, ) -> Result<Option<Confirmed<Recovered<EthereumTxEnvelope<TxEip4844>>>>, ColdStorageError>

Get a transaction by specifier, with block confirmation metadata.

pub async fn get_tx_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Confirmed<Recovered<EthereumTxEnvelope<TxEip4844>>>>, ColdStorageError>

Get a transaction by hash.

pub async fn get_tx_by_block_and_index( &self, block: u64, index: u64, ) -> Result<Option<Confirmed<Recovered<EthereumTxEnvelope<TxEip4844>>>>, ColdStorageError>

Get a transaction by block number and index.

pub async fn get_tx_by_block_hash_and_index( &self, block_hash: FixedBytes<32>, index: u64, ) -> Result<Option<Confirmed<Recovered<EthereumTxEnvelope<TxEip4844>>>>, ColdStorageError>

Get a transaction by block hash and index.

pub async fn get_transactions_in_block( &self, block: u64, ) -> Result<Vec<Recovered<EthereumTxEnvelope<TxEip4844>>>, ColdStorageError>

Get all transactions in a block.

pub async fn get_transaction_count( &self, block: u64, ) -> Result<u64, ColdStorageError>

Get the transaction count for a block.

pub async fn get_receipt( &self, spec: ReceiptSpecifier, ) -> Result<Option<ColdReceipt>, ColdStorageError>

Get a receipt by specifier.

pub async fn get_receipt_by_tx_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<ColdReceipt>, ColdStorageError>

Get a receipt by transaction hash.

pub async fn get_receipt_by_block_and_index( &self, block: u64, index: u64, ) -> Result<Option<ColdReceipt>, ColdStorageError>

Get a receipt by block number and index.

pub async fn get_receipts_in_block( &self, block: u64, ) -> Result<Vec<ColdReceipt>, ColdStorageError>

Get all receipts in a block.

pub async fn get_signet_events( &self, spec: SignetEventsSpecifier, ) -> Result<Vec<DbSignetEvent>, ColdStorageError>

Get signet events by specifier.

pub async fn get_signet_events_in_block( &self, block: u64, ) -> Result<Vec<DbSignetEvent>, ColdStorageError>

Get signet events in a block.

pub async fn get_signet_events_in_range( &self, start: u64, end: u64, ) -> Result<Vec<DbSignetEvent>, ColdStorageError>

Get signet events in a range of blocks.

pub async fn get_zenith_header( &self, block: u64, ) -> Result<Option<DbZenithHeader>, ColdStorageError>

Get a zenith header by block number.

pub async fn get_zenith_headers( &self, spec: ZenithHeaderSpecifier, ) -> Result<Vec<DbZenithHeader>, ColdStorageError>

Get zenith headers by specifier.

pub async fn get_zenith_headers_in_range( &self, start: u64, end: u64, ) -> Result<Vec<DbZenithHeader>, ColdStorageError>

Get zenith headers in a range of blocks.

pub async fn get_logs( &self, filter: Filter, max_logs: usize, ) -> Result<Vec<Log>, ColdStorageError>

Filter logs by block range, address, and topics.

Follows eth_getLogs semantics. Returns matching logs ordered by (block_number, tx_index, log_index).

pub async fn stream_logs( &self, filter: Filter, max_logs: usize, deadline: Duration, ) -> Result<ReceiverStream<Result<Log, ColdStorageError>>, ColdStorageError>

Stream logs matching a filter.

Returns a LogStream that yields matching logs in order. Consume with StreamExt::next() until None. If the last item is Err(...), an error occurred (deadline, too many logs, reorg).

The deadline is clamped to the handle’s configured maximum.

pub async fn get_latest_block(&self) -> Result<Option<u64>, ColdStorageError>

Get the latest block number in storage.

pub async fn append_block( &self, data: BlockData, ) -> Result<(), ColdStorageError>

Append a single block to cold storage.

pub async fn append_blocks( &self, data: Vec<BlockData>, ) -> Result<(), ColdStorageError>

Append multiple blocks to cold storage.

pub async fn truncate_above(&self, block: u64) -> Result<(), ColdStorageError>

Truncate all data above the given block number.

This removes block N+1 and higher from all tables and invalidates any cached lookups above block.

pub async fn drain_above( &self, block: u64, ) -> Result<Vec<Vec<ColdReceipt>>, ColdStorageError>

Read and remove all blocks above the given block number.

Returns receipts for each block above block in ascending order, then truncates. Index 0 = block+1, index 1 = block+2, etc.

impl ColdStorage

pub fn new_erased<B>(backend: B, cancel: CancellationToken) -> ColdStorage

where B: ColdStorageBackend,

Construct a type-erased cold storage handle.

Wraps backend in ErasedBackend so the resulting handle has no B type parameter to propagate through downstream signatures. Equivalent to ColdStorage::new(ErasedBackend::new(backend), cancel).

Choose this constructor when you want runtime swappability of the backend; use new directly for fully monomorphized call sites.

Trait Implementations

impl<B> Clone for ColdStorage<B>

where B: ColdStorageBackend,

fn clone(&self) -> ColdStorage<B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Debug for ColdStorage<B>

where B: ColdStorageBackend,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.