flags.go 62.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
// 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
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
15
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
16

17
// Package utils contains internal helper functions for go-ethereum commands.
18 19 20 21
package utils

import (
	"crypto/ecdsa"
22
	"errors"
23
	"fmt"
24
	"io"
25
	"io/ioutil"
26
	"math/big"
27
	"os"
28
	"path/filepath"
29
	"strconv"
30
	"strings"
31 32
	"text/tabwriter"
	"text/template"
33
	"time"
34

35
	"github.com/ethereum/go-ethereum/accounts"
36
	"github.com/ethereum/go-ethereum/accounts/keystore"
zelig's avatar
zelig committed
37
	"github.com/ethereum/go-ethereum/common"
38
	"github.com/ethereum/go-ethereum/common/fdlimit"
39 40
	"github.com/ethereum/go-ethereum/consensus"
	"github.com/ethereum/go-ethereum/consensus/clique"
41
	"github.com/ethereum/go-ethereum/consensus/ethash"
42
	"github.com/ethereum/go-ethereum/core"
43
	"github.com/ethereum/go-ethereum/core/vm"
44 45
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
46 47
	"github.com/ethereum/go-ethereum/eth/downloader"
	"github.com/ethereum/go-ethereum/eth/gasprice"
48
	"github.com/ethereum/go-ethereum/ethdb"
49
	"github.com/ethereum/go-ethereum/ethstats"
50
	"github.com/ethereum/go-ethereum/graphql"
51
	"github.com/ethereum/go-ethereum/les"
52
	"github.com/ethereum/go-ethereum/log"
53
	"github.com/ethereum/go-ethereum/metrics"
54
	"github.com/ethereum/go-ethereum/metrics/influxdb"
55
	"github.com/ethereum/go-ethereum/miner"
56
	"github.com/ethereum/go-ethereum/node"
57
	"github.com/ethereum/go-ethereum/p2p"
58
	"github.com/ethereum/go-ethereum/p2p/discv5"
59
	"github.com/ethereum/go-ethereum/p2p/enode"
60
	"github.com/ethereum/go-ethereum/p2p/nat"
61
	"github.com/ethereum/go-ethereum/p2p/netutil"
62
	"github.com/ethereum/go-ethereum/params"
63
	"github.com/ethereum/go-ethereum/rpc"
64
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv6"
65
	pcsclite "github.com/gballet/go-libpcsclite"
66
	cli "gopkg.in/urfave/cli.v1"
67 68
)

