Struct FullScanRequest

pub struct FullScanRequest<K> { /* private fields */ }

Data required to perform a spk-based blockchain client full scan.

A client full scan iterates through all the scripts for the given keychains, fetching relevant data until some stop gap number of scripts is found that have no data. This operation is generally only used when importing or restoring previously used keychains in which the list of used scripts is not known. The full scan process also updates the chain from the given chain_tip (if provided).

Implementations

impl<K: Ord + Clone> FullScanRequest<K>

pub fn builder_at(start_time: u64) -> FullScanRequestBuilder<K>

Start building a FullScanRequest with a given start_time.

start_time specifies the start time of sync. Chain sources can use this value to set TxUpdate::seen_ats for mempool transactions. A transaction without any seen_ats is assumed to be unseen in the mempool.

Use FullScanRequest::builder to use the current timestamp as start_time (this requires feature = "std).

pub fn builder() -> FullScanRequestBuilder<K>

Start building a FullScanRequest with the current timestamp as the start_time.

Use FullScanRequest::builder_at to manually set the start_time, or if feature = "std" is not available.

pub fn start_time(&self) -> u64

When the full-scan-request was initiated.

pub fn chain_tip(&self) -> Option<CheckPoint>

Get the chain tip CheckPoint of this request (if any).

pub fn keychains(&self) -> Vec<K>

List all keychains contained in this request.

pub fn next_spk(&mut self, keychain: K) -> Option<Indexed<ScriptBuf>>

Advances the full scan request and returns the next indexed ScriptBuf of the given keychain.

pub fn iter_spks( &mut self, keychain: K, ) -> impl Iterator<Item = Indexed<ScriptBuf>> + '_

Iterate over indexed ScriptBufs contained in this request of the given keychain.

Trait Implementations

impl<K> From<FullScanRequestBuilder<K>> for FullScanRequest<K>

fn from(builder: FullScanRequestBuilder<K>) -> Self

Converts to this type from the input type.