flags.go 30.4 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/consensus/ethash"
35
	"github.com/ethereum/go-ethereum/core"
36
	"github.com/ethereum/go-ethereum/core/state"
37
	"github.com/ethereum/go-ethereum/core/vm"
38 39
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
40 41
	"github.com/ethereum/go-ethereum/eth/downloader"
	"github.com/ethereum/go-ethereum/eth/gasprice"
42
	"github.com/ethereum/go-ethereum/ethdb"
43
	"github.com/ethereum/go-ethereum/ethstats"
44
	"github.com/ethereum/go-ethereum/event"
45
	"github.com/ethereum/go-ethereum/les"
46
	"github.com/ethereum/go-ethereum/log"
B
Bas van Kervel 已提交
47
	"github.com/ethereum/go-ethereum/metrics"
48
	"github.com/ethereum/go-ethereum/node"
49
	"github.com/ethereum/go-ethereum/p2p"
50
	"github.com/ethereum/go-ethereum/p2p/discover"
51
	"github.com/ethereum/go-ethereum/p2p/discv5"
52
	"github.com/ethereum/go-ethereum/p2p/nat"
53
	"github.com/ethereum/go-ethereum/p2p/netutil"
54
	"github.com/ethereum/go-ethereum/params"
55
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv2"
56
	"gopkg.in/urfave/cli.v1"
57 58
)

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
func init() {
	cli.AppHelpTemplate = `{{.Name}} {{if .Flags}}[global options] {{end}}command{{if .Flags}} [command options]{{end}} [arguments...]

VERSION:
   {{.Version}}

COMMANDS:
   {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
   {{end}}{{if .Flags}}
GLOBAL OPTIONS:
   {{range .Flags}}{{.}}
   {{end}}{{end}}
`

	cli.CommandHelpTemplate = `{{.Name}}{{if .Subcommands}} command{{end}}{{if .Flags}} [command options]{{end}} [arguments...]
{{if .Description}}{{.Description}}
{{end}}{{if .Subcommands}}
SUBCOMMANDS:
	{{range .Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
	{{end}}{{end}}{{if .Flags}}
OPTIONS:
	{{range .Flags}}{{.}}
	{{end}}{{end}}
`
}

F
Felix Lange 已提交
85
// NewApp creates an app with sane defaults.
86
func NewApp(gitCommit, usage string) *cli.App {
F
Felix Lange 已提交
87
	app := cli.NewApp()
88
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
89
	app.Author = ""
O
obscuren 已提交
90
	//app.Authors = nil
F
Felix Lange 已提交
91
	app.Email = ""
92
	app.Version = params.Version
93 94 95
	if gitCommit != "" {
		app.Version += "-" + gitCommit[:8]
	}
F
Felix Lange 已提交
96 97 98 99
	app.Usage = usage
	return app
}

100 101 102 103 104 105 106 107 108
// 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
109
	DataDirFlag = DirectoryFlag{
110
		Name:  "datadir",
111
		Usage: "Data directory for the databases and keystore",
112
		Value: DirectoryString{node.DefaultDataDir()},
113
	}
K
Kobi Gurkan 已提交
114 115 116 117
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
118 119 120 121 122 123 124
	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)",
125
		Value: eth.DefaultConfig.EthashCachesInMem,
126 127 128 129
	}
	EthashCachesOnDiskFlag = cli.IntFlag{
		Name:  "ethash.cachesondisk",
		Usage: "Number of recent ethash caches to keep on disk (16MB each)",
130
		Value: eth.DefaultConfig.EthashCachesOnDisk,
131 132 133 134
	}
	EthashDatasetDirFlag = DirectoryFlag{
		Name:  "ethash.dagdir",
		Usage: "Directory to store the ethash mining DAGs (default = inside home folder)",
135
		Value: DirectoryString{eth.DefaultConfig.EthashDatasetDir},
136
	}
137 138 139
	EthashDatasetsInMemoryFlag = cli.IntFlag{
		Name:  "ethash.dagsinmem",
		Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
140
		Value: eth.DefaultConfig.EthashDatasetsInMem,
141
	}
