Struct bitcoincore_rest::BitcoinRest

pub struct BitcoinRest { /* private fields */ }

Holds the endpoint and http client

Implementations

impl BitcoinRest

pub fn new(endpoint: String) -> Self

Create a new BitcoinRest instance with given endpoint url Must be in the format “http://{ip}:{port}/rest/”

pub fn network_default(network: Network) -> Self

Create a new BitcoinRest instance with the default endpoint for that network For example, Network::Bitcoin creates an instance with “http://localhost:8332/rest/”

pub async fn get_json<T: for<'a> Deserialize<'a>>(
    &self,
    path: &str
) -> Result<T, Error>

Get a response from a json endpoint

pub async fn get_bin(&self, path: &str) -> Result<Bytes, Error>

Get a response from a bin endpoint

pub async fn get_block_headers(
    &self,
    start_hash: &BlockHash,
    count: u32
) -> Result<Vec<BlockHeader>, Error>

Get a series of block headers beginning from a block hash See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#blockheaders

pub async fn get_block_at_height(&self, height: u64) -> Result<Block, Error>

Convenience function to get a block at a specific height

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

Get a block hash at a specific height See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#blockhash-by-height

pub async fn get_block(&self, hash: &BlockHash) -> Result<Block, Error>

Get a block by its hash See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#blocks

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

Get a transaction by its txid See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#transactions

pub async fn get_block_filter_headers(
    &self,
    start_hash: &BlockHash,
    count: u32
) -> Result<Vec<FilterHeader>, Error>

Get a series of block filter headers beggining from a block hash See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#blockfilter-headers

pub async fn get_block_filter(
    &self,
    hash: &BlockHash
) -> Result<BlockFilter, Error>

Get a block filter for a given block hash See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#blockfilters

pub async fn get_chain_info(&self) -> Result<GetBlockchainInfoResult, Error>

Get info on the block chain state See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#chaininfos

pub async fn get_utxos(
    &self,
    outpoints: Vec<OutPoint>,
    check_mempool: bool
) -> Result<GetUtxosResult, Error>

Get utxos for a given set of outpoints Optionally check unconfirmed utxos in the mempool See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#query-utxo-set

pub async fn get_mempool_info(&self) -> Result<GetMempoolInfoResult, Error>

Get info on the mempool state See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#memory-pool

pub async fn get_mempool(
    &self
) -> Result<HashMap<Txid, GetMempoolEntryResult>, Error>

Get info for every transaction in the mempool See https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md#memory-pool

Trait Implementations

impl Clone for BitcoinRest

fn clone(&self) -> BitcoinRest

Returns a copy of the value.

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

Performs copy-assignment from source.