Add new MinTxsInBlock consensus param (#252)

* Add new MinTxsInBlock consensus param * test * exclude nonzero gas tx
sei-protocol · Jan 6, 2025 · 327430d · 327430d
1 parent 57e0107
commit 327430d
Show file tree

Hide file tree

Showing 12 changed files with 426 additions and 321 deletions.
diff --git a/abci/types/types.pb.go b/abci/types/types.pb.go
diff --git a/internal/consensus/mempool_test.go b/internal/consensus/mempool_test.go
@@ -230,7 +230,7 @@ func TestMempoolRmBadTx(t *testing.T) {
 
 		// check for the tx
 		for {
-			txs := assertMempool(t, cs.txNotifier).ReapMaxBytesMaxGas(int64(len(txBytes)), -1)
+			txs := assertMempool(t, cs.txNotifier).ReapMaxBytesMaxGas(int64(len(txBytes)), -1, 0)
 			if len(txs) == 0 {
 				emptyMempoolCh <- struct{}{}
 				return

diff --git a/internal/consensus/replay_stubs.go b/internal/consensus/replay_stubs.go
@@ -33,9 +33,9 @@ func (emptyMempool) Size() int                 { return 0 }
 func (emptyMempool) CheckTx(context.Context, types.Tx, func(*abci.ResponseCheckTx), mempool.TxInfo) error {
 	return nil
 }
-func (emptyMempool) RemoveTxByKey(txKey types.TxKey) error   { return nil }
-func (emptyMempool) ReapMaxBytesMaxGas(_, _ int64) types.Txs { return types.Txs{} }
-func (emptyMempool) ReapMaxTxs(n int) types.Txs              { return types.Txs{} }
+func (emptyMempool) RemoveTxByKey(txKey types.TxKey) error      { return nil }
+func (emptyMempool) ReapMaxBytesMaxGas(_, _, _ int64) types.Txs { return types.Txs{} }
+func (emptyMempool) ReapMaxTxs(n int) types.Txs                 { return types.Txs{} }
 func (emptyMempool) Update(
 	_ context.Context,
 	_ int64,

diff --git a/internal/mempool/mempool.go b/internal/mempool/mempool.go
@@ -431,13 +431,14 @@ func (txmp *TxMempool) Flush() {
 // NOTE:
 //   - Transactions returned are not removed from the mempool transaction
 //     store or indexes.
-func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs {
+func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs {
 	txmp.mtx.Lock()
 	defer txmp.mtx.Unlock()
 
 	var (
-		totalGas  int64
-		totalSize int64
+		totalGas        int64
+		totalSize       int64
+		nonzeroGasTxCnt int64
 	)
 
 	var txs []types.Tx
@@ -453,13 +454,16 @@ func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs {
 		}
 		totalSize += size
 		gas := totalGas + wtx.gasWanted
-		if maxGas > -1 && gas > maxGas {
+		if nonzeroGasTxCnt >= minTxsInBlock && maxGas > -1 && gas > maxGas {
 			return false
 		}
 
 		totalGas = gas
 
 		txs = append(txs, wtx.tx)
+		if wtx.gasWanted > 0 {
+			nonzeroGasTxCnt++
+		}
 		return true
 	})
 

diff --git a/internal/mempool/mempool_test.go b/internal/mempool/mempool_test.go
@@ -384,7 +384,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
 	wg.Add(1)
 	go func() {
 		defer wg.Done()
-		reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50)
+		reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, 0)
 		ensurePrioritized(reapedTxs)
 		require.Equal(t, len(tTxs), txmp.Size())
 		require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -395,7 +395,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
 	wg.Add(1)
 	go func() {
 		defer wg.Done()
-		reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1)
+		reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1, 0)
 		ensurePrioritized(reapedTxs)
 		require.Equal(t, len(tTxs), txmp.Size())
 		require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -407,13 +407,23 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
 	wg.Add(1)
 	go func() {
 		defer wg.Done()
-		reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30)
+		reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30, 0)
 		ensurePrioritized(reapedTxs)
 		require.Equal(t, len(tTxs), txmp.Size())
 		require.Equal(t, int64(5690), txmp.SizeBytes())
 		require.Len(t, reapedTxs, 25)
 	}()
 
+	// Reap by min transactions in block regardless of gas limit.
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+		reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 1, 2)
+		ensurePrioritized(reapedTxs)
+		require.Equal(t, len(tTxs), txmp.Size())
+		require.Len(t, reapedTxs, 2)
+	}()
+
 	wg.Wait()
 }
 