142 143
	EthashDatasetsOnDiskFlag = cli.IntFlag{
		Name:  "ethash.dagsondisk",
144
		Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
145
		Value: eth.DefaultConfig.EthashDatasetsOnDisk,
146
	}
Z
zelig 已提交
147 148
	NetworkIdFlag = cli.IntFlag{
		Name:  "networkid",
149
		Usage: "Network identifier (integer, 1=Frontier, 2=Morden (disused), 3=Ropsten)",
150
		Value: eth.DefaultConfig.NetworkId,
Z
zelig 已提交
151
	}
152 153
	TestNetFlag = cli.BoolFlag{
		Name:  "testnet",
154
		Usage: "Ropsten network: pre-configured proof-of-work test network",
155
	}
156 157
	DevModeFlag = cli.BoolFlag{
		Name:  "dev",
158
		Usage: "Developer mode: pre-configured private network with several debugging flags",
159
	}
160 161
	IdentityFlag = cli.StringFlag{
		Name:  "identity",
162
		Usage: "Custom node name",
163
	}
Z
zelig 已提交
164 165 166
	DocRootFlag = DirectoryFlag{
		Name:  "docroot",
		Usage: "Document Root for HTTPClient file scheme",
167
		Value: DirectoryString{homeDir()},
Z
zelig 已提交
168
	}
169 170
	FastSyncFlag = cli.BoolFlag{
		Name:  "fast",
171
		Usage: "Enable fast syncing through state downloads",
172
	}
173 174 175 176
	LightModeFlag = cli.BoolFlag{
		Name:  "light",
		Usage: "Enable light client mode",
	}
177 178 179 180 181 182 183
	defaultSyncMode = eth.DefaultConfig.SyncMode
	SyncModeFlag    = TextMarshalerFlag{
		Name:  "syncmode",
		Usage: `Blockchain sync mode ("fast", "full", or "light")`,
		Value: &defaultSyncMode,
	}

184 185 186 187 188 189 190 191 192 193
	LightServFlag = cli.IntFlag{
		Name:  "lightserv",
		Usage: "Maximum percentage of time allowed for serving LES requests (0-90)",
		Value: 0,
	}
	LightPeersFlag = cli.IntFlag{
		Name:  "lightpeers",
		Usage: "Maximum number of LES client peers",
		Value: 20,
	}
194 195
	LightKDFFlag = cli.BoolFlag{
		Name:  "lightkdf",
196
		Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
197
	}
198 199 200 201 202 203 204 205 206 207 208
	// Performance tuning settings
	CacheFlag = cli.IntFlag{
		Name:  "cache",
		Usage: "Megabytes of memory allocated to internal caching (min 16MB / database forced)",
		Value: 128,
	}
	TrieCacheGenFlag = cli.IntFlag{
		Name:  "trie-cache-gens",
		Usage: "Number of trie node generations to keep in memory",
		Value: int(state.MaxTrieCacheGen),
	}
209 210 211 212
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
213
	}
214 215
	MinerThreadsFlag = cli.IntFlag{
		Name:  "minerthreads",
216
		Usage: "Number of CPU threads to use for mining",
217 218
		Value: runtime.NumCPU(),
	}
219
	TargetGasLimitFlag = cli.Uint64Flag{
220 221
		Name:  "targetgaslimit",
		Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine",
222
		Value: params.GenesisGasLimit.Uint64(),
223
	}
Z
zelig 已提交
224
	EtherbaseFlag = cli.StringFlag{
O
obscuren 已提交
225
		Name:  "etherbase",
226
		Usage: "Public address for block mining rewards (default = first account created)",
227
		Value: "0",
Z
zelig 已提交
228
	}
229
	GasPriceFlag = BigFlag{
230
		Name:  "gasprice",
231
		Usage: "Minimal gas price to accept for mining a transactions",
232
		Value: big.NewInt(20 * params.Shannon),
233
	}
Z
zelig 已提交
234 235
	ExtraDataFlag = cli.StringFlag{
		Name:  "extradata",
236
		Usage: "Block extra data set by the miner (default = client version)",
Z
zelig 已提交
237
	}
238
	// Account settings
