Struct bdk::blockchain::compact_filters::CompactFiltersBlockchain

pub struct CompactFiltersBlockchain { /* fields omitted */ }

This is supported on crate feature compact_filters only.

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>

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

pub fn get_capabilities(&self) -> HashSet<Capability>

Return the set of Capability supported by this backend

pub 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

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

Fetch a transaction from the blockchain given its txid

pub fn broadcast(&self, tx: &Transaction) -> Result<(), Error>

Broadcast a transaction

pub fn get_height(&self) -> Result<u32, Error>

Return the current height

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

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

pub 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 ConfigurableBlockchain for CompactFiltersBlockchain

type Config = CompactFiltersBlockchainConfig

Type that contains the configuration

pub fn from_config(config: &Self::Config) -> Result<Self, Error>

Create a new instance given a configuration

impl Debug for CompactFiltersBlockchain

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

Formats the value using the given formatter.

impl From<CompactFiltersBlockchain> for AnyBlockchain

pub fn from(inner: CompactFiltersBlockchain) -> Self

Performs the conversion.