Struct bitcoin::BitcoinCore

pub struct BitcoinCore { /* private fields */ }

Implementations

impl BitcoinCore

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

Wait indefinitely for the node to sync.

pub async fn wallet_has_public_key( &self, public_key: PublicKey ) -> Result<bool, Error>

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

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

Trait Implementations

impl BitcoinCoreApi for BitcoinCore

fn wait_for_block<'life0, 'async_trait>( &'life0 self, height: u32, num_confirmations: u32 ) -> Pin<Box<dyn Future<Output = Result<Block, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Wait for a specified height to return a BlockHash or exit on error.

Arguments

• height - block height to fetch
• num_confirmations - minimum for a block to be accepted

fn get_block_count<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Get the tip of the main chain as reported by Bitcoin core.

fn get_balance(&self, min_confirmations: Option<u32>) -> Result<Amount, Error>

Get wallet balance.

fn list_transactions( &self, max_count: Option<usize> ) -> Result<Vec<ListTransactionResult>, Error>

List the transaction in the wallet. max_count sets a limit on the amount of transactions returned. If none is provided, DEFAULT_MAX_TX_COUNT is used, which is an arbitrarily picked big number to effectively return all transactions.

fn get_raw_tx<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txid: &'life1 Txid, block_hash: &'life2 BlockHash ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get the raw transaction identified by Txid and stored in the specified block.

Arguments

• txid - transaction ID
• block_hash - hash of the block tx is stored in

fn get_transaction<'life0, 'life1, 'async_trait>( &'life0 self, txid: &'life1 Txid, block_hash: Option<BlockHash> ) -> Pin<Box<dyn Future<Output = Result<Transaction, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the raw transaction identified by Txid and stored in the specified block.

Arguments

• txid - transaction ID
• block_hash - hash of the block tx is stored in

fn get_proof<'life0, 'life1, 'async_trait>( &'life0 self, txid: Txid, block_hash: &'life1 BlockHash ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the merkle proof which can be used to validate transaction inclusion.

Arguments

• txid - transaction ID
• block_hash - hash of the block tx is stored in

fn get_block_hash<'life0, 'async_trait>( &'life0 self, height: u32 ) -> Pin<Box<dyn Future<Output = Result<BlockHash, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Get the block hash for a given height.

Arguments

• height - block height

fn get_new_address<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Address, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Gets a new address from the wallet

fn get_new_public_key<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<PublicKey, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Gets a new public key for an address in the wallet

fn add_new_deposit_key<'life0, 'async_trait>( &'life0 self, public_key: PublicKey, secret_key: Vec<u8> ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Derive and import the private key for the master public key and public secret

fn get_mempool_transactions<'a, 'async_trait>( &'a self ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Iterator<Item = Result<Transaction, Error>> + Send + 'a>, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'a: 'async_trait,

Get the transactions that are currently in the mempool. Since impl trait is not allowed within trait method, we have to use trait objects.

fn wait_for_transaction_metadata<'life0, 'async_trait>( &'life0 self, txid: Txid, num_confirmations: u32, block_hash: Option<BlockHash>, is_wallet: bool ) -> Pin<Box<dyn Future<Output = Result<TransactionMetadata, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Waits for the required number of confirmations, and collects data about the transaction

Arguments

• txid - transaction ID
• num_confirmations - how many confirmations we need to wait for
• block_hash - optional block hash

fn create_and_send_transaction<'life0, 'async_trait>( &'life0 self, address: Address, sat: u64, fee_rate: SatPerVbyte, request_id: Option<H256> ) -> Pin<Box<dyn Future<Output = Result<Txid, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Send an amount of Bitcoin to an address, but only submit the transaction to the mempool; this method does not wait until the block is included in the blockchain.

Arguments

• address - Bitcoin address to fund
• sat - number of Satoshis to transfer
• fee_rate - fee rate in sat/vbyte
• request_id - the issue/redeem/replace id for which this transfer is being made

fn send_to_address<'life0, 'async_trait>( &'life0 self, address: Address, sat: u64, request_id: Option<H256>, fee_rate: SatPerVbyte, num_confirmations: u32 ) -> Pin<Box<dyn Future<Output = Result<TransactionMetadata, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Send an amount of Bitcoin to an address and wait until it is included in the blockchain with the requested number of confirmations.

Arguments

• address - Bitcoin address to fund
• sat - number of Satoshis to transfer
• request_id - the issue/redeem/replace id for which this transfer is being made
• fee_rate - fee rate in sat/vbyte
• num_confirmations - how many confirmations we need to wait for

fn create_or_load_wallet<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Create or load a wallet on Bitcoin Core.

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

Get the number of unspent transaction outputs.

fn network(&self) -> Network

fn dump_derivation_key( &self, public_key: &PublicKey ) -> Result<PrivateKey, Error>

fn import_derivation_key(&self, private_key: &PrivateKey) -> Result<(), Error>

fn get_best_block_hash<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<BlockHash, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn get_pruned_height<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn get_block<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 BlockHash ) -> Pin<Box<dyn Future<Output = Result<Block, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn get_block_header<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 BlockHash ) -> Pin<Box<dyn Future<Output = Result<BlockHeader, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn bump_fee<'life0, 'life1, 'async_trait>( &'life0 self, txid: &'life1 Txid, address: Address, fee_rate: SatPerVbyte ) -> Pin<Box<dyn Future<Output = Result<Txid, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn rescan_blockchain<'life0, 'async_trait>( &'life0 self, start_height: usize, end_height: usize ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn rescan_electrs_for_addresses<'life0, 'async_trait>( &'life0 self, addresses: Vec<Address> ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn is_in_mempool<'life0, 'async_trait>( &'life0 self, txid: Txid ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn fee_rate<'life0, 'async_trait>( &'life0 self, txid: Txid ) -> Pin<Box<dyn Future<Output = Result<SatPerVbyte, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn get_tx_for_op_return<'life0, 'async_trait>( &'life0 self, _address: Address, _amount: u128, _data: H256 ) -> Pin<Box<dyn Future<Output = Result<Option<Txid>, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

fn is_full_node(&self) -> bool

impl Clone for BitcoinCore

fn clone(&self) -> BitcoinCore

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.