69 70 71 72 73
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:
74
	{{range .cmd.Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
75 76 77 78 79
	{{end}}{{end}}{{if .categorizedFlags}}
{{range $idx, $categorized := .categorizedFlags}}{{$categorized.Name}} OPTIONS:
{{range $categorized.Flags}}{{"\t"}}{{.}}
{{end}}
{{end}}{{end}}`
80 81 82 83 84 85 86 87 88 89 90

	OriginCommandHelpTemplate = `{{.Name}}{{if .Subcommands}} command{{end}}{{if .Flags}} [command options]{{end}} [arguments...]
{{if .Description}}{{.Description}}
{{end}}{{if .Subcommands}}
SUBCOMMANDS:
	{{range .Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
	{{end}}{{end}}{{if .Flags}}
OPTIONS:
{{range $.Flags}}{{"\t"}}{{.}}
{{end}}
{{end}}`
91 92
)

93 94 95 96 97 98 99 100 101 102 103 104 105
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}}
`
106
	cli.CommandHelpTemplate = CommandHelpTemplate
107
	cli.HelpPrinter = printHelp
108 109
}

Felix Lange's avatar
Felix Lange committed
110
// NewApp creates an app with sane defaults.
111
func NewApp(gitCommit, gitDate, usage string) *cli.App {
Felix Lange's avatar
Felix Lange committed
112
	app := cli.NewApp()
113
	app.Name = filepath.Base(os.Args[0])
Felix Lange's avatar
Felix Lange committed
114 115
	app.Author = ""
	app.Email = ""
116
	app.Version = params.VersionWithCommit(gitCommit, gitDate)
Felix Lange's avatar
Felix Lange committed
117 118 119 120
	app.Usage = usage
	return app
}

121 122 123 124 125 126 127 128 129 130 131
func printHelp(out io.Writer, templ string, data interface{}) {
	funcMap := template.FuncMap{"join": strings.Join}
	t := template.Must(template.New("help").Funcs(funcMap).Parse(templ))
	w := tabwriter.NewWriter(out, 38, 8, 2, ' ', 0)
	err := t.Execute(w, data)
	if err != nil {
		panic(err)
	}
	w.Flush()
}

132 133 134 135 136 137 138 139 140
// 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
141
	DataDirFlag = DirectoryFlag{
142
		Name:  "datadir",
143
		Usage: "Data directory for the databases and keystore",
144
		Value: DirectoryString(node.DefaultDataDir()),
145
	}
146 147 148 149
	AncientFlag = DirectoryFlag{
		Name:  "datadir.ancient",
		Usage: "Data directory for ancient chain segments (default = inside chaindata)",
	}
150 151 152 153
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
154 155
	NoUSBFlag = cli.BoolFlag{
		Name:  "nousb",
156
		Usage: "Disables monitoring for and managing USB hardware wallets",
157
	}
158 159 160 161 162
	SmartCardDaemonPathFlag = cli.StringFlag{
		Name:  "pcscdpath",
		Usage: "Path to the smartcard daemon (pcscd) socket file",
		Value: pcsclite.PCSCDSockName,
	}
163
	NetworkIdFlag = cli.Uint64Flag{
zelig's avatar
zelig committed
164
		Name:  "networkid",
165
		Usage: "Network identifier (integer, 1=Frontier, 3=Ropsten, 4=Rinkeby, 5=Görli)",
166
		Value: eth.DefaultConfig.NetworkId,
zelig's avatar
zelig committed
167
	}
168
	LegacyTestnetFlag = cli.BoolFlag{ // TODO(q9f): Remove after Ropsten is discontinued.
169
		Name:  "testnet",
170 171 172 173 174
		Usage: "Pre-configured test network (Deprecated: Please choose one of --goerli, --rinkeby, or --ropsten.)",
	}
	GoerliFlag = cli.BoolFlag{
		Name:  "goerli",
		Usage: "Görli network: pre-configured proof-of-authority test network",
175
	}
176 177 178 179
	RinkebyFlag = cli.BoolFlag{
		Name:  "rinkeby",
		Usage: "Rinkeby network: pre-configured proof-of-authority test network",
	}
180 181 182
	RopstenFlag = cli.BoolFlag{
		Name:  "ropsten",
		Usage: "Ropsten network: pre-configured proof-of-work test network",
183
	}
184
	DeveloperFlag = cli.BoolFlag{
185
		Name:  "dev",
186 187 188 189 190
		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)",
191
	}
192 193
	IdentityFlag = cli.StringFlag{
		Name:  "identity",
194
		Usage: "Custom node name",
195
	}
zelig's avatar
zelig committed
196 197 198
	DocRootFlag = DirectoryFlag{
		Name:  "docroot",
		Usage: "Document Root for HTTPClient file scheme",
199
		Value: DirectoryString(homeDir()),
zelig's avatar
zelig committed
200
	}
201 202
	ExitWhenSyncedFlag = cli.BoolFlag{
		Name:  "exitwhensynced",
203
		Usage: "Exits after block synchronisation completes",
204
	}
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
	IterativeOutputFlag = cli.BoolFlag{
		Name:  "iterative",
		Usage: "Print streaming JSON iteratively, delimited by newlines",
	}
	ExcludeStorageFlag = cli.BoolFlag{
		Name:  "nostorage",
		Usage: "Exclude storage entries (save db lookups)",
	}
	IncludeIncompletesFlag = cli.BoolFlag{
		Name:  "incompletes",
		Usage: "Include accounts for which we don't have the address (missing preimage)",
	}
	ExcludeCodeFlag = cli.BoolFlag{
		Name:  "nocode",
		Usage: "Exclude contract code (save db lookups)",
	}
221 222 223 224 225 226
	defaultSyncMode = eth.DefaultConfig.SyncMode
	SyncModeFlag    = TextMarshalerFlag{
		Name:  "syncmode",
		Usage: `Blockchain sync mode ("fast", "full", or "light")`,
		Value: &defaultSyncMode,
	}
227 228 229 230 231
	GCModeFlag = cli.StringFlag{
		Name:  "gcmode",
		Usage: `Blockchain garbage collection mode ("full", "archive")`,
		Value: "full",
	}
232 233 234 235
	SnapshotFlag = cli.BoolFlag{
		Name:  "snapshot",
		Usage: `Enables snapshot-database mode -- experimental work in progress feature`,
	}
236 237 238 239 240 241 242 243
	LightKDFFlag = cli.BoolFlag{
		Name:  "lightkdf",
		Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
	}
	WhitelistFlag = cli.StringFlag{
		Name:  "whitelist",
		Usage: "Comma separated block number-to-hash mappings to enforce (<number>=<hash>)",
	}
244 245
	// Light server and client settings
	LightLegacyServFlag = cli.IntFlag{ // Deprecated in favor of light.serve, remove in 2021
246
		Name:  "lightserv",
247 248 249 250 251
		Usage: "Maximum percentage of time allowed for serving LES requests (deprecated, use --light.serve)",
		Value: eth.DefaultConfig.LightServ,
	}
	LightServeFlag = cli.IntFlag{
		Name:  "light.serve",
252
		Usage: "Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100)",
253
		Value: eth.DefaultConfig.LightServ,
254
	}
255 256 257 258
	LightIngressFlag = cli.IntFlag{
		Name:  "light.ingress",
		Usage: "Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
		Value: eth.DefaultConfig.LightIngress,
259
	}
260 261 262 263
	LightEgressFlag = cli.IntFlag{
		Name:  "light.egress",
		Usage: "Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
		Value: eth.DefaultConfig.LightEgress,
264
	}
265
	LightLegacyPeersFlag = cli.IntFlag{ // Deprecated in favor of light.maxpeers, remove in 2021
266
		Name:  "lightpeers",
267 268 269 270 271 272
		Usage: "Maximum number of light clients to serve, or light servers to attach to  (deprecated, use --light.maxpeers)",
		Value: eth.DefaultConfig.LightPeers,
	}
	LightMaxPeersFlag = cli.IntFlag{
		Name:  "light.maxpeers",
		Usage: "Maximum number of light clients to serve, or light servers to attach to",
273
		Value: eth.DefaultConfig.LightPeers,
274
	}
275 276 277 278
	UltraLightServersFlag = cli.StringFlag{
		Name:  "ulc.servers",
		Usage: "List of trusted ultra-light servers",
		Value: strings.Join(eth.DefaultConfig.UltraLightServers, ","),
279
	}
280 281 282 283 284 285 286 287
	UltraLightFractionFlag = cli.IntFlag{
		Name:  "ulc.fraction",
		Usage: "Minimum % of trusted ultra-light servers required to announce a new head",
		Value: eth.DefaultConfig.UltraLightFraction,
	}
	UltraLightOnlyAnnounceFlag = cli.BoolFlag{
		Name:  "ulc.onlyannounce",
		Usage: "Ultra light server sends announcements only",
288
	}
289 290 291 292 293 294 295 296
	// 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)",
297
		Value: eth.DefaultConfig.Ethash.CachesInMem,
298 299 300 301
	}
	EthashCachesOnDiskFlag = cli.IntFlag{
		Name:  "ethash.cachesondisk",
		Usage: "Number of recent ethash caches to keep on disk (16MB each)",
302
		Value: eth.DefaultConfig.Ethash.CachesOnDisk,
303
	}
304 305 306 307
	EthashCachesLockMmapFlag = cli.BoolFlag{
		Name:  "ethash.cacheslockmmap",
		Usage: "Lock memory maps of recent ethash caches",
	}
308 309
	EthashDatasetDirFlag = DirectoryFlag{
		Name:  "ethash.dagdir",
310 311
		Usage: "Directory to store the ethash mining DAGs",
		Value: DirectoryString(eth.DefaultConfig.Ethash.DatasetDir),
312 313 314 315
	}
	EthashDatasetsInMemoryFlag = cli.IntFlag{
		Name:  "ethash.dagsinmem",
		Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
316
		Value: eth.DefaultConfig.Ethash.DatasetsInMem,
317 318 319 320
	}
	EthashDatasetsOnDiskFlag = cli.IntFlag{
		Name:  "ethash.dagsondisk",
		Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
321
		Value: eth.DefaultConfig.Ethash.DatasetsOnDisk,
322
	}
323 324 325 326
	EthashDatasetsLockMmapFlag = cli.BoolFlag{
		Name:  "ethash.dagslockmmap",
		Usage: "Lock memory maps for recent ethash mining DAGs",
	}
327
	// Transaction pool settings
328 329 330 331
	TxPoolLocalsFlag = cli.StringFlag{
		Name:  "txpool.locals",
		Usage: "Comma separated accounts to treat as locals (no flush, priority inclusion)",
	}
332 333 334 335
	TxPoolNoLocalsFlag = cli.BoolFlag{
		Name:  "txpool.nolocals",
		Usage: "Disables price exemptions for locally submitted transactions",
	}
336 337 338 339 340 341 342 343 344 345
	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,
	}
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	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,
	}
381 382 383
	// Performance tuning settings
	CacheFlag = cli.IntFlag{
		Name:  "cache",
384
		Usage: "Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode)",
385 386 387 388 389
		Value: 1024,
	}
	CacheDatabaseFlag = cli.IntFlag{
		Name:  "cache.database",
		Usage: "Percentage of cache memory allowance to use for database io",
390 391 392 393
		Value: 50,
	}
	CacheTrieFlag = cli.IntFlag{
		Name:  "cache.trie",
394 395
		Usage: "Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode)",
		Value: 15,
396 397 398
	}
	CacheGCFlag = cli.IntFlag{
		Name:  "cache.gc",
399
		Usage: "Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode)",
400
		Value: 25,
401
	}
402 403 404 405 406
	CacheSnapshotFlag = cli.IntFlag{
		Name:  "cache.snapshot",
		Usage: "Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode)",
		Value: 10,
	}
407 408 409 410
	CacheNoPrefetchFlag = cli.BoolFlag{
		Name:  "cache.noprefetch",
		Usage: "Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)",
	}
411 412 413 414
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
415
	}
416
	MinerThreadsFlag = cli.IntFlag{
417
		Name:  "miner.threads",
418
		Usage: "Number of CPU threads to use for mining",
419 420
		Value: 0,
	}
421 422 423 424 425
	MinerLegacyThreadsFlag = cli.IntFlag{
		Name:  "minerthreads",
		Usage: "Number of CPU threads to use for mining (deprecated, use --miner.threads)",
		Value: 0,
	}
426 427 428
	MinerNotifyFlag = cli.StringFlag{
		Name:  "miner.notify",
		Usage: "Comma separated HTTP URL list to notify of new work packages",
429
	}
