mirror of https://github.com/status-im/op-geth.git
1448 lines
48 KiB
Go
1448 lines
48 KiB
Go
// Copyright 2015 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 contains internal helper functions for go-ethereum commands.
|
|
package utils
|
|
|
|
import (
|
|
"crypto/ecdsa"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"math/big"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/accounts"
|
|
"github.com/ethereum/go-ethereum/accounts/keystore"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/fdlimit"
|
|
"github.com/ethereum/go-ethereum/consensus"
|
|
"github.com/ethereum/go-ethereum/consensus/clique"
|
|
"github.com/ethereum/go-ethereum/consensus/ethash"
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/core/state"
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/dashboard"
|
|
"github.com/ethereum/go-ethereum/eth"
|
|
"github.com/ethereum/go-ethereum/eth/downloader"
|
|
"github.com/ethereum/go-ethereum/eth/gasprice"
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
"github.com/ethereum/go-ethereum/ethstats"
|
|
"github.com/ethereum/go-ethereum/les"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/metrics"
|
|
"github.com/ethereum/go-ethereum/metrics/influxdb"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/p2p"
|
|
"github.com/ethereum/go-ethereum/p2p/discv5"
|
|
"github.com/ethereum/go-ethereum/p2p/enode"
|
|
"github.com/ethereum/go-ethereum/p2p/nat"
|
|
"github.com/ethereum/go-ethereum/p2p/netutil"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
whisper "github.com/ethereum/go-ethereum/whisper/whisperv6"
|
|
"gopkg.in/urfave/cli.v1"
|
|
)
|
|
|
|
var (
|
|
CommandHelpTemplate = `{{.cmd.Name}}{{if .cmd.Subcommands}} command{{end}}{{if .cmd.Flags}} [command options]{{end}} [arguments...]
|
|
{{if .cmd.Description}}{{.cmd.Description}}
|
|
{{end}}{{if .cmd.Subcommands}}
|
|
SUBCOMMANDS:
|
|
{{range .cmd.Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
|
|
{{end}}{{end}}{{if .categorizedFlags}}
|
|
{{range $idx, $categorized := .categorizedFlags}}{{$categorized.Name}} OPTIONS:
|
|
{{range $categorized.Flags}}{{"\t"}}{{.}}
|
|
{{end}}
|
|
{{end}}{{end}}`
|
|
)
|
|
|
|
func init() {
|
|
cli.AppHelpTemplate = `{{.Name}} {{if .Flags}}[global options] {{end}}command{{if .Flags}} [command options]{{end}} [arguments...]
|
|
|
|
VERSION:
|
|
{{.Version}}
|
|
|
|
COMMANDS:
|
|
{{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
|
|
{{end}}{{if .Flags}}
|
|
GLOBAL OPTIONS:
|
|
{{range .Flags}}{{.}}
|
|
{{end}}{{end}}
|
|
`
|
|
|
|
cli.CommandHelpTemplate = CommandHelpTemplate
|
|
}
|
|
|
|
// NewApp creates an app with sane defaults.
|
|
func NewApp(gitCommit, usage string) *cli.App {
|
|
app := cli.NewApp()
|
|
app.Name = filepath.Base(os.Args[0])
|
|
app.Author = ""
|
|
//app.Authors = nil
|
|
app.Email = ""
|
|
app.Version = params.VersionWithMeta
|
|
if len(gitCommit) >= 8 {
|
|
app.Version += "-" + gitCommit[:8]
|
|
}
|
|
app.Usage = usage
|
|
return app
|
|
}
|
|
|
|
// These are all the command line flags we support.
|
|
// If you add to this list, please remember to include the
|
|
// flag in the appropriate command definition.
|
|
//
|
|
// The flags are defined here so their names and help texts
|
|
// are the same for all commands.
|
|
|
|
var (
|
|
// General settings
|
|
DataDirFlag = DirectoryFlag{
|
|
Name: "datadir",
|
|
Usage: "Data directory for the databases and keystore",
|
|
Value: DirectoryString{node.DefaultDataDir()},
|
|
}
|
|
KeyStoreDirFlag = DirectoryFlag{
|
|
Name: "keystore",
|
|
Usage: "Directory for the keystore (default = inside the datadir)",
|
|
}
|
|
NoUSBFlag = cli.BoolFlag{
|
|
Name: "nousb",
|
|
Usage: "Disables monitoring for and managing USB hardware wallets",
|
|
}
|
|
NetworkIdFlag = cli.Uint64Flag{
|
|
Name: "networkid",
|
|
Usage: "Network identifier (integer, 1=Frontier, 2=Morden (disused), 3=Ropsten, 4=Rinkeby)",
|
|
Value: eth.DefaultConfig.NetworkId,
|
|
}
|
|
TestnetFlag = cli.BoolFlag{
|
|
Name: "testnet",
|
|
Usage: "Ropsten network: pre-configured proof-of-work test network",
|
|
}
|
|
RinkebyFlag = cli.BoolFlag{
|
|
Name: "rinkeby",
|
|
Usage: "Rinkeby network: pre-configured proof-of-authority test network",
|
|
}
|
|
DeveloperFlag = cli.BoolFlag{
|
|
Name: "dev",
|
|
Usage: "Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled",
|
|
}
|
|
DeveloperPeriodFlag = cli.IntFlag{
|
|
Name: "dev.period",
|
|
Usage: "Block period to use in developer mode (0 = mine only if transaction pending)",
|
|
}
|
|
IdentityFlag = cli.StringFlag{
|
|
Name: "identity",
|
|
Usage: "Custom node name",
|
|
}
|
|
DocRootFlag = DirectoryFlag{
|
|
Name: "docroot",
|
|
Usage: "Document Root for HTTPClient file scheme",
|
|
Value: DirectoryString{homeDir()},
|
|
}
|
|
defaultSyncMode = eth.DefaultConfig.SyncMode
|
|
SyncModeFlag = TextMarshalerFlag{
|
|
Name: "syncmode",
|
|
Usage: `Blockchain sync mode ("fast", "full", or "light")`,
|
|
Value: &defaultSyncMode,
|
|
}
|
|
GCModeFlag = cli.StringFlag{
|
|
Name: "gcmode",
|
|
Usage: `Blockchain garbage collection mode ("full", "archive")`,
|
|
Value: "full",
|
|
}
|
|
LightServFlag = cli.IntFlag{
|
|
Name: "lightserv",
|
|
Usage: "Maximum percentage of time allowed for serving LES requests (0-90)",
|
|
Value: 0,
|
|
}
|
|
LightPeersFlag = cli.IntFlag{
|
|
Name: "lightpeers",
|
|
Usage: "Maximum number of LES client peers",
|
|
Value: eth.DefaultConfig.LightPeers,
|
|
}
|
|
LightKDFFlag = cli.BoolFlag{
|
|
Name: "lightkdf",
|
|
Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
|
|
}
|
|
// Dashboard settings
|
|
DashboardEnabledFlag = cli.BoolFlag{
|
|
Name: metrics.DashboardEnabledFlag,
|
|
Usage: "Enable the dashboard",
|
|
}
|
|
DashboardAddrFlag = cli.StringFlag{
|
|
Name: "dashboard.addr",
|
|
Usage: "Dashboard listening interface",
|
|
Value: dashboard.DefaultConfig.Host,
|
|
}
|
|
DashboardPortFlag = cli.IntFlag{
|
|
Name: "dashboard.host",
|
|
Usage: "Dashboard listening port",
|
|
Value: dashboard.DefaultConfig.Port,
|
|
}
|
|
DashboardRefreshFlag = cli.DurationFlag{
|
|
Name: "dashboard.refresh",
|
|
Usage: "Dashboard metrics collection refresh rate",
|
|
Value: dashboard.DefaultConfig.Refresh,
|
|
}
|
|
// Ethash settings
|
|
EthashCacheDirFlag = DirectoryFlag{
|
|
Name: "ethash.cachedir",
|
|
Usage: "Directory to store the ethash verification caches (default = inside the datadir)",
|
|
}
|
|
EthashCachesInMemoryFlag = cli.IntFlag{
|
|
Name: "ethash.cachesinmem",
|
|
Usage: "Number of recent ethash caches to keep in memory (16MB each)",
|
|
Value: eth.DefaultConfig.Ethash.CachesInMem,
|
|
}
|
|
EthashCachesOnDiskFlag = cli.IntFlag{
|
|
Name: "ethash.cachesondisk",
|
|
Usage: "Number of recent ethash caches to keep on disk (16MB each)",
|
|
Value: eth.DefaultConfig.Ethash.CachesOnDisk,
|
|
}
|
|
EthashDatasetDirFlag = DirectoryFlag{
|
|
Name: "ethash.dagdir",
|
|
Usage: "Directory to store the ethash mining DAGs (default = inside home folder)",
|
|
Value: DirectoryString{eth.DefaultConfig.Ethash.DatasetDir},
|
|
}
|
|
EthashDatasetsInMemoryFlag = cli.IntFlag{
|
|
Name: "ethash.dagsinmem",
|
|
Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
|
|
Value: eth.DefaultConfig.Ethash.DatasetsInMem,
|
|
}
|
|
EthashDatasetsOnDiskFlag = cli.IntFlag{
|
|
Name: "ethash.dagsondisk",
|
|
Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
|
|
Value: eth.DefaultConfig.Ethash.DatasetsOnDisk,
|
|
}
|
|
// Transaction pool settings
|
|
TxPoolLocalsFlag = cli.StringFlag{
|
|
Name: "txpool.locals",
|
|
Usage: "Comma separated accounts to treat as locals (no flush, priority inclusion)",
|
|
}
|
|
TxPoolNoLocalsFlag = cli.BoolFlag{
|
|
Name: "txpool.nolocals",
|
|
Usage: "Disables price exemptions for locally submitted transactions",
|
|
}
|
|
TxPoolJournalFlag = cli.StringFlag{
|
|
Name: "txpool.journal",
|
|
Usage: "Disk journal for local transaction to survive node restarts",
|
|
Value: core.DefaultTxPoolConfig.Journal,
|
|
}
|
|
TxPoolRejournalFlag = cli.DurationFlag{
|
|
Name: "txpool.rejournal",
|
|
Usage: "Time interval to regenerate the local transaction journal",
|
|
Value: core.DefaultTxPoolConfig.Rejournal,
|
|
}
|
|
TxPoolPriceLimitFlag = cli.Uint64Flag{
|
|
Name: "txpool.pricelimit",
|
|
Usage: "Minimum gas price limit to enforce for acceptance into the pool",
|
|
Value: eth.DefaultConfig.TxPool.PriceLimit,
|
|
}
|
|
TxPoolPriceBumpFlag = cli.Uint64Flag{
|
|
Name: "txpool.pricebump",
|
|
Usage: "Price bump percentage to replace an already existing transaction",
|
|
Value: eth.DefaultConfig.TxPool.PriceBump,
|
|
}
|
|
TxPoolAccountSlotsFlag = cli.Uint64Flag{
|
|
Name: "txpool.accountslots",
|
|
Usage: "Minimum number of executable transaction slots guaranteed per account",
|
|
Value: eth.DefaultConfig.TxPool.AccountSlots,
|
|
}
|
|
TxPoolGlobalSlotsFlag = cli.Uint64Flag{
|
|
Name: "txpool.globalslots",
|
|
Usage: "Maximum number of executable transaction slots for all accounts",
|
|
Value: eth.DefaultConfig.TxPool.GlobalSlots,
|
|
}
|
|
TxPoolAccountQueueFlag = cli.Uint64Flag{
|
|
Name: "txpool.accountqueue",
|
|
Usage: "Maximum number of non-executable transaction slots permitted per account",
|
|
Value: eth.DefaultConfig.TxPool.AccountQueue,
|
|
}
|
|
TxPoolGlobalQueueFlag = cli.Uint64Flag{
|
|
Name: "txpool.globalqueue",
|
|
Usage: "Maximum number of non-executable transaction slots for all accounts",
|
|
Value: eth.DefaultConfig.TxPool.GlobalQueue,
|
|
}
|
|
TxPoolLifetimeFlag = cli.DurationFlag{
|
|
Name: "txpool.lifetime",
|
|
Usage: "Maximum amount of time non-executable transaction are queued",
|
|
Value: eth.DefaultConfig.TxPool.Lifetime,
|
|
}
|
|
// Performance tuning settings
|
|
CacheFlag = cli.IntFlag{
|
|
Name: "cache",
|
|
Usage: "Megabytes of memory allocated to internal caching",
|
|
Value: 1024,
|
|
}
|
|
CacheDatabaseFlag = cli.IntFlag{
|
|
Name: "cache.database",
|
|
Usage: "Percentage of cache memory allowance to use for database io",
|
|
Value: 75,
|
|
}
|
|
CacheGCFlag = cli.IntFlag{
|
|
Name: "cache.gc",
|
|
Usage: "Percentage of cache memory allowance to use for trie pruning",
|
|
Value: 25,
|
|
}
|
|
TrieCacheGenFlag = cli.IntFlag{
|
|
Name: "trie-cache-gens",
|
|
Usage: "Number of trie node generations to keep in memory",
|
|
Value: int(state.MaxTrieCacheGen),
|
|
}
|
|
// Miner settings
|
|
MiningEnabledFlag = cli.BoolFlag{
|
|
Name: "mine",
|
|
Usage: "Enable mining",
|
|
}
|
|
MinerThreadsFlag = cli.IntFlag{
|
|
Name: "miner.threads",
|
|
Usage: "Number of CPU threads to use for mining",
|
|
Value: 0,
|
|
}
|
|
MinerLegacyThreadsFlag = cli.IntFlag{
|
|
Name: "minerthreads",
|
|
Usage: "Number of CPU threads to use for mining (deprecated, use --miner.threads)",
|
|
Value: 0,
|
|
}
|
|
MinerNotifyFlag = cli.StringFlag{
|
|
Name: "miner.notify",
|
|
Usage: "Comma separated HTTP URL list to notify of new work packages",
|
|
}
|
|
MinerGasTargetFlag = cli.Uint64Flag{
|
|
Name: "miner.gastarget",
|
|
Usage: "Target gas floor for mined blocks",
|
|
Value: eth.DefaultConfig.MinerGasFloor,
|
|
}
|
|
MinerLegacyGasTargetFlag = cli.Uint64Flag{
|
|
Name: "targetgaslimit",
|
|
Usage: "Target gas floor for mined blocks (deprecated, use --miner.gastarget)",
|
|
Value: eth.DefaultConfig.MinerGasFloor,
|
|
}
|
|
MinerGasLimitFlag = cli.Uint64Flag{
|
|
Name: "miner.gaslimit",
|
|
Usage: "Target gas ceiling for mined blocks",
|
|
Value: eth.DefaultConfig.MinerGasCeil,
|
|
}
|
|
MinerGasPriceFlag = BigFlag{
|
|
Name: "miner.gasprice",
|
|
Usage: "Minimum gas price for mining a transaction",
|
|
Value: eth.DefaultConfig.MinerGasPrice,
|
|
}
|
|
MinerLegacyGasPriceFlag = BigFlag{
|
|
Name: "gasprice",
|
|
Usage: "Minimum gas price for mining a transaction (deprecated, use --miner.gasprice)",
|
|
Value: eth.DefaultConfig.MinerGasPrice,
|
|
}
|
|
MinerEtherbaseFlag = cli.StringFlag{
|
|
Name: "miner.etherbase",
|
|
Usage: "Public address for block mining rewards (default = first account)",
|
|
Value: "0",
|
|
}
|
|
MinerLegacyEtherbaseFlag = cli.StringFlag{
|
|
Name: "etherbase",
|
|
Usage: "Public address for block mining rewards (default = first account, deprecated, use --miner.etherbase)",
|
|
Value: "0",
|
|
}
|
|
MinerExtraDataFlag = cli.StringFlag{
|
|
Name: "miner.extradata",
|
|
Usage: "Block extra data set by the miner (default = client version)",
|
|
}
|
|
MinerLegacyExtraDataFlag = cli.StringFlag{
|
|
Name: "extradata",
|
|
Usage: "Block extra data set by the miner (default = client version, deprecated, use --miner.extradata)",
|
|
}
|
|
MinerRecommitIntervalFlag = cli.DurationFlag{
|
|
Name: "miner.recommit",
|
|
Usage: "Time interval to recreate the block being mined",
|
|
Value: eth.DefaultConfig.MinerRecommit,
|
|
}
|
|
MinerNoVerfiyFlag = cli.BoolFlag{
|
|
Name: "miner.noverify",
|
|
Usage: "Disable remote sealing verification",
|
|
}
|
|
// Account settings
|
|
UnlockedAccountFlag = cli.StringFlag{
|
|
Name: "unlock",
|
|
Usage: "Comma separated list of accounts to unlock",
|
|
Value: "",
|
|
}
|
|
PasswordFileFlag = cli.StringFlag{
|
|
Name: "password",
|
|
Usage: "Password file to use for non-interactive password input",
|
|
Value: "",
|
|
}
|
|
|
|
VMEnableDebugFlag = cli.BoolFlag{
|
|
Name: "vmdebug",
|
|
Usage: "Record information useful for VM and contract debugging",
|
|
}
|
|
// Logging and debug settings
|
|
EthStatsURLFlag = cli.StringFlag{
|
|
Name: "ethstats",
|
|
Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
|
|
}
|
|
FakePoWFlag = cli.BoolFlag{
|
|
Name: "fakepow",
|
|
Usage: "Disables proof-of-work verification",
|
|
}
|
|
NoCompactionFlag = cli.BoolFlag{
|
|
Name: "nocompaction",
|
|
Usage: "Disables db compaction after import",
|
|
}
|
|
// RPC settings
|
|
RPCEnabledFlag = cli.BoolFlag{
|
|
Name: "rpc",
|
|
Usage: "Enable the HTTP-RPC server",
|
|
}
|
|
RPCListenAddrFlag = cli.StringFlag{
|
|
Name: "rpcaddr",
|
|
Usage: "HTTP-RPC server listening interface",
|
|
Value: node.DefaultHTTPHost,
|
|
}
|
|
RPCPortFlag = cli.IntFlag{
|
|
Name: "rpcport",
|
|
Usage: "HTTP-RPC server listening port",
|
|
Value: node.DefaultHTTPPort,
|
|
}
|
|
RPCCORSDomainFlag = cli.StringFlag{
|
|
Name: "rpccorsdomain",
|
|
Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
|
|
Value: "",
|
|
}
|
|
RPCVirtualHostsFlag = cli.StringFlag{
|
|
Name: "rpcvhosts",
|
|
Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
|
|
Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
|
|
}
|
|
RPCApiFlag = cli.StringFlag{
|
|
Name: "rpcapi",
|
|
Usage: "API's offered over the HTTP-RPC interface",
|
|
Value: "",
|
|
}
|
|
IPCDisabledFlag = cli.BoolFlag{
|
|
Name: "ipcdisable",
|
|
Usage: "Disable the IPC-RPC server",
|
|
}
|
|
IPCPathFlag = DirectoryFlag{
|
|
Name: "ipcpath",
|
|
Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
|
|
}
|
|
WSEnabledFlag = cli.BoolFlag{
|
|
Name: "ws",
|
|
Usage: "Enable the WS-RPC server",
|
|
}
|
|
WSListenAddrFlag = cli.StringFlag{
|
|
Name: "wsaddr",
|
|
Usage: "WS-RPC server listening interface",
|
|
Value: node.DefaultWSHost,
|
|
}
|
|
WSPortFlag = cli.IntFlag{
|
|
Name: "wsport",
|
|
Usage: "WS-RPC server listening port",
|
|
Value: node.DefaultWSPort,
|
|
}
|
|
WSApiFlag = cli.StringFlag{
|
|
Name: "wsapi",
|
|
Usage: "API's offered over the WS-RPC interface",
|
|
Value: "",
|
|
}
|
|
WSAllowedOriginsFlag = cli.StringFlag{
|
|
Name: "wsorigins",
|
|
Usage: "Origins from which to accept websockets requests",
|
|
Value: "",
|
|
}
|
|
ExecFlag = cli.StringFlag{
|
|
Name: "exec",
|
|
Usage: "Execute JavaScript statement",
|
|
}
|
|
PreloadJSFlag = cli.StringFlag{
|
|
Name: "preload",
|
|
Usage: "Comma separated list of JavaScript files to preload into the console",
|
|
}
|
|
|
|
// Network Settings
|
|
MaxPeersFlag = cli.IntFlag{
|
|
Name: "maxpeers",
|
|
Usage: "Maximum number of network peers (network disabled if set to 0)",
|
|
Value: 25,
|
|
}
|
|
MaxPendingPeersFlag = cli.IntFlag{
|
|
Name: "maxpendpeers",
|
|
Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
|
|
Value: 0,
|
|
}
|
|
ListenPortFlag = cli.IntFlag{
|
|
Name: "port",
|
|
Usage: "Network listening port",
|
|
Value: 30303,
|
|
}
|
|
BootnodesFlag = cli.StringFlag{
|
|
Name: "bootnodes",
|
|
Usage: "Comma separated enode URLs for P2P discovery bootstrap (set v4+v5 instead for light servers)",
|
|
Value: "",
|
|
}
|
|
BootnodesV4Flag = cli.StringFlag{
|
|
Name: "bootnodesv4",
|
|
Usage: "Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes)",
|
|
Value: "",
|
|
}
|
|
BootnodesV5Flag = cli.StringFlag{
|
|
Name: "bootnodesv5",
|
|
Usage: "Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes)",
|
|
Value: "",
|
|
}
|
|
NodeKeyFileFlag = cli.StringFlag{
|
|
Name: "nodekey",
|
|
Usage: "P2P node key file",
|
|
}
|
|
NodeKeyHexFlag = cli.StringFlag{
|
|
Name: "nodekeyhex",
|
|
Usage: "P2P node key as hex (for testing)",
|
|
}
|
|
NATFlag = cli.StringFlag{
|
|
Name: "nat",
|
|
Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
|
|
Value: "any",
|
|
}
|
|
NoDiscoverFlag = cli.BoolFlag{
|
|
Name: "nodiscover",
|
|
Usage: "Disables the peer discovery mechanism (manual peer addition)",
|
|
}
|
|
DiscoveryV5Flag = cli.BoolFlag{
|
|
Name: "v5disc",
|
|
Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
|
|
}
|
|
NetrestrictFlag = cli.StringFlag{
|
|
Name: "netrestrict",
|
|
Usage: "Restricts network communication to the given IP networks (CIDR masks)",
|
|
}
|
|
|
|
// ATM the url is left to the user and deployment to
|
|
JSpathFlag = cli.StringFlag{
|
|
Name: "jspath",
|
|
Usage: "JavaScript root path for `loadScript`",
|
|
Value: ".",
|
|
}
|
|
|
|
// Gas price oracle settings
|
|
GpoBlocksFlag = cli.IntFlag{
|
|
Name: "gpoblocks",
|
|
Usage: "Number of recent blocks to check for gas prices",
|
|
Value: eth.DefaultConfig.GPO.Blocks,
|
|
}
|
|
GpoPercentileFlag = cli.IntFlag{
|
|
Name: "gpopercentile",
|
|
Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
|
|
Value: eth.DefaultConfig.GPO.Percentile,
|
|
}
|
|
WhisperEnabledFlag = cli.BoolFlag{
|
|
Name: "shh",
|
|
Usage: "Enable Whisper",
|
|
}
|
|
WhisperMaxMessageSizeFlag = cli.IntFlag{
|
|
Name: "shh.maxmessagesize",
|
|
Usage: "Max message size accepted",
|
|
Value: int(whisper.DefaultMaxMessageSize),
|
|
}
|
|
WhisperMinPOWFlag = cli.Float64Flag{
|
|
Name: "shh.pow",
|
|
Usage: "Minimum POW accepted",
|
|
Value: whisper.DefaultMinimumPoW,
|
|
}
|
|
WhisperRestrictConnectionBetweenLightClientsFlag = cli.BoolFlag{
|
|
Name: "shh.restrict-light",
|
|
Usage: "Restrict connection between two whisper light clients",
|
|
}
|
|
|
|
// Metrics flags
|
|
MetricsEnabledFlag = cli.BoolFlag{
|
|
Name: metrics.MetricsEnabledFlag,
|
|
Usage: "Enable metrics collection and reporting",
|
|
}
|
|
MetricsEnableInfluxDBFlag = cli.BoolFlag{
|
|
Name: "metrics.influxdb",
|
|
Usage: "Enable metrics export/push to an external InfluxDB database",
|
|
}
|
|
MetricsInfluxDBEndpointFlag = cli.StringFlag{
|
|
Name: "metrics.influxdb.endpoint",
|
|
Usage: "InfluxDB API endpoint to report metrics to",
|
|
Value: "http://localhost:8086",
|
|
}
|
|
MetricsInfluxDBDatabaseFlag = cli.StringFlag{
|
|
Name: "metrics.influxdb.database",
|
|
Usage: "InfluxDB database name to push reported metrics to",
|
|
Value: "geth",
|
|
}
|
|
MetricsInfluxDBUsernameFlag = cli.StringFlag{
|
|
Name: "metrics.influxdb.username",
|
|
Usage: "Username to authorize access to the database",
|
|
Value: "test",
|
|
}
|
|
MetricsInfluxDBPasswordFlag = cli.StringFlag{
|
|
Name: "metrics.influxdb.password",
|
|
Usage: "Password to authorize access to the database",
|
|
Value: "test",
|
|
}
|
|
// The `host` tag is part of every measurement sent to InfluxDB. Queries on tags are faster in InfluxDB.
|
|
// It is used so that we can group all nodes and average a measurement across all of them, but also so
|
|
// that we can select a specific node and inspect its measurements.
|
|
// https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
|
|
MetricsInfluxDBHostTagFlag = cli.StringFlag{
|
|
Name: "metrics.influxdb.host.tag",
|
|
Usage: "InfluxDB `host` tag attached to all measurements",
|
|
Value: "localhost",
|
|
}
|
|
|
|
EWASMInterpreterFlag = cli.StringFlag{
|
|
Name: "vm.ewasm",
|
|
Usage: "External ewasm configuration (default = built-in interpreter)",
|
|
Value: "",
|
|
}
|
|
EVMInterpreterFlag = cli.StringFlag{
|
|
Name: "vm.evm",
|
|
Usage: "External EVM configuration (default = built-in interpreter)",
|
|
Value: "",
|
|
}
|
|
)
|
|
|
|
// MakeDataDir retrieves the currently requested data directory, terminating
|
|
// if none (or the empty string) is specified. If the node is starting a testnet,
|
|
// the a subdirectory of the specified datadir will be used.
|
|
func MakeDataDir(ctx *cli.Context) string {
|
|
if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
|
|
if ctx.GlobalBool(TestnetFlag.Name) {
|
|
return filepath.Join(path, "testnet")
|
|
}
|
|
if ctx.GlobalBool(RinkebyFlag.Name) {
|
|
return filepath.Join(path, "rinkeby")
|
|
}
|
|
return path
|
|
}
|
|
Fatalf("Cannot determine default data directory, please set manually (--datadir)")
|
|
return ""
|
|
}
|
|
|
|
// setNodeKey creates a node key from set command line flags, either loading it
|
|
// from a file or as a specified hex value. If neither flags were provided, this
|
|
// method returns nil and an emphemeral key is to be generated.
|
|
func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
|
|
var (
|
|
hex = ctx.GlobalString(NodeKeyHexFlag.Name)
|
|
file = ctx.GlobalString(NodeKeyFileFlag.Name)
|
|
key *ecdsa.PrivateKey
|
|
err error
|
|
)
|
|
switch {
|
|
case file != "" && hex != "":
|
|
Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
|
|
case file != "":
|
|
if key, err = crypto.LoadECDSA(file); err != nil {
|
|
Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
|
|
}
|
|
cfg.PrivateKey = key
|
|
case hex != "":
|
|
if key, err = crypto.HexToECDSA(hex); err != nil {
|
|
Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
|
|
}
|
|
cfg.PrivateKey = key
|
|
}
|
|
}
|
|
|
|
// setNodeUserIdent creates the user identifier from CLI flags.
|
|
func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
|
|
if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
|
|
cfg.UserIdent = identity
|
|
}
|
|
}
|
|
|
|
// setBootstrapNodes creates a list of bootstrap nodes from the command line
|
|
// flags, reverting to pre-configured ones if none have been specified.
|
|
func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
|
|
urls := params.MainnetBootnodes
|
|
switch {
|
|
case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV4Flag.Name):
|
|
if ctx.GlobalIsSet(BootnodesV4Flag.Name) {
|
|
urls = strings.Split(ctx.GlobalString(BootnodesV4Flag.Name), ",")
|
|
} else {
|
|
urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
|
|
}
|
|
case ctx.GlobalBool(TestnetFlag.Name):
|
|
urls = params.TestnetBootnodes
|
|
case ctx.GlobalBool(RinkebyFlag.Name):
|
|
urls = params.RinkebyBootnodes
|
|
case cfg.BootstrapNodes != nil:
|
|
return // already set, don't apply defaults.
|
|
}
|
|
|
|
cfg.BootstrapNodes = make([]*enode.Node, 0, len(urls))
|
|
for _, url := range urls {
|
|
node, err := enode.ParseV4(url)
|
|
if err != nil {
|
|
log.Crit("Bootstrap URL invalid", "enode", url, "err", err)
|
|
}
|
|
cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
|
|
}
|
|
}
|
|
|
|
// setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
|
|
// flags, reverting to pre-configured ones if none have been specified.
|
|
func setBootstrapNodesV5(ctx *cli.Context, cfg *p2p.Config) {
|
|
urls := params.DiscoveryV5Bootnodes
|
|
switch {
|
|
case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV5Flag.Name):
|
|
if ctx.GlobalIsSet(BootnodesV5Flag.Name) {
|
|
urls = strings.Split(ctx.GlobalString(BootnodesV5Flag.Name), ",")
|
|
} else {
|
|
urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
|
|
}
|
|
case ctx.GlobalBool(RinkebyFlag.Name):
|
|
urls = params.RinkebyBootnodes
|
|
case cfg.BootstrapNodesV5 != nil:
|
|
return // already set, don't apply defaults.
|
|
}
|
|
|
|
cfg.BootstrapNodesV5 = make([]*discv5.Node, 0, len(urls))
|
|
for _, url := range urls {
|
|
node, err := discv5.ParseNode(url)
|
|
if err != nil {
|
|
log.Error("Bootstrap URL invalid", "enode", url, "err", err)
|
|
continue
|
|
}
|
|
cfg.BootstrapNodesV5 = append(cfg.BootstrapNodesV5, node)
|
|
}
|
|
}
|
|
|
|
// setListenAddress creates a TCP listening address string from set command
|
|
// line flags.
|
|
func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
|
|
if ctx.GlobalIsSet(ListenPortFlag.Name) {
|
|
cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
|
|
}
|
|
}
|
|
|
|
// setNAT creates a port mapper from command line flags.
|
|
func setNAT(ctx *cli.Context, cfg *p2p.Config) {
|
|
if ctx.GlobalIsSet(NATFlag.Name) {
|
|
natif, err := nat.Parse(ctx.GlobalString(NATFlag.Name))
|
|
if err != nil {
|
|
Fatalf("Option %s: %v", NATFlag.Name, err)
|
|
}
|
|
cfg.NAT = natif
|
|
}
|
|
}
|
|
|
|
// splitAndTrim splits input separated by a comma
|
|
// and trims excessive white space from the substrings.
|
|
func splitAndTrim(input string) []string {
|
|
result := strings.Split(input, ",")
|
|
for i, r := range result {
|
|
result[i] = strings.TrimSpace(r)
|
|
}
|
|
return result
|
|
}
|
|
|
|
// setHTTP creates the HTTP RPC listener interface string from the set
|
|
// command line flags, returning empty if the HTTP endpoint is disabled.
|
|
func setHTTP(ctx *cli.Context, cfg *node.Config) {
|
|
if ctx.GlobalBool(RPCEnabledFlag.Name) && cfg.HTTPHost == "" {
|
|
cfg.HTTPHost = "127.0.0.1"
|
|
if ctx.GlobalIsSet(RPCListenAddrFlag.Name) {
|
|
cfg.HTTPHost = ctx.GlobalString(RPCListenAddrFlag.Name)
|
|
}
|
|
}
|
|
|
|
if ctx.GlobalIsSet(RPCPortFlag.Name) {
|
|
cfg.HTTPPort = ctx.GlobalInt(RPCPortFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(RPCCORSDomainFlag.Name) {
|
|
cfg.HTTPCors = splitAndTrim(ctx.GlobalString(RPCCORSDomainFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(RPCApiFlag.Name) {
|
|
cfg.HTTPModules = splitAndTrim(ctx.GlobalString(RPCApiFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(RPCVirtualHostsFlag.Name) {
|
|
cfg.HTTPVirtualHosts = splitAndTrim(ctx.GlobalString(RPCVirtualHostsFlag.Name))
|
|
}
|
|
}
|
|
|
|
// setWS creates the WebSocket RPC listener interface string from the set
|
|
// command line flags, returning empty if the HTTP endpoint is disabled.
|
|
func setWS(ctx *cli.Context, cfg *node.Config) {
|
|
if ctx.GlobalBool(WSEnabledFlag.Name) && cfg.WSHost == "" {
|
|
cfg.WSHost = "127.0.0.1"
|
|
if ctx.GlobalIsSet(WSListenAddrFlag.Name) {
|
|
cfg.WSHost = ctx.GlobalString(WSListenAddrFlag.Name)
|
|
}
|
|
}
|
|
|
|
if ctx.GlobalIsSet(WSPortFlag.Name) {
|
|
cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {
|
|
cfg.WSOrigins = splitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(WSApiFlag.Name) {
|
|
cfg.WSModules = splitAndTrim(ctx.GlobalString(WSApiFlag.Name))
|
|
}
|
|
}
|
|
|
|
// setIPC creates an IPC path configuration from the set command line flags,
|
|
// returning an empty string if IPC was explicitly disabled, or the set path.
|
|
func setIPC(ctx *cli.Context, cfg *node.Config) {
|
|
checkExclusive(ctx, IPCDisabledFlag, IPCPathFlag)
|
|
switch {
|
|
case ctx.GlobalBool(IPCDisabledFlag.Name):
|
|
cfg.IPCPath = ""
|
|
case ctx.GlobalIsSet(IPCPathFlag.Name):
|
|
cfg.IPCPath = ctx.GlobalString(IPCPathFlag.Name)
|
|
}
|
|
}
|
|
|
|
// makeDatabaseHandles raises out the number of allowed file handles per process
|
|
// for Geth and returns half of the allowance to assign to the database.
|
|
func makeDatabaseHandles() int {
|
|
limit, err := fdlimit.Current()
|
|
if err != nil {
|
|
Fatalf("Failed to retrieve file descriptor allowance: %v", err)
|
|
}
|
|
if limit < 2048 {
|
|
if err := fdlimit.Raise(2048); err != nil {
|
|
Fatalf("Failed to raise file descriptor allowance: %v", err)
|
|
}
|
|
}
|
|
if limit > 2048 { // cap database file descriptors even if more is available
|
|
limit = 2048
|
|
}
|
|
return limit / 2 // Leave half for networking and other stuff
|
|
}
|
|
|
|
// MakeAddress converts an account specified directly as a hex encoded string or
|
|
// a key index in the key store to an internal account representation.
|
|
func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
|
|
// If the specified account is a valid address, return it
|
|
if common.IsHexAddress(account) {
|
|
return accounts.Account{Address: common.HexToAddress(account)}, nil
|
|
}
|
|
// Otherwise try to interpret the account as a keystore index
|
|
index, err := strconv.Atoi(account)
|
|
if err != nil || index < 0 {
|
|
return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
|
|
}
|
|
log.Warn("-------------------------------------------------------------------")
|
|
log.Warn("Referring to accounts by order in the keystore folder is dangerous!")
|
|
log.Warn("This functionality is deprecated and will be removed in the future!")
|
|
log.Warn("Please use explicit addresses! (can search via `geth account list`)")
|
|
log.Warn("-------------------------------------------------------------------")
|
|
|
|
accs := ks.Accounts()
|
|
if len(accs) <= index {
|
|
return accounts.Account{}, fmt.Errorf("index %d higher than number of accounts %d", index, len(accs))
|
|
}
|
|
return accs[index], nil
|
|
}
|
|
|
|
// setEtherbase retrieves the etherbase either from the directly specified
|
|
// command line flags or from the keystore if CLI indexed.
|
|
func setEtherbase(ctx *cli.Context, ks *keystore.KeyStore, cfg *eth.Config) {
|
|
// Extract the current etherbase, new flag overriding legacy one
|
|
var etherbase string
|
|
if ctx.GlobalIsSet(MinerLegacyEtherbaseFlag.Name) {
|
|
etherbase = ctx.GlobalString(MinerLegacyEtherbaseFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerEtherbaseFlag.Name) {
|
|
etherbase = ctx.GlobalString(MinerEtherbaseFlag.Name)
|
|
}
|
|
// Convert the etherbase into an address and configure it
|
|
if etherbase != "" {
|
|
account, err := MakeAddress(ks, etherbase)
|
|
if err != nil {
|
|
Fatalf("Invalid miner etherbase: %v", err)
|
|
}
|
|
cfg.Etherbase = account.Address
|
|
}
|
|
}
|
|
|
|
// MakePasswordList reads password lines from the file specified by the global --password flag.
|
|
func MakePasswordList(ctx *cli.Context) []string {
|
|
path := ctx.GlobalString(PasswordFileFlag.Name)
|
|
if path == "" {
|
|
return nil
|
|
}
|
|
text, err := ioutil.ReadFile(path)
|
|
if err != nil {
|
|
Fatalf("Failed to read password file: %v", err)
|
|
}
|
|
lines := strings.Split(string(text), "\n")
|
|
// Sanitise DOS line endings.
|
|
for i := range lines {
|
|
lines[i] = strings.TrimRight(lines[i], "\r")
|
|
}
|
|
return lines
|
|
}
|
|
|
|
func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
|
|
setNodeKey(ctx, cfg)
|
|
setNAT(ctx, cfg)
|
|
setListenAddress(ctx, cfg)
|
|
setBootstrapNodes(ctx, cfg)
|
|
setBootstrapNodesV5(ctx, cfg)
|
|
|
|
lightClient := ctx.GlobalString(SyncModeFlag.Name) == "light"
|
|
lightServer := ctx.GlobalInt(LightServFlag.Name) != 0
|
|
lightPeers := ctx.GlobalInt(LightPeersFlag.Name)
|
|
|
|
if ctx.GlobalIsSet(MaxPeersFlag.Name) {
|
|
cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
|
|
if lightServer && !ctx.GlobalIsSet(LightPeersFlag.Name) {
|
|
cfg.MaxPeers += lightPeers
|
|
}
|
|
} else {
|
|
if lightServer {
|
|
cfg.MaxPeers += lightPeers
|
|
}
|
|
if lightClient && ctx.GlobalIsSet(LightPeersFlag.Name) && cfg.MaxPeers < lightPeers {
|
|
cfg.MaxPeers = lightPeers
|
|
}
|
|
}
|
|
if !(lightClient || lightServer) {
|
|
lightPeers = 0
|
|
}
|
|
ethPeers := cfg.MaxPeers - lightPeers
|
|
if lightClient {
|
|
ethPeers = 0
|
|
}
|
|
log.Info("Maximum peer count", "ETH", ethPeers, "LES", lightPeers, "total", cfg.MaxPeers)
|
|
|
|
if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
|
|
cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(NoDiscoverFlag.Name) || lightClient {
|
|
cfg.NoDiscovery = true
|
|
}
|
|
|
|
// if we're running a light client or server, force enable the v5 peer discovery
|
|
// unless it is explicitly disabled with --nodiscover note that explicitly specifying
|
|
// --v5disc overrides --nodiscover, in which case the later only disables v4 discovery
|
|
forceV5Discovery := (lightClient || lightServer) && !ctx.GlobalBool(NoDiscoverFlag.Name)
|
|
if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
|
|
cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
|
|
} else if forceV5Discovery {
|
|
cfg.DiscoveryV5 = true
|
|
}
|
|
|
|
if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
|
|
list, err := netutil.ParseNetlist(netrestrict)
|
|
if err != nil {
|
|
Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
|
|
}
|
|
cfg.NetRestrict = list
|
|
}
|
|
|
|
if ctx.GlobalBool(DeveloperFlag.Name) {
|
|
// --dev mode can't use p2p networking.
|
|
cfg.MaxPeers = 0
|
|
cfg.ListenAddr = ":0"
|
|
cfg.NoDiscovery = true
|
|
cfg.DiscoveryV5 = false
|
|
}
|
|
}
|
|
|
|
// SetNodeConfig applies node-related command line flags to the config.
|
|
func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
|
|
SetP2PConfig(ctx, &cfg.P2P)
|
|
setIPC(ctx, cfg)
|
|
setHTTP(ctx, cfg)
|
|
setWS(ctx, cfg)
|
|
setNodeUserIdent(ctx, cfg)
|
|
|
|
switch {
|
|
case ctx.GlobalIsSet(DataDirFlag.Name):
|
|
cfg.DataDir = ctx.GlobalString(DataDirFlag.Name)
|
|
case ctx.GlobalBool(DeveloperFlag.Name):
|
|
cfg.DataDir = "" // unless explicitly requested, use memory databases
|
|
case ctx.GlobalBool(TestnetFlag.Name):
|
|
cfg.DataDir = filepath.Join(node.DefaultDataDir(), "testnet")
|
|
case ctx.GlobalBool(RinkebyFlag.Name):
|
|
cfg.DataDir = filepath.Join(node.DefaultDataDir(), "rinkeby")
|
|
}
|
|
|
|
if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
|
|
cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(LightKDFFlag.Name) {
|
|
cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(NoUSBFlag.Name) {
|
|
cfg.NoUSB = ctx.GlobalBool(NoUSBFlag.Name)
|
|
}
|
|
}
|
|
|
|
func setGPO(ctx *cli.Context, cfg *gasprice.Config) {
|
|
if ctx.GlobalIsSet(GpoBlocksFlag.Name) {
|
|
cfg.Blocks = ctx.GlobalInt(GpoBlocksFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(GpoPercentileFlag.Name) {
|
|
cfg.Percentile = ctx.GlobalInt(GpoPercentileFlag.Name)
|
|
}
|
|
}
|
|
|
|
func setTxPool(ctx *cli.Context, cfg *core.TxPoolConfig) {
|
|
if ctx.GlobalIsSet(TxPoolLocalsFlag.Name) {
|
|
locals := strings.Split(ctx.GlobalString(TxPoolLocalsFlag.Name), ",")
|
|
for _, account := range locals {
|
|
if trimmed := strings.TrimSpace(account); !common.IsHexAddress(trimmed) {
|
|
Fatalf("Invalid account in --txpool.locals: %s", trimmed)
|
|
} else {
|
|
cfg.Locals = append(cfg.Locals, common.HexToAddress(account))
|
|
}
|
|
}
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolNoLocalsFlag.Name) {
|
|
cfg.NoLocals = ctx.GlobalBool(TxPoolNoLocalsFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolJournalFlag.Name) {
|
|
cfg.Journal = ctx.GlobalString(TxPoolJournalFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolRejournalFlag.Name) {
|
|
cfg.Rejournal = ctx.GlobalDuration(TxPoolRejournalFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolPriceLimitFlag.Name) {
|
|
cfg.PriceLimit = ctx.GlobalUint64(TxPoolPriceLimitFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolPriceBumpFlag.Name) {
|
|
cfg.PriceBump = ctx.GlobalUint64(TxPoolPriceBumpFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolAccountSlotsFlag.Name) {
|
|
cfg.AccountSlots = ctx.GlobalUint64(TxPoolAccountSlotsFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolGlobalSlotsFlag.Name) {
|
|
cfg.GlobalSlots = ctx.GlobalUint64(TxPoolGlobalSlotsFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolAccountQueueFlag.Name) {
|
|
cfg.AccountQueue = ctx.GlobalUint64(TxPoolAccountQueueFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolGlobalQueueFlag.Name) {
|
|
cfg.GlobalQueue = ctx.GlobalUint64(TxPoolGlobalQueueFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(TxPoolLifetimeFlag.Name) {
|
|
cfg.Lifetime = ctx.GlobalDuration(TxPoolLifetimeFlag.Name)
|
|
}
|
|
}
|
|
|
|
func setEthash(ctx *cli.Context, cfg *eth.Config) {
|
|
if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
|
|
cfg.Ethash.CacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
|
|
cfg.Ethash.DatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
|
|
cfg.Ethash.CachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
|
|
cfg.Ethash.CachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
|
|
cfg.Ethash.DatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
|
|
cfg.Ethash.DatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
|
|
}
|
|
}
|
|
|
|
// checkExclusive verifies that only a single instance of the provided flags was
|
|
// set by the user. Each flag might optionally be followed by a string type to
|
|
// specialize it further.
|
|
func checkExclusive(ctx *cli.Context, args ...interface{}) {
|
|
set := make([]string, 0, 1)
|
|
for i := 0; i < len(args); i++ {
|
|
// Make sure the next argument is a flag and skip if not set
|
|
flag, ok := args[i].(cli.Flag)
|
|
if !ok {
|
|
panic(fmt.Sprintf("invalid argument, not cli.Flag type: %T", args[i]))
|
|
}
|
|
// Check if next arg extends current and expand its name if so
|
|
name := flag.GetName()
|
|
|
|
if i+1 < len(args) {
|
|
switch option := args[i+1].(type) {
|
|
case string:
|
|
// Extended flag, expand the name and shift the arguments
|
|
if ctx.GlobalString(flag.GetName()) == option {
|
|
name += "=" + option
|
|
}
|
|
i++
|
|
|
|
case cli.Flag:
|
|
default:
|
|
panic(fmt.Sprintf("invalid argument, not cli.Flag or string extension: %T", args[i+1]))
|
|
}
|
|
}
|
|
// Mark the flag if it's set
|
|
if ctx.GlobalIsSet(flag.GetName()) {
|
|
set = append(set, "--"+name)
|
|
}
|
|
}
|
|
if len(set) > 1 {
|
|
Fatalf("Flags %v can't be used at the same time", strings.Join(set, ", "))
|
|
}
|
|
}
|
|
|
|
// SetShhConfig applies shh-related command line flags to the config.
|
|
func SetShhConfig(ctx *cli.Context, stack *node.Node, cfg *whisper.Config) {
|
|
if ctx.GlobalIsSet(WhisperMaxMessageSizeFlag.Name) {
|
|
cfg.MaxMessageSize = uint32(ctx.GlobalUint(WhisperMaxMessageSizeFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(WhisperMinPOWFlag.Name) {
|
|
cfg.MinimumAcceptedPOW = ctx.GlobalFloat64(WhisperMinPOWFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(WhisperRestrictConnectionBetweenLightClientsFlag.Name) {
|
|
cfg.RestrictConnectionBetweenLightClients = true
|
|
}
|
|
}
|
|
|
|
// SetEthConfig applies eth-related command line flags to the config.
|
|
func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *eth.Config) {
|
|
// Avoid conflicting network flags
|
|
checkExclusive(ctx, DeveloperFlag, TestnetFlag, RinkebyFlag)
|
|
checkExclusive(ctx, LightServFlag, SyncModeFlag, "light")
|
|
|
|
ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
|
|
setEtherbase(ctx, ks, cfg)
|
|
setGPO(ctx, &cfg.GPO)
|
|
setTxPool(ctx, &cfg.TxPool)
|
|
setEthash(ctx, cfg)
|
|
|
|
if ctx.GlobalIsSet(SyncModeFlag.Name) {
|
|
cfg.SyncMode = *GlobalTextMarshaler(ctx, SyncModeFlag.Name).(*downloader.SyncMode)
|
|
}
|
|
if ctx.GlobalIsSet(LightServFlag.Name) {
|
|
cfg.LightServ = ctx.GlobalInt(LightServFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(LightPeersFlag.Name) {
|
|
cfg.LightPeers = ctx.GlobalInt(LightPeersFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(NetworkIdFlag.Name) {
|
|
cfg.NetworkId = ctx.GlobalUint64(NetworkIdFlag.Name)
|
|
}
|
|
|
|
if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheDatabaseFlag.Name) {
|
|
cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
|
|
}
|
|
cfg.DatabaseHandles = makeDatabaseHandles()
|
|
|
|
if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
|
|
Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
|
|
}
|
|
cfg.NoPruning = ctx.GlobalString(GCModeFlag.Name) == "archive"
|
|
|
|
if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
|
|
cfg.TrieCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
|
|
}
|
|
if ctx.GlobalIsSet(MinerNotifyFlag.Name) {
|
|
cfg.MinerNotify = strings.Split(ctx.GlobalString(MinerNotifyFlag.Name), ",")
|
|
}
|
|
if ctx.GlobalIsSet(DocRootFlag.Name) {
|
|
cfg.DocRoot = ctx.GlobalString(DocRootFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerLegacyExtraDataFlag.Name) {
|
|
cfg.MinerExtraData = []byte(ctx.GlobalString(MinerLegacyExtraDataFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {
|
|
cfg.MinerExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))
|
|
}
|
|
if ctx.GlobalIsSet(MinerLegacyGasTargetFlag.Name) {
|
|
cfg.MinerGasFloor = ctx.GlobalUint64(MinerLegacyGasTargetFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {
|
|
cfg.MinerGasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {
|
|
cfg.MinerGasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerLegacyGasPriceFlag.Name) {
|
|
cfg.MinerGasPrice = GlobalBig(ctx, MinerLegacyGasPriceFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerGasPriceFlag.Name) {
|
|
cfg.MinerGasPrice = GlobalBig(ctx, MinerGasPriceFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerRecommitIntervalFlag.Name) {
|
|
cfg.MinerRecommit = ctx.Duration(MinerRecommitIntervalFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
|
|
cfg.MinerNoverify = ctx.Bool(MinerNoVerfiyFlag.Name)
|
|
}
|
|
if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
|
|
// TODO(fjl): force-enable this in --dev mode
|
|
cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
|
|
}
|
|
|
|
if ctx.GlobalIsSet(EWASMInterpreterFlag.Name) {
|
|
cfg.EWASMInterpreter = ctx.GlobalString(EWASMInterpreterFlag.Name)
|
|
}
|
|
|
|
if ctx.GlobalIsSet(EVMInterpreterFlag.Name) {
|
|
cfg.EVMInterpreter = ctx.GlobalString(EVMInterpreterFlag.Name)
|
|
}
|
|
|
|
// Override any default configs for hard coded networks.
|
|
switch {
|
|
case ctx.GlobalBool(TestnetFlag.Name):
|
|
if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
|
|
cfg.NetworkId = 3
|
|
}
|
|
cfg.Genesis = core.DefaultTestnetGenesisBlock()
|
|
case ctx.GlobalBool(RinkebyFlag.Name):
|
|
if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
|
|
cfg.NetworkId = 4
|
|
}
|
|
cfg.Genesis = core.DefaultRinkebyGenesisBlock()
|
|
case ctx.GlobalBool(DeveloperFlag.Name):
|
|
if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
|
|
cfg.NetworkId = 1337
|
|
}
|
|
// Create new developer account or reuse existing one
|
|
var (
|
|
developer accounts.Account
|
|
err error
|
|
)
|
|
if accs := ks.Accounts(); len(accs) > 0 {
|
|
developer = ks.Accounts()[0]
|
|
} else {
|
|
developer, err = ks.NewAccount("")
|
|
if err != nil {
|
|
Fatalf("Failed to create developer account: %v", err)
|
|
}
|
|
}
|
|
if err := ks.Unlock(developer, ""); err != nil {
|
|
Fatalf("Failed to unlock developer account: %v", err)
|
|
}
|
|
log.Info("Using developer account", "address", developer.Address)
|
|
|
|
cfg.Genesis = core.DeveloperGenesisBlock(uint64(ctx.GlobalInt(DeveloperPeriodFlag.Name)), developer.Address)
|
|
if !ctx.GlobalIsSet(MinerGasPriceFlag.Name) && !ctx.GlobalIsSet(MinerLegacyGasPriceFlag.Name) {
|
|
cfg.MinerGasPrice = big.NewInt(1)
|
|
}
|
|
}
|
|
// TODO(fjl): move trie cache generations into config
|
|
if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
|
|
state.MaxTrieCacheGen = uint16(gen)
|
|
}
|
|
}
|
|
|
|
// SetDashboardConfig applies dashboard related command line flags to the config.
|
|
func SetDashboardConfig(ctx *cli.Context, cfg *dashboard.Config) {
|
|
cfg.Host = ctx.GlobalString(DashboardAddrFlag.Name)
|
|
cfg.Port = ctx.GlobalInt(DashboardPortFlag.Name)
|
|
cfg.Refresh = ctx.GlobalDuration(DashboardRefreshFlag.Name)
|
|
}
|
|
|
|
// RegisterEthService adds an Ethereum client to the stack.
|
|
func RegisterEthService(stack *node.Node, cfg *eth.Config) {
|
|
var err error
|
|
if cfg.SyncMode == downloader.LightSync {
|
|
err = stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
|
|
return les.New(ctx, cfg)
|
|
})
|
|
} else {
|
|
err = stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
|
|
fullNode, err := eth.New(ctx, cfg)
|
|
if fullNode != nil && cfg.LightServ > 0 {
|
|
ls, _ := les.NewLesServer(fullNode, cfg)
|
|
fullNode.AddLesServer(ls)
|
|
}
|
|
return fullNode, err
|
|
})
|
|
}
|
|
if err != nil {
|
|
Fatalf("Failed to register the Ethereum service: %v", err)
|
|
}
|
|
}
|
|
|
|
// RegisterDashboardService adds a dashboard to the stack.
|
|
func RegisterDashboardService(stack *node.Node, cfg *dashboard.Config, commit string) {
|
|
stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
|
|
return dashboard.New(cfg, commit, ctx.ResolvePath("logs")), nil
|
|
})
|
|
}
|
|
|
|
// RegisterShhService configures Whisper and adds it to the given node.
|
|
func RegisterShhService(stack *node.Node, cfg *whisper.Config) {
|
|
if err := stack.Register(func(n *node.ServiceContext) (node.Service, error) {
|
|
return whisper.New(cfg), nil
|
|
}); err != nil {
|
|
Fatalf("Failed to register the Whisper service: %v", err)
|
|
}
|
|
}
|
|
|
|
// RegisterEthStatsService configures the Ethereum Stats daemon and adds it to
|
|
// the given node.
|
|
func RegisterEthStatsService(stack *node.Node, url string) {
|
|
if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
|
|
// Retrieve both eth and les services
|
|
var ethServ *eth.Ethereum
|
|
ctx.Service(ðServ)
|
|
|
|
var lesServ *les.LightEthereum
|
|
ctx.Service(&lesServ)
|
|
|
|
return ethstats.New(url, ethServ, lesServ)
|
|
}); err != nil {
|
|
Fatalf("Failed to register the Ethereum Stats service: %v", err)
|
|
}
|
|
}
|
|
|
|
func SetupMetrics(ctx *cli.Context) {
|
|
if metrics.Enabled {
|
|
log.Info("Enabling metrics collection")
|
|
var (
|
|
enableExport = ctx.GlobalBool(MetricsEnableInfluxDBFlag.Name)
|
|
endpoint = ctx.GlobalString(MetricsInfluxDBEndpointFlag.Name)
|
|
database = ctx.GlobalString(MetricsInfluxDBDatabaseFlag.Name)
|
|
username = ctx.GlobalString(MetricsInfluxDBUsernameFlag.Name)
|
|
password = ctx.GlobalString(MetricsInfluxDBPasswordFlag.Name)
|
|
hosttag = ctx.GlobalString(MetricsInfluxDBHostTagFlag.Name)
|
|
)
|
|
|
|
if enableExport {
|
|
log.Info("Enabling metrics export to InfluxDB")
|
|
go influxdb.InfluxDBWithTags(metrics.DefaultRegistry, 10*time.Second, endpoint, database, username, password, "geth.", map[string]string{
|
|
"host": hosttag,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
|
|
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
|
|
var (
|
|
cache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
|
|
handles = makeDatabaseHandles()
|
|
)
|
|
name := "chaindata"
|
|
if ctx.GlobalString(SyncModeFlag.Name) == "light" {
|
|
name = "lightchaindata"
|
|
}
|
|
chainDb, err := stack.OpenDatabase(name, cache, handles)
|
|
if err != nil {
|
|
Fatalf("Could not open database: %v", err)
|
|
}
|
|
return chainDb
|
|
}
|
|
|
|
func MakeGenesis(ctx *cli.Context) *core.Genesis {
|
|
var genesis *core.Genesis
|
|
switch {
|
|
case ctx.GlobalBool(TestnetFlag.Name):
|
|
genesis = core.DefaultTestnetGenesisBlock()
|
|
case ctx.GlobalBool(RinkebyFlag.Name):
|
|
genesis = core.DefaultRinkebyGenesisBlock()
|
|
case ctx.GlobalBool(DeveloperFlag.Name):
|
|
Fatalf("Developer chains are ephemeral")
|
|
}
|
|
return genesis
|
|
}
|
|
|
|
// MakeChain creates a chain manager from set command line flags.
|
|
func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
|
|
var err error
|
|
chainDb = MakeChainDatabase(ctx, stack)
|
|
|
|
config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
|
|
if err != nil {
|
|
Fatalf("%v", err)
|
|
}
|
|
var engine consensus.Engine
|
|
if config.Clique != nil {
|
|
engine = clique.New(config.Clique, chainDb)
|
|
} else {
|
|
engine = ethash.NewFaker()
|
|
if !ctx.GlobalBool(FakePoWFlag.Name) {
|
|
engine = ethash.New(ethash.Config{
|
|
CacheDir: stack.ResolvePath(eth.DefaultConfig.Ethash.CacheDir),
|
|
CachesInMem: eth.DefaultConfig.Ethash.CachesInMem,
|
|
CachesOnDisk: eth.DefaultConfig.Ethash.CachesOnDisk,
|
|
DatasetDir: stack.ResolvePath(eth.DefaultConfig.Ethash.DatasetDir),
|
|
DatasetsInMem: eth.DefaultConfig.Ethash.DatasetsInMem,
|
|
DatasetsOnDisk: eth.DefaultConfig.Ethash.DatasetsOnDisk,
|
|
}, nil, false)
|
|
}
|
|
}
|
|
if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
|
|
Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
|
|
}
|
|
cache := &core.CacheConfig{
|
|
Disabled: ctx.GlobalString(GCModeFlag.Name) == "archive",
|
|
TrieNodeLimit: eth.DefaultConfig.TrieCache,
|
|
TrieTimeLimit: eth.DefaultConfig.TrieTimeout,
|
|
}
|
|
if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
|
|
cache.TrieNodeLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
|
|
}
|
|
vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
|
|
chain, err = core.NewBlockChain(chainDb, cache, config, engine, vmcfg, nil)
|
|
if err != nil {
|
|
Fatalf("Can't create BlockChain: %v", err)
|
|
}
|
|
return chain, chainDb
|
|
}
|
|
|
|
// MakeConsolePreloads retrieves the absolute paths for the console JavaScript
|
|
// scripts to preload before starting.
|
|
func MakeConsolePreloads(ctx *cli.Context) []string {
|
|
// Skip preloading if there's nothing to preload
|
|
if ctx.GlobalString(PreloadJSFlag.Name) == "" {
|
|
return nil
|
|
}
|
|
// Otherwise resolve absolute paths and return them
|
|
preloads := []string{}
|
|
|
|
assets := ctx.GlobalString(JSpathFlag.Name)
|
|
for _, file := range strings.Split(ctx.GlobalString(PreloadJSFlag.Name), ",") {
|
|
preloads = append(preloads, common.AbsolutePath(assets, strings.TrimSpace(file)))
|
|
}
|
|
return preloads
|
|
}
|
|
|
|
// MigrateFlags sets the global flag from a local flag when it's set.
|
|
// This is a temporary function used for migrating old command/flags to the
|
|
// new format.
|
|
//
|
|
// e.g. geth account new --keystore /tmp/mykeystore --lightkdf
|
|
//
|
|
// is equivalent after calling this method with:
|
|
//
|
|
// geth --keystore /tmp/mykeystore --lightkdf account new
|
|
//
|
|
// This allows the use of the existing configuration functionality.
|
|
// When all flags are migrated this function can be removed and the existing
|
|
// configuration functionality must be changed that is uses local flags
|
|
func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error {
|
|
return func(ctx *cli.Context) error {
|
|
for _, name := range ctx.FlagNames() {
|
|
if ctx.IsSet(name) {
|
|
ctx.GlobalSet(name, ctx.String(name))
|
|
}
|
|
}
|
|
return action(ctx)
|
|
}
|
|
}
|