From 0d20a1456dce359f966df493d2f9468151b984aa Mon Sep 17 00:00:00 2001 From: Aleksandr Bezobchuk Date: Mon, 20 Mar 2023 17:09:14 -0400 Subject: [PATCH] docs: update mempool Select godoc (#15486) --- types/mempool/priority_nonce.go | 3 +++ types/mempool/sender_nonce.go | 3 +++ 2 files changed, 6 insertions(+) diff --git a/types/mempool/priority_nonce.go b/types/mempool/priority_nonce.go index 01010a08f3..401526b7b2 100644 --- a/types/mempool/priority_nonce.go +++ b/types/mempool/priority_nonce.go @@ -337,6 +337,9 @@ func (i *PriorityNonceIterator[C]) 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[C]) 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 index 928d6319bd..c013072dfe 100644 --- 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