430 431 432
	MinerGasTargetFlag = cli.Uint64Flag{
		Name:  "miner.gastarget",
		Usage: "Target gas floor for mined blocks",
433
		Value: eth.DefaultConfig.Miner.GasFloor,
434 435
	}
	MinerLegacyGasTargetFlag = cli.Uint64Flag{
436
		Name:  "targetgaslimit",
437
		Usage: "Target gas floor for mined blocks (deprecated, use --miner.gastarget)",
438
		Value: eth.DefaultConfig.Miner.GasFloor,
439 440 441 442
	}
	MinerGasLimitFlag = cli.Uint64Flag{
		Name:  "miner.gaslimit",
		Usage: "Target gas ceiling for mined blocks",
443
		Value: eth.DefaultConfig.Miner.GasCeil,
444
	}
445 446
	MinerGasPriceFlag = BigFlag{
		Name:  "miner.gasprice",
447
		Usage: "Minimum gas price for mining a transaction",
448
		Value: eth.DefaultConfig.Miner.GasPrice,
zelig's avatar
zelig committed
449
	}
450
	MinerLegacyGasPriceFlag = BigFlag{
451
		Name:  "gasprice",
452
		Usage: "Minimum gas price for mining a transaction (deprecated, use --miner.gasprice)",
453
		Value: eth.DefaultConfig.Miner.GasPrice,
454
	}
455 456 457 458 459 460 461 462 463 464 465 466
	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",
467
		Usage: "Block extra data set by the miner (default = client version)",
zelig's avatar
zelig committed
468
	}
469 470 471 472
	MinerLegacyExtraDataFlag = cli.StringFlag{
		Name:  "extradata",
		Usage: "Block extra data set by the miner (default = client version, deprecated, use --miner.extradata)",
	}
473 474
	MinerRecommitIntervalFlag = cli.DurationFlag{
		Name:  "miner.recommit",
475
		Usage: "Time interval to recreate the block being mined",
476
		Value: eth.DefaultConfig.Miner.Recommit,
477
	}
478 479 480 481
	MinerNoVerfiyFlag = cli.BoolFlag{
		Name:  "miner.noverify",
		Usage: "Disable remote sealing verification",
	}
482
	// Account settings
zelig's avatar
zelig committed
483 484
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
485
		Usage: "Comma separated list of accounts to unlock",
zelig's avatar
zelig committed
486 487 488 489
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
490
		Usage: "Password file to use for non-interactive password input",
zelig's avatar
zelig committed
491
		Value: "",
zelig's avatar
zelig committed
492
	}
493 494 495 496 497
	ExternalSignerFlag = cli.StringFlag{
		Name:  "signer",
		Usage: "External signer (url or path to ipc file)",
		Value: "",
	}
498 499 500 501
	VMEnableDebugFlag = cli.BoolFlag{
		Name:  "vmdebug",
		Usage: "Record information useful for VM and contract debugging",
	}
502 503 504 505
	InsecureUnlockAllowedFlag = cli.BoolFlag{
		Name:  "allow-insecure-unlock",
		Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http",
	}
506 507 508 509
	RPCGlobalGasCap = cli.Uint64Flag{
		Name:  "rpc.gascap",
		Usage: "Sets a cap on gas that can be used in eth_call/estimateGas",
	}
510 511 512 513 514
	// Logging and debug settings
	EthStatsURLFlag = cli.StringFlag{
		Name:  "ethstats",
		Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
	}
515 516 517 518
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
519 520 521 522
	NoCompactionFlag = cli.BoolFlag{
		Name:  "nocompaction",
		Usage: "Disables db compaction after import",
	}
523
	// RPC settings
524 525 526 527 528 529 530 531
	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)",
	}
532 533
	RPCEnabledFlag = cli.BoolFlag{
		Name:  "rpc",
534
		Usage: "Enable the HTTP-RPC server",
535 536 537
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
538
		Usage: "HTTP-RPC server listening interface",
539
		Value: node.DefaultHTTPHost,
540 541 542
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
543
		Usage: "HTTP-RPC server listening port",
544
		Value: node.DefaultHTTPPort,
545
	}
546 547
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
548
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
549 550
		Value: "",
	}
551 552 553
	RPCVirtualHostsFlag = cli.StringFlag{
		Name:  "rpcvhosts",
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
554
		Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
555
	}
556
	RPCApiFlag = cli.StringFlag{
557
		Name:  "rpcapi",
558
		Usage: "API's offered over the HTTP-RPC interface",
559
		Value: "",
560
	}
561
	WSEnabledFlag = cli.BoolFlag{
562
		Name:  "ws",
563 564 565 566 567
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
568
		Value: node.DefaultWSHost,
569 570 571 572
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
573
		Value: node.DefaultWSPort,
574 575 576 577
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
578
		Value: "",
579
	}
580 581 582
	WSAllowedOriginsFlag = cli.StringFlag{
		Name:  "wsorigins",
		Usage: "Origins from which to accept websockets requests",
583
		Value: "",
584
	}
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
	GraphQLEnabledFlag = cli.BoolFlag{
		Name:  "graphql",
		Usage: "Enable the GraphQL server",
	}
	GraphQLListenAddrFlag = cli.StringFlag{
		Name:  "graphql.addr",
		Usage: "GraphQL server listening interface",
		Value: node.DefaultGraphQLHost,
	}
	GraphQLPortFlag = cli.IntFlag{
		Name:  "graphql.port",
		Usage: "GraphQL server listening port",
		Value: node.DefaultGraphQLPort,
	}
	GraphQLCORSDomainFlag = cli.StringFlag{
		Name:  "graphql.corsdomain",
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
		Value: "",
	}
	GraphQLVirtualHostsFlag = cli.StringFlag{
		Name:  "graphql.vhosts",
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
		Value: strings.Join(node.DefaultConfig.GraphQLVirtualHosts, ","),
	}
609 610
	ExecFlag = cli.StringFlag{
		Name:  "exec",
611
		Usage: "Execute JavaScript statement",
612
	}
613
	PreloadJSFlag = cli.StringFlag{
614 615 616
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}
617

618 619 620
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
621
		Usage: "Maximum number of network peers (network disabled if set to 0)",
622
		Value: node.DefaultConfig.P2P.MaxPeers,
623
	}
624 625 626
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
627
		Value: node.DefaultConfig.P2P.MaxPendingPeers,
628
	}
629 630 631 632 633
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
634
	BootnodesFlag = cli.StringFlag{
635
		Name:  "bootnodes",
636 637 638 639 640 641 642 643 644 645 646
		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)",
647
		Value: "",
648 649 650 651 652 653 654 655 656 657 658
	}
	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",
659
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
660 661
		Value: "any",
	}
662 663 664 665
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
666 667 668 669
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
670 671 672 673
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}
674 675 676 677
	DNSDiscoveryFlag = cli.StringFlag{
		Name:  "discovery.dns",
		Usage: "Sets DNS discovery entry points (use \"\" to disable DNS)",
	}
678

679
	// ATM the url is left to the user and deployment to
zelig's avatar
zelig committed
680 681
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
682
		Usage: "JavaScript root path for `loadScript`",
zelig's avatar
zelig committed
683 684
		Value: ".",
	}
685 686

	// Gas price oracle settings
687 688 689
	GpoBlocksFlag = cli.IntFlag{
		Name:  "gpoblocks",
		Usage: "Number of recent blocks to check for gas prices",
690
		Value: eth.DefaultConfig.GPO.Blocks,
zsfelfoldi's avatar
zsfelfoldi committed
691
	}
692 693 694
	GpoPercentileFlag = cli.IntFlag{
		Name:  "gpopercentile",
		Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
695
		Value: eth.DefaultConfig.GPO.Percentile,
zsfelfoldi's avatar
zsfelfoldi committed
696
	}
697 698 699 700 701 702 703 704 705 706 707 708 709 710
	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,
	}
711 712 713 714
	WhisperRestrictConnectionBetweenLightClientsFlag = cli.BoolFlag{
		Name:  "shh.restrict-light",
		Usage: "Restrict connection between two whisper light clients",
	}
