flags.go 66.4 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
	"fmt"
23
	"io"
24
	"io/ioutil"
25
	"math/big"
26
	"os"
27
	"path/filepath"
28
	"strconv"
29
	"strings"
30 31
	"text/tabwriter"
	"text/template"
32
	"time"
33

34
	"github.com/ethereum/go-ethereum/accounts"
35
	"github.com/ethereum/go-ethereum/accounts/keystore"
zelig's avatar
zelig committed
36
	"github.com/ethereum/go-ethereum/common"
37
	"github.com/ethereum/go-ethereum/common/fdlimit"
38 39
	"github.com/ethereum/go-ethereum/consensus"
	"github.com/ethereum/go-ethereum/consensus/clique"
40
	"github.com/ethereum/go-ethereum/consensus/ethash"
41
	"github.com/ethereum/go-ethereum/core"
42
	"github.com/ethereum/go-ethereum/core/rawdb"
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/internal/ethapi"
52
	"github.com/ethereum/go-ethereum/internal/flags"
53
	"github.com/ethereum/go-ethereum/les"
54
	"github.com/ethereum/go-ethereum/log"
55
	"github.com/ethereum/go-ethereum/metrics"
56
	"github.com/ethereum/go-ethereum/metrics/exp"
57
	"github.com/ethereum/go-ethereum/metrics/influxdb"
58
	"github.com/ethereum/go-ethereum/miner"
59
	"github.com/ethereum/go-ethereum/node"
60
	"github.com/ethereum/go-ethereum/p2p"
61
	"github.com/ethereum/go-ethereum/p2p/discv5"
62
	"github.com/ethereum/go-ethereum/p2p/enode"
63
	"github.com/ethereum/go-ethereum/p2p/nat"
64
	"github.com/ethereum/go-ethereum/p2p/netutil"
65
	"github.com/ethereum/go-ethereum/params"
66
	pcsclite "github.com/gballet/go-libpcsclite"
67
	cli "gopkg.in/urfave/cli.v1"
68 69
)

