Struct bdk::blockchain::compact_filters::CompactFiltersBlockchain

[+] Show declaration

pub struct CompactFiltersBlockchain { /* fields omitted */ }

This is supported on feature="compact_filters" only.

[−] Expand description

Structure implementing the required blockchain traits

Example

See the blockchain::compact_filters module for a usage example.

Implementations

impl CompactFiltersBlockchain[−]

pub fn new<P: AsRef<Path>>(
    peers: Vec<Peer>,
    storage_dir: P,
    skip_blocks: Option<usize>
) -> Result<Self, CompactFiltersError>[−]

This is supported on feature="compact_filters" only.

Construct a new instance given a list of peers, a path to store headers and block filters downloaded during the sync and optionally a number of blocks to ignore starting from the genesis while scanning for the wallet's outputs.

For each Peer specified a new thread will be spawned to download and verify the filters in parallel. It's currently recommended to only connect to a single peer to avoid inconsistencies in the data returned, optionally with multiple connections in parallel to speed-up the sync process.

Trait Implementations

impl Blockchain for CompactFiltersBlockchain[+]

[+] Show hidden undocumented items

fn get_capabilities(&self) -> HashSet<Capability>[−]

Return the set of Capability supported by this backend

fn setup<D: BatchDatabase, P: 'static + Progress>(
    &self,
    _stop_gap: Option<usize>,
    database: &mut D,
    progress_update: P
) -> Result<(), Error>[−]

Setup the backend and populate the internal database for the first time

fn get_tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error>[−]

Fetch a transaction from the blockchain given its txid

fn broadcast(&self, tx: &Transaction) -> Result<(), Error>[−]

Broadcast a transaction

fn get_height(&self) -> Result<u32, Error>[−]

Return the current height

fn estimate_fee(&self, _target: usize) -> Result<FeeRate, Error>[−]

Estimate the fee rate required to confirm a transaction in a given target of blocks

fn sync<D: BatchDatabase, P: 'static + Progress>(
    &self,
    stop_gap: Option<usize>,
    database: &mut D,
    progress_update: P
) -> Result<(), Error>[−]

Populate the internal database with transactions and UTXOs

impl Debug for CompactFiltersBlockchain[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.