flags.go 29.3 KB
Newer Older
F
Felix Lange 已提交
1 2 3 4 5 6 7 8 9 10
// Copyright 2015 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
F
Felix Lange 已提交
12 13 14
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
15
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
F
Felix Lange 已提交
16

17 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/release"
51
	"github.com/ethereum/go-ethereum/rpc"
52
	"github.com/ethereum/go-ethereum/whisper"
53
	"gopkg.in/urfave/cli.v1"
54 55
)

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
func init() {
	cli.AppHelpTemplate = `{{.Name}} {{if .Flags}}[global options] {{end}}command{{if .Flags}} [command options]{{end}} [arguments...]

VERSION:
   {{.Version}}

COMMANDS:
   {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
   {{end}}{{if .Flags}}
GLOBAL OPTIONS:
   {{range .Flags}}{{.}}
   {{end}}{{end}}
`

	cli.CommandHelpTemplate = `{{.Name}}{{if .Subcommands}} command{{end}}{{if .Flags}} [command options]{{end}} [arguments...]
{{if .Description}}{{.Description}}
{{end}}{{if .Subcommands}}
SUBCOMMANDS:
	{{range .Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
	{{end}}{{end}}{{if .Flags}}
OPTIONS:
	{{range .Flags}}{{.}}
	{{end}}{{end}}
`
}

F
Felix Lange 已提交
82 83 84
// NewApp creates an app with sane defaults.
func NewApp(version, usage string) *cli.App {
	app := cli.NewApp()
85
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
86
	app.Author = ""
O
obscuren 已提交
87
	//app.Authors = nil
F
Felix Lange 已提交
88 89 90 91 92 93
	app.Email = ""
	app.Version = version
	app.Usage = usage
	return app
}

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

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

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

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

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

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

K
Kobi Gurkan 已提交
416 417 418 419 420 421 422 423 424 425
// MakeKeyStoreDir resolves the folder to use for storing the account keys from the
// set command line flags, returning the explicitly requested path, or one inside
// the data directory otherwise.
func MakeKeyStoreDir(datadir string, ctx *cli.Context) string {
	if path := ctx.GlobalString(KeyStoreDirFlag.Name); path != "" {
		return path
	}
	return filepath.Join(datadir, "keystore")
}

426
// MakeIPCPath creates an IPC path configuration from the set command line flags,
427
// returning an empty string if IPC was explicitly disabled, or the set path.
428
func MakeIPCPath(ctx *cli.Context) string {
429 430 431 432 433 434
	if ctx.GlobalBool(IPCDisabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(IPCPathFlag.Name)
}

435 436 437 438 439 440 441 442 443 444 445
// 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
	)
446 447 448
	switch {
	case file != "" && hex != "":
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
449

450 451 452 453
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
		}
454

455 456 457 458 459 460 461 462
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
		}
	}
	return key
}

463 464 465 466 467 468 469 470
// MakeNodeName creates a node name from a base set and the command line flags.
func MakeNodeName(client, version string, ctx *cli.Context) string {
	name := common.MakeName(client, version)
	if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
		name += "/" + identity
	}
	if ctx.GlobalBool(VMEnableJitFlag.Name) {
		name += "/JIT"
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 496 497 498 499 500 501 502 503 504 505 506 507
	return name
}

// 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))
508
	if err != nil {
509 510 511 512 513
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

514 515 516 517 518 519 520 521 522 523
// 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
}

524
// MakeHTTPRpcHost creates the HTTP RPC listener interface string from the set
525
// command line flags, returning empty if the HTTP endpoint is disabled.
526
func MakeHTTPRpcHost(ctx *cli.Context) string {
527 528 529 530 531 532
	if !ctx.GlobalBool(RPCEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(RPCListenAddrFlag.Name)
}

533
// MakeWSRpcHost creates the WebSocket RPC listener interface string from the set
534
// command line flags, returning empty if the HTTP endpoint is disabled.
535
func MakeWSRpcHost(ctx *cli.Context) string {
536 537 538 539 540 541
	if !ctx.GlobalBool(WSEnabledFlag.Name) {
		return ""
	}
	return ctx.GlobalString(WSListenAddrFlag.Name)
}

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
// 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
}

558 559 560
// MakeAccountManager creates an account manager from set command line flags.
func MakeAccountManager(ctx *cli.Context) *accounts.Manager {
	// Create the keystore crypto primitive, light if requested
561 562
	scryptN := accounts.StandardScryptN
	scryptP := accounts.StandardScryptP
563
	if ctx.GlobalBool(LightKDFFlag.Name) {
564 565
		scryptN = accounts.LightScryptN
		scryptP = accounts.LightScryptP
566
	}
567 568 569
	datadir := MustMakeDataDir(ctx)
	keydir := MakeKeyStoreDir(datadir, ctx)
	return accounts.NewManager(keydir, scryptN, scryptP)
570 571 572 573
}

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

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

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

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

