Struct FuelClient

pub struct FuelClient { /* private fields */ }

Implementations

impl FuelClient

pub fn new(url: impl AsRef<str>) -> Result<Self>

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

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

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

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

Default dry run, matching the exact configuration as the node

pub async fn dry_run_opt( &self, tx: &Transaction, utxo_validation: Option<bool>, ) -> Result<Vec<Receipt>>

Dry run with options to override the node behavior

pub async fn submit(&self, tx: &Transaction) -> Result<TransactionId>

pub async fn submit_and_await_commit( &self, tx: &Transaction, ) -> Result<TransactionStatus>

Submit the transaction and wait for it to be included into a block.

This will wait forever if needed, so consider wrapping this call with a tokio::time::timeout.

pub async fn start_session(&self) -> Result<String>

pub async fn end_session(&self, id: &str) -> Result<bool>

pub async fn reset(&self, id: &str) -> Result<bool>

pub async fn execute(&self, id: &str, op: &Opcode) -> Result<bool>

pub async fn register(&self, id: &str, register: RegisterId) -> Result<Word>

pub async fn memory( &self, id: &str, start: usize, size: usize, ) -> Result<Vec<u8>>

pub async fn set_breakpoint( &self, session_id: &str, contract: ContractId, pc: u64, ) -> Result<()>

pub async fn set_single_stepping( &self, session_id: &str, enable: bool, ) -> Result<()>

pub async fn start_tx( &self, session_id: &str, tx: &Transaction, ) -> Result<RunResult>

pub async fn continue_tx(&self, session_id: &str) -> Result<RunResult>

pub async fn transaction(&self, id: &str) -> Result<Option<TransactionResponse>>

pub async fn transaction_status(&self, id: &str) -> Result<TransactionStatus>

Get the status of a transaction

pub async fn subscribe_transaction_status( &self, id: &str, ) -> Result<impl Stream<Item = Result<TransactionStatus>>>

Subscribe to the status of a transaction

pub async fn await_transaction_commit( &self, id: &str, ) -> Result<TransactionStatus>

Awaits for the transaction to be committed into a block

This will wait forever if needed, so consider wrapping this call with a tokio::time::timeout.

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

returns a paginated set of transactions sorted by block height

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

Returns a paginated set of transactions associated with a txo owner address.

pub async fn receipts(&self, id: &str) -> Result<Vec<Receipt>>

pub async fn produce_blocks( &self, blocks_to_produce: u64, time: Option<TimeParameters>, ) -> Result<u64>

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

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

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

Retrieve multiple blocks

pub async fn coin(&self, id: &str) -> Result<Option<Coin>>

pub async fn coins( &self, owner: &str, asset_id: Option<&str>, request: PaginationRequest<String>, ) -> Result<PaginatedResult<Coin, String>>

Retrieve a page of coins by their owner

pub async fn resources_to_spend( &self, owner: &str, spend_query: Vec<(&str, u64, Option<u64>)>, excluded_ids: Option<(Vec<&str>, Vec<&str>)>, ) -> Result<Vec<Vec<Resource>>>

Retrieve resources to spend in a transaction

pub async fn contract(&self, id: &str) -> Result<Option<Contract>>

pub async fn contract_balance( &self, id: &str, asset: Option<&str>, ) -> Result<u64>

pub async fn balance(&self, owner: &str, asset_id: Option<&str>) -> Result<u64>

pub async fn balances( &self, owner: &str, request: PaginationRequest<String>, ) -> Result<PaginatedResult<Balance, String>>

pub async fn contract_balances( &self, contract: &str, request: PaginationRequest<String>, ) -> Result<PaginatedResult<ContractBalance, String>>

pub async fn messages( &self, owner: Option<&str>, request: PaginationRequest<String>, ) -> Result<PaginatedResult<Message, String>>

pub async fn message_proof( &self, transaction_id: &str, message_id: &str, ) -> Result<Option<MessageProof>>

Request a merkle proof of an output message.

Trait Implementations

impl Clone for FuelClient

fn clone(&self) -> FuelClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuelClient

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

Formats the value using the given formatter.

impl<S> From<S> for FuelClient

where S: Into<SocketAddr>,

fn from(socket: S) -> Self

Converts to this type from the input type.

impl FromStr for FuelClient

type Err = Error

The associated error which can be returned from parsing.

fn from_str(str: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FuelClient

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FuelClient

fn eq(&self, other: &FuelClient) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FuelClient

impl StructuralPartialEq for FuelClient