Struct BitcoinCanister 

pub struct BitcoinCanister<'agent> { /* private fields */ }

The canister interface for the IC Bitcoin canister.

Implementations

impl<'agent> BitcoinCanister<'agent>

pub fn from_canister( canister: Canister<'agent>, network: BitcoinNetwork, ) -> Self

Create a BitcoinCanister interface from an existing canister object.

pub fn create( agent: &'agent Agent, canister_id: Principal, network: BitcoinNetwork, ) -> Self

Create a BitcoinCanister interface pointing to the specified canister ID.

pub fn mainnet(agent: &'agent Agent) -> Self

Create a BitcoinCanister interface for the Bitcoin mainnet canister on the IC mainnet.

pub fn testnet(agent: &'agent Agent) -> Self

Create a BitcoinCanister interface for the Bitcoin testnet canister on the IC mainnet.

pub fn for_network( agent: &'agent Agent, network: BitcoinNetwork, ) -> Result<Self, AgentError>

Create a BitcoinCanister interface for the specified Bitcoin network on the IC mainnet. Errors if Regtest is specified.

pub fn get_balance( &self, address: &str, min_confirmations: Option<u32>, ) -> impl 'agent + AsyncCall<Value = (u64,)>

Gets the BTC balance (in satoshis) of a particular Bitcoin address, filtering by number of confirmations. Most applications should require 6 confirmations.

pub fn get_balance_query( &self, address: &str, min_confirmations: Option<u32>, ) -> impl 'agent + SyncCall<Value = (u64,)>

Gets the BTC balance (in satoshis) of a particular Bitcoin address, filtering by number of confirmations. Most applications should require 6 confirmations.

pub fn get_utxos( &self, address: &str, filter: Option<UtxosFilter>, ) -> impl 'agent + AsyncCall<Value = (GetUtxosResponse,)>

Fetch the list of UTXOs for a Bitcoin address, filtering by number of confirmations. Most applications should require 6 confirmations.

This method is paginated. If not all the results can be returned, then next_page will be set to Some, and its value can be passed to this method to get the next page.

pub fn get_utxos_query( &self, address: &str, filter: Option<UtxosFilter>, ) -> impl 'agent + SyncCall<Value = (GetUtxosResponse,)>

Fetch the list of UTXOs for a Bitcoin address, filtering by number of confirmations. Most applications should require 6 confirmations.

This method is paginated. If not all the results can be returned, then next_page will be set to Some, and its value can be passed to this method to get the next page.

pub fn get_current_fee_percentiles( &self, ) -> impl 'agent + AsyncCall<Value = (Vec<u64>,)>

Gets the transaction fee percentiles for the last 10,000 transactions. In the returned vector, v[i] is the ith percentile fee, measured in millisatoshis/vbyte, and v[0] is the smallest fee.

pub fn get_block_headers( &self, start_height: u32, end_height: Option<u32>, ) -> impl 'agent + AsyncCall<Value = (GetBlockHeadersResponse,)>

Gets the block headers for the specified range of blocks. If end_height is None, the returned tip_height provides the tip at the moment the chain was queried.

pub fn send_transaction( &self, transaction: Vec<u8>, ) -> impl 'agent + AsyncCall<Value = ()>

Submits a new Bitcoin transaction. No guarantees are made about the outcome.

Methods from Deref<Target = Canister<'agent>>

pub fn canister_id_(&self) -> &Principal

Get the canister ID of this canister. Prefer using canister_id instead.

pub fn canister_id(&self) -> &Principal

Get the canister ID of this canister.

pub fn update_<'canister>( &'canister self, method_name: &str, ) -> AsyncCallBuilder<'agent, 'canister>

Create an AsyncCallBuilder to do an update call. Prefer using update instead.

pub fn update<'canister>( &'canister self, method_name: &str, ) -> AsyncCallBuilder<'agent, 'canister>

Create an AsyncCallBuilder to do an update call.

pub fn query_<'canister>( &'canister self, method_name: &str, ) -> SyncCallBuilder<'agent, 'canister>

Create a SyncCallBuilder to do a query call. Prefer using query instead.

pub fn query<'canister>( &'canister self, method_name: &str, ) -> SyncCallBuilder<'agent, 'canister>

Create a SyncCallBuilder to do a query call.

pub async fn wait<'canister>( &'canister self, request_id: &RequestId, ) -> Result<Vec<u8>, AgentError>

Call request_status on the RequestId in a loop and return the response as a byte vector.

pub fn clone_with_(&self, id: Principal) -> Self

Creates a copy of this canister, changing the canister ID to the provided principal. Prefer using clone_with instead.

pub fn clone_with(&self, id: Principal) -> Self

Creates a copy of this canister, changing the canister ID to the provided principal.

Trait Implementations

impl<'agent> Debug for BitcoinCanister<'agent>

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

Formats the value using the given formatter.

impl<'agent> Deref for BitcoinCanister<'agent>

type Target = Canister<'agent>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.