flags.go 30.3 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"
25
	"math/big"
26
	"os"
27
	"path/filepath"
28
	"runtime"
29
	"strconv"
30
	"strings"
31

32
	"github.com/ethereum/ethash"
F
Felix Lange 已提交
33
	"github.com/ethereum/go-ethereum/accounts"
Z
zelig 已提交
34
	"github.com/ethereum/go-ethereum/common"
35
	"github.com/ethereum/go-ethereum/core"
36
	"github.com/ethereum/go-ethereum/core/state"
37 38 39
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
	"github.com/ethereum/go-ethereum/ethdb"
40
	"github.com/ethereum/go-ethereum/ethstats"
41
	"github.com/ethereum/go-ethereum/event"
42
	"github.com/ethereum/go-ethereum/les"
43
	"github.com/ethereum/go-ethereum/logger"
O
obscuren 已提交
44
	"github.com/ethereum/go-ethereum/logger/glog"
B
Bas van Kervel 已提交
45
	"github.com/ethereum/go-ethereum/metrics"
46 47
	"github.com/ethereum/go-ethereum/node"
	"github.com/ethereum/go-ethereum/p2p/discover"
48
	"github.com/ethereum/go-ethereum/p2p/discv5"
49
	"github.com/ethereum/go-ethereum/p2p/nat"
50
	"github.com/ethereum/go-ethereum/p2p/netutil"
51
	"github.com/ethereum/go-ethereum/params"
52
	"github.com/ethereum/go-ethereum/pow"
53
	"github.com/ethereum/go-ethereum/rpc"
54
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv2"
55
	"gopkg.in/urfave/cli.v1"
56 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
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 已提交
84
// NewApp creates an app with sane defaults.
85
func NewApp(gitCommit, usage string) *cli.App {
F
Felix Lange 已提交
86
	app := cli.NewApp()
87
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
88
	app.Author = ""
O
obscuren 已提交
89
	//app.Authors = nil
F
Felix Lange 已提交
90
	app.Email = ""
91
	app.Version = params.Version
92 93 94
	if gitCommit != "" {
		app.Version += "-" + gitCommit[:8]
	}
F
Felix Lange 已提交
95 96 97 98
	app.Usage = usage
	return app
}

99 100 101 102 103 104 105 106 107
// 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
108
	DataDirFlag = DirectoryFlag{
109
		Name:  "datadir",
110
		Usage: "Data directory for the databases and keystore",
111
		Value: DirectoryString{node.DefaultDataDir()},
112
	}
K
Kobi Gurkan 已提交
113 114 115 116
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
Z
zelig 已提交
117 118
	NetworkIdFlag = cli.IntFlag{
		Name:  "networkid",
119
		Usage: "Network identifier (integer, 0=Olympic (disused), 1=Frontier, 2=Morden (disused), 3=Ropsten)",
Z
zelig 已提交
120 121
		Value: eth.NetworkId,
	}
122 123 124
	OlympicFlag = cli.BoolFlag{
		Name:  "olympic",
		Usage: "Olympic network: pre-configured pre-release test network",
O
obscuren 已提交
125
	}
126 127
	TestNetFlag = cli.BoolFlag{
		Name:  "testnet",
128
		Usage: "Ropsten network: pre-configured test network",
129
	}
130 131
	DevModeFlag = cli.BoolFlag{
		Name:  "dev",
132
		Usage: "Developer mode: pre-configured private network with several debugging flags",
133
	}
134 135
	IdentityFlag = cli.StringFlag{
		Name:  "identity",
136
		Usage: "Custom node name",
137
	}
138 139 140 141
	NatspecEnabledFlag = cli.BoolFlag{
		Name:  "natspec",
		Usage: "Enable NatSpec confirmation notice",
	}
Z
zelig 已提交
142 143 144
	DocRootFlag = DirectoryFlag{
		Name:  "docroot",
		Usage: "Document Root for HTTPClient file scheme",
145
		Value: DirectoryString{homeDir()},
Z
zelig 已提交
146
	}
