flags.go 31.2 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
	"math/rand"
26
	"os"
27
	"path/filepath"
28
	"runtime"
29
	"strconv"
30
	"strings"
31
	"time"
32

33
	"github.com/ethereum/ethash"
F
Felix Lange 已提交
34
	"github.com/ethereum/go-ethereum/accounts"
Z
zelig 已提交
35
	"github.com/ethereum/go-ethereum/common"
36
	"github.com/ethereum/go-ethereum/core"
37
	"github.com/ethereum/go-ethereum/core/state"
38 39 40 41
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/ethereum/go-ethereum/event"
42 43
	"github.com/ethereum/go-ethereum/les"
	"github.com/ethereum/go-ethereum/light"
44
	"github.com/ethereum/go-ethereum/logger"
O
obscuren 已提交
45
	"github.com/ethereum/go-ethereum/logger/glog"
B
Bas van Kervel 已提交
46
	"github.com/ethereum/go-ethereum/metrics"
47 48
	"github.com/ethereum/go-ethereum/node"
	"github.com/ethereum/go-ethereum/p2p/discover"
49
	"github.com/ethereum/go-ethereum/p2p/discv5"
50
	"github.com/ethereum/go-ethereum/p2p/nat"
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 92 93 94
	app.Version = Version
	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, 1=Frontier, 2=Morden)",
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 128
	TestNetFlag = cli.BoolFlag{
		Name:  "testnet",
		Usage: "Morden network: pre-configured test network with modified starting nonces (replay protection)",
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 184 185 186 187 188
	// 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",
	}
189 190 191 192
	// Miner settings
	MiningEnabledFlag = cli.BoolFlag{
		Name:  "mine",
		Usage: "Enable mining",
193
	}
194 195
	MinerThreadsFlag = cli.IntFlag{
		Name:  "minerthreads",
196
		Usage: "Number of CPU threads to use for mining",
197 198
		Value: runtime.NumCPU(),
	}
199 200 201 202 203
	TargetGasLimitFlag = cli.StringFlag{
		Name:  "targetgaslimit",
		Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine",
		Value: params.GenesisGasLimit.String(),
	}
204 205 206 207
	AutoDAGFlag = cli.BoolFlag{
		Name:  "autodag",
		Usage: "Enable automatic DAG pregeneration",
	}
Z
zelig 已提交
208
	EtherbaseFlag = cli.StringFlag{
O
obscuren 已提交
209
		Name:  "etherbase",
210
		Usage: "Public address for block mining rewards (default = first account created)",
211
		Value: "0",
Z
zelig 已提交
212
	}
213 214
	GasPriceFlag = cli.StringFlag{
		Name:  "gasprice",
215
		Usage: "Minimal gas price to accept for mining a transactions",
216
		Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(),
217
	}
Z
zelig 已提交
218 219
	ExtraDataFlag = cli.StringFlag{
		Name:  "extradata",
220
		Usage: "Block extra data set by the miner (default = client version)",
Z
zelig 已提交
221
	}
222
	// Account settings
Z
zelig 已提交
223 224
	UnlockedAccountFlag = cli.StringFlag{
		Name:  "unlock",
225
		Usage: "Comma separated list of accounts to unlock",
Z
zelig 已提交
226 227 228 229
		Value: "",
	}
	PasswordFileFlag = cli.StringFlag{
		Name:  "password",
230
		Usage: "Password file to use for non-inteactive password input",
Z
zelig 已提交
231
		Value: "",
Z
zelig 已提交
232
	}
233

234 235 236 237 238 239 240 241 242 243 244 245 246 247
	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 已提交
248
	// logging and debug settings
249 250
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
251
		Usage: "Enable metrics collection and reporting",
252
	}
253 254 255 256
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
257 258 259 260

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

330 331 332
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
333
		Usage: "Maximum number of network peers (network disabled if set to 0)",
334
		Value: 25,
335
	}
336 337 338 339 340
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
341 342 343 344 345 346 347
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
348
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
349 350 351 352 353 354 355 356 357 358 359 360
		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",
361
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
362 363
		Value: "any",
	}
364 365 366 367
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
368 369 370 371
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
372 373
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
374
		Usage: "Enable Whisper",
375
	}
376
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
377 378
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
I
Isidoro Ghezzi 已提交
379
		Usage: "JavaScript root path for `loadScript` and document root for `admin.httpGet`",
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 TestnetBootnodes
492
		}
493
		return 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 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
// 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) {
		return DiscoveryV5Bootnodes
	}
	// 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 659 660 661 662 663
