Struct forc_debug::FuelClient
source · pub struct FuelClient { /* private fields */ }
Implementations§
source§impl FuelClient
impl FuelClient
pub fn new(url: impl AsRef<str>) -> Result<FuelClient, Error>
sourcepub async fn query<ResponseData, Vars>(
&self,
q: Operation<ResponseData, Vars>
) -> Result<ResponseData, Error>where
Vars: Serialize,
ResponseData: DeserializeOwned + 'static,
pub async fn query<ResponseData, Vars>(
&self,
q: Operation<ResponseData, Vars>
) -> Result<ResponseData, Error>where
Vars: Serialize,
ResponseData: DeserializeOwned + 'static,
Send the GraphQL query to the client.
pub async fn health(&self) -> Result<bool, Error>
pub async fn node_info(&self) -> Result<NodeInfo, Error>
pub async fn chain_info(&self) -> Result<ChainInfo, Error>
sourcepub async fn dry_run(&self, tx: &Transaction) -> Result<Vec<Receipt>, Error>
pub async fn dry_run(&self, tx: &Transaction) -> Result<Vec<Receipt>, Error>
Default dry run, matching the exact configuration as the node
sourcepub async fn dry_run_opt(
&self,
tx: &Transaction,
utxo_validation: Option<bool>
) -> Result<Vec<Receipt>, Error>
pub async fn dry_run_opt( &self, tx: &Transaction, utxo_validation: Option<bool> ) -> Result<Vec<Receipt>, Error>
Dry run with options to override the node behavior
sourcepub async fn estimate_predicates(
&self,
tx: &mut Transaction
) -> Result<(), Error>
pub async fn estimate_predicates( &self, tx: &mut Transaction ) -> Result<(), Error>
Estimate predicates for the transaction
pub async fn submit(&self, tx: &Transaction) -> Result<Bytes32, Error>
sourcepub async fn submit_and_await_commit(
&self,
tx: &Transaction
) -> Result<TransactionStatus, Error>
pub async fn submit_and_await_commit( &self, tx: &Transaction ) -> Result<TransactionStatus, Error>
Submit the transaction and wait for it either to be included in
a block or removed from TxPool
.
This will wait forever if needed, so consider wrapping this call
with a tokio::time::timeout
.
sourcepub async fn submit_and_await_commit_with_receipts(
&self,
tx: &Transaction
) -> Result<(TransactionStatus, Option<Vec<Receipt>>), Error>
pub async fn submit_and_await_commit_with_receipts( &self, tx: &Transaction ) -> Result<(TransactionStatus, Option<Vec<Receipt>>), Error>
Submits transaction, await confirmation and return receipts.
pub async fn start_session(&self) -> Result<String, Error>
pub async fn end_session(&self, id: &str) -> Result<bool, Error>
pub async fn reset(&self, id: &str) -> Result<bool, Error>
pub async fn execute(&self, id: &str, op: &Instruction) -> Result<bool, Error>
pub async fn register(&self, id: &str, register: u32) -> Result<u64, Error>
pub async fn memory( &self, id: &str, start: u32, size: u32 ) -> Result<Vec<u8>, Error>
pub async fn set_breakpoint( &self, session_id: &str, contract: ContractId, pc: u64 ) -> Result<(), Error>
pub async fn set_single_stepping( &self, session_id: &str, enable: bool ) -> Result<(), Error>
pub async fn start_tx( &self, session_id: &str, tx: &Transaction ) -> Result<RunResult, Error>
pub async fn continue_tx(&self, session_id: &str) -> Result<RunResult, Error>
pub async fn transaction( &self, id: &Bytes32 ) -> Result<Option<TransactionResponse>, Error>
sourcepub async fn transaction_status(
&self,
id: &Bytes32
) -> Result<TransactionStatus, Error>
pub async fn transaction_status( &self, id: &Bytes32 ) -> Result<TransactionStatus, Error>
Get the status of a transaction
sourcepub async fn subscribe_transaction_status(
&self,
id: &Bytes32
) -> Result<impl Stream<Item = Result<TransactionStatus, Error>>, Error>
pub async fn subscribe_transaction_status( &self, id: &Bytes32 ) -> Result<impl Stream<Item = Result<TransactionStatus, Error>>, Error>
Subscribe to the status of a transaction
sourcepub async fn await_transaction_commit(
&self,
id: &Bytes32
) -> Result<TransactionStatus, Error>
pub async fn await_transaction_commit( &self, id: &Bytes32 ) -> Result<TransactionStatus, Error>
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
.
sourcepub async fn transactions(
&self,
request: PaginationRequest<String>
) -> Result<PaginatedResult<TransactionResponse, String>, Error>
pub async fn transactions( &self, request: PaginationRequest<String> ) -> Result<PaginatedResult<TransactionResponse, String>, Error>
returns a paginated set of transactions sorted by block height
sourcepub async fn transactions_by_owner(
&self,
owner: &Address,
request: PaginationRequest<String>
) -> Result<PaginatedResult<TransactionResponse, String>, Error>
pub async fn transactions_by_owner( &self, owner: &Address, request: PaginationRequest<String> ) -> Result<PaginatedResult<TransactionResponse, String>, Error>
Returns a paginated set of transactions associated with a txo owner address.
pub async fn receipts( &self, id: &Bytes32 ) -> Result<Option<Vec<Receipt>>, Error>
pub async fn produce_blocks( &self, blocks_to_produce: u32, start_timestamp: Option<u64> ) -> Result<BlockHeight, Error>
pub async fn block(&self, id: &Bytes32) -> Result<Option<Block>, Error>
pub async fn block_by_height(&self, height: u32) -> Result<Option<Block>, Error>
sourcepub async fn blocks(
&self,
request: PaginationRequest<String>
) -> Result<PaginatedResult<Block, String>, Error>
pub async fn blocks( &self, request: PaginationRequest<String> ) -> Result<PaginatedResult<Block, String>, Error>
Retrieve multiple blocks
pub async fn coin(&self, id: &UtxoId) -> Result<Option<Coin>, Error>
sourcepub async fn coins(
&self,
owner: &Address,
asset_id: Option<&AssetId>,
request: PaginationRequest<String>
) -> Result<PaginatedResult<Coin, String>, Error>
pub async fn coins( &self, owner: &Address, asset_id: Option<&AssetId>, request: PaginationRequest<String> ) -> Result<PaginatedResult<Coin, String>, Error>
Retrieve a page of coins by their owner
sourcepub async fn coins_to_spend(
&self,
owner: &Address,
spend_query: Vec<(AssetId, u64, Option<u32>)>,
excluded_ids: Option<(Vec<UtxoId>, Vec<Nonce>)>
) -> Result<Vec<Vec<CoinType>>, Error>
pub async fn coins_to_spend( &self, owner: &Address, spend_query: Vec<(AssetId, u64, Option<u32>)>, excluded_ids: Option<(Vec<UtxoId>, Vec<Nonce>)> ) -> Result<Vec<Vec<CoinType>>, Error>
Retrieve coins to spend in a transaction
pub async fn contract(&self, id: &ContractId) -> Result<Option<Contract>, Error>
pub async fn contract_balance( &self, id: &ContractId, asset: Option<&AssetId> ) -> Result<u64, Error>
pub async fn balance( &self, owner: &Address, asset_id: Option<&AssetId> ) -> Result<u64, Error>
pub async fn balances( &self, owner: &Address, request: PaginationRequest<String> ) -> Result<PaginatedResult<Balance, String>, Error>
pub async fn contract_balances( &self, contract: &ContractId, request: PaginationRequest<String> ) -> Result<PaginatedResult<ContractBalance, String>, Error>
pub async fn messages( &self, owner: Option<&Address>, request: PaginationRequest<String> ) -> Result<PaginatedResult<Message, String>, Error>
pub async fn message_status( &self, nonce: &Nonce ) -> Result<MessageStatus, Error>
sourcepub async fn message_proof(
&self,
transaction_id: &Bytes32,
nonce: &Nonce,
commit_block_id: Option<&Bytes32>,
commit_block_height: Option<BlockHeight>
) -> Result<Option<MessageProof>, Error>
pub async fn message_proof( &self, transaction_id: &Bytes32, nonce: &Nonce, commit_block_id: Option<&Bytes32>, commit_block_height: Option<BlockHeight> ) -> Result<Option<MessageProof>, Error>
Request a merkle proof of an output message.
Trait Implementations§
source§impl Clone for FuelClient
impl Clone for FuelClient
source§fn clone(&self) -> FuelClient
fn clone(&self) -> FuelClient
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FuelClient
impl Debug for FuelClient
source§impl<S> From<S> for FuelClientwhere
S: Into<SocketAddr>,
impl<S> From<S> for FuelClientwhere
S: Into<SocketAddr>,
source§fn from(socket: S) -> FuelClient
fn from(socket: S) -> FuelClient
Auto Trait Implementations§
impl !RefUnwindSafe for FuelClient
impl Send for FuelClient
impl Sync for FuelClient
impl Unpin for FuelClient
impl !UnwindSafe for FuelClient
Blanket Implementations§
source§impl<T> AnyDebug for T
impl<T> AnyDebug for T
source§fn as_any_ref(&self) -> &(dyn Any + 'static)
fn as_any_ref(&self) -> &(dyn Any + 'static)
Any
.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> StorageAsMut for T
impl<T> StorageAsMut for T
fn storage<Type>(&mut self) -> StorageMut<'_, Self, Type>where
Type: Mappable,
fn storage_as_mut<Type>(&mut self) -> StorageMut<'_, Self, Type>where
Type: Mappable,
source§impl<T> StorageAsRef for T
impl<T> StorageAsRef for T
fn storage<Type>(&self) -> StorageRef<'_, Self, Type>where
Type: Mappable,
fn storage_as_ref<Type>(&self) -> StorageRef<'_, Self, Type>where
Type: Mappable,
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.