147 148
	FastSyncFlag = cli.BoolFlag{
		Name:  "fast",
149
		Usage: "Enable fast syncing through state downloads",
150
	}
151 152 153 154 155 156 157 158 159 160 161 162 163 164
	LightModeFlag = cli.BoolFlag{
		Name:  "light",
		Usage: "Enable light client mode",
	}
	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,
	}
165 166
	LightKDFFlag = cli.BoolFlag{
		Name:  "lightkdf",
167
		Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
168
	}
169 170 171 172 173 174 175 176 177 178 179
	// 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),
	}
180 181 182 183
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
184
	}
185 186
	MinerThreadsFlag = cli.IntFlag{
		Name:  "minerthreads",
187
		Usage: "Number of CPU threads to use for mining",
188 189
		Value: runtime.NumCPU(),
	}
190 191 192 193 194
	TargetGasLimitFlag = cli.StringFlag{
		Name:  "targetgaslimit",
		Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine",
		Value: params.GenesisGasLimit.String(),
	}
195 196 197 198
	AutoDAGFlag = cli.BoolFlag{
		Name:  "autodag",
		Usage: "Enable automatic DAG pregeneration",
	}
Z
zelig 已提交
199
	EtherbaseFlag = cli.StringFlag{
O
obscuren 已提交
200
		Name:  "etherbase",
201
		Usage: "Public address for block mining rewards (default = first account created)",
202
		Value: "0",
Z
zelig 已提交
203
	}
204 205
	GasPriceFlag = cli.StringFlag{
		Name:  "gasprice",
206
		Usage: "Minimal gas price to accept for mining a transactions",
207
		Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(),
208
	}
Z
zelig 已提交
209 210
	ExtraDataFlag = cli.StringFlag{
		Name:  "extradata",
211
		Usage: "Block extra data set by the miner (default = client version)",
Z
zelig 已提交
212
	}
213
	// Account settings
Z
zelig 已提交
214 215
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
216
		Usage: "Comma separated list of accounts to unlock",
Z
zelig 已提交
217 218 219 220
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
221
		Usage: "Password file to use for non-inteactive password input",
Z
zelig 已提交
222
		Value: "",
Z
zelig 已提交
223
	}
224

225 226 227 228 229 230 231 232 233 234 235 236 237
	VMForceJitFlag = cli.BoolFlag{
		Name:  "forcejit",
		Usage: "Force the JIT VM to take precedence",
	}
	VMJitCacheFlag = cli.IntFlag{
		Name:  "jitcache",
		Usage: "Amount of cached JIT VM programs",
		Value: 64,
	}
	VMEnableJitFlag = cli.BoolFlag{
		Name:  "jitvm",
		Usage: "Enable the JIT VM",
	}
238 239 240 241 242
	// Logging and debug settings
	EthStatsURLFlag = cli.StringFlag{
		Name:  "ethstats",
		Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
	}
243 244
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
245
		Usage: "Enable metrics collection and reporting",
246
	}
247 248 249 250
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
251 252 253 254

	// RPC settings
	RPCEnabledFlag = cli.BoolFlag{
		Name:  "rpc",
255
		Usage: "Enable the HTTP-RPC server",
256 257 258
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
259
		Usage: "HTTP-RPC server listening interface",
260
		Value: node.DefaultHTTPHost,
261 262 263
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
264
		Usage: "HTTP-RPC server listening port",
265
		Value: node.DefaultHTTPPort,
266
	}
267 268
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
269
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
270 271
		Value: "",
	}
272
	RPCApiFlag = cli.StringFlag{
273
		Name:  "rpcapi",
274
		Usage: "API's offered over the HTTP-RPC interface",
275
		Value: rpc.DefaultHTTPApis,
276
	}
