flags.go 30.7 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 18 19 20
package utils

import (
	"crypto/ecdsa"
21
	"fmt"
22
	"io/ioutil"
23
	"math"
24
	"math/big"
25
	"os"
26
	"path/filepath"
27
	"runtime"
28
	"strconv"
29
	"strings"
30

31
	"github.com/ethereum/ethash"
F
Felix Lange 已提交
32
	"github.com/ethereum/go-ethereum/accounts"
Z
zelig 已提交
33
	"github.com/ethereum/go-ethereum/common"
34
	"github.com/ethereum/go-ethereum/core"
35
	"github.com/ethereum/go-ethereum/core/state"
36 37 38 39
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/ethereum/go-ethereum/event"
40 41
	"github.com/ethereum/go-ethereum/les"
	"github.com/ethereum/go-ethereum/light"
42
	"github.com/ethereum/go-ethereum/logger"
O
obscuren 已提交
43
	"github.com/ethereum/go-ethereum/logger/glog"
B
Bas van Kervel 已提交
44
	"github.com/ethereum/go-ethereum/metrics"
45 46
	"github.com/ethereum/go-ethereum/node"
	"github.com/ethereum/go-ethereum/p2p/discover"
47
	"github.com/ethereum/go-ethereum/p2p/discv5"
48
	"github.com/ethereum/go-ethereum/p2p/nat"
49
	"github.com/ethereum/go-ethereum/params"
50
	"github.com/ethereum/go-ethereum/pow"
51
	"github.com/ethereum/go-ethereum/rpc"
52
	whisper "github.com/ethereum/go-ethereum/whisper/whisperv2"
53
	"gopkg.in/urfave/cli.v1"
54 55
)

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

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

232 233 234 235 236 237 238 239 240 241 242 243 244 245
	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",
	}

Z
zelig 已提交
246
	// logging and debug settings
247 248
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
249
		Usage: "Enable metrics collection and reporting",
250
	}
251 252 253 254
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
255 256 257 258

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

328 329 330
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
331
		Usage: "Maximum number of network peers (network disabled if set to 0)",
332
		Value: 25,
333
	}
334 335 336 337 338
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
339 340 341 342 343 344 345
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
346
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
347 348 349 350 351 352 353 354 355 356 357 358
		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",
359
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
360 361
		Value: "any",
	}
362 363 364 365
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
366 367 368 369
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
370 371
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
372
		Usage: "Enable Whisper",
373
	}
374
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
375 376
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
I
Isidoro Ghezzi 已提交
377
		Usage: "JavaScript root path for `loadScript` and document root for `admin.httpGet`",
Z
CLI:  
zelig 已提交
378 379
		Value: ".",
	}
380 381
	SolcPathFlag = cli.StringFlag{
		Name:  "solc",
382
		Usage: "Solidity compiler command to be used",
383 384
		Value: "solc",
	}
385 386

	// Gas price oracle settings
Z
zsfelfoldi 已提交
387 388 389
	GpoMinGasPriceFlag = cli.StringFlag{
		Name:  "gpomin",
		Usage: "Minimum suggested gas price",
390
		Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(),
Z
zsfelfoldi 已提交
391 392 393 394
	}
	GpoMaxGasPriceFlag = cli.StringFlag{
		Name:  "gpomax",
		Usage: "Maximum suggested gas price",
395
		Value: new(big.Int).Mul(big.NewInt(500), common.Shannon).String(),
Z
zsfelfoldi 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
	}
	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,
	}
417 418
)

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

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

443 444 445 446 447 448 449 450 451 452 453
// 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
	)
454 455 456
	switch {
	case file != "" && hex != "":
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
457

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

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

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

// 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) {
489
			return params.TestnetBootnodes
490
		}
491
		return params.MainnetBootnodes
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
	}
	// 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
}

507 508 509 510 511
// 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) {
512
		return params.DiscoveryV5Bootnodes
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
	}
	// 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
}

528 529 530 531 532 533
// 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))
}

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

