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) -> 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 with 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 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 dump_tx_out_set(&self, path: &str) -> Result<DumpTxOutSet, 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_verbose_zero( &self, hash: BlockHash, ) -> Result<GetBlockVerboseZero, Error>

Gets a block by blockhash with verbose set to 0.

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

Gets a block by blockhash with verbose set to 1.

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_block_from_peer( &self, blockhash: BlockHash, peer_id: u32, ) -> Result<(), Error>

impl Client

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

impl Client

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

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_deployment_info( &self, blockhash: &BlockHash, ) -> Result<GetDeploymentInfo, Error>

impl Client

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

impl Client

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

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_tx_spending_prevout( &self, outputs: &[OutPoint], ) -> Result<GetTxSpendingPrevout, Error>

impl Client

pub fn import_mempool(&self, filepath: &str) -> Result<(), Error>

impl Client

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

impl Client

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

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

impl Client

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

impl Client

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

Aborts an ongoing scanblocks scan.

pub fn scan_blocks_start( &self, scan_objects: &[&str], ) -> Result<ScanBlocksStart, Error>

Starts a scan of blocks for specified descriptors.

pub fn scan_blocks_status(&self) -> Result<Option<ScanBlocksStatus>, Error>

Checks the status of an ongoing scanblocks scan.

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn generate_block( &self, output: &str, transactions: &[String], submit: bool, ) -> Result<GenerateBlock, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_net_totals(&self) -> Result<GetNetTotals, 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 get_node_addresses(&self) -> Result<GetNodeAddresses, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn submit_package( &self, package: &[Transaction], max_fee_rate: Option<FeeRate>, max_burn_amount: Option<Amount>, ) -> Result<SubmitPackage, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

Calls createwallet with wallet as the only argument.

In v23 and later this creates a descriptor wallet. Use create_legacy_wallet to create a legacy wallet.

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

Creates a legacy wallet (i.e not a native descriptor wallet).

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

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.
8. external_signer (boolean, optional, default=false) Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true.

impl Client

pub fn create_wallet_descriptor( &self, address_type: &str, hdkey: &str, ) -> Result<CreateWalletDescriptor, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn get_address_info( &self, address: &Address, ) -> Result<GetAddressInfo, 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 get_hd_keys(&self) -> Result<GetHdKeys, Error>

impl Client

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

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, Error>

Gets a new address - low level RPC call.

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

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, Error>

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

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

impl Client

pub fn migrate_wallet(&self, wallet_name: &str) -> Result<MigrateWallet, Error>

impl Client

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

Calls newkeypool for the loaded wallet.

newkeypool

Entirely clears and refills the keypool. Requires wallet passphrase to be set if wallet is encrypted.

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn restore_wallet( &self, wallet_name: &str, backup_file: &Path, ) -> Result<RestoreWallet, Error>

Calls restorewallet with required and optional arguments.

restorewallet “wallet_name” “backup_file” ( load_on_startup )

impl Client

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

impl Client

pub fn send_all(&self, recipients: &[Address]) -> Result<SendAll, Error>

impl Client

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

impl Client

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

impl Client

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

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn simulate_raw_transaction( &self, rawtxs: &[String], ) -> Result<SimulateRawTransaction, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

pub fn wallet_display_address( &self, address: &str, ) -> Result<WalletDisplayAddress, Error>

impl Client

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

impl Client

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

impl Client

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

impl Client

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

impl Client

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

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.