Skip to content

Commit 1743cdf

Browse files
jewei1997jewei1997
authored
Add a hard max gas wanted at 50mil gas as a consensus param (#267)
* add a hard max gas wanted at 50mil gas * minor comment * fix mock mempool * add 2 tests to ensure minTxsPerBlock is still respected * update formatting in description * fix params_test.gp * set max_gas_wanted in test genesis * updates to rpc readme and openapi
1 parent 9042a3e commit 1743cdf

File tree

17 files changed

+475
-344
lines changed

17 files changed

+475
-344
lines changed

‎abci/types/types.pb.go

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

‎config/toml.go

+1
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,7 @@ const testGenesisFmt = `{
693693
"consensus_params": {
694694
"block": {
695695
"max_bytes": "22020096",
696+
"max_gas_wanted": "-1",
696697
"max_gas": "-1",
697698
"time_iota_ms": "10"
698699
},

‎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, 0)
233+
txs := assertMempool(t, cs.txNotifier).ReapMaxBytesMaxGas(int64(len(txBytes)), -1, -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/evidence/pool_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -495,8 +495,8 @@ func TestRecoverPendingEvidence(t *testing.T) {
495495
LastBlockHeight: height + 15,
496496
ConsensusParams: types.ConsensusParams{
497497
Block: types.BlockParams{
498-
MaxBytes: 22020096,
499-
MaxGas: -1,
498+
MaxBytes: 22020096,
499+
MaxGasWanted: -1,
500500
},
501501
Evidence: types.EvidenceParams{
502502
MaxAgeNumBlocks: 20,
@@ -529,8 +529,8 @@ func initializeStateFromValidatorSet(t *testing.T, valSet *types.ValidatorSet, h
529529
LastHeightValidatorsChanged: 1,
530530
ConsensusParams: types.ConsensusParams{
531531
Block: types.BlockParams{
532-
MaxBytes: 22020096,
533-
MaxGas: -1,
532+
MaxBytes: 22020096,
533+
MaxGasWanted: -1,
534534
},
535535
Evidence: types.EvidenceParams{
536536
MaxAgeNumBlocks: 20,

‎internal/mempool/mempool.go

+21-11
Original file line numberDiff line numberDiff line change
@@ -428,18 +428,25 @@ func (txmp *TxMempool) Flush() {
428428

429429
// ReapMaxBytesMaxGas returns a list of transactions within the provided size
430430
// and gas constraints. Transaction are retrieved in priority order.
431+
// There are 4 types of constraints.
432+
// 1. maxBytes - stops pulling txs from mempool once maxBytes is hit. Can be set to -1 to be ignored.
433+
// 2. maxGasWanted - stops pulling txs from mempool once total gas wanted exceeds maxGasWanted.
434+
// Can be set to -1 to be ignored.
435+
// 3. maxGasEstimated - similar to maxGasWanted but will use the estimated gas used for EVM txs
436+
// while still using gas wanted for cosmos txs. Can be set to -1 to be ignored.
431437
//
432438
// NOTE:
433439
// - Transactions returned are not removed from the mempool transaction
434440
// store or indexes.
435-
func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs {
441+
func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGasWanted, maxGasEstimated, minTxsInBlock int64) types.Txs {
436442
txmp.mtx.Lock()
437443
defer txmp.mtx.Unlock()
438444

439445
var (
440-
totalGas int64
441-
totalSize int64
442-
nonzeroGasTxCnt int64
446+
totalGasWanted int64
447+
totalGasEstimated int64
448+
totalSize int64
449+
nonzeroGasTxCnt int64
443450
)
444451

445452
var txs []types.Tx
@@ -455,21 +462,24 @@ func (txmp *TxMempool) ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64)
455462
}
456463

457464
// if the tx doesn't have a gas estimate, fallback to gas wanted
458-
var gasEstimateOrWanted int64
465+
var txGasEstimate int64
459466
if wtx.estimatedGas > 0 {
460-
gasEstimateOrWanted = wtx.estimatedGas
467+
txGasEstimate = wtx.estimatedGas
461468
} else {
462-
gasEstimateOrWanted = wtx.gasWanted
469+
txGasEstimate = wtx.gasWanted
463470
}
464471

465472
totalSize += size
466-
gas := totalGas + gasEstimateOrWanted
467-
maxGasExceeded := maxGas > -1 && gas > maxGas
468-
if nonzeroGasTxCnt >= minTxsInBlock && maxGasExceeded {
473+
gasWanted := totalGasWanted + wtx.gasWanted
474+
gasEstimated := totalGasEstimated + txGasEstimate
475+
maxGasWantedExceeded := maxGasWanted > -1 && gasWanted > maxGasWanted
476+
maxGasEstimatedExceeded := maxGasEstimated > -1 && gasEstimated > maxGasEstimated
477+
if nonzeroGasTxCnt >= minTxsInBlock && (maxGasWantedExceeded || maxGasEstimatedExceeded) {
469478
return false
470479
}
471480

472-
totalGas = gas
481+
totalGasWanted = gasWanted
482+
totalGasEstimated = gasEstimated
473483

474484
txs = append(txs, wtx.tx)
475485
if wtx.gasWanted > 0 {

‎internal/mempool/mempool_test.go

+30-10
Original file line numberDiff line numberDiff line change
@@ -367,8 +367,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
367367
ctx, cancel := context.WithCancel(context.Background())
368368
defer cancel()
369369

370-
// gas estimated is 1 so we will use this and not fallback to gas wanted
371-
gasEstimated := int64(1)
370+
gasEstimated := int64(1) // gas estimated set to 1
372371
client := abciclient.NewLocalClient(log.NewNopLogger(), &application{Application: kvstore.NewApplication(), gasEstimated: &gasEstimated})
373372
if err := client.Start(ctx); err != nil {
374373
t.Fatal(err)
@@ -407,7 +406,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
407406
wg.Add(1)
408407
go func() {
409408
defer wg.Done()
410-
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, 0)
409+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, -1, 0)
411410
ensurePrioritized(reapedTxs)
412411
require.Equal(t, len(tTxs), txmp.Size())
413412
require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -418,7 +417,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
418417
wg.Add(1)
419418
go func() {
420419
defer wg.Done()
421-
reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1, 0)
420+
reapedTxs := txmp.ReapMaxBytesMaxGas(1000, -1, -1, 0)
422421
ensurePrioritized(reapedTxs)
423422
require.Equal(t, len(tTxs), txmp.Size())
424423
require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -430,7 +429,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
430429
wg.Add(1)
431430
go func() {
432431
defer wg.Done()
433-
reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30, 0)
432+
reapedTxs := txmp.ReapMaxBytesMaxGas(1500, 30, -1, 0)
434433
ensurePrioritized(reapedTxs)
435434
require.Equal(t, len(tTxs), txmp.Size())
436435
require.Equal(t, int64(5690), txmp.SizeBytes())
@@ -441,7 +440,7 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
441440
wg.Add(1)
442441
go func() {
443442
defer wg.Done()
444-
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 1, 2)
443+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 1, -1, 2)
445444
ensurePrioritized(reapedTxs)
446445
require.Equal(t, len(tTxs), txmp.Size())
447446
require.Len(t, reapedTxs, 2)
@@ -451,21 +450,42 @@ func TestTxMempool_ReapMaxBytesMaxGas(t *testing.T) {
451450
wg.Add(1)
452451
go func() {
453452
defer wg.Done()
454-
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, 0)
453+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, -1, 50, 0)
455454
ensurePrioritized(reapedTxs)
456455
require.Equal(t, len(tTxs), txmp.Size())
457456
require.Len(t, reapedTxs, 50)
458457
}()
459458

459+
// Test that minTxsPerBlock is still used even when max gas esimated is exceeded
460+
wg.Add(1)
461+
go func() {
462+
defer wg.Done()
463+
// pull minTxsPerBlock even though max gas wanted is hit
464+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, -1, 50, 51)
465+
ensurePrioritized(reapedTxs)
466+
require.Equal(t, len(tTxs), txmp.Size())
467+
require.Len(t, reapedTxs, 51)
468+
}()
469+
470+
// Test that minTxsPerBlock is still used even when max gas wanted is exceeded
471+
wg.Add(1)
472+
go func() {
473+
defer wg.Done()
474+
// pull minTxsPerBlock even though max gas wanted is hit
475+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, -1, 51)
476+
ensurePrioritized(reapedTxs)
477+
require.Equal(t, len(tTxs), txmp.Size())
478+
require.Len(t, reapedTxs, 51)
479+
}()
480+
460481
wg.Wait()
461482
}
462483

463484
func TestTxMempool_ReapMaxBytesMaxGas_FallbackToGasWanted(t *testing.T) {
464485
ctx, cancel := context.WithCancel(context.Background())
465486
defer cancel()
466487

467-
// gas estimated is 0 so we will fallback to gas wanted
468-
gasEstimated := int64(0)
488+
gasEstimated := int64(0) // gas estimated not set so fallback to gas wanted
469489
client := abciclient.NewLocalClient(log.NewNopLogger(), &application{Application: kvstore.NewApplication(), gasEstimated: &gasEstimated})
470490
if err := client.Start(ctx); err != nil {
471491
t.Fatal(err)
@@ -501,7 +521,7 @@ func TestTxMempool_ReapMaxBytesMaxGas_FallbackToGasWanted(t *testing.T) {
501521
wg.Add(1)
502522
go func() {
503523
defer wg.Done()
504-
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, 50, 0)
524+
reapedTxs := txmp.ReapMaxBytesMaxGas(-1, -1, 50, 0)
505525
ensurePrioritized(reapedTxs)
506526
require.Equal(t, len(tTxs), txmp.Size())
507527
require.Len(t, reapedTxs, 50)

‎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 all 3 maxes are negative, there is no cap on the size of all returned
5050
// transactions (~ all available transactions).
51-
ReapMaxBytesMaxGas(maxBytes, maxGas, minTxsInBlock int64) types.Txs
51+
ReapMaxBytesMaxGas(maxBytes, maxGas, maxGasEstimated, 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

+2-1
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,14 @@ func (blockExec *BlockExecutor) CreateProposalBlock(
9595

9696
maxBytes := state.ConsensusParams.Block.MaxBytes
9797
maxGas := state.ConsensusParams.Block.MaxGas
98+
maxGasWanted := state.ConsensusParams.Block.MaxGasWanted
9899

99100
evidence, evSize := blockExec.evpool.PendingEvidence(state.ConsensusParams.Evidence.MaxBytes)
100101

101102
// Fetch a limited amount of valid txs
102103
maxDataBytes := types.MaxDataBytes(maxBytes, evSize, state.Validators.Size())
103104

104-
txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGas, state.ConsensusParams.Block.MinTxsInBlock)
105+
txs := blockExec.mempool.ReapMaxBytesMaxGas(maxDataBytes, maxGasWanted, maxGas, state.ConsensusParams.Block.MinTxsInBlock)
105106
commit := lastExtCommit.ToCommit()
106107
block := state.MakeBlock(height, txs, commit, evidence, proposerAddr)
107108
rpp, err := blockExec.appClient.PrepareProposal(

‎proto/tendermint/abci/types.proto

+2
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,8 @@ message BlockParams {
494494
int64 max_gas = 2;
495495
// Minimum txs to include in a block regardless of gas limit
496496
int64 min_txs_in_block = 3;
497+
// Maximum gas wanted in a block. Must be greater than or equal to -1
498+
int64 max_gas_wanted = 4;
497499
}
498500

499501
message ConsensusParams {

0 commit comments

Comments
 (0)