2020-05-05 08:19:17 +00:00
// 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"
2021-02-05 12:51:15 +00:00
"github.com/ethereum/go-ethereum/eth/ethconfig"
2020-05-05 08:19:17 +00:00
"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)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . Miner . GasFloor ,
2020-05-05 08:19:17 +00:00
}
LegacyMinerGasPriceFlag = BigFlag {
Name : "gasprice" ,
Usage : "Minimum gas price for mining a transaction (deprecated, use --miner.gasprice)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . Miner . GasPrice ,
2020-05-05 08:19:17 +00:00
}
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)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . LightServ ,
2020-05-05 08:19:17 +00:00
}
LegacyLightPeersFlag = cli . IntFlag {
Name : "lightpeers" ,
Usage : "Maximum number of light clients to serve, or light servers to attach to (deprecated, use --light.maxpeers)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . LightPeers ,
2020-05-05 08:19:17 +00:00
}
// (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.)" ,
}
2020-08-03 17:40:46 +00:00
// (Deprecated May 2020, shown in aliased flags section)
2020-05-05 08:19:17 +00:00
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)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . GPO . Blocks ,
2020-05-05 08:19:17 +00:00
}
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)" ,
2021-02-05 12:51:15 +00:00
Value : ethconfig . Defaults . GPO . Percentile ,
2020-05-05 08:19:17 +00:00
}
2020-05-11 08:16:32 +00:00
LegacyBootnodesV4Flag = cli . StringFlag {
Name : "bootnodesv4" ,
Usage : "Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes) (deprecated, use --bootnodes)" ,
Value : "" ,
}
LegacyBootnodesV5Flag = cli . StringFlag {
Name : "bootnodesv5" ,
Usage : "Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes) (deprecated, use --bootnodes)" ,
Value : "" ,
}
2020-08-03 17:40:46 +00:00
// (Deprecated July 2020, shown in aliased flags section)
LegacyGraphQLListenAddrFlag = cli . StringFlag {
Name : "graphql.addr" ,
Usage : "GraphQL server listening interface (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql)" ,
}
LegacyGraphQLPortFlag = cli . IntFlag {
Name : "graphql.port" ,
Usage : "GraphQL server listening port (deprecated, graphql can only be enabled on the HTTP-RPC server endpoint, use --graphql)" ,
Value : node . DefaultHTTPPort ,
}
2020-05-05 08:19:17 +00:00
)
// 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 ( ) )
}
}