B
Bas van Kervel 已提交
277 278 279 280 281 282
	IPCDisabledFlag = cli.BoolFlag{
		Name:  "ipcdisable",
		Usage: "Disable the IPC-RPC server",
	}
	IPCApiFlag = cli.StringFlag{
		Name:  "ipcapi",
283
		Usage: "APIs offered over the IPC-RPC interface",
284
		Value: rpc.DefaultIPCApis,
B
Bas van Kervel 已提交
285 286 287
	}
	IPCPathFlag = DirectoryFlag{
		Name:  "ipcpath",
288
		Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
289
		Value: DirectoryString{"geth.ipc"},
B
Bas van Kervel 已提交
290
	}
291
	WSEnabledFlag = cli.BoolFlag{
292
		Name:  "ws",
293 294 295 296 297
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
298
		Value: node.DefaultWSHost,
299 300 301 302
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
303
		Value: node.DefaultWSPort,
304 305 306 307
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
308
		Value: rpc.DefaultHTTPApis,
309
	}
B
Bas van Kervel 已提交
310 311 312
	WSAllowedOriginsFlag = cli.StringFlag{
		Name:  "wsorigins",
		Usage: "Origins from which to accept websockets requests",
313
		Value: "",
314
	}
315 316
	ExecFlag = cli.StringFlag{
		Name:  "exec",
317
		Usage: "Execute JavaScript statement (only in combination with console/attach)",
318
	}
319
	PreloadJSFlag = cli.StringFlag{
320 321 322
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}
323

324 325 326
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
327
		Usage: "Maximum number of network peers (network disabled if set to 0)",
328
		Value: 25,
329
	}
330 331 332 333 334
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
335 336 337 338 339 340 341
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
342
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
343 344 345 346 347 348 349 350 351 352 353 354
		Value: "",
	}
	NodeKeyFileFlag = cli.StringFlag{
		Name:  "nodekey",
		Usage: "P2P node key file",
	}
	NodeKeyHexFlag = cli.StringFlag{
		Name:  "nodekeyhex",
		Usage: "P2P node key as hex (for testing)",
	}
	NATFlag = cli.StringFlag{
		Name:  "nat",
355
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
356 357
		Value: "any",
	}
358 359 360 361
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
362 363 364 365
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
366 367 368 369 370
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}

371 372
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
373
		Usage: "Enable Whisper",
374
	}
375

376
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
377 378
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
379
		Usage: "JavaScript root path for `loadScript`",
Z
CLI:  
zelig 已提交
380 381
		Value: ".",
	}
382 383
	SolcPathFlag = cli.StringFlag{
		Name:  "solc",
384
		Usage: "Solidity compiler command to be used",
385 386
		Value: "solc",
	}
387 388

	// Gas price oracle settings
Z
zsfelfoldi 已提交
389 390 391
	GpoMinGasPriceFlag = cli.StringFlag{
		Name:  "gpomin",
		Usage: "Minimum suggested gas price",
392
		Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(),
Z
zsfelfoldi 已提交
393 394 395 396
	}
	GpoMaxGasPriceFlag = cli.StringFlag{
		Name:  "gpomax",
		Usage: "Maximum suggested gas price",
397
		Value: new(big.Int).Mul(big.NewInt(500), common.Shannon).String(),
Z
zsfelfoldi 已提交
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
	}
	GpoFullBlockRatioFlag = cli.IntFlag{
		Name:  "gpofull",
		Usage: "Full block threshold for gas price calculation (%)",
		Value: 80,
	}
	GpobaseStepDownFlag = cli.IntFlag{
		Name:  "gpobasedown",
		Usage: "Suggested gas price base step down ratio (1/1000)",
		Value: 10,
	}
	GpobaseStepUpFlag = cli.IntFlag{
		Name:  "gpobaseup",
		Usage: "Suggested gas price base step up ratio (1/1000)",
		Value: 100,
	}
	GpobaseCorrectionFactorFlag = cli.IntFlag{
		Name:  "gpobasecf",
		Usage: "Suggested gas price base correction factor (%)",
		Value: 110,
	}
