Struct Client

pub struct Client { /* private fields */ }

Client implements a JSON-RPC client for the Bitcoin Core daemon or compatible APIs.

Implementations

impl Client

pub fn new(url: &str) -> Self

Creates a client to a bitcoind JSON-RPC server without authentication.

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

Creates a client to a bitcoind JSON-RPC server with authentication.

pub fn call<T: for<'a> Deserialize<'a>>( &self, method: &str, args: &[Value], ) -> Result<T>

Call an RPC method with given args list.

impl Client

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

Checks that the JSON-RPC endpoint is for a bitcoind instance with the expected version.

impl Client

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

impl Client

pub fn best_block_hash(&self) -> Result<BlockHash>

Gets the blockhash of the current chain tip.

pub fn get_best_block_hash(&self) -> Result<GetBestBlockHash>

impl Client

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

Gets a block by blockhash.

pub fn get_block_verbosity_zero( &self, hash: BlockHash, ) -> Result<GetBlockVerbosityZero>

pub fn get_block_verbosity_one( &self, hash: BlockHash, ) -> Result<GetBlockVerbosityOne>

impl Client

pub fn get_tx_out(&self, txid: Txid, vout: u64) -> Result<GetTxOut>

impl Client

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

impl Client

pub fn get_block_hash(&self, height: u64) -> Result<GetBlockHash>

impl Client

pub fn get_block_header(&self, hash: &BlockHash) -> Result<GetBlockHeader>

pub fn get_block_header_verbose( &self, hash: &BlockHash, ) -> Result<GetBlockHeaderVerbose>

impl Client

pub fn get_block_stats_by_height(&self, height: u32) -> Result<GetBlockStats>

pub fn get_block_stats_by_block_hash( &self, hash: &BlockHash, ) -> Result<GetBlockStats>

impl Client

pub fn get_chain_tips(&self) -> Result<GetChainTips>

impl Client

pub fn get_chain_tx_stats(&self) -> Result<GetChainTxStats>

impl Client

pub fn get_difficulty(&self) -> Result<GetDifficulty>

impl Client

pub fn get_mempool_ancestors(&self, txid: Txid) -> Result<GetMempoolAncestors>

impl Client

pub fn get_memory_info(&self) -> Result<GetMemoryInfoStats>

impl Client

pub fn logging(&self) -> Result<Logging>

impl Client

pub fn stop(&self) -> Result<String>

impl Client

pub fn uptime(&self) -> Result<u32>

impl Client

pub fn generate_to_address( &self, nblocks: usize, address: &Address, ) -> Result<GenerateToAddress>

impl Client

pub fn generate(&self, nblocks: usize) -> Result<Generate>

impl Client

pub fn get_added_node_info(&self) -> Result<GetAddedNodeInfo>

impl Client

pub fn get_net_totals(&self) -> Result<GetNetTotals>

impl Client

pub fn server_version(&self) -> Result<usize>

Returns the server version field of GetNetworkInfo.

pub fn get_network_info(&self) -> Result<GetNetworkInfo>

impl Client

pub fn get_peer_info(&self) -> Result<GetPeerInfo>

impl Client

pub fn send_raw_transaction( &self, tx: &Transaction, ) -> Result<SendRawTransaction>

impl Client

pub fn create_wallet(&self, wallet: &str) -> Result<CreateWallet>

impl Client

pub fn unload_wallet(&self, wallet: &str) -> Result<()>

impl Client

pub fn load_wallet(&self, wallet: &str) -> Result<LoadWallet>

impl Client

pub fn new_address(&self) -> Result<Address>

Gets a new address from bitcoind and parses it assuming its correct.

pub fn new_address_with_type(&self, ty: AddressType) -> Result<Address>

Gets a new address from bitcoind and parses it assuming its correct.

pub fn get_new_address(&self) -> Result<GetNewAddress>

pub fn get_new_address_with_type( &self, ty: AddressType, ) -> Result<GetNewAddress>

impl Client

pub fn get_balance(&self) -> Result<GetBalance>

impl Client

pub fn send_to_address( &self, address: &Address<NetworkChecked>, amount: Amount, ) -> Result<SendToAddress>

impl Client

pub fn get_transaction(&self, txid: Txid) -> Result<GetTransaction>

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.