Struct BitcoinRpcClient 

pub struct BitcoinRpcClient { /* private fields */ }

Minimal async JSON-RPC client for Bitcoin Core regtest nodes.

Implementations

impl BitcoinRpcClient

pub fn new( host: impl AsRef<str>, port: u16, user: impl Into<String>, password: impl Into<String>, ) -> Self

Create a client for a host, port, and RPC credentials.

pub fn endpoint(&self) -> &str

Return the HTTP endpoint used by this client.

pub fn wallet(&self, wallet_name: &str) -> Self

Return a client scoped to a named Bitcoin Core wallet.

pub async fn get_blockchain_info( &self, ) -> Result<BlockchainInfo, BitcoinRpcError>

Call getblockchaininfo.

pub async fn list_wallets(&self) -> Result<Vec<String>, BitcoinRpcError>

Call listwallets.

pub async fn create_wallet( &self, wallet_name: &str, ) -> Result<CreateWallet, BitcoinRpcError>

Call createwallet.

pub async fn load_wallet( &self, wallet_name: &str, ) -> Result<LoadWallet, BitcoinRpcError>

Call loadwallet.

pub async fn ensure_wallet( &self, wallet_name: &str, ) -> Result<(), BitcoinRpcError>

Ensure a wallet is loaded, creating it if it does not already exist.

pub async fn get_new_address(&self) -> Result<String, BitcoinRpcError>

Call getnewaddress.

pub async fn generate_to_address( &self, count: u64, address: &str, ) -> Result<Vec<String>, BitcoinRpcError>

Mine count regtest blocks to address.

pub async fn get_block(&self, hash: &str) -> Result<BlockInfo, BitcoinRpcError>

Call getblock with verbosity 1.

pub async fn add_node(&self, socket: &str) -> Result<(), BitcoinRpcError>

Call addnode <socket> add.

pub async fn send_to_address( &self, address: &str, amount_btc: f64, ) -> Result<String, BitcoinRpcError>

Call sendtoaddress and return the transaction id.

pub async fn send_many( &self, amounts: &HashMap<String, f64>, ) -> Result<String, BitcoinRpcError>

Call sendmany and return the transaction id.

pub async fn call<T>( &self, method: &str, params: Value, ) -> Result<T, BitcoinRpcError>

where T: DeserializeOwned,

Call a JSON-RPC method and deserialize the result field.

pub async fn call_value( &self, method: &str, params: Value, ) -> Result<Value, BitcoinRpcError>

Call a JSON-RPC method and return the raw JSON result field.

Trait Implementations

impl Clone for BitcoinRpcClient

fn clone(&self) -> BitcoinRpcClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitcoinRpcClient

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

Formats the value using the given formatter.