Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Program

Icon LinkModule: @fuel-ts/program

Icon LinkClasses

Icon LinkInterfaces

Icon LinkType Aliases

Icon LinkCallConfig

Ƭ CallConfig<T>: Object

Represents configuration for calling a contract function.

Icon LinkType parameters

NameTypeDescription
TunknownType of the function's arguments.

Icon LinkType declaration

NameType
argsT
callParameters?CallParams
forward?CoinQuantity
funcFunctionFragment
programAbstractProgram
txParameters?TxParams

Icon LinkDefined in

packages/program/src/types.ts:51 Icon Link


Icon LinkCallParams

Ƭ CallParams: Partial<{ forward: CoinQuantityLike ; gasLimit: BigNumberish }>

Represents call parameters for a contract call.

Icon LinkDefined in

packages/program/src/types.ts:27 Icon Link


Icon LinkContractCall

Ƭ ContractCall: Object

Represents a contract call.

Icon LinkType declaration

NameType
amount?BigNumberish
assetId?BytesLike
contractIdAbstractAddress
dataBytesLike
fnSelectorstring
gas?BigNumberish
isInputDataPointerboolean
isOutputDataHeapboolean
outputEncodedLengthnumber

Icon LinkDefined in

packages/program/src/types.ts:12 Icon Link


Icon LinkInvocationScopeLike

Ƭ InvocationScopeLike<T>: Object

Represents a like object of InvocationScope with a method to get its call configuration.

Icon LinkType parameters

NameTypeDescription
TunknownType of the function's arguments.

Icon LinkType declaration

NameType
getCallConfig() => CallConfig <T>

Icon LinkDefined in

packages/program/src/types.ts:82 Icon Link


Icon LinkInvokeFunction

Ƭ InvokeFunction<TArgs, TReturn>: (...args: TArgs) => FunctionInvocationScope <TArgs, TReturn>

Icon LinkType parameters

NameTypeDescription
TArgsextends any[] = any[]Type of the function's arguments.
TReturnanyType of the function's return value.

Icon LinkType declaration

▸ (...args): FunctionInvocationScope <TArgs, TReturn>

Represents a function that can be invoked.

Icon LinkParameters

NameType
...argsTArgs

Icon LinkReturns

FunctionInvocationScope <TArgs, TReturn>

Icon LinkDefined in

packages/program/src/types.ts:67 Icon Link


Icon LinkRevertReason

Ƭ RevertReason: "RequireFailed" | "TransferToAddressFailed" | "SendMessageFailed" | "AssertEqFailed" | "AssertFailed" | "Unknown"

Represents the possible reasons for a revert.

Icon LinkDefined in

packages/program/src/revert/revert-error.ts:15 Icon Link


Icon LinkTransactionCostOptions

Ƭ TransactionCostOptions: Partial<{ fundTransaction: boolean ; gasPrice: BigNumberish }>

Represents options for calculating the transaction cost.

Icon LinkDefined in

packages/program/src/types.ts:93 Icon Link


Icon LinkTxParams

Ƭ TxParams: Partial<{ gasLimit: BigNumberish ; gasPrice: BigNumberish ; maturity?: number ; maxFee?: BigNumberish ; variableOutputs: number ; witnessLimit?: BigNumberish }>

Represents transaction parameters for a contract call.

Icon LinkDefined in

packages/program/src/types.ts:36 Icon Link