func MakeNode(ctx *cli.Context, name, gitCommit string) *node.Node {
	vsn := Version
	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 699 700 701 702 703 704 705 706 707
		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.
708
func RegisterEthService(ctx *cli.Context, stack *node.Node, extra []byte) {
709 710 711 712 713 714 715 716 717 718 719
	// 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)
	}

720 721 722 723 724 725 726 727 728 729
	// initialise new random number generator
	rand := rand.New(rand.NewSource(time.Now().UnixNano()))
	// get enabled jit flag
	jitEnabled := ctx.GlobalBool(VMEnableJitFlag.Name)
	// if the jit is not enabled enable it for 10 pct of the people
	if !jitEnabled && rand.Float64() < 0.1 {
		jitEnabled = true
		glog.V(logger.Info).Infoln("You're one of the lucky few that will try out the JIT VM (random). If you get a consensus failure please be so kind to report this incident with the block hash that failed. You can switch to the regular VM by setting --jitvm=false")
	}

730
	ethConf := &eth.Config{
731
		Etherbase:               MakeEtherbase(stack.AccountManager(), ctx),
732
		ChainConfig:             MakeChainConfig(ctx, stack),
733
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
734 735 736 737
		LightMode:               ctx.GlobalBool(LightModeFlag.Name),
		LightServ:               ctx.GlobalInt(LightServFlag.Name),
		LightPeers:              ctx.GlobalInt(LightPeersFlag.Name),
		MaxPeers:                ctx.GlobalInt(MaxPeersFlag.Name),
738
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
739
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
740 741
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
742
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
743
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
744
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
745
		EnableJit:               jitEnabled,
746
		ForceJit:                ctx.GlobalBool(VMForceJitFlag.Name),
Z
zsfelfoldi 已提交
747 748 749 750 751 752 753 754 755
		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),
756
	}
757

758 759 760 761 762 763
	// 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
		}
764
		ethConf.Genesis = core.OlympicGenesisBlock()
765

766 767 768 769
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
770
		ethConf.Genesis = core.TestNetGenesisBlock()
771
		state.StartingNonce = 1048576 // (2**20)
772
		light.StartingNonce = 1048576 // (2**20)
773

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

786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
	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)
		}
803
	}
804 805 806 807 808 809 810
}

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

813 814 815 816 817 818 819 820 821 822 823 824
// 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)
	}
825
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
826 827
}

828
// MakeChainConfig reads the chain configuration from the database in ctx.Datadir.
829
func MakeChainConfig(ctx *cli.Context, stack *node.Node) *params.ChainConfig {
830
	db := MakeChainDatabase(ctx, stack)
831 832
	defer db.Close()

833
	return MakeChainConfigFromDb(ctx, db)
834 835
}

836
// MakeChainConfigFromDb reads the chain configuration from the given database.
837
func MakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig {
838
	// If the chain is already initialized, use any existing chain configs
839
	config := new(params.ChainConfig)
840

841 842
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
843
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
844 845 846 847 848 849
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
850 851 852
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
J
Jeffrey Wilcke 已提交
853 854 855 856
	// set chain id in case it's zero.
	if config.ChainId == nil {
		config.ChainId = new(big.Int)
	}
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
	// 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
			}
872
		}
873 874 875 876 877 878 879
		if config.DAOForkBlock == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.DAOForkBlock = params.TestNetDAOForkBlock
			} else {
				config.DAOForkBlock = params.MainNetDAOForkBlock
			}
			config.DAOForkSupport = true
880
		}
881 882 883 884 885 886
		if config.EIP150Block == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP150Block = params.TestNetHomesteadGasRepriceBlock
			} else {
				config.EIP150Block = params.MainNetHomesteadGasRepriceBlock
			}
887
		}
888 889 890 891 892 893
		if config.EIP150Hash == (common.Hash{}) {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.EIP150Hash = params.TestNetHomesteadGasRepriceHash
			} else {
				config.EIP150Hash = params.MainNetHomesteadGasRepriceHash
			}
894
		}
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
		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
			}
		}
		config.DAOForkSupport = true
910
	}
911

912
	// Force override any existing configs if explicitly requested
913 914
	switch {
	case ctx.GlobalBool(SupportDAOFork.Name):
915
		config.DAOForkSupport = true
916
	case ctx.GlobalBool(OpposeDAOFork.Name):
917
		config.DAOForkSupport = false
918
	}
919
	return config
920 921
}

922 923 924 925 926 927 928 929
func ChainDbName(ctx *cli.Context) string {
	if ctx.GlobalBool(LightModeFlag.Name) {
		return "lightchaindata"
	} else {
		return "chaindata"
	}
}

930
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
931
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
932 933 934
	var (
		cache   = ctx.GlobalInt(CacheFlag.Name)
		handles = MakeDatabaseHandles()
935
		name    = ChainDbName(ctx)
936
	)
937

938
	chainDb, err := stack.OpenDatabase(name, cache, handles)
939
	if err != nil {
940 941
		Fatalf("Could not open database: %v", err)
	}
942 943 944 945
	return chainDb
}

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

950
	if ctx.GlobalBool(OlympicFlag.Name) {
951
		_, err := core.WriteTestNetGenesisBlock(chainDb)
952 953 954 955
		if err != nil {
			glog.Fatalln(err)
		}
	}
956
	chainConfig := MakeChainConfigFromDb(ctx, chainDb)
957

958 959 960 961 962
	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 已提交
963 964 965
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
966
	return chain, chainDb
967
}
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984

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