mirror of https://github.com/ethereum/go-ethereum
cmd/utils: renames flags related to http-rpc server (#20935)
* rpc flags related to starting http server renamed to http * old rpc flags aliased and still functional * pprof flags fixed * renames gpo related flags * linted * renamed rpc flags for consistency and clarity * added warn logs * added more warn logs for all deprecated flags for consistency * moves legacy flags to separate file, hides older flags under show-deprecated-flags command * legacy prefix and moved some more legacy flags to legacy file * fixed circular import * added docs * fixed imports lint error * added notes about when flags were deprecated * cmd/utils: group flags by deprecation date + reorder by date, * modified deprecated comments for consistency, added warn log for --rpc * making sure deprecated flags are still functional * show-deprecated-flags command cleaned up * fixed lint errors * corrected merge conflict * IsSet --> GlobalIsSet * uncategorized flags, if not deprecated, displayed under misc Co-authored-by: Martin Holst Swende <martin@swende.se>pull/21026/head
rene
5 years ago
committed by
GitHub
parent
587656619d
commit
c989bca173
@ -0,0 +1,163 @@ |
||||
// Copyright 2020 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package utils |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
|
||||
"github.com/ethereum/go-ethereum/eth" |
||||
"github.com/ethereum/go-ethereum/node" |
||||
"gopkg.in/urfave/cli.v1" |
||||
) |
||||
|
||||
var ShowDeprecated = cli.Command{ |
||||
Action: showDeprecated, |
||||
Name: "show-deprecated-flags", |
||||
Usage: "Show flags that have been deprecated", |
||||
ArgsUsage: " ", |
||||
Category: "MISCELLANEOUS COMMANDS", |
||||
Description: "Show flags that have been deprecated and will soon be removed", |
||||
} |
||||
|
||||
var DeprecatedFlags = []cli.Flag{ |
||||
LegacyTestnetFlag, |
||||
LegacyLightServFlag, |
||||
LegacyLightPeersFlag, |
||||
LegacyMinerThreadsFlag, |
||||
LegacyMinerGasTargetFlag, |
||||
LegacyMinerGasPriceFlag, |
||||
LegacyMinerEtherbaseFlag, |
||||
LegacyMinerExtraDataFlag, |
||||
} |
||||
|
||||
var ( |
||||
// (Deprecated April 2018)
|
||||
LegacyMinerThreadsFlag = cli.IntFlag{ |
||||
Name: "minerthreads", |
||||
Usage: "Number of CPU threads to use for mining (deprecated, use --miner.threads)", |
||||
Value: 0, |
||||
} |
||||
LegacyMinerGasTargetFlag = cli.Uint64Flag{ |
||||
Name: "targetgaslimit", |
||||
Usage: "Target gas floor for mined blocks (deprecated, use --miner.gastarget)", |
||||
Value: eth.DefaultConfig.Miner.GasFloor, |
||||
} |
||||
LegacyMinerGasPriceFlag = BigFlag{ |
||||
Name: "gasprice", |
||||
Usage: "Minimum gas price for mining a transaction (deprecated, use --miner.gasprice)", |
||||
Value: eth.DefaultConfig.Miner.GasPrice, |
||||
} |
||||
LegacyMinerEtherbaseFlag = cli.StringFlag{ |
||||
Name: "etherbase", |
||||
Usage: "Public address for block mining rewards (default = first account, deprecated, use --miner.etherbase)", |
||||
Value: "0", |
||||
} |
||||
LegacyMinerExtraDataFlag = cli.StringFlag{ |
||||
Name: "extradata", |
||||
Usage: "Block extra data set by the miner (default = client version, deprecated, use --miner.extradata)", |
||||
} |
||||
|
||||
// (Deprecated June 2019)
|
||||
LegacyLightServFlag = cli.IntFlag{ |
||||
Name: "lightserv", |
||||
Usage: "Maximum percentage of time allowed for serving LES requests (deprecated, use --light.serve)", |
||||
Value: eth.DefaultConfig.LightServ, |
||||
} |
||||
LegacyLightPeersFlag = cli.IntFlag{ |
||||
Name: "lightpeers", |
||||
Usage: "Maximum number of light clients to serve, or light servers to attach to (deprecated, use --light.maxpeers)", |
||||
Value: eth.DefaultConfig.LightPeers, |
||||
} |
||||
|
||||
// (Deprecated April 2020)
|
||||
LegacyTestnetFlag = cli.BoolFlag{ // TODO(q9f): Remove after Ropsten is discontinued.
|
||||
Name: "testnet", |
||||
Usage: "Pre-configured test network (Deprecated: Please choose one of --goerli, --rinkeby, or --ropsten.)", |
||||
} |
||||
LegacyRPCEnabledFlag = cli.BoolFlag{ |
||||
Name: "rpc", |
||||
Usage: "Enable the HTTP-RPC server (deprecated, use --http)", |
||||
} |
||||
LegacyRPCListenAddrFlag = cli.StringFlag{ |
||||
Name: "rpcaddr", |
||||
Usage: "HTTP-RPC server listening interface (deprecated, use --http.addr)", |
||||
Value: node.DefaultHTTPHost, |
||||
} |
||||
LegacyRPCPortFlag = cli.IntFlag{ |
||||
Name: "rpcport", |
||||
Usage: "HTTP-RPC server listening port (deprecated, use --http.port)", |
||||
Value: node.DefaultHTTPPort, |
||||
} |
||||
LegacyRPCCORSDomainFlag = cli.StringFlag{ |
||||
Name: "rpccorsdomain", |
||||
Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced) (deprecated, use --http.corsdomain)", |
||||
Value: "", |
||||
} |
||||
LegacyRPCVirtualHostsFlag = cli.StringFlag{ |
||||
Name: "rpcvhosts", |
||||
Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (deprecated, use --http.vhosts)", |
||||
Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","), |
||||
} |
||||
LegacyRPCApiFlag = cli.StringFlag{ |
||||
Name: "rpcapi", |
||||
Usage: "API's offered over the HTTP-RPC interface (deprecated, use --http.api)", |
||||
Value: "", |
||||
} |
||||
LegacyWSListenAddrFlag = cli.StringFlag{ |
||||
Name: "wsaddr", |
||||
Usage: "WS-RPC server listening interface (deprecated, use --ws.addr)", |
||||
Value: node.DefaultWSHost, |
||||
} |
||||
LegacyWSPortFlag = cli.IntFlag{ |
||||
Name: "wsport", |
||||
Usage: "WS-RPC server listening port (deprecated, use --ws.port)", |
||||
Value: node.DefaultWSPort, |
||||
} |
||||
LegacyWSApiFlag = cli.StringFlag{ |
||||
Name: "wsapi", |
||||
Usage: "API's offered over the WS-RPC interface (deprecated, use --ws.api)", |
||||
Value: "", |
||||
} |
||||
LegacyWSAllowedOriginsFlag = cli.StringFlag{ |
||||
Name: "wsorigins", |
||||
Usage: "Origins from which to accept websockets requests (deprecated, use --ws.origins)", |
||||
Value: "", |
||||
} |
||||
LegacyGpoBlocksFlag = cli.IntFlag{ |
||||
Name: "gpoblocks", |
||||
Usage: "Number of recent blocks to check for gas prices (deprecated, use --gpo.blocks)", |
||||
Value: eth.DefaultConfig.GPO.Blocks, |
||||
} |
||||
LegacyGpoPercentileFlag = cli.IntFlag{ |
||||
Name: "gpopercentile", |
||||
Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices (deprecated, use --gpo.percentile)", |
||||
Value: eth.DefaultConfig.GPO.Percentile, |
||||
} |
||||
) |
||||
|
||||
// showDeprecated displays deprecated flags that will be soon removed from the codebase.
|
||||
func showDeprecated(*cli.Context) { |
||||
fmt.Println("--------------------------------------------------------------------") |
||||
fmt.Println("The following flags are deprecated and will be removed in the future!") |
||||
fmt.Println("--------------------------------------------------------------------") |
||||
fmt.Println() |
||||
|
||||
for _, flag := range DeprecatedFlags { |
||||
fmt.Println(flag.String()) |
||||
} |
||||
} |
||||
Loading…
Reference in new issue