419 420
)

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

436
// MakeIPCPath creates an IPC path configuration from the set command line flags,
437
// returning an empty string if IPC was explicitly disabled, or the set path.
438
func MakeIPCPath(ctx *cli.Context) string {
439 440 441 442 443 444
	if ctx.GlobalBool(IPCDisabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(IPCPathFlag.Name)
}

445 446 447 448 449 450 451 452 453 454 455
// MakeNodeKey creates a node key from set command line flags, either loading it
// from a file or as a specified hex value. If neither flags were provided, this
// method returns nil and an emphemeral key is to be generated.
func MakeNodeKey(ctx *cli.Context) *ecdsa.PrivateKey {
	var (
		hex  = ctx.GlobalString(NodeKeyHexFlag.Name)
		file = ctx.GlobalString(NodeKeyFileFlag.Name)

		key *ecdsa.PrivateKey
		err error
	)
456 457 458
	switch {
	case file != "" && hex != "":
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
459

460 461 462 463
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
		}
464

465 466 467 468 469 470 471 472
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
		}
	}
	return key
}

473 474 475
// makeNodeUserIdent creates the user identifier from CLI flags.
func makeNodeUserIdent(ctx *cli.Context) string {
	var comps []string
476
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
477
		comps = append(comps, identity)
478 479
	}
	if ctx.GlobalBool(VMEnableJitFlag.Name) {
480
		comps = append(comps, "JIT")
481
	}
482
	return strings.Join(comps, "/")
483 484 485 486 487 488 489 490
}

// MakeBootstrapNodes creates a list of bootstrap nodes from the command line
// flags, reverting to pre-configured ones if none have been specified.
func MakeBootstrapNodes(ctx *cli.Context) []*discover.Node {
	// Return pre-configured nodes if none were manually requested
	if !ctx.GlobalIsSet(BootnodesFlag.Name) {
		if ctx.GlobalBool(TestNetFlag.Name) {
491
			return params.TestnetBootnodes
492
		}
493
		return params.MainnetBootnodes
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	}
	// Otherwise parse and use the CLI bootstrap nodes
	bootnodes := []*discover.Node{}

	for _, url := range strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",") {
		node, err := discover.ParseNode(url)
		if err != nil {
			glog.V(logger.Error).Infof("Bootstrap URL %s: %v\n", url, err)
			continue
		}
		bootnodes = append(bootnodes, node)
	}
	return bootnodes
}

509 510 511 512 513
// MakeBootstrapNodesV5 creates a list of bootstrap nodes from the command line
// flags, reverting to pre-configured ones if none have been specified.
func MakeBootstrapNodesV5(ctx *cli.Context) []*discv5.Node {
	// Return pre-configured nodes if none were manually requested
	if !ctx.GlobalIsSet(BootnodesFlag.Name) {
514
		return params.DiscoveryV5Bootnodes
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
	}
	// Otherwise parse and use the CLI bootstrap nodes
	bootnodes := []*discv5.Node{}

	for _, url := range strings.Split(ctx.GlobalString(BootnodesFlag.Name), ",") {
		node, err := discv5.ParseNode(url)
		if err != nil {
			glog.V(logger.Error).Infof("Bootstrap URL %s: %v\n", url, err)
			continue
		}
		bootnodes = append(bootnodes, node)
	}
	return bootnodes
}

530 531 532 533 534 535
// MakeListenAddress creates a TCP listening address string from set command
// line flags.
func MakeListenAddress(ctx *cli.Context) string {
	return fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
}

536 537 538
// MakeDiscoveryV5Address creates a UDP listening address string from set command
// line flags for the V5 discovery protocol.
func MakeDiscoveryV5Address(ctx *cli.Context) string {
539 540 541
	return fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name)+1)
}

