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

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

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

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

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

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

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

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

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

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

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

472 473 474
// makeNodeUserIdent creates the user identifier from CLI flags.
func makeNodeUserIdent(ctx *cli.Context) string {
	var comps []string
475
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
476
		comps = append(comps, identity)
477 478
	}
	if ctx.GlobalBool(VMEnableJitFlag.Name) {
479
		comps = append(comps, "JIT")
480
	}
481
	return strings.Join(comps, "/")
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
}

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

514 515 516 517
func MakeListenAddressV5(ctx *cli.Context) string {
	return fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name)+1)
}

518 519 520
// 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))
521
	if err != nil {
522 523 524 525 526
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

527 528 529 530 531 532 533 534 535 536
// 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
}

537
// MakeHTTPRpcHost creates the HTTP RPC listener interface string from the set
538
// command line flags, returning empty if the HTTP endpoint is disabled.
539
func MakeHTTPRpcHost(ctx *cli.Context) string {
540 541 542 543 544 545
	if !ctx.GlobalBool(RPCEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(RPCListenAddrFlag.Name)
}

546
// MakeWSRpcHost creates the WebSocket RPC listener interface string from the set
547
// command line flags, returning empty if the HTTP endpoint is disabled.
548
func MakeWSRpcHost(ctx *cli.Context) string {
549 550 551 552 553 554
	if !ctx.GlobalBool(WSEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(WSListenAddrFlag.Name)
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
// 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
}

571 572
// 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 已提交
573
func MakeAddress(accman *accounts.Manager, account string) (accounts.Account, error) {
574 575
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
F
Felix Lange 已提交
576
		return accounts.Account{Address: common.HexToAddress(account)}, nil
577 578 579 580
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
F
Felix Lange 已提交
581
		return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
582
	}
F
Felix Lange 已提交
583
	return accman.AccountByIndex(index)
584 585 586 587 588
}

// 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 已提交
589
	accounts := accman.Accounts()
590
	if !ctx.GlobalIsSet(EtherbaseFlag.Name) && len(accounts) == 0 {
591
		glog.V(logger.Error).Infoln("WARNING: No etherbase set and no accounts found as default")
592 593
		return common.Address{}
	}
594 595 596
	etherbase := ctx.GlobalString(EtherbaseFlag.Name)
	if etherbase == "" {
		return common.Address{}
597
	}
598
	// If the specified etherbase is a valid address, return it
F
Felix Lange 已提交
599
	account, err := MakeAddress(accman, etherbase)
600
	if err != nil {
601
		Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
602
	}
F
Felix Lange 已提交
603
	return account.Address
604 605 606 607 608 609 610
}

// 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))
611
	}
612 613 614
	return extra
}

615
// MakePasswordList reads password lines from the file specified by --password.
616
func MakePasswordList(ctx *cli.Context) []string {
617 618 619 620 621 622 623 624 625 626 627 628
	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")
629
	}
630
	return lines
631 632
}

633
// MakeNode configures a node with no services from command line flags.
634 635 636 637 638 639
func MakeNode(ctx *cli.Context, name, gitCommit string) *node.Node {
	vsn := Version
	if gitCommit != "" {
		vsn += "-" + gitCommit[:8]
	}

640
	config := &node.Config{
641
		DataDir:           MakeDataDir(ctx),
642 643 644
		KeyStoreDir:       ctx.GlobalString(KeyStoreDirFlag.Name),
		UseLightweightKDF: ctx.GlobalBool(LightKDFFlag.Name),
		PrivateKey:        MakeNodeKey(ctx),
645 646 647
		Name:              name,
		Version:           vsn,
		UserIdent:         makeNodeUserIdent(ctx),
648 649
		NoDiscovery:       ctx.GlobalBool(NoDiscoverFlag.Name) || ctx.GlobalBool(LightModeFlag.Name),
		DiscoveryV5:       ctx.GlobalBool(DiscoveryV5Flag.Name) || ctx.GlobalBool(LightModeFlag.Name) || ctx.GlobalInt(LightServFlag.Name) > 0,
650 651
		BootstrapNodes:    MakeBootstrapNodes(ctx),
		ListenAddr:        MakeListenAddress(ctx),
652
		ListenAddrV5:      MakeListenAddressV5(ctx),
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
		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.
683
func RegisterEthService(ctx *cli.Context, stack *node.Node, extra []byte) {
684 685 686 687 688 689 690 691 692 693 694
	// 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)
	}

695 696 697 698 699 700 701 702 703 704
	// 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")
	}

705
	ethConf := &eth.Config{
706
		Etherbase:               MakeEtherbase(stack.AccountManager(), ctx),
707
		ChainConfig:             MakeChainConfig(ctx, stack),
708
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
709 710 711 712
		LightMode:               ctx.GlobalBool(LightModeFlag.Name),
		LightServ:               ctx.GlobalInt(LightServFlag.Name),
		LightPeers:              ctx.GlobalInt(LightPeersFlag.Name),
		MaxPeers:                ctx.GlobalInt(MaxPeersFlag.Name),
713
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
714
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
715 716
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
717
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
718
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
719
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
720
		EnableJit:               jitEnabled,
721
		ForceJit:                ctx.GlobalBool(VMForceJitFlag.Name),
Z
zsfelfoldi 已提交
722 723 724 725 726 727 728 729 730
		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),
731
	}