715 716 717

	// Metrics flags
	MetricsEnabledFlag = cli.BoolFlag{
718
		Name:  "metrics",
719 720
		Usage: "Enable metrics collection and reporting",
	}
721 722 723 724
	MetricsEnabledExpensiveFlag = cli.BoolFlag{
		Name:  "metrics.expensive",
		Usage: "Enable expensive metrics collection and reporting",
	}
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	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",
	}
749 750 751
	// Tags are part of every measurement sent to InfluxDB. Queries on tags are faster in InfluxDB.
	// For example `host` tag could be 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.
752
	// https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
753 754 755 756
	MetricsInfluxDBTagsFlag = cli.StringFlag{
		Name:  "metrics.influxdb.tags",
		Usage: "Comma-separated InfluxDB tags (key/values) attached to all measurements",
		Value: "host=localhost",
757
	}
758 759 760 761 762 763 764 765 766 767
	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: "",
	}
768 769
)

770
// MakeDataDir retrieves the currently requested data directory, terminating
771
// if none (or the empty string) is specified. If the node is starting a testnet,
772
// then a subdirectory of the specified datadir will be used.
773
func MakeDataDir(ctx *cli.Context) string {
774
	if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
775 776 777 778 779 780 781 782
		if ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name) {
			// Maintain compatibility with older Geth configurations storing the
			// Ropsten database in `testnet` instead of `ropsten`.
			legacyPath := filepath.Join(path, "testnet")
			if _, err := os.Stat(legacyPath); !os.IsNotExist(err) {
				return legacyPath
			}
			return filepath.Join(path, "ropsten")
783
		}
784 785 786
		if ctx.GlobalBool(RinkebyFlag.Name) {
			return filepath.Join(path, "rinkeby")
		}
787 788 789
		if ctx.GlobalBool(GoerliFlag.Name) {
			return filepath.Join(path, "goerli")
		}
790
		return path
791
	}
792
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
793
	return ""
794 795
}

796
// setNodeKey creates a node key from set command line flags, either loading it
797 798
// 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.
799
func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
800 801 802
	var (
		hex  = ctx.GlobalString(NodeKeyHexFlag.Name)
		file = ctx.GlobalString(NodeKeyFileFlag.Name)
803 804
		key  *ecdsa.PrivateKey
		err  error
805
	)
806 807
	switch {
	case file != "" && hex != "":
808
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
809 810
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
811
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
812
		}
813
		cfg.PrivateKey = key
814 815
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
816
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
817
		}
818
		cfg.PrivateKey = key
819 820 821
	}
}

822 823
// setNodeUserIdent creates the user identifier from CLI flags.
func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
824
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
825
		cfg.UserIdent = identity
826 827 828
	}
}

829
// setBootstrapNodes creates a list of bootstrap nodes from the command line
830
// flags, reverting to pre-configured ones if none have been specified.
831
func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
832
	urls := params.MainnetBootnodes
833
	switch {
834 835
	case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV4Flag.Name):
		if ctx.GlobalIsSet(BootnodesV4Flag.Name) {
836
			urls = splitAndTrim(ctx.GlobalString(BootnodesV4Flag.Name))
837
		} else {
838
			urls = splitAndTrim(ctx.GlobalString(BootnodesFlag.Name))
839
		}
840 841
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
		urls = params.RopstenBootnodes
842 843
	case ctx.GlobalBool(RinkebyFlag.Name):
		urls = params.RinkebyBootnodes
844 845
	case ctx.GlobalBool(GoerliFlag.Name):
		urls = params.GoerliBootnodes
846 847
	case cfg.BootstrapNodes != nil:
		return // already set, don't apply defaults.
848 849
	}

850
	cfg.BootstrapNodes = make([]*enode.Node, 0, len(urls))
851
	for _, url := range urls {
852
		if url != "" {
853
			node, err := enode.Parse(enode.ValidSchemes, url)
854 855
			if err != nil {
				log.Crit("Bootstrap URL invalid", "enode", url, "err", err)
856
				continue
857 858
			}
			cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
859 860 861 862
		}
	}
}

863
// setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
864
// flags, reverting to pre-configured ones if none have been specified.
865
func setBootstrapNodesV5(ctx *cli.Context, cfg *p2p.Config) {
866
	urls := params.DiscoveryV5Bootnodes
867
	switch {
868 869
	case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV5Flag.Name):
		if ctx.GlobalIsSet(BootnodesV5Flag.Name) {
870
			urls = splitAndTrim(ctx.GlobalString(BootnodesV5Flag.Name))
871
		} else {
872
			urls = splitAndTrim(ctx.GlobalString(BootnodesFlag.Name))
873
		}
874
	case ctx.GlobalBool(RinkebyFlag.Name):
875
		urls = params.RinkebyBootnodes
876 877
	case ctx.GlobalBool(GoerliFlag.Name):
		urls = params.GoerliBootnodes
878
	case cfg.BootstrapNodesV5 != nil:
879
		return // already set, don't apply defaults.
880 881
	}

882
	cfg.BootstrapNodesV5 = make([]*discv5.Node, 0, len(urls))
883
	for _, url := range urls {
884 885 886 887 888 889 890
		if url != "" {
			node, err := discv5.ParseNode(url)
			if err != nil {
				log.Error("Bootstrap URL invalid", "enode", url, "err", err)
				continue
			}
			cfg.BootstrapNodesV5 = append(cfg.BootstrapNodesV5, node)
891 892 893 894
		}
	}
}

895
// setListenAddress creates a TCP listening address string from set command
896
// line flags.
897 898 899 900
func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
	if ctx.GlobalIsSet(ListenPortFlag.Name) {
		cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
	}
901 902
}

903 904 905 906 907 908 909 910
// 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
911 912 913
	}
}

914 915 916
// splitAndTrim splits input separated by a comma
// and trims excessive white space from the substrings.
func splitAndTrim(input string) []string {
917 918 919 920 921 922 923
	result := strings.Split(input, ",")
	for i, r := range result {
		result[i] = strings.TrimSpace(r)
	}
	return result
}

924
// setHTTP creates the HTTP RPC listener interface string from the set
925
// command line flags, returning empty if the HTTP endpoint is disabled.
926 927 928 929 930 931 932 933 934 935 936
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) {
937
		cfg.HTTPCors = splitAndTrim(ctx.GlobalString(RPCCORSDomainFlag.Name))
938 939
	}
	if ctx.GlobalIsSet(RPCApiFlag.Name) {
940
		cfg.HTTPModules = splitAndTrim(ctx.GlobalString(RPCApiFlag.Name))
941
	}
942 943 944
	if ctx.GlobalIsSet(RPCVirtualHostsFlag.Name) {
		cfg.HTTPVirtualHosts = splitAndTrim(ctx.GlobalString(RPCVirtualHostsFlag.Name))
	}
945 946
}

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
// setGraphQL creates the GraphQL listener interface string from the set
// command line flags, returning empty if the GraphQL endpoint is disabled.
func setGraphQL(ctx *cli.Context, cfg *node.Config) {
	if ctx.GlobalBool(GraphQLEnabledFlag.Name) && cfg.GraphQLHost == "" {
		cfg.GraphQLHost = "127.0.0.1"
		if ctx.GlobalIsSet(GraphQLListenAddrFlag.Name) {
			cfg.GraphQLHost = ctx.GlobalString(GraphQLListenAddrFlag.Name)
		}
	}
	cfg.GraphQLPort = ctx.GlobalInt(GraphQLPortFlag.Name)
	if ctx.GlobalIsSet(GraphQLCORSDomainFlag.Name) {
		cfg.GraphQLCors = splitAndTrim(ctx.GlobalString(GraphQLCORSDomainFlag.Name))
	}
	if ctx.GlobalIsSet(GraphQLVirtualHostsFlag.Name) {
		cfg.GraphQLVirtualHosts = splitAndTrim(ctx.GlobalString(GraphQLVirtualHostsFlag.Name))
	}
}

