@fuel-ts/account v0.94.1 • Docs
Class: TransactionResponse
Represents a response for a transaction.
Constructors
new TransactionResponse()
new TransactionResponse(
tx
,provider
,abis
?):TransactionResponse
Constructor for TransactionResponse
.
Parameters
Parameter | Type | Description |
---|---|---|
tx | string | TransactionRequest | The transaction ID or TransactionRequest. |
provider | Provider | The provider. |
abis ? | JsonAbisFromAllCalls | - |
Returns
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:144
Properties
Property | Type | Description | Defined in |
---|---|---|---|
abis? | JsonAbisFromAllCalls | - | packages/account/src/providers/transaction-response/transaction-response.ts:136 |
gasUsed | BN | Gas used on the transaction | packages/account/src/providers/transaction-response/transaction-response.ts:131 |
id | string | Transaction ID | packages/account/src/providers/transaction-response/transaction-response.ts:127 |
provider | Provider | Current provider | packages/account/src/providers/transaction-response/transaction-response.ts:129 |
Methods
assembleResult()
assembleResult<
TTransactionType
>(contractsAbiMap
?):Promise
<TransactionResult
<TTransactionType
>>
Assembles the result of a transaction by retrieving the transaction summary, decoding logs (if available), and handling transaction failure.
This method can be used to obtain the result of a transaction that has just been submitted or one that has already been processed.
Type Parameters
Type Parameter | Default type | Description |
---|---|---|
TTransactionType | void | The type of the transaction. |
Parameters
Parameter | Type | Description |
---|---|---|
contractsAbiMap ? | AbiMap | The map of contract ABIs. |
Returns
Promise
<TransactionResult
<TTransactionType
>>
- The assembled transaction result.
Throws
If the transaction status is a failure.
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:353
decodeTransaction()
decodeTransaction<
TTransactionType
>(transactionWithReceipts
):Transaction
<TTransactionType
>
Decode the raw payload of the transaction.
Type Parameters
Type Parameter | Default type |
---|---|
TTransactionType | void |
Parameters
Parameter | Type | Description |
---|---|---|
transactionWithReceipts | object | The transaction with receipts object. |
transactionWithReceipts.id | string | - |
transactionWithReceipts.rawPayload | string | - |
transactionWithReceipts.status ? | null | object | object | object | object | - |
Returns
Transaction
<TTransactionType
>
The decoded transaction.
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:272
fetch()
fetch():
Promise
<object
>
Fetch the transaction with receipts from the provider.
Returns
Promise
<object
>
Transaction with receipts query result.
Name | Type | Defined in |
---|---|---|
id | string | packages/account/src/providers/__generated__/operations.ts:1302 |
rawPayload | string | packages/account/src/providers/__generated__/operations.ts:1302 |
status | null | object | object | object | object | packages/account/src/providers/__generated__/operations.ts:1302 |
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:241
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
Type Parameter | Default type |
---|---|
TTransactionType | void |
Parameters
Parameter | Type | Description |
---|---|---|
contractsAbiMap ? | AbiMap | The contracts ABI map. |
Returns
Promise
<TransactionSummary
<TTransactionType
>>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:286
wait()
wait<
TTransactionType
>(contractsAbiMap
?):Promise
<TransactionResult
<TTransactionType
>>
Waits for transaction to complete and returns the result.
Type Parameters
Type Parameter | Default type |
---|---|
TTransactionType | void |
Parameters
Parameter | Type | Description |
---|---|---|
contractsAbiMap ? | AbiMap | The contracts ABI map. |
Returns
Promise
<TransactionResult
<TTransactionType
>>
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:407
waitForResult()
waitForResult<
TTransactionType
>(contractsAbiMap
?):Promise
<TransactionResult
<TTransactionType
>>
Waits for transaction to complete and returns the result.
Type Parameters
Type Parameter | Default type |
---|---|
TTransactionType | void |
Parameters
Parameter | Type |
---|---|
contractsAbiMap ? | AbiMap |
Returns
Promise
<TransactionResult
<TTransactionType
>>
The completed transaction result
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:395
create()
static
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
Parameter | 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:160