@fuel-ts/program .FunctionInvocationScope
Represents a scope for invoking a function.
| Name | Type | Description |
|---|---|---|
TArgs | extends any[] = any[] | The type of the function arguments. |
TReturn | any | The type of the return value. |
BaseInvocationScope<TReturn>
↳ FunctionInvocationScope
• new FunctionInvocationScope<TArgs, TReturn>(program, func, args): FunctionInvocationScope <TArgs, TReturn>
Constructs an instance of FunctionInvocationScope.
| Name | Type |
|---|---|
TArgs | extends any[] = any[] |
TReturn | any |
| Name | Type | Description |
|---|---|---|
program | AbstractProgram | The program. |
func | FunctionFragment<JsonAbi, string> | The function fragment. |
args | TArgs | The arguments. |
FunctionInvocationScope <TArgs, TReturn>
BaseInvocationScope<TReturn>.constructor
functions/invocation-scope.ts:34
• Protected args: TArgs
functions/invocation-scope.ts:25
• Private Optional callParameters: Partial<{ forward: CoinQuantityLike ; gasLimit: BigNumberish }>
functions/invocation-scope.ts:23
• Protected externalAbis: Record<string, JsonAbi> = {}
BaseInvocationScope.externalAbis
functions/base-invocation-scope.ts:66
• Private Optional forward: CoinQuantity
functions/invocation-scope.ts:24
• Protected func: FunctionFragment<JsonAbi, string>
functions/invocation-scope.ts:22
• Protected functionInvocationScopes: InvocationScopeLike [] = []
BaseInvocationScope.functionInvocationScopes
functions/base-invocation-scope.ts:61
• Protected hasCallParamsGasLimit: boolean = false
BaseInvocationScope.hasCallParamsGasLimit
functions/base-invocation-scope.ts:65
• Protected isMultiCall: boolean = false
BaseInvocationScope.isMultiCall
functions/base-invocation-scope.ts:64
• Protected program: AbstractProgram
BaseInvocationScope.program
functions/base-invocation-scope.ts:60
• Protected requiredCoins: CoinQuantity [] = []
BaseInvocationScope.requiredCoins
functions/base-invocation-scope.ts:63
• Protected transactionRequest: ScriptTransactionRequest
BaseInvocationScope.transactionRequest
functions/base-invocation-scope.ts:59
• Protected Optional txParameters: Partial<{ gasLimit: BigNumberish ; maturity?: number ; maxFee?: BigNumberish ; tip: BigNumberish ; variableOutputs: number ; witnessLimit?: BigNumberish }>
BaseInvocationScope.txParameters
functions/base-invocation-scope.ts:62
• get calls(): ContractCall []
Getter for the contract calls.
ContractCall []
An array of contract calls.
BaseInvocationScope.calls
functions/base-invocation-scope.ts:88
▸ addBatchTransfer(transferParams): FunctionInvocationScope <TArgs, TReturn>
Adds multiple transfers to the contract call transaction request.
| Name | Type | Description |
|---|---|---|
transferParams | TransferParams [] | An array of TransferParams objects representing the transfers to be made. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.addBatchTransfer
functions/base-invocation-scope.ts:339
▸ addCall(funcScope): FunctionInvocationScope <TArgs, TReturn>
Adds a single call to the invocation scope.
| Name | Type | Description |
|---|---|---|
funcScope | InvocationScopeLike | The function scope to add. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.addCall
functions/base-invocation-scope.ts:174
▸ addCalls(funcScopes): FunctionInvocationScope <TArgs, TReturn>
Adds multiple calls to the invocation scope.
| Name | Type | Description |
|---|---|---|
funcScopes | InvocationScopeLike [] | An array of function scopes to add. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.addCalls
functions/base-invocation-scope.ts:185
▸ addContracts(contracts): FunctionInvocationScope <TArgs, TReturn>
Adds contracts to the invocation scope.
| Name | Type | Description |
|---|---|---|
contracts | AbstractContract [] | An array of contracts to add. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.addContracts
functions/base-invocation-scope.ts:307
▸ addSigners(signers): FunctionInvocationScope <TArgs, TReturn>
FunctionInvocationScope <TArgs, TReturn>
BaseInvocationScope.addSigners
functions/base-invocation-scope.ts:352
▸ addTransfer(transferParams): FunctionInvocationScope <TArgs, TReturn>
Adds an asset transfer to an Account on the contract call transaction request.
| Name | Type | Description |
|---|---|---|
transferParams | TransferParams | The object representing the transfer to be made. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.addTransfer
functions/base-invocation-scope.ts:321
▸ call<T>(): Promise<{ transactionId: string ; waitForResult: () => Promise<FunctionResult <T>> }>
Submits the contract call transaction and returns a promise that resolves to an object containing the transaction ID and a function to wait for the result. The promise will resolve as soon as the transaction is submitted to the node.
| Name | Type | Description |
|---|---|---|
T | TReturn | The type of the return value. |
Promise<{ transactionId: string ; waitForResult: () => Promise<FunctionResult <T>> }>
A promise that resolves to an object containing:
transactionId: The ID of the submitted transaction. waitForResult: A function that waits for the transaction result. BaseInvocationScope.call
functions/base-invocation-scope.ts:379
▸ callParams(callParams): FunctionInvocationScope <TArgs, TReturn>
Sets the call parameters for the function invocation.
Throws
If the function is not payable and forward is set.
| Name | Type | Description |
|---|---|---|
callParams | Partial<{ forward: CoinQuantityLike ; gasLimit: BigNumberish }> | The call parameters. |
FunctionInvocationScope <TArgs, TReturn>
The instance of FunctionInvocationScope.
functions/invocation-scope.ts:77
▸ checkGasLimitTotal(): void
Checks if the total gas limit is within the acceptable range.
void
BaseInvocationScope.checkGasLimitTotal
functions/base-invocation-scope.ts:217
▸ dryRun<T>(): Promise<DryRunResult <T>>
Executes a transaction in dry run mode.
| Name | Type |
|---|---|
T | TReturn |
Promise<DryRunResult <T>>
The result of the invocation call.
BaseInvocationScope.dryRun
functions/base-invocation-scope.ts:438
▸ fundWithRequiredCoins(): Promise<ScriptTransactionRequest >
Funds the transaction with the required coins.
Promise<ScriptTransactionRequest >
The current instance of the class.
BaseInvocationScope.fundWithRequiredCoins
functions/base-invocation-scope.ts:254
▸ get<T>(): Promise<DryRunResult <T>>
| Name | Type |
|---|---|
T | TReturn |
Promise<DryRunResult <T>>
BaseInvocationScope.get
functions/base-invocation-scope.ts:452
▸ getCallConfig(): CallConfig <TArgs>
Gets the call configuration.
CallConfig <TArgs>
The call configuration.
functions/invocation-scope.ts:47
▸ getProvider(): Provider
BaseInvocationScope.getProvider
functions/base-invocation-scope.ts:466
▸ getRequiredCoins(): CoinQuantity []
Gets the required coins for the transaction.
CoinQuantity []
An array of required coin quantities.
BaseInvocationScope.getRequiredCoins
functions/base-invocation-scope.ts:137
▸ getTransactionCost(): Promise<TransactionCost >
Gets the transaction cost ny dry running the transaction.
Promise<TransactionCost >
The transaction cost details.
BaseInvocationScope.getTransactionCost
functions/base-invocation-scope.ts:236
▸ getTransactionId(chainId?): Promise<string>
Obtains the ID of a transaction.
| Name | Type | Description |
|---|---|---|
chainId? | number | the chainId to use to hash the transaction with |
Promise<string>
the ID of the transaction.
BaseInvocationScope.getTransactionId
functions/base-invocation-scope.ts:478
▸ getTransactionRequest(): Promise<ScriptTransactionRequest >
Prepares and returns the transaction request object.
Promise<ScriptTransactionRequest >
The prepared transaction request.
BaseInvocationScope.getTransactionRequest
functions/base-invocation-scope.ts:364
▸ prepareTransaction(): Promise<void>
Prepares the transaction by updating the script request, required coins, and checking the gas limit.
Promise<void>
BaseInvocationScope.prepareTransaction
functions/base-invocation-scope.ts:195
▸ setArguments(...args): FunctionInvocationScope <TArgs, TReturn>
Sets the arguments for the function invocation.
| Name | Type | Description |
|---|---|---|
...args | TArgs | The arguments. |
FunctionInvocationScope <TArgs, TReturn>
The instance of FunctionInvocationScope.
functions/invocation-scope.ts:65
▸ simulate<T>(): Promise<DryRunResult <T>>
Simulates a transaction.
| Name | Type |
|---|---|
T | TReturn |
Promise<DryRunResult <T>>
The result of the invocation call.
BaseInvocationScope.simulate
functions/base-invocation-scope.ts:411
▸ txParams(txParams): FunctionInvocationScope <TArgs, TReturn>
Sets the transaction parameters.
| Name | Type | Description |
|---|---|---|
txParams | Partial<{ gasLimit: BigNumberish ; maturity?: number ; maxFee?: BigNumberish ; tip: BigNumberish ; variableOutputs: number ; witnessLimit?: BigNumberish }> | The transaction parameters to set. |
FunctionInvocationScope <TArgs, TReturn>
The current instance of the class.
BaseInvocationScope.txParams
functions/base-invocation-scope.ts:286
▸ updateContractInputAndOutput(): void
Updates the transaction request with the current input/output.
void
BaseInvocationScope.updateContractInputAndOutput
functions/base-invocation-scope.ts:118
▸ updateRequiredCoins(): void
Updates the required coins for the transaction.
void
BaseInvocationScope.updateRequiredCoins
functions/base-invocation-scope.ts:150
▸ updateScriptRequest(): void
Updates the script request with the current contract calls.
void
BaseInvocationScope.updateScriptRequest