QiTransactionResponse
A QiTransactionResponse includes all properties about a Qi transaction that was sent to the network, which may or may not be included in a block.
The TransactionResponse.isMined | TransactionResponse.isMined can be used to check if the transaction has
been mined as well as type guard that the otherwise possibly null properties are defined.
Implements
QiTransactionLikeQiTransactionResponseParams
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
blockHash | readonly | null | string | The blockHash of the block that this transaction was included in. This is null for pending transactions. |
blockNumber | readonly | null | number | The block number of the block that this transaction was included in. This is null for pending transactions. |
chainId | readonly | bigint | The chain ID. |
hash | readonly | string | The transaction hash. |
index | readonly | bigint | The index within the block that this transaction resides at. |
provider | readonly | Provider | The provider this is connected to, which will influence how its methods will resolve its async inspection methods. |
signature | readonly | string | The signature. |
type | readonly | number | The EIP-2718 transaction envelope type. This is 0 for legacytransactions types. |
Methods
confirmations()
Resolve to the number of confirmations this transaction has.
Returns
Promise<number>
A promise resolving to the number of confirmations.
Source
getBlock()
Resolves to the Block that this transaction was included in.
This will return null if the transaction has not been included yet.
Parameters
| Parameter | Type | Description |
|---|---|---|
shard | Shard | The shard to fetch the block from. |
Returns
Promise<null | Block>
A promise resolving to the block or null if not found.
Source
getTransaction()
Resolves to this transaction being re-requested from the provider. This can be used if you have an unmined transaction and wish to get an up-to-date populated instance.
Returns
Promise<null | QiTransactionResponse>
A promise resolving to the transaction, or null if not found.
Throws
If the transaction is not found.
Source
isMined()
Returns true if this transaction has been included.
This is effective only as of the time the TransactionResponse was instantiated. To get up-to-date information, use getTransaction.
This provides a Type Guard that this transaction will have non-null property values for properties that are null for unmined transactions.
Returns
this is QiMinedTransactionResponse
True if the transaction has been mined or false otherwise.
Source
removedEvent()
Returns a filter which can be used to listen for orphan events that evict this transaction.
Returns
The orphan filter.
Source
reorderedEvent()
Returns a filter which can be used to listen for orphan events that re-order this event against other.
Parameters
| Parameter | Type | Description |
|---|---|---|
other? | TransactionResponse | The other transaction to compare against. |
Returns
The orphan filter.
Source
replaceableTransaction()
Returns a new TransactionResponse instance which has the ability to detect (and throw an error) if the
transaction is replaced, which will begin scanning at startBlock.
This should generally not be used by developers and is intended primarily for internal use. Setting an incorrect
startBlock can have devastating performance consequences if used incorrectly.
Parameters
| Parameter | Type | Description |
|---|---|---|
startBlock | number | The block number to start scanning for replacements. |
Returns
The replaceable transaction.
Source
toJSON()
Returns a JSON-compatible representation of this transaction.
Returns
any
Source
Was this page helpful?