965
// setWS creates the WebSocket RPC listener interface string from the set
966
// command line flags, returning empty if the HTTP endpoint is disabled.
967 968 969 970 971 972 973 974 975 976 977
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) {
978
		cfg.WSOrigins = splitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
979 980
	}
	if ctx.GlobalIsSet(WSApiFlag.Name) {
981
		cfg.WSModules = splitAndTrim(ctx.GlobalString(WSApiFlag.Name))
982 983 984 985 986 987
	}
}

// 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) {
988
	CheckExclusive(ctx, IPCDisabledFlag, IPCPathFlag)
989 990 991 992 993
	switch {
	case ctx.GlobalBool(IPCDisabledFlag.Name):
		cfg.IPCPath = ""
	case ctx.GlobalIsSet(IPCPathFlag.Name):
		cfg.IPCPath = ctx.GlobalString(IPCPathFlag.Name)
994 995 996
	}
}

997 998
// setLes configures the les server and ultra light client settings from the command line flags.
func setLes(ctx *cli.Context, cfg *eth.Config) {
999 1000 1001 1002 1003 1004 1005 1006
	if ctx.GlobalIsSet(LightLegacyServFlag.Name) {
		cfg.LightServ = ctx.GlobalInt(LightLegacyServFlag.Name)
	}
	if ctx.GlobalIsSet(LightServeFlag.Name) {
		cfg.LightServ = ctx.GlobalInt(LightServeFlag.Name)
	}
	if ctx.GlobalIsSet(LightIngressFlag.Name) {
		cfg.LightIngress = ctx.GlobalInt(LightIngressFlag.Name)
1007
	}
1008 1009
	if ctx.GlobalIsSet(LightEgressFlag.Name) {
		cfg.LightEgress = ctx.GlobalInt(LightEgressFlag.Name)
1010
	}
1011 1012
	if ctx.GlobalIsSet(LightLegacyPeersFlag.Name) {
		cfg.LightPeers = ctx.GlobalInt(LightLegacyPeersFlag.Name)
1013
	}
1014 1015
	if ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
		cfg.LightPeers = ctx.GlobalInt(LightMaxPeersFlag.Name)
1016
	}
1017 1018
	if ctx.GlobalIsSet(UltraLightServersFlag.Name) {
		cfg.UltraLightServers = strings.Split(ctx.GlobalString(UltraLightServersFlag.Name), ",")
1019
	}
1020 1021
	if ctx.GlobalIsSet(UltraLightFractionFlag.Name) {
		cfg.UltraLightFraction = ctx.GlobalInt(UltraLightFractionFlag.Name)
1022
	}
1023 1024 1025
	if cfg.UltraLightFraction <= 0 && cfg.UltraLightFraction > 100 {
		log.Error("Ultra light fraction is invalid", "had", cfg.UltraLightFraction, "updated", eth.DefaultConfig.UltraLightFraction)
		cfg.UltraLightFraction = eth.DefaultConfig.UltraLightFraction
1026
	}
1027 1028
	if ctx.GlobalIsSet(UltraLightOnlyAnnounceFlag.Name) {
		cfg.UltraLightOnlyAnnounce = ctx.GlobalBool(UltraLightOnlyAnnounceFlag.Name)
1029 1030 1031
	}
}

1032
// makeDatabaseHandles raises out the number of allowed file handles per process
1033
// for Geth and returns half of the allowance to assign to the database.
1034
func makeDatabaseHandles() int {
1035
	limit, err := fdlimit.Maximum()
1036
	if err != nil {
1037
		Fatalf("Failed to retrieve file descriptor allowance: %v", err)
1038
	}
1039 1040
	raised, err := fdlimit.Raise(uint64(limit))
	if err != nil {
1041
		Fatalf("Failed to raise file descriptor allowance: %v", err)
1042
	}
1043
	return int(raised / 2) // Leave half for networking and other stuff
1044 1045
}

1046 1047
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
1048
func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
1049 1050
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
Felix Lange's avatar
Felix Lange committed
1051
		return accounts.Account{Address: common.HexToAddress(account)}, nil
1052 1053 1054
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
1055
	if err != nil || index < 0 {
Felix Lange's avatar
Felix Lange committed
1056
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
1057
	}
1058 1059 1060 1061 1062 1063
	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("-------------------------------------------------------------------")

1064 1065 1066 1067 1068
	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
1069 1070
}

1071
// setEtherbase retrieves the etherbase either from the directly specified
1072
// command line flags or from the keystore if CLI indexed.
1073
func setEtherbase(ctx *cli.Context, ks *keystore.KeyStore, cfg *eth.Config) {
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	// 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 != "" {
1084 1085 1086 1087 1088
		if ks != nil {
			account, err := MakeAddress(ks, etherbase)
			if err != nil {
				Fatalf("Invalid miner etherbase: %v", err)
			}
1089
			cfg.Miner.Etherbase = account.Address
1090 1091
		} else {
			Fatalf("No etherbase configured")
1092
		}
1093
	}
1094 1095
}

1096
// MakePasswordList reads password lines from the file specified by the global --password flag.
1097
func MakePasswordList(ctx *cli.Context) []string {
1098 1099 1100 1101 1102 1103
	path := ctx.GlobalString(PasswordFileFlag.Name)
	if path == "" {
		return nil
	}
	text, err := ioutil.ReadFile(path)
	if err != nil {
1104
		Fatalf("Failed to read password file: %v", err)
1105 1106 1107 1108 1109
	}
	lines := strings.Split(string(text), "\n")
	// Sanitise DOS line endings.
	for i := range lines {
		lines[i] = strings.TrimRight(lines[i], "\r")
1110
	}
1111
	return lines
1112 1113
}

1114 1115 1116 1117 1118 1119 1120
func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
	setNodeKey(ctx, cfg)
	setNAT(ctx, cfg)
	setListenAddress(ctx, cfg)
	setBootstrapNodes(ctx, cfg)
	setBootstrapNodesV5(ctx, cfg)

1121
	lightClient := ctx.GlobalString(SyncModeFlag.Name) == "light"
1122
	lightServer := (ctx.GlobalInt(LightLegacyServFlag.Name) != 0 || ctx.GlobalInt(LightServeFlag.Name) != 0)
1123

1124 1125 1126 1127
	lightPeers := ctx.GlobalInt(LightLegacyPeersFlag.Name)
	if ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
		lightPeers = ctx.GlobalInt(LightMaxPeersFlag.Name)
	}
1128 1129 1130 1131 1132
	if lightClient && !ctx.GlobalIsSet(LightLegacyPeersFlag.Name) && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
		// dynamic default - for clients we use 1/10th of the default for servers
		lightPeers /= 10
	}

1133 1134
	if ctx.GlobalIsSet(MaxPeersFlag.Name) {
		cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
1135
		if lightServer && !ctx.GlobalIsSet(LightLegacyPeersFlag.Name) && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
1136 1137
			cfg.MaxPeers += lightPeers
		}
1138 1139 1140 1141
	} else {
		if lightServer {
			cfg.MaxPeers += lightPeers
		}
1142
		if lightClient && (ctx.GlobalIsSet(LightLegacyPeersFlag.Name) || ctx.GlobalIsSet(LightMaxPeersFlag.Name)) && cfg.MaxPeers < lightPeers {
1143 1144
			cfg.MaxPeers = lightPeers
		}
1145
	}
1146 1147 1148 1149 1150 1151 1152 1153 1154
	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)

1155 1156 1157
	if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
		cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
	}
