⌘K

Icon SunFilledIcon MoonStars
FunctionInvocationResult

Icon LinkClass: FunctionInvocationResult<T, TTransactionType>

@fuel-ts/program .FunctionInvocationResult

Represents the result of a function invocation with transaction details.

Icon LinkType parameters

NameTypeDescription
TanyThe type of the returned value.
TTransactionTypevoidThe type of the transaction.

Icon LinkHierarchy

Icon LinkConstructors

Icon Linkconstructor

new FunctionInvocationResult<T, TTransactionType>(funcScopes, transactionResponse, transactionResult, program, isMultiCall): FunctionInvocationResult <T, TTransactionType>

Constructs an instance of FunctionInvocationResult.

Icon LinkType parameters

NameType
Tany
TTransactionTypevoid

Icon LinkParameters

NameTypeDescription
funcScopesInvocationScopeLike | InvocationScopeLike []The function scopes.
transactionResponseTransactionResponse The transaction response.
transactionResultTransactionResult<TTransactionType>The transaction result.
programAbstractProgramThe program.
isMultiCallbooleanWhether it's a multi-call.

Icon LinkReturns

FunctionInvocationResult <T, TTransactionType>

Icon LinkOverrides

InvocationResult .constructor

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:144 Icon Link

Icon LinkProperties

Icon LinkfunctionScopes

Readonly functionScopes: InvocationScopeLike []

Icon LinkInherited from

InvocationResult .functionScopes

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:40 Icon Link


Icon LinkgasUsed

Readonly gasUsed: BN

Icon LinkInherited from

InvocationResult .gasUsed

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:42 Icon Link


Icon LinkisMultiCall

Readonly isMultiCall: boolean

Icon LinkInherited from

InvocationResult .isMultiCall

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:41 Icon Link


Icon Linklogs

Readonly logs: any[]

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:133 Icon Link


Icon Linkprogram

Readonly program: AbstractProgram

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:132 Icon Link


Icon LinktransactionId

Readonly transactionId: string

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:129 Icon Link


Icon LinktransactionResponse

Readonly transactionResponse: TransactionResponse

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:130 Icon Link


Icon LinktransactionResult

Readonly transactionResult: TransactionResult<TTransactionType>

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:131 Icon Link


Icon Linkvalue

Readonly value: T

Icon LinkInherited from

InvocationResult .value

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:43 Icon Link

Icon LinkMethods

Icon LinkgetDecodedLogs

getDecodedLogs(receipts): unknown[]

Decodes the logs from the receipts.

Icon LinkParameters

NameTypeDescription
receiptsTransactionResultReceipt[]The transaction result receipts.

Icon LinkReturns

unknown[]

The decoded logs.

Icon LinkInherited from

InvocationResult .getDecodedLogs

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:108 Icon Link


Icon LinkgetDecodedValue

getDecodedValue(callResult): T

Decodes the value from the call result.

Icon LinkParameters

NameTypeDescription
callResultCallResult The call result.

Icon LinkReturns

T

The decoded value.

Icon LinkInherited from

InvocationResult .getDecodedValue

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:82 Icon Link


Icon Linkbuild

build<T, TTransactionType>(funcScope, transactionResponse, isMultiCall, program): Promise<FunctionInvocationResult <T, TTransactionType>>

Builds an instance of FunctionInvocationResult.

Icon LinkType parameters

NameType
TT
TTransactionTypevoid

Icon LinkParameters

NameTypeDescription
funcScopeInvocationScopeLike | InvocationScopeLike []The function scope.
transactionResponseTransactionResponse The transaction response.
isMultiCallbooleanWhether it's a multi-call.
programAbstractProgramThe program.

Icon LinkReturns

Promise<FunctionInvocationResult <T, TTransactionType>>

The function invocation result.

Icon LinkDefined in

packages/program/src/functions/invocation-results.ts:168 Icon Link