Z
zelig 已提交
239 240
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
241
		Usage: "Comma separated list of accounts to unlock",
Z
zelig 已提交
242 243 244 245
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
246
		Usage: "Password file to use for non-inteactive password input",
Z
zelig 已提交
247
		Value: "",
Z
zelig 已提交
248
	}
249

250 251 252 253
	VMEnableDebugFlag = cli.BoolFlag{
		Name:  "vmdebug",
		Usage: "Record information useful for VM and contract debugging",
	}
254 255 256 257 258
	// Logging and debug settings
	EthStatsURLFlag = cli.StringFlag{
		Name:  "ethstats",
		Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
	}
259 260
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
261
		Usage: "Enable metrics collection and reporting",
262
	}
263 264 265 266
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
267 268 269 270
	NoCompactionFlag = cli.BoolFlag{
		Name:  "nocompaction",
		Usage: "Disables db compaction after import",
	}
271 272 273
	// RPC settings
	RPCEnabledFlag = cli.BoolFlag{
		Name:  "rpc",
274
		Usage: "Enable the HTTP-RPC server",
275 276 277
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
278
		Usage: "HTTP-RPC server listening interface",
279
		Value: node.DefaultHTTPHost,
280 281 282
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
283
		Usage: "HTTP-RPC server listening port",
284
		Value: node.DefaultHTTPPort,
285
	}
286 287
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
288
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
289 290
		Value: "",
	}
291
	RPCApiFlag = cli.StringFlag{
292
		Name:  "rpcapi",
293
		Usage: "API's offered over the HTTP-RPC interface",
294
		Value: "",
295
	}
B
Bas van Kervel 已提交
296 297 298 299 300 301
	IPCDisabledFlag = cli.BoolFlag{
		Name:  "ipcdisable",
		Usage: "Disable the IPC-RPC server",
	}
	IPCPathFlag = DirectoryFlag{
		Name:  "ipcpath",
302
		Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
B
Bas van Kervel 已提交
303
	}
304
	WSEnabledFlag = cli.BoolFlag{
305
		Name:  "ws",
306 307 308 309 310
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
311
		Value: node.DefaultWSHost,
312 313 314 315
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
316
		Value: node.DefaultWSPort,
317 318 319 320
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
321
		Value: "",
322
	}
B
Bas van Kervel 已提交
323 324 325
	WSAllowedOriginsFlag = cli.StringFlag{
		Name:  "wsorigins",
		Usage: "Origins from which to accept websockets requests",
326
		Value: "",
327
	}
328 329
	ExecFlag = cli.StringFlag{
		Name:  "exec",
330
		Usage: "Execute JavaScript statement (only in combination with console/attach)",
331
	}
332
	PreloadJSFlag = cli.StringFlag{
333 334 335
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}
336

337 338 339
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
340
		Usage: "Maximum number of network peers (network disabled if set to 0)",
341
		Value: 25,
342
	}
343 344 345 346 347
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
348 349 350 351 352
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
353
	BootnodesFlag = cli.StringFlag{
354
		Name:  "bootnodes",
355
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
356
		Value: "",
357 358 359 360 361 362 363 364 365 366 367
	}
	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",
368
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
369 370
		Value: "any",
	}
371 372 373 374
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
375 376 377 378
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
379 380 381 382 383
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}

384 385
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
386
		Usage: "Enable Whisper",
387
	}
388

389
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
390 391
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
392
		Usage: "JavaScript root path for `loadScript`",
Z
CLI:  
zelig 已提交
393 394
		Value: ".",
	}
395 396
	SolcPathFlag = cli.StringFlag{
		Name:  "solc",
397
		Usage: "Solidity compiler command to be used",
398 399
		Value: "solc",
	}
400 401

	// Gas price oracle settings
402 403 404
	GpoBlocksFlag = cli.IntFlag{
		Name:  "gpoblocks",
		Usage: "Number of recent blocks to check for gas prices",
405
		Value: eth.DefaultConfig.GPO.Blocks,
Z
zsfelfoldi 已提交
406
	}
407 408 409
	GpoPercentileFlag = cli.IntFlag{
		Name:  "gpopercentile",
		Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
410
		Value: eth.DefaultConfig.GPO.Percentile,
Z
zsfelfoldi 已提交
411
	}
