flags.go 42.1 KB
Newer Older
F
Felix Lange 已提交
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
F
Felix Lange 已提交
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/>.
F
Felix Lange 已提交
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/ioutil"
24
	"math/big"
25
	"os"
26
	"path/filepath"
27
	"runtime"
28
	"strconv"
29
	"strings"
30

F
Felix Lange 已提交
31
	"github.com/ethereum/go-ethereum/accounts"
32
	"github.com/ethereum/go-ethereum/accounts/keystore"
Z
zelig 已提交
33
	"github.com/ethereum/go-ethereum/common"
34
	"github.com/ethereum/go-ethereum/common/fdlimit"
35 36
	"github.com/ethereum/go-ethereum/consensus"
	"github.com/ethereum/go-ethereum/consensus/clique"
37
	"github.com/ethereum/go-ethereum/consensus/ethash"
38
	"github.com/ethereum/go-ethereum/core"
39
	"github.com/ethereum/go-ethereum/core/state"
40
	"github.com/ethereum/go-ethereum/core/vm"
41
	"github.com/ethereum/go-ethereum/crypto"
42
	"github.com/ethereum/go-ethereum/dashboard"
43
	"github.com/ethereum/go-ethereum/eth"
44 45
	"github.com/ethereum/go-ethereum/eth/downloader"
	"github.com/ethereum/go-ethereum/eth/gasprice"
46
	"github.com/ethereum/go-ethereum/ethdb"
47
	"github.com/ethereum/go-ethereum/ethstats"
48
	"github.com/ethereum/go-ethereum/les"
49
	"github.com/ethereum/go-ethereum/log"
B
Bas van Kervel 已提交
50
	"github.com/ethereum/go-ethereum/metrics"
51
	"github.com/ethereum/go-ethereum/node"
52
	"github.com/ethereum/go-ethereum/p2p"
53
	"github.com/ethereum/go-ethereum/p2p/discover"
54
	"github.com/ethereum/go-ethereum/p2p/discv5"
55
	"github.com/ethereum/go-ethereum/p2p/nat"
56
	"github.com/ethereum/go-ethereum/p2p/netutil"
57
	"github.com/ethereum/go-ethereum/params"
58
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv5"
59
	"gopkg.in/urfave/cli.v1"
60 61
)

62 63 64 65 66 67 68 69 70 71 72 73 74
var (
	CommandHelpTemplate = `{{.cmd.Name}}{{if .cmd.Subcommands}} command{{end}}{{if .cmd.Flags}} [command options]{{end}} [arguments...]
{{if .cmd.Description}}{{.cmd.Description}}
{{end}}{{if .cmd.Subcommands}}
SUBCOMMANDS:
	{{range .cmd.Subcommands}}{{.cmd.Name}}{{with .cmd.ShortName}}, {{.cmd}}{{end}}{{ "\t" }}{{.cmd.Usage}}
	{{end}}{{end}}{{if .categorizedFlags}}
{{range $idx, $categorized := .categorizedFlags}}{{$categorized.Name}} OPTIONS:
{{range $categorized.Flags}}{{"\t"}}{{.}}
{{end}}
{{end}}{{end}}`
)

