Class: TransactionResponse
@fuel-ts/account.TransactionResponse
Represents a response for a transaction.
Constructors
constructor
• new TransactionResponse(id
, provider
, abis?
): TransactionResponse
Constructor for TransactionResponse
.
Parameters
Name | Type | Description |
---|---|---|
id | string | The transaction ID. |
provider | Provider | The provider. |
abis? | JsonAbisFromAllCalls | - |
Returns
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:100
Properties
abis
• Optional
abis: JsonAbisFromAllCalls
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:92
gasUsed
• gasUsed: BN
Gas used on the transaction
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:88
gqlTransaction
• Optional
gqlTransaction: Object
The graphql Transaction with receipts object.
Type declaration
Name | Type |
---|---|
__typename | "Transaction" |
gasPrice? | null | string |
id | string |
rawPayload | string |
receipts? | null | { __typename : "Receipt" ; amount? : null | string ; assetId? : null | string ; contract? : null | { __typename : "Contract" ; id : string } ; contractId? : null | string ; data? : null | string ; digest? : null | string ; gas? : null | string ; gasUsed? : 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 | { __typename : "Contract" ; id : string } ; toAddress? : null | string ; val? : null | string }[] |
status? | null | { __typename : "FailureStatus" ; block : { __typename : "Block" ; id : string } ; reason : string ; time : string ; type : "FailureStatus" } | { __typename : "SqueezedOutStatus" ; reason : string ; type : "SqueezedOutStatus" } | { __typename : "SubmittedStatus" ; time : string ; type : "SubmittedStatus" } | { __typename : "SuccessStatus" ; block : { __typename : "Block" ; id : string } ; programState? : null | { __typename : "ProgramState" ; data : string ; returnType : GqlReturnType } ; time : string ; type : "SuccessStatus" } |
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:90
id
• id: string
Transaction ID
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:84
provider
• provider: Provider
Current provider
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:86
Methods
decodeTransaction
▸ decodeTransaction<TTransactionType
>(transactionWithReceipts
): Transaction
<TTransactionType
>
Decode the raw payload of the transaction.
Type parameters
Name | Type |
---|---|
TTransactionType | void |
Parameters
Name | Type | Description |
---|---|---|
transactionWithReceipts | Object | The transaction with receipts object. |
transactionWithReceipts.__typename | "Transaction" | - |
transactionWithReceipts.gasPrice? | null | string | - |
transactionWithReceipts.id | string | - |
transactionWithReceipts.rawPayload | string | - |
transactionWithReceipts.receipts? | null | { __typename : "Receipt" ; amount? : null | string ; assetId? : null | string ; contract? : null | { __typename : "Contract" ; id : string } ; contractId? : null | string ; data? : null | string ; digest? : null | string ; gas? : null | string ; gasUsed? : 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 | { __typename : "Contract" ; id : string } ; toAddress? : null | string ; val? : null | string }[] | - |
transactionWithReceipts.status? | null | { __typename : "FailureStatus" ; block : { __typename : "Block" ; id : string } ; reason : string ; time : string ; type : "FailureStatus" } | { __typename : "SqueezedOutStatus" ; reason : string ; type : "SqueezedOutStatus" } | { __typename : "SubmittedStatus" ; time : string ; type : "SubmittedStatus" } | { __typename : "SuccessStatus" ; block : { __typename : "Block" ; id : string } ; programState? : null | { __typename : "ProgramState" ; data : string ; returnType : GqlReturnType } ; time : string ; type : "SuccessStatus" } | - |
Returns
Transaction
<TTransactionType
>
The decoded transaction.
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:159
fetch
▸ fetch(): Promise
<{ __typename
: "Transaction"
; gasPrice?
: null
| string
; id
: string
; rawPayload
: string
; receipts?
: null
| { __typename
: "Receipt"
; amount?
: null
| string
; assetId?
: null
| string
; contract?
: null
| { __typename
: "Contract"
; id
: string
} ; contractId?
: null
| string
; data?
: null
| string
; digest?
: null
| string
; gas?
: null
| string
; gasUsed?
: 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
| { __typename
: "Contract"
; id
: string
} ; toAddress?
: null
| string
; val?
: null
| string
}[] ; status?
: null
| { __typename
: "FailureStatus"
; block
: { __typename
: "Block"
; id
: string
} ; reason
: string
; time
: string
; type
: "FailureStatus"
} | { __typename
: "SqueezedOutStatus"
; reason
: string
; type
: "SqueezedOutStatus"
} | { __typename
: "SubmittedStatus"
; time
: string
; type
: "SubmittedStatus"
} | { __typename
: "SuccessStatus"
; block
: { __typename
: "Block"
; id
: string
} ; programState?
: null
| { __typename
: "ProgramState"
; data
: string
; returnType
: GqlReturnType
} ; time
: string
; type
: "SuccessStatus"
} }>
Fetch the transaction with receipts from the provider.
Returns
Promise
<{ __typename
: "Transaction"
; gasPrice?
: null
| string
; id
: string
; rawPayload
: string
; receipts?
: null
| { __typename
: "Receipt"
; amount?
: null
| string
; assetId?
: null
| string
; contract?
: null
| { __typename
: "Contract"
; id
: string
} ; contractId?
: null
| string
; data?
: null
| string
; digest?
: null
| string
; gas?
: null
| string
; gasUsed?
: 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
| { __typename
: "Contract"
; id
: string
} ; toAddress?
: null
| string
; val?
: null
| string
}[] ; status?
: null
| { __typename
: "FailureStatus"
; block
: { __typename
: "Block"
; id
: string
} ; reason
: string
; time
: string
; type
: "FailureStatus"
} | { __typename
: "SqueezedOutStatus"
; reason
: string
; type
: "SqueezedOutStatus"
} | { __typename
: "SubmittedStatus"
; time
: string
; type
: "SubmittedStatus"
} | { __typename
: "SuccessStatus"
; block
: { __typename
: "Block"
; id
: string
} ; programState?
: null
| { __typename
: "ProgramState"
; data
: string
; returnType
: GqlReturnType
} ; time
: string
; type
: "SuccessStatus"
} }>
Transaction with receipts query result.
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:129
getTransactionSummary
▸ getTransactionSummary<TTransactionType
>(contractsAbiMap?
): Promise
<TransactionSummary
<TTransactionType
>>
Retrieves the TransactionSummary. If the gqlTransaction
is not set, it will fetch it from the provider
Type parameters
Name | Type |
---|---|
TTransactionType | void |
Parameters
Name | Type | Description |
---|---|---|
contractsAbiMap? | AbiMap | The contracts ABI map. |
Returns
Promise
<TransactionSummary
<TTransactionType
>>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:173
wait
▸ wait<TTransactionType
>(contractsAbiMap?
): Promise
<TransactionResult
<TTransactionType
>>
Waits for transaction to complete and returns the result.
Type parameters
Name | Type |
---|---|
TTransactionType | void |
Parameters
Name | Type | Description |
---|---|---|
contractsAbiMap? | AbiMap | The contracts ABI map. |
Returns
Promise
<TransactionResult
<TTransactionType
>>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:282
waitForResult
▸ waitForResult<TTransactionType
>(contractsAbiMap?
): Promise
<TransactionResult
<TTransactionType
>>
Waits for transaction to complete and returns the result.
Type parameters
Name | Type |
---|---|
TTransactionType | void |
Parameters
Name | Type |
---|---|
contractsAbiMap? | AbiMap |
Returns
Promise
<TransactionResult
<TTransactionType
>>
The completed transaction result
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:237
waitForStatusChange
▸ waitForStatusChange(): Promise
<void
>
Returns
Promise
<void
>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:207
create
▸ 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.
Parameters
Name | Type | Description |
---|---|---|
id | string | The transaction ID. |
provider | Provider | The provider. |
abis? | JsonAbisFromAllCalls | - |
Returns
Promise
<TransactionResponse
>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:114