412 413
)

414
// MakeDataDir retrieves the currently requested data directory, terminating
415 416
// 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.
417
func MakeDataDir(ctx *cli.Context) string {
418
	if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
419
		// TODO: choose a different location outside of the regular datadir.
420
		if ctx.GlobalBool(TestNetFlag.Name) {
421
			return filepath.Join(path, "testnet")
422 423
		}
		return path
424
	}
425
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
426
	return ""
427 428
}

429
// setNodeKey creates a node key from set command line flags, either loading it
430 431
// 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.
432
func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
433 434 435
	var (
		hex  = ctx.GlobalString(NodeKeyHexFlag.Name)
		file = ctx.GlobalString(NodeKeyFileFlag.Name)
436 437
		key  *ecdsa.PrivateKey
		err  error
438
	)
439 440
	switch {
	case file != "" && hex != "":
441
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
442 443
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
444
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
445
		}
446
		cfg.PrivateKey = key
447 448
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
449
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
450
		}
451
		cfg.PrivateKey = key
452 453 454
	}
}

455 456
// setNodeUserIdent creates the user identifier from CLI flags.
func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
457
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
458
		cfg.UserIdent = identity
459 460 461
	}
}

462
// setBootstrapNodes creates a list of bootstrap nodes from the command line
463
// flags, reverting to pre-configured ones if none have been specified.
464
func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
465 466
	urls := params.MainnetBootnodes
	if ctx.GlobalIsSet(BootnodesFlag.Name) {
467
		urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
468 469
	} else if ctx.GlobalBool(TestNetFlag.Name) {
		urls = params.TestnetBootnodes
470 471
	}

472
	cfg.BootstrapNodes = make([]*discover.Node, 0, len(urls))
473
	for _, url := range urls {
474 475
		node, err := discover.ParseNode(url)
		if err != nil {
P
Péter Szilágyi 已提交
476
			log.Error("Bootstrap URL invalid", "enode", url, "err", err)
477 478
			continue
		}
479
		cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
480 481 482
	}
}

483
// setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
484
// flags, reverting to pre-configured ones if none have been specified.
485
func setBootstrapNodesV5(ctx *cli.Context, cfg *p2p.Config) {
486 487
	urls := params.DiscoveryV5Bootnodes
	if ctx.GlobalIsSet(BootnodesFlag.Name) {
488
		urls = strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",")
489 490
	} else if cfg.BootstrapNodesV5 == nil {
		return // already set, don't apply defaults.
491 492
	}

493
	cfg.BootstrapNodesV5 = make([]*discv5.Node, 0, len(urls))
494
	for _, url := range urls {
495 496
		node, err := discv5.ParseNode(url)
		if err != nil {
P
Péter Szilágyi 已提交
497
			log.Error("Bootstrap URL invalid", "enode", url, "err", err)
498 499
			continue
		}
500
		cfg.BootstrapNodesV5 = append(cfg.BootstrapNodesV5, node)
501 502 503
	}
}

504
// setListenAddress creates a TCP listening address string from set command
505
// line flags.
506 507 508 509
func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
	if ctx.GlobalIsSet(ListenPortFlag.Name) {
		cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
	}
510 511
}

512
// setDiscoveryV5Address creates a UDP listening address string from set command
513
// line flags for the V5 discovery protocol.
514 515 516 517
func setDiscoveryV5Address(ctx *cli.Context, cfg *p2p.Config) {
	if ctx.GlobalIsSet(ListenPortFlag.Name) {
		cfg.DiscoveryV5Addr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name)+1)
	}
518 519
}

520 521 522 523 524 525 526 527
// 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
528 529 530
	}
}

531
// makeRPCModules splits input separated by a comma and trims excessive white
532
// space from the substrings.
533
func makeRPCModules(input string) []string {
534 535 536 537 538 539 540
	result := strings.Split(input, ",")
	for i, r := range result {
		result[i] = strings.TrimSpace(r)
	}
	return result
}

