Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Docs /
Fuels Ts /
Account /
TransactionResponse

Icon LinkClass: TransactionResponse

@fuel-ts/account .TransactionResponse

Represents a response for a transaction.

Icon LinkConstructors

Icon Linkconstructor

• new TransactionResponse(id, provider, abis?): TransactionResponse

Constructor for TransactionResponse.

Icon LinkParameters

NameTypeDescription
idstringThe transaction ID.
providerProvider The provider.
abis?JsonAbisFromAllCalls -

Icon LinkReturns

TransactionResponse

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:101 Icon Link

Icon LinkProperties

Icon Linkabis

• Optional abis: JsonAbisFromAllCalls

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:93 Icon Link

Icon LinkgasUsed

• gasUsed: BN

Gas used on the transaction

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:89 Icon Link

Icon LinkgqlTransaction

• Optional gqlTransaction: Object

The graphql Transaction with receipts object.

Icon LinkType declaration

NameType
idstring
rawPayloadstring
status?null | { block: { id: string } ; reason: string ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "FailureStatus" } | { reason: string ; type: "SqueezedOutStatus" } | { time: string ; type: "SubmittedStatus" } | { block: { id: string } ; programState?: null | { data: string ; returnType: GqlReturnType } ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "SuccessStatus" }

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:91 Icon Link

Icon Linkid

• id: string

Transaction ID

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:85 Icon Link

Icon Linkprovider

• provider: Provider

Current provider

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:87 Icon Link

Icon LinkMethods

Icon LinkdecodeTransaction

▸ decodeTransaction<TTransactionType>(transactionWithReceipts): Transaction<TTransactionType>

Decode the raw payload of the transaction.

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameTypeDescription
transactionWithReceiptsObjectThe transaction with receipts object.
transactionWithReceipts.idstring-
transactionWithReceipts.rawPayloadstring-
transactionWithReceipts.status?null | { block: { id: string } ; reason: string ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "FailureStatus" } | { reason: string ; type: "SqueezedOutStatus" } | { time: string ; type: "SubmittedStatus" } | { block: { id: string } ; programState?: null | { data: string ; returnType: GqlReturnType } ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "SuccessStatus" }-

Icon LinkReturns

Transaction<TTransactionType>

The decoded transaction.

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:160 Icon Link

Icon Linkfetch

▸ fetch(): Promise<{ id: string ; rawPayload: string ; status?: null | { block: { id: string } ; reason: string ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "FailureStatus" } | { reason: string ; type: "SqueezedOutStatus" } | { time: string ; type: "SubmittedStatus" } | { block: { id: string } ; programState?: null | { data: string ; returnType: GqlReturnType } ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "SuccessStatus" } }>

Fetch the transaction with receipts from the provider.

Icon LinkReturns

Promise<{ id: string ; rawPayload: string ; status?: null | { block: { id: string } ; reason: string ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "FailureStatus" } | { reason: string ; type: "SqueezedOutStatus" } | { time: string ; type: "SubmittedStatus" } | { block: { id: string } ; programState?: null | { data: string ; returnType: GqlReturnType } ; receipts: { amount?: null | string ; assetId?: null | string ; contractId?: null | string ; data?: null | string ; digest?: null | string ; gas?: null | string ; gasUsed?: null | string ; id?: null | string ; is?: null | string ; len?: null | string ; nonce?: null | string ; param1?: null | string ; param2?: null | string ; pc?: null | string ; ptr?: null | string ; ra?: null | string ; rb?: null | string ; rc?: null | string ; rd?: null | string ; reason?: null | string ; receiptType: GqlReceiptType ; recipient?: null | string ; result?: null | string ; sender?: null | string ; subId?: null | string ; to?: null | string ; toAddress?: null | string ; val?: null | string }[] ; time: string ; totalFee: string ; totalGas: string ; type: "SuccessStatus" } }>

Transaction with receipts query result.

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:130 Icon Link

Icon LinkgetTransactionSummary

▸ getTransactionSummary<TTransactionType>(contractsAbiMap?): Promise<TransactionSummary <TTransactionType>>

Retrieves the TransactionSummary. If the gqlTransaction is not set, it will fetch it from the provider

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameTypeDescription
contractsAbiMap?AbiMap The contracts ABI map.

Icon LinkReturns

Promise<TransactionSummary <TTransactionType>>

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:174 Icon Link

Icon Linkwait

▸ wait<TTransactionType>(contractsAbiMap?): Promise<TransactionResult<TTransactionType>>

Waits for transaction to complete and returns the result.

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameTypeDescription
contractsAbiMap?AbiMap The contracts ABI map.

Icon LinkReturns

Promise<TransactionResult<TTransactionType>>

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:293 Icon Link

Icon LinkwaitForResult

▸ waitForResult<TTransactionType>(contractsAbiMap?): Promise<TransactionResult<TTransactionType>>

Waits for transaction to complete and returns the result.

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameType
contractsAbiMap?AbiMap

Icon LinkReturns

Promise<TransactionResult<TTransactionType>>

The completed transaction result

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:249 Icon Link

Icon LinkwaitForStatusChange

▸ waitForStatusChange(): Promise<void>

Icon LinkReturns

Promise<void>

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:219 Icon Link

Icon Linkcreate

▸ create(id, provider, abis?): Promise<TransactionResponse >

Async constructor for TransactionResponse. This method can be used to create an instance of TransactionResponse and wait for the transaction to be fetched from the chain, ensuring that the gqlTransaction property is set.

Icon LinkParameters

NameTypeDescription
idstringThe transaction ID.
providerProvider The provider.
abis?JsonAbisFromAllCalls -

Icon LinkReturns

Promise<TransactionResponse >

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:115 Icon Link