cmd, core, eth, miner: deprecate miner.gastarget flag (#23213)

rjl493456442 · web-flow · commit 6d175460dfb4 · 2021-08-10T11:28:33.000+03:00
diff --git a/cmd/geth/main.go b/cmd/geth/main.go
@@ -118,7 +118,7 @@ var (
 		utils.MiningEnabledFlag,
 		utils.MinerThreadsFlag,
 		utils.MinerNotifyFlag,
-		utils.MinerGasTargetFlag,
+		utils.LegacyMinerGasTargetFlag,
 		utils.MinerGasLimitFlag,
 		utils.MinerGasPriceFlag,
 		utils.MinerEtherbaseFlag,
diff --git a/cmd/geth/usage.go b/cmd/geth/usage.go
@@ -182,7 +182,6 @@ var AppHelpFlagGroups = []flags.FlagGroup{
 			utils.MinerNotifyFlag,
 			utils.MinerNotifyFullFlag,
 			utils.MinerGasPriceFlag,
-			utils.MinerGasTargetFlag,
 			utils.MinerGasLimitFlag,
 			utils.MinerEtherbaseFlag,
 			utils.MinerExtraDataFlag,
@@ -226,6 +225,7 @@ var AppHelpFlagGroups = []flags.FlagGroup{
 			utils.LegacyRPCCORSDomainFlag,
 			utils.LegacyRPCVirtualHostsFlag,
 			utils.LegacyRPCApiFlag,
+			utils.LegacyMinerGasTargetFlag,
 		},
 	},
 	{
diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go
@@ -444,11 +444,6 @@ var (
 		Name:  "miner.notify.full",
 		Usage: "Notify with pending block headers instead of work packages",
 	}
-	MinerGasTargetFlag = cli.Uint64Flag{
-		Name:  "miner.gastarget",
-		Usage: "Target gas floor for mined blocks",
-		Value: ethconfig.Defaults.Miner.GasFloor,
-	}
 	MinerGasLimitFlag = cli.Uint64Flag{
 		Name:  "miner.gaslimit",
 		Usage: "Target gas ceiling for mined blocks",
@@ -1386,9 +1381,6 @@ func setMiner(ctx *cli.Context, cfg *miner.Config) {
 	if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {
 		cfg.ExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))
 	}
-	if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {
-		cfg.GasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)
-	}
 	if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {
 		cfg.GasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)
 	}
@@ -1401,6 +1393,9 @@ func setMiner(ctx *cli.Context, cfg *miner.Config) {
 	if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
 		cfg.Noverify = ctx.GlobalBool(MinerNoVerfiyFlag.Name)
 	}
+	if ctx.GlobalIsSet(LegacyMinerGasTargetFlag.Name) {
+		log.Warn("The generic --miner.gastarget flag is deprecated and will be removed in the future!")
+	}
 }
 
 func setWhitelist(ctx *cli.Context, cfg *ethconfig.Config) {
diff --git a/cmd/utils/flags_legacy.go b/cmd/utils/flags_legacy.go
@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/ethereum/go-ethereum/eth/ethconfig"
 	"github.com/ethereum/go-ethereum/node"
 	"gopkg.in/urfave/cli.v1"
 )
@@ -33,7 +34,9 @@ var ShowDeprecated = cli.Command{
 	Description: "Show flags that have been deprecated and will soon be removed",
 }
 
-var DeprecatedFlags = []cli.Flag{}
+var DeprecatedFlags = []cli.Flag{
+	LegacyMinerGasTargetFlag,
+}
 
 var (
 	// (Deprecated May 2020, shown in aliased flags section)
@@ -66,6 +69,12 @@ var (
 		Usage: "API's offered over the HTTP-RPC interface (deprecated and will be removed June 2021, use --http.api)",
 		Value: "",
 	}
+	// (Deprecated July 2021, shown in aliased flags section)
+	LegacyMinerGasTargetFlag = cli.Uint64Flag{
+		Name:  "miner.gastarget",
+		Usage: "Target gas floor for mined blocks (deprecated)",
+		Value: ethconfig.Defaults.Miner.GasFloor,
+	}
 )
 
 // showDeprecated displays deprecated flags that will be soon removed from the codebase.