1158
	if ctx.GlobalIsSet(NoDiscoverFlag.Name) || lightClient {
1159
		cfg.NoDiscovery = true
1160 1161
	}

1162 1163 1164
	// 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
1165
	forceV5Discovery := (lightClient || lightServer) && !ctx.GlobalBool(NoDiscoverFlag.Name)
1166 1167 1168 1169
	if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
		cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
	} else if forceV5Discovery {
		cfg.DiscoveryV5 = true
1170
	}
1171

1172 1173 1174
	if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
		list, err := netutil.ParseNetlist(netrestrict)
		if err != nil {
1175
			Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
1176
		}
1177
		cfg.NetRestrict = list
1178 1179
	}

1180
	if ctx.GlobalBool(DeveloperFlag.Name) {
1181 1182 1183 1184 1185
		// --dev mode can't use p2p networking.
		cfg.MaxPeers = 0
		cfg.ListenAddr = ":0"
		cfg.NoDiscovery = true
		cfg.DiscoveryV5 = false
1186 1187 1188
	}
}

1189 1190 1191 1192 1193
// 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)
1194
	setGraphQL(ctx, cfg)
1195 1196
	setWS(ctx, cfg)
	setNodeUserIdent(ctx, cfg)
1197
	setDataDir(ctx, cfg)
1198
	setSmartCard(ctx, cfg)
1199

1200 1201 1202 1203
	if ctx.GlobalIsSet(ExternalSignerFlag.Name) {
		cfg.ExternalSigner = ctx.GlobalString(ExternalSignerFlag.Name)
	}

1204 1205 1206 1207 1208 1209
	if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
		cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
	}
	if ctx.GlobalIsSet(LightKDFFlag.Name) {
		cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
	}
1210 1211 1212
	if ctx.GlobalIsSet(NoUSBFlag.Name) {
		cfg.NoUSB = ctx.GlobalBool(NoUSBFlag.Name)
	}
1213 1214 1215
	if ctx.GlobalIsSet(InsecureUnlockAllowedFlag.Name) {
		cfg.InsecureUnlockAllowed = ctx.GlobalBool(InsecureUnlockAllowedFlag.Name)
	}
1216 1217
}

1218 1219 1220 1221 1222 1223 1224 1225 1226
func setSmartCard(ctx *cli.Context, cfg *node.Config) {
	// Skip enabling smartcards if no path is set
	path := ctx.GlobalString(SmartCardDaemonPathFlag.Name)
	if path == "" {
		return
	}
	// Sanity check that the smartcard path is valid
	fi, err := os.Stat(path)
	if err != nil {
1227
		log.Info("Smartcard socket not found, disabling", "err", err)
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
		return
	}
	if fi.Mode()&os.ModeType != os.ModeSocket {
		log.Error("Invalid smartcard daemon path", "path", path, "type", fi.Mode().String())
		return
	}
	// Smartcard daemon path exists and is a socket, enable it
	cfg.SmartCardDaemonPath = path
}

1238 1239 1240 1241 1242 1243
func setDataDir(ctx *cli.Context, cfg *node.Config) {
	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
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
	case (ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name)) && cfg.DataDir == node.DefaultDataDir():
		// Maintain compatibility with older Geth configurations storing the
		// Ropsten database in `testnet` instead of `ropsten`.
		legacyPath := filepath.Join(node.DefaultDataDir(), "testnet")
		if _, err := os.Stat(legacyPath); !os.IsNotExist(err) {
			log.Warn("Using the deprecated `testnet` datadir. Future versions will store the Ropsten chain in `ropsten`.")
			cfg.DataDir = legacyPath
		} else {
			cfg.DataDir = filepath.Join(node.DefaultDataDir(), "ropsten")
		}
1254
	case ctx.GlobalBool(RinkebyFlag.Name) && cfg.DataDir == node.DefaultDataDir():
1255
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "rinkeby")
1256
	case ctx.GlobalBool(GoerliFlag.Name) && cfg.DataDir == node.DefaultDataDir():
1257
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "goerli")
1258 1259 1260
	}
}

1261 1262 1263 1264 1265 1266 1267 1268 1269
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)
	}
}

1270
func setTxPool(ctx *cli.Context, cfg *core.TxPoolConfig) {
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
	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))
			}
		}
	}
1281 1282 1283
	if ctx.GlobalIsSet(TxPoolNoLocalsFlag.Name) {
		cfg.NoLocals = ctx.GlobalBool(TxPoolNoLocalsFlag.Name)
	}
1284 1285 1286 1287 1288 1289
	if ctx.GlobalIsSet(TxPoolJournalFlag.Name) {
		cfg.Journal = ctx.GlobalString(TxPoolJournalFlag.Name)
	}
	if ctx.GlobalIsSet(TxPoolRejournalFlag.Name) {
		cfg.Rejournal = ctx.GlobalDuration(TxPoolRejournalFlag.Name)
	}
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
	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)
	}
}

1313 1314
func setEthash(ctx *cli.Context, cfg *eth.Config) {
	if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
1315
		cfg.Ethash.CacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
1316 1317
	}
	if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
1318
		cfg.Ethash.DatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
1319 1320
	}
	if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
1321
		cfg.Ethash.CachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
1322 1323
	}
	if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
1324
		cfg.Ethash.CachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
1325
	}
1326 1327 1328
	if ctx.GlobalIsSet(EthashCachesLockMmapFlag.Name) {
		cfg.Ethash.CachesLockMmap = ctx.GlobalBool(EthashCachesLockMmapFlag.Name)
	}
1329
	if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
1330
		cfg.Ethash.DatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
1331 1332
	}
	if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
1333
		cfg.Ethash.DatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
1334
	}
1335 1336 1337
	if ctx.GlobalIsSet(EthashDatasetsLockMmapFlag.Name) {
		cfg.Ethash.DatasetsLockMmap = ctx.GlobalBool(EthashDatasetsLockMmapFlag.Name)
	}
1338 1339
}

1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
func setMiner(ctx *cli.Context, cfg *miner.Config) {
	if ctx.GlobalIsSet(MinerNotifyFlag.Name) {
		cfg.Notify = strings.Split(ctx.GlobalString(MinerNotifyFlag.Name), ",")
	}
	if ctx.GlobalIsSet(MinerLegacyExtraDataFlag.Name) {
		cfg.ExtraData = []byte(ctx.GlobalString(MinerLegacyExtraDataFlag.Name))
	}
	if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {
		cfg.ExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))
	}
	if ctx.GlobalIsSet(MinerLegacyGasTargetFlag.Name) {
		cfg.GasFloor = ctx.GlobalUint64(MinerLegacyGasTargetFlag.Name)
	}
	if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {
		cfg.GasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)
	}
	if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {
		cfg.GasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)
	}
	if ctx.GlobalIsSet(MinerLegacyGasPriceFlag.Name) {
		cfg.GasPrice = GlobalBig(ctx, MinerLegacyGasPriceFlag.Name)
	}
	if ctx.GlobalIsSet(MinerGasPriceFlag.Name) {
		cfg.GasPrice = GlobalBig(ctx, MinerGasPriceFlag.Name)
	}
	if ctx.GlobalIsSet(MinerRecommitIntervalFlag.Name) {
		cfg.Recommit = ctx.Duration(MinerRecommitIntervalFlag.Name)
	}
	if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
		cfg.Noverify = ctx.Bool(MinerNoVerfiyFlag.Name)
	}
}

