Struct BlockingClient

pub struct BlockingClient {
    pub proxy: Option<String>,
    pub timeout: Option<u64>,
    pub headers: HashMap<String, String>,
    pub max_retries: usize,
    /* private fields */
}

Fields

proxy: Option<String>

The proxy is ignored when targeting wasm32.

timeout: Option<u64>

Socket timeout.

headers: HashMap<String, String>

HTTP headers to set on every request made to Esplora server

max_retries: usize

Number of times to retry a request

Implementations

impl BlockingClient

pub fn from_builder(builder: Builder) -> Self

Build a blocking client from a Builder

pub fn url(&self) -> &str

Get the underlying base URL.

pub fn get_request(&self, path: &str) -> Result<Request, Error>

Perform a raw HTTP GET request with the given URI path.

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<TxStatus, Error>

Get the status of a Transaction given its Txid.

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

Get transaction info given it’s Txid.

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_block_by_hash( &self, block_hash: &BlockHash, ) -> Result<Option<Block>, Error>

Get a Block 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_merkle_block( &self, txid: &Txid, ) -> Result<Option<MerkleBlock>, Error>

Get a MerkleBlock 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<u16, f64>, 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 get_address_stats( &self, address: &Address, ) -> Result<AddressStats, Error>

Get information about a specific address, includes confirmed balance and transactions in the mempool.

pub fn get_address_txs( &self, address: &Address, last_seen: Option<Txid>, ) -> Result<Vec<Tx>, Error>

Get transaction history for the specified address/scripthash, sorted with newest first.

Returns up to 50 mempool transactions plus the first 25 confirmed transactions. More can be requested by specifying the last txid seen by the previous query.

pub fn scripthash_txs( &self, script: &Script, last_seen: Option<Txid>, ) -> Result<Vec<Tx>, 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.

pub fn get_blocks( &self, height: Option<u32>, ) -> Result<Vec<BlockSummary>, Error>

Gets some recent block summaries starting at the tip or at height if provided.

The maximum number of summaries returned depends on the backend itself: esplora returns 10 while mempool.space returns 15.

Trait Implementations

impl Clone for BlockingClient

fn clone(&self) -> BlockingClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockingClient

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

Formats the value using the given formatter.