Struct Provider

pub struct Provider { /* private fields */ }

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.

Implementations

impl Provider

pub async fn from(addr: impl Into<SocketAddr>) -> Result<Self>

pub async fn healthy(&self) -> Result<bool>

pub async fn connect(url: impl AsRef<str>) -> Result<Provider>

Connects to an existing node at the given address.

pub fn url(&self) -> &str

pub async fn blob(&self, blob_id: BlobId) -> Result<Option<Blob>>

pub async fn blob_exists(&self, blob_id: BlobId) -> Result<bool>

pub async fn send_transaction_and_await_commit<T: Transaction>( &self, tx: T, ) -> Result<TxStatus>

Sends a transaction to the underlying Provider’s client.

pub async fn send_transaction<T: Transaction>(&self, tx: T) -> Result<TxId>

pub async fn await_transaction_commit<T: Transaction>( &self, id: TxId, ) -> Result<TxStatus>

pub async fn tx_status(&self, tx_id: &TxId) -> Result<TxStatus>

pub async fn chain_info(&self) -> Result<ChainInfo>

pub fn consensus_parameters(&self) -> &ConsensusParameters

pub fn base_asset_id(&self) -> &AssetId

pub fn chain_id(&self) -> ChainId

pub async fn node_info(&self) -> Result<NodeInfo>

pub async fn latest_gas_price(&self) -> Result<LatestGasPrice>

pub async fn estimate_gas_price( &self, block_horizon: u32, ) -> Result<EstimateGasPrice>

pub async fn dry_run(&self, tx: impl Transaction) -> Result<TxStatus>

pub async fn dry_run_multiple( &self, transactions: Transactions, ) -> Result<Vec<(TxId, TxStatus)>>

pub async fn dry_run_opt( &self, tx: impl Transaction, utxo_validation: bool, gas_price: Option<u64>, ) -> Result<TxStatus>

pub async fn dry_run_opt_multiple( &self, transactions: Transactions, utxo_validation: bool, gas_price: Option<u64>, ) -> Result<Vec<(TxId, TxStatus)>>

pub async fn get_coins( &self, from: &Bech32Address, asset_id: AssetId, ) -> Result<Vec<Coin>>

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

pub async fn get_spendable_resources( &self, filter: ResourceFilter, ) -> Result<Vec<CoinType>>

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, ) -> Result<u64>

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, ) -> Result<u64>

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

pub async fn get_balances( &self, address: &Bech32Address, ) -> Result<HashMap<String, u64>>

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, ) -> Result<HashMap<AssetId, u64>>

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

pub async fn get_transaction_by_id( &self, tx_id: &TxId, ) -> Result<Option<TransactionResponse>>

pub async fn get_transactions( &self, request: PaginationRequest<String>, ) -> Result<PaginatedResult<TransactionResponse, String>>

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

pub async fn latest_block_height(&self) -> Result<u32>

pub async fn latest_block_time(&self) -> Result<Option<DateTime<Utc>>>

pub async fn produce_blocks( &self, blocks_to_produce: u32, start_time: Option<DateTime<Utc>>, ) -> Result<u32>

pub async fn block(&self, block_id: &Bytes32) -> Result<Option<Block>>

pub async fn block_by_height( &self, height: BlockHeight, ) -> Result<Option<Block>>

pub async fn get_blocks( &self, request: PaginationRequest<String>, ) -> Result<PaginatedResult<Block, String>>

pub async fn estimate_transaction_cost<T: Transaction>( &self, tx: T, tolerance: Option<f64>, block_horizon: Option<u32>, ) -> Result<TransactionCost>

pub async fn get_messages(&self, from: &Bech32Address) -> Result<Vec<Message>>

pub async fn get_message_proof( &self, tx_id: &TxId, nonce: &Nonce, commit_block_id: Option<&Bytes32>, commit_block_height: Option<u32>, ) -> Result<Option<MessageProof>>

pub async fn is_user_account(&self, address: impl Into<Bytes32>) -> Result<bool>

pub fn with_retry_config(self, retry_config: RetryConfig) -> Self

pub async fn contract_exists( &self, contract_id: &Bech32ContractId, ) -> Result<bool>

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

Formats the value using the given formatter.

impl DryRunner for Provider

fn dry_run<'life0, 'async_trait>( &'life0 self, tx: FuelTransaction, ) -> Pin<Box<dyn Future<Output = Result<DryRun>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn estimate_gas_price<'life0, 'async_trait>( &'life0 self, block_horizon: u32, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn consensus_parameters(&self) -> &ConsensusParameters

fn maybe_estimate_predicates<'life0, 'life1, 'async_trait>( &'life0 self, tx: &'life1 FuelTransaction, _latest_chain_executor_version: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<Option<FuelTransaction>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,