@@ -74,7 +83,8 @@ func showDeprecated(*cli.Context) {
 	fmt.Println("The following flags are deprecated and will be removed in the future!")
 	fmt.Println("--------------------------------------------------------------------")
 	fmt.Println()
-	// TODO remove when there are newly deprecated flags
-	fmt.Println("no deprecated flags to show at this time")
+	for _, flag := range DeprecatedFlags {
+		fmt.Println(flag.String())
+	}
 	fmt.Println()
 }
diff --git a/core/block_validator.go b/core/block_validator.go
@@ -103,44 +103,9 @@ func (v *BlockValidator) ValidateState(block *types.Block, statedb *state.StateD
 }
 
 // CalcGasLimit computes the gas limit of the next block after parent. It aims
-// to keep the baseline gas above the provided floor, and increase it towards the
-// ceil if the blocks are full. If the ceil is exceeded, it will always decrease
-// the gas allowance.
-func CalcGasLimit(parentGasUsed, parentGasLimit, gasFloor, gasCeil uint64) uint64 {
-	// contrib = (parentGasUsed * 3 / 2) / 1024
-	contrib := (parentGasUsed + parentGasUsed/2) / params.GasLimitBoundDivisor
-
-	// decay = parentGasLimit / 1024 -1
-	decay := parentGasLimit/params.GasLimitBoundDivisor - 1
-
-	/*
-		strategy: gasLimit of block-to-mine is set based on parent's
-		gasUsed value.  if parentGasUsed > parentGasLimit * (2/3) then we
-		increase it, otherwise lower it (or leave it unchanged if it's right
-		at that usage) the amount increased/decreased depends on how far away
-		from parentGasLimit * (2/3) parentGasUsed is.
-	*/
-	limit := parentGasLimit - decay + contrib
-	if limit < params.MinGasLimit {
-		limit = params.MinGasLimit
-	}
-	// If we're outside our allowed gas range, we try to hone towards them
-	if limit < gasFloor {
-		limit = parentGasLimit + decay
-		if limit > gasFloor {
-			limit = gasFloor
-		}
-	} else if limit > gasCeil {
-		limit = parentGasLimit - decay
-		if limit < gasCeil {
-			limit = gasCeil
-		}
-	}
-	return limit
-}
-
-// CalcGasLimit1559 calculates the next block gas limit under 1559 rules.
-func CalcGasLimit1559(parentGasLimit, desiredLimit uint64) uint64 {
+// to keep the baseline gas close to the provided target, and increase it towards
+// the target if the baseline gas is lower.
+func CalcGasLimit(parentGasLimit, desiredLimit uint64) uint64 {
 	delta := parentGasLimit/params.GasLimitBoundDivisor - 1
 	limit := parentGasLimit
 	if desiredLimit < params.MinGasLimit {
diff --git a/core/block_validator_test.go b/core/block_validator_test.go
@@ -198,8 +198,7 @@ func testHeaderConcurrentAbortion(t *testing.T, threads int) {
 	}
 }
 
-func TestCalcGasLimit1559(t *testing.T) {
-
+func TestCalcGasLimit(t *testing.T) {
 	for i, tc := range []struct {
 		pGasLimit uint64
 		max       uint64
@@ -209,23 +208,23 @@ func TestCalcGasLimit1559(t *testing.T) {
 		{40000000, 40039061, 39960939},
 	} {
 		// Increase
-		if have, want := CalcGasLimit1559(tc.pGasLimit, 2*tc.pGasLimit), tc.max; have != want {
+		if have, want := CalcGasLimit(tc.pGasLimit, 2*tc.pGasLimit), tc.max; have != want {
 			t.Errorf("test %d: have %d want <%d", i, have, want)
 		}
 		// Decrease
-		if have, want := CalcGasLimit1559(tc.pGasLimit, 0), tc.min; have != want {
+		if have, want := CalcGasLimit(tc.pGasLimit, 0), tc.min; have != want {
 			t.Errorf("test %d: have %d want >%d", i, have, want)
 		}
 		// Small decrease
-		if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit-1), tc.pGasLimit-1; have != want {
+		if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit-1), tc.pGasLimit-1; have != want {
 			t.Errorf("test %d: have %d want %d", i, have, want)
 		}
 		// Small increase
-		if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit+1), tc.pGasLimit+1; have != want {
+		if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit+1), tc.pGasLimit+1; have != want {
 			t.Errorf("test %d: have %d want %d", i, have, want)
 		}
 		// No change
-		if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit), tc.pGasLimit; have != want {
+		if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit), tc.pGasLimit; have != want {
 			t.Errorf("test %d: have %d want %d", i, have, want)
 		}
 	}
diff --git a/core/chain_makers.go b/core/chain_makers.go
@@ -273,11 +273,10 @@ func makeHeader(chain consensus.ChainReader, parent *types.Block, state *state.S
 	}
 	if chain.Config().IsLondon(header.Number) {
 		header.BaseFee = misc.CalcBaseFee(chain.Config(), parent.Header())
-		parentGasLimit := parent.GasLimit()
 		if !chain.Config().IsLondon(parent.Number()) {
-			parentGasLimit = parent.GasLimit() * params.ElasticityMultiplier
+			parentGasLimit := parent.GasLimit() * params.ElasticityMultiplier
+			header.GasLimit = CalcGasLimit(parentGasLimit, parentGasLimit)
 		}
-		header.GasLimit = CalcGasLimit1559(parentGasLimit, parentGasLimit)
 	}
 	return header
 }
diff --git a/eth/ethconfig/config.go b/eth/ethconfig/config.go
@@ -83,7 +83,6 @@ var Defaults = Config{
 	TrieTimeout:             60 * time.Minute,
 	SnapshotCache:           102,
 	Miner: miner.Config{
-		GasFloor: 8000000,
 		GasCeil:  8000000,
 		GasPrice: big.NewInt(params.GWei),
 		Recommit: 3 * time.Second,
diff --git a/miner/stress/1559/main.go b/miner/stress/1559/main.go
@@ -242,7 +242,6 @@ func makeMiner(genesis *core.Genesis) (*node.Node, *eth.Ethereum, error) {
 		GPO:             ethconfig.Defaults.GPO,
 		Ethash:          ethconfig.Defaults.Ethash,
 		Miner: miner.Config{
-			GasFloor: genesis.GasLimit * 9 / 10,
 			GasCeil:  genesis.GasLimit * 11 / 10,
 			GasPrice: big.NewInt(1),
 			Recommit: time.Second,
diff --git a/miner/stress/clique/main.go b/miner/stress/clique/main.go
@@ -193,7 +193,6 @@ func makeSealer(genesis *core.Genesis) (*node.Node, *eth.Ethereum, error) {
 		TxPool:          core.DefaultTxPoolConfig,
 		GPO:             ethconfig.Defaults.GPO,
 		Miner: miner.Config{
-			GasFloor: genesis.GasLimit * 9 / 10,
 			GasCeil:  genesis.GasLimit * 11 / 10,
 			GasPrice: big.NewInt(1),
 			Recommit: time.Second,
diff --git a/miner/stress/ethash/main.go b/miner/stress/ethash/main.go
@@ -171,7 +171,6 @@ func makeMiner(genesis *core.Genesis) (*node.Node, *eth.Ethereum, error) {
 		GPO:             ethconfig.Defaults.GPO,
 		Ethash:          ethconfig.Defaults.Ethash,
 		Miner: miner.Config{
-			GasFloor: genesis.GasLimit * 9 / 10,
 			GasCeil:  genesis.GasLimit * 11 / 10,
 			GasPrice: big.NewInt(1),
 			Recommit: time.Second,
diff --git a/miner/worker.go b/miner/worker.go
@@ -897,19 +897,17 @@ func (w *worker) commitNewWork(interrupt *int32, noempty bool, timestamp int64)
 	header := &types.Header{
 		ParentHash: parent.Hash(),
 		Number:     num.Add(num, common.Big1),
-		GasLimit:   core.CalcGasLimit(parent.GasUsed(), parent.GasLimit(), w.config.GasFloor, w.config.GasCeil),
+		GasLimit:   core.CalcGasLimit(parent.GasLimit(), w.config.GasCeil),
 		Extra:      w.extra,
 		Time:       uint64(timestamp),
 	}
 	// Set baseFee and GasLimit if we are on an EIP-1559 chain
 	if w.chainConfig.IsLondon(header.Number) {
 		header.BaseFee = misc.CalcBaseFee(w.chainConfig, parent.Header())
-		parentGasLimit := parent.GasLimit()
 		if !w.chainConfig.IsLondon(parent.Number()) {
-			// Bump by 2x
-			parentGasLimit = parent.GasLimit() * params.ElasticityMultiplier
+			parentGasLimit := parent.GasLimit() * params.ElasticityMultiplier
+			header.GasLimit = core.CalcGasLimit(parentGasLimit, w.config.GasCeil)
 		}
-		header.GasLimit = core.CalcGasLimit1559(parentGasLimit, w.config.GasCeil)
 	}
 	// Only set the coinbase if our consensus engine is running (avoid spurious block rewards)
 	if w.isRunning() {
diff --git a/miner/worker_test.go b/miner/worker_test.go
@@ -67,7 +67,6 @@ var (
 
 	testConfig = &Config{
 		Recommit: time.Second,
-		GasFloor: params.GenesisGasLimit,
 		GasCeil:  params.GenesisGasLimit,
 	}
 )

Original file line number	Diff line number	Diff line change
`@@ -444,11 +444,6 @@ var (`
`444`	`444`	`Name: "miner.notify.full",`
`445`	`445`	`Usage: "Notify with pending block headers instead of work packages",`
`446`	`446`	`}`
`447`		`- MinerGasTargetFlag = cli.Uint64Flag{`
`448`		`- Name: "miner.gastarget",`
`449`		`- Usage: "Target gas floor for mined blocks",`
`450`		`- Value: ethconfig.Defaults.Miner.GasFloor,`
`451`		`- }`
`452`	`447`	`MinerGasLimitFlag = cli.Uint64Flag{`
`453`	`448`	`Name: "miner.gaslimit",`
`454`	`449`	`Usage: "Target gas ceiling for mined blocks",`
`@@ -1386,9 +1381,6 @@ func setMiner(ctx cli.Context, cfg miner.Config) {`
`1386`	`1381`	`if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {`
`1387`	`1382`	`cfg.ExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))`
`1388`	`1383`	`}`
`1389`		`- if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {`
`1390`		`- cfg.GasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)`
`1391`		`- }`
`1392`	`1384`	`if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {`
`1393`	`1385`	`cfg.GasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)`
`1394`	`1386`	`}`
`@@ -1401,6 +1393,9 @@ func setMiner(ctx cli.Context, cfg miner.Config) {`
`1401`	`1393`	`if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {`
`1402`	`1394`	`cfg.Noverify = ctx.GlobalBool(MinerNoVerfiyFlag.Name)`
`1403`	`1395`	`}`
	`1396`	`+ if ctx.GlobalIsSet(LegacyMinerGasTargetFlag.Name) {`
	`1397`	`+ log.Warn("The generic --miner.gastarget flag is deprecated and will be removed in the future!")`
	`1398`	`+ }`
`1404`	`1399`	`}`
`1405`	`1400`
`1406`	`1401`	`func setWhitelist(ctx cli.Context, cfg ethconfig.Config) {`
Original file line number	Diff line number	Diff line change
`@@ -198,8 +198,7 @@ func testHeaderConcurrentAbortion(t *testing.T, threads int) {`
`198`	`198`	`}`
`199`	`199`	`}`
`200`	`200`
`201`		`-func TestCalcGasLimit1559(t *testing.T) {`
`202`		`-`
	`201`	`+func TestCalcGasLimit(t *testing.T) {`
`203`	`202`	`for i, tc := range []struct {`
`204`	`203`	`pGasLimit uint64`
`205`	`204`	`max uint64`
`@@ -209,23 +208,23 @@ func TestCalcGasLimit1559(t *testing.T) {`
`209`	`208`	`{40000000, 40039061, 39960939},`
`210`	`209`	`} {`
`211`	`210`	`// Increase`
`212`		`- if have, want := CalcGasLimit1559(tc.pGasLimit, 2*tc.pGasLimit), tc.max; have != want {`
	`211`	`+ if have, want := CalcGasLimit(tc.pGasLimit, 2*tc.pGasLimit), tc.max; have != want {`
`213`	`212`	`t.Errorf("test %d: have %d want <%d", i, have, want)`
`214`	`213`	`}`
`215`	`214`	`// Decrease`
`216`		`- if have, want := CalcGasLimit1559(tc.pGasLimit, 0), tc.min; have != want {`
	`215`	`+ if have, want := CalcGasLimit(tc.pGasLimit, 0), tc.min; have != want {`
`217`	`216`	`t.Errorf("test %d: have %d want >%d", i, have, want)`
`218`	`217`	`}`
`219`	`218`	`// Small decrease`
`220`		`- if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit-1), tc.pGasLimit-1; have != want {`
	`219`	`+ if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit-1), tc.pGasLimit-1; have != want {`
`221`	`220`	`t.Errorf("test %d: have %d want %d", i, have, want)`
`222`	`221`	`}`
`223`	`222`	`// Small increase`
`224`		`- if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit+1), tc.pGasLimit+1; have != want {`
	`223`	`+ if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit+1), tc.pGasLimit+1; have != want {`
`225`	`224`	`t.Errorf("test %d: have %d want %d", i, have, want)`
`226`	`225`	`}`
`227`	`226`	`// No change`
`228`		`- if have, want := CalcGasLimit1559(tc.pGasLimit, tc.pGasLimit), tc.pGasLimit; have != want {`
	`227`	`+ if have, want := CalcGasLimit(tc.pGasLimit, tc.pGasLimit), tc.pGasLimit; have != want {`
`229`	`228`	`t.Errorf("test %d: have %d want %d", i, have, want)`
`230`	`229`	`}`
`231`	`230`	`}`
Original file line number	Diff line number	Diff line change
`@@ -273,11 +273,10 @@ func makeHeader(chain consensus.ChainReader, parent types.Block, state state.S`
`273`	`273`	`}`
`274`	`274`	`if chain.Config().IsLondon(header.Number) {`
`275`	`275`	`header.BaseFee = misc.CalcBaseFee(chain.Config(), parent.Header())`
`276`		`- parentGasLimit := parent.GasLimit()`
`277`	`276`	`if !chain.Config().IsLondon(parent.Number()) {`
`278`		`- parentGasLimit = parent.GasLimit() * params.ElasticityMultiplier`
	`277`	`+ parentGasLimit := parent.GasLimit() * params.ElasticityMultiplier`
	`278`	`+ header.GasLimit = CalcGasLimit(parentGasLimit, parentGasLimit)`
`279`	`279`	`}`
`280`		`- header.GasLimit = CalcGasLimit1559(parentGasLimit, parentGasLimit)`
`281`	`280`	`}`
`282`	`281`	`return header`
`283`	`282`	`}`