Struct Client 

pub struct Client(/* private fields */);

Bitcoin Core RPC client. Thread-safe and cheap to clone.

Implementations

impl Client

pub fn get_block_count(&self) -> Result<u64>

Returns the numbers of block in the longest chain.

pub fn get_last_height(&self) -> Result<Height>

Returns the numbers of block in the longest chain.

pub fn get_block<'a, H>(&self, hash: &'a H) -> Result<Block>

where &'a H: Into<&'a BlockHash>,

pub fn get_block_info<'a, H>(&self, hash: &'a H) -> Result<GetBlockVerboseOne>

where &'a H: Into<&'a BlockHash>,

pub fn get_block_header<'a, H>(&self, hash: &'a H) -> Result<Header>

where &'a H: Into<&'a BlockHash>,

pub fn get_block_header_info<'a, H>( &self, hash: &'a H, ) -> Result<GetBlockHeaderVerbose>

where &'a H: Into<&'a BlockHash>,

pub fn get_block_hash<H>(&self, height: H) -> Result<BlockHash>

where H: Into<u64> + Copy,

pub fn get_block_hashes_range<H1, H2>( &self, start: H1, end: H2, ) -> Result<Vec<BlockHash>>

where H1: Into<u64>, H2: Into<u64>,

Get every canonical block hash for the inclusive height range start..=end in a single JSON-RPC batch request. Returns hashes in canonical order (start, start+1, …, end). Use this whenever resolving more than ~2 heights — one HTTP round-trip beats N sequential get_block_hash calls once the per-call overhead dominates.

pub fn get_tx_out( &self, txid: &Txid, vout: Vout, include_mempool: Option<bool>, ) -> Result<Option<GetTxOut>>

pub fn get_raw_mempool(&self) -> Result<Vec<Txid>>

pub fn get_raw_transaction<'a, T>(&self, txid: &'a T) -> Result<Transaction>

where &'a T: Into<&'a Txid>,

pub fn get_raw_transaction_from<'a, T, H>( &self, txid: &'a T, block_hash: &'a H, ) -> Result<Transaction>

where &'a T: Into<&'a Txid>, &'a H: Into<&'a BlockHash>,

pub fn get_raw_transaction_hex<'a, T>(&self, txid: &'a T) -> Result<String>

where &'a T: Into<&'a Txid>,

pub fn get_raw_transaction_hex_from<'a, T, H>( &self, txid: &'a T, block_hash: &'a H, ) -> Result<String>

where &'a T: Into<&'a Txid>, &'a H: Into<&'a BlockHash>,

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

pub fn get_raw_transactions( &self, txids: &[Txid], ) -> Result<FxHashMap<Txid, Transaction>>

Batched getrawtransaction over a slice of txids. Returns a map keyed by txid containing the deserialized tx. Individual failures (e.g. a tx that evicted between the listing and this call) are logged and dropped so a single bad entry doesn’t kill the batch.

Chunked at BATCH_CHUNK requests per round-trip.

pub fn send_raw_transaction(&self, hex: &str) -> Result<Txid>

pub fn fetch_mempool_state( &self, ) -> Result<(MempoolState, Vec<BlockTemplateTx>)>

Core’s projected next block + live mempool txid set + mempoolminfee, fetched in a single bitcoind round-trip. GBT carries each tx’s full body and stats, so block 0 is exact even when a tx vanishes from the mempool listing between the GBT and getrawmempool calls; no follow-up entry fetch can race it. Returns the passthrough MempoolState and the raw block_template (consumed downstream by GBT synthesis), in one batched round-trip: getblocktemplate + getrawmempool false

• getmempoolinfo.

pub fn fetch_new_pool_data( &self, txids: &[Txid], ) -> Result<(Vec<MempoolEntryInfo>, FxHashMap<Txid, Transaction>)>

Mixed batch of getmempoolentry + getrawtransaction for the same txid set in one round-trip. Returns the entries vec and the raw-tx map keyed by txid. Per-item -5 (NOT_FOUND — tx evicted between the listing and this call) drops silently for either leg; transport-level failures still propagate. Chunked at BATCH_CHUNK txids per round-trip (2× that on the wire).

pub fn get_closest_valid_height( &self, hash: BlockHash, ) -> Result<(Height, BlockHash)>

pub fn get_blockchain_info(&self) -> Result<GetBlockchainInfo>

pub fn get_network(&self) -> Result<Network>

Bitcoin network the connected node is running on, derived from getblockchaininfo.chain.

pub fn wait_for_synced_node(&self) -> Result<()>

impl Client

pub fn new(url: &str, auth: Auth) -> Result<Self>

pub fn new_with( url: &str, auth: Auth, max_retries: usize, retry_delay: Duration, ) -> Result<Self>

pub fn default_url() -> &'static str

pub fn default_bitcoin_path() -> PathBuf

pub fn default_linux_bitcoin_path() -> PathBuf

pub fn default_mac_bitcoin_path() -> PathBuf

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.