Skip to content

Commit 327430d

Browse files
codchencodchen
authored
Add new MinTxsInBlock consensus param (#252)
* Add new MinTxsInBlock consensus param * test * exclude nonzero gas tx
1 parent 57e0107 commit 327430d

File tree

12 files changed

+426
-321
lines changed

12 files changed

+426
-321
lines changed

‎abci/types/types.pb.go

+288-251
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/consensus/mempool_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ func TestMempoolRmBadTx(t *testing.T) {
230230

231231
// check for the tx
232232
for {
233-
txs := assertMempool(t, cs.txNotifier).ReapMaxBytesMaxGas(int64(len(txBytes)), -1)
233+
txs := assertMempool(t, cs.txNotifier).ReapMaxBytesMaxGas(int64(len(txBytes)), -1, 0)
234234
if len(txs) == 0 {
235235
emptyMempoolCh <- struct{}{}
236236
return

‎internal/consensus/replay_stubs.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ func (emptyMempool) Size() int { return 0 }
3333
func (emptyMempool) CheckTx(context.Context, types.Tx, func(*abci.ResponseCheckTx), mempool.TxInfo) error {
3434
return nil
3535
}
36-
func (emptyMempool) RemoveTxByKey(txKey types.TxKey) error { return nil }
37-
func (emptyMempool) ReapMaxBytesMaxGas(_, _ int64) types.Txs { return types.Txs{} }
38-
func (emptyMempool) ReapMaxTxs(n int) types.Txs { return types.Txs{} }
36+
func (emptyMempool) RemoveTxByKey(txKey types.TxKey) error { return nil }
37+
func (emptyMempool) ReapMaxBytesMaxGas(_, _, _ int64) types.Txs { return types.Txs{} }
38+
func (emptyMempool) ReapMaxTxs(n int) types.Txs { return types.Txs{} }
3939
func (emptyMempool) Update(
4040
_ context.Context,
4141
_ int64,

‎internal/mempool/mempool.go

+8-4
Original file line numberDiff line numberDiff line change
@@ -431,13 +431,14 @@ func (txmp *TxMempool) Flush() {
431431
// NOTE:
432432
// - Transactions returned are not removed from the mempool transaction
433433
// store or indexes.
434-
func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs {
434+
func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs {
435435
txmp.mtx.Lock()
436436
defer txmp.mtx.Unlock()
437437

438438
var (
439-
totalGas int64
440-
totalSize int64
439+
totalGas int64
440+
totalSize int64
441+
nonzeroGasTxCnt int64
441442
)
442443

443444
var txs []types.Tx
@@ -453,13 +454,16 @@ func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs {
453454
}
454455
totalSize += size
455456
gas := totalGas + wtx.gasWanted
456-
if maxGas > -1 && gas > maxGas {
457+
if nonzeroGasTxCnt >= minTxsInBlock && maxGas > -1 && gas > maxGas {
457458
return false
458459
}
459460

460461
totalGas = gas
461462

462463
txs = append(txs, wtx.tx)
464+
if wtx.gasWanted > 0 {
465+
nonzeroGasTxCnt++
466+
}
463467
return true
464468
})
465469

‎internal/mempool/mempool_test.go

+13-3
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
384384
wg.Add(1)
385385
go func() {
386386
defer wg.Done()
387-
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50)
387+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, 0)
388388
ensurePrioritized(reapedTxs)
389389
require.Equal(t, len(tTxs), txmp.Size())
390390
require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -395,7 +395,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
395395
wg.Add(1)
396396
go func() {
397397
defer wg.Done()
398-
reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1)
398+
reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1, 0)
399399
ensurePrioritized(reapedTxs)
400400
require.Equal(t, len(tTxs), txmp.Size())
401401
require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -407,13 +407,23 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
407407
wg.Add(1)
408408
go func() {
409409
defer wg.Done()
410-
reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30)
410+
reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30, 0)
411411
ensurePrioritized(reapedTxs)
412412
require.Equal(t, len(tTxs), txmp.Size())
413413
require.Equal(t, int64(5690), txmp.SizeBytes())
414414
require.Len(t, reapedTxs, 25)
415415
}()
416416

417+
// Reap by min transactions in block regardless of gas limit.
418+
wg.Add(1)
419+
go func() {
420+
defer wg.Done()
421+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 1, 2)
422+
ensurePrioritized(reapedTxs)
423+
require.Equal(t, len(tTxs), txmp.Size())
424+
require.Len(t, reapedTxs, 2)
425+
}()
426+
417427
wg.Wait()
418428
}
419429

‎internal/mempool/mocks/mempool.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/mempool/types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ type Mempool interface {
4848
//
4949
// If both maxes are negative, there is no cap on the size of all returned
5050
// transactions (~ all available transactions).
51-
ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs
51+
ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs
5252

5353
// ReapMaxTxs reaps up to max transactions from the mempool. If max is
5454
// negative, there is no cap on the size of all returned transactions

‎internal/state/execution.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ func (blockExec *BlockExecutor) CreateProposalBlock(
101101
// Fetch a limited amount of valid txs
102102
maxDataBytes := types.MaxDataBytes(maxBytes, evSize, state.Validators.Size())
103103

104-
txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGas)
104+
txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGas, state.ConsensusParams.Block.MinTxsInBlock)
105105
commit := lastExtCommit.ToCommit()
106106
block := state.MakeBlock(height, txs, commit, evidence, proposerAddr)
107107
rpp, err := blockExec.appClient.PrepareProposal(

‎proto/tendermint/abci/types.proto

+2
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,8 @@ message BlockParams {
490490
int64 max_bytes = 1;
491491
// Note: must be greater or equal to -1
492492
int64 max_gas = 2;
493+
// Minimum txs to include in a block regardless of gas limit
494+
int64 min_txs_in_block = 3;
493495
}
494496

495497
message ConsensusParams {

‎proto/tendermint/types/params.pb.go

+89-49
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎proto/tendermint/types/params.proto

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ message BlockParams {
2828
// Max gas per block.
2929
// Note: must be greater or equal to -1
3030
int64 max_gas = 2;
31+
// Minimum txs to include in a block regardless of gas limit
32+
int64 min_txs_in_block = 3;
3133
}
3234

3335
// EvidenceParams determine how we handle evidence of malfeasance.

‎types/params.go

+17-7
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ type HashedParams struct {
5757
// BlockParams define limits on the block size and gas plus minimum time
5858
// between blocks.
5959
type BlockParams struct {
60-
MaxBytes int64 `json:"max_bytes,string"`
61-
MaxGas int64 `json:"max_gas,string"`
60+
MaxBytes int64 `json:"max_bytes,string"`
61+
MaxGas int64 `json:"max_gas,string"`
62+
MinTxsInBlock int64 `json:"min_txs_in_block,string"`
6263
}
6364

6465
// EvidenceParams determine how we handle evidence of malfeasance.
@@ -132,7 +133,8 @@ func DefaultBlockParams() BlockParams {
132133
MaxBytes: 22020096, // 21MB
133134
// Default, can be increased and tuned as needed
134135
// match sei-devnet-3 and atlantic-2 current values
135-
MaxGas: 100000000,
136+
MaxGas: 100000000,
137+
MinTxsInBlock: 0,
136138
}
137139
}
138140

@@ -286,6 +288,11 @@ func (params ConsensusParams) ValidateConsensusParams() error {
286288
params.Block.MaxGas)
287289
}
288290

291+
if params.Block.MinTxsInBlock < 0 {
292+
return fmt.Errorf("block.MinTxsInBlock must be non-negative. Got %d",
293+
params.Block.MinTxsInBlock)
294+
}
295+
289296
if params.Evidence.MaxAgeNumBlocks <= 0 {
290297
return fmt.Errorf("evidence.MaxAgeNumBlocks must be greater than 0. Got %d",
291298
params.Evidence.MaxAgeNumBlocks)
@@ -423,6 +430,7 @@ func (params ConsensusParams) UpdateConsensusParams(params2 *tmproto.ConsensusPa
423430
if params2.Block != nil {
424431
res.Block.MaxBytes = params2.Block.MaxBytes
425432
res.Block.MaxGas = params2.Block.MaxGas
433+
res.Block.MinTxsInBlock = params2.Block.MinTxsInBlock
426434
}
427435
if params2.Evidence != nil {
428436
res.Evidence.MaxAgeNumBlocks = params2.Evidence.MaxAgeNumBlocks
@@ -473,8 +481,9 @@ func (params ConsensusParams) UpdateConsensusParams(params2 *tmproto.ConsensusPa
473481
func (params *ConsensusParams) ToProto() tmproto.ConsensusParams {
474482
return tmproto.ConsensusParams{
475483
Block: &tmproto.BlockParams{
476-
MaxBytes: params.Block.MaxBytes,
477-
MaxGas: params.Block.MaxGas,
484+
MaxBytes: params.Block.MaxBytes,
485+
MaxGas: params.Block.MaxGas,
486+
MinTxsInBlock: params.Block.MinTxsInBlock,
478487
},
479488
Evidence: &tmproto.EvidenceParams{
480489
MaxAgeNumBlocks: params.Evidence.MaxAgeNumBlocks,
@@ -509,8 +518,9 @@ func (params *ConsensusParams) ToProto() tmproto.ConsensusParams {
509518
func ConsensusParamsFromProto(pbParams tmproto.ConsensusParams) ConsensusParams {
510519
c := ConsensusParams{
511520
Block: BlockParams{
512-
MaxBytes: pbParams.Block.MaxBytes,
513-
MaxGas: pbParams.Block.MaxGas,
521+
MaxBytes: pbParams.Block.MaxBytes,
522+
MaxGas: pbParams.Block.MaxGas,
523+
MinTxsInBlock: pbParams.Block.MinTxsInBlock,
514524
},
515525
Evidence: EvidenceParams{
516526
MaxAgeNumBlocks: pbParams.Evidence.MaxAgeNumBlocks,

0 commit comments

Comments
 (0)