flags.go 26.1 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"
B
Bas van Kervel 已提交
26
	"net"
27
	"net/http"
28
	"os"
29
	"path/filepath"
30
	"runtime"
31
	"strconv"
32
	"strings"
33

34
	"github.com/codegangsta/cli"
35
	"github.com/ethereum/ethash"
F
Felix Lange 已提交
36
	"github.com/ethereum/go-ethereum/accounts"
Z
zelig 已提交
37
	"github.com/ethereum/go-ethereum/common"
38
	"github.com/ethereum/go-ethereum/core"
39
	"github.com/ethereum/go-ethereum/core/state"
B
Bas van Kervel 已提交
40
	"github.com/ethereum/go-ethereum/core/vm"
41 42 43 44 45
	"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 已提交
46
	"github.com/ethereum/go-ethereum/logger/glog"
B
Bas van Kervel 已提交
47
	"github.com/ethereum/go-ethereum/metrics"
48 49
	"github.com/ethereum/go-ethereum/node"
	"github.com/ethereum/go-ethereum/p2p/discover"
50
	"github.com/ethereum/go-ethereum/p2p/nat"
51
	"github.com/ethereum/go-ethereum/params"
B
Bas van Kervel 已提交
52 53
	"github.com/ethereum/go-ethereum/rpc/api"
	"github.com/ethereum/go-ethereum/rpc/codec"
54
	"github.com/ethereum/go-ethereum/rpc/comms"
B
Bas van Kervel 已提交
55 56
	"github.com/ethereum/go-ethereum/rpc/shared"
	"github.com/ethereum/go-ethereum/rpc/useragent"
57
	rpc "github.com/ethereum/go-ethereum/rpc/v2"
58
	"github.com/ethereum/go-ethereum/whisper"
59
	"github.com/ethereum/go-ethereum/xeth"
60 61
)

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
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 已提交
88 89 90
// NewApp creates an app with sane defaults.
func NewApp(version, usage string) *cli.App {
	app := cli.NewApp()
91
	app.Name = filepath.Base(os.Args[0])
F
Felix Lange 已提交
92
	app.Author = ""
O
obscuren 已提交
93
	//app.Authors = nil
F
Felix Lange 已提交
94 95 96 97 98 99
	app.Email = ""
	app.Version = version
	app.Usage = usage
	return app
}

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

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

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

	// Gas price oracle settings
Z
zsfelfoldi 已提交
367 368 369
	GpoMinGasPriceFlag = cli.StringFlag{
		Name:  "gpomin",
		Usage: "Minimum suggested gas price",
370
		Value: new(big.Int).Mul(big.NewInt(50), common.Shannon).String(),
Z
zsfelfoldi 已提交
371 372 373 374
	}
	GpoMaxGasPriceFlag = cli.StringFlag{
		Name:  "gpomax",
		Usage: "Maximum suggested gas price",
375
		Value: new(big.Int).Mul(big.NewInt(500), common.Shannon).String(),
Z
zsfelfoldi 已提交
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
	}
	GpoFullBlockRatioFlag = cli.IntFlag{
		Name:  "gpofull",
		Usage: "Full block threshold for gas price calculation (%)",
		Value: 80,
	}
	GpobaseStepDownFlag = cli.IntFlag{
		Name:  "gpobasedown",
		Usage: "Suggested gas price base step down ratio (1/1000)",
		Value: 10,
	}
	GpobaseStepUpFlag = cli.IntFlag{
		Name:  "gpobaseup",
		Usage: "Suggested gas price base step up ratio (1/1000)",
		Value: 100,
	}
	GpobaseCorrectionFactorFlag = cli.IntFlag{
		Name:  "gpobasecf",
		Usage: "Suggested gas price base correction factor (%)",
		Value: 110,
	}
397 398
)

399 400 401 402 403 404 405 406 407
// 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
408
	}
409 410
	Fatalf("Cannot determine default data directory, please set manually (--datadir)")
	return ""
411 412
}

413 414 415 416 417 418 419 420 421 422 423
// 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
	)
424 425 426
	switch {
	case file != "" && hex != "":
		Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
427

428 429 430 431
	case file != "":
		if key, err = crypto.LoadECDSA(file); err != nil {
			Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
		}
432

433 434 435 436 437 438 439 440
	case hex != "":
		if key, err = crypto.HexToECDSA(hex); err != nil {
			Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
		}
	}
	return key
}

441 442 443 444 445 446 447 448
// 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"
449
	}
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
	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))