diff --git a/internal/mempool/mocks/mempool.go b/internal/mempool/mocks/mempool.go
diff --git a/internal/mempool/types.go b/internal/mempool/types.go
@@ -48,7 +48,7 @@ type Mempool interface {
 	//
 	// If both maxes are negative, there is no cap on the size of all returned
 	// transactions (~ all available transactions).
-	ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs
+	ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs
 
 	// ReapMaxTxs reaps up to max transactions from the mempool. If max is
 	// negative, there is no cap on the size of all returned transactions

diff --git a/internal/state/execution.go b/internal/state/execution.go
@@ -101,7 +101,7 @@ func (blockExec *BlockExecutor) CreateProposalBlock(
 	// Fetch a limited amount of valid txs
 	maxDataBytes := types.MaxDataBytes(maxBytes, evSize, state.Validators.Size())
 
-	txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGas)
+	txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGas, state.ConsensusParams.Block.MinTxsInBlock)
 	commit := lastExtCommit.ToCommit()
 	block := state.MakeBlock(height, txs, commit, evidence, proposerAddr)
 	rpp, err := blockExec.appClient.PrepareProposal(

diff --git a/proto/tendermint/abci/types.proto b/proto/tendermint/abci/types.proto
@@ -490,6 +490,8 @@ message BlockParams {
   int64 max_bytes = 1;
   // Note: must be greater or equal to -1
   int64 max_gas = 2;
+  // Minimum txs to include in a block regardless of gas limit
+  int64 min_txs_in_block = 3;
 }
 
 message ConsensusParams {

diff --git a/proto/tendermint/types/params.pb.go b/proto/tendermint/types/params.pb.go
diff --git a/proto/tendermint/types/params.proto b/proto/tendermint/types/params.proto
@@ -28,6 +28,8 @@ message BlockParams {
   // Max gas per block.
   // Note: must be greater or equal to -1
   int64 max_gas = 2;
+  // Minimum txs to include in a block regardless of gas limit
+  int64 min_txs_in_block = 3;
 }
 
 // EvidenceParams determine how we handle evidence of malfeasance.

diff --git a/types/params.go b/types/params.go
@@ -57,8 +57,9 @@ type HashedParams struct {
 // BlockParams define limits on the block size and gas plus minimum time
 // between blocks.
 type BlockParams struct {
-	MaxBytes int64 `json:"max_bytes,string"`
-	MaxGas   int64 `json:"max_gas,string"`
+	MaxBytes      int64 `json:"max_bytes,string"`
+	MaxGas        int64 `json:"max_gas,string"`
+	MinTxsInBlock int64 `json:"min_txs_in_block,string"`
 }
 
 // EvidenceParams determine how we handle evidence of malfeasance.
@@ -132,7 +133,8 @@ func DefaultBlockParams() BlockParams {
 		MaxBytes: 22020096, // 21MB
 		// Default, can be increased and tuned as needed
 		// match sei-devnet-3 and atlantic-2 current values
-		MaxGas:   100000000,
+		MaxGas:        100000000,
+		MinTxsInBlock: 0,
 	}
 }
 
@@ -286,6 +288,11 @@ func (params ConsensusParams) ValidateConsensusParams() error {
 			params.Block.MaxGas)
 	}
 
+	if params.Block.MinTxsInBlock < 0 {
+		return fmt.Errorf("block.MinTxsInBlock must be non-negative. Got %d",
+			params.Block.MinTxsInBlock)
+	}
+
 	if params.Evidence.MaxAgeNumBlocks <= 0 {
 		return fmt.Errorf("evidence.MaxAgeNumBlocks must be greater than 0. Got %d",
 			params.Evidence.MaxAgeNumBlocks)
@@ -423,6 +430,7 @@ func (params ConsensusParams) UpdateConsensusParams(params2 *tmproto.ConsensusPa
 	if params2.Block != nil {
 		res.Block.MaxBytes = params2.Block.MaxBytes
 		res.Block.MaxGas = params2.Block.MaxGas
+		res.Block.MinTxsInBlock = params2.Block.MinTxsInBlock
 	}
 	if params2.Evidence != nil {
 		res.Evidence.MaxAgeNumBlocks = params2.Evidence.MaxAgeNumBlocks
@@ -473,8 +481,9 @@ func (params ConsensusParams) UpdateConsensusParams(params2 *tmproto.ConsensusPa
 func (params *ConsensusParams) ToProto() tmproto.ConsensusParams {
 	return tmproto.ConsensusParams{
 		Block: &tmproto.BlockParams{
-			MaxBytes: params.Block.MaxBytes,
-			MaxGas:   params.Block.MaxGas,
+			MaxBytes:      params.Block.MaxBytes,
+			MaxGas:        params.Block.MaxGas,
+			MinTxsInBlock: params.Block.MinTxsInBlock,
 		},
 		Evidence: &tmproto.EvidenceParams{
 			MaxAgeNumBlocks: params.Evidence.MaxAgeNumBlocks,
@@ -509,8 +518,9 @@ func (params *ConsensusParams) ToProto() tmproto.ConsensusParams {
 func ConsensusParamsFromProto(pbParams tmproto.ConsensusParams) ConsensusParams {
 	c := ConsensusParams{
 		Block: BlockParams{
-			MaxBytes: pbParams.Block.MaxBytes,
-			MaxGas:   pbParams.Block.MaxGas,
+			MaxBytes:      pbParams.Block.MaxBytes,
+			MaxGas:        pbParams.Block.MaxGas,
+			MinTxsInBlock: pbParams.Block.MinTxsInBlock,
 		},
 		Evidence: EvidenceParams{
 			MaxAgeNumBlocks: pbParams.Evidence.MaxAgeNumBlocks,