542 543 544
// MakeNAT creates a port mapper from set command line flags.
func MakeNAT(ctx *cli.Context) nat.Interface {
	natif, err := nat.Parse(ctx.GlobalString(NATFlag.Name))
545
	if err != nil {
546 547 548 549 550
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

551 552 553 554 555 556 557 558 559 560
// MakeRPCModules splits input separated by a comma and trims excessive white
// space from the substrings.
func MakeRPCModules(input string) []string {
	result := strings.Split(input, ",")
	for i, r := range result {
		result[i] = strings.TrimSpace(r)
	}
	return result
}

561
// MakeHTTPRpcHost creates the HTTP RPC listener interface string from the set
562
// command line flags, returning empty if the HTTP endpoint is disabled.
563
func MakeHTTPRpcHost(ctx *cli.Context) string {
564 565 566 567 568 569
	if !ctx.GlobalBool(RPCEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(RPCListenAddrFlag.Name)
}

570
// MakeWSRpcHost creates the WebSocket RPC listener interface string from the set
571
// command line flags, returning empty if the HTTP endpoint is disabled.
572
func MakeWSRpcHost(ctx *cli.Context) string {
573 574 575 576 577 578
	if !ctx.GlobalBool(WSEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(WSListenAddrFlag.Name)
}

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
// MakeDatabaseHandles raises out the number of allowed file handles per process
// for Geth and returns half of the allowance to assign to the database.
func MakeDatabaseHandles() int {
	if err := raiseFdLimit(2048); err != nil {
		Fatalf("Failed to raise file descriptor allowance: %v", err)
	}
	limit, err := getFdLimit()
	if err != nil {
		Fatalf("Failed to retrieve file descriptor allowance: %v", err)
	}
	if limit > 2048 { // cap database file descriptors even if more is available
		limit = 2048
	}
	return limit / 2 // Leave half for networking and other stuff
}

595 596
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
F
Felix Lange 已提交
597
func MakeAddress(accman *accounts.Manager, account string) (accounts.Account, error) {
598 599
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
600
		return accounts.Account{Address: common.HexToAddress(account)}, nil
601 602 603 604
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
F
Felix Lange 已提交
605
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
606
	}
F
Felix Lange 已提交
607
	return accman.AccountByIndex(index)
608 609 610 611 612
}

// MakeEtherbase retrieves the etherbase either from the directly specified
// command line flags or from the keystore if CLI indexed.
func MakeEtherbase(accman *accounts.Manager, ctx *cli.Context) common.Address {
F
Felix Lange 已提交
613
	accounts := accman.Accounts()
614
	if !ctx.GlobalIsSet(EtherbaseFlag.Name) && len(accounts) == 0 {
615
		glog.V(logger.Error).Infoln("WARNING: No etherbase set and no accounts found as default")
616 617
		return common.Address{}
	}
618 619 620
	etherbase := ctx.GlobalString(EtherbaseFlag.Name)
	if etherbase == "" {
		return common.Address{}
621
	}
622
	// If the specified etherbase is a valid address, return it
F
Felix Lange 已提交
623
	account, err := MakeAddress(accman, etherbase)
624
	if err != nil {
625
		Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
626
	}
F
Felix Lange 已提交
627
	return account.Address
628 629 630 631 632 633 634
}

// MakeMinerExtra resolves extradata for the miner from the set command line flags
// or returns a default one composed on the client, runtime and OS metadata.
func MakeMinerExtra(extra []byte, ctx *cli.Context) []byte {
	if ctx.GlobalIsSet(ExtraDataFlag.Name) {
		return []byte(ctx.GlobalString(ExtraDataFlag.Name))
635
	}
636 637 638
	return extra
}

639
// MakePasswordList reads password lines from the file specified by --password.
640
func MakePasswordList(ctx *cli.Context) []string {
641 642 643 644 645 646 647 648 649 650 651 652
	path := ctx.GlobalString(PasswordFileFlag.Name)
	if path == "" {
		return nil
	}
	text, err := ioutil.ReadFile(path)
	if err != nil {
		Fatalf("Failed to read password file: %v", err)
	}
	lines := strings.Split(string(text), "\n")
	// Sanitise DOS line endings.
	for i := range lines {
		lines[i] = strings.TrimRight(lines[i], "\r")
653
	}
654
	return lines
655 656
}

657
// MakeNode configures a node with no services from command line flags.
658
func MakeNode(ctx *cli.Context, name, gitCommit string) *node.Node {
659
	vsn := params.Version
660 661 662 663
	if gitCommit != "" {
		vsn += "-" + gitCommit[:8]
	}

664
	config := &node.Config{
665
		DataDir:           MakeDataDir(ctx),
666 667 668
		KeyStoreDir:       ctx.GlobalString(KeyStoreDirFlag.Name),
		UseLightweightKDF: ctx.GlobalBool(LightKDFFlag.Name),
		PrivateKey:        MakeNodeKey(ctx),
669 670 671
		Name:              name,
		Version:           vsn,
		UserIdent:         makeNodeUserIdent(ctx),
672 673
		NoDiscovery:       ctx.GlobalBool(NoDiscoverFlag.Name) || ctx.GlobalBool(LightModeFlag.Name),
		DiscoveryV5:       ctx.GlobalBool(DiscoveryV5Flag.Name) || ctx.GlobalBool(LightModeFlag.Name) || ctx.GlobalInt(LightServFlag.Name) > 0,
674
		DiscoveryV5Addr:   MakeDiscoveryV5Address(ctx),
675
		BootstrapNodes:    MakeBootstrapNodes(ctx),
676
		BootstrapNodesV5:  MakeBootstrapNodesV5(ctx),
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
		ListenAddr:        MakeListenAddress(ctx),
		NAT:               MakeNAT(ctx),
		MaxPeers:          ctx.GlobalInt(MaxPeersFlag.Name),
		MaxPendingPeers:   ctx.GlobalInt(MaxPendingPeersFlag.Name),
		IPCPath:           MakeIPCPath(ctx),
		HTTPHost:          MakeHTTPRpcHost(ctx),
		HTTPPort:          ctx.GlobalInt(RPCPortFlag.Name),
		HTTPCors:          ctx.GlobalString(RPCCORSDomainFlag.Name),
		HTTPModules:       MakeRPCModules(ctx.GlobalString(RPCApiFlag.Name)),
		WSHost:            MakeWSRpcHost(ctx),
		WSPort:            ctx.GlobalInt(WSPortFlag.Name),
		WSOrigins:         ctx.GlobalString(WSAllowedOriginsFlag.Name),
		WSModules:         MakeRPCModules(ctx.GlobalString(WSApiFlag.Name)),
	}
	if ctx.GlobalBool(DevModeFlag.Name) {
		if !ctx.GlobalIsSet(DataDirFlag.Name) {
			config.DataDir = filepath.Join(os.TempDir(), "/ethereum_dev_mode")
		}
		// --dev mode does not need p2p networking.
		config.MaxPeers = 0
		config.ListenAddr = ":0"
	}
699 700 701 702 703 704 705 706
	if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
		list, err := netutil.ParseNetlist(netrestrict)
		if err != nil {
			Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
		}
		config.NetRestrict = list
	}

707 708 709 710 711 712 713 714 715
	stack, err := node.New(config)
	if err != nil {
		Fatalf("Failed to create the protocol stack: %v", err)
	}
	return stack
}

// RegisterEthService configures eth.Ethereum from command line flags and adds it to the
// given node.
716
func RegisterEthService(ctx *cli.Context, stack *node.Node, extra []byte) {
717 718 719 720 721 722 723 724 725 726 727 728
	// Avoid conflicting network flags
	networks, netFlags := 0, []cli.BoolFlag{DevModeFlag, TestNetFlag, OlympicFlag}
	for _, flag := range netFlags {
		if ctx.GlobalBool(flag.Name) {
			networks++
		}
	}
	if networks > 1 {
		Fatalf("The %v flags are mutually exclusive", netFlags)
	}

	ethConf := &eth.Config{
729
		Etherbase:               MakeEtherbase(stack.AccountManager(), ctx),
730
		ChainConfig:             MakeChainConfig(ctx, stack),
731
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
732 733 734 735
		LightMode:               ctx.GlobalBool(LightModeFlag.Name),
		LightServ:               ctx.GlobalInt(LightServFlag.Name),
		LightPeers:              ctx.GlobalInt(LightPeersFlag.Name),
		MaxPeers:                ctx.GlobalInt(MaxPeersFlag.Name),
736
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
737
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
738 739
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
740
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
741
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
742
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
Z
zsfelfoldi 已提交
743 744 745 746 747 748 749 750 751
		GasPrice:                common.String2Big(ctx.GlobalString(GasPriceFlag.Name)),
		GpoMinGasPrice:          common.String2Big(ctx.GlobalString(GpoMinGasPriceFlag.Name)),
		GpoMaxGasPrice:          common.String2Big(ctx.GlobalString(GpoMaxGasPriceFlag.Name)),
		GpoFullBlockRatio:       ctx.GlobalInt(GpoFullBlockRatioFlag.Name),
		GpobaseStepDown:         ctx.GlobalInt(GpobaseStepDownFlag.Name),
		GpobaseStepUp:           ctx.GlobalInt(GpobaseStepUpFlag.Name),
		GpobaseCorrectionFactor: ctx.GlobalInt(GpobaseCorrectionFactorFlag.Name),
		SolcPath:                ctx.GlobalString(SolcPathFlag.Name),
		AutoDAG:                 ctx.GlobalBool(AutoDAGFlag.Name) || ctx.GlobalBool(MiningEnabledFlag.Name),
752
	}
753

754 755 756 757 758 759
	// Override any default configs in dev mode or the test net
	switch {
	case ctx.GlobalBool(OlympicFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 1
		}
760
		ethConf.Genesis = core.OlympicGenesisBlock()
761

762 763
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
764
			ethConf.NetworkId = 3
765
		}
766
		ethConf.Genesis = core.DefaultTestnetGenesisBlock()
767

768
	case ctx.GlobalBool(DevModeFlag.Name):
769
		ethConf.Genesis = core.OlympicGenesisBlock()
770 771
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
772
		}
773
		ethConf.PowTest = true
774
	}
775 776 777 778
	// Override any global options pertaining to the Ethereum protocol
	if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
		state.MaxTrieCacheGen = uint16(gen)
	}
