Struct fuels::accounts::provider::Provider

pub struct Provider {
    pub client: FuelClient,
    pub consensus_parameters: ConsensusParameters,
}

Encapsulates common client operations in the SDK. Note that you may also use client, which is an instance of FuelClient, directly, which provides a broader API.

Fields

client: FuelClient

consensus_parameters: ConsensusParameters

Implementations

impl Provider

pub fn new( client: FuelClient, consensus_parameters: ConsensusParameters ) -> Provider

pub async fn send_transaction<T>( &self, tx: T ) -> impl Future<Output = Result<Bytes32, Error>>where T: Transaction,

Sends a transaction to the underlying Provider’s client.

pub async fn get_receipts( &self, tx_id: &Bytes32 ) -> impl Future<Output = Result<Vec<Receipt, Global>, Error>>

pub async fn connect( url: impl AsRef<str> ) -> impl Future<Output = Result<Provider, Error>>

Connects to an existing node at the given address.

pub async fn chain_info( &self ) -> impl Future<Output = Result<ChainInfo, ProviderError>>

pub fn consensus_parameters(&self) -> ConsensusParameters

pub fn chain_id(&self) -> ChainId

pub async fn node_info( &self ) -> impl Future<Output = Result<NodeInfo, ProviderError>>

pub async fn checked_dry_run<T>( &self, tx: T ) -> impl Future<Output = Result<Vec<Receipt, Global>, Error>>where T: Transaction,

pub async fn dry_run<T>( &self, tx: T ) -> impl Future<Output = Result<Vec<Receipt, Global>, Error>>where T: Transaction,

pub async fn dry_run_no_validation<T>( &self, tx: T ) -> impl Future<Output = Result<Vec<Receipt, Global>, Error>>where T: Transaction,

pub async fn get_coins( &self, from: &Bech32Address, asset_id: AssetId ) -> impl Future<Output = Result<Vec<Coin, Global>, ProviderError>>

Gets all unspent coins owned by address from, with asset ID asset_id.

pub async fn get_spendable_resources( &self, filter: ResourceFilter ) -> impl Future<Output = Result<Vec<CoinType, Global>, ProviderError>>

Get some spendable coins of asset asset_id for address from that add up at least to amount amount. The returned coins (UTXOs) are actual coins that can be spent. The number of coins (UXTOs) is optimized to prevent dust accumulation.

pub async fn get_asset_balance( &self, address: &Bech32Address, asset_id: AssetId ) -> impl Future<Output = Result<u64, ProviderError>>

Get the balance of all spendable coins asset_id for address address. This is different from getting coins because we are just returning a number (the sum of UTXOs amount) instead of the UTXOs.

pub async fn get_contract_asset_balance( &self, contract_id: &Bech32ContractId, asset_id: AssetId ) -> impl Future<Output = Result<u64, ProviderError>>

Get the balance of all spendable coins asset_id for contract with id contract_id.

pub async fn get_balances( &self, address: &Bech32Address ) -> impl Future<Output = Result<HashMap<String, u64, RandomState>, ProviderError>>

Get all the spendable balances of all assets for address address. This is different from getting the coins because we are only returning the numbers (the sum of UTXOs coins amount for each asset id) and not the UTXOs coins themselves

pub async fn get_contract_balances( &self, contract_id: &Bech32ContractId ) -> impl Future<Output = Result<HashMap<AssetId, u64, RandomState>, ProviderError>>

Get all balances of all assets for the contract with id contract_id.

pub async fn get_transaction_by_id( &self, tx_id: &Bytes32 ) -> impl Future<Output = Result<Option<TransactionResponse>, ProviderError>>

pub async fn get_transactions( &self, request: PaginationRequest<String> ) -> impl Future<Output = Result<PaginatedResult<TransactionResponse, String>, ProviderError>>

pub async fn get_transactions_by_owner( &self, owner: &Bech32Address, request: PaginationRequest<String> ) -> impl Future<Output = Result<PaginatedResult<TransactionResponse, String>, ProviderError>>

pub async fn latest_block_height( &self ) -> impl Future<Output = Result<u32, ProviderError>>

pub async fn latest_block_time( &self ) -> impl Future<Output = Result<Option<DateTime<Utc>>, ProviderError>>

pub async fn produce_blocks( &self, blocks_to_produce: u64, start_time: Option<DateTime<Utc>> ) -> impl Future<Output = Result<u32, Error>>

pub async fn block( &self, block_id: &Bytes32 ) -> impl Future<Output = Result<Option<Block>, ProviderError>>

Get block by id.

pub async fn get_blocks( &self, request: PaginationRequest<String> ) -> impl Future<Output = Result<PaginatedResult<Block, String>, ProviderError>>

pub async fn estimate_transaction_cost<T>( &self, tx: T, tolerance: Option<f64> ) -> impl Future<Output = Result<TransactionCost, Error>>where T: Transaction,

pub async fn get_messages( &self, from: &Bech32Address ) -> impl Future<Output = Result<Vec<Message, Global>, ProviderError>>

pub async fn get_message_proof( &self, tx_id: &Bytes32, message_id: &MessageId, commit_block_id: Option<&Bytes32>, commit_block_height: Option<u32> ) -> impl Future<Output = Result<Option<MessageProof>, ProviderError>>

Trait Implementations

impl Clone for Provider

fn clone(&self) -> Provider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Provider

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

Formats the value using the given formatter.