Struct bdk::blockchain::EsploraBlockchain

pub struct EsploraBlockchain { /* private fields */ }

Available on crate feature esplora only.

Structure that implements the logic to sync with Esplora

Example

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

Implementations

impl EsploraBlockchain

pub fn new(base_url: &str, stop_gap: usize) -> Self

Create a new instance of the client from a base URL and the stop_gap.

pub fn from_client(url_client: BlockingClient, stop_gap: usize) -> Self

Build a new instance given a client

pub fn with_concurrency(self, concurrency: u8) -> Self

Set the number of parallel requests the client can make.

Methods from Deref<Target = BlockingClient>

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

Get a Transaction option given its Txid

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

Get a Transaction given its Txid.

pub fn get_txid_at_block_index(
    &self,
    block_hash: &BlockHash,
    index: usize
) -> Result<Option<Txid>, Error>

Get a Txid of a transaction given its index in a block with a given hash.

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

Get the status of a Transaction given its Txid.

pub fn get_header(&self, block_height: u32) -> Result<BlockHeader, Error>

👎Deprecated since 0.1.2: Deprecated to improve alignment with Esplora API. Users should use get_block_hash and get_header_by_hash methods directly.

Get a BlockHeader given a particular block height.

pub fn get_header_by_hash(
    &self,
    block_hash: &BlockHash
) -> Result<BlockHeader, Error>

Get a BlockHeader given a particular block hash.

pub fn get_block_status(
    &self,
    block_hash: &BlockHash
) -> Result<BlockStatus, Error>

Get the BlockStatus given a particular BlockHash.

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

Get a merkle inclusion proof for a Transaction with the given Txid.

pub fn get_output_status(
    &self,
    txid: &Txid,
    index: u64
) -> Result<Option<OutputStatus>, Error>

Get the spending status of an output given a Txid and the output index.

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

Broadcast a Transaction to Esplora

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

Get the height of the current blockchain tip.

pub fn get_tip_hash(&self) -> Result<BlockHash, Error>

Get the BlockHash of the current blockchain tip.

pub fn get_block_hash(&self, block_height: u32) -> Result<BlockHash, Error>

Get the BlockHash of a specific block height

pub fn get_fee_estimates(
    &self
) -> Result<HashMap<String, f64, RandomState>, Error>

Get an map where the key is the confirmation target (in number of blocks) and the value is the estimated feerate (in sat/vB).

pub fn scripthash_txs(
    &self,
    script: &Script,
    last_seen: Option<Txid>
) -> Result<Vec<Tx, Global>, Error>

Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.

Trait Implementations

impl Blockchain for EsploraBlockchain

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

Return the set of Capability supported by this backend

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

Broadcast a transaction

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

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

impl ConfigurableBlockchain for EsploraBlockchain

type Config = EsploraBlockchainConfig

Type that contains the configuration

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

Create a new instance given a configuration

impl Debug for EsploraBlockchain

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

Formats the value using the given formatter.

impl Deref for EsploraBlockchain

type Target = BlockingClient

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<EsploraBlockchain> for AnyBlockchain

fn from(inner: EsploraBlockchain) -> Self

Converts to this type from the input type.

impl GetBlockHash for EsploraBlockchain

fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error>

fetch block hash given its height

impl GetHeight for EsploraBlockchain

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

Return the current height

impl GetTx for EsploraBlockchain

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

Fetch a transaction given its txid

impl WalletSync for EsploraBlockchain

fn wallet_setup<D: BatchDatabase>(
    &self,
    database: &mut D,
    _progress_update: Box<dyn Progress>
) -> Result<(), Error>

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

fn wallet_sync<D: BatchDatabase>(
    &self,
    database: &mut D,
    progress_update: Box<dyn Progress>
) -> Result<(), Error>

If not overridden, it defaults to calling Self::wallet_setup internally.

impl StatelessBlockchain for EsploraBlockchain