540 541 542
// 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))
543
	if err != nil {
544 545 546 547 548
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

549 550 551 552 553 554 555 556 557 558
// 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
}

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

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

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
// 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
}

593 594
// 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 已提交
595
func MakeAddress(accman *accounts.Manager, account string) (accounts.Account, error) {
596 597
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
598
		return accounts.Account{Address: common.HexToAddress(account)}, nil
599 600 601 602
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
F
Felix Lange 已提交
603
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
604
	}
F
Felix Lange 已提交
605
	return accman.AccountByIndex(index)
606 607 608 609 610
}

// 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 已提交
611
	accounts := accman.Accounts()
612
	if !ctx.GlobalIsSet(EtherbaseFlag.Name) && len(accounts) == 0 {
613
		glog.V(logger.Error).Infoln("WARNING: No etherbase set and no accounts found as default")
614 615
		return common.Address{}
	}
616 617 618
	etherbase := ctx.GlobalString(EtherbaseFlag.Name)
	if etherbase == "" {
		return common.Address{}
619
	}
620
	// If the specified etherbase is a valid address, return it
F
Felix Lange 已提交
621
	account, err := MakeAddress(accman, etherbase)
622
	if err != nil {
623
		Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
624
	}
F
Felix Lange 已提交
625
	return account.Address
626 627 628 629 630 631 632
}

// 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))
633
	}
634 635 636
	return extra
}

637
// MakePasswordList reads password lines from the file specified by --password.
638
func MakePasswordList(ctx *cli.Context) []string {
639 640 641 642 643 644 645 646 647 648 649 650
	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")
651
	}
652
	return lines
653 654
}

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

662
	config := &node.Config{
663
		DataDir:           MakeDataDir(ctx),
664 665 666
		KeyStoreDir:       ctx.GlobalString(KeyStoreDirFlag.Name),
		UseLightweightKDF: ctx.GlobalBool(LightKDFFlag.Name),
		PrivateKey:        MakeNodeKey(ctx),
667 668 669
		Name:              name,
		Version:           vsn,
		UserIdent:         makeNodeUserIdent(ctx),
670 671
		NoDiscovery:       ctx.GlobalBool(NoDiscoverFlag.Name) || ctx.GlobalBool(LightModeFlag.Name),
		DiscoveryV5:       ctx.GlobalBool(DiscoveryV5Flag.Name) || ctx.GlobalBool(LightModeFlag.Name) || ctx.GlobalInt(LightServFlag.Name) > 0,
672
		DiscoveryV5Addr:   MakeDiscoveryV5Address(ctx),
673
		BootstrapNodes:    MakeBootstrapNodes(ctx),
674
		BootstrapNodesV5:  MakeBootstrapNodesV5(ctx),
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
		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"
	}
	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.
706
func RegisterEthService(ctx *cli.Context, stack *node.Node, extra []byte) {
707 708 709 710 711 712 713 714 715 716 717 718
	// 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{
719
		Etherbase:               MakeEtherbase(stack.AccountManager(), ctx),
720
		ChainConfig:             MakeChainConfig(ctx, stack),
721
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
722 723 724 725
		LightMode:               ctx.GlobalBool(LightModeFlag.Name),
		LightServ:               ctx.GlobalInt(LightServFlag.Name),
		LightPeers:              ctx.GlobalInt(LightPeersFlag.Name),
		MaxPeers:                ctx.GlobalInt(MaxPeersFlag.Name),
726
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
727
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
728 729
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
730
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
731
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
732
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
Z
zsfelfoldi 已提交
733 734 735 736 737 738 739 740 741
		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),
742
	}
743

744 745 746 747 748 749
	// 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
		}
750
		ethConf.Genesis = core.OlympicGenesisBlock()
751

752 753 754 755
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
756
		ethConf.Genesis = core.TestNetGenesisBlock()
757
		state.StartingNonce = 1048576 // (2**20)
758
		light.StartingNonce = 1048576 // (2**20)
759

