Skip to content

@fuel-ts/program v0.94.6Docs


@fuel-ts/program

Type Aliases

CallConfig<T>

CallConfig<T>: object

Represents configuration for calling a contract function.

Type Parameters

T = unknown

Type of the function's arguments.

Type declaration

args

args: T

callParameters?

optional callParameters: CallParams

externalAbis

externalAbis: Record<string, JsonAbi>

forward?

optional forward: CoinQuantity

func

func: FunctionFragment

program

program: AbstractProgram

txParameters?

optional txParameters: TxParams

Defined in

types.ts:53


CallParams

CallParams: Partial<object>

Represents call parameters for a contract call.

Type declaration

forward

forward: CoinQuantityLike

gasLimit

gasLimit: BigNumberish

Defined in

types.ts:31


ContractCall

ContractCall: object

Represents a contract call.

Type declaration

amount?

optional amount: BigNumberish

assetId?

optional assetId: BytesLike

contractId

contractId: AbstractAddress

data

data: BytesLike

externalContractsAbis?

optional externalContractsAbis: Record<string, JsonAbi>

fnSelectorBytes

fnSelectorBytes: Uint8Array

gas?

optional gas: BigNumberish

Defined in

types.ts:18


DryRunResult<TReturn>

DryRunResult<TReturn>: object

Type Parameters

TReturn

Type declaration

callResult

readonly callResult: CallResult

functionScopes

readonly functionScopes: InvocationScopeLike[]

gasUsed

readonly gasUsed: BN

isMultiCall

readonly isMultiCall: boolean

value

readonly value: TReturn

Defined in

types.ts:119


FunctionResult<TReturn>

FunctionResult<TReturn>: object

Type Parameters

TReturn

Type declaration

functionScopes

readonly functionScopes: InvocationScopeLike[]

gasUsed

readonly gasUsed: BN

isMultiCall

readonly isMultiCall: boolean

logs

readonly logs: any[]

program

readonly program: AbstractProgram

transactionId

readonly transactionId: string

transactionResponse

readonly transactionResponse: TransactionResponse

transactionResult

readonly transactionResult: TransactionResult<Script>

value

readonly value: TReturn

Defined in

types.ts:106


InvocationScopeLike<T>

InvocationScopeLike<T>: object

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

Type Parameters

T = unknown

Type of the function's arguments.

Type declaration

getCallConfig()

Get the call configuration for this invocation scope.

Returns

CallConfig<T>

{CallConfig<T>} The call configuration.

Defined in

types.ts:91


TransactionCostOptions

TransactionCostOptions: Partial&lt;object>

Represents options for calculating the transaction cost.

Type declaration

fundTransaction

fundTransaction: boolean

Defined in

types.ts:102


TxParams

TxParams: Partial&lt;object>

Represents transaction parameters for a contract call.

Type declaration

gasLimit

gasLimit: BigNumberish

maturity?

optional maturity: number

maxFee?

optional maxFee: BigNumberish

tip

tip: BigNumberish

variableOutputs

variableOutputs: number

witnessLimit?

optional witnessLimit: BigNumberish

Defined in

types.ts:39

Classes

Interfaces