486
	if err != nil {
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 514 515 516 517 518 519 520 521 522 523 524 525
		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.
526
func MakeAddress(accman *accounts.Manager, account string) (a common.Address, err error) {
527 528
	// If the specified account is a valid address, return it
	if common.IsHexAddress(account) {
529
		return common.HexToAddress(account), nil
530 531 532 533
	}
	// Otherwise try to interpret the account as a keystore index
	index, err := strconv.Atoi(account)
	if err != nil {
534
		return a, fmt.Errorf("invalid account address or index %q", account)
535 536 537
	}
	hex, err := accman.AddressByIndex(index)
	if err != nil {
538
		return a, fmt.Errorf("can't get account #%d (%v)", index, err)
539
	}
540
	return common.HexToAddress(hex), nil
541 542 543 544 545 546
}

// 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()
547
	if !ctx.GlobalIsSet(EtherbaseFlag.Name) && len(accounts) == 0 {
548
		glog.V(logger.Error).Infoln("WARNING: No etherbase set and no accounts found as default")
549 550
		return common.Address{}
	}
551 552 553
	etherbase := ctx.GlobalString(EtherbaseFlag.Name)
	if etherbase == "" {
		return common.Address{}
554
	}
555 556
	// If the specified etherbase is a valid address, return it
	addr, err := MakeAddress(accman, etherbase)
557
	if err != nil {
558
		Fatalf("Option %q: %v", EtherbaseFlag.Name, err)
559
	}
560
	return addr
561 562 563 564 565 566 567
}

// 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))
568
	}
569 570 571 572 573 574 575 576 577 578 579 580 581 582 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
	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),
615
		FastSync:                ctx.GlobalBool(FastSyncFlag.Name),
Z
zsfelfoldi 已提交
616
		BlockChainVersion:       ctx.GlobalInt(BlockchainVersionFlag.Name),
617
		DatabaseCache:           ctx.GlobalInt(CacheFlag.Name),
Z
zsfelfoldi 已提交
618
		NetworkId:               ctx.GlobalInt(NetworkIdFlag.Name),
619 620
		AccountManager:          accman,
		Etherbase:               MakeEtherbase(accman, ctx),
Z
zsfelfoldi 已提交
621
		MinerThreads:            ctx.GlobalInt(MinerThreadsFlag.Name),
622
		ExtraData:               MakeMinerExtra(extra, ctx),
Z
zsfelfoldi 已提交
623
		NatSpec:                 ctx.GlobalBool(NatspecEnabledFlag.Name),
Z
zelig 已提交
624
		DocRoot:                 ctx.GlobalString(DocRootFlag.Name),
Z
zsfelfoldi 已提交
625 626 627 628 629 630 631 632 633
		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),
634
	}
635 636
	// Configure the Whisper service
	shhEnable := ctx.GlobalBool(WhisperEnabledFlag.Name)
637

638 639 640 641 642 643 644 645 646
	// 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()
		}
647

648 649 650 651 652 653 654 655
	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)
656

657 658 659 660
	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")
661 662
		}
		if !ctx.GlobalIsSet(MaxPeersFlag.Name) {
663
			stackConf.MaxPeers = 0
664 665
		}
		if !ctx.GlobalIsSet(ListenPortFlag.Name) {
666 667 668 669 670 671 672 673
			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)
674 675
		}
		if !ctx.GlobalIsSet(WhisperEnabledFlag.Name) {
676
			shhEnable = true
677
		}
678 679
		if !ctx.GlobalIsSet(VMDebugFlag.Name) {
			vm.Debug = true
680
		}
681
		ethConf.PowTest = true
682
	}
683 684 685 686 687
	// Assemble and return the protocol stack
	stack, err := node.New(stackConf)
	if err != nil {
		Fatalf("Failed to create the protocol stack: %v", err)
	}
688
	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
689 690 691 692 693
		return eth.New(ctx, ethConf)
	}); err != nil {
		Fatalf("Failed to register the Ethereum service: %v", err)
	}
	if shhEnable {
694
		if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
695 696 697
			Fatalf("Failed to register the Whisper service: %v", err)
		}
	}
698

699
	return stack
700 701
}

702 703 704 705 706
// 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)
707 708 709 710 711 712
	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)
	}
713
}
714

715 716 717 718 719 720 721 722 723 724 725 726 727 728
// 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)
	}
}

729 730
// SetupVM configured the VM package's global settings
func SetupVM(ctx *cli.Context) {
731
	vm.EnableJit = ctx.GlobalBool(VMEnableJitFlag.Name)
732 733 734 735
	vm.ForceJit = ctx.GlobalBool(VMForceJitFlag.Name)
	vm.SetJITCacheSize(ctx.GlobalInt(VMJitCacheFlag.Name))
}