732

733 734 735 736 737 738
	// 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
		}
739
		ethConf.Genesis = core.OlympicGenesisBlock()
740

741 742 743 744
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
745
		ethConf.Genesis = core.TestNetGenesisBlock()
746
		state.StartingNonce = 1048576 // (2**20)
747
		light.StartingNonce = 1048576 // (2**20)
748

749
	case ctx.GlobalBool(DevModeFlag.Name):
750
		ethConf.Genesis = core.OlympicGenesisBlock()
751 752
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
753
		}
754
		ethConf.PowTest = true
755
	}
756 757 758 759
	// Override any global options pertaining to the Ethereum protocol
	if gen := ctx.GlobalInt(TrieCacheGenFlag.Name); gen > 0 {
		state.MaxTrieCacheGen = uint16(gen)
	}
760

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
	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)
		}
778
	}
779 780 781 782 783 784 785
}

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

788 789 790 791 792 793 794 795 796 797 798 799
// 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)
	}
800
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
801 802
}

803
// MakeChainConfig reads the chain configuration from the database in ctx.Datadir.
804
func MakeChainConfig(ctx *cli.Context, stack *node.Node) *params.ChainConfig {
805
	db := MakeChainDatabase(ctx, stack)
806 807
	defer db.Close()

808
	return MakeChainConfigFromDb(ctx, db)
809 810
}

811
// MakeChainConfigFromDb reads the chain configuration from the given database.
812
func MakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig {
813
	// If the chain is already initialized, use any existing chain configs
814
	config := new(params.ChainConfig)
815

816 817
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
818
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
819 820 821 822 823 824
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
825 826 827
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
J
Jeffrey Wilcke 已提交
828 829 830 831
	// set chain id in case it's zero.
	if config.ChainId == nil {
		config.ChainId = new(big.Int)
	}
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
	// 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
			}
847
		}
848 849 850 851 852 853 854
		if config.DAOForkBlock == nil {
			if ctx.GlobalBool(TestNetFlag.Name) {
				config.DAOForkBlock = params.TestNetDAOForkBlock
			} else {
				config.DAOForkBlock = params.MainNetDAOForkBlock
			}
			config.DAOForkSupport = true
855
		}
856 857 858 859 860 861 862
		config.DAOForkSupport = true
	}
	if config.EIP150Block == nil {
		if ctx.GlobalBool(TestNetFlag.Name) {
			config.EIP150Block = params.TestNetHomesteadGasRepriceBlock
		} else {
			config.EIP150Block = params.MainNetHomesteadGasRepriceBlock
863
		}
864 865 866 867 868 869
	}
	if config.EIP150Hash == (common.Hash{}) {
		if ctx.GlobalBool(TestNetFlag.Name) {
			config.EIP150Hash = params.TestNetHomesteadGasRepriceHash
		} else {
			config.EIP150Hash = params.MainNetHomesteadGasRepriceHash
870 871
		}
	}
872
	// Force override any existing configs if explicitly requested
873 874
	switch {
	case ctx.GlobalBool(SupportDAOFork.Name):
875
		config.DAOForkSupport = true
876
	case ctx.GlobalBool(OpposeDAOFork.Name):
877
		config.DAOForkSupport = false
878
	}
879
	return config
880 881
}

882 883 884 885 886 887 888 889
func ChainDbName(ctx *cli.Context) string {
	if ctx.GlobalBool(LightModeFlag.Name) {
		return "lightchaindata"
	} else {
		return "chaindata"
	}
}

890
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
891
func MakeChainDatabase(ctx *cli.Context, stack *node.Node) ethdb.Database {
892 893 894
	var (
		cache   = ctx.GlobalInt(CacheFlag.Name)
		handles = MakeDatabaseHandles()
895
		name    = ChainDbName(ctx)
896
	)
897

898
	chainDb, err := stack.OpenDatabase(name, cache, handles)
899
	if err != nil {
900 901
		Fatalf("Could not open database: %v", err)
	}
902 903 904 905
	return chainDb
}

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

910
	if ctx.GlobalBool(OlympicFlag.Name) {
911
		_, err := core.WriteTestNetGenesisBlock(chainDb)
912 913 914 915
		if err != nil {
			glog.Fatalln(err)
		}
	}
916
	chainConfig := MakeChainConfigFromDb(ctx, chainDb)
917

918 919 920 921 922
	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 已提交
923 924 925
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
926
	return chain, chainDb
927
}
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944

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