flags.go 26.9 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 42
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/eth"
	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/ethereum/go-ethereum/event"
	"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/nat"
48
	"github.com/ethereum/go-ethereum/params"
49
	"github.com/ethereum/go-ethereum/pow"
50
	"github.com/ethereum/go-ethereum/rpc"
51
	"github.com/ethereum/go-ethereum/whisper"
52
	"gopkg.in/urfave/cli.v1"
53 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
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 已提交
81
// NewApp creates an app with sane defaults.
82
func NewApp(gitCommit, usage string) *cli.App {
F
Felix Lange 已提交
83
	app := cli.NewApp()
84
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
85
	app.Author = ""
O
obscuren 已提交
86
	//app.Authors = nil
F
Felix Lange 已提交
87
	app.Email = ""
88 89 90 91
	app.Version = Version
	if gitCommit != "" {
		app.Version += "-" + gitCommit[:8]
	}
F
Felix Lange 已提交
92 93 94 95
	app.Usage = usage
	return app
}

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

216 217 218 219 220 221 222 223 224 225 226 227 228 229
	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 已提交
230
	// logging and debug settings
231 232
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
233
		Usage: "Enable metrics collection and reporting",
234
	}
235 236 237 238
	FakePoWFlag = cli.BoolFlag{
		Name:  "fakepow",
		Usage: "Disables proof-of-work verification",
	}
239 240 241 242

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

312 313 314
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
315
		Usage: "Maximum number of network peers (network disabled if set to 0)",
316
		Value: 25,
317
	}
318 319 320 321 322
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
323 324 325 326 327 328 329
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
330
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
331 332 333 334 335 336 337 338 339 340 341 342
		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",
343
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
344 345
		Value: "any",
	}
346 347 348 349
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
350 351
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
352
		Usage: "Enable Whisper",
353
	}
354
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
355 356
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
I
Isidoro Ghezzi 已提交
357
		Usage: "JavaScript root path for `loadScript` and document root for `admin.httpGet`",
Z
CLI:  
zelig 已提交
358 359
		Value: ".",
	}
360 361
	SolcPathFlag = cli.StringFlag{
		Name:  "solc",
362
		Usage: "Solidity compiler command to be used",
363 364
		Value: "solc",
	}
365 366

	// Gas price oracle settings
Z
zsfelfoldi 已提交
367 368 369
	GpoMinGasPriceFlag = cli.StringFlag{
		Name:  "gpomin",
		Usage: "Minimum suggested gas price",
370
		Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(),
Z
zsfelfoldi 已提交
371 372 373 374
	}
	GpoMaxGasPriceFlag = cli.StringFlag{
		Name:  "gpomax",
		Usage: "Maximum suggested gas price",
375
		Value: new(big.Int).Mul(big.NewInt(500), common.Shannon).String(),
Z
zsfelfoldi 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
	}
	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,
	}
397 398
)

399
// MakeDataDir retrieves the currently requested data directory, terminating
400 401
// 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.
402
func MakeDataDir(ctx *cli.Context) string {
403
	if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
404
		// TODO: choose a different location outside of the regular datadir.
405
		if ctx.GlobalBool(TestNetFlag.Name) {
406
			return filepath.Join(path, "testnet")
407 408
		}
		return path
409
	}
410 411
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
	return ""
412 413
}

414
// MakeIPCPath creates an IPC path configuration from the set command line flags,
415
// returning an empty string if IPC was explicitly disabled, or the set path.
416
func MakeIPCPath(ctx *cli.Context) string {
417 418 419 420 421 422
	if ctx.GlobalBool(IPCDisabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(IPCPathFlag.Name)
}

423 424 425 426 427 428 429 430 431 432 433
// 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
	)
434 435 436
	switch {
	case file != "" && hex != "":
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
437

438 439 440 441
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
		}
442

443 444 445 446 447 448 449 450
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
		}
	}
	return key
}