1373
func setWhitelist(ctx *cli.Context, cfg *eth.Config) {
1374 1375 1376 1377 1378 1379 1380 1381 1382
	whitelist := ctx.GlobalString(WhitelistFlag.Name)
	if whitelist == "" {
		return
	}
	cfg.Whitelist = make(map[uint64]common.Hash)
	for _, entry := range strings.Split(whitelist, ",") {
		parts := strings.Split(entry, "=")
		if len(parts) != 2 {
			Fatalf("Invalid whitelist entry: %s", entry)
1383
		}
1384 1385 1386 1387 1388 1389 1390 1391 1392
		number, err := strconv.ParseUint(parts[0], 0, 64)
		if err != nil {
			Fatalf("Invalid whitelist block number %s: %v", parts[0], err)
		}
		var hash common.Hash
		if err = hash.UnmarshalText([]byte(parts[1])); err != nil {
			Fatalf("Invalid whitelist hash %s: %v", parts[1], err)
		}
		cfg.Whitelist[number] = hash
1393 1394 1395
	}
}

1396
// CheckExclusive verifies that only a single instance of the provided flags was
1397 1398
// set by the user. Each flag might optionally be followed by a string type to
// specialize it further.
1399
func CheckExclusive(ctx *cli.Context, args ...interface{}) {
1400
	set := make([]string, 0, 1)
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
	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:
1413
				// Extended flag check, make sure value set doesn't conflict with passed in option
1414 1415
				if ctx.GlobalString(flag.GetName()) == option {
					name += "=" + option
1416
					set = append(set, "--"+name)
1417
				}
1418
				// shift arguments and continue
1419
				i++
1420
				continue
1421 1422 1423 1424 1425 1426 1427

			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
1428
		if ctx.GlobalIsSet(flag.GetName()) {
1429
			set = append(set, "--"+name)
1430 1431
		}
	}
1432
	if len(set) > 1 {
1433
		Fatalf("Flags %v can't be used at the same time", strings.Join(set, ", "))
1434
	}
1435 1436
}

1437 1438
// SetShhConfig applies shh-related command line flags to the config.
func SetShhConfig(ctx *cli.Context, stack *node.Node, cfg *whisper.Config) {
1439 1440
	if ctx.GlobalIsSet(WhisperMaxMessageSizeFlag.Name) {
		cfg.MaxMessageSize = uint32(ctx.GlobalUint(WhisperMaxMessageSizeFlag.Name))
1441
	}
1442 1443
	if ctx.GlobalIsSet(WhisperMinPOWFlag.Name) {
		cfg.MinimumAcceptedPOW = ctx.GlobalFloat64(WhisperMinPOWFlag.Name)
1444
	}
1445 1446 1447
	if ctx.GlobalIsSet(WhisperRestrictConnectionBetweenLightClientsFlag.Name) {
		cfg.RestrictConnectionBetweenLightClients = true
	}
1448 1449
}

1450 1451 1452
// 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
1453
	CheckExclusive(ctx, DeveloperFlag, LegacyTestnetFlag, RopstenFlag, RinkebyFlag, GoerliFlag)
1454 1455 1456
	CheckExclusive(ctx, LightLegacyServFlag, LightServeFlag, SyncModeFlag, "light")
	CheckExclusive(ctx, DeveloperFlag, ExternalSignerFlag) // Can't use both ephemeral unlocked and external signer

1457 1458 1459 1460
	var ks *keystore.KeyStore
	if keystores := stack.AccountManager().Backends(keystore.KeyStoreType); len(keystores) > 0 {
		ks = keystores[0].(*keystore.KeyStore)
	}
1461 1462
	setEtherbase(ctx, ks, cfg)
	setGPO(ctx, &cfg.GPO)
1463
	setTxPool(ctx, &cfg.TxPool)
1464
	setEthash(ctx, cfg)
1465
	setMiner(ctx, &cfg.Miner)
1466
	setWhitelist(ctx, cfg)
1467
	setLes(ctx, cfg)
1468

1469
	if ctx.GlobalIsSet(SyncModeFlag.Name) {
1470 1471 1472
		cfg.SyncMode = *GlobalTextMarshaler(ctx, SyncModeFlag.Name).(*downloader.SyncMode)
	}
	if ctx.GlobalIsSet(NetworkIdFlag.Name) {
1473
		cfg.NetworkId = ctx.GlobalUint64(NetworkIdFlag.Name)
1474
	}
1475 1476
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheDatabaseFlag.Name) {
		cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1477 1478
	}
	cfg.DatabaseHandles = makeDatabaseHandles()
1479 1480 1481
	if ctx.GlobalIsSet(AncientFlag.Name) {
		cfg.DatabaseFreezer = ctx.GlobalString(AncientFlag.Name)
	}
1482

1483 1484 1485
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
1486 1487 1488 1489 1490 1491
	if ctx.GlobalIsSet(GCModeFlag.Name) {
		cfg.NoPruning = ctx.GlobalString(GCModeFlag.Name) == "archive"
	}
	if ctx.GlobalIsSet(CacheNoPrefetchFlag.Name) {
		cfg.NoPrefetch = ctx.GlobalBool(CacheNoPrefetchFlag.Name)
	}
1492 1493 1494
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
		cfg.TrieCleanCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
	}
1495
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
1496
		cfg.TrieDirtyCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
1497
	}
1498 1499 1500
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheSnapshotFlag.Name) {
		cfg.SnapshotCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheSnapshotFlag.Name) / 100
	}
1501 1502 1503
	if !ctx.GlobalIsSet(SnapshotFlag.Name) {
		cfg.SnapshotCache = 0 // Disabled
	}
1504 1505 1506 1507 1508 1509 1510
	if ctx.GlobalIsSet(DocRootFlag.Name) {
		cfg.DocRoot = ctx.GlobalString(DocRootFlag.Name)
	}
	if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
		// TODO(fjl): force-enable this in --dev mode
		cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
	}
1511

1512 1513 1514 1515 1516 1517 1518
	if ctx.GlobalIsSet(EWASMInterpreterFlag.Name) {
		cfg.EWASMInterpreter = ctx.GlobalString(EWASMInterpreterFlag.Name)
	}

	if ctx.GlobalIsSet(EVMInterpreterFlag.Name) {
		cfg.EVMInterpreter = ctx.GlobalString(EVMInterpreterFlag.Name)
	}
1519 1520 1521
	if ctx.GlobalIsSet(RPCGlobalGasCap.Name) {
		cfg.RPCGasCap = new(big.Int).SetUint64(ctx.GlobalUint64(RPCGlobalGasCap.Name))
	}
1522 1523 1524 1525 1526 1527 1528 1529
	if ctx.GlobalIsSet(DNSDiscoveryFlag.Name) {
		urls := ctx.GlobalString(DNSDiscoveryFlag.Name)
		if urls == "" {
			cfg.DiscoveryURLs = []string{}
		} else {
			cfg.DiscoveryURLs = splitAndTrim(urls)
		}
	}
1530

1531
	// Override any default configs for hard coded networks.
1532
	switch {
1533
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
1534
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
1535
			cfg.NetworkId = 3
1536
		}
1537 1538
		cfg.Genesis = core.DefaultRopstenGenesisBlock()
		setDNSDiscoveryDefaults(cfg, params.KnownDNSNetworks[params.RopstenGenesisHash])
1539 1540 1541 1542 1543
	case ctx.GlobalBool(RinkebyFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 4
		}
		cfg.Genesis = core.DefaultRinkebyGenesisBlock()
1544
		setDNSDiscoveryDefaults(cfg, params.KnownDNSNetworks[params.RinkebyGenesisHash])
1545 1546 1547 1548 1549
	case ctx.GlobalBool(GoerliFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 5
		}
		cfg.Genesis = core.DefaultGoerliGenesisBlock()
1550
		setDNSDiscoveryDefaults(cfg, params.KnownDNSNetworks[params.GoerliGenesisHash])
1551
	case ctx.GlobalBool(DeveloperFlag.Name):
1552 1553 1554
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 1337
		}
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
		// 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)
