Struct fuels_programs::contract::ContractCallHandler

pub struct ContractCallHandler<T: Account, D> {
    pub contract_call: ContractCall,
    pub tx_policies: TxPolicies,
    pub account: T,
    pub datatype: PhantomData<D>,
    pub log_decoder: LogDecoder,
    /* private fields */
}

Helper that handles submitting a call to a client and formatting the response

Fields

contract_call: ContractCall

tx_policies: TxPolicies

account: T

datatype: PhantomData<D>

log_decoder: LogDecoder

Implementations

impl<T, D> ContractCallHandler<T, D>

where T: Account, D: Tokenizable + Parameterize + Debug,

pub fn with_contract_ids(self, contract_ids: &[Bech32ContractId]) -> Self

Sets external contracts as dependencies to this contract’s call. Effectively, this will be used to create fuel_tx::Input::Contract/fuel_tx::Output::Contract pairs and set them into the transaction. Note that this is a builder method, i.e. use it as a chain:

my_contract_instance.my_method(...).with_contract_ids(&[another_contract_id]).call()

pub fn with_variable_output_policy( self, variable_outputs: VariableOutputPolicy, ) -> Self

If this method is not called, the default policy is to not add any variable outputs.

Parameters

• variable_outputs: The VariableOutputPolicy to apply for the contract call.

Returns

• Self: The updated SDK configuration.

pub fn with_contracts(self, contracts: &[&dyn SettableContract]) -> Self

Sets external contract instances as dependencies to this contract’s call. Effectively, this will be used to: merge LogDecoders and create fuel_tx::Input::Contract/fuel_tx::Output::Contract pairs and set them into the transaction. Note that this is a builder method, i.e. use it as a chain:

my_contract_instance.my_method(...).with_contracts(&[another_contract_instance]).call()

pub fn add_custom_asset( self, asset_id: AssetId, amount: u64, to: Option<Bech32Address>, ) -> Self

Adds a custom asset_id with its amount and an optional address to be used for generating outputs to this contract’s call.

Parameters

• asset_id: The unique identifier of the asset being added.
• amount: The amount of the asset being added.
• address: The optional account address that the output amount will be sent to. If not provided, the asset will be sent to the users account address. Note that this is a builder method, i.e. use it as a chain:

let asset_id = AssetId::from([3u8; 32]);
let amount = 5000;
my_contract_instance.my_method(...).add_custom_asset(asset_id, amount, None).call()

pub fn is_payable(&self) -> bool

pub fn with_tx_policies(self, tx_policies: TxPolicies) -> Self

Sets the transaction policies for a given transaction. Note that this is a builder method, i.e. use it as a chain:

let tx_policies = TxPolicies::default().with_gas_price(100);
my_contract_instance.my_method(...).with_tx_policies(tx_policies).call()

pub fn with_decoder_config(self, decoder_config: DecoderConfig) -> Self

pub fn call_params(self, params: CallParameters) -> Result<Self>

Sets the call parameters for a given contract call. Note that this is a builder method, i.e. use it as a chain:

let params = CallParameters { amount: 1, asset_id: AssetId::zeroed() };
my_contract_instance.my_method(...).call_params(params).call()

pub async fn transaction_builder(&self) -> Result<ScriptTransactionBuilder>

pub async fn build_tx(&self) -> Result<ScriptTransaction>

Returns the script that executes the contract call

pub async fn call(self) -> Result<FuelCallResponse<D>>

Call a contract’s method on the node, in a state-modifying manner.

pub async fn submit(self) -> Result<SubmitResponse<T, D>>

pub async fn simulate(&mut self) -> Result<FuelCallResponse<D>>

Call a contract’s method on the node, in a simulated manner, meaning the state of the blockchain is not modified but simulated.

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

Get a contract’s estimated cost

pub fn get_response( &self, receipts: Vec<Receipt>, ) -> Result<FuelCallResponse<D>>

Create a FuelCallResponse from call receipts

pub fn get_response_from( &self, tx_status: TxStatus, ) -> Result<FuelCallResponse<D>>

Create a FuelCallResponse from TxStatus

Trait Implementations

impl<T: Debug + Account, D: Debug> Debug for ContractCallHandler<T, D>

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

Formats the value using the given formatter.

impl<T, D> TxDependencyExtension for ContractCallHandler<T, D>

where T: Account, D: Tokenizable + Parameterize + Debug + Send + Sync,

fn simulate<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

fn append_contract(self, contract_id: Bech32ContractId) -> Self

Appends additional external contracts as dependencies to this call. Effectively, this will be used to create additional fuel_tx::Input::Contract/fuel_tx::Output::Contract pairs and set them into the transaction. Note that this is a builder method, i.e. use it as a chain:

fn determine_missing_contracts<'async_trait>( self, max_attempts: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: Send + 'async_trait,

Simulates the call and attempts to resolve missing contract outputs. Forwards the received error if it cannot be fixed.