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 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_verbose_zero( &self, hash: BlockHash, ) -> Result<GetBlockVerboseZero>

Gets a block by blockhash with verbose set to 0.

pub fn get_block_verbose_one( &self, hash: BlockHash, ) -> Result<GetBlockVerboseOne>

Gets a block by blockhash with verbose set to 1.

impl Client

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

impl Client

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

impl Client

pub fn get_block_filter(&self, block: BlockHash) -> Result<GetBlockFilter>

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>

pub fn get_mempool_ancestors_verbose( &self, txid: Txid, ) -> Result<GetMempoolAncestorsVerbose>

impl Client

pub fn get_mempool_descendants( &self, txid: Txid, ) -> Result<GetMempoolDescendants>

pub fn get_mempool_descendants_verbose( &self, txid: Txid, ) -> Result<GetMempoolDescendantsVerbose>

impl Client

pub fn get_mempool_entry(&self, txid: Txid) -> Result<GetMempoolEntry>

impl Client

pub fn get_mempool_info(&self) -> Result<GetMempoolInfo>

impl Client

pub fn get_raw_mempool(&self) -> Result<GetRawMempool>

pub fn get_raw_mempool_verbose(&self) -> Result<GetRawMempool>

impl Client

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

impl Client

pub fn get_tx_out_proof(&self, txids: &[Txid]) -> Result<String>

impl Client

pub fn get_tx_out_set_info(&self) -> Result<GetTxOutSetInfo>

impl Client

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

impl Client

pub fn prune_blockchain(&self, target: u64) -> Result<PruneBlockchain>

Instructs the node to prune the blockchain up to a specified height or timestamp.

impl Client

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

impl Client

pub fn verify_chain(&self) -> Result<VerifyChain>

impl Client

pub fn verify_tx_out_proof(&self, proof: &str) -> Result<VerifyTxOutProof>

impl Client

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

impl Client

pub fn get_rpc_info(&self) -> Result<GetRpcInfo>

impl Client

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

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_block( &self, output: &str, transactions: &[String], ) -> Result<GenerateBlock>

impl Client

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

impl Client

pub fn generate_to_descriptor( &self, nblocks: usize, descriptor: &str, ) -> Result<GenerateToDescriptor>

impl Client

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

impl Client

pub fn add_peer_address( &self, address: &str, port: u16, ) -> Result<AddPeerAddress>

impl Client

pub fn get_block_template( &self, request: &TemplateRequest, ) -> Result<GetBlockTemplate>

impl Client

pub fn get_mining_info(&self) -> Result<GetMiningInfo>

impl Client

pub fn get_network_hash_ps(&self) -> Result<f64>

impl Client

pub fn prioritise_transaction( &self, txid: &Txid, fee_delta: SignedAmount, ) -> Result<bool>

impl Client

pub fn submit_block(&self, block: &Block) -> Result<()>

impl Client

pub fn submit_header(&self, header: &Header) -> Result<()>

impl Client

pub fn add_node(&self, node: &str, command: AddNodeCommand) -> Result<()>

impl Client

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

impl Client

pub fn disconnect_node(&self, address: &str) -> Result<()>

impl Client

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

impl Client

pub fn get_connection_count(&self) -> Result<GetConnectionCount>

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_node_addresses(&self) -> Result<GetNodeAddresses>

impl Client

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

impl Client

pub fn list_banned(&self) -> Result<ListBanned>

impl Client

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

impl Client

pub fn set_ban(&self, subnet: &str, command: SetBanCommand) -> Result<()>

impl Client

pub fn set_network_active(&self, state: bool) -> Result<SetNetworkActive>

impl Client

pub fn analyze_psbt(&self, psbt: &Psbt) -> Result<AnalyzePsbt>

impl Client

pub fn combine_psbt(&self, txs: &[Psbt]) -> Result<CombinePsbt>

impl Client

pub fn combine_raw_transaction( &self, txs: &[Transaction], ) -> Result<CombineRawTransaction>

impl Client

pub fn convert_to_psbt(&self, tx: &Transaction) -> Result<ConvertToPsbt>

impl Client

pub fn create_psbt( &self, inputs: &[Input], outputs: &[Output], ) -> Result<CreatePsbt>

impl Client

pub fn create_raw_transaction( &self, inputs: &[Input], outputs: &[Output], ) -> Result<CreateRawTransaction>

impl Client

pub fn decode_psbt(&self, psbt: &str) -> Result<DecodePsbt>

impl Client

pub fn decode_raw_transaction( &self, tx: &Transaction, ) -> Result<DecodeRawTransaction>