// MakeSystemNode sets up a local node, configures the services to launch and
// assembles the P2P protocol stack.
636
func MakeSystemNode(name, version string, relconf release.Config, extra []byte, ctx *cli.Context) *node.Node {
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
	// 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)
	}
	// Configure the node's service container
	stackConf := &node.Config{
		DataDir:         MustMakeDataDir(ctx),
		PrivateKey:      MakeNodeKey(ctx),
		Name:            MakeNodeName(name, version, ctx),
		NoDiscovery:     ctx.GlobalBool(NoDiscoverFlag.Name),
		BootstrapNodes:  MakeBootstrapNodes(ctx),
		ListenAddr:      MakeListenAddress(ctx),
		NAT:             MakeNAT(ctx),
		MaxPeers:        ctx.GlobalInt(MaxPeersFlag.Name),
		MaxPendingPeers: ctx.GlobalInt(MaxPendingPeersFlag.Name),
658 659 660 661
		IPCPath:         MakeIPCPath(ctx),
		HTTPHost:        MakeHTTPRpcHost(ctx),
		HTTPPort:        ctx.GlobalInt(RPCPortFlag.Name),
		HTTPCors:        ctx.GlobalString(RPCCORSDomainFlag.Name),
662
		HTTPModules:     MakeRPCModules(ctx.GlobalString(RPCApiFlag.Name)),
663 664
		WSHost:          MakeWSRpcHost(ctx),
		WSPort:          ctx.GlobalInt(WSPortFlag.Name),
B
Bas van Kervel 已提交
665
		WSOrigins:       ctx.GlobalString(WSAllowedOriginsFlag.Name),
666
		WSModules:       MakeRPCModules(ctx.GlobalString(WSApiFlag.Name)),
667 668 669 670
	}
	// Configure the Ethereum service
	accman := MakeAccountManager(ctx)

671 672 673 674 675 676 677 678 679 680
	// 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")
	}

681
	ethConf := &eth.Config{
682
		ChainConfig:             MustMakeChainConfig(ctx),
683
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
Z
zsfelfoldi 已提交
684
		BlockChainVersion:       ctx.GlobalInt(BlockchainVersionFlag.Name),
685
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
686
		DatabaseHandles:         MakeDatabaseHandles(),
Z
zsfelfoldi 已提交
687
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
688 689
		AccountManager:          accman,
		Etherbase:               MakeEtherbase(accman, ctx),
Z
zsfelfoldi 已提交
690
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
691
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
692
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
693
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
694
		EnableJit:               jitEnabled,
695
		ForceJit:                ctx.GlobalBool(VMForceJitFlag.Name),
Z
zsfelfoldi 已提交
696 697 698 699 700 701 702 703 704
		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),
705
	}
706 707
	// Configure the Whisper service
	shhEnable := ctx.GlobalBool(WhisperEnabledFlag.Name)
708

709 710 711 712 713 714
	// 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
		}
715
		ethConf.Genesis = core.OlympicGenesisBlock()
716

717 718 719 720
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
721
		ethConf.Genesis = core.TestNetGenesisBlock()
722
		state.StartingNonce = 1048576 // (2**20)
723

724 725 726 727
	case ctx.GlobalBool(DevModeFlag.Name):
		// Override the base network stack configs
		if !ctx.GlobalIsSet(DataDirFlag.Name) {
			stackConf.DataDir = filepath.Join(os.TempDir(), "/ethereum_dev_mode")
728 729
		}
		if !ctx.GlobalIsSet(MaxPeersFlag.Name) {
730
			stackConf.MaxPeers = 0
731 732
		}
		if !ctx.GlobalIsSet(ListenPortFlag.Name) {
733 734 735
			stackConf.ListenAddr = ":0"
		}
		// Override the Ethereum protocol configs
736
		ethConf.Genesis = core.OlympicGenesisBlock()
737 738
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
739 740
		}
		if !ctx.GlobalIsSet(WhisperEnabledFlag.Name) {
741
			shhEnable = true
742
		}
743
		ethConf.PowTest = true
744
	}
745 746 747 748 749
	// Assemble and return the protocol stack
	stack, err := node.New(stackConf)
	if err != nil {
		Fatalf("Failed to create the protocol stack: %v", err)
	}
750 751 752 753 754 755 756

	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
		return accman, nil
	}); err != nil {
		Fatalf("Failed to register the account manager service: %v", err)
	}

757
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
758 759 760 761 762
		return eth.New(ctx, ethConf)
	}); err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
	}
	if shhEnable {
763
		if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
764 765 766
			Fatalf("Failed to register the Whisper service: %v", err)
		}
	}