779

780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
	if ethConf.LightMode {
		if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
			return les.New(ctx, ethConf)
		}); err != nil {
			Fatalf("Failed to register the Ethereum light node service: %v", err)
		}
	} else {
		if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
			fullNode, err := eth.New(ctx, ethConf)
			if fullNode != nil && ethConf.LightServ > 0 {
				ls, _ := les.NewLesServer(fullNode, ethConf)
				fullNode.AddLesServer(ls)
			}
			return fullNode, err
		}); err != nil {
			Fatalf("Failed to register the Ethereum full node service: %v", err)
		}
797
	}
798 799
}

800
// RegisterShhService configures Whisper and adds it to the given node.
801 802 803 804
func RegisterShhService(stack *node.Node) {
	if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
		Fatalf("Failed to register the Whisper service: %v", err)
	}
805 806
}

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
// 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 {
		Fatalf("Failed to register the Ethereum Stats service: %v", err)
	}
}

824 825 826 827 828 829 830 831 832 833 834 835
// SetupNetwork configures the system for either the main net or some test network.
func SetupNetwork(ctx *cli.Context) {
	switch {
	case ctx.GlobalBool(OlympicFlag.Name):
		params.DurationLimit = big.NewInt(8)
		params.GenesisGasLimit = big.NewInt(3141592)
		params.MinGasLimit = big.NewInt(125000)
		params.MaximumExtraDataSize = big.NewInt(1024)
		NetworkIdFlag.Value = 0
		core.BlockReward = big.NewInt(1.5e+18)
		core.ExpDiffPeriod = big.NewInt(math.MaxInt64)
	}
836
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
837 838
}