impl Client

pub fn decode_script(&self, script: &str) -> Result<DecodeScript>

impl Client

pub fn finalize_psbt(&self, psbt: &Psbt) -> Result<FinalizePsbt>

impl Client

pub fn fund_raw_transaction( &self, tx: &Transaction, ) -> Result<FundRawTransaction>

impl Client

pub fn get_raw_transaction(&self, txid: Txid) -> Result<GetRawTransaction>

pub fn get_raw_transaction_verbose( &self, txid: Txid, ) -> Result<GetRawTransactionVerbose>

impl Client

pub fn join_psbts(&self, psbts: &[Psbt]) -> Result<JoinPsbts>

impl Client

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

impl Client

pub fn sign_raw_transaction( &self, tx: &Transaction, ) -> Result<SignRawTransaction>

impl Client

pub fn sign_raw_transaction_with_key( &self, tx: &Transaction, keys: &[PrivateKey], ) -> Result<SignRawTransactionWithKey>

impl Client

pub fn test_mempool_accept( &self, txs: &[Transaction], ) -> Result<TestMempoolAccept>

impl Client

pub fn utxo_update_psbt(&self, psbt: &Psbt) -> Result<UtxoUpdatePsbt>

impl Client

pub fn create_multisig( &self, nrequired: u32, keys: Vec<PublicKey>, ) -> Result<CreateMultisig>

impl Client

pub fn derive_addresses(&self, descriptor: &str) -> Result<DeriveAddresses>

impl Client

pub fn estimate_smart_fee(&self, blocks: u32) -> Result<EstimateSmartFee>

impl Client

pub fn get_descriptor_info(&self, descriptor: &str) -> Result<GetDescriptorInfo>

impl Client

pub fn get_index_info(&self) -> Result<GetIndexInfo>

impl Client

pub fn sign_message_with_privkey( &self, privkey: &PrivateKey, message: &str, ) -> Result<SignMessageWithPrivKey>

impl Client

pub fn validate_address( &self, address: &Address<NetworkChecked>, ) -> Result<ValidateAddress>

impl Client

pub fn verify_message( &self, address: &Address<NetworkChecked>, signature: &MessageSignature, message: &str, ) -> Result<VerifyMessage>

impl Client

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

impl Client

pub fn abort_rescan(&self) -> Result<AbortRescan>

impl Client

pub fn add_multisig_address_with_keys( &self, nrequired: u32, keys: Vec<PublicKey>, ) -> Result<AddMultisigAddress>

pub fn add_multisig_address_with_addresses( &self, nrequired: u32, keys: Vec<Address>, ) -> Result<AddMultisigAddress>

impl Client

pub fn backup_wallet(&self, destination: &Path) -> Result<()>

impl Client

pub fn bump_fee(&self, txid: Txid) -> Result<BumpFee>

impl Client

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

Calls createwallet with wallet as the only argument.

In v21 and v22 this creates a legacy wallet. Use create_descriptor_wallet to create a descriptor wallet.

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

Creates a wallet with descriptors=true (descriptor wallet).

createwallet “wallet_name” ( disable_private_keys blank “passphrase” avoid_reuse descriptors load_on_startup )

Creates and loads a new wallet.

Arguments:

