Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Program

@fuel-ts/program v0.97.0Docs


Icon Link@fuel-ts/program

Icon LinkType Aliases

Icon LinkCallConfig<T>

Icon InfoCircle

CallConfig<T>: object

Represents configuration for calling a contract function.

Icon LinkType Parameters

T = unknown

Type of the function's arguments.

Icon LinkType declaration

Icon Linkargs

Icon InfoCircle

args: T

Icon LinkcallParameters?

Icon InfoCircle

optional callParameters: CallParams

Icon LinkexternalAbis

Icon InfoCircle

externalAbis: Record<string, JsonAbi>

Icon Linkforward?

Icon InfoCircle

optional forward: CoinQuantity

Icon Linkfunc

Icon InfoCircle

func: FunctionFragment

Icon Linkprogram

Icon InfoCircle

program: AbstractProgram

Icon LinktxParameters?

Icon InfoCircle

optional txParameters: TxParams

Icon LinkDefined in

types.ts:53 Icon Link


Icon LinkCallParams

Icon InfoCircle

CallParams: Partial<object>

Represents call parameters for a contract call.

Icon LinkType declaration

Icon Linkforward

Icon InfoCircle

forward: CoinQuantityLike

Icon LinkgasLimit

Icon InfoCircle

gasLimit: BigNumberish

Icon LinkDefined in

types.ts:31 Icon Link


Icon LinkContractCall

Icon InfoCircle

ContractCall: object

Represents a contract call.

Icon LinkType declaration

Icon Linkamount?

Icon InfoCircle

optional amount: BigNumberish

Icon LinkassetId?

Icon InfoCircle

optional assetId: BytesLike

Icon LinkcontractId

Icon InfoCircle

contractId: AbstractAddress

Icon Linkdata

Icon InfoCircle

data: BytesLike

Icon LinkexternalContractsAbis?

Icon InfoCircle

optional externalContractsAbis: Record<string, JsonAbi>

Icon LinkfnSelectorBytes

Icon InfoCircle

fnSelectorBytes: Uint8Array

Icon Linkgas?

Icon InfoCircle

optional gas: BigNumberish

Icon LinkDefined in

types.ts:18 Icon Link


Icon LinkDryRunResult<TReturn>

Icon InfoCircle

DryRunResult<TReturn>: object

Icon LinkType Parameters

TReturn

Icon LinkType declaration

Icon LinkcallResult

Icon InfoCircle

readonly callResult: CallResult

Icon LinkfunctionScopes

Icon InfoCircle

readonly functionScopes: InvocationScopeLike []

Icon LinkgasUsed

Icon InfoCircle

readonly gasUsed: BN

Icon LinkisMultiCall

Icon InfoCircle

readonly isMultiCall: boolean

Icon Linkvalue

Icon InfoCircle

readonly value: TReturn

Icon LinkDefined in

types.ts:119 Icon Link


Icon LinkFunctionResult<TReturn>

Icon InfoCircle

FunctionResult<TReturn>: object

Icon LinkType Parameters

TReturn

Icon LinkType declaration

Icon LinkfunctionScopes

Icon InfoCircle

readonly functionScopes: InvocationScopeLike []

Icon LinkgasUsed

Icon InfoCircle

readonly gasUsed: BN

Icon LinkisMultiCall

Icon InfoCircle

readonly isMultiCall: boolean

Icon Linklogs

Icon InfoCircle

readonly logs: any[]

Icon Linkprogram

Icon InfoCircle

readonly program: AbstractProgram

Icon LinktransactionId

Icon InfoCircle

readonly transactionId: string

Icon LinktransactionResponse

Icon InfoCircle

readonly transactionResponse: TransactionResponse

Icon LinktransactionResult

Icon InfoCircle

readonly transactionResult: TransactionResult<Script >

Icon Linkvalue

Icon InfoCircle

readonly value: TReturn

Icon LinkDefined in

types.ts:106 Icon Link


Icon LinkInvocationScopeLike<T>

Icon InfoCircle

InvocationScopeLike<T>: object

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

Icon LinkType Parameters

T = unknown

Type of the function's arguments.

Icon LinkType declaration

Icon LinkgetCallConfig()

Get the call configuration for this invocation scope.

Icon LinkReturns

CallConfig <T>

{CallConfig<T>} The call configuration.

Icon LinkDefined in

types.ts:91 Icon Link


Icon LinkTransactionCostOptions

Icon InfoCircle

TransactionCostOptions: Partial&lt;object>

Represents options for calculating the transaction cost.

Icon LinkType declaration

Icon LinkfundTransaction

Icon InfoCircle

fundTransaction: boolean

Icon LinkDefined in

types.ts:102 Icon Link


Icon LinkTxParams

Icon InfoCircle

TxParams: Partial&lt;object>

Represents transaction parameters for a contract call.

Icon LinkType declaration

Icon LinkgasLimit

Icon InfoCircle

gasLimit: BigNumberish

Icon Linkmaturity?

Icon InfoCircle

optional maturity: number

Icon LinkmaxFee?

Icon InfoCircle

optional maxFee: BigNumberish

Icon Linktip

Icon InfoCircle

tip: BigNumberish

Icon LinkvariableOutputs

Icon InfoCircle

variableOutputs: number

Icon LinkwitnessLimit?

Icon InfoCircle

optional witnessLimit: BigNumberish

Icon LinkDefined in

types.ts:39 Icon Link

Icon LinkClasses

Icon LinkInterfaces