RpcApi

Trait RpcApi 

Source
pub trait RpcApi: Sized {
Show 85 methods // Required method fn call<T>(&self, cmd: &str, args: &[Value]) -> Result<T, Error> where T: for<'a> Deserialize<'a>; // Provided methods fn get_by_id<T>(&self, id: &<T as Queryable<Self>>::Id) -> Result<T, Error> where T: Queryable<Self> { ... } fn get_network_info(&self) -> Result<GetNetworkInfoResult, Error> { ... } fn version(&self) -> Result<usize, Error> { ... } fn add_multisig_address( &self, nrequired: usize, keys: &[PubKeyOrAddress<'_>], label: Option<&str>, address_type: Option<AddressType>, ) -> Result<AddMultiSigAddressResult, Error> { ... } fn load_wallet(&self, wallet: &str) -> Result<LoadWalletResult, Error> { ... } fn unload_wallet(&self, wallet: Option<&str>) -> Result<(), Error> { ... } fn create_wallet( &self, wallet: &str, disable_private_keys: Option<bool>, blank: Option<bool>, passphrase: Option<&str>, avoid_reuse: Option<bool>, ) -> Result<LoadWalletResult, Error> { ... } fn list_wallets(&self) -> Result<Vec<String>, Error> { ... } fn get_wallet_info(&self) -> Result<GetWalletInfoResult, Error> { ... } fn backup_wallet(&self, destination: Option<&str>) -> Result<(), Error> { ... } fn dump_private_key(&self, address: &Address) -> Result<PrivateKey, Error> { ... } fn encrypt_wallet(&self, passphrase: &str) -> Result<(), Error> { ... } fn get_difficulty(&self) -> Result<f64, Error> { ... } fn get_connection_count(&self) -> Result<usize, Error> { ... } fn get_block(&self, hash: &BlockHash) -> Result<Block, Error> { ... } fn get_block_hex(&self, hash: &BlockHash) -> Result<String, Error> { ... } fn get_block_info(&self, hash: &BlockHash) -> Result<GetBlockResult, Error> { ... } fn get_block_header(&self, hash: &BlockHash) -> Result<BlockHeader, Error> { ... } fn get_block_header_info( &self, hash: &BlockHash, ) -> Result<GetBlockHeaderResult, Error> { ... } fn get_mining_info(&self) -> Result<GetMiningInfoResult, Error> { ... } fn get_blockchain_info(&self) -> Result<GetBlockchainInfoResult, Error> { ... } fn get_block_count(&self) -> Result<u64, Error> { ... } fn get_best_block_hash(&self) -> Result<BlockHash, Error> { ... } fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error> { ... } fn get_raw_transaction( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<Transaction, Error> { ... } fn get_raw_transaction_hex( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<String, Error> { ... } fn get_raw_transaction_info( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<GetRawTransactionResult, Error> { ... } fn get_block_filter( &self, block_hash: &BlockHash, ) -> Result<GetBlockFilterResult, Error> { ... } fn get_balance( &self, minconf: Option<usize>, include_watchonly: Option<bool>, ) -> Result<Amount, Error> { ... } fn get_balances(&self) -> Result<GetBalancesResult, Error> { ... } fn get_received_by_address( &self, address: &Address, minconf: Option<u32>, ) -> Result<Amount, Error> { ... } fn get_transaction( &self, txid: &Txid, include_watchonly: Option<bool>, ) -> Result<GetTransactionResult, Error> { ... } fn list_transactions( &self, label: Option<&str>, count: Option<usize>, skip: Option<usize>, include_watchonly: Option<bool>, ) -> Result<Vec<ListTransactionResult>, Error> { ... } fn list_since_block( &self, blockhash: Option<&BlockHash>, target_confirmations: Option<usize>, include_watchonly: Option<bool>, include_removed: Option<bool>, ) -> Result<ListSinceBlockResult, Error> { ... } fn get_tx_out( &self, txid: &Txid, vout: u32, include_mempool: Option<bool>, ) -> Result<Option<GetTxOutResult>, Error> { ... } fn get_tx_out_proof( &self, txids: &[Txid], block_hash: Option<&BlockHash>, ) -> Result<Vec<u8>, Error> { ... } fn import_public_key( &self, pubkey: &PublicKey, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error> { ... } fn import_private_key( &self, privkey: &PrivateKey, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error> { ... } fn import_address( &self, address: &Address, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error> { ... } fn import_address_script( &self, script: &Script, label: Option<&str>, rescan: Option<bool>, p2sh: Option<bool>, ) -> Result<(), Error> { ... } fn import_multi( &self, requests: &[ImportMultiRequest<'_>], options: Option<&ImportMultiOptions>, ) -> Result<Vec<ImportMultiResult>, Error> { ... } fn set_label(&self, address: &Address, label: &str) -> Result<(), Error> { ... } fn key_pool_refill(&self, new_size: Option<usize>) -> Result<(), Error> { ... } fn list_unspent( &self, minconf: Option<usize>, maxconf: Option<usize>, addresses: Option<&[&Address]>, include_unsafe: Option<bool>, query_options: Option<ListUnspentQueryOptions>, ) -> Result<Vec<ListUnspentResultEntry>, Error> { ... } fn lock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error> { ... } fn unlock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error> { ... } fn unlock_unspent_all(&self) -> Result<bool, Error> { ... } fn list_received_by_address( &self, address_filter: Option<&Address>, minconf: Option<u32>, include_empty: Option<bool>, include_watchonly: Option<bool>, ) -> Result<Vec<ListReceivedByAddressResult>, Error> { ... } fn create_raw_transaction_hex( &self, utxos: &[CreateRawTransactionInput], outs: &HashMap<String, Amount>, locktime: Option<i64>, replaceable: Option<bool>, ) -> Result<String, Error> { ... } fn create_raw_transaction( &self, utxos: &[CreateRawTransactionInput], outs: &HashMap<String, Amount>, locktime: Option<i64>, replaceable: Option<bool>, ) -> Result<Transaction, Error> { ... } fn fund_raw_transaction<R>( &self, tx: R, options: Option<&FundRawTransactionOptions>, is_witness: Option<bool>, ) -> Result<FundRawTransactionResult, Error> where R: RawTx { ... } fn sign_raw_transaction<R>( &self, tx: R, utxos: Option<&[SignRawTransactionInput]>, private_keys: Option<&[PrivateKey]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error> where R: RawTx { ... } fn sign_raw_transaction_with_wallet<R>( &self, tx: R, utxos: Option<&[SignRawTransactionInput]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error> where R: RawTx { ... } fn sign_raw_transaction_with_key<R>( &self, tx: R, privkeys: &[PrivateKey], prevtxs: Option<&[SignRawTransactionInput]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error> where R: RawTx { ... } fn test_mempool_accept<R>( &self, rawtxs: &[R], ) -> Result<Vec<TestMempoolAcceptResult>, Error> where R: RawTx { ... } fn stop(&self) -> Result<String, Error> { ... } fn verify_message( &self, address: &Address, signature: &Signature, message: &str, ) -> Result<bool, Error> { ... } fn get_new_address( &self, label: Option<&str>, address_type: Option<AddressType>, ) -> Result<Address, Error> { ... } fn get_address_info( &self, address: &Address, ) -> Result<GetAddressInfoResult, Error> { ... } fn generate_to_address( &self, block_num: u64, address: &Address, ) -> Result<Vec<BlockHash>, Error> { ... } fn generate( &self, block_num: u64, maxtries: Option<u64>, ) -> Result<Vec<BlockHash>, Error> { ... } fn invalidate_block(&self, block_hash: &BlockHash) -> Result<(), Error> { ... } fn reconsider_block(&self, block_hash: &BlockHash) -> Result<(), Error> { ... } fn get_raw_mempool(&self) -> Result<Vec<Txid>, Error> { ... } fn get_mempool_entry( &self, txid: &Txid, ) -> Result<GetMempoolEntryResult, Error> { ... } fn send_to_address( &self, address: &Address, amount: Amount, comment: Option<&str>, comment_to: Option<&str>, subtract_fee: Option<bool>, replaceable: Option<bool>, confirmation_target: Option<u32>, estimate_mode: Option<EstimateMode>, ) -> Result<Txid, Error> { ... } fn get_peer_info(&self) -> Result<Vec<GetPeerInfoResult>, Error> { ... } fn ping(&self) -> Result<(), Error> { ... } fn send_raw_transaction<R>(&self, tx: R) -> Result<Txid, Error> where R: RawTx { ... } fn estimate_smart_fee( &self, conf_target: u16, estimate_mode: Option<EstimateMode>, ) -> Result<EstimateSmartFeeResult, Error> { ... } fn wait_for_new_block(&self, timeout: u64) -> Result<BlockRef, Error> { ... } fn wait_for_block( &self, blockhash: &BlockHash, timeout: u64, ) -> Result<BlockRef, Error> { ... } fn wallet_create_funded_psbt( &self, inputs: &[CreateRawTransactionInput], outputs: &HashMap<String, Amount>, locktime: Option<i64>, options: Option<WalletCreateFundedPsbtOptions>, bip32derivs: Option<bool>, ) -> Result<WalletCreateFundedPsbtResult, Error> { ... } fn wallet_process_psbt( &self, psbt: &str, sign: Option<bool>, sighash_type: Option<SigHashType>, bip32derivs: Option<bool>, ) -> Result<WalletProcessPsbtResult, Error> { ... } fn get_descriptor_info( &self, desc: &str, ) -> Result<GetDescriptorInfoResult, Error> { ... } fn combine_psbt(&self, psbts: &[String]) -> Result<String, Error> { ... } fn finalize_psbt( &self, psbt: &str, extract: Option<bool>, ) -> Result<FinalizePsbtResult, Error> { ... } fn derive_addresses( &self, descriptor: &str, range: Option<[u32; 2]>, ) -> Result<Vec<Address>, Error> { ... } fn rescan_blockchain( &self, start_from: Option<usize>, stop_height: Option<usize>, ) -> Result<(usize, Option<usize>), Error> { ... } fn get_tx_out_set_info(&self) -> Result<GetTxOutSetInfoResult, Error> { ... } fn get_net_totals(&self) -> Result<GetNetTotalsResult, Error> { ... } fn get_network_hash_ps( &self, nblocks: Option<u64>, height: Option<u64>, ) -> Result<f64, Error> { ... } fn uptime(&self) -> Result<u64, Error> { ... } fn scan_tx_out_set_blocking( &self, descriptors: &[ScanTxOutRequest], ) -> Result<ScanTxOutResult, Error> { ... }
}