75 76 77 78 79 80 81 82 83 84 85 86 87 88
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}}
`

89
	cli.CommandHelpTemplate = CommandHelpTemplate
90 91
}

F
Felix Lange 已提交
92
// NewApp creates an app with sane defaults.
93
func NewApp(gitCommit, usage string) *cli.App {
F
Felix Lange 已提交
94
	app := cli.NewApp()
95
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
96
	app.Author = ""
O
obscuren 已提交
97
	//app.Authors = nil
F
Felix Lange 已提交
98
	app.Email = ""
99
	app.Version = params.Version
100
	if len(gitCommit) >= 8 {
101 102
		app.Version += "-" + gitCommit[:8]
	}
F
Felix Lange 已提交
103 104 105 106
	app.Usage = usage
	return app
}

107 108 109 110 111 112 113 114 115
// 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
116
	DataDirFlag = DirectoryFlag{
117
		Name:  "datadir",
118
		Usage: "Data directory for the databases and keystore",
119
		Value: DirectoryString{node.DefaultDataDir()},
120
	}
K
Kobi Gurkan 已提交
121 122 123 124
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
125 126
	NoUSBFlag = cli.BoolFlag{
		Name:  "nousb",
O
Oli Bye 已提交
127
		Usage: "Disables monitoring for and managing USB hardware wallets",
128
	}
129
	NetworkIdFlag = cli.Uint64Flag{
Z
zelig 已提交
130
		Name:  "networkid",
131
		Usage: "Network identifier (integer, 1=Frontier, 2=Morden (disused), 3=Ropsten, 4=Rinkeby)",
132
		Value: eth.DefaultConfig.NetworkId,
Z
zelig 已提交
133
	}
134
	TestnetFlag = cli.BoolFlag{
135
		Name:  "testnet",
136
		Usage: "Ropsten network: pre-configured proof-of-work test network",
137
	}
138 139 140 141
	RinkebyFlag = cli.BoolFlag{
		Name:  "rinkeby",
		Usage: "Rinkeby network: pre-configured proof-of-authority test network",
	}
142
	DeveloperFlag = cli.BoolFlag{
143
		Name:  "dev",
144 145 146 147 148
		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)",
149
	}
150 151
	IdentityFlag = cli.StringFlag{
		Name:  "identity",
152
		Usage: "Custom node name",
153
	}
Z
zelig 已提交
154 155 156
	DocRootFlag = DirectoryFlag{
		Name:  "docroot",
		Usage: "Document Root for HTTPClient file scheme",
157
		Value: DirectoryString{homeDir()},
Z
zelig 已提交
158
	}
159 160
	FastSyncFlag = cli.BoolFlag{
		Name:  "fast",
161
		Usage: "Enable fast syncing through state downloads",
162
	}
163 164 165 166
	LightModeFlag = cli.BoolFlag{
		Name:  "light",
		Usage: "Enable light client mode",
	}
167 168 169 170 171 172
	defaultSyncMode = eth.DefaultConfig.SyncMode
	SyncModeFlag    = TextMarshalerFlag{
		Name:  "syncmode",
		Usage: `Blockchain sync mode ("fast", "full", or "light")`,
		Value: &defaultSyncMode,
	}
173 174 175 176 177
	GCModeFlag = cli.StringFlag{
		Name:  "gcmode",
		Usage: `Blockchain garbage collection mode ("full", "archive")`,
		Value: "full",
	}
178 179 180 181 182 183 184 185
	LightServFlag = cli.IntFlag{
		Name:  "lightserv",
		Usage: "Maximum percentage of time allowed for serving LES requests (0-90)",
		Value: 0,
	}
	LightPeersFlag = cli.IntFlag{
		Name:  "lightpeers",
		Usage: "Maximum number of LES client peers",
186
		Value: eth.DefaultConfig.LightPeers,
187
	}
188 189
	LightKDFFlag = cli.BoolFlag{
		Name:  "lightkdf",
190
		Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
191
	}
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
	// Dashboard settings
	DashboardEnabledFlag = cli.BoolFlag{
		Name:  "dashboard",
		Usage: "Enable the dashboard",
	}
	DashboardAddrFlag = cli.StringFlag{
		Name:  "dashboard.addr",
		Usage: "Dashboard listening interface",
		Value: dashboard.DefaultConfig.Host,
	}
	DashboardPortFlag = cli.IntFlag{
		Name:  "dashboard.host",
		Usage: "Dashboard listening port",
		Value: dashboard.DefaultConfig.Port,
	}
	DashboardRefreshFlag = cli.DurationFlag{
		Name:  "dashboard.refresh",
		Usage: "Dashboard metrics collection refresh rate",
		Value: dashboard.DefaultConfig.Refresh,
	}
212 213 214 215 216 217 218 219
	// 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)",
220
		Value: eth.DefaultConfig.Ethash.CachesInMem,
221 222 223 224
	}
	EthashCachesOnDiskFlag = cli.IntFlag{
		Name:  "ethash.cachesondisk",
		Usage: "Number of recent ethash caches to keep on disk (16MB each)",
225
		Value: eth.DefaultConfig.Ethash.CachesOnDisk,
226 227 228 229
	}
	EthashDatasetDirFlag = DirectoryFlag{
		Name:  "ethash.dagdir",
		Usage: "Directory to store the ethash mining DAGs (default = inside home folder)",
230
		Value: DirectoryString{eth.DefaultConfig.Ethash.DatasetDir},
231 232 233 234
	}
	EthashDatasetsInMemoryFlag = cli.IntFlag{
		Name:  "ethash.dagsinmem",
		Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
235
		Value: eth.DefaultConfig.Ethash.DatasetsInMem,
236 237 238 239
	}
	EthashDatasetsOnDiskFlag = cli.IntFlag{
		Name:  "ethash.dagsondisk",
		Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
240
		Value: eth.DefaultConfig.Ethash.DatasetsOnDisk,
241 242
	}
	// Transaction pool settings
243 244 245 246
	TxPoolNoLocalsFlag = cli.BoolFlag{
		Name:  "txpool.nolocals",
		Usage: "Disables price exemptions for locally submitted transactions",
	}
247 248 249 250 251 252 253 254 255 256
	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,
	}
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
	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,
	}
292 293 294
	// Performance tuning settings
	CacheFlag = cli.IntFlag{
		Name:  "cache",
295 296 297 298 299 300 301 302 303 304 305 306
		Usage: "Megabytes of memory allocated to internal caching",
		Value: 1024,
	}
	CacheDatabaseFlag = cli.IntFlag{
		Name:  "cache.database",
		Usage: "Percentage of cache memory allowance to use for database io",
		Value: 75,
	}
	CacheGCFlag = cli.IntFlag{
		Name:  "cache.gc",
		Usage: "Percentage of cache memory allowance to use for trie pruning",
		Value: 25,
307 308 309 310 311 312
	}
	TrieCacheGenFlag = cli.IntFlag{
		Name:  "trie-cache-gens",
		Usage: "Number of trie node generations to keep in memory",
		Value: int(state.MaxTrieCacheGen),
	}
313 314 315 316
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
317
	}
318 319
	MinerThreadsFlag = cli.IntFlag{
		Name:  "minerthreads",
320
		Usage: "Number of CPU threads to use for mining",
321 322
		Value: runtime.NumCPU(),
	}
323
	TargetGasLimitFlag = cli.Uint64Flag{
324 325
		Name:  "targetgaslimit",
		Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine",
326
		Value: params.GenesisGasLimit,
327
	}
Z
zelig 已提交
328
	EtherbaseFlag = cli.StringFlag{
O
obscuren 已提交
329
		Name:  "etherbase",
330
		Usage: "Public address for block mining rewards (default = first account created)",
331
		Value: "0",
Z
zelig 已提交
332
	}
333
	GasPriceFlag = BigFlag{
334
		Name:  "gasprice",
335
		Usage: "Minimal gas price to accept for mining a transactions",
336
		Value: eth.DefaultConfig.GasPrice,
337
	}
Z
zelig 已提交
338 339
	ExtraDataFlag = cli.StringFlag{
		Name:  "extradata",
340
		Usage: "Block extra data set by the miner (default = client version)",
Z
zelig 已提交
341
	}
342
	// Account settings
Z
zelig 已提交
343 344
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
345
		Usage: "Comma separated list of accounts to unlock",
Z
zelig 已提交
346 347 348 349
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
A
ayeowch 已提交
350
		Usage: "Password file to use for non-interactive password input",
Z
zelig 已提交
351
		Value: "",
Z
zelig 已提交
352
	}
353

354 355 356 357
	VMEnableDebugFlag = cli.BoolFlag{
		Name:  "vmdebug",
		Usage: "Record information useful for VM and contract debugging",
	}
358 359 360 361 362
	// Logging and debug settings
	EthStatsURLFlag = cli.StringFlag{
		Name:  "ethstats",
		Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
	}
363 364
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
365
		Usage: "Enable metrics collection and reporting",
366
	}
367 368 369 370
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
371 372 373 374
	NoCompactionFlag = cli.BoolFlag{
		Name:  "nocompaction",
		Usage: "Disables db compaction after import",
	}
375 376 377
	// RPC settings
	RPCEnabledFlag = cli.BoolFlag{
		Name:  "rpc",
378
		Usage: "Enable the HTTP-RPC server",
379 380 381
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
382
		Usage: "HTTP-RPC server listening interface",
383
		Value: node.DefaultHTTPHost,
384 385 386
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
387
		Usage: "HTTP-RPC server listening port",
388
		Value: node.DefaultHTTPPort,
389
	}
390 391
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
392
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
393 394
		Value: "",
	}
395 396 397
	RPCVirtualHostsFlag = cli.StringFlag{
		Name:  "rpcvhosts",
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
398
		Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
399
	}
400
	RPCApiFlag = cli.StringFlag{
401
		Name:  "rpcapi",
402
		Usage: "API's offered over the HTTP-RPC interface",
403
		Value: "",
404
	}
B
Bas van Kervel 已提交
405 406 407 408 409 410
	IPCDisabledFlag = cli.BoolFlag{
		Name:  "ipcdisable",
		Usage: "Disable the IPC-RPC server",
	}
	IPCPathFlag = DirectoryFlag{
		Name:  "ipcpath",
411
		Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
B
Bas van Kervel 已提交
412
	}
413
	WSEnabledFlag = cli.BoolFlag{
414
		Name:  "ws",
415 416 417 418 419
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
420
		Value: node.DefaultWSHost,
421 422 423 424
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
425
		Value: node.DefaultWSPort,
426 427 428 429
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
430
		Value: "",
431
	}
B
Bas van Kervel 已提交
432 433 434
	WSAllowedOriginsFlag = cli.StringFlag{
		Name:  "wsorigins",
		Usage: "Origins from which to accept websockets requests",
435
		Value: "",
436
	}
437 438
	ExecFlag = cli.StringFlag{
		Name:  "exec",
439
		Usage: "Execute JavaScript statement",
440
	}
441
	PreloadJSFlag = cli.StringFlag{
442 443 444
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}
445

446 447 448
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
449
		Usage: "Maximum number of network peers (network disabled if set to 0)",
450
		Value: 25,
451
	}
452 453 454 455 456
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
457 458 459 460 461
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
462
	BootnodesFlag = cli.StringFlag{
463
		Name:  "bootnodes",
464 465 466 467 468 469 470 471 472 473 474
		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)",
475
		Value: "",
476 477 478 479 480 481 482 483 484 485 486
	}
	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",
487
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
488 489
		Value: "any",
	}
490 491 492 493
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
494 495 496 497
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
498 499 500 501 502
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}

503
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
504 505
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
506
		Usage: "JavaScript root path for `loadScript`",
Z
CLI:  
zelig 已提交
507 508
		Value: ".",
	}
509 510

	// Gas price oracle settings
511 512 513
	GpoBlocksFlag = cli.IntFlag{
		Name:  "gpoblocks",
		Usage: "Number of recent blocks to check for gas prices",
514
		Value: eth.DefaultConfig.GPO.Blocks,
Z
zsfelfoldi 已提交
515
	}
516 517 518
	GpoPercentileFlag = cli.IntFlag{
		Name:  "gpopercentile",
		Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
519
		Value: eth.DefaultConfig.GPO.Percentile,
Z
zsfelfoldi 已提交
520
	}
521 522 523 524 525 526 527 528 529 530 531 532 533 534
	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,
	}
535 536
)

537
// MakeDataDir retrieves the currently requested data directory, terminating
538 539
// if none (or the empty string) is specified. If the node is starting a testnet,
// the a subdirectory of the specified datadir will be used.
540
func MakeDataDir(ctx *cli.Context) string {
541
	if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
542
		if ctx.GlobalBool(TestnetFlag.Name) {
543
			return filepath.Join(path, "testnet")
544
		}
545 546 547
		if ctx.GlobalBool(RinkebyFlag.Name) {
			return filepath.Join(path, "rinkeby")
		}
548
		return path
549
	}
550
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
551
	return ""
552 553
}

554
// setNodeKey creates a node key from set command line flags, either loading it
555 556
// 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.
557
func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
558 559 560
	var (
		hex  = ctx.GlobalString(NodeKeyHexFlag.Name)
		file = ctx.GlobalString(NodeKeyFileFlag.Name)
561 562
		key  *ecdsa.PrivateKey
		err  error
563
	)
564 565
	switch {
	case file != "" && hex != "":
566
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
567 568
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
569
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
570
		}
571
		cfg.PrivateKey = key
572 573
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
574
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
575
		}
576
		cfg.PrivateKey = key
577 578 579
	}
}

580 581
// setNodeUserIdent creates the user identifier from CLI flags.
func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
582
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
583
		cfg.UserIdent = identity
584 585 586
	}
}

587
// setBootstrapNodes creates a list of bootstrap nodes from the command line
588
// flags, reverting to pre-configured ones if none have been specified.
589
func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
590
	urls := params.MainnetBootnodes
591
	switch {
592 593 594 595 596 597
	case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV4Flag.Name):
		if ctx.GlobalIsSet(BootnodesV4Flag.Name) {
			urls = strings.Split(ctx.GlobalString(BootnodesV4Flag.Name), ",")
		} else {
			urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
		}
598
	case ctx.GlobalBool(TestnetFlag.Name):
599
		urls = params.TestnetBootnodes
600 601
	case ctx.GlobalBool(RinkebyFlag.Name):
		urls = params.RinkebyBootnodes
602 603
	case cfg.BootstrapNodes != nil:
		return // already set, don't apply defaults.
604 605
	}

606
	cfg.BootstrapNodes = make([]*discover.Node, 0, len(urls))
607
	for _, url := range urls {
608 609
		node, err := discover.ParseNode(url)
		if err != nil {
P
Péter Szilágyi 已提交
610
			log.Error("Bootstrap URL invalid", "enode", url, "err", err)
611 612
			continue
		}
613
		cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
614 615 616
	}
}

617
// setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
618
// flags, reverting to pre-configured ones if none have been specified.
619
func setBootstrapNodesV5(ctx *cli.Context, cfg *p2p.Config) {
620
	urls := params.DiscoveryV5Bootnodes
621
	switch {
622 623 624 625 626 627
	case ctx.GlobalIsSet(BootnodesFlag.Name) || ctx.GlobalIsSet(BootnodesV5Flag.Name):
		if ctx.GlobalIsSet(BootnodesV5Flag.Name) {
			urls = strings.Split(ctx.GlobalString(BootnodesV5Flag.Name), ",")
		} else {
			urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
		}
628
	case ctx.GlobalBool(RinkebyFlag.Name):
629
		urls = params.RinkebyBootnodes
630
	case cfg.BootstrapNodesV5 != nil:
631
		return // already set, don't apply defaults.
632 633
	}

634
	cfg.BootstrapNodesV5 = make([]*discv5.Node, 0, len(urls))
635
	for _, url := range urls {
636 637
		node, err := discv5.ParseNode(url)
		if err != nil {
P
Péter Szilágyi 已提交
638
			log.Error("Bootstrap URL invalid", "enode", url, "err", err)
639 640
			continue
		}
641
		cfg.BootstrapNodesV5 = append(cfg.BootstrapNodesV5, node)
642 643 644
	}
}

645
// setListenAddress creates a TCP listening address string from set command
646
// line flags.
647 648 649 650
func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
	if ctx.GlobalIsSet(ListenPortFlag.Name) {
		cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
	}
651 652
}

653 654 655 656 657 658 659 660
// 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
661 662 663
	}
}

664 665 666
// splitAndTrim splits input separated by a comma
// and trims excessive white space from the substrings.
func splitAndTrim(input string) []string {
667 668 669 670 671 672 673
	result := strings.Split(input, ",")
	for i, r := range result {
		result[i] = strings.TrimSpace(r)
	}
	return result
}

674
// setHTTP creates the HTTP RPC listener interface string from the set
675
// command line flags, returning empty if the HTTP endpoint is disabled.
676 677 678 679 680 681 682 683 684 685 686 687
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) {
688
		cfg.HTTPCors = splitAndTrim(ctx.GlobalString(RPCCORSDomainFlag.Name))
689 690
	}
	if ctx.GlobalIsSet(RPCApiFlag.Name) {
691
		cfg.HTTPModules = splitAndTrim(ctx.GlobalString(RPCApiFlag.Name))
692
	}
693 694 695
	if ctx.GlobalIsSet(RPCVirtualHostsFlag.Name) {
		cfg.HTTPVirtualHosts = splitAndTrim(ctx.GlobalString(RPCVirtualHostsFlag.Name))
	}
696 697
}

698
// setWS creates the WebSocket RPC listener interface string from the set
699
// command line flags, returning empty if the HTTP endpoint is disabled.
700 701 702 703 704 705 706 707 708 709 710 711
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) {
712
		cfg.WSOrigins = splitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
713 714
	}
	if ctx.GlobalIsSet(WSApiFlag.Name) {
715
		cfg.WSModules = splitAndTrim(ctx.GlobalString(WSApiFlag.Name))
716 717 718 719 720 721 722 723 724 725 726 727
	}
}

// setIPC creates an IPC path configuration from the set command line flags,
// returning an empty string if IPC was explicitly disabled, or the set path.
func setIPC(ctx *cli.Context, cfg *node.Config) {
	checkExclusive(ctx, IPCDisabledFlag, IPCPathFlag)
	switch {
	case ctx.GlobalBool(IPCDisabledFlag.Name):
		cfg.IPCPath = ""
	case ctx.GlobalIsSet(IPCPathFlag.Name):
		cfg.IPCPath = ctx.GlobalString(IPCPathFlag.Name)
728 729 730
	}
}

731
// makeDatabaseHandles raises out the number of allowed file handles per process
732
// for Geth and returns half of the allowance to assign to the database.
733
func makeDatabaseHandles() int {
734
	limit, err := fdlimit.Current()
735
	if err != nil {
736
		Fatalf("Failed to retrieve file descriptor allowance: %v", err)
737
	}
738 739 740 741 742
	if limit < 2048 {
		if err := fdlimit.Raise(2048); err != nil {
			Fatalf("Failed to raise file descriptor allowance: %v", err)
		}
	}
743 744 745 746 747 748
	if limit > 2048 { // cap database file descriptors even if more is available
		limit = 2048
	}
	return limit / 2 // Leave half for networking and other stuff
}

749 750
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
751
func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
752 753
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
754
		return accounts.Account{Address: common.HexToAddress(account)}, nil
755 756 757
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
758
	if err != nil || index < 0 {
F
Felix Lange 已提交
759
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
760
	}
761 762 763 764 765 766
	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("-------------------------------------------------------------------")

767 768 769 770 771
	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
772 773
}

774
// setEtherbase retrieves the etherbase either from the directly specified
775
// command line flags or from the keystore if CLI indexed.
776 777 778 779 780 781 782
func setEtherbase(ctx *cli.Context, ks *keystore.KeyStore, cfg *eth.Config) {
	if ctx.GlobalIsSet(EtherbaseFlag.Name) {
		account, err := MakeAddress(ks, ctx.GlobalString(EtherbaseFlag.Name))
		if err != nil {
			Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
		}
		cfg.Etherbase = account.Address
783
	}
784 785
}

786
// MakePasswordList reads password lines from the file specified by the global --password flag.
787
func MakePasswordList(ctx *cli.Context) []string {
788 789 790 791 792 793
	path := ctx.GlobalString(PasswordFileFlag.Name)
	if path == "" {
		return nil
	}
	text, err := ioutil.ReadFile(path)
	if err != nil {
794
		Fatalf("Failed to read password file: %v", err)
795 796 797 798 799
	}
	lines := strings.Split(string(text), "\n")
	// Sanitise DOS line endings.
	for i := range lines {
		lines[i] = strings.TrimRight(lines[i], "\r")
800
	}
801
	return lines
802 803
}

804 805 806 807 808 809 810
func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
	setNodeKey(ctx, cfg)
	setNAT(ctx, cfg)
	setListenAddress(ctx, cfg)
	setBootstrapNodes(ctx, cfg)
	setBootstrapNodesV5(ctx, cfg)

811 812 813 814
	lightClient := ctx.GlobalBool(LightModeFlag.Name) || ctx.GlobalString(SyncModeFlag.Name) == "light"
	lightServer := ctx.GlobalInt(LightServFlag.Name) != 0
	lightPeers := ctx.GlobalInt(LightPeersFlag.Name)

815 816
	if ctx.GlobalIsSet(MaxPeersFlag.Name) {
		cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
817 818 819
		if lightServer && !ctx.GlobalIsSet(LightPeersFlag.Name) {
			cfg.MaxPeers += lightPeers
		}
820 821 822 823 824 825 826
	} else {
		if lightServer {
			cfg.MaxPeers += lightPeers
		}
		if lightClient && ctx.GlobalIsSet(LightPeersFlag.Name) && cfg.MaxPeers < lightPeers {
			cfg.MaxPeers = lightPeers
		}
827
	}
828 829 830 831 832 833 834 835 836
	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)

837 838 839
	if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
		cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
	}
840
	if ctx.GlobalIsSet(NoDiscoverFlag.Name) || lightClient {
841
		cfg.NoDiscovery = true
842 843
	}

844 845 846
	// 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
847
	forceV5Discovery := (lightClient || lightServer) && !ctx.GlobalBool(NoDiscoverFlag.Name)
848 849 850 851
	if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
		cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
	} else if forceV5Discovery {
		cfg.DiscoveryV5 = true
852
	}
853

854 855 856
	if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
		list, err := netutil.ParseNetlist(netrestrict)
		if err != nil {
857
			Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
858
		}
859
		cfg.NetRestrict = list
860 861
	}

862
	if ctx.GlobalBool(DeveloperFlag.Name) {
863 864 865 866 867
		// --dev mode can't use p2p networking.
		cfg.MaxPeers = 0
		cfg.ListenAddr = ":0"
		cfg.NoDiscovery = true
		cfg.DiscoveryV5 = false
868 869 870
	}
}

871 872 873 874 875 876 877 878 879 880 881
// SetNodeConfig applies node-related command line flags to the config.
func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
	SetP2PConfig(ctx, &cfg.P2P)
	setIPC(ctx, cfg)
	setHTTP(ctx, cfg)
	setWS(ctx, cfg)
	setNodeUserIdent(ctx, cfg)

	switch {
	case ctx.GlobalIsSet(DataDirFlag.Name):
		cfg.DataDir = ctx.GlobalString(DataDirFlag.Name)
882 883
	case ctx.GlobalBool(DeveloperFlag.Name):
		cfg.DataDir = "" // unless explicitly requested, use memory databases
884
	case ctx.GlobalBool(TestnetFlag.Name):
885
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "testnet")
886 887
	case ctx.GlobalBool(RinkebyFlag.Name):
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "rinkeby")
888 889 890 891 892 893 894 895
	}

	if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
		cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
	}
	if ctx.GlobalIsSet(LightKDFFlag.Name) {
		cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
	}
896 897 898
	if ctx.GlobalIsSet(NoUSBFlag.Name) {
		cfg.NoUSB = ctx.GlobalBool(NoUSBFlag.Name)
	}
899 900 901 902 903 904 905 906 907 908 909
}

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

910
func setTxPool(ctx *cli.Context, cfg *core.TxPoolConfig) {
911 912 913
	if ctx.GlobalIsSet(TxPoolNoLocalsFlag.Name) {
		cfg.NoLocals = ctx.GlobalBool(TxPoolNoLocalsFlag.Name)
	}
914 915 916 917 918 919
	if ctx.GlobalIsSet(TxPoolJournalFlag.Name) {
		cfg.Journal = ctx.GlobalString(TxPoolJournalFlag.Name)
	}
	if ctx.GlobalIsSet(TxPoolRejournalFlag.Name) {
		cfg.Rejournal = ctx.GlobalDuration(TxPoolRejournalFlag.Name)
	}
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
	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)
	}
}

943 944
func setEthash(ctx *cli.Context, cfg *eth.Config) {
	if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
945
		cfg.Ethash.CacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
946 947
	}
	if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
948
		cfg.Ethash.DatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
949 950
	}
	if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
951
		cfg.Ethash.CachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
952 953
	}
	if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
954
		cfg.Ethash.CachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
955 956
	}
	if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
957
		cfg.Ethash.DatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
958 959
	}
	if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
960
		cfg.Ethash.DatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
961 962 963
	}
}

964 965 966 967
// checkExclusive verifies that only a single isntance of the provided flags was
// set by the user. Each flag might optionally be followed by a string type to
// specialize it further.
func checkExclusive(ctx *cli.Context, args ...interface{}) {
968
	set := make([]string, 0, 1)
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
	for i := 0; i < len(args); i++ {
		// Make sure the next argument is a flag and skip if not set
		flag, ok := args[i].(cli.Flag)
		if !ok {
			panic(fmt.Sprintf("invalid argument, not cli.Flag type: %T", args[i]))
		}
		// Check if next arg extends current and expand its name if so
		name := flag.GetName()

		if i+1 < len(args) {
			switch option := args[i+1].(type) {
			case string:
				// Extended flag, expand the name and shift the arguments
				if ctx.GlobalString(flag.GetName()) == option {
					name += "=" + option
				}
				i++

			case cli.Flag:
			default:
				panic(fmt.Sprintf("invalid argument, not cli.Flag or string extension: %T", args[i+1]))
			}
		}
		// Mark the flag if it's set
993
		if ctx.GlobalIsSet(flag.GetName()) {
994
			set = append(set, "--"+name)
995 996
		}
	}
997
	if len(set) > 1 {
998
		Fatalf("Flags %v can't be used at the same time", strings.Join(set, ", "))
999
	}
1000 1001
}

1002 1003
// SetShhConfig applies shh-related command line flags to the config.
func SetShhConfig(ctx *cli.Context, stack *node.Node, cfg *whisper.Config) {
1004 1005
	if ctx.GlobalIsSet(WhisperMaxMessageSizeFlag.Name) {
		cfg.MaxMessageSize = uint32(ctx.GlobalUint(WhisperMaxMessageSizeFlag.Name))
1006
	}
1007 1008
	if ctx.GlobalIsSet(WhisperMinPOWFlag.Name) {
		cfg.MinimumAcceptedPOW = ctx.GlobalFloat64(WhisperMinPOWFlag.Name)
1009 1010 1011
	}
}

1012 1013 1014
// 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
1015
	checkExclusive(ctx, DeveloperFlag, TestnetFlag, RinkebyFlag)
1016
	checkExclusive(ctx, FastSyncFlag, LightModeFlag, SyncModeFlag)
1017 1018
	checkExclusive(ctx, LightServFlag, LightModeFlag)
	checkExclusive(ctx, LightServFlag, SyncModeFlag, "light")
1019

1020
	ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
1021 1022
	setEtherbase(ctx, ks, cfg)
	setGPO(ctx, &cfg.GPO)
1023
	setTxPool(ctx, &cfg.TxPool)
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
	setEthash(ctx, cfg)

	switch {
	case ctx.GlobalIsSet(SyncModeFlag.Name):
		cfg.SyncMode = *GlobalTextMarshaler(ctx, SyncModeFlag.Name).(*downloader.SyncMode)
	case ctx.GlobalBool(FastSyncFlag.Name):
		cfg.SyncMode = downloader.FastSync
	case ctx.GlobalBool(LightModeFlag.Name):
		cfg.SyncMode = downloader.LightSync
	}
	if ctx.GlobalIsSet(LightServFlag.Name) {
		cfg.LightServ = ctx.GlobalInt(LightServFlag.Name)
	}
	if ctx.GlobalIsSet(LightPeersFlag.Name) {
		cfg.LightPeers = ctx.GlobalInt(LightPeersFlag.Name)
	}
	if ctx.GlobalIsSet(NetworkIdFlag.Name) {
1041
		cfg.NetworkId = ctx.GlobalUint64(NetworkIdFlag.Name)
1042 1043
	}

1044 1045
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheDatabaseFlag.Name) {
		cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1046 1047 1048
	}
	cfg.DatabaseHandles = makeDatabaseHandles()

1049 1050 1051 1052 1053 1054 1055 1056
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
	cfg.NoPruning = ctx.GlobalString(GCModeFlag.Name) == "archive"

	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
		cfg.TrieCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
	}
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
	if ctx.GlobalIsSet(MinerThreadsFlag.Name) {
		cfg.MinerThreads = ctx.GlobalInt(MinerThreadsFlag.Name)
	}
	if ctx.GlobalIsSet(DocRootFlag.Name) {
		cfg.DocRoot = ctx.GlobalString(DocRootFlag.Name)
	}
	if ctx.GlobalIsSet(ExtraDataFlag.Name) {
		cfg.ExtraData = []byte(ctx.GlobalString(ExtraDataFlag.Name))
	}
	if ctx.GlobalIsSet(GasPriceFlag.Name) {
		cfg.GasPrice = GlobalBig(ctx, GasPriceFlag.Name)
	}
	if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
		// TODO(fjl): force-enable this in --dev mode
		cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
	}
1073

1074
	// Override any default configs for hard coded networks.
1075
	switch {
1076
	case ctx.GlobalBool(TestnetFlag.Name):
1077
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
1078
			cfg.NetworkId = 3
1079
		}
1080
		cfg.Genesis = core.DefaultTestnetGenesisBlock()
1081 1082 1083 1084 1085
	case ctx.GlobalBool(RinkebyFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			cfg.NetworkId = 4
		}
		cfg.Genesis = core.DefaultRinkebyGenesisBlock()
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	case ctx.GlobalBool(DeveloperFlag.Name):
		// 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)
1106
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
1107
			cfg.GasPrice = big.NewInt(1)
1108 1109
		}
	}
1110
	// TODO(fjl): move trie cache generations into config
1111 1112 1113
	if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
		state.MaxTrieCacheGen = uint16(gen)
	}
1114
}
1115

1116 1117 1118 1119 1120 1121 1122
// SetDashboardConfig applies dashboard related command line flags to the config.
func SetDashboardConfig(ctx *cli.Context, cfg *dashboard.Config) {
	cfg.Host = ctx.GlobalString(DashboardAddrFlag.Name)
	cfg.Port = ctx.GlobalInt(DashboardPortFlag.Name)
	cfg.Refresh = ctx.GlobalDuration(DashboardRefreshFlag.Name)
}

1123 1124 1125 1126 1127 1128 1129
// 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)
		})
1130
	} else {
1131 1132 1133 1134
		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)
1135 1136 1137
				fullNode.AddLesServer(ls)
			}
			return fullNode, err
1138 1139 1140 1141
		})
	}
	if err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
1142
	}
1143 1144
}

1145
// RegisterDashboardService adds a dashboard to the stack.
1146
func RegisterDashboardService(stack *node.Node, cfg *dashboard.Config, commit string) {
1147
	stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
1148
		return dashboard.New(cfg, commit)
1149 1150 1151
	})
}

1152
// RegisterShhService configures Whisper and adds it to the given node.
1153 1154 1155 1156
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 {
1157
		Fatalf("Failed to register the Whisper service: %v", err)
1158
	}
1159 1160
}

1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
// RegisterEthStatsService configures the Ethereum Stats daemon and adds it to
// th egiven node.
func RegisterEthStatsService(stack *node.Node, url string) {
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
		// Retrieve both eth and les services
		var ethServ *eth.Ethereum
		ctx.Service(&ethServ)

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

		return ethstats.New(url, ethServ, lesServ)
	}); err != nil {
1174
		Fatalf("Failed to register the Ethereum Stats service: %v", err)
1175 1176 1177
	}
}

1178 1179
// SetupNetwork configures the system for either the main net or some test network.
func SetupNetwork(ctx *cli.Context) {
1180
	// TODO(fjl): move target gas limit into config
1181
	params.TargetGasLimit = ctx.GlobalUint64(TargetGasLimitFlag.Name)
1182 1183
}

1184
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
1185
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
1186
	var (
1187
		cache   = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
1188
		handles = makeDatabaseHandles()
1189
	)
1190 1191 1192 1193
	name := "chaindata"
	if ctx.GlobalBool(LightModeFlag.Name) {
		name = "lightchaindata"
	}
1194
	chainDb, err := stack.OpenDatabase(name, cache, handles)
1195
	if err != nil {
1196
		Fatalf("Could not open database: %v", err)
1197
	}
1198 1199 1200
	return chainDb
}

F
Felix Lange 已提交
1201 1202 1203
func MakeGenesis(ctx *cli.Context) *core.Genesis {
	var genesis *core.Genesis
	switch {
1204
	case ctx.GlobalBool(TestnetFlag.Name):
F
Felix Lange 已提交
1205
		genesis = core.DefaultTestnetGenesisBlock()
1206 1207
	case ctx.GlobalBool(RinkebyFlag.Name):
		genesis = core.DefaultRinkebyGenesisBlock()
1208 1209
	case ctx.GlobalBool(DeveloperFlag.Name):
		Fatalf("Developer chains are ephemeral")
F
Felix Lange 已提交
1210 1211 1212 1213
	}
	return genesis
}

1214
// MakeChain creates a chain manager from set command line flags.
1215
func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
1216
	var err error
1217
	chainDb = MakeChainDatabase(ctx, stack)
1218

F
Felix Lange 已提交
1219 1220 1221 1222
	config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
	if err != nil {
		Fatalf("%v", err)
	}
1223 1224 1225 1226 1227 1228
	var engine consensus.Engine
	if config.Clique != nil {
		engine = clique.New(config.Clique, chainDb)
	} else {
		engine = ethash.NewFaker()
		if !ctx.GlobalBool(FakePoWFlag.Name) {
1229 1230 1231 1232 1233 1234 1235 1236
			engine = ethash.New(ethash.Config{
				CacheDir:       stack.ResolvePath(eth.DefaultConfig.Ethash.CacheDir),
				CachesInMem:    eth.DefaultConfig.Ethash.CachesInMem,
				CachesOnDisk:   eth.DefaultConfig.Ethash.CachesOnDisk,
				DatasetDir:     stack.ResolvePath(eth.DefaultConfig.Ethash.DatasetDir),
				DatasetsInMem:  eth.DefaultConfig.Ethash.DatasetsInMem,
				DatasetsOnDisk: eth.DefaultConfig.Ethash.DatasetsOnDisk,
			})
1237 1238
		}
	}
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
	if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
		Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
	}
	cache := &core.CacheConfig{
		Disabled:      ctx.GlobalString(GCModeFlag.Name) == "archive",
		TrieNodeLimit: eth.DefaultConfig.TrieCache,
		TrieTimeLimit: eth.DefaultConfig.TrieTimeout,
	}
	if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
		cache.TrieNodeLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
	}
F
Felix Lange 已提交
1250
	vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
1251
	chain, err = core.NewBlockChain(chainDb, cache, config, engine, vmcfg)
O
obscuren 已提交
1252
	if err != nil {
F
Felix Lange 已提交
1253
		Fatalf("Can't create BlockChain: %v", err)
O
obscuren 已提交
1254
	}
1255
	return chain, chainDb
1256
}
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273

// MakeConsolePreloads retrieves the absolute paths for the console JavaScript
// scripts to preload before starting.
func MakeConsolePreloads(ctx *cli.Context) []string {
	// Skip preloading if there's nothing to preload
	if ctx.GlobalString(PreloadJSFlag.Name) == "" {
		return nil
	}
	// Otherwise resolve absolute paths and return them
	preloads := []string{}

	assets := ctx.GlobalString(JSpathFlag.Name)
	for _, file := range strings.Split(ctx.GlobalString(PreloadJSFlag.Name), ",") {
		preloads = append(preloads, common.AbsolutePath(assets, strings.TrimSpace(file)))
	}
	return preloads
}
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297

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