451 452 453
// makeNodeUserIdent creates the user identifier from CLI flags.
func makeNodeUserIdent(ctx *cli.Context) string {
	var comps []string
454
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
455
		comps = append(comps, identity)
456 457
	}
	if ctx.GlobalBool(VMEnableJitFlag.Name) {
458
		comps = append(comps, "JIT")
459
	}
460
	return strings.Join(comps, "/")
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
}

// 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) {
			return TestNetBootNodes
		}
		return FrontierBootNodes
	}
	// 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
}

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

// 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))
496
	if err != nil {
497 498 499 500 501
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

502 503 504 505 506 507 508 509 510 511
// 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
}

512
// MakeHTTPRpcHost creates the HTTP RPC listener interface string from the set
513
// command line flags, returning empty if the HTTP endpoint is disabled.
514
func MakeHTTPRpcHost(ctx *cli.Context) string {
515 516 517 518 519 520
	if !ctx.GlobalBool(RPCEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(RPCListenAddrFlag.Name)
}

521
// MakeWSRpcHost creates the WebSocket RPC listener interface string from the set
522
// command line flags, returning empty if the HTTP endpoint is disabled.
523
func MakeWSRpcHost(ctx *cli.Context) string {
524 525 526 527 528 529
	if !ctx.GlobalBool(WSEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(WSListenAddrFlag.Name)
}

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
// 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
}

546 547
// 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 已提交
548
func MakeAddress(accman *accounts.Manager, account string) (accounts.Account, error) {
549 550
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
551
		return accounts.Account{Address: common.HexToAddress(account)}, nil
552 553 554 555
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
F
Felix Lange 已提交
556
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
557
	}
F
Felix Lange 已提交
558
	return accman.AccountByIndex(index)
559 560 561 562 563
}

// 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 已提交
564
	accounts := accman.Accounts()
565
	if !ctx.GlobalIsSet(EtherbaseFlag.Name) && len(accounts) == 0 {
566
		glog.V(logger.Error).Infoln("WARNING: No etherbase set and no accounts found as default")
567 568
		return common.Address{}
	}
569 570 571
	etherbase := ctx.GlobalString(EtherbaseFlag.Name)
	if etherbase == "" {
		return common.Address{}
572
	}
573
	// If the specified etherbase is a valid address, return it
F
Felix Lange 已提交
574
	account, err := MakeAddress(accman, etherbase)
575
	if err != nil {
576
		Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
577
	}
F
Felix Lange 已提交
578
	return account.Address
579 580 581 582 583 584 585
}

// 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))
586
	}
587 588 589
	return extra
}

590
// MakePasswordList reads password lines from the file specified by --password.
591
func MakePasswordList(ctx *cli.Context) []string {
592 593 594 595 596 597 598 599 600 601 602 603
	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")
604
	}
605
	return lines
606 607
}

608
// MakeNode configures a node with no services from command line flags.
609 610 611 612 613 614
func MakeNode(ctx *cli.Context, name, gitCommit string) *node.Node {
	vsn := Version
	if gitCommit != "" {
		vsn += "-" + gitCommit[:8]
	}

615
	config := &node.Config{
616
		DataDir:           MakeDataDir(ctx),
617 618 619
		KeyStoreDir:       ctx.GlobalString(KeyStoreDirFlag.Name),
		UseLightweightKDF: ctx.GlobalBool(LightKDFFlag.Name),
		PrivateKey:        MakeNodeKey(ctx),
620 621 622
		Name:              name,
		Version:           vsn,
		UserIdent:         makeNodeUserIdent(ctx),
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
		NoDiscovery:       ctx.GlobalBool(NoDiscoverFlag.Name),
		BootstrapNodes:    MakeBootstrapNodes(ctx),
		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.
656
func RegisterEthService(ctx *cli.Context, stack *node.Node, extra []byte) {
657 658 659 660 661 662 663 664 665 666 667
	// 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)
	}

668 669 670 671 672 673 674 675 676 677
	// 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")
	}

678
	ethConf := &eth.Config{
679
		Etherbase:               MakeEtherbase(stack.AccountManager(), ctx),
680
		ChainConfig:             MakeChainConfig(ctx, stack),
681
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
682
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
683
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
684 685
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
686
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
687
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
688
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
689
		EnableJit:               jitEnabled,
690
		ForceJit:                ctx.GlobalBool(VMForceJitFlag.Name),
Z
zsfelfoldi 已提交
691 692 693 694 695 696 697 698 699
		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),
700
	}
