flags.go 26.5 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
	"log"
24
	"math"
25
	"math/big"
26
	"net/http"
27
	"os"
28
	"path/filepath"
29
	"runtime"
30
	"strconv"
31
	"strings"
32

33 34
	"errors"

35
	"github.com/codegangsta/cli"
36
	"github.com/ethereum/ethash"
F
Felix Lange 已提交
37
	"github.com/ethereum/go-ethereum/accounts"
Z
zelig 已提交
38
	"github.com/ethereum/go-ethereum/common"
39
	"github.com/ethereum/go-ethereum/core"
40
	"github.com/ethereum/go-ethereum/core/state"
B
Bas van Kervel 已提交
41
	"github.com/ethereum/go-ethereum/core/vm"
42 43 44 45 46
	"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 已提交
47
	"github.com/ethereum/go-ethereum/logger/glog"
B
Bas van Kervel 已提交
48
	"github.com/ethereum/go-ethereum/metrics"
49 50
	"github.com/ethereum/go-ethereum/node"
	"github.com/ethereum/go-ethereum/p2p/discover"
51
	"github.com/ethereum/go-ethereum/p2p/nat"
52
	"github.com/ethereum/go-ethereum/params"
53
	"github.com/ethereum/go-ethereum/rpc"
54
	"github.com/ethereum/go-ethereum/whisper"
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 84 85
// NewApp creates an app with sane defaults.
func NewApp(version, usage string) *cli.App {
	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 90 91 92 93 94
	app.Email = ""
	app.Version = version
	app.Usage = usage
	return app
}

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

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
	// vm flags
	VMDebugFlag = cli.BoolFlag{
		Name:  "vmdebug",
		Usage: "Virtual Machine debug output",
	}
	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 已提交
225
	// logging and debug settings
226 227
	VerbosityFlag = cli.IntFlag{
		Name:  "verbosity",
228
		Usage: "Logging verbosity: 0-6 (0=silent, 1=error, 2=warn, 3=info, 4=core, 5=debug, 6=debug detail)",
229 230
		Value: int(logger.InfoLevel),
	}
231 232 233
	LogFileFlag = cli.StringFlag{
		Name:  "logfile",
		Usage: "Log output file within the data dir (default = no log file generated)",
234
		Value: "",
235
	}
236 237
	LogVModuleFlag = cli.GenericFlag{
		Name:  "vmodule",
238
		Usage: "Per-module verbosity: comma-separated list of <module>=<level>, where <module> is file literal or a glog pattern",
239 240 241
		Value: glog.GetVModule(),
	}
	BacktraceAtFlag = cli.GenericFlag{
242 243
		Name:  "backtrace",
		Usage: "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")",
244 245
		Value: glog.GetTraceLocation(),
	}
246 247
	PProfEanbledFlag = cli.BoolFlag{
		Name:  "pprof",
248
		Usage: "Enable the profiling server on localhost",
249 250 251
	}
	PProfPortFlag = cli.IntFlag{
		Name:  "pprofport",
252
		Usage: "Profile server listening port",
253 254
		Value: 6060,
	}
255 256
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  metrics.MetricsEnabledFlag,
257
		Usage: "Enable metrics collection and reporting",
258
	}
259 260 261 262

	// RPC settings
	RPCEnabledFlag = cli.BoolFlag{
		Name:  "rpc",
263
		Usage: "Enable the HTTP-RPC server",
264 265 266
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
267
		Usage: "HTTP-RPC server listening interface",
268 269 270 271
		Value: "127.0.0.1",
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
272
		Usage: "HTTP-RPC server listening port",
273 274
		Value: 8545,
	}
275 276
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
277
		Usage: "Domains from which to accept cross origin requests (browser enforced)",
278 279
		Value: "",
	}
280
	RPCApiFlag = cli.StringFlag{
281
		Name:  "rpcapi",
282
		Usage: "API's offered over the HTTP-RPC interface",
283
		Value: rpc.DefaultHttpRpcApis,
284
	}
B
Bas van Kervel 已提交
285 286 287 288 289 290
	IPCDisabledFlag = cli.BoolFlag{
		Name:  "ipcdisable",
		Usage: "Disable the IPC-RPC server",
	}
	IPCApiFlag = cli.StringFlag{
		Name:  "ipcapi",
291
		Usage: "API's offered over the IPC-RPC interface",
292
		Value: rpc.DefaultIpcApis,
B
Bas van Kervel 已提交
293 294 295 296 297 298
	}
	IPCPathFlag = DirectoryFlag{
		Name:  "ipcpath",
		Usage: "Filename for IPC socket/pipe",
		Value: DirectoryString{common.DefaultIpcPath()},
	}
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
	WSEnabledFlag = cli.BoolFlag{
		Name: "ws",
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
		Value: "127.0.0.1",
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
		Value: 8546,
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
		Value: rpc.DefaultHttpRpcApis,
	}
	WSAllowedDomainsFlag = cli.StringFlag{
		Name:  "wsdomains",
		Usage: "Domains from which to accept websockets requests",
		Value: "",
322
	}
