Struct bitcoind_json_rpc_regtest::Client

source · 
pub struct Client { /* private fields */ }
Expand description

Client implements a JSON-RPC client for the Bitcoin Core daemon or compatible APIs.

Implementations§

source§

impl Client

source

pub fn new(url: &str) -> Client

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Creates a client to a bitcoind JSON-RPC server without authentication.

source

pub fn new_with_auth(url: &str, auth: Auth) -> Result<Client, Error>

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Creates a client to a bitcoind JSON-RPC server without authentication.

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Call an RPC method with given args list.

source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Gets the blockhash of the current chain tip.

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Gets a block by blockhash.

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Returns the server version field of GetNetworkInfo.

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Checks that the JSON-RPC endpoint is for a bitcoind instance with the expected version.

source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

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

source

pub fn new_address_with_type(&self, ty: AddressType) -> Result<Address, Error>

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

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

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source

pub fn get_new_address_with_type( &self, ty: AddressType, ) -> Result<GetNewAddress, Error>

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.
source§

impl Client

source

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

Available on non-crate feature 26_0 and non-crate feature 25_2 and non-crate feature 25_1 and non-crate feature 25_0 and non-crate feature 24_2 and non-feadure="24_1" and non-crate feature 24_0_1 and non-crate feature 23_2 and non-crate feature 23_1 and non-crate feature 23_0 and non-crate feature 22_1 and non-crate feature 22_0 and non-crate feature 0_21_2 and non-crate feature 0_20_2 and non-crate feature 0_19_1 and non-crate feature 0_18_1 and non-crate feature 0_17_1 only.

Trait Implementations§

source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.