701

702 703 704 705 706 707
	// 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
		}
708
		ethConf.Genesis = core.OlympicGenesisBlock()
709

710 711 712 713
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
714
		ethConf.Genesis = core.TestNetGenesisBlock()
715
		state.StartingNonce = 1048576 // (2**20)
716

717
	case ctx.GlobalBool(DevModeFlag.Name):
718
		ethConf.Genesis = core.OlympicGenesisBlock()
719 720
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
721
		}
722
		ethConf.PowTest = true
723
	}
724

725
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
726 727 728 729
		return eth.New(ctx, ethConf)
	}); err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
	}
730 731 732 733 734 735 736
}

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

739 740 741 742 743 744 745 746 747 748 749 750
// 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)
	}
751
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
752 753
}

754 755 756
// MakeChainConfig reads the chain configuration from the database in ctx.Datadir.
func MakeChainConfig(ctx *cli.Context, stack *node.Node) *core.ChainConfig {
	db := MakeChainDatabase(ctx, stack)
757 758
	defer db.Close()

759
	return MakeChainConfigFromDb(ctx, db)
760 761
}

762 763
// MakeChainConfigFromDb reads the chain configuration from the given database.
func MakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *core.ChainConfig {
764
	// If the chain is already initialized, use any existing chain configs
765 766
	config := new(core.ChainConfig)

767 768
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
769
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
770 771 772 773 774 775
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
776 777 778
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
779 780 781
	// Set any missing fields due to them being unset or system upgrade
	if config.HomesteadBlock == nil {
		if ctx.GlobalBool(TestNetFlag.Name) {
782
			config.HomesteadBlock = params.TestNetHomesteadBlock
783
		} else {
784
			config.HomesteadBlock = params.MainNetHomesteadBlock
785
		}
786
	}
787 788
	if config.DAOForkBlock == nil {
		if ctx.GlobalBool(TestNetFlag.Name) {
789
			config.DAOForkBlock = params.TestNetDAOForkBlock
790
		} else {
791
			config.DAOForkBlock = params.MainNetDAOForkBlock
792
		}
793
		config.DAOForkSupport = true
794 795
	}
	// Force override any existing configs if explicitly requested
796 797
	switch {
	case ctx.GlobalBool(SupportDAOFork.Name):
798
		config.DAOForkSupport = true
799
	case ctx.GlobalBool(OpposeDAOFork.Name):
800
		config.DAOForkSupport = false
801
	}
802
	return config
803 804
}

805
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
806
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
807 808 809 810
	var (
		cache   = ctx.GlobalInt(CacheFlag.Name)
		handles = MakeDatabaseHandles()
	)
811

812
	chainDb, err := stack.OpenDatabase("chaindata", cache, handles)
813
	if err != nil {
814 815
		Fatalf("Could not open database: %v", err)
	}
816 817 818 819
	return chainDb
}

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

824
	if ctx.GlobalBool(OlympicFlag.Name) {
825
		_, err := core.WriteTestNetGenesisBlock(chainDb)
826 827 828 829
		if err != nil {
			glog.Fatalln(err)
		}
	}
830
	chainConfig := MakeChainConfigFromDb(ctx, chainDb)
831

832 833 834 835 836
	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 已提交
837 838 839
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
840
	return chain, chainDb
841
}
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

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