1. wallet_name (string, required) The name for the new wallet. If this is a path, the wallet will be created at the path location.
2. disable_private_keys (boolean, optional, default=false) Disable the possibility of private keys (only watchonlys are possible in this mode).
3. blank (boolean, optional, default=false) Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed.
4. passphrase (string, optional) Encrypt the wallet with this passphrase.
5. avoid_reuse (boolean, optional, default=false) Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind.
6. descriptors (boolean, optional, default=true) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation
7. load_on_startup (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged.

impl Client

pub fn dump_priv_key(&self, address: &Address) -> Result<DumpPrivKey>

impl Client

pub fn dump_wallet(&self, filename: &Path) -> Result<DumpWallet>

impl Client

pub fn encrypt_wallet(&self, passphrase: &str) -> Result<EncryptWallet>

impl Client

pub fn get_received_by_label(&self, label: &str) -> Result<GetReceivedByLabel>

impl Client

pub fn get_addresses_by_label(&self, label: &str) -> Result<GetAddressesByLabel>

impl Client

pub fn get_address_info(&self, address: &Address) -> Result<GetAddressInfo>

impl Client

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

impl Client

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

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 new_address_with_label( &self, label: &str, ) -> Result<Address<NetworkUnchecked>>

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

pub fn get_new_address( &self, label: Option<&str>, ty: Option<AddressType>, ) -> Result<GetNewAddress>

Gets a new address - low level RPC call.

impl Client

pub fn get_raw_change_address(&self) -> Result<GetRawChangeAddress>

impl Client

pub fn get_received_by_address( &self, address: &Address<NetworkChecked>, ) -> Result<GetReceivedByAddress>

impl Client

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

impl Client

pub fn get_unconfirmed_balance(&self) -> Result<GetUnconfirmedBalance>

impl Client

pub fn get_wallet_info(&self) -> Result<GetWalletInfo>

impl Client

pub fn import_address(&self, address: &Address) -> Result<()>

impl Client

pub fn import_descriptors( &self, requests: &[ImportDescriptorsRequest], ) -> Result<ImportDescriptors>

impl Client

pub fn import_multi( &self, requests: &[ImportMultiRequest], ) -> Result<ImportMulti>

impl Client

pub fn import_privkey(&self, privkey: &PrivateKey) -> Result<()>

impl Client

pub fn import_pruned_funds( &self, raw_transaction: &str, tx_out_proof: &str, ) -> Result<()>

impl Client

pub fn import_pubkey(&self, pubkey: &PublicKey) -> Result<()>

impl Client

pub fn import_wallet(&self, filename: &Path) -> Result<()>

impl Client

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

impl Client

pub fn list_address_groupings(&self) -> Result<ListAddressGroupings>

impl Client

pub fn list_labels(&self) -> Result<ListLabels>

impl Client

pub fn list_received_by_label(&self) -> Result<ListReceivedByLabel>

impl Client

pub fn list_lock_unspent(&self) -> Result<ListLockUnspent>

impl Client

pub fn list_received_by_address(&self) -> Result<ListReceivedByAddress>

impl Client

pub fn list_since_block(&self) -> Result<ListSinceBlock>

impl Client

pub fn list_transactions(&self) -> Result<ListTransactions>

impl Client

pub fn list_unspent(&self) -> Result<ListUnspent>

impl Client

pub fn list_wallet_dir(&self) -> Result<ListWalletDir>

impl Client

pub fn list_wallets(&self) -> Result<ListWallets>

impl Client

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

impl Client

pub fn lock_unspent(&self, outputs: &[(Txid, u32)]) -> Result<LockUnspent>

Lock the given list of transaction outputs. Returns true on success.

This wraps Core RPC: lockunspent false [{"txid":"..","vout":n},...].

pub fn unlock_unspent(&self, outputs: &[(Txid, u32)]) -> Result<LockUnspent>

Unlock the given list of transaction outputs. Returns true on success.

This wraps Core RPC: lockunspent true [{"txid":"..","vout":n},...].

impl Client

pub fn psbt_bump_fee(&self, txid: &Txid) -> Result<PsbtBumpFee>

impl Client

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

impl Client

pub fn rescan_blockchain(&self) -> Result<RescanBlockchain>

impl Client

pub fn send(&self, outputs: &BTreeMap<String, f64>) -> Result<Send>

impl Client

pub fn send_many(&self, amounts: BTreeMap<Address, Amount>) -> Result<SendMany>

impl Client

pub fn send_many_verbose( &self, amounts: BTreeMap<Address, Amount>, ) -> Result<SendManyVerbose>

impl Client

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

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

impl Client

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

impl Client

pub fn set_tx_fee(&self, fee_rate: FeeRate) -> Result<SetTxFee>

impl Client

pub fn set_wallet_flag(&self, flag: &str) -> Result<SetWalletFlag>

impl Client

pub fn sign_message( &self, address: &Address, message: &str, ) -> Result<SignMessage>

impl Client

pub fn sign_raw_transaction_with_wallet( &self, tx: &Transaction, ) -> Result<SignRawTransactionWithWallet>

impl Client

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

impl Client

pub fn upgrade_wallet(&self) -> Result<UpgradeWallet>

impl Client

pub fn wallet_create_funded_psbt( &self, inputs: Vec<WalletCreateFundedPsbtInput>, outputs: Vec<BTreeMap<Address, Amount>>, ) -> Result<WalletCreateFundedPsbt>

impl Client

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

impl Client

pub fn wallet_passphrase(&self, passphrase: &str, timeout: u64) -> Result<()>

impl Client

pub fn wallet_passphrase_change( &self, old_passphrase: &str, new_passphrase: &str, ) -> Result<()>

impl Client

pub fn wallet_process_psbt(&self, psbt: &Psbt) -> Result<WalletProcessPsbt>

impl Client

pub fn get_zmq_notifications(&self) -> Result<Vec<GetZmqNotifications>>

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.