541
// setHTTP creates the HTTP RPC listener interface string from the set
542
// command line flags, returning empty if the HTTP endpoint is disabled.
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
func setHTTP(ctx *cli.Context, cfg *node.Config) {
	if ctx.GlobalBool(RPCEnabledFlag.Name) && cfg.HTTPHost == "" {
		cfg.HTTPHost = "127.0.0.1"
		if ctx.GlobalIsSet(RPCListenAddrFlag.Name) {
			cfg.HTTPHost = ctx.GlobalString(RPCListenAddrFlag.Name)
		}
	}

	if ctx.GlobalIsSet(RPCPortFlag.Name) {
		cfg.HTTPPort = ctx.GlobalInt(RPCPortFlag.Name)
	}
	if ctx.GlobalIsSet(RPCCORSDomainFlag.Name) {
		cfg.HTTPCors = ctx.GlobalString(RPCCORSDomainFlag.Name)
	}
	if ctx.GlobalIsSet(RPCApiFlag.Name) {
		cfg.HTTPModules = makeRPCModules(ctx.GlobalString(RPCApiFlag.Name))
559 560 561
	}
}

562
// setWS creates the WebSocket RPC listener interface string from the set
563
// command line flags, returning empty if the HTTP endpoint is disabled.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
func setWS(ctx *cli.Context, cfg *node.Config) {
	if ctx.GlobalBool(WSEnabledFlag.Name) && cfg.WSHost == "" {
		cfg.WSHost = "127.0.0.1"
		if ctx.GlobalIsSet(WSListenAddrFlag.Name) {
			cfg.WSHost = ctx.GlobalString(WSListenAddrFlag.Name)
		}
	}

	if ctx.GlobalIsSet(WSPortFlag.Name) {
		cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)
	}
	if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {
		cfg.WSOrigins = ctx.GlobalString(WSAllowedOriginsFlag.Name)
	}
	if ctx.GlobalIsSet(WSApiFlag.Name) {
		cfg.WSModules = makeRPCModules(ctx.GlobalString(WSApiFlag.Name))
	}
}

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

595
// makeDatabaseHandles raises out the number of allowed file handles per process
596
// for Geth and returns half of the allowance to assign to the database.
597
func makeDatabaseHandles() int {
598
	if err := raiseFdLimit(2048); err != nil {
599
		Fatalf("Failed to raise file descriptor allowance: %v", err)
600 601 602
	}
	limit, err := getFdLimit()
	if err != nil {
603
		Fatalf("Failed to retrieve file descriptor allowance: %v", err)
604 605 606 607 608 609 610
	}
	if limit > 2048 { // cap database file descriptors even if more is available
		limit = 2048
	}
	return limit / 2 // Leave half for networking and other stuff
}

611 612
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
613
func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
614 615
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
616
		return accounts.Account{Address: common.HexToAddress(account)}, nil
617 618 619
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
620
	if err != nil || index < 0 {
F
Felix Lange 已提交
621
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
622
	}
623 624 625 626 627
	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
628 629
}

630
// setEtherbase retrieves the etherbase either from the directly specified
631
// command line flags or from the keystore if CLI indexed.
632 633 634 635 636 637 638 639
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
		return
640
	}
641 642 643 644 645 646 647
	accounts := ks.Accounts()
	if (cfg.Etherbase == common.Address{}) {
		if len(accounts) > 0 {
			cfg.Etherbase = accounts[0].Address
		} else {
			log.Warn("No etherbase set and no accounts found as default")
		}
648
	}
649 650
}

651
// MakePasswordList reads password lines from the file specified by --password.
652
func MakePasswordList(ctx *cli.Context) []string {
653 654 655 656 657 658
	path := ctx.GlobalString(PasswordFileFlag.Name)
	if path == "" {
		return nil
	}
	text, err := ioutil.ReadFile(path)
	if err != nil {
659
		Fatalf("Failed to read password file: %v", err)
660 661 662 663 664
	}
	lines := strings.Split(string(text), "\n")
	// Sanitise DOS line endings.
	for i := range lines {
		lines[i] = strings.TrimRight(lines[i], "\r")
665
	}
666
	return lines
667 668
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
	setNodeKey(ctx, cfg)
	setNAT(ctx, cfg)
	setListenAddress(ctx, cfg)
	setDiscoveryV5Address(ctx, cfg)
	setBootstrapNodes(ctx, cfg)
	setBootstrapNodesV5(ctx, cfg)

	if ctx.GlobalIsSet(MaxPeersFlag.Name) {
		cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
	}
	if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
		cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
	}
	if ctx.GlobalIsSet(NoDiscoverFlag.Name) || ctx.GlobalBool(LightModeFlag.Name) {
		cfg.NoDiscovery = true
685 686
	}

