docs: update mempool Select godoc (backport #15486) (#15489)

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>
cosmos · Mar 20, 2023 · cfbd108 · cfbd108
1 parent a0497b7
commit cfbd108
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/types/mempool/priority_nonce.go b/types/mempool/priority_nonce.go
@@ -306,6 +306,9 @@ func (i *PriorityNonceIterator) Tx() sdk.Tx {
 //
 // The maxBytes parameter defines the maximum number of bytes of transactions to
 // return.
+//
+// NOTE: It is not safe to use this iterator while removing transactions from
+// the underlying mempool.
 func (mp *PriorityNonceMempool) Select(_ context.Context, _ [][]byte) Iterator {
 	if mp.priorityIndex.Len() == 0 {
 		return nil

diff --git a/types/mempool/sender_nonce.go b/types/mempool/sender_nonce.go
@@ -151,6 +151,9 @@ func (snm *SenderNonceMempool) Insert(_ context.Context, tx sdk.Tx) error {
 
 // Select returns an iterator ordering transactions the mempool with the lowest
 // nonce of a random selected sender first.
+//
+// NOTE: It is not safe to use this iterator while removing transactions from
+// the underlying mempool.
 func (snm *SenderNonceMempool) Select(_ context.Context, _ [][]byte) Iterator {
 	var senders []string