Struct esplora_client::blocking::BlockingClient

pub struct BlockingClient { /* private fields */ }

Implementations

impl BlockingClient

pub fn from_builder(builder: Builder) -> Result<Self, Error>

build a blocking client from a Builder

pub fn from_agent(url: String, agent: Agent) -> Self

build a blocking client from an Agent

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_header(&self, block_height: u32) -> Result<BlockHeader, Error>

👎Deprecated since 0.2.0: 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_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<String, 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 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.

pub fn url(&self) -> &str

Get the underlying base URL.

pub fn agent(&self) -> &Agent

Get the underlying Agent.

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.