687 688 689
	// 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
690
	forceV5Discovery := (ctx.GlobalBool(LightModeFlag.Name) || ctx.GlobalInt(LightServFlag.Name) > 0) && !ctx.GlobalBool(NoDiscoverFlag.Name)
691 692 693 694
	if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
		cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
	} else if forceV5Discovery {
		cfg.DiscoveryV5 = true
695
	}
696

697 698 699
	if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
		list, err := netutil.ParseNetlist(netrestrict)
		if err != nil {
700
			Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
701
		}
702
		cfg.NetRestrict = list
703 704
	}

705 706 707 708 709 710
	if ctx.GlobalBool(DevModeFlag.Name) {
		// --dev mode can't use p2p networking.
		cfg.MaxPeers = 0
		cfg.ListenAddr = ":0"
		cfg.NoDiscovery = true
		cfg.DiscoveryV5 = false
711 712 713
	}
}

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
// SetNodeConfig applies node-related command line flags to the config.
func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
	SetP2PConfig(ctx, &cfg.P2P)
	setIPC(ctx, cfg)
	setHTTP(ctx, cfg)
	setWS(ctx, cfg)
	setNodeUserIdent(ctx, cfg)

	switch {
	case ctx.GlobalIsSet(DataDirFlag.Name):
		cfg.DataDir = ctx.GlobalString(DataDirFlag.Name)
	case ctx.GlobalBool(DevModeFlag.Name):
		cfg.DataDir = filepath.Join(os.TempDir(), "ethereum_dev_mode")
	case ctx.GlobalBool(TestNetFlag.Name):
		cfg.DataDir = filepath.Join(node.DefaultDataDir(), "testnet")
	}

	if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
		cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
	}
	if ctx.GlobalIsSet(LightKDFFlag.Name) {
		cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
	}
}

func setGPO(ctx *cli.Context, cfg *gasprice.Config) {
	if ctx.GlobalIsSet(GpoBlocksFlag.Name) {
		cfg.Blocks = ctx.GlobalInt(GpoBlocksFlag.Name)
	}
	if ctx.GlobalIsSet(GpoPercentileFlag.Name) {
		cfg.Percentile = ctx.GlobalInt(GpoPercentileFlag.Name)
	}
}

func setEthash(ctx *cli.Context, cfg *eth.Config) {
	if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
		cfg.EthashCacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
	}
	if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
		cfg.EthashDatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
	}
	if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
		cfg.EthashCachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
	}
	if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
		cfg.EthashCachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
	}
	if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
		cfg.EthashDatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
	}
	if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
		cfg.EthashDatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
	}
}

func checkExclusive(ctx *cli.Context, flags ...cli.Flag) {
	set := make([]string, 0, 1)
	for _, flag := range flags {
		if ctx.GlobalIsSet(flag.GetName()) {
			set = append(set, "--"+flag.GetName())
774 775
		}
	}
776 777
	if len(set) > 1 {
		Fatalf("flags %v can't be used at the same time", strings.Join(set, ", "))
778
	}
779 780 781 782 783 784 785 786
}

// SetEthConfig applies eth-related command line flags to the config.
func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *eth.Config) {
	// Avoid conflicting network flags
	checkExclusive(ctx, DevModeFlag, TestNetFlag)
	checkExclusive(ctx, FastSyncFlag, LightModeFlag, SyncModeFlag)

787
	ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	setEtherbase(ctx, ks, cfg)
	setGPO(ctx, &cfg.GPO)
	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) {
		cfg.NetworkId = ctx.GlobalInt(NetworkIdFlag.Name)
	}

	// Ethereum needs to know maxPeers to calculate the light server peer ratio.
	// TODO(fjl): ensure Ethereum can get MaxPeers from node.
	cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)

	if ctx.GlobalIsSet(CacheFlag.Name) {
		cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name)
	}
	cfg.DatabaseHandles = makeDatabaseHandles()

	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(SolcPathFlag.Name) {
		cfg.SolcPath = ctx.GlobalString(SolcPathFlag.Name)
	}
	if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
		// TODO(fjl): force-enable this in --dev mode
		cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
	}
