fix: nil pointer ref priority nonce mempool iterator (backport #17668) (

#17675) Co-authored-by: Bala Murali Krishna Komatireddy <[email protected]> Co-authored-by: Julien Robert <[email protected]>
cosmos · Sep 11, 2023 · 55aa507 · 55aa507
1 parent c79964c
commit 55aa507
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Bug Fixes
 
 * (config) [#17649](https://github.com/cosmos/cosmos-sdk/pull/17649) Fix `mempool.max-txs` configuration is invalid in `app.config`.
+* (mempool) [#17668](https://github.com/cosmos/cosmos-sdk/pull/17668) Fix `PriorityNonceIterator.Next()` nil pointer ref for min priority at the end of iteration.
 
 ## [v0.47.5](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.5) - 2023-09-01
 

diff --git a/types/mempool/priority_nonce.go b/types/mempool/priority_nonce.go
@@ -283,7 +283,7 @@ func (i *PriorityNonceIterator) Next() Iterator {
 	// priority in the pool.
 	if key.priority < i.nextPriority {
 		return i.iteratePriority()
-	} else if key.priority == i.nextPriority {
+	} else if key.priority == i.nextPriority && i.priorityNode.Next() != nil {
 		// Weight is incorporated into the priority index key only (not sender index)
 		// so we must fetch it here from the scores map.
 		weight := i.mempool.scores[txMeta{nonce: key.nonce, sender: key.sender}].weight

diff --git a/types/mempool/priority_nonce_test.go b/types/mempool/priority_nonce_test.go
@@ -258,6 +258,62 @@ func (s *MempoolTestSuite) TestPriorityNonceTxOrder() {
 	}
 }
 
+func (s *MempoolTestSuite) TestIterator() {
+	t := s.T()
+	ctx := sdk.NewContext(nil, cmtproto.Header{}, false, log.NewNopLogger())
+	accounts := simtypes.RandomAccounts(rand.New(rand.NewSource(0)), 2)
+	sa := accounts[0].Address
+	sb := accounts[1].Address
+
+	tests := []struct {
+		txs  []txSpec
+		fail bool
+	}{
+		{
+			txs: []txSpec{
+				{p: 20, n: 1, a: sa},
+				{p: 15, n: 1, a: sb},
+				{p: 6, n: 2, a: sa},
+				{p: 21, n: 4, a: sa},
+				{p: 8, n: 2, a: sb},
+			},
+		},
+		{
+			txs: []txSpec{
+				{p: 20, n: 1, a: sa},
+				{p: 15, n: 1, a: sb},
+				{p: 6, n: 2, a: sa},
+				{p: 21, n: 4, a: sa},
+				{p: math.MinInt64, n: 2, a: sb},
+			},
+		},
+	}
+
+	for i, tt := range tests {
+		t.Run(fmt.Sprintf("case %d", i), func(t *testing.T) {
+			pool := mempool.DefaultPriorityMempool()
+
+			// create test txs and insert into mempool
+			for i, ts := range tt.txs {
+				tx := testTx{id: i, priority: int64(ts.p), nonce: uint64(ts.n), address: ts.a}
+				c := ctx.WithPriority(tx.priority)
+				err := pool.Insert(c, tx)
+				require.NoError(t, err)
+			}
+
+			// iterate through txs
+			iterator := pool.Select(ctx, nil)
+			for iterator != nil {
+				tx := iterator.Tx().(testTx)
+				require.Equal(t, tt.txs[tx.id].p, int(tx.priority))
+				require.Equal(t, tt.txs[tx.id].n, int(tx.nonce))
+				require.Equal(t, tt.txs[tx.id].a, tx.address)
+				iterator = iterator.Next()
+			}
+		})
+	}
+}
+
 func (s *MempoolTestSuite) TestPriorityTies() {
 	ctx := sdk.NewContext(nil, cmtproto.Header{}, false, log.NewNopLogger())
 	accounts := simtypes.RandomAccounts(rand.New(rand.NewSource(0)), 3)