1574
		if !ctx.GlobalIsSet(MinerGasPriceFlag.Name) && !ctx.GlobalIsSet(MinerLegacyGasPriceFlag.Name) {
1575
			cfg.Miner.GasPrice = big.NewInt(1)
1576
		}
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
	default:
		if cfg.NetworkId == 1 {
			setDNSDiscoveryDefaults(cfg, params.KnownDNSNetworks[params.MainnetGenesisHash])
		}
	}
}

// setDNSDiscoveryDefaults configures DNS discovery with the given URL if
// no URLs are set.
func setDNSDiscoveryDefaults(cfg *eth.Config, url string) {
	if cfg.DiscoveryURLs != nil {
		return
1589
	}
1590
	cfg.DiscoveryURLs = []string{url}
1591
}
1592

1593 1594 1595 1596 1597 1598 1599
// 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)
		})
1600
	} else {
1601 1602 1603 1604
		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)
1605 1606 1607
				fullNode.AddLesServer(ls)
			}
			return fullNode, err
1608 1609 1610 1611
		})
	}
	if err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
1612
	}
1613 1614
}

1615
// RegisterShhService configures Whisper and adds it to the given node.
1616 1617 1618 1619
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 {
1620
		Fatalf("Failed to register the Whisper service: %v", err)
1621
	}
1622 1623
}

1624
// RegisterEthStatsService configures the Ethereum Stats daemon and adds it to
1625
// the given node.
1626 1627 1628 1629 1630 1631 1632 1633 1634
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(&ethServ)

		var lesServ *les.LightEthereum
		ctx.Service(&lesServ)

1635
		// Let ethstats use whichever is not nil
1636 1637
		return ethstats.New(url, ethServ, lesServ)
	}); err != nil {
1638
		Fatalf("Failed to register the Ethereum Stats service: %v", err)
1639 1640 1641
	}
}

1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
// RegisterGraphQLService is a utility function to construct a new service and register it against a node.
func RegisterGraphQLService(stack *node.Node, endpoint string, cors, vhosts []string, timeouts rpc.HTTPTimeouts) {
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
		// Try to construct the GraphQL service backed by a full node
		var ethServ *eth.Ethereum
		if err := ctx.Service(&ethServ); err == nil {
			return graphql.New(ethServ.APIBackend, endpoint, cors, vhosts, timeouts)
		}
		// Try to construct the GraphQL service backed by a light node
		var lesServ *les.LightEthereum
		if err := ctx.Service(&lesServ); err == nil {
			return graphql.New(lesServ.ApiBackend, endpoint, cors, vhosts, timeouts)
		}
		// Well, this should not have happened, bail out
		return nil, errors.New("no Ethereum service")
	}); err != nil {
		Fatalf("Failed to register the GraphQL service: %v", err)
	}
}

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673
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)
		)

		if enableExport {
1674 1675
			tagsMap := SplitTagsFlag(ctx.GlobalString(MetricsInfluxDBTagsFlag.Name))

1676
			log.Info("Enabling metrics export to InfluxDB")
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693

			go influxdb.InfluxDBWithTags(metrics.DefaultRegistry, 10*time.Second, endpoint, database, username, password, "geth.", tagsMap)
		}
	}
}

func SplitTagsFlag(tagsFlag string) map[string]string {
	tags := strings.Split(tagsFlag, ",")
	tagsMap := map[string]string{}

	for _, t := range tags {
		if t != "" {
			kv := strings.Split(t, "=")

			if len(kv) == 2 {
				tagsMap[kv[0]] = kv[1]
			}
1694 1695
		}
	}
1696 1697

	return tagsMap
1698 1699
}

1700
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
1701
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
1702
	var (
1703
		cache   = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1704
		handles = makeDatabaseHandles()
1705
	)
1706
	name := "chaindata"
1707
	if ctx.GlobalString(SyncModeFlag.Name) == "light" {
1708 1709
		name = "lightchaindata"
	}
1710
	chainDb, err := stack.OpenDatabaseWithFreezer(name, cache, handles, ctx.GlobalString(AncientFlag.Name), "")
1711
	if err != nil {
1712
		Fatalf("Could not open database: %v", err)
1713
	}
1714 1715 1716
	return chainDb
}

1717 1718 1719
func MakeGenesis(ctx *cli.Context) *core.Genesis {
	var genesis *core.Genesis
	switch {
1720 1721
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
		genesis = core.DefaultRopstenGenesisBlock()
1722 1723
	case ctx.GlobalBool(RinkebyFlag.Name):
		genesis = core.DefaultRinkebyGenesisBlock()
1724 1725
	case ctx.GlobalBool(GoerliFlag.Name):
		genesis = core.DefaultGoerliGenesisBlock()
1726 1727
	case ctx.GlobalBool(DeveloperFlag.Name):
		Fatalf("Developer chains are ephemeral")
1728 1729 1730 1731
	}
	return genesis
}

1732
// MakeChain creates a chain manager from set command line flags.
1733
func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
1734
	var err error
1735
	chainDb = MakeChainDatabase(ctx, stack)
1736 1737 1738 1739
	config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
	if err != nil {
		Fatalf("%v", err)
	}
1740 1741 1742 1743 1744 1745
	var engine consensus.Engine
	if config.Clique != nil {
		engine = clique.New(config.Clique, chainDb)
	} else {
		engine = ethash.NewFaker()
		if !ctx.GlobalBool(FakePoWFlag.Name) {
1746
			engine = ethash.New(ethash.Config{
1747 1748 1749 1750 1751 1752 1753 1754
				CacheDir:         stack.ResolvePath(eth.DefaultConfig.Ethash.CacheDir),
				CachesInMem:      eth.DefaultConfig.Ethash.CachesInMem,
				CachesOnDisk:     eth.DefaultConfig.Ethash.CachesOnDisk,
				CachesLockMmap:   eth.DefaultConfig.Ethash.CachesLockMmap,
				DatasetDir:       stack.ResolvePath(eth.DefaultConfig.Ethash.DatasetDir),
				DatasetsInMem:    eth.DefaultConfig.Ethash.DatasetsInMem,
				DatasetsOnDisk:   eth.DefaultConfig.Ethash.DatasetsOnDisk,
				DatasetsLockMmap: eth.DefaultConfig.Ethash.DatasetsLockMmap,
1755
			}, nil, false)
1756 1757
		}
	}
1758 1759 1760 1761
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
	cache := &core.CacheConfig{
1762 1763 1764 1765 1766
		TrieCleanLimit:      eth.DefaultConfig.TrieCleanCache,
		TrieCleanNoPrefetch: ctx.GlobalBool(CacheNoPrefetchFlag.Name),
		TrieDirtyLimit:      eth.DefaultConfig.TrieDirtyCache,
		TrieDirtyDisabled:   ctx.GlobalString(GCModeFlag.Name) == "archive",
		TrieTimeLimit:       eth.DefaultConfig.TrieTimeout,
1767
		SnapshotLimit:       eth.DefaultConfig.SnapshotCache,
1768
	}
1769 1770 1771
	if !ctx.GlobalIsSet(SnapshotFlag.Name) {
		cache.SnapshotLimit = 0 // Disabled
	}
1772 1773
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
		cache.TrieCleanLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
1774 1775
	}
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
1776
		cache.TrieDirtyLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
1777
	}
1778
	vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
1779
	chain, err = core.NewBlockChain(chainDb, cache, config, engine, vmcfg, nil)
1780
	if err != nil {
1781
		Fatalf("Can't create BlockChain: %v", err)
1782
	}
1783
	return chain, chainDb
1784
}
1785 1786 1787 1788 1789 1790 1791 1792 1793

// 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
1794
	var preloads []string
1795 1796 1797 1798 1799 1800 1801

	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
}
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825

// 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)
	}
}