323 324
	ExecFlag = cli.StringFlag{
		Name:  "exec",
325
		Usage: "Execute JavaScript statement (only in combination with console/attach)",
326
	}
327 328 329
	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
330
		Usage: "Maximum number of network peers (network disabled if set to 0)",
331
		Value: 25,
332
	}
333 334 335 336 337
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
338 339 340 341 342 343 344
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 30303,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
345
		Usage: "Comma separated enode URLs for P2P discovery bootstrap",
346 347 348 349 350 351 352 353 354 355 356 357
		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",
358
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
359 360
		Value: "any",
	}
361 362 363 364
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
365 366
	WhisperEnabledFlag = cli.BoolFlag{
		Name:  "shh",
367
		Usage: "Enable Whisper",
368
	}
369
	// ATM the url is left to the user and deployment to
Z
CLI:  
zelig 已提交
370 371
	JSpathFlag = cli.StringFlag{
		Name:  "jspath",
372
		Usage: "JavaSript root path for `loadScript` and document root for `admin.httpGet`",
Z
CLI:  
zelig 已提交
373 374
		Value: ".",
	}
375 376
	SolcPathFlag = cli.StringFlag{
		Name:  "solc",
377
		Usage: "Solidity compiler command to be used",
378 379
		Value: "solc",
	}
380 381

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

414 415 416 417 418 419 420 421 422
// 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
423
	}
424 425
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
	return ""
426 427
}

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

443 444 445 446
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
		}
447

448 449 450 451 452 453 454 455
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
		}
	}
	return key
}

456 457 458 459 460 461 462 463
// 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"
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 496 497 498 499 500
	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))
501
	if err != nil {
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
		Fatalf("Option %s: %v", NATFlag.Name, err)
	}
	return natif
}

// MakeGenesisBlock loads up a genesis block from an input file specified in the
// command line, or returns the empty string if none set.
func MakeGenesisBlock(ctx *cli.Context) string {
	genesis := ctx.GlobalString(GenesisFileFlag.Name)
	if genesis == "" {
		return ""
	}
	data, err := ioutil.ReadFile(genesis)
	if err != nil {
		Fatalf("Failed to load custom genesis file: %v", err)
	}
	return string(data)
}

// 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
	scryptN := crypto.StandardScryptN
	scryptP := crypto.StandardScryptP

	if ctx.GlobalBool(LightKDFFlag.Name) {
		scryptN = crypto.LightScryptN
		scryptP = crypto.LightScryptP
	}
	// Assemble an account manager using the configured datadir
	var (
		datadir  = MustMakeDataDir(ctx)
		keystore = crypto.NewKeyStorePassphrase(filepath.Join(datadir, "keystore"), scryptN, scryptP)
	)
	return accounts.NewManager(keystore)
}

// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
541
func MakeAddress(accman *accounts.Manager, account string) (a common.Address, err error) {
542 543
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
544
		return common.HexToAddress(account), nil
545 546 547 548
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
549
		return a, fmt.Errorf("invalid account address or index %q", account)
550 551 552
	}
	hex, err := accman.AddressByIndex(index)
	if err != nil {
553
		return a, fmt.Errorf("can't get account #%d (%v)", index, err)
554
	}
555
	return common.HexToAddress(hex), nil
556 557 558 559 560 561
}

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

// 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))
583
	}
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	return extra
}

// MakePasswordList loads up a list of password from a file specified by the
// command line flags.
func MakePasswordList(ctx *cli.Context) []string {
	if path := ctx.GlobalString(PasswordFileFlag.Name); path != "" {
		blob, err := ioutil.ReadFile(path)
		if err != nil {
			Fatalf("Failed to read password file: %v", err)
		}
		return strings.Split(string(blob), "\n")
	}
	return nil
}

// MakeSystemNode sets up a local node, configures the services to launch and
// assembles the P2P protocol stack.
func MakeSystemNode(name, version string, extra []byte, ctx *cli.Context) *node.Node {
	// 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),
	}
	// Configure the Ethereum service
	accman := MakeAccountManager(ctx)

	ethConf := &eth.Config{
		Genesis:                 MakeGenesisBlock(ctx),
630
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
Z
zsfelfoldi 已提交
631
		BlockChainVersion:       ctx.GlobalInt(BlockchainVersionFlag.Name),
632
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
Z
zsfelfoldi 已提交
633
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
634 635
		AccountManager:          accman,
		Etherbase:               MakeEtherbase(accman, ctx),
Z
zsfelfoldi 已提交
636
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
637
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
638
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
639
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
Z
zsfelfoldi 已提交
640 641 642 643 644 645 646 647 648
		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),
