Struct Client

pub struct Client { /* private fields */ }

An async client for interacting with a bitcoind instance.

Implementations

impl Client

pub fn new( url: String, username: String, password: String, max_retries: Option<u8>, retry_interval: Option<u64>, ) -> ClientResult<Self>

Creates a new Client with the given URL, username, and password.

Trait Implementations

impl Broadcaster for Client

async fn send_raw_transaction(&self, tx: &Transaction) -> ClientResult<Txid>

Sends a raw transaction to the network.

async fn test_mempool_accept( &self, tx: &Transaction, ) -> ClientResult<Vec<TestMempoolAccept>>

Tests if a raw transaction is valid.

async fn submit_package( &self, txs: &[Transaction], ) -> ClientResult<SubmitPackage>

Submit a package of raw transactions (serialized, hex-encoded) to local node.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Reader for Client

async fn estimate_smart_fee(&self, conf_target: u16) -> ClientResult<u64>

Estimates the approximate fee per kilobyte needed for a transaction to begin confirmation within conf_target blocks if possible and return the number of blocks for which the estimate is valid.

async fn get_block_header(&self, hash: &BlockHash) -> ClientResult<Header>

Gets a Header with the given hash.

async fn get_block(&self, hash: &BlockHash) -> ClientResult<Block>

Gets a Block with the given hash.

async fn get_block_height(&self, hash: &BlockHash) -> ClientResult<u64>

Gets a block height with the given hash.

async fn get_block_header_at(&self, height: u64) -> ClientResult<Header>

Gets a Header at given height.

async fn get_block_at(&self, height: u64) -> ClientResult<Block>

Gets a Block at given height.

async fn get_block_count(&self) -> ClientResult<u64>

Gets the height of the most-work fully-validated chain.

async fn get_block_hash(&self, height: u64) -> ClientResult<BlockHash>

Gets the BlockHash at given height.

async fn get_blockchain_info(&self) -> ClientResult<GetBlockchainInfo>

Gets various state info regarding blockchain processing.

async fn get_current_timestamp(&self) -> ClientResult<u32>

Gets the timestamp in the block header of the current best block in bitcoin.

async fn get_raw_mempool(&self) -> ClientResult<Vec<Txid>>

Gets all transaction ids in mempool.

async fn get_raw_transaction_verbosity_zero( &self, txid: &Txid, ) -> ClientResult<GetRawTransactionVerbosityZero>

Gets a raw transaction by its Txid.

async fn get_raw_transaction_verbosity_one( &self, txid: &Txid, ) -> ClientResult<GetRawTransactionVerbosityOne>

Gets a raw transaction by its Txid.

async fn get_tx_out( &self, txid: &Txid, vout: u32, include_mempool: bool, ) -> ClientResult<GetTxOut>

Returns details about an unspent transaction output.

async fn network(&self) -> ClientResult<Network>

Gets the underlying Network information.

impl Signer for Client

async fn sign_raw_transaction_with_wallet( &self, tx: &Transaction, prev_outputs: Option<Vec<PreviousTransactionOutput>>, ) -> ClientResult<SignRawTransactionWithWallet>

Signs a transaction using the keys available in the underlying Bitcoin client’s wallet and returns a signed transaction.

async fn get_xpriv(&self) -> ClientResult<Option<Xpriv>>

Gets the underlying Xpriv from the wallet.

async fn import_descriptors( &self, descriptors: Vec<ImportDescriptor>, wallet_name: String, ) -> ClientResult<Vec<ImportDescriptorResult>>

Imports the descriptors into the wallet.

impl Wallet for Client

async fn get_new_address(&self) -> ClientResult<Address>

Generates new address under own control for the underlying Bitcoin client’s wallet.

async fn get_transaction(&self, txid: &Txid) -> ClientResult<GetTransaction>

Gets information related to a transaction.

async fn get_utxos(&self) -> ClientResult<Vec<ListUnspent>>

Gets all Unspent Transaction Outputs (UTXOs) for the underlying Bitcoin client’s wallet.

async fn list_transactions( &self, count: Option<usize>, ) -> ClientResult<Vec<ListTransactions>>

Lists transactions in the underlying Bitcoin client’s wallet.

async fn list_wallets(&self) -> ClientResult<Vec<String>>

Lists all wallets in the underlying Bitcoin client.

async fn create_raw_transaction( &self, raw_tx: CreateRawTransaction, ) -> ClientResult<Transaction>

Creates a raw transaction.