736
// MakeChain creates a chain manager from set command line flags.
737
func MakeChain(ctx *cli.Context) (chain *core.BlockChain, chainDb ethdb.Database) {
738
	datadir := MustMakeDataDir(ctx)
739 740
	cache := ctx.GlobalInt(CacheFlag.Name)

741
	var err error
742
	if chainDb, err = ethdb.NewLDBDatabase(filepath.Join(datadir, "chaindata"), cache); err != nil {
743 744
		Fatalf("Could not open database: %v", err)
	}
745
	if ctx.GlobalBool(OlympicFlag.Name) {
746
		_, err := core.WriteTestNetGenesisBlock(chainDb)
747 748 749 750
		if err != nil {
			glog.Fatalln(err)
		}
	}
751 752

	eventMux := new(event.TypeMux)
753
	pow := ethash.New()
754
	//genesis := core.GenesisBlock(uint64(ctx.GlobalInt(GenesisNonceFlag.Name)), blockDB)
755
	chain, err = core.NewBlockChain(chainDb, pow, eventMux)
O
obscuren 已提交
756 757 758 759
	if err != nil {
		Fatalf("Could not start chainmanager: %v", err)
	}

760
	return chain, chainDb
761
}
F
Felix Lange 已提交
762

B
Bas van Kervel 已提交
763
func IpcSocketPath(ctx *cli.Context) (ipcpath string) {
764
	if runtime.GOOS == "windows" {
B
Bas van Kervel 已提交
765
		ipcpath = common.DefaultIpcPath()
B
Bas van Kervel 已提交
766
		if ctx.GlobalIsSet(IPCPathFlag.Name) {
B
Bas van Kervel 已提交
767 768 769 770
			ipcpath = ctx.GlobalString(IPCPathFlag.Name)
		}
	} else {
		ipcpath = common.DefaultIpcPath()
B
Bas van Kervel 已提交
771
		if ctx.GlobalIsSet(DataDirFlag.Name) {
B
Bas van Kervel 已提交
772 773
			ipcpath = filepath.Join(ctx.GlobalString(DataDirFlag.Name), "geth.ipc")
		}
B
Bas van Kervel 已提交
774 775 776
		if ctx.GlobalIsSet(IPCPathFlag.Name) {
			ipcpath = ctx.GlobalString(IPCPathFlag.Name)
		}
B
Bas van Kervel 已提交
777 778 779 780 781
	}

	return
}

782
func StartIPC(stack *node.Node, ctx *cli.Context) error {
B
Bas van Kervel 已提交
783
	config := comms.IpcConfig{
B
Bas van Kervel 已提交
784
		Endpoint: IpcSocketPath(ctx),
B
Bas van Kervel 已提交
785 786
	}

787 788 789 790 791 792 793 794 795 796 797 798 799 800
	var ethereum *eth.Ethereum
	if err := stack.Service(&ethereum); err != nil {
		return err
	}

	if ctx.GlobalIsSet(IPCExperimental.Name) {
		listener, err := comms.CreateListener(config)
		if err != nil {
			return err
		}

		server := rpc.NewServer()

		// register package API's this node provides
801
		offered := stack.APIs()
802 803 804
		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)
805
		}
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828

		web3 := NewPublicWeb3API(stack)
		server.RegisterName("web3", web3)
		net := NewPublicNetAPI(stack.Server(), ethereum.NetVersion())
		server.RegisterName("net", net)

		go func() {
			glog.V(logger.Info).Infof("Start IPC server on %s\n", config.Endpoint)
			for {
				conn, err := listener.Accept()
				if err != nil {
					glog.V(logger.Error).Infof("Unable to accept connection - %v\n", err)
				}

				codec := rpc.NewJSONCodec(conn)
				go server.ServeCodec(codec)
			}
		}()

		return nil
	}

	initializer := func(conn net.Conn) (comms.Stopper, shared.EthereumApi, error) {
829
		fe := useragent.NewRemoteFrontend(conn, ethereum.AccountManager())
830 831
		xeth := xeth.New(stack, fe)
		apis, err := api.ParseApiString(ctx.GlobalString(IPCApiFlag.Name), codec.JSON, xeth, stack)
B
Bas van Kervel 已提交
832
		if err != nil {
833
			return nil, nil, err
B
Bas van Kervel 已提交
834
		}
835
		return xeth, api.Merge(apis...), nil
B
Bas van Kervel 已提交
836
	}
B
Bas van Kervel 已提交
837
	return comms.StartIpc(config, codec.JSON, initializer)
B
Bas van Kervel 已提交
838 839
}

840 841
// StartRPC starts a HTTP JSON-RPC API server.
func StartRPC(stack *node.Node, ctx *cli.Context) error {
842
	config := comms.HttpConfig{
T
Taylor Gerring 已提交
843 844 845
		ListenAddress: ctx.GlobalString(RPCListenAddrFlag.Name),
		ListenPort:    uint(ctx.GlobalInt(RPCPortFlag.Name)),
		CorsDomain:    ctx.GlobalString(RPCCORSDomainFlag.Name),
846
	}
T
Taylor Gerring 已提交
847

848
	xeth := xeth.New(stack, nil)
849 850
	codec := codec.JSON

851
	apis, err := api.ParseApiString(ctx.GlobalString(RpcApiFlag.Name), codec, xeth, stack)
852 853 854
	if err != nil {
		return err
	}
B
Bas van Kervel 已提交
855
	return comms.StartHttp(config, codec, api.Merge(apis...))
856
}
857 858 859 860 861 862 863

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