@fuel-ts/program .MultiCallInvocationScope
Represents a scope for invoking multiple calls.
| Name | Type | Description |
|---|---|---|
TReturn | any | The type of the return value. |
BaseInvocationScope<TReturn>
↳ MultiCallInvocationScope
• new MultiCallInvocationScope<TReturn>(contract, funcScopes): MultiCallInvocationScope <TReturn>
Constructs an instance of MultiCallInvocationScope.
| Name | Type |
|---|---|
TReturn | any |
| Name | Type | Description |
|---|---|---|
contract | AbstractContract | The contract. |
funcScopes | FunctionInvocationScope <any[], any>[] | An array of function invocation scopes. |
MultiCallInvocationScope <TReturn>
BaseInvocationScope<TReturn>.constructor
functions/multicall-scope.ts:20
• Protected externalAbis: Record<string, JsonAbi> = {}
BaseInvocationScope.externalAbis
functions/base-invocation-scope.ts:65
• Protected functionInvocationScopes: InvocationScopeLike [] = []
BaseInvocationScope.functionInvocationScopes
functions/base-invocation-scope.ts:60
• Protected hasCallParamsGasLimit: boolean = false
BaseInvocationScope.hasCallParamsGasLimit
functions/base-invocation-scope.ts:64
• Protected isMultiCall: boolean = false
BaseInvocationScope.isMultiCall
functions/base-invocation-scope.ts:63
• Protected program: AbstractProgram
BaseInvocationScope.program
functions/base-invocation-scope.ts:59
• Protected requiredCoins: CoinQuantity [] = []
BaseInvocationScope.requiredCoins
functions/base-invocation-scope.ts:62
• Protected transactionRequest: ScriptTransactionRequest
BaseInvocationScope.transactionRequest
functions/base-invocation-scope.ts:58
• Protected Optional txParameters: Partial<{ gasLimit: BigNumberish ; gasPrice: BigNumberish ; maturity?: number ; maxFee?: BigNumberish ; variableOutputs: number ; witnessLimit?: BigNumberish }>
BaseInvocationScope.txParameters
functions/base-invocation-scope.ts:61
• get calls(): ContractCall []
Getter for the contract calls.
ContractCall []
An array of contract calls.
BaseInvocationScope.calls
functions/base-invocation-scope.ts:88
▸ addCall(funcScope): MultiCallInvocationScope <TReturn>
Adds a single function invocation scope to the multi-call invocation scope.
| Name | Type | Description |
|---|---|---|
funcScope | FunctionInvocationScope <any[], any> | The function invocation scope. |
MultiCallInvocationScope <TReturn>
The instance of MultiCallInvocationScope.
BaseInvocationScope.addCall
functions/multicall-scope.ts:32
▸ addCalls(funcScopes): MultiCallInvocationScope <TReturn>
Adds multiple function invocation scopes to the multi-call invocation scope.
| Name | Type | Description |
|---|---|---|
funcScopes | FunctionInvocationScope <any[], any>[] | An array of function invocation scopes. |
MultiCallInvocationScope <TReturn>
The instance of MultiCallInvocationScope.
BaseInvocationScope.addCalls
functions/multicall-scope.ts:42
▸ addContracts(contracts): MultiCallInvocationScope <TReturn>
Adds contracts to the invocation scope.
| Name | Type | Description |
|---|---|---|
contracts | AbstractContract [] | An array of contracts to add. |
MultiCallInvocationScope <TReturn>
The current instance of the class.
BaseInvocationScope.addContracts
functions/base-invocation-scope.ts:315
▸ addSigners(signers): MultiCallInvocationScope <TReturn>
MultiCallInvocationScope <TReturn>
BaseInvocationScope.addSigners
functions/base-invocation-scope.ts:341
▸ addTransfer(destination, amount, assetId): MultiCallInvocationScope <TReturn>
Adds an asset transfer to an Account on the contract call transaction request.
| Name | Type | Description |
|---|---|---|
destination | string | AbstractAddress | The address of the destination. |
amount | BigNumberish | The amount of coins to transfer. |
assetId | string | The asset ID of the coins to transfer. |
MultiCallInvocationScope <TReturn>
The current instance of the class.
BaseInvocationScope.addTransfer
functions/base-invocation-scope.ts:331
▸ call<T>(): Promise<FunctionInvocationResult <T, void>>
Submits a transaction.
| Name | Type |
|---|---|
T | TReturn |
Promise<FunctionInvocationResult <T, void>>
The result of the function invocation.
BaseInvocationScope.call
functions/base-invocation-scope.ts:363
▸ checkGasLimitTotal(): void
Checks if the total gas limit is within the acceptable range.
void
BaseInvocationScope.checkGasLimitTotal
functions/base-invocation-scope.ts:210
▸ dryRun<T>(): Promise<InvocationCallResult <T>>
Executes a transaction in dry run mode.
| Name | Type |
|---|---|
T | TReturn |
Promise<InvocationCallResult <T>>
The result of the invocation call.
BaseInvocationScope.dryRun
functions/base-invocation-scope.ts:416
▸ fundWithRequiredCoins(): Promise<MultiCallInvocationScope <TReturn>>
Funds the transaction with the required coins.
Promise<MultiCallInvocationScope <TReturn>>
The current instance of the class.
BaseInvocationScope.fundWithRequiredCoins
functions/base-invocation-scope.ts:247
▸ get<T>(): Promise<InvocationCallResult <T>>
| Name | Type |
|---|---|
T | TReturn |
Promise<InvocationCallResult <T>>
BaseInvocationScope.get
functions/base-invocation-scope.ts:430
▸ getProvider(): Provider
BaseInvocationScope.getProvider
functions/base-invocation-scope.ts:444
▸ getRequiredCoins(): CoinQuantity []
Gets the required coins for the transaction.
CoinQuantity []
An array of required coin quantities.
BaseInvocationScope.getRequiredCoins
functions/base-invocation-scope.ts:130
▸ getTransactionCost(options?): Promise<TransactionCost >
Gets the transaction cost ny dry running the transaction.
| Name | Type | Description |
|---|---|---|
options? | Partial<{ fundTransaction: boolean ; gasPrice: BigNumberish }> | Optional transaction cost options. |
Promise<TransactionCost >
The transaction cost details.
BaseInvocationScope.getTransactionCost
functions/base-invocation-scope.ts:229
▸ 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:456
▸ getTransactionRequest(): Promise<ScriptTransactionRequest >
Prepares and returns the transaction request object.
Promise<ScriptTransactionRequest >
The prepared transaction request.
BaseInvocationScope.getTransactionRequest
functions/base-invocation-scope.ts:353
▸ 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:188
▸ simulate<T>(): Promise<InvocationCallResult <T>>
Simulates a transaction.
| Name | Type |
|---|---|
T | TReturn |
Promise<InvocationCallResult <T>>
The result of the invocation call.
BaseInvocationScope.simulate
functions/base-invocation-scope.ts:389
▸ txParams(txParams): MultiCallInvocationScope <TReturn>
Sets the transaction parameters.
| Name | Type | Description |
|---|---|---|
txParams | Partial<{ gasLimit: BigNumberish ; gasPrice: BigNumberish ; maturity?: number ; maxFee?: BigNumberish ; variableOutputs: number ; witnessLimit?: BigNumberish }> | The transaction parameters to set. |
MultiCallInvocationScope <TReturn>
The current instance of the class.
BaseInvocationScope.txParams
functions/base-invocation-scope.ts:291
▸ updateContractInputAndOutput(): void
Updates the transaction request with the current input/output.
void
BaseInvocationScope.updateContractInputAndOutput
functions/base-invocation-scope.ts:116
▸ updateRequiredCoins(): void
Updates the required coins for the transaction.
void
BaseInvocationScope.updateRequiredCoins
functions/base-invocation-scope.ts:143
▸ updateScriptRequest(): void
Updates the script request with the current contract calls.
void
BaseInvocationScope.updateScriptRequest
functions/base-invocation-scope.ts:107
▸ validateHeapTypeReturnCalls(): void
void