Struct bitcoind_json_rpc_regtest::Client

pub struct Client { /* private fields */ }

Available on crate feature 26_0 only.

The version specific client and json types.

THIS IS AVAILABLE FOR ALL VERSION NUMBER FEATURES (eg 25_0, 24_2 etc). This crate is unusual in that it expects exactly one version number feature to be selected, docs.rs is not set up to handle such oddity.

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

Implementations

impl Client

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

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

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

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

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

where T: for<'a> Deserialize<'a>,

Call an RPC method with given args list.

impl Client

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

impl Client

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

Gets the blockhash of the current chain tip.

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

impl Client

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

Gets a block by blockhash.

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

Returns the server version field of GetNetworkInfo.

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_balances(&self) -> Result<GetBalances, Error>

impl Client

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

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

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

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

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

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

impl Client

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

impl Client

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

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.