839

840
	// Override any default configs for --dev and --testnet.
841 842 843
	switch {
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
844
			cfg.NetworkId = 3
845
		}
846
		cfg.Genesis = core.DefaultTestnetGenesisBlock()
847
	case ctx.GlobalBool(DevModeFlag.Name):
848
		cfg.Genesis = core.DevGenesisBlock()
849
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
850
			cfg.GasPrice = new(big.Int)
851
		}
852
		cfg.PowTest = true
853
	}
854 855

	// TODO(fjl): move trie cache generations into config
856 857 858
	if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
		state.MaxTrieCacheGen = uint16(gen)
	}
859
}
860

861 862 863 864 865 866 867
// 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)
		})
868
	} else {
869 870 871 872
		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)
873 874 875
				fullNode.AddLesServer(ls)
			}
			return fullNode, err
876 877 878 879
		})
	}
	if err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
880
	}
881 882
}

883
// RegisterShhService configures Whisper and adds it to the given node.
884 885
func RegisterShhService(stack *node.Node) {
	if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
886
		Fatalf("Failed to register the Whisper service: %v", err)
887
	}
888 889
}

890 891 892 893 894 895 896 897 898 899 900 901 902
// 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 {
903
		Fatalf("Failed to register the Ethereum Stats service: %v", err)
904 905 906
	}
}

907 908
// SetupNetwork configures the system for either the main net or some test network.
func SetupNetwork(ctx *cli.Context) {
909
	// TODO(fjl): move target gas limit into config
910
	params.TargetGasLimit = new(big.Int).SetUint64(ctx.GlobalUint64(TargetGasLimitFlag.Name))
911 912
}

913 914 915 916 917 918 919 920
func ChainDbName(ctx *cli.Context) string {
	if ctx.GlobalBool(LightModeFlag.Name) {
		return "lightchaindata"
	} else {
		return "chaindata"
	}
}

921
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
922
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
923 924
	var (
		cache   = ctx.GlobalInt(CacheFlag.Name)
925
		handles = makeDatabaseHandles()
926
		name    = ChainDbName(ctx)
927
	)
928

929
	chainDb, err := stack.OpenDatabase(name, cache, handles)
930
	if err != nil {
931
		Fatalf("Could not open database: %v", err)
932
	}
933 934 935
	return chainDb
}

F
Felix Lange 已提交
936 937 938 939 940 941 942 943 944 945 946
func MakeGenesis(ctx *cli.Context) *core.Genesis {
	var genesis *core.Genesis
	switch {
	case ctx.GlobalBool(TestNetFlag.Name):
		genesis = core.DefaultTestnetGenesisBlock()
	case ctx.GlobalBool(DevModeFlag.Name):
		genesis = core.DevGenesisBlock()
	}
	return genesis
}

947
// MakeChain creates a chain manager from set command line flags.
948
func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
949
	var err error
950
	chainDb = MakeChainDatabase(ctx, stack)
951

952
	engine := ethash.NewFaker()
953
	if !ctx.GlobalBool(FakePoWFlag.Name) {
954
		engine = ethash.New("", 1, 0, "", 1, 0)
955
	}
F
Felix Lange 已提交
956 957 958 959 960
	config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
	if err != nil {
		Fatalf("%v", err)
	}
	vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
961
	chain, err = core.NewBlockChain(chainDb, config, engine, new(event.TypeMux), vmcfg)
O
obscuren 已提交
962
	if err != nil {
F
Felix Lange 已提交
963
		Fatalf("Can't create BlockChain: %v", err)
O
obscuren 已提交
964
	}
965
	return chain, chainDb
966
}
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983

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