649
	}
650 651
	// Configure the Whisper service
	shhEnable := ctx.GlobalBool(WhisperEnabledFlag.Name)
652

653 654 655 656 657 658 659 660 661
	// 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
		}
		if !ctx.GlobalIsSet(GenesisFileFlag.Name) {
			ethConf.Genesis = core.OlympicGenesisBlock()
		}
662

663 664 665 666 667 668 669 670
	case ctx.GlobalBool(TestNetFlag.Name):
		if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
			ethConf.NetworkId = 2
		}
		if !ctx.GlobalIsSet(GenesisFileFlag.Name) {
			ethConf.Genesis = core.TestNetGenesisBlock()
		}
		state.StartingNonce = 1048576 // (2**20)
671

672 673 674 675
	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")
676 677
		}
		if !ctx.GlobalIsSet(MaxPeersFlag.Name) {
678
			stackConf.MaxPeers = 0
679 680
		}
		if !ctx.GlobalIsSet(ListenPortFlag.Name) {
681 682 683 684 685 686 687 688
			stackConf.ListenAddr = ":0"
		}
		// Override the Ethereum protocol configs
		if !ctx.GlobalIsSet(GenesisFileFlag.Name) {
			ethConf.Genesis = core.OlympicGenesisBlock()
		}
		if !ctx.GlobalIsSet(GasPriceFlag.Name) {
			ethConf.GasPrice = new(big.Int)
689 690
		}
		if !ctx.GlobalIsSet(WhisperEnabledFlag.Name) {
691
			shhEnable = true
692
		}
693 694
		if !ctx.GlobalIsSet(VMDebugFlag.Name) {
			vm.Debug = true
695
		}
696
		ethConf.PowTest = true
697
	}
698 699 700 701 702
	// Assemble and return the protocol stack
	stack, err := node.New(stackConf)
	if err != nil {
		Fatalf("Failed to create the protocol stack: %v", err)
	}
703
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
704 705 706 707 708
		return eth.New(ctx, ethConf)
	}); err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
	}
	if shhEnable {
709
		if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
710 711 712
			Fatalf("Failed to register the Whisper service: %v", err)
		}
	}
713

714
	return stack
715 716
}

717 718 719 720 721
// SetupLogger configures glog from the logging-related command line flags.
func SetupLogger(ctx *cli.Context) {
	glog.SetV(ctx.GlobalInt(VerbosityFlag.Name))
	glog.CopyStandardLogTo("INFO")
	glog.SetToStderr(true)
722 723 724 725 726 727
	if ctx.GlobalIsSet(LogFileFlag.Name) {
		logger.New("", ctx.GlobalString(LogFileFlag.Name), ctx.GlobalInt(VerbosityFlag.Name))
	}
	if ctx.GlobalIsSet(VMDebugFlag.Name) {
		vm.Debug = ctx.GlobalBool(VMDebugFlag.Name)
	}
728
}
729

730 731 732 733 734 735 736 737 738 739 740 741 742 743
// 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)
	}
}

744 745
// SetupVM configured the VM package's global settings
func SetupVM(ctx *cli.Context) {
746
	vm.EnableJit = ctx.GlobalBool(VMEnableJitFlag.Name)
747 748 749 750
	vm.ForceJit = ctx.GlobalBool(VMForceJitFlag.Name)
	vm.SetJITCacheSize(ctx.GlobalInt(VMJitCacheFlag.Name))
}

751
// MakeChain creates a chain manager from set command line flags.
752
func MakeChain(ctx *cli.Context) (chain *core.BlockChain, chainDb ethdb.Database) {
753
	datadir := MustMakeDataDir(ctx)
754 755
	cache := ctx.GlobalInt(CacheFlag.Name)

756
	var err error
757
	if chainDb, err = ethdb.NewLDBDatabase(filepath.Join(datadir, "chaindata"), cache); err != nil {
758 759
		Fatalf("Could not open database: %v", err)
	}
760
	if ctx.GlobalBool(OlympicFlag.Name) {
761
		_, err := core.WriteTestNetGenesisBlock(chainDb)
762 763 764 765
		if err != nil {
			glog.Fatalln(err)
		}
	}
766 767

	eventMux := new(event.TypeMux)
768
	pow := ethash.New()
769
	//genesis := core.GenesisBlock(uint64(ctx.GlobalInt(GenesisNonceFlag.Name)), blockDB)
770
	chain, err = core.NewBlockChain(chainDb, pow, eventMux)
O
obscuren 已提交
771 772 773 774
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}

775
	return chain, chainDb