767 768 769 770
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
		return release.NewReleaseService(ctx, relconf)
	}); err != nil {
		Fatalf("Failed to register the Geth release oracle service: %v", err)
771
	}
772
	return stack
773 774
}

775 776 777 778 779 780 781 782 783 784 785 786
// 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)
	}
787
	params.TargetGasLimit = common.String2Big(ctx.GlobalString(TargetGasLimitFlag.Name))
788 789
}

790
// MustMakeChainConfig reads the chain configuration from the database in ctx.Datadir.
791
func MustMakeChainConfig(ctx *cli.Context) *core.ChainConfig {
792
	db := MakeChainDatabase(ctx)
793 794
	defer db.Close()

795 796 797 798 799
	return MustMakeChainConfigFromDb(ctx, db)
}

// MustMakeChainConfigFromDb reads the chain configuration from the given database.
func MustMakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *core.ChainConfig {
800
	// If the chain is already initialized, use any existing chain configs
801 802
	config := new(core.ChainConfig)

803 804
	genesis := core.GetBlock(db, core.GetCanonicalHash(db, 0), 0)
	if genesis != nil {
805
		storedConfig, err := core.GetChainConfig(db, genesis.Hash())
806 807 808 809 810 811
		switch err {
		case nil:
			config = storedConfig
		case core.ChainConfigNotFoundErr:
			// No configs found, use empty, will populate below
		default:
812 813 814
			Fatalf("Could not make chain configuration: %v", err)
		}
	}
815 816 817
	// Set any missing fields due to them being unset or system upgrade
	if config.HomesteadBlock == nil {
		if ctx.GlobalBool(TestNetFlag.Name) {
818
			config.HomesteadBlock = params.TestNetHomesteadBlock
819
		} else {
820
			config.HomesteadBlock = params.MainNetHomesteadBlock
821
		}
822
	}
823 824
	if config.DAOForkBlock == nil {
		if ctx.GlobalBool(TestNetFlag.Name) {
825
			config.DAOForkBlock = params.TestNetDAOForkBlock
826
		} else {
827
			config.DAOForkBlock = params.MainNetDAOForkBlock
828
		}
829
		config.DAOForkSupport = true
830 831
	}
	// Force override any existing configs if explicitly requested
832 833
	switch {
	case ctx.GlobalBool(SupportDAOFork.Name):
834
		config.DAOForkSupport = true
835
	case ctx.GlobalBool(OpposeDAOFork.Name):
836
		config.DAOForkSupport = false
837
	}
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
	// Temporarilly display a proper message so the user knows which fork its on
	if !ctx.GlobalBool(TestNetFlag.Name) && (genesis == nil || genesis.Hash() == common.HexToHash("0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3")) {
		choice := "SUPPORT"
		if !config.DAOForkSupport {
			choice = "OPPOSE"
		}
		current := fmt.Sprintf("Geth is currently configured to %s the DAO hard-fork!", choice)
		howtoswap := fmt.Sprintf("You can change your choice prior to block #%v with --support-dao-fork or --oppose-dao-fork.", config.DAOForkBlock)
		howtosync := fmt.Sprintf("After the hard-fork block #%v passed, changing chains requires a resync from scratch!", config.DAOForkBlock)
		separator := strings.Repeat("-", len(howtoswap))

		glog.V(logger.Warn).Info(separator)
		glog.V(logger.Warn).Info(current)
		glog.V(logger.Warn).Info(howtoswap)
		glog.V(logger.Warn).Info(howtosync)
		glog.V(logger.Warn).Info(separator)
	}
855
	return config
856 857
}

858 859 860 861 862 863 864
// MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
func MakeChainDatabase(ctx *cli.Context) ethdb.Database {
	var (
		datadir = MustMakeDataDir(ctx)
		cache   = ctx.GlobalInt(CacheFlag.Name)
		handles = MakeDatabaseHandles()
	)
865

866 867
	chainDb, err := ethdb.NewLDBDatabase(filepath.Join(datadir, "chaindata"), cache, handles)
	if err != nil {
868 869
		Fatalf("Could not open database: %v", err)
	}
870 871 872 873 874 875 876 877
	return chainDb
}

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

878
	if ctx.GlobalBool(OlympicFlag.Name) {
879
		_, err := core.WriteTestNetGenesisBlock(chainDb)
880 881 882 883
		if err != nil {
			glog.Fatalln(err)
		}
	}
884
	chainConfig := MustMakeChainConfigFromDb(ctx, chainDb)
885

886 887 888 889 890
	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 已提交
891 892 893
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}
894
	return chain, chainDb
895
}
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912

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