839
// MakeChainConfig reads the chain configuration from the database in ctx.Datadir.
840
func MakeChainConfig(ctx *cli.Context, stack *node.Node) *params.ChainConfig {
841
	db := MakeChainDatabase(ctx, stack)
842 843
	defer db.Close()

844
	return MakeChainConfigFromDb(ctx, db)
845 846
}

847
// MakeChainConfigFromDb reads the chain configuration from the given database.
848
func MakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig {
849
	// If the chain is already initialized, use any existing chain configs
850
	config := new(params.ChainConfig)
851

852 853
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
854
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
855 856 857 858 859 860
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
861 862 863
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
J
Jeffrey Wilcke 已提交
864 865 866 867
	// set chain id in case it's zero.
	if config.ChainId == nil {
		config.ChainId = new(big.Int)
	}
868 869 870 871 872 873 874 875
	// Check whether we are allowed to set default config params or not:
	//  - If no genesis is set, we're running either mainnet or testnet (private nets use `geth init`)
	//  - If a genesis is already set, ensure we have a configuration for it (mainnet or testnet)
	defaults := genesis == nil ||
		(genesis.Hash() == params.MainNetGenesisHash && !ctx.GlobalBool(TestNetFlag.Name)) ||
		(genesis.Hash() == params.TestNetGenesisHash && ctx.GlobalBool(TestNetFlag.Name))

	if defaults {
876
		if ctx.GlobalBool(TestNetFlag.Name) {
877
			config = params.TestnetChainConfig
878
		} else {
879
			// Homestead fork
880
			config.HomesteadBlock = params.MainNetHomesteadBlock
881
			// DAO fork
882
			config.DAOForkBlock = params.MainNetDAOForkBlock
883
			config.DAOForkSupport = true
884

885
			// DoS reprice fork
886 887
			config.EIP150Block = params.MainNetHomesteadGasRepriceBlock
			config.EIP150Hash = params.MainNetHomesteadGasRepriceHash
888 889

			// DoS state cleanup fork
890 891 892
			config.EIP155Block = params.MainNetSpuriousDragon
			config.EIP158Block = params.MainNetSpuriousDragon
			config.ChainId = params.MainNetChainID
893
		}
894
	}
895
	return config
896 897
}