70 71 72 73 74 75 76 77 78 79 80 81 82
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}}
`
83
	cli.CommandHelpTemplate = flags.CommandHelpTemplate
84
	cli.HelpPrinter = printHelp
85 86
}

87 88 89 90 91 92 93 94 95 96 97
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()
}

98 99 100 101 102 103 104 105 106
// 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
107
	DataDirFlag = DirectoryFlag{
108
		Name:  "datadir",
109
		Usage: "Data directory for the databases and keystore",
110
		Value: DirectoryString(node.DefaultDataDir()),
111
	}
112 113 114 115
	AncientFlag = DirectoryFlag{
		Name:  "datadir.ancient",
		Usage: "Data directory for ancient chain segments (default = inside chaindata)",
	}
116 117 118 119
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
120 121
	NoUSBFlag = cli.BoolFlag{
		Name:  "nousb",
122
		Usage: "Disables monitoring for and managing USB hardware wallets",
123
	}
124 125 126 127 128
	SmartCardDaemonPathFlag = cli.StringFlag{
		Name:  "pcscdpath",
		Usage: "Path to the smartcard daemon (pcscd) socket file",
		Value: pcsclite.PCSCDSockName,
	}
129
	NetworkIdFlag = cli.Uint64Flag{
zelig's avatar
zelig committed
130
		Name:  "networkid",
131
		Usage: "Explicitly set network id (integer)(For testnets: use --ropsten, --rinkeby, --goerli instead)",
132
		Value: eth.DefaultConfig.NetworkId,
zelig's avatar
zelig committed
133
	}
134 135 136
	GoerliFlag = cli.BoolFlag{
		Name:  "goerli",
		Usage: "Görli network: pre-configured proof-of-authority test network",
137
	}
138 139 140 141
	YoloV1Flag = cli.BoolFlag{
		Name:  "yolov1",
		Usage: "YOLOv1 network: pre-configured proof-of-authority shortlived test network.",
	}
142 143 144 145
	RinkebyFlag = cli.BoolFlag{
		Name:  "rinkeby",
		Usage: "Rinkeby network: pre-configured proof-of-authority test network",
	}
146 147 148
	RopstenFlag = cli.BoolFlag{
		Name:  "ropsten",
		Usage: "Ropsten network: pre-configured proof-of-work test network",
149
	}
150
	DeveloperFlag = cli.BoolFlag{
151
		Name:  "dev",
152 153 154 155 156
		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)",
157
	}
158 159
	IdentityFlag = cli.StringFlag{
		Name:  "identity",
160
		Usage: "Custom node name",
161
	}
zelig's avatar
zelig committed
162 163 164
	DocRootFlag = DirectoryFlag{
		Name:  "docroot",
		Usage: "Document Root for HTTPClient file scheme",
165
		Value: DirectoryString(HomeDir()),
zelig's avatar
zelig committed
166
	}
167 168
	ExitWhenSyncedFlag = cli.BoolFlag{
		Name:  "exitwhensynced",
169
		Usage: "Exits after block synchronisation completes",
170
	}
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
	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)",
	}
187 188 189 190 191 192
	defaultSyncMode = eth.DefaultConfig.SyncMode
	SyncModeFlag    = TextMarshalerFlag{
		Name:  "syncmode",
		Usage: `Blockchain sync mode ("fast", "full", or "light")`,
		Value: &defaultSyncMode,
	}
193 194 195 196 197
	GCModeFlag = cli.StringFlag{
		Name:  "gcmode",
		Usage: `Blockchain garbage collection mode ("full", "archive")`,
		Value: "full",
	}
198 199 200 201
	SnapshotFlag = cli.BoolFlag{
		Name:  "snapshot",
		Usage: `Enables snapshot-database mode -- experimental work in progress feature`,
	}
202 203 204 205 206
	TxLookupLimitFlag = cli.Int64Flag{
		Name:  "txlookuplimit",
		Usage: "Number of recent blocks to maintain transactions index by-hash for (default = index all blocks)",
		Value: 0,
	}
207 208 209 210 211 212 213 214
	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>)",
	}
215 216 217
	// Light server and client settings
	LightServeFlag = cli.IntFlag{
		Name:  "light.serve",
218
		Usage: "Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100)",
219
		Value: eth.DefaultConfig.LightServ,
220
	}
221 222 223 224
	LightIngressFlag = cli.IntFlag{
		Name:  "light.ingress",
		Usage: "Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
		Value: eth.DefaultConfig.LightIngress,
225
	}
226 227 228 229
	LightEgressFlag = cli.IntFlag{
		Name:  "light.egress",
		Usage: "Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
		Value: eth.DefaultConfig.LightEgress,
230
	}
231 232 233
	LightMaxPeersFlag = cli.IntFlag{
		Name:  "light.maxpeers",
		Usage: "Maximum number of light clients to serve, or light servers to attach to",
234
		Value: eth.DefaultConfig.LightPeers,
235
	}
236 237 238 239
	UltraLightServersFlag = cli.StringFlag{
		Name:  "ulc.servers",
		Usage: "List of trusted ultra-light servers",
		Value: strings.Join(eth.DefaultConfig.UltraLightServers, ","),
240
	}
241 242 243 244 245 246 247 248
	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",
249
	}
250 251 252 253
	LightNoPruneFlag = cli.BoolFlag{
		Name:  "light.nopruning",
		Usage: "Disable ancient light chain data pruning",
	}
254 255 256 257 258 259 260 261
	// 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)",
262
		Value: eth.DefaultConfig.Ethash.CachesInMem,
263 264 265 266
	}
	EthashCachesOnDiskFlag = cli.IntFlag{
		Name:  "ethash.cachesondisk",
		Usage: "Number of recent ethash caches to keep on disk (16MB each)",
267
		Value: eth.DefaultConfig.Ethash.CachesOnDisk,
268
	}
269 270 271 272
	EthashCachesLockMmapFlag = cli.BoolFlag{
		Name:  "ethash.cacheslockmmap",
		Usage: "Lock memory maps of recent ethash caches",
	}
273 274
	EthashDatasetDirFlag = DirectoryFlag{
		Name:  "ethash.dagdir",
275 276
		Usage: "Directory to store the ethash mining DAGs",
		Value: DirectoryString(eth.DefaultConfig.Ethash.DatasetDir),
277 278 279 280
	}
	EthashDatasetsInMemoryFlag = cli.IntFlag{
		Name:  "ethash.dagsinmem",
		Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
281
		Value: eth.DefaultConfig.Ethash.DatasetsInMem,
282 283 284 285
	}
	EthashDatasetsOnDiskFlag = cli.IntFlag{
		Name:  "ethash.dagsondisk",
		Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
286
		Value: eth.DefaultConfig.Ethash.DatasetsOnDisk,
287
	}
288 289 290 291
	EthashDatasetsLockMmapFlag = cli.BoolFlag{
		Name:  "ethash.dagslockmmap",
		Usage: "Lock memory maps for recent ethash mining DAGs",
	}
292
	// Transaction pool settings
293 294 295 296
	TxPoolLocalsFlag = cli.StringFlag{
		Name:  "txpool.locals",
		Usage: "Comma separated accounts to treat as locals (no flush, priority inclusion)",
	}
297 298 299 300
	TxPoolNoLocalsFlag = cli.BoolFlag{
		Name:  "txpool.nolocals",
		Usage: "Disables price exemptions for locally submitted transactions",
	}
301 302 303 304 305 306 307 308 309 310
	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,
	}
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
	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,
	}
346 347 348
	// Performance tuning settings
	CacheFlag = cli.IntFlag{
		Name:  "cache",
349
		Usage: "Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode)",
350 351 352 353 354
		Value: 1024,
	}
	CacheDatabaseFlag = cli.IntFlag{
		Name:  "cache.database",
		Usage: "Percentage of cache memory allowance to use for database io",
355 356 357 358
		Value: 50,
	}
	CacheTrieFlag = cli.IntFlag{
		Name:  "cache.trie",
359 360
		Usage: "Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode)",
		Value: 15,
361
	}
362 363 364 365 366 367 368 369 370 371
	CacheTrieJournalFlag = cli.StringFlag{
		Name:  "cache.trie.journal",
		Usage: "Disk journal directory for trie cache to survive node restarts",
		Value: eth.DefaultConfig.TrieCleanCacheJournal,
	}
	CacheTrieRejournalFlag = cli.DurationFlag{
		Name:  "cache.trie.rejournal",
		Usage: "Time interval to regenerate the trie cache journal",
		Value: eth.DefaultConfig.TrieCleanCacheRejournal,
	}
372 373
	CacheGCFlag = cli.IntFlag{
		Name:  "cache.gc",
374
		Usage: "Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode)",
375
		Value: 25,
376
	}
377 378 379 380 381
	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,
	}
382 383 384 385
	CacheNoPrefetchFlag = cli.BoolFlag{
		Name:  "cache.noprefetch",
		Usage: "Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)",
	}
386 387 388 389
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
390
	}
391
	MinerThreadsFlag = cli.IntFlag{
392
		Name:  "miner.threads",
393
		Usage: "Number of CPU threads to use for mining",
394 395 396 397 398
		Value: 0,
	}
	MinerNotifyFlag = cli.StringFlag{
		Name:  "miner.notify",
		Usage: "Comma separated HTTP URL list to notify of new work packages",
399
	}
400 401 402
	MinerGasTargetFlag = cli.Uint64Flag{
		Name:  "miner.gastarget",
		Usage: "Target gas floor for mined blocks",
403
		Value: eth.DefaultConfig.Miner.GasFloor,
404
	}
405 406 407
	MinerGasLimitFlag = cli.Uint64Flag{
		Name:  "miner.gaslimit",
		Usage: "Target gas ceiling for mined blocks",
408
		Value: eth.DefaultConfig.Miner.GasCeil,
409
	}
410 411
	MinerGasPriceFlag = BigFlag{
		Name:  "miner.gasprice",
412
		Usage: "Minimum gas price for mining a transaction",
413
		Value: eth.DefaultConfig.Miner.GasPrice,
zelig's avatar
zelig committed
414
	}
415 416 417 418 419 420 421
	MinerEtherbaseFlag = cli.StringFlag{
		Name:  "miner.etherbase",
		Usage: "Public address for block mining rewards (default = first account)",
		Value: "0",
	}
	MinerExtraDataFlag = cli.StringFlag{
		Name:  "miner.extradata",
422
		Usage: "Block extra data set by the miner (default = client version)",
zelig's avatar
zelig committed
423
	}
424 425
	MinerRecommitIntervalFlag = cli.DurationFlag{
		Name:  "miner.recommit",
426
		Usage: "Time interval to recreate the block being mined",
427
		Value: eth.DefaultConfig.Miner.Recommit,
428
	}
429 430 431 432
	MinerNoVerfiyFlag = cli.BoolFlag{
		Name:  "miner.noverify",
		Usage: "Disable remote sealing verification",
	}
433
	// Account settings
zelig's avatar
zelig committed
434 435
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
436
		Usage: "Comma separated list of accounts to unlock",
zelig's avatar
zelig committed
437 438 439 440
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
441
		Usage: "Password file to use for non-interactive password input",
zelig's avatar
zelig committed
442
		Value: "",
zelig's avatar
zelig committed
443
	}
444 445 446 447 448
	ExternalSignerFlag = cli.StringFlag{
		Name:  "signer",
		Usage: "External signer (url or path to ipc file)",
		Value: "",
	}
449 450 451 452
	VMEnableDebugFlag = cli.BoolFlag{
		Name:  "vmdebug",
		Usage: "Record information useful for VM and contract debugging",
	}
453 454 455 456
	InsecureUnlockAllowedFlag = cli.BoolFlag{
		Name:  "allow-insecure-unlock",
		Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http",
	}
457 458
	RPCGlobalGasCap = cli.Uint64Flag{
		Name:  "rpc.gascap",
459 460
		Usage: "Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)",
		Value: eth.DefaultConfig.RPCGasCap,
461
	}
462 463 464 465 466
	RPCGlobalTxFeeCap = cli.Float64Flag{
		Name:  "rpc.txfeecap",
		Usage: "Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap)",
		Value: eth.DefaultConfig.RPCTxFeeCap,
	}
467 468 469 470 471
	// Logging and debug settings
	EthStatsURLFlag = cli.StringFlag{
		Name:  "ethstats",
		Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
	}
472 473 474 475
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
476 477 478 479
	NoCompactionFlag = cli.BoolFlag{
		Name:  "nocompaction",
		Usage: "Disables db compaction after import",
	}
480
	// RPC settings
481 482 483 484 485 486 487 488
	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)",
	}
489 490
	HTTPEnabledFlag = cli.BoolFlag{
		Name:  "http",
491
		Usage: "Enable the HTTP-RPC server",
492
	}
493 494
	HTTPListenAddrFlag = cli.StringFlag{
		Name:  "http.addr",
495
		Usage: "HTTP-RPC server listening interface",
496
		Value: node.DefaultHTTPHost,
497
	}
498 499
	HTTPPortFlag = cli.IntFlag{
		Name:  "http.port",
500
		Usage: "HTTP-RPC server listening port",
501
		Value: node.DefaultHTTPPort,
502
	}
503 504
	HTTPCORSDomainFlag = cli.StringFlag{
		Name:  "http.corsdomain",
505
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
506 507
		Value: "",
	}
508 509
	HTTPVirtualHostsFlag = cli.StringFlag{
		Name:  "http.vhosts",
510
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
511
		Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
512
	}
513 514
	HTTPApiFlag = cli.StringFlag{
		Name:  "http.api",
515
		Usage: "API's offered over the HTTP-RPC interface",
516
		Value: "",
517
	}
518 519 520 521 522 523 524 525 526 527 528 529 530 531
	GraphQLEnabledFlag = cli.BoolFlag{
		Name:  "graphql",
		Usage: "Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.",
	}
	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, ","),
	}
532
	WSEnabledFlag = cli.BoolFlag{
533
		Name:  "ws",
534 535 536
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
537
		Name:  "ws.addr",
538
		Usage: "WS-RPC server listening interface",
539
		Value: node.DefaultWSHost,
540 541
	}
	WSPortFlag = cli.IntFlag{
542
		Name:  "ws.port",
543
		Usage: "WS-RPC server listening port",
544
		Value: node.DefaultWSPort,
545 546
	}
	WSApiFlag = cli.StringFlag{
547
		Name:  "ws.api",
548
		Usage: "API's offered over the WS-RPC interface",
549
		Value: "",
550
	}
551
	WSAllowedOriginsFlag = cli.StringFlag{
552
		Name:  "ws.origins",
553
		Usage: "Origins from which to accept websockets requests",
554
		Value: "",
555
	}
556 557
	ExecFlag = cli.StringFlag{
		Name:  "exec",
558
		Usage: "Execute JavaScript statement",
559
	}
560
	PreloadJSFlag = cli.StringFlag{
561 562 563
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}
564

565 566 567
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
568
		Usage: "Maximum number of network peers (network disabled if set to 0)",
569
		Value: node.DefaultConfig.P2P.MaxPeers,
570
	}
571 572 573
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
574
		Value: node.DefaultConfig.P2P.MaxPendingPeers,
575
	}
576 577 578 579 580
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
581
	BootnodesFlag = cli.StringFlag{
582
		Name:  "bootnodes",
583
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
584
		Value: "",
585 586 587 588 589 590 591 592 593 594 595
	}
	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",
596
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
597 598
		Value: "any",
	}
599 600 601 602
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
603 604 605 606
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
607 608 609 610
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}
611 612 613 614
	DNSDiscoveryFlag = cli.StringFlag{
		Name:  "discovery.dns",
		Usage: "Sets DNS discovery entry points (use \"\" to disable DNS)",
	}
615

616
	// ATM the url is left to the user and deployment to
zelig's avatar
zelig committed
617 618
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
619
		Usage: "JavaScript root path for `loadScript`",
zelig's avatar
zelig committed
620 621
		Value: ".",
	}
622 623

	// Gas price oracle settings
624
	GpoBlocksFlag = cli.IntFlag{
625
		Name:  "gpo.blocks",
626
		Usage: "Number of recent blocks to check for gas prices",
627
		Value: eth.DefaultConfig.GPO.Blocks,
zsfelfoldi's avatar
zsfelfoldi committed
628
	}
629
	GpoPercentileFlag = cli.IntFlag{
630
		Name:  "gpo.percentile",
631
		Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
632
		Value: eth.DefaultConfig.GPO.Percentile,
zsfelfoldi's avatar
zsfelfoldi committed
633
	}
634 635 636 637 638
	GpoMaxGasPriceFlag = cli.Int64Flag{
		Name:  "gpo.maxprice",
		Usage: "Maximum gas price will be recommended by gpo",
		Value: eth.DefaultConfig.GPO.MaxPrice.Int64(),
	}
639 640 641 642 643 644 645
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
		Usage: "Enable Whisper",
	}
	WhisperMaxMessageSizeFlag = cli.IntFlag{
		Name:  "shh.maxmessagesize",
		Usage: "Max message size accepted",
646
		Value: 1024 * 1024,
647 648 649 650
	}
	WhisperMinPOWFlag = cli.Float64Flag{
		Name:  "shh.pow",
		Usage: "Minimum POW accepted",
651
		Value: 0.2,
652
	}
653 654 655 656
	WhisperRestrictConnectionBetweenLightClientsFlag = cli.BoolFlag{
		Name:  "shh.restrict-light",
		Usage: "Restrict connection between two whisper light clients",
	}
657 658 659

	// Metrics flags
	MetricsEnabledFlag = cli.BoolFlag{
660
		Name:  "metrics",
661 662
		Usage: "Enable metrics collection and reporting",
	}
663 664 665 666
	MetricsEnabledExpensiveFlag = cli.BoolFlag{
		Name:  "metrics.expensive",
		Usage: "Enable expensive metrics collection and reporting",
	}
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681

	// MetricsHTTPFlag defines the endpoint for a stand-alone metrics HTTP endpoint.
	// Since the pprof service enables sensitive/vulnerable behavior, this allows a user
	// to enable a public-OK metrics endpoint without having to worry about ALSO exposing
	// other profiling behavior or information.
	MetricsHTTPFlag = cli.StringFlag{
		Name:  "metrics.addr",
		Usage: "Enable stand-alone metrics HTTP server listening interface",
		Value: "127.0.0.1",
	}
	MetricsPortFlag = cli.IntFlag{
		Name:  "metrics.port",
		Usage: "Metrics HTTP server listening port",
		Value: 6060,
	}
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
	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",
	}
706 707 708
	// 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.
709
	// https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
710 711 712 713
	MetricsInfluxDBTagsFlag = cli.StringFlag{
		Name:  "metrics.influxdb.tags",
		Usage: "Comma-separated InfluxDB tags (key/values) attached to all measurements",
		Value: "host=localhost",
714
	}
715 716 717 718 719 720 721 722 723 724
	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: "",
	}
725 726
)

727
// MakeDataDir retrieves the currently requested data directory, terminating
728
// if none (or the empty string) is specified. If the node is starting a testnet,
729
// then a subdirectory of the specified datadir will be used.
730
func MakeDataDir(ctx *cli.Context) string {
731
	if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
732 733 734 735 736 737 738 739
		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")
740
		}
741 742 743
		if ctx.GlobalBool(RinkebyFlag.Name) {
			return filepath.Join(path, "rinkeby")
		}
744 745 746
		if ctx.GlobalBool(GoerliFlag.Name) {
			return filepath.Join(path, "goerli")
		}
747 748 749
		if ctx.GlobalBool(YoloV1Flag.Name) {
			return filepath.Join(path, "yolo-v1")
		}
750
		return path
751
	}
752
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
753
	return ""
754 755
}

756
// setNodeKey creates a node key from set command line flags, either loading it
757 758
// 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.
759
func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
760 761 762
	var (
		hex  = ctx.GlobalString(NodeKeyHexFlag.Name)
		file = ctx.GlobalString(NodeKeyFileFlag.Name)
763 764
		key  *ecdsa.PrivateKey
		err  error
765
	)
766 767
	switch {
	case file != "" && hex != "":
768
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
769 770
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
771
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
772
		}
773
		cfg.PrivateKey = key
774 775
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
776
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
777
		}
778
		cfg.PrivateKey = key
779 780 781
	}
}

782 783
// setNodeUserIdent creates the user identifier from CLI flags.
func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
784
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
785
		cfg.UserIdent = identity
786 787 788
	}
}

789
// setBootstrapNodes creates a list of bootstrap nodes from the command line
790
// flags, reverting to pre-configured ones if none have been specified.
791
func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
792
	urls := params.MainnetBootnodes
793
	switch {
794 795
	case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(LegacyBootnodesV4Flag.Name):
		if ctx.GlobalIsSet(LegacyBootnodesV4Flag.Name) {
796
			urls = SplitAndTrim(ctx.GlobalString(LegacyBootnodesV4Flag.Name))
797
		} else {
798
			urls = SplitAndTrim(ctx.GlobalString(BootnodesFlag.Name))
799
		}
800 801
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
		urls = params.RopstenBootnodes
802 803
	case ctx.GlobalBool(RinkebyFlag.Name):
		urls = params.RinkebyBootnodes
804 805
	case ctx.GlobalBool(GoerliFlag.Name):
		urls = params.GoerliBootnodes
806 807
	case ctx.GlobalBool(YoloV1Flag.Name):
		urls = params.YoloV1Bootnodes
808 809
	case cfg.BootstrapNodes != nil:
		return // already set, don't apply defaults.
810 811
	}

812
	cfg.BootstrapNodes = make([]*enode.Node, 0, len(urls))
813
	for _, url := range urls {
814
		if url != "" {
815
			node, err := enode.Parse(enode.ValidSchemes, url)
816 817
			if err != nil {
				log.Crit("Bootstrap URL invalid", "enode", url, "err", err)
818
				continue
819 820
			}
			cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
821 822 823 824
		}
	}
}

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

848
	cfg.BootstrapNodesV5 = make([]*discv5.Node, 0, len(urls))
849
	for _, url := range urls {
850 851 852 853 854 855 856
		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)
857 858 859 860
		}
	}
}

861
// setListenAddress creates a TCP listening address string from set command
862
// line flags.
863 864 865 866
func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
	if ctx.GlobalIsSet(ListenPortFlag.Name) {
		cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
	}
867 868
}

869 870 871 872 873 874 875 876
// 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
877 878 879
	}
}

880
// SplitAndTrim splits input separated by a comma
881
// and trims excessive white space from the substrings.
882
func SplitAndTrim(input string) (ret []string) {
883 884
	l := strings.Split(input, ",")
	for _, r := range l {
885
		if r = strings.TrimSpace(r); r != "" {
886 887
			ret = append(ret, r)
		}
888
	}
889
	return ret
890 891
}

892
// setHTTP creates the HTTP RPC listener interface string from the set
893
// command line flags, returning empty if the HTTP endpoint is disabled.
894
func setHTTP(ctx *cli.Context, cfg *node.Config) {
895 896
	if ctx.GlobalBool(LegacyRPCEnabledFlag.Name) && cfg.HTTPHost == "" {
		log.Warn("The flag --rpc is deprecated and will be removed in the future, please use --http")
897
		cfg.HTTPHost = "127.0.0.1"
898 899 900
		if ctx.GlobalIsSet(LegacyRPCListenAddrFlag.Name) {
			cfg.HTTPHost = ctx.GlobalString(LegacyRPCListenAddrFlag.Name)
			log.Warn("The flag --rpcaddr is deprecated and will be removed in the future, please use --http.addr")
901 902
		}
	}
903 904 905 906 907
	if ctx.GlobalBool(HTTPEnabledFlag.Name) && cfg.HTTPHost == "" {
		cfg.HTTPHost = "127.0.0.1"
		if ctx.GlobalIsSet(HTTPListenAddrFlag.Name) {
			cfg.HTTPHost = ctx.GlobalString(HTTPListenAddrFlag.Name)
		}
908
	}
909 910 911 912

	if ctx.GlobalIsSet(LegacyRPCPortFlag.Name) {
		cfg.HTTPPort = ctx.GlobalInt(LegacyRPCPortFlag.Name)
		log.Warn("The flag --rpcport is deprecated and will be removed in the future, please use --http.port")
913
	}
914 915
	if ctx.GlobalIsSet(HTTPPortFlag.Name) {
		cfg.HTTPPort = ctx.GlobalInt(HTTPPortFlag.Name)
916
	}
917 918

	if ctx.GlobalIsSet(LegacyRPCCORSDomainFlag.Name) {
919
		cfg.HTTPCors = SplitAndTrim(ctx.GlobalString(LegacyRPCCORSDomainFlag.Name))
920 921 922
		log.Warn("The flag --rpccorsdomain is deprecated and will be removed in the future, please use --http.corsdomain")
	}
	if ctx.GlobalIsSet(HTTPCORSDomainFlag.Name) {
923
		cfg.HTTPCors = SplitAndTrim(ctx.GlobalString(HTTPCORSDomainFlag.Name))
924 925 926
	}

	if ctx.GlobalIsSet(LegacyRPCApiFlag.Name) {
927
		cfg.HTTPModules = SplitAndTrim(ctx.GlobalString(LegacyRPCApiFlag.Name))
928 929 930
		log.Warn("The flag --rpcapi is deprecated and will be removed in the future, please use --http.api")
	}
	if ctx.GlobalIsSet(HTTPApiFlag.Name) {
931
		cfg.HTTPModules = SplitAndTrim(ctx.GlobalString(HTTPApiFlag.Name))
932 933 934
	}

	if ctx.GlobalIsSet(LegacyRPCVirtualHostsFlag.Name) {
935
		cfg.HTTPVirtualHosts = SplitAndTrim(ctx.GlobalString(LegacyRPCVirtualHostsFlag.Name))
936 937 938
		log.Warn("The flag --rpcvhosts is deprecated and will be removed in the future, please use --http.vhosts")
	}
	if ctx.GlobalIsSet(HTTPVirtualHostsFlag.Name) {
939
		cfg.HTTPVirtualHosts = SplitAndTrim(ctx.GlobalString(HTTPVirtualHostsFlag.Name))
940
	}
941 942
}

943 944 945 946
// 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.GlobalIsSet(GraphQLCORSDomainFlag.Name) {
947
		cfg.GraphQLCors = SplitAndTrim(ctx.GlobalString(GraphQLCORSDomainFlag.Name))
948 949
	}
	if ctx.GlobalIsSet(GraphQLVirtualHostsFlag.Name) {
950
		cfg.GraphQLVirtualHosts = SplitAndTrim(ctx.GlobalString(GraphQLVirtualHostsFlag.Name))
951 952 953
	}
}

954
// setWS creates the WebSocket RPC listener interface string from the set
955
// command line flags, returning empty if the HTTP endpoint is disabled.
956 957 958
func setWS(ctx *cli.Context, cfg *node.Config) {
	if ctx.GlobalBool(WSEnabledFlag.Name) && cfg.WSHost == "" {
		cfg.WSHost = "127.0.0.1"
959 960 961 962
		if ctx.GlobalIsSet(LegacyWSListenAddrFlag.Name) {
			cfg.WSHost = ctx.GlobalString(LegacyWSListenAddrFlag.Name)
			log.Warn("The flag --wsaddr is deprecated and will be removed in the future, please use --ws.addr")
		}
963 964 965 966
		if ctx.GlobalIsSet(WSListenAddrFlag.Name) {
			cfg.WSHost = ctx.GlobalString(WSListenAddrFlag.Name)
		}
	}
967 968 969 970
	if ctx.GlobalIsSet(LegacyWSPortFlag.Name) {
		cfg.WSPort = ctx.GlobalInt(LegacyWSPortFlag.Name)
		log.Warn("The flag --wsport is deprecated and will be removed in the future, please use --ws.port")
	}
971 972 973
	if ctx.GlobalIsSet(WSPortFlag.Name) {
		cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)
	}
974 975

	if ctx.GlobalIsSet(LegacyWSAllowedOriginsFlag.Name) {
976
		cfg.WSOrigins = SplitAndTrim(ctx.GlobalString(LegacyWSAllowedOriginsFlag.Name))
977 978
		log.Warn("The flag --wsorigins is deprecated and will be removed in the future, please use --ws.origins")
	}
979
	if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {
980
		cfg.WSOrigins = SplitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
981
	}
982 983

	if ctx.GlobalIsSet(LegacyWSApiFlag.Name) {
984
		cfg.WSModules = SplitAndTrim(ctx.GlobalString(LegacyWSApiFlag.Name))
985 986
		log.Warn("The flag --wsapi is deprecated and will be removed in the future, please use --ws.api")
	}
987
	if ctx.GlobalIsSet(WSApiFlag.Name) {
988
		cfg.WSModules = SplitAndTrim(ctx.GlobalString(WSApiFlag.Name))
989 990 991 992 993 994
	}
}

// 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) {
995
	CheckExclusive(ctx, IPCDisabledFlag, IPCPathFlag)
996 997 998 999 1000
	switch {
	case ctx.GlobalBool(IPCDisabledFlag.Name):
		cfg.IPCPath = ""
	case ctx.GlobalIsSet(IPCPathFlag.Name):
		cfg.IPCPath = ctx.GlobalString(IPCPathFlag.Name)
1001 1002 1003
	}
}

1004 1005
// setLes configures the les server and ultra light client settings from the command line flags.
func setLes(ctx *cli.Context, cfg *eth.Config) {
1006 1007 1008
	if ctx.GlobalIsSet(LegacyLightServFlag.Name) {
		cfg.LightServ = ctx.GlobalInt(LegacyLightServFlag.Name)
		log.Warn("The flag --lightserv is deprecated and will be removed in the future, please use --light.serve")
1009 1010 1011 1012 1013 1014
	}
	if ctx.GlobalIsSet(LightServeFlag.Name) {
		cfg.LightServ = ctx.GlobalInt(LightServeFlag.Name)
	}
	if ctx.GlobalIsSet(LightIngressFlag.Name) {
		cfg.LightIngress = ctx.GlobalInt(LightIngressFlag.Name)
1015
	}
1016 1017
	if ctx.GlobalIsSet(LightEgressFlag.Name) {
		cfg.LightEgress = ctx.GlobalInt(LightEgressFlag.Name)
1018
	}
1019 1020 1021
	if ctx.GlobalIsSet(LegacyLightPeersFlag.Name) {
		cfg.LightPeers = ctx.GlobalInt(LegacyLightPeersFlag.Name)
		log.Warn("The flag --lightpeers is deprecated and will be removed in the future, please use --light.maxpeers")
1022
	}
1023 1024
	if ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
		cfg.LightPeers = ctx.GlobalInt(LightMaxPeersFlag.Name)
1025
	}
1026 1027
	if ctx.GlobalIsSet(UltraLightServersFlag.Name) {
		cfg.UltraLightServers = strings.Split(ctx.GlobalString(UltraLightServersFlag.Name), ",")
1028
	}
1029 1030
	if ctx.GlobalIsSet(UltraLightFractionFlag.Name) {
		cfg.UltraLightFraction = ctx.GlobalInt(UltraLightFractionFlag.Name)
1031
	}
1032 1033 1034
	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
1035
	}
1036 1037
	if ctx.GlobalIsSet(UltraLightOnlyAnnounceFlag.Name) {
		cfg.UltraLightOnlyAnnounce = ctx.GlobalBool(UltraLightOnlyAnnounceFlag.Name)
1038
	}
1039 1040 1041
	if ctx.GlobalIsSet(LightNoPruneFlag.Name) {
		cfg.LightNoPrune = ctx.GlobalBool(LightNoPruneFlag.Name)
	}
1042 1043
}

1044
// makeDatabaseHandles raises out the number of allowed file handles per process
1045
// for Geth and returns half of the allowance to assign to the database.
1046
func makeDatabaseHandles() int {
1047
	limit, err := fdlimit.Maximum()
1048
	if err != nil {
1049
		Fatalf("Failed to retrieve file descriptor allowance: %v", err)
1050
	}
1051 1052
	raised, err := fdlimit.Raise(uint64(limit))
	if err != nil {
1053
		Fatalf("Failed to raise file descriptor allowance: %v", err)
1054
	}
1055
	return int(raised / 2) // Leave half for networking and other stuff
1056 1057
}

1058 1059
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
1060
func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
1061 1062
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
Felix Lange's avatar
Felix Lange committed
1063
		return accounts.Account{Address: common.HexToAddress(account)}, nil
1064 1065 1066
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
1067
	if err != nil || index < 0 {
Felix Lange's avatar
Felix Lange committed
1068
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
1069
	}
1070 1071 1072 1073 1074 1075
	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("-------------------------------------------------------------------")

1076 1077 1078 1079 1080
	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
1081 1082
}

1083
// setEtherbase retrieves the etherbase either from the directly specified
1084
// command line flags or from the keystore if CLI indexed.
1085
func setEtherbase(ctx *cli.Context, ks *keystore.KeyStore, cfg *eth.Config) {
1086 1087
	// Extract the current etherbase, new flag overriding legacy one
	var etherbase string
1088 1089 1090 1091
	if ctx.GlobalIsSet(LegacyMinerEtherbaseFlag.Name) {
		etherbase = ctx.GlobalString(LegacyMinerEtherbaseFlag.Name)
		log.Warn("The flag --etherbase is deprecated and will be removed in the future, please use --miner.etherbase")

1092 1093 1094 1095 1096 1097
	}
	if ctx.GlobalIsSet(MinerEtherbaseFlag.Name) {
		etherbase = ctx.GlobalString(MinerEtherbaseFlag.Name)
	}
	// Convert the etherbase into an address and configure it
	if etherbase != "" {
1098 1099 1100 1101 1102
		if ks != nil {
			account, err := MakeAddress(ks, etherbase)
			if err != nil {
				Fatalf("Invalid miner etherbase: %v", err)
			}
1103
			cfg.Miner.Etherbase = account.Address
1104 1105
		} else {
			Fatalf("No etherbase configured")
1106
		}
1107
	}
1108 1109
}

1110
// MakePasswordList reads password lines from the file specified by the global --password flag.
1111
func MakePasswordList(ctx *cli.Context) []string {
1112 1113 1114 1115 1116 1117
	path := ctx.GlobalString(PasswordFileFlag.Name)
	if path == "" {
		return nil
	}
	text, err := ioutil.ReadFile(path)
	if err != nil {
1118
		Fatalf("Failed to read password file: %v", err)
1119 1120 1121 1122 1123
	}
	lines := strings.Split(string(text), "\n")
	// Sanitise DOS line endings.
	for i := range lines {
		lines[i] = strings.TrimRight(lines[i], "\r")
1124
	}
1125
	return lines
1126 1127
}

1128 1129 1130 1131 1132 1133 1134
func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
	setNodeKey(ctx, cfg)
	setNAT(ctx, cfg)
	setListenAddress(ctx, cfg)
	setBootstrapNodes(ctx, cfg)
	setBootstrapNodesV5(ctx, cfg)

1135
	lightClient := ctx.GlobalString(SyncModeFlag.Name) == "light"
1136
	lightServer := (ctx.GlobalInt(LegacyLightServFlag.Name) != 0 || ctx.GlobalInt(LightServeFlag.Name) != 0)
1137

1138
	lightPeers := ctx.GlobalInt(LegacyLightPeersFlag.Name)
1139 1140 1141
	if ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
		lightPeers = ctx.GlobalInt(LightMaxPeersFlag.Name)
	}
1142
	if lightClient && !ctx.GlobalIsSet(LegacyLightPeersFlag.Name) && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
1143 1144 1145 1146
		// dynamic default - for clients we use 1/10th of the default for servers
		lightPeers /= 10
	}

1147 1148
	if ctx.GlobalIsSet(MaxPeersFlag.Name) {
		cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
1149
		if lightServer && !ctx.GlobalIsSet(LegacyLightPeersFlag.Name) && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
1150 1151
			cfg.MaxPeers += lightPeers
		}
1152 1153 1154 1155
	} else {
		if lightServer {
			cfg.MaxPeers += lightPeers
		}
1156
		if lightClient && (ctx.GlobalIsSet(LegacyLightPeersFlag.Name) || ctx.GlobalIsSet(LightMaxPeersFlag.Name)) && cfg.MaxPeers < lightPeers {
1157 1158
			cfg.MaxPeers = lightPeers
		}
1159
	}
1160 1161 1162 1163 1164 1165 1166 1167 1168
	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)

1169 1170 1171
	if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
		cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
	}
1172
	if ctx.GlobalIsSet(NoDiscoverFlag.Name) || lightClient {
1173
		cfg.NoDiscovery = true
1174 1175
	}

1176 1177 1178
	// 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
1179
	forceV5Discovery := (lightClient || lightServer) && !ctx.GlobalBool(NoDiscoverFlag.Name)
1180 1181 1182 1183
	if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
		cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
	} else if forceV5Discovery {
		cfg.DiscoveryV5 = true
1184
	}
1185

1186 1187 1188
	if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
		list, err := netutil.ParseNetlist(netrestrict)
		if err != nil {
1189
			Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
1190
		}
1191
		cfg.NetRestrict = list
1192 1193
	}

1194
	if ctx.GlobalBool(DeveloperFlag.Name) {
1195 1196 1197 1198 1199
		// --dev mode can't use p2p networking.
		cfg.MaxPeers = 0
		cfg.ListenAddr = ":0"
		cfg.NoDiscovery = true
		cfg.DiscoveryV5 = false
1200 1201 1202
	}
}

1203 1204 1205 1206 1207
// 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)
1208
	setGraphQL(ctx, cfg)
1209 1210
	setWS(ctx, cfg)
	setNodeUserIdent(ctx, cfg)
1211
	setDataDir(ctx, cfg)
1212
	setSmartCard(ctx, cfg)
1213

1214 1215 1216 1217
	if ctx.GlobalIsSet(ExternalSignerFlag.Name) {
		cfg.ExternalSigner = ctx.GlobalString(ExternalSignerFlag.Name)
	}

1218 1219 1220 1221 1222 1223
	if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
		cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
	}
	if ctx.GlobalIsSet(LightKDFFlag.Name) {
		cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
	}
1224 1225 1226
	if ctx.GlobalIsSet(NoUSBFlag.Name) {
		cfg.NoUSB = ctx.GlobalBool(NoUSBFlag.Name)
	}
1227 1228 1229
	if ctx.GlobalIsSet(InsecureUnlockAllowedFlag.Name) {
		cfg.InsecureUnlockAllowed = ctx.GlobalBool(InsecureUnlockAllowedFlag.Name)
	}
1230 1231
}

1232 1233 1234 1235 1236 1237 1238 1239 1240
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 {
1241
		log.Info("Smartcard socket not found, disabling", "err", err)
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
		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
}

1252 1253 1254 1255 1256 1257
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
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
	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")
		}
1268
	case ctx.GlobalBool(RinkebyFlag.Name) && cfg.DataDir == node.DefaultDataDir():
1269
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "rinkeby")
1270
	case ctx.GlobalBool(GoerliFlag.Name) && cfg.DataDir == node.DefaultDataDir():
1271
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "goerli")
1272 1273
	case ctx.GlobalBool(YoloV1Flag.Name) && cfg.DataDir == node.DefaultDataDir():
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "yolo-v1")
1274 1275 1276
	}
}

1277 1278 1279 1280 1281 1282 1283
func setGPO(ctx *cli.Context, cfg *gasprice.Config, light bool) {
	// If we are running the light client, apply another group
	// settings for gas oracle.
	if light {
		cfg.Blocks = eth.DefaultLightGPOConfig.Blocks
		cfg.Percentile = eth.DefaultLightGPOConfig.Percentile
	}
1284 1285 1286 1287
	if ctx.GlobalIsSet(LegacyGpoBlocksFlag.Name) {
		cfg.Blocks = ctx.GlobalInt(LegacyGpoBlocksFlag.Name)
		log.Warn("The flag --gpoblocks is deprecated and will be removed in the future, please use --gpo.blocks")
	}
1288 1289 1290
	if ctx.GlobalIsSet(GpoBlocksFlag.Name) {
		cfg.Blocks = ctx.GlobalInt(GpoBlocksFlag.Name)
	}
1291 1292 1293 1294
	if ctx.GlobalIsSet(LegacyGpoPercentileFlag.Name) {
		cfg.Percentile = ctx.GlobalInt(LegacyGpoPercentileFlag.Name)
		log.Warn("The flag --gpopercentile is deprecated and will be removed in the future, please use --gpo.percentile")
	}
1295 1296 1297
	if ctx.GlobalIsSet(GpoPercentileFlag.Name) {
		cfg.Percentile = ctx.GlobalInt(GpoPercentileFlag.Name)
	}
1298 1299 1300
	if ctx.GlobalIsSet(GpoMaxGasPriceFlag.Name) {
		cfg.MaxPrice = big.NewInt(ctx.GlobalInt64(GpoMaxGasPriceFlag.Name))
	}
1301 1302
}

1303
func setTxPool(ctx *cli.Context, cfg *core.TxPoolConfig) {
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	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))
			}
		}
	}
1314 1315 1316
	if ctx.GlobalIsSet(TxPoolNoLocalsFlag.Name) {
		cfg.NoLocals = ctx.GlobalBool(TxPoolNoLocalsFlag.Name)
	}
1317 1318 1319 1320 1321 1322
	if ctx.GlobalIsSet(TxPoolJournalFlag.Name) {
		cfg.Journal = ctx.GlobalString(TxPoolJournalFlag.Name)
	}
	if ctx.GlobalIsSet(TxPoolRejournalFlag.Name) {
		cfg.Rejournal = ctx.GlobalDuration(TxPoolRejournalFlag.Name)
	}
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
	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)
	}
}

1346 1347
func setEthash(ctx *cli.Context, cfg *eth.Config) {
	if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
1348
		cfg.Ethash.CacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
1349 1350
	}
	if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
1351
		cfg.Ethash.DatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
1352 1353
	}
	if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
1354
		cfg.Ethash.CachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
1355 1356
	}
	if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
1357
		cfg.Ethash.CachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
1358
	}
1359 1360 1361
	if ctx.GlobalIsSet(EthashCachesLockMmapFlag.Name) {
		cfg.Ethash.CachesLockMmap = ctx.GlobalBool(EthashCachesLockMmapFlag.Name)
	}
1362
	if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
1363
		cfg.Ethash.DatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
1364 1365
	}
	if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
1366
		cfg.Ethash.DatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
1367
	}
1368 1369 1370
	if ctx.GlobalIsSet(EthashDatasetsLockMmapFlag.Name) {
		cfg.Ethash.DatasetsLockMmap = ctx.GlobalBool(EthashDatasetsLockMmapFlag.Name)
	}
1371 1372
}

1373 1374 1375 1376
func setMiner(ctx *cli.Context, cfg *miner.Config) {
	if ctx.GlobalIsSet(MinerNotifyFlag.Name) {
		cfg.Notify = strings.Split(ctx.GlobalString(MinerNotifyFlag.Name), ",")
	}
1377 1378 1379
	if ctx.GlobalIsSet(LegacyMinerExtraDataFlag.Name) {
		cfg.ExtraData = []byte(ctx.GlobalString(LegacyMinerExtraDataFlag.Name))
		log.Warn("The flag --extradata is deprecated and will be removed in the future, please use --miner.extradata")
1380 1381 1382 1383
	}
	if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {
		cfg.ExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))
	}
1384 1385 1386
	if ctx.GlobalIsSet(LegacyMinerGasTargetFlag.Name) {
		cfg.GasFloor = ctx.GlobalUint64(LegacyMinerGasTargetFlag.Name)
		log.Warn("The flag --targetgaslimit is deprecated and will be removed in the future, please use --miner.gastarget")
1387 1388 1389 1390 1391 1392 1393
	}
	if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {
		cfg.GasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)
	}
	if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {
		cfg.GasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)
	}
1394 1395 1396
	if ctx.GlobalIsSet(LegacyMinerGasPriceFlag.Name) {
		cfg.GasPrice = GlobalBig(ctx, LegacyMinerGasPriceFlag.Name)
		log.Warn("The flag --gasprice is deprecated and will be removed in the future, please use --miner.gasprice")
1397 1398 1399 1400 1401
	}
	if ctx.GlobalIsSet(MinerGasPriceFlag.Name) {
		cfg.GasPrice = GlobalBig(ctx, MinerGasPriceFlag.Name)
	}
	if ctx.GlobalIsSet(MinerRecommitIntervalFlag.Name) {
1402
		cfg.Recommit = ctx.GlobalDuration(MinerRecommitIntervalFlag.Name)
1403 1404
	}
	if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
1405
		cfg.Noverify = ctx.GlobalBool(MinerNoVerfiyFlag.Name)
1406 1407 1408
	}
}

1409
func setWhitelist(ctx *cli.Context, cfg *eth.Config) {
1410 1411 1412 1413 1414 1415 1416 1417 1418
	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)
1419
		}
1420 1421 1422 1423 1424 1425 1426 1427 1428
		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
1429 1430 1431
	}
}

1432
// CheckExclusive verifies that only a single instance of the provided flags was
1433 1434
// set by the user. Each flag might optionally be followed by a string type to
// specialize it further.
1435
func CheckExclusive(ctx *cli.Context, args ...interface{}) {
1436
	set := make([]string, 0, 1)
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
	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:
1449
				// Extended flag check, make sure value set doesn't conflict with passed in option
1450 1451
				if ctx.GlobalString(flag.GetName()) == option {
					name += "=" + option
1452
					set = append(set, "--"+name)
1453
				}
1454
				// shift arguments and continue
1455
				i++
1456
				continue
1457 1458 1459 1460 1461 1462 1463

			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
1464
		if ctx.GlobalIsSet(flag.GetName()) {
1465
			set = append(set, "--"+name)
1466 1467
		}
	}
1468
	if len(set) > 1 {
1469
		Fatalf("Flags %v can't be used at the same time", strings.Join(set, ", "))
1470
	}
1471 1472
}

1473
// SetShhConfig applies shh-related command line flags to the config.
1474 1475 1476 1477 1478 1479
func SetShhConfig(ctx *cli.Context, stack *node.Node) {
	if ctx.GlobalIsSet(WhisperEnabledFlag.Name) ||
		ctx.GlobalIsSet(WhisperMaxMessageSizeFlag.Name) ||
		ctx.GlobalIsSet(WhisperMinPOWFlag.Name) ||
		ctx.GlobalIsSet(WhisperRestrictConnectionBetweenLightClientsFlag.Name) {
		log.Warn("Whisper support has been deprecated and the code has been moved to github.com/ethereum/whisper")
1480
	}
1481 1482
}

1483 1484 1485
// 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
1486
	CheckExclusive(ctx, DeveloperFlag, LegacyTestnetFlag, RopstenFlag, RinkebyFlag, GoerliFlag, YoloV1Flag)
1487
	CheckExclusive(ctx, LegacyLightServFlag, LightServeFlag, SyncModeFlag, "light")
1488
	CheckExclusive(ctx, DeveloperFlag, ExternalSignerFlag) // Can't use both ephemeral unlocked and external signer
1489 1490 1491 1492 1493
	CheckExclusive(ctx, GCModeFlag, "archive", TxLookupLimitFlag)
	// todo(rjl493456442) make it available for les server
	// Ancient tx indices pruning is not available for les server now
	// since light client relies on the server for transaction status query.
	CheckExclusive(ctx, LegacyLightServFlag, LightServeFlag, TxLookupLimitFlag)
1494 1495 1496 1497
	var ks *keystore.KeyStore
	if keystores := stack.AccountManager().Backends(keystore.KeyStoreType); len(keystores) > 0 {
		ks = keystores[0].(*keystore.KeyStore)
	}
1498
	setEtherbase(ctx, ks, cfg)
1499
	setGPO(ctx, &cfg.GPO, ctx.GlobalString(SyncModeFlag.Name) == "light")
1500
	setTxPool(ctx, &cfg.TxPool)
1501
	setEthash(ctx, cfg)
1502
	setMiner(ctx, &cfg.Miner)
1503
	setWhitelist(ctx, cfg)
1504
	setLes(ctx, cfg)
1505

1506
	if ctx.GlobalIsSet(SyncModeFlag.Name) {
1507 1508 1509
		cfg.SyncMode = *GlobalTextMarshaler(ctx, SyncModeFlag.Name).(*downloader.SyncMode)
	}
	if ctx.GlobalIsSet(NetworkIdFlag.Name) {
1510
		cfg.NetworkId = ctx.GlobalUint64(NetworkIdFlag.Name)
1511
	}
1512 1513
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheDatabaseFlag.Name) {
		cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1514 1515
	}
	cfg.DatabaseHandles = makeDatabaseHandles()
1516 1517 1518
	if ctx.GlobalIsSet(AncientFlag.Name) {
		cfg.DatabaseFreezer = ctx.GlobalString(AncientFlag.Name)
	}
1519

1520 1521 1522
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
1523 1524 1525 1526 1527 1528
	if ctx.GlobalIsSet(GCModeFlag.Name) {
		cfg.NoPruning = ctx.GlobalString(GCModeFlag.Name) == "archive"
	}
	if ctx.GlobalIsSet(CacheNoPrefetchFlag.Name) {
		cfg.NoPrefetch = ctx.GlobalBool(CacheNoPrefetchFlag.Name)
	}
1529 1530 1531
	if ctx.GlobalIsSet(TxLookupLimitFlag.Name) {
		cfg.TxLookupLimit = ctx.GlobalUint64(TxLookupLimitFlag.Name)
	}
1532 1533 1534
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
		cfg.TrieCleanCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
	}
1535 1536 1537 1538 1539 1540
	if ctx.GlobalIsSet(CacheTrieJournalFlag.Name) {
		cfg.TrieCleanCacheJournal = ctx.GlobalString(CacheTrieJournalFlag.Name)
	}
	if ctx.GlobalIsSet(CacheTrieRejournalFlag.Name) {
		cfg.TrieCleanCacheRejournal = ctx.GlobalDuration(CacheTrieRejournalFlag.Name)
	}
1541
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
1542
		cfg.TrieDirtyCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
1543
	}
1544 1545 1546
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheSnapshotFlag.Name) {
		cfg.SnapshotCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheSnapshotFlag.Name) / 100
	}
1547
	if !ctx.GlobalIsSet(SnapshotFlag.Name) {
1548
		cfg.TrieCleanCache += cfg.SnapshotCache
1549 1550
		cfg.SnapshotCache = 0 // Disabled
	}
1551 1552 1553 1554 1555 1556 1557
	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)
	}
1558

1559 1560 1561 1562 1563 1564 1565
	if ctx.GlobalIsSet(EWASMInterpreterFlag.Name) {
		cfg.EWASMInterpreter = ctx.GlobalString(EWASMInterpreterFlag.Name)
	}

	if ctx.GlobalIsSet(EVMInterpreterFlag.Name) {
		cfg.EVMInterpreter = ctx.GlobalString(EVMInterpreterFlag.Name)
	}
1566
	if ctx.GlobalIsSet(RPCGlobalGasCap.Name) {
1567 1568 1569 1570 1571 1572
		cfg.RPCGasCap = ctx.GlobalUint64(RPCGlobalGasCap.Name)
	}
	if cfg.RPCGasCap != 0 {
		log.Info("Set global gas cap", "cap", cfg.RPCGasCap)
	} else {
		log.Info("Global gas cap disabled")
1573
	}
1574 1575 1576
	if ctx.GlobalIsSet(RPCGlobalTxFeeCap.Name) {
		cfg.RPCTxFeeCap = ctx.GlobalFloat64(RPCGlobalTxFeeCap.Name)
	}
1577 1578 1579 1580 1581
	if ctx.GlobalIsSet(DNSDiscoveryFlag.Name) {
		urls := ctx.GlobalString(DNSDiscoveryFlag.Name)
		if urls == "" {
			cfg.DiscoveryURLs = []string{}
		} else {
1582
			cfg.DiscoveryURLs = SplitAndTrim(urls)
1583 1584
		}
	}
1585

1586
	// Override any default configs for hard coded networks.
1587
	switch {
1588
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
1589
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
1590
			cfg.NetworkId = 3
1591
		}
1592
		cfg.Genesis = core.DefaultRopstenGenesisBlock()
1593
		setDNSDiscoveryDefaults(cfg, params.RopstenGenesisHash)
1594 1595 1596 1597 1598
	case ctx.GlobalBool(RinkebyFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 4
		}
		cfg.Genesis = core.DefaultRinkebyGenesisBlock()
1599
		setDNSDiscoveryDefaults(cfg, params.RinkebyGenesisHash)
1600 1601 1602 1603 1604
	case ctx.GlobalBool(GoerliFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 5
		}
		cfg.Genesis = core.DefaultGoerliGenesisBlock()
1605
		setDNSDiscoveryDefaults(cfg, params.GoerliGenesisHash)
1606 1607 1608 1609 1610
	case ctx.GlobalBool(YoloV1Flag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 133519467574833 // "yolov1"
		}
		cfg.Genesis = core.DefaultYoloV1GenesisBlock()
1611
	case ctx.GlobalBool(DeveloperFlag.Name):
1612 1613 1614
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 1337
		}
1615 1616
		// Create new developer account or reuse existing one
		var (
1617 1618 1619
			developer  accounts.Account
			passphrase string
			err        error
1620
		)
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
		if list := MakePasswordList(ctx); len(list) > 0 {
			// Just take the first value. Although the function returns a possible multiple values and
			// some usages iterate through them as attempts, that doesn't make sense in this setting,
			// when we're definitely concerned with only one account.
			passphrase = list[0]
		}
		// setEtherbase has been called above, configuring the miner address from command line flags.
		if cfg.Miner.Etherbase != (common.Address{}) {
			developer = accounts.Account{Address: cfg.Miner.Etherbase}
		} else if accs := ks.Accounts(); len(accs) > 0 {
1631 1632
			developer = ks.Accounts()[0]
		} else {
1633
			developer, err = ks.NewAccount(passphrase)
1634 1635 1636 1637
			if err != nil {
				Fatalf("Failed to create developer account: %v", err)
			}
		}
1638
		if err := ks.Unlock(developer, passphrase); err != nil {
1639 1640 1641 1642
			Fatalf("Failed to unlock developer account: %v", err)
		}
		log.Info("Using developer account", "address", developer.Address)

1643
		// Create a new developer genesis block or reuse existing one
1644
		cfg.Genesis = core.DeveloperGenesisBlock(uint64(ctx.GlobalInt(DeveloperPeriodFlag.Name)), developer.Address)
1645 1646 1647 1648 1649 1650 1651 1652 1653
		if ctx.GlobalIsSet(DataDirFlag.Name) {
			// Check if we have an already initialized chain and fall back to
			// that if so. Otherwise we need to generate a new genesis spec.
			chaindb := MakeChainDatabase(ctx, stack)
			if rawdb.ReadCanonicalHash(chaindb, 0) != (common.Hash{}) {
				cfg.Genesis = nil // fallback to db content
			}
			chaindb.Close()
		}
1654
		if !ctx.GlobalIsSet(MinerGasPriceFlag.Name) && !ctx.GlobalIsSet(LegacyMinerGasPriceFlag.Name) {
1655
			cfg.Miner.GasPrice = big.NewInt(1)
1656
		}
1657 1658
	default:
		if cfg.NetworkId == 1 {
1659
			setDNSDiscoveryDefaults(cfg, params.MainnetGenesisHash)
1660 1661 1662 1663 1664 1665
		}
	}
}

// setDNSDiscoveryDefaults configures DNS discovery with the given URL if
// no URLs are set.
1666
func setDNSDiscoveryDefaults(cfg *eth.Config, genesis common.Hash) {
1667
	if cfg.DiscoveryURLs != nil {
1668 1669 1670
		return // already set through flags/config
	}

1671
	protocol := "all"
1672 1673 1674 1675 1676
	if cfg.SyncMode == downloader.LightSync {
		protocol = "les"
	}
	if url := params.KnownDNSNetwork(genesis, protocol); url != "" {
		cfg.DiscoveryURLs = []string{url}
1677
	}
1678
}
1679

1680
// RegisterEthService adds an Ethereum client to the stack.
1681
func RegisterEthService(stack *node.Node, cfg *eth.Config) ethapi.Backend {
1682
	if cfg.SyncMode == downloader.LightSync {
1683 1684 1685 1686 1687
		backend, err := les.New(stack, cfg)
		if err != nil {
			Fatalf("Failed to register the Ethereum service: %v", err)
		}
		return backend.ApiBackend
1688
	} else {
1689 1690 1691 1692 1693 1694 1695 1696
		backend, err := eth.New(stack, cfg)
		if err != nil {
			Fatalf("Failed to register the Ethereum service: %v", err)
		}
		if cfg.LightServ > 0 {
			_, err := les.NewLesServer(stack, backend, cfg)
			if err != nil {
				Fatalf("Failed to create the LES server: %v", err)
1697
			}
1698 1699
		}
		return backend.APIBackend
1700
	}
1701 1702
}

1703
// RegisterEthStatsService configures the Ethereum Stats daemon and adds it to
1704
// the given node.
1705 1706
func RegisterEthStatsService(stack *node.Node, backend ethapi.Backend, url string) {
	if err := ethstats.New(stack, backend, backend.Engine(), url); err != nil {
1707
		Fatalf("Failed to register the Ethereum Stats service: %v", err)
1708 1709 1710
	}
}

1711
// RegisterGraphQLService is a utility function to construct a new service and register it against a node.
1712 1713
func RegisterGraphQLService(stack *node.Node, backend ethapi.Backend, cfg node.Config) {
	if err := graphql.New(stack, backend, cfg.GraphQLCors, cfg.GraphQLVirtualHosts); err != nil {
1714 1715 1716 1717
		Fatalf("Failed to register the GraphQL service: %v", err)
	}
}

1718 1719 1720
func SetupMetrics(ctx *cli.Context) {
	if metrics.Enabled {
		log.Info("Enabling metrics collection")
1721

1722 1723 1724 1725 1726 1727 1728 1729 1730
		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 {
1731 1732
			tagsMap := SplitTagsFlag(ctx.GlobalString(MetricsInfluxDBTagsFlag.Name))

1733
			log.Info("Enabling metrics export to InfluxDB")
1734 1735 1736

			go influxdb.InfluxDBWithTags(metrics.DefaultRegistry, 10*time.Second, endpoint, database, username, password, "geth.", tagsMap)
		}
1737 1738 1739 1740 1741 1742

		if ctx.GlobalIsSet(MetricsHTTPFlag.Name) {
			address := fmt.Sprintf("%s:%d", ctx.GlobalString(MetricsHTTPFlag.Name), ctx.GlobalInt(MetricsPortFlag.Name))
			log.Info("Enabling stand-alone metrics HTTP endpoint", "address", address)
			exp.Setup(address)
		}
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
	}
}

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]
			}
1757 1758
		}
	}
1759 1760

	return tagsMap
1761 1762
}

1763
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
1764
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
1765
	var (
1766
		cache   = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1767
		handles = makeDatabaseHandles()
1768 1769 1770

		err     error
		chainDb ethdb.Database
1771
	)
1772
	if ctx.GlobalString(SyncModeFlag.Name) == "light" {
1773 1774 1775 1776 1777
		name := "lightchaindata"
		chainDb, err = stack.OpenDatabase(name, cache, handles, "")
	} else {
		name := "chaindata"
		chainDb, err = stack.OpenDatabaseWithFreezer(name, cache, handles, ctx.GlobalString(AncientFlag.Name), "")
1778
	}
1779
	if err != nil {
1780
		Fatalf("Could not open database: %v", err)
1781
	}
1782 1783 1784
	return chainDb
}

1785 1786 1787
func MakeGenesis(ctx *cli.Context) *core.Genesis {
	var genesis *core.Genesis
	switch {
1788 1789
	case ctx.GlobalBool(LegacyTestnetFlag.Name) || ctx.GlobalBool(RopstenFlag.Name):
		genesis = core.DefaultRopstenGenesisBlock()
1790 1791
	case ctx.GlobalBool(RinkebyFlag.Name):
		genesis = core.DefaultRinkebyGenesisBlock()
1792 1793
	case ctx.GlobalBool(GoerliFlag.Name):
		genesis = core.DefaultGoerliGenesisBlock()
1794 1795
	case ctx.GlobalBool(YoloV1Flag.Name):
		genesis = core.DefaultYoloV1GenesisBlock()
1796 1797
	case ctx.GlobalBool(DeveloperFlag.Name):
		Fatalf("Developer chains are ephemeral")
1798 1799 1800 1801
	}
	return genesis
}

1802
// MakeChain creates a chain manager from set command line flags.
1803
func MakeChain(ctx *cli.Context, stack *node.Node, readOnly bool) (chain *core.BlockChain, chainDb ethdb.Database) {
1804
	var err error
1805
	chainDb = MakeChainDatabase(ctx, stack)
1806 1807 1808 1809
	config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
	if err != nil {
		Fatalf("%v", err)
	}
1810 1811 1812 1813 1814 1815
	var engine consensus.Engine
	if config.Clique != nil {
		engine = clique.New(config.Clique, chainDb)
	} else {
		engine = ethash.NewFaker()
		if !ctx.GlobalBool(FakePoWFlag.Name) {
1816
			engine = ethash.New(ethash.Config{
1817 1818 1819 1820 1821 1822 1823 1824
				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,
1825
			}, nil, false)
1826 1827
		}
	}
1828 1829 1830 1831
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
	cache := &core.CacheConfig{
1832 1833 1834 1835 1836
		TrieCleanLimit:      eth.DefaultConfig.TrieCleanCache,
		TrieCleanNoPrefetch: ctx.GlobalBool(CacheNoPrefetchFlag.Name),
		TrieDirtyLimit:      eth.DefaultConfig.TrieDirtyCache,
		TrieDirtyDisabled:   ctx.GlobalString(GCModeFlag.Name) == "archive",
		TrieTimeLimit:       eth.DefaultConfig.TrieTimeout,
1837
		SnapshotLimit:       eth.DefaultConfig.SnapshotCache,
1838
	}
1839 1840 1841
	if !ctx.GlobalIsSet(SnapshotFlag.Name) {
		cache.SnapshotLimit = 0 // Disabled
	}
1842 1843
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
		cache.TrieCleanLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
1844 1845
	}
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
1846
		cache.TrieDirtyLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
1847
	}
1848
	vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
1849 1850 1851 1852 1853 1854
	var limit *uint64
	if ctx.GlobalIsSet(TxLookupLimitFlag.Name) && !readOnly {
		l := ctx.GlobalUint64(TxLookupLimitFlag.Name)
		limit = &l
	}
	chain, err = core.NewBlockChain(chainDb, cache, config, engine, vmcfg, nil, limit)
obscuren's avatar
obscuren committed
1855
	if err != nil {
1856
		Fatalf("Can't create BlockChain: %v", err)
obscuren's avatar
obscuren committed
1857
	}
1858
	return chain, chainDb
1859
}
1860 1861 1862 1863 1864 1865 1866 1867 1868

// 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
1869
	var preloads []string
1870 1871 1872 1873 1874 1875 1876

	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
}
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900

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