776
}
F
Felix Lange 已提交
777

778
func IPCSocketPath(ctx *cli.Context) (ipcpath string) {
779
	if runtime.GOOS == "windows" {
B
Bas van Kervel 已提交
780
		ipcpath = common.DefaultIpcPath()
B
Bas van Kervel 已提交
781
		if ctx.GlobalIsSet(IPCPathFlag.Name) {
B
Bas van Kervel 已提交
782 783 784 785
			ipcpath = ctx.GlobalString(IPCPathFlag.Name)
		}
	} else {
		ipcpath = common.DefaultIpcPath()
B
Bas van Kervel 已提交
786
		if ctx.GlobalIsSet(DataDirFlag.Name) {
B
Bas van Kervel 已提交
787 788
			ipcpath = filepath.Join(ctx.GlobalString(DataDirFlag.Name), "geth.ipc")
		}
B
Bas van Kervel 已提交
789 790 791
		if ctx.GlobalIsSet(IPCPathFlag.Name) {
			ipcpath = ctx.GlobalString(IPCPathFlag.Name)
		}
B
Bas van Kervel 已提交
792 793 794 795 796
	}

	return
}

797
func StartIPC(stack *node.Node, ctx *cli.Context) error {
798 799 800 801 802
	var ethereum *eth.Ethereum
	if err := stack.Service(&ethereum); err != nil {
		return err
	}

803 804 805 806 807
	endpoint := IPCSocketPath(ctx)
	listener, err := rpc.CreateIPCListener(endpoint)
	if err != nil {
		return err
	}
808

809
	server := rpc.NewServer()
810

811 812 813 814 815 816
	// register package API's this node provides
	offered := stack.APIs()
	for _, api := range offered {
		server.RegisterName(api.Namespace, api.Service)
		glog.V(logger.Debug).Infof("Register %T under namespace '%s' for IPC service\n", api.Service, api.Namespace)
	}
817

818 819 820 821 822 823
	go func() {
		glog.V(logger.Info).Infof("Start IPC server on %s\n", endpoint)
		for {
			conn, err := listener.Accept()
			if err != nil {
				glog.V(logger.Error).Infof("Unable to accept connection - %v\n", err)
824 825
			}

826 827
			codec := rpc.NewJSONCodec(conn)
			go server.ServeCodec(codec)
B
Bas van Kervel 已提交
828
		}
829 830 831 832
	}()

	return nil

B
Bas van Kervel 已提交
833 834
}

835 836
// StartRPC starts a HTTP JSON-RPC API server.
func StartRPC(stack *node.Node, ctx *cli.Context) error {
837 838 839 840 841 842 843 844 845 846 847 848 849
	for _, api := range stack.APIs() {
		if adminApi, ok := api.Service.(*node.PrivateAdminAPI); ok {
			address := ctx.GlobalString(RPCListenAddrFlag.Name)
			port := ctx.GlobalInt(RPCPortFlag.Name)
			cors := ctx.GlobalString(RPCCORSDomainFlag.Name)
			apiStr := ""
			if ctx.GlobalIsSet(RPCApiFlag.Name) {
				apiStr = ctx.GlobalString(RPCApiFlag.Name)
			}

			_, err := adminApi.StartRPC(address, port, cors, apiStr)
			return err
		}
850
	}
T
Taylor Gerring 已提交
851

852 853 854
	glog.V(logger.Error).Infof("Unable to start RPC-HTTP interface, could not find admin API")
	return errors.New("Unable to start RPC-HTTP interface")
}
855

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
// StartWS starts a websocket JSON-RPC API server.
func StartWS(stack *node.Node, ctx *cli.Context) error {
	for _, api := range stack.APIs() {
		if adminApi, ok := api.Service.(*node.PrivateAdminAPI); ok {
			address := ctx.GlobalString(WSListenAddrFlag.Name)
			port := ctx.GlobalInt(WSAllowedDomainsFlag.Name)
			allowedDomains := ctx.GlobalString(WSAllowedDomainsFlag.Name)
			apiStr := ""
			if ctx.GlobalIsSet(WSApiFlag.Name) {
				apiStr = ctx.GlobalString(WSApiFlag.Name)
			}

			_, err := adminApi.StartWS(address, port, allowedDomains, apiStr)
			return err
		}
871
	}
872 873 874

	glog.V(logger.Error).Infof("Unable to start RPC-WS interface, could not find admin API")
	return errors.New("Unable to start RPC-WS interface")
875
}
876 877 878 879 880 881 882

func StartPProf(ctx *cli.Context) {
	address := fmt.Sprintf("localhost:%d", ctx.GlobalInt(PProfPortFlag.Name))
	go func() {
		log.Println(http.ListenAndServe(address, nil))
	}()
}