898 899 900 901 902 903 904 905
func ChainDbName(ctx *cli.Context) string {
	if ctx.GlobalBool(LightModeFlag.Name) {
		return "lightchaindata"
	} else {
		return "chaindata"
	}
}

906
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
907
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
908 909 910
	var (
		cache   = ctx.GlobalInt(CacheFlag.Name)
		handles = MakeDatabaseHandles()
911
		name    = ChainDbName(ctx)
912
	)
913

914
	chainDb, err := stack.OpenDatabase(name, cache, handles)
915
	if err != nil {
916 917
		Fatalf("Could not open database: %v", err)
	}
918 919 920 921
	return chainDb
}

// MakeChain creates a chain manager from set command line flags.
922
func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
923
	var err error
924
	chainDb = MakeChainDatabase(ctx, stack)
925

926
	if ctx.GlobalBool(OlympicFlag.Name) {
927
		_, err := core.WriteTestNetGenesisBlock(chainDb)
928 929 930 931
		if err != nil {
			glog.Fatalln(err)
		}
	}
932
	chainConfig := MakeChainConfigFromDb(ctx, chainDb)
933

934 935 936 937 938
	pow := pow.PoW(core.FakePow{})
	if !ctx.GlobalBool(FakePoWFlag.Name) {
		pow = ethash.New()
	}
	chain, err = core.NewBlockChain(chainDb, chainConfig, pow, new(event.TypeMux))
O
obscuren 已提交
939 940 941
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
942
	return chain, chainDb
943
}
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960

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