760
	case ctx.GlobalBool(DevModeFlag.Name):
761
		ethConf.Genesis = core.OlympicGenesisBlock()
762 763
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
764
		}
765
		ethConf.PowTest = true
766
	}
767 768 769 770
	// Override any global options pertaining to the Ethereum protocol
	if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
		state.MaxTrieCacheGen = uint16(gen)
	}
771

772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
	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)
		}
789
	}
790 791 792 793 794 795 796
}

// RegisterShhService configures whisper and adds it to the given node.
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)
	}
797 798
}

799 800 801 802 803 804 805 806 807 808 809 810
// 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)
	}
811
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
812 813
}

814
// MakeChainConfig reads the chain configuration from the database in ctx.Datadir.
815
func MakeChainConfig(ctx *cli.Context, stack *node.Node) *params.ChainConfig {
816
	db := MakeChainDatabase(ctx, stack)
817 818
	defer db.Close()

819
	return MakeChainConfigFromDb(ctx, db)
820 821
}

822
// MakeChainConfigFromDb reads the chain configuration from the given database.
823
func MakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig {
824
	// If the chain is already initialized, use any existing chain configs
825
	config := new(params.ChainConfig)
826

827 828
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
829
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
830 831 832 833 834 835
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
836 837 838
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
J
Jeffrey Wilcke 已提交
839 840 841 842
	// set chain id in case it's zero.
	if config.ChainId == nil {
		config.ChainId = new(big.Int)
	}
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
	// 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))

	// Set any missing chainConfig fields due to them being unset or system upgrade
	if defaults {
		if config.HomesteadBlock == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.HomesteadBlock = params.TestNetHomesteadBlock
			} else {
				config.HomesteadBlock = params.MainNetHomesteadBlock
			}
858
		}
859 860 861 862 863 864 865
		if config.DAOForkBlock == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.DAOForkBlock = params.TestNetDAOForkBlock
			} else {
				config.DAOForkBlock = params.MainNetDAOForkBlock
			}
			config.DAOForkSupport = true
866
		}
867 868 869 870 871 872
		if config.EIP150Block == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP150Block = params.TestNetHomesteadGasRepriceBlock
			} else {
				config.EIP150Block = params.MainNetHomesteadGasRepriceBlock
			}
873
		}
874 875 876 877 878 879
		if config.EIP150Hash == (common.Hash{}) {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP150Hash = params.TestNetHomesteadGasRepriceHash
			} else {
				config.EIP150Hash = params.MainNetHomesteadGasRepriceHash
			}
880
		}
881 882 883 884 885 886 887 888 889 890 891 892 893 894
		if config.EIP155Block == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP150Block = params.TestNetSpuriousDragon
			} else {
				config.EIP155Block = params.MainNetSpuriousDragon
			}
		}
		if config.EIP158Block == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP158Block = params.TestNetSpuriousDragon
			} else {
				config.EIP158Block = params.MainNetSpuriousDragon
			}
		}
895 896 897 898 899 900 901
		if config.ChainId.BitLen() == 0 {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.ChainId = params.TestNetChainID
			} else {
				config.ChainId = params.MainNetChainID
			}
		}
902
		config.DAOForkSupport = true
903
	}
904

905
	// Force override any existing configs if explicitly requested
906 907
	switch {
	case ctx.GlobalBool(SupportDAOFork.Name):
908
		config.DAOForkSupport = true
909
	case ctx.GlobalBool(OpposeDAOFork.Name):
910
		config.DAOForkSupport = false
911
	}
912
	return config
913 914
}

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

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

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

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

943
	if ctx.GlobalBool(OlympicFlag.Name) {
944
		_, err := core.WriteTestNetGenesisBlock(chainDb)
945 946 947 948
		if err != nil {
			glog.Fatalln(err)
		}
	}
949
	chainConfig := MakeChainConfigFromDb(ctx, chainDb)
950

951 952 953 954 955
	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 已提交
956 957 958
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
959
	return chain, chainDb
960
}
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977

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