feat: add tx status in mempool #1287
Open
+429
−140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ninabarbakadze
requested review from
ramin,
evan-forbes and
cmwaters
and removed request for
a team and
ramin
rootulp
approved these changes
Jun 6, 2024
Comment on lines
19
to
20
| // Push adds the given raw transaction to the cache and returns true if it was | ||
| // newly added. Otherwise, it returns false. |
There was a problem hiding this comment.
Suggested change
| // Push adds the given raw transaction to the cache and returns true if it was | |
| // newly added. Otherwise, it returns false. | |
| // Push adds the given tx key to the cache and returns true if it was | |
| // newly added. Otherwise, it returns false. |
| @@ -18,14 +18,14 @@ type TxCache interface { | |||
|
|
|||
| // Push adds the given raw transaction to the cache and returns true if it was | |||
| // newly added. Otherwise, it returns false. | |||
| Push(tx types.Tx) bool | |||
| Push(tx types.TxKey) bool | |||
|
|
|||
| // Remove removes the given raw transaction from the cache. | |||
There was a problem hiding this comment.
Suggested change
| // Remove removes the given raw transaction from the cache. | |
| // Remove removes the given tx key from the cache. |
Comment on lines
26
to
27
| // Has reports whether tx is present in the cache. Checking for presence is | ||
| // not treated as an access of the value. |
There was a problem hiding this comment.
Suggested change
| // Has reports whether tx is present in the cache. Checking for presence is | |
| // not treated as an access of the value. | |
| // Has reports whether tx key is present in the cache. Checking for presence is | |
| // not treated as an access of the value. |
Comment on lines
-92
to
91
| key := tx.Key() | ||
| func (c *LRUTxCache) Remove(key types.TxKey) { | ||
| c.RemoveTxByKey(key) | ||
| } |
There was a problem hiding this comment.
[question] Remove is now redundant with RemoveTxByKey. Should we remove one of them?
| wtx := txmp.store.get(txKey) | ||
| if wtx != nil { | ||
| return wtx.tx, true | ||
| } | ||
| return types.Tx{}, false | ||
| } | ||
|
|
||
| // GetTxEvicted returns a bool indicating whether the transaction with | ||
| // the specified key was recently evicted and is currently within the cache |
There was a problem hiding this comment.
Suggested change
| // the specified key was recently evicted and is currently within the cache | |
| // the specified key was recently evicted and is currently within the cache. |
| @@ -183,6 +183,16 @@ func (mem *CListMempool) TxsFront() *clist.CElement { | |||
| return mem.txs.Front() | |||
| } | |||
|
|
|||
| // GetTxByKey currently not enabled in v0 but it is required by the interface. | |||
There was a problem hiding this comment.
Suggested change
| // GetTxByKey currently not enabled in v0 but it is required by the interface. | |
| // GetTxByKey is not supported by the v0 mempool but it is required to satisfy the mempool interface. |
| return nil, false | ||
| } | ||
|
|
||
| // GetTxEvicted currently not enabled in v0 but it is required by the interface. |
There was a problem hiding this comment.
Suggested change
| // GetTxEvicted currently not enabled in v0 but it is required by the interface. | |
| // GetTxEvicted is not supported by the v0 mempool but it is required to satisfy the mempool interface. |
| } | ||
|
|
||
| // GetTxEvicted returns a bool indicating whether the transaction with | ||
| // the specified key was recently evicted and is currently within the cache |
There was a problem hiding this comment.
Suggested change
| // the specified key was recently evicted and is currently within the cache | |
| // the specified key was recently evicted and is currently within the cache. |
|
|
||
| // TxStatus retrieves the status of a transaction given its hash. It returns a ResultTxStatus | ||
| // containing the height and index of the transaction within the block(if committed) | ||
| // or whether the transaction is pending, evicted in the mempool otherwise unknown. |
There was a problem hiding this comment.
Suggested change
| // or whether the transaction is pending, evicted in the mempool otherwise unknown. | |
| // or whether the transaction is pending, evicted from the mempool, or otherwise unknown. |
Comment on lines
+26
to
+42
| return &ctypes.ResultTxStatus{Status: "PENDING"}, nil | ||
| } | ||
|
|
||
| // Check if the tx is evicted | ||
| isEvicted := env.Mempool.GetTxEvicted(txKey) | ||
| if isEvicted { | ||
| return &ctypes.ResultTxStatus{Status: "EVICTED"}, nil | ||
| } | ||
|
|
||
| // Check if the tx has been committed | ||
| txInfo := env.BlockStore.LoadTxInfo(hash) | ||
| if txInfo != nil { | ||
| return &ctypes.ResultTxStatus{Height: txInfo.Height, Index: txInfo.Index, Status: "COMMITTED"}, nil | ||
| } | ||
|
|
||
| // If the tx is not in the mempool, evicted, or committed, return unknown | ||
| return &ctypes.ResultTxStatus{Status: "UNKNOWN"}, nil |
There was a problem hiding this comment.
[question] should we extract consts for PENDING, EVICTED, COMMITTED, and UNKNOWN?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1281
Opens #1381