Struct RestClient

pub struct RestClient { /* private fields */ }

Available on crate feature use-reqwest only.

Creates HTTP REST requests to bitcoind.

See RestApi for the available methods.

Implementations

impl RestClient

pub fn new(endpoint: impl IntoUrl) -> Result<Self, Error>

Create a new RestClient instance with given endpoint url

pub fn network_default(network: Network) -> Self

Create a new RestClient instance with the default endpoint for that network

For example, Network::Bitcoin creates an instance with "http://localhost:8332"

Trait Implementations

impl Clone for RestClient

fn clone(&self) -> RestClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl RestApi for RestClient

fn get_json<'life0, 'life1, 'async_trait, T>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where T: 'async_trait + for<'a> Deserialize<'a>, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a response from a json endpoint

fn get_bin<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a response from a bin endpoint

fn get_block_headers<'life0, 'async_trait>( &'life0 self, start_hash: BlockHash, count: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<Header>, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a series of block headers beginning from a block hash

fn get_block_at_height<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = Result<Block, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Convenience function to get a block at a specific height

fn get_block_hash<'life0, 'async_trait>( &'life0 self, height: u64, ) -> Pin<Box<dyn Future<Output = Result<BlockHash, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a block hash at a specific height

fn get_block<'life0, 'async_trait>( &'life0 self, hash: BlockHash, ) -> Pin<Box<dyn Future<Output = Result<Block, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a block by its hash

fn get_transaction<'life0, 'async_trait>( &'life0 self, txid: Txid, ) -> Pin<Box<dyn Future<Output = Result<Transaction, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a transaction by its txid

fn get_block_filter_headers<'life0, 'async_trait>( &'life0 self, start_hash: BlockHash, count: u32, ) -> Pin<Box<dyn Future<Output = Result<Vec<FilterHeader>, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a series of block filter headers beginning from a block hash

fn get_block_filter<'life0, 'async_trait>( &'life0 self, hash: BlockHash, ) -> Pin<Box<dyn Future<Output = Result<BlockFilter, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get a block filter for a given block hash

fn get_chain_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetBlockchainInfoResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get info on the block chain state

fn get_utxos<'life0, 'life1, 'async_trait>( &'life0 self, outpoints: &'life1 [OutPoint], check_mempool: bool, ) -> Pin<Box<dyn Future<Output = Result<GetUtxosResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get utxos for a given set of outpoints

fn get_mempool_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetMempoolInfoResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get info on the mempool state

fn get_mempool<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<Txid, GetMempoolEntryResult>, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get info for every transaction in the mempool

fn get_mempool_txids<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Txid>, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get the txid for every transaction in the mempool Only available on Bitcoin Core v25.0.0 and later

fn get_mempool_txids_and_sequence<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetMempoolTxidsAndSequenceResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get the txid for every transaction in the mempool and the mempool sequence Only available on Bitcoin Core v25.0.0 and later

fn get_deployment_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetDeploymentInfoResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get soft fork deployment status info Only available on Bitcoin Core v25.0.0 and later

unsafe fn get_deployment_info_at_block<'life0, 'async_trait>( &'life0 self, hash: BlockHash, ) -> Pin<Box<dyn Future<Output = Result<GetDeploymentInfoResult, Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get soft fork deployment status info Only available on Bitcoin Core v25.1.0 and later