Required Methods§

Source

fn call<T>(&self, cmd: &str, args: &[Value]) -> Result<T, Error>
where T: for<'a> Deserialize<'a>,

Call a cmd rpc with given args list

Provided Methods§

Source

fn get_by_id<T>(&self, id: &<T as Queryable<Self>>::Id) -> Result<T, Error>
where T: Queryable<Self>,

Query an object implementing Querable type

Source

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

Source

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

Source

fn add_multisig_address( &self, nrequired: usize, keys: &[PubKeyOrAddress<'_>], label: Option<&str>, address_type: Option<AddressType>, ) -> Result<AddMultiSigAddressResult, Error>

Source

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

Source

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

Source

fn create_wallet( &self, wallet: &str, disable_private_keys: Option<bool>, blank: Option<bool>, passphrase: Option<&str>, avoid_reuse: Option<bool>, ) -> Result<LoadWalletResult, Error>

Source

fn list_wallets(&self) -> Result<Vec<String>, Error>

Source

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

Source

fn backup_wallet(&self, destination: Option<&str>) -> Result<(), Error>

Source

fn dump_private_key(&self, address: &Address) -> Result<PrivateKey, Error>

Source

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

Source

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

Source

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

Source

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

Source

fn get_block_hex(&self, hash: &BlockHash) -> Result<String, Error>

Source

fn get_block_info(&self, hash: &BlockHash) -> Result<GetBlockResult, Error>

Source

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

Source

fn get_block_header_info( &self, hash: &BlockHash, ) -> Result<GetBlockHeaderResult, Error>

Source

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

Source

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

Returns a data structure containing various state info regarding blockchain processing.

Source

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

Returns the numbers of block in the longest chain.

Source

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

Returns the hash of the best (tip) block in the longest blockchain.

Source

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

Get block hash at a given height

Source

fn get_raw_transaction( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<Transaction, Error>

Source

fn get_raw_transaction_hex( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<String, Error>

Source

fn get_raw_transaction_info( &self, txid: &Txid, block_hash: Option<&BlockHash>, ) -> Result<GetRawTransactionResult, Error>

Source

fn get_block_filter( &self, block_hash: &BlockHash, ) -> Result<GetBlockFilterResult, Error>

Source

fn get_balance( &self, minconf: Option<usize>, include_watchonly: Option<bool>, ) -> Result<Amount, Error>

Source

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

Source

fn get_received_by_address( &self, address: &Address, minconf: Option<u32>, ) -> Result<Amount, Error>

Source

fn get_transaction( &self, txid: &Txid, include_watchonly: Option<bool>, ) -> Result<GetTransactionResult, Error>

Source

fn list_transactions( &self, label: Option<&str>, count: Option<usize>, skip: Option<usize>, include_watchonly: Option<bool>, ) -> Result<Vec<ListTransactionResult>, Error>

Source

fn list_since_block( &self, blockhash: Option<&BlockHash>, target_confirmations: Option<usize>, include_watchonly: Option<bool>, include_removed: Option<bool>, ) -> Result<ListSinceBlockResult, Error>

Source

fn get_tx_out( &self, txid: &Txid, vout: u32, include_mempool: Option<bool>, ) -> Result<Option<GetTxOutResult>, Error>

Source

fn get_tx_out_proof( &self, txids: &[Txid], block_hash: Option<&BlockHash>, ) -> Result<Vec<u8>, Error>

Source

fn import_public_key( &self, pubkey: &PublicKey, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error>

Source

fn import_private_key( &self, privkey: &PrivateKey, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error>

Source

fn import_address( &self, address: &Address, label: Option<&str>, rescan: Option<bool>, ) -> Result<(), Error>

Source

fn import_address_script( &self, script: &Script, label: Option<&str>, rescan: Option<bool>, p2sh: Option<bool>, ) -> Result<(), Error>

Source

fn import_multi( &self, requests: &[ImportMultiRequest<'_>], options: Option<&ImportMultiOptions>, ) -> Result<Vec<ImportMultiResult>, Error>

Source

fn set_label(&self, address: &Address, label: &str) -> Result<(), Error>

Source

fn key_pool_refill(&self, new_size: Option<usize>) -> Result<(), Error>

Source

fn list_unspent( &self, minconf: Option<usize>, maxconf: Option<usize>, addresses: Option<&[&Address]>, include_unsafe: Option<bool>, query_options: Option<ListUnspentQueryOptions>, ) -> Result<Vec<ListUnspentResultEntry>, Error>

Source

fn lock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>

To unlock, use [unlock_unspent].

Source

fn unlock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>

Source

fn unlock_unspent_all(&self) -> Result<bool, Error>

Unlock all unspent UTXOs.

Source

fn list_received_by_address( &self, address_filter: Option<&Address>, minconf: Option<u32>, include_empty: Option<bool>, include_watchonly: Option<bool>, ) -> Result<Vec<ListReceivedByAddressResult>, Error>

Source

fn create_raw_transaction_hex( &self, utxos: &[CreateRawTransactionInput], outs: &HashMap<String, Amount>, locktime: Option<i64>, replaceable: Option<bool>, ) -> Result<String, Error>

Source

fn create_raw_transaction( &self, utxos: &[CreateRawTransactionInput], outs: &HashMap<String, Amount>, locktime: Option<i64>, replaceable: Option<bool>, ) -> Result<Transaction, Error>

Source

fn fund_raw_transaction<R>( &self, tx: R, options: Option<&FundRawTransactionOptions>, is_witness: Option<bool>, ) -> Result<FundRawTransactionResult, Error>
where R: RawTx,

Source

fn sign_raw_transaction<R>( &self, tx: R, utxos: Option<&[SignRawTransactionInput]>, private_keys: Option<&[PrivateKey]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error>
where R: RawTx,

👎Deprecated
Source

fn sign_raw_transaction_with_wallet<R>( &self, tx: R, utxos: Option<&[SignRawTransactionInput]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error>
where R: RawTx,

Source

fn sign_raw_transaction_with_key<R>( &self, tx: R, privkeys: &[PrivateKey], prevtxs: Option<&[SignRawTransactionInput]>, sighash_type: Option<SigHashType>, ) -> Result<SignRawTransactionResult, Error>
where R: RawTx,

Source

fn test_mempool_accept<R>( &self, rawtxs: &[R], ) -> Result<Vec<TestMempoolAcceptResult>, Error>
where R: RawTx,

Source

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

Source

fn verify_message( &self, address: &Address, signature: &Signature, message: &str, ) -> Result<bool, Error>

Source

fn get_new_address( &self, label: Option<&str>, address_type: Option<AddressType>, ) -> Result<Address, Error>

Generate new address under own control

Source

fn get_address_info( &self, address: &Address, ) -> Result<GetAddressInfoResult, Error>

Source

fn generate_to_address( &self, block_num: u64, address: &Address, ) -> Result<Vec<BlockHash>, Error>

Mine block_num blocks and pay coinbase to address

Returns hashes of the generated blocks

Source

fn generate( &self, block_num: u64, maxtries: Option<u64>, ) -> Result<Vec<BlockHash>, Error>

Mine up to block_num blocks immediately (before the RPC call returns) to an address in the wallet.

Source

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

Mark a block as invalid by block_hash

Source

fn reconsider_block(&self, block_hash: &BlockHash) -> Result<(), Error>

Mark a block as valid by block_hash

Source

fn get_raw_mempool(&self) -> Result<Vec<Txid>, Error>

Get txids of all transactions in a memory pool

Source

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

Get mempool data for given transaction

Source

fn send_to_address( &self, address: &Address, amount: Amount, comment: Option<&str>, comment_to: Option<&str>, subtract_fee: Option<bool>, replaceable: Option<bool>, confirmation_target: Option<u32>, estimate_mode: Option<EstimateMode>, ) -> Result<Txid, Error>

Source

fn get_peer_info(&self) -> Result<Vec<GetPeerInfoResult>, Error>

Returns data about each connected network node as an array of PeerInfo

Source

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

Requests that a ping be sent to all other nodes, to measure ping time.

Results provided in getpeerinfo, pingtime and pingwait fields are decimal seconds.

Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.

Source

fn send_raw_transaction<R>(&self, tx: R) -> Result<Txid, Error>
where R: RawTx,

Source

fn estimate_smart_fee( &self, conf_target: u16, estimate_mode: Option<EstimateMode>, ) -> Result<EstimateSmartFeeResult, Error>

Source

fn wait_for_new_block(&self, timeout: u64) -> Result<BlockRef, Error>

Waits for a specific new block and returns useful info about it. Returns the current block on timeout or exit.

§Arguments
  1. timeout: Time in milliseconds to wait for a response. 0 indicates no timeout.
Source

fn wait_for_block( &self, blockhash: &BlockHash, timeout: u64, ) -> Result<BlockRef, Error>

Waits for a specific new block and returns useful info about it. Returns the current block on timeout or exit.

§Arguments
  1. blockhash: Block hash to wait for.
  2. timeout: Time in milliseconds to wait for a response. 0 indicates no timeout.
Source

fn wallet_create_funded_psbt( &self, inputs: &[CreateRawTransactionInput], outputs: &HashMap<String, Amount>, locktime: Option<i64>, options: Option<WalletCreateFundedPsbtOptions>, bip32derivs: Option<bool>, ) -> Result<WalletCreateFundedPsbtResult, Error>

Source

fn wallet_process_psbt( &self, psbt: &str, sign: Option<bool>, sighash_type: Option<SigHashType>, bip32derivs: Option<bool>, ) -> Result<WalletProcessPsbtResult, Error>

Source

fn get_descriptor_info( &self, desc: &str, ) -> Result<GetDescriptorInfoResult, Error>

Source

fn combine_psbt(&self, psbts: &[String]) -> Result<String, Error>

Source

fn finalize_psbt( &self, psbt: &str, extract: Option<bool>, ) -> Result<FinalizePsbtResult, Error>

Source

fn derive_addresses( &self, descriptor: &str, range: Option<[u32; 2]>, ) -> Result<Vec<Address>, Error>

Source

fn rescan_blockchain( &self, start_from: Option<usize>, stop_height: Option<usize>, ) -> Result<(usize, Option<usize>), Error>

Source

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

Returns statistics about the unspent transaction output set. This call may take some time.

Source

fn get_net_totals(&self) -> Result<GetNetTotalsResult, Error>

Returns information about network traffic, including bytes in, bytes out, and current time.

Source

fn get_network_hash_ps( &self, nblocks: Option<u64>, height: Option<u64>, ) -> Result<f64, Error>

Returns the estimated network hashes per second based on the last n blocks.

Source

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

Returns the total uptime of the server in seconds

Source

fn scan_tx_out_set_blocking( &self, descriptors: &[ScanTxOutRequest], ) -> Result<ScanTxOutResult, Error>

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§