Trait testutils::RpcApi [−][src]
Required methods
pub fn call<T>(&self, cmd: &str, args: &[Value]) -> Result<T, Error> where
T: for<'a> Deserialize<'a>,
[src]
T: for<'a> Deserialize<'a>,
Call a cmd
rpc with given args
list
Provided methods
pub fn get_by_id<T>(&self, id: &<T as Queryable<Self>>::Id) -> Result<T, Error> where
T: Queryable<Self>,
[src]
T: Queryable<Self>,
Query an object implementing Querable
type
pub fn get_network_info(&self) -> Result<GetNetworkInfoResult, Error>
[src]
pub fn version(&self) -> Result<usize, Error>
[src]
pub fn add_multisig_address(
&self,
nrequired: usize,
keys: &[PubKeyOrAddress<'_>],
label: Option<&str>,
address_type: Option<AddressType>
) -> Result<AddMultiSigAddressResult, Error>
[src]
&self,
nrequired: usize,
keys: &[PubKeyOrAddress<'_>],
label: Option<&str>,
address_type: Option<AddressType>
) -> Result<AddMultiSigAddressResult, Error>
pub fn load_wallet(&self, wallet: &str) -> Result<LoadWalletResult, Error>
[src]
pub fn unload_wallet(&self, wallet: Option<&str>) -> Result<(), Error>
[src]
pub fn create_wallet(
&self,
wallet: &str,
disable_private_keys: Option<bool>,
blank: Option<bool>,
passphrase: Option<&str>,
avoid_reuse: Option<bool>
) -> Result<LoadWalletResult, Error>
[src]
&self,
wallet: &str,
disable_private_keys: Option<bool>,
blank: Option<bool>,
passphrase: Option<&str>,
avoid_reuse: Option<bool>
) -> Result<LoadWalletResult, Error>
pub fn list_wallets(&self) -> Result<Vec<String, Global>, Error>
[src]
pub fn get_wallet_info(&self) -> Result<GetWalletInfoResult, Error>
[src]
pub fn backup_wallet(&self, destination: Option<&str>) -> Result<(), Error>
[src]
pub fn dump_private_key(&self, address: &Address) -> Result<PrivateKey, Error>
[src]
pub fn encrypt_wallet(&self, passphrase: &str) -> Result<(), Error>
[src]
pub fn get_difficulty(&self) -> Result<f64, Error>
[src]
pub fn get_connection_count(&self) -> Result<usize, Error>
[src]
pub fn get_block(&self, hash: &BlockHash) -> Result<Block, Error>
[src]
pub fn get_block_hex(&self, hash: &BlockHash) -> Result<String, Error>
[src]
pub fn get_block_info(&self, hash: &BlockHash) -> Result<GetBlockResult, Error>
[src]
pub fn get_block_header(&self, hash: &BlockHash) -> Result<BlockHeader, Error>
[src]
pub fn get_block_header_info(
&self,
hash: &BlockHash
) -> Result<GetBlockHeaderResult, Error>
[src]
&self,
hash: &BlockHash
) -> Result<GetBlockHeaderResult, Error>
pub fn get_mining_info(&self) -> Result<GetMiningInfoResult, Error>
[src]
pub fn get_blockchain_info(&self) -> Result<GetBlockchainInfoResult, Error>
[src]
Returns a data structure containing various state info regarding blockchain processing.
pub fn get_block_count(&self) -> Result<u64, Error>
[src]
Returns the numbers of block in the longest chain.
pub fn get_best_block_hash(&self) -> Result<BlockHash, Error>
[src]
Returns the hash of the best (tip) block in the longest blockchain.
pub fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error>
[src]
Get block hash at a given height
pub fn get_raw_transaction(
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<Transaction, Error>
[src]
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<Transaction, Error>
pub fn get_raw_transaction_hex(
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<String, Error>
[src]
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<String, Error>
pub fn get_raw_transaction_info(
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<GetRawTransactionResult, Error>
[src]
&self,
txid: &Txid,
block_hash: Option<&BlockHash>
) -> Result<GetRawTransactionResult, Error>
pub fn get_block_filter(
&self,
block_hash: &BlockHash
) -> Result<GetBlockFilterResult, Error>
[src]
&self,
block_hash: &BlockHash
) -> Result<GetBlockFilterResult, Error>
pub fn get_balance(
&self,
minconf: Option<usize>,
include_watchonly: Option<bool>
) -> Result<Amount, Error>
[src]
&self,
minconf: Option<usize>,
include_watchonly: Option<bool>
) -> Result<Amount, Error>
pub fn get_balances(&self) -> Result<GetBalancesResult, Error>
[src]
pub fn get_received_by_address(
&self,
address: &Address,
minconf: Option<u32>
) -> Result<Amount, Error>
[src]
&self,
address: &Address,
minconf: Option<u32>
) -> Result<Amount, Error>
pub fn get_transaction(
&self,
txid: &Txid,
include_watchonly: Option<bool>
) -> Result<GetTransactionResult, Error>
[src]
&self,
txid: &Txid,
include_watchonly: Option<bool>
) -> Result<GetTransactionResult, Error>
pub fn list_transactions(
&self,
label: Option<&str>,
count: Option<usize>,
skip: Option<usize>,
include_watchonly: Option<bool>
) -> Result<Vec<ListTransactionResult, Global>, Error>
[src]
&self,
label: Option<&str>,
count: Option<usize>,
skip: Option<usize>,
include_watchonly: Option<bool>
) -> Result<Vec<ListTransactionResult, Global>, Error>
pub fn list_since_block(
&self,
blockhash: Option<&BlockHash>,
target_confirmations: Option<usize>,
include_watchonly: Option<bool>,
include_removed: Option<bool>
) -> Result<ListSinceBlockResult, Error>
[src]
&self,
blockhash: Option<&BlockHash>,
target_confirmations: Option<usize>,
include_watchonly: Option<bool>,
include_removed: Option<bool>
) -> Result<ListSinceBlockResult, Error>
pub fn get_tx_out(
&self,
txid: &Txid,
vout: u32,
include_mempool: Option<bool>
) -> Result<Option<GetTxOutResult>, Error>
[src]
&self,
txid: &Txid,
vout: u32,
include_mempool: Option<bool>
) -> Result<Option<GetTxOutResult>, Error>
pub fn get_tx_out_proof(
&self,
txids: &[Txid],
block_hash: Option<&BlockHash>
) -> Result<Vec<u8, Global>, Error>
[src]
&self,
txids: &[Txid],
block_hash: Option<&BlockHash>
) -> Result<Vec<u8, Global>, Error>
pub fn import_public_key(
&self,
pubkey: &PublicKey,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
[src]
&self,
pubkey: &PublicKey,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
pub fn import_private_key(
&self,
privkey: &PrivateKey,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
[src]
&self,
privkey: &PrivateKey,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
pub fn import_address(
&self,
address: &Address,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
[src]
&self,
address: &Address,
label: Option<&str>,
rescan: Option<bool>
) -> Result<(), Error>
pub fn import_address_script(
&self,
script: &Script,
label: Option<&str>,
rescan: Option<bool>,
p2sh: Option<bool>
) -> Result<(), Error>
[src]
&self,
script: &Script,
label: Option<&str>,
rescan: Option<bool>,
p2sh: Option<bool>
) -> Result<(), Error>
pub fn import_multi(
&self,
requests: &[ImportMultiRequest<'_>],
options: Option<&ImportMultiOptions>
) -> Result<Vec<ImportMultiResult, Global>, Error>
[src]
&self,
requests: &[ImportMultiRequest<'_>],
options: Option<&ImportMultiOptions>
) -> Result<Vec<ImportMultiResult, Global>, Error>
pub fn set_label(&self, address: &Address, label: &str) -> Result<(), Error>
[src]
pub fn key_pool_refill(&self, new_size: Option<usize>) -> Result<(), Error>
[src]
pub fn list_unspent(
&self,
minconf: Option<usize>,
maxconf: Option<usize>,
addresses: Option<&[&Address]>,
include_unsafe: Option<bool>,
query_options: Option<ListUnspentQueryOptions>
) -> Result<Vec<ListUnspentResultEntry, Global>, Error>
[src]
&self,
minconf: Option<usize>,
maxconf: Option<usize>,
addresses: Option<&[&Address]>,
include_unsafe: Option<bool>,
query_options: Option<ListUnspentQueryOptions>
) -> Result<Vec<ListUnspentResultEntry, Global>, Error>
pub fn lock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>
[src]
To unlock, use [unlock_unspent].
pub fn unlock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>
[src]
pub fn unlock_unspent_all(&self) -> Result<bool, Error>
[src]
Unlock all unspent UTXOs.
pub fn list_received_by_address(
&self,
address_filter: Option<&Address>,
minconf: Option<u32>,
include_empty: Option<bool>,
include_watchonly: Option<bool>
) -> Result<Vec<ListReceivedByAddressResult, Global>, Error>
[src]
&self,
address_filter: Option<&Address>,
minconf: Option<u32>,
include_empty: Option<bool>,
include_watchonly: Option<bool>
) -> Result<Vec<ListReceivedByAddressResult, Global>, Error>
pub fn create_raw_transaction_hex(
&self,
utxos: &[CreateRawTransactionInput],
outs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
replaceable: Option<bool>
) -> Result<String, Error>
[src]
&self,
utxos: &[CreateRawTransactionInput],
outs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
replaceable: Option<bool>
) -> Result<String, Error>
pub fn create_raw_transaction(
&self,
utxos: &[CreateRawTransactionInput],
outs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
replaceable: Option<bool>
) -> Result<Transaction, Error>
[src]
&self,
utxos: &[CreateRawTransactionInput],
outs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
replaceable: Option<bool>
) -> Result<Transaction, Error>
pub fn fund_raw_transaction<R>(
&self,
tx: R,
options: Option<&FundRawTransactionOptions>,
is_witness: Option<bool>
) -> Result<FundRawTransactionResult, Error> where
R: RawTx,
[src]
&self,
tx: R,
options: Option<&FundRawTransactionOptions>,
is_witness: Option<bool>
) -> Result<FundRawTransactionResult, Error> where
R: RawTx,
pub 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,
[src]
&self,
tx: R,
utxos: Option<&[SignRawTransactionInput]>,
private_keys: Option<&[PrivateKey]>,
sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
R: RawTx,
pub fn sign_raw_transaction_with_wallet<R>(
&self,
tx: R,
utxos: Option<&[SignRawTransactionInput]>,
sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
R: RawTx,
[src]
&self,
tx: R,
utxos: Option<&[SignRawTransactionInput]>,
sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
R: RawTx,
pub 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,
[src]
&self,
tx: R,
privkeys: &[PrivateKey],
prevtxs: Option<&[SignRawTransactionInput]>,
sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
R: RawTx,
pub fn test_mempool_accept<R>(
&self,
rawtxs: &[R]
) -> Result<Vec<TestMempoolAcceptResult, Global>, Error> where
R: RawTx,
[src]
&self,
rawtxs: &[R]
) -> Result<Vec<TestMempoolAcceptResult, Global>, Error> where
R: RawTx,
pub fn stop(&self) -> Result<String, Error>
[src]
pub fn verify_message(
&self,
address: &Address,
signature: &Signature,
message: &str
) -> Result<bool, Error>
[src]
&self,
address: &Address,
signature: &Signature,
message: &str
) -> Result<bool, Error>
pub fn get_new_address(
&self,
label: Option<&str>,
address_type: Option<AddressType>
) -> Result<Address, Error>
[src]
&self,
label: Option<&str>,
address_type: Option<AddressType>
) -> Result<Address, Error>
Generate new address under own control
pub fn get_address_info(
&self,
address: &Address
) -> Result<GetAddressInfoResult, Error>
[src]
&self,
address: &Address
) -> Result<GetAddressInfoResult, Error>
pub fn generate_to_address(
&self,
block_num: u64,
address: &Address
) -> Result<Vec<BlockHash, Global>, Error>
[src]
&self,
block_num: u64,
address: &Address
) -> Result<Vec<BlockHash, Global>, Error>
Mine block_num
blocks and pay coinbase to address
Returns hashes of the generated blocks
pub fn generate(
&self,
block_num: u64,
maxtries: Option<u64>
) -> Result<Vec<BlockHash, Global>, Error>
[src]
&self,
block_num: u64,
maxtries: Option<u64>
) -> Result<Vec<BlockHash, Global>, Error>
Mine up to block_num blocks immediately (before the RPC call returns) to an address in the wallet.
pub fn invalidate_block(&self, block_hash: &BlockHash) -> Result<(), Error>
[src]
Mark a block as invalid by block_hash
pub fn reconsider_block(&self, block_hash: &BlockHash) -> Result<(), Error>
[src]
Mark a block as valid by block_hash
pub fn get_raw_mempool(&self) -> Result<Vec<Txid, Global>, Error>
[src]
Get txids of all transactions in a memory pool
pub fn get_mempool_entry(
&self,
txid: &Txid
) -> Result<GetMempoolEntryResult, Error>
[src]
&self,
txid: &Txid
) -> Result<GetMempoolEntryResult, Error>
Get mempool data for given transaction
pub 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>
[src]
&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>
pub fn get_peer_info(&self) -> Result<Vec<GetPeerInfoResult, Global>, Error>
[src]
Returns data about each connected network node as an array of
PeerInfo
pub fn ping(&self) -> Result<(), Error>
[src]
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.
pub fn send_raw_transaction<R>(&self, tx: R) -> Result<Txid, Error> where
R: RawTx,
[src]
R: RawTx,
pub fn estimate_smart_fee(
&self,
conf_target: u16,
estimate_mode: Option<EstimateMode>
) -> Result<EstimateSmartFeeResult, Error>
[src]
&self,
conf_target: u16,
estimate_mode: Option<EstimateMode>
) -> Result<EstimateSmartFeeResult, Error>
pub fn wait_for_new_block(&self, timeout: u64) -> Result<BlockRef, Error>
[src]
Waits for a specific new block and returns useful info about it. Returns the current block on timeout or exit.
Arguments
timeout
: Time in milliseconds to wait for a response. 0 indicates no timeout.
pub fn wait_for_block(
&self,
blockhash: &BlockHash,
timeout: u64
) -> Result<BlockRef, Error>
[src]
&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
blockhash
: Block hash to wait for.timeout
: Time in milliseconds to wait for a response. 0 indicates no timeout.
pub fn wallet_create_funded_psbt(
&self,
inputs: &[CreateRawTransactionInput],
outputs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
options: Option<WalletCreateFundedPsbtOptions>,
bip32derivs: Option<bool>
) -> Result<WalletCreateFundedPsbtResult, Error>
[src]
&self,
inputs: &[CreateRawTransactionInput],
outputs: &HashMap<String, Amount, RandomState>,
locktime: Option<i64>,
options: Option<WalletCreateFundedPsbtOptions>,
bip32derivs: Option<bool>
) -> Result<WalletCreateFundedPsbtResult, Error>
pub fn wallet_process_psbt(
&self,
psbt: &str,
sign: Option<bool>,
sighash_type: Option<SigHashType>,
bip32derivs: Option<bool>
) -> Result<WalletProcessPsbtResult, Error>
[src]
&self,
psbt: &str,
sign: Option<bool>,
sighash_type: Option<SigHashType>,
bip32derivs: Option<bool>
) -> Result<WalletProcessPsbtResult, Error>
pub fn get_descriptor_info(
&self,
desc: &str
) -> Result<GetDescriptorInfoResult, Error>
[src]
&self,
desc: &str
) -> Result<GetDescriptorInfoResult, Error>
pub fn combine_psbt(&self, psbts: &[String]) -> Result<String, Error>
[src]
pub fn finalize_psbt(
&self,
psbt: &str,
extract: Option<bool>
) -> Result<FinalizePsbtResult, Error>
[src]
&self,
psbt: &str,
extract: Option<bool>
) -> Result<FinalizePsbtResult, Error>
pub fn derive_addresses(
&self,
descriptor: &str,
range: Option<[u32; 2]>
) -> Result<Vec<Address, Global>, Error>
[src]
&self,
descriptor: &str,
range: Option<[u32; 2]>
) -> Result<Vec<Address, Global>, Error>
pub fn rescan_blockchain(
&self,
start_from: Option<usize>,
stop_height: Option<usize>
) -> Result<(usize, Option<usize>), Error>
[src]
&self,
start_from: Option<usize>,
stop_height: Option<usize>
) -> Result<(usize, Option<usize>), Error>
pub fn get_tx_out_set_info(&self) -> Result<GetTxOutSetInfoResult, Error>
[src]
Returns statistics about the unspent transaction output set. This call may take some time.
pub fn get_net_totals(&self) -> Result<GetNetTotalsResult, Error>
[src]
Returns information about network traffic, including bytes in, bytes out, and current time.
pub fn get_network_hash_ps(
&self,
nblocks: Option<u64>,
height: Option<u64>
) -> Result<f64, Error>
[src]
&self,
nblocks: Option<u64>,
height: Option<u64>
) -> Result<f64, Error>
Returns the estimated network hashes per second based on the last n blocks.
pub fn uptime(&self) -> Result<u64, Error>
[src]
Returns the total uptime of the server in seconds
pub fn scan_tx_out_set_blocking(
&self,
descriptors: &[ScanTxOutRequest]
) -> Result<ScanTxOutResult, Error>
[src]
&self,
descriptors: &[ScanTxOutRequest]
) -> Result<ScanTxOutResult, Error>