5fff491bbd
As per GNU GPL requirement I've added the copyright and the license information as a subcommand as well as a copyright notice when displaying the help command.
434 lines
12 KiB
Go
434 lines
12 KiB
Go
// Copyright 2014 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
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// geth is the official command-line client for Ethereum.
|
|
package main
|
|
|
|
import (
|
|
"encoding/hex"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/ethereum/ethash"
|
|
"github.com/ethereum/go-ethereum/cmd/utils"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/console"
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/eth"
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
"github.com/ethereum/go-ethereum/internal/debug"
|
|
"github.com/ethereum/go-ethereum/logger"
|
|
"github.com/ethereum/go-ethereum/logger/glog"
|
|
"github.com/ethereum/go-ethereum/metrics"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
"github.com/ethereum/go-ethereum/release"
|
|
"github.com/ethereum/go-ethereum/rlp"
|
|
"gopkg.in/urfave/cli.v1"
|
|
)
|
|
|
|
const (
|
|
clientIdentifier = "Geth" // Client identifier to advertise over the network
|
|
versionMajor = 1 // Major version component of the current release
|
|
versionMinor = 5 // Minor version component of the current release
|
|
versionPatch = 0 // Patch version component of the current release
|
|
versionMeta = "unstable" // Version metadata to append to the version string
|
|
|
|
versionOracle = "0xfa7b9770ca4cb04296cac84f37736d4041251cdf" // Ethereum address of the Geth release oracle
|
|
)
|
|
|
|
var (
|
|
gitCommit string // Git SHA1 commit hash of the release (set via linker flags)
|
|
verString string // Combined textual representation of all the version components
|
|
relConfig release.Config // Structured version information and release oracle config
|
|
app *cli.App
|
|
)
|
|
|
|
func init() {
|
|
// Construct the textual version string from the individual components
|
|
verString = fmt.Sprintf("%d.%d.%d", versionMajor, versionMinor, versionPatch)
|
|
if versionMeta != "" {
|
|
verString += "-" + versionMeta
|
|
}
|
|
if gitCommit != "" {
|
|
verString += "-" + gitCommit[:8]
|
|
}
|
|
// Construct the version release oracle configuration
|
|
relConfig.Oracle = common.HexToAddress(versionOracle)
|
|
|
|
relConfig.Major = uint32(versionMajor)
|
|
relConfig.Minor = uint32(versionMinor)
|
|
relConfig.Patch = uint32(versionPatch)
|
|
|
|
commit, _ := hex.DecodeString(gitCommit)
|
|
copy(relConfig.Commit[:], commit)
|
|
|
|
// Initialize the CLI app and start Geth
|
|
app = utils.NewApp(verString, "the go-ethereum command line interface")
|
|
app.Action = geth
|
|
app.HideVersion = true // we have a command to print the version
|
|
app.Commands = []cli.Command{
|
|
importCommand,
|
|
exportCommand,
|
|
upgradedbCommand,
|
|
removedbCommand,
|
|
dumpCommand,
|
|
monitorCommand,
|
|
accountCommand,
|
|
walletCommand,
|
|
consoleCommand,
|
|
attachCommand,
|
|
javascriptCommand,
|
|
{
|
|
Action: makedag,
|
|
Name: "makedag",
|
|
Usage: "generate ethash dag (for testing)",
|
|
Description: `
|
|
The makedag command generates an ethash DAG in /tmp/dag.
|
|
|
|
This command exists to support the system testing project.
|
|
Regular users do not need to execute it.
|
|
`,
|
|
},
|
|
{
|
|
Action: gpuinfo,
|
|
Name: "gpuinfo",
|
|
Usage: "gpuinfo",
|
|
Description: `
|
|
Prints OpenCL device info for all found GPUs.
|
|
`,
|
|
},
|
|
{
|
|
Action: gpubench,
|
|
Name: "gpubench",
|
|
Usage: "benchmark GPU",
|
|
Description: `
|
|
Runs quick benchmark on first GPU found.
|
|
`,
|
|
},
|
|
{
|
|
Action: version,
|
|
Name: "version",
|
|
Usage: "print ethereum version numbers",
|
|
Description: `
|
|
The output of this command is supposed to be machine-readable.
|
|
`,
|
|
},
|
|
{
|
|
Action: initGenesis,
|
|
Name: "init",
|
|
Usage: "bootstraps and initialises a new genesis block (JSON)",
|
|
Description: `
|
|
The init command initialises a new genesis block and definition for the network.
|
|
This is a destructive action and changes the network in which you will be
|
|
participating.
|
|
`,
|
|
},
|
|
{
|
|
Action: license,
|
|
Name: "license",
|
|
Usage: "displays geth's license information",
|
|
},
|
|
}
|
|
|
|
app.Flags = []cli.Flag{
|
|
utils.IdentityFlag,
|
|
utils.UnlockedAccountFlag,
|
|
utils.PasswordFileFlag,
|
|
utils.BootnodesFlag,
|
|
utils.DataDirFlag,
|
|
utils.KeyStoreDirFlag,
|
|
utils.BlockchainVersionFlag,
|
|
utils.OlympicFlag,
|
|
utils.FastSyncFlag,
|
|
utils.CacheFlag,
|
|
utils.LightKDFFlag,
|
|
utils.JSpathFlag,
|
|
utils.ListenPortFlag,
|
|
utils.MaxPeersFlag,
|
|
utils.MaxPendingPeersFlag,
|
|
utils.EtherbaseFlag,
|
|
utils.GasPriceFlag,
|
|
utils.SupportDAOFork,
|
|
utils.OpposeDAOFork,
|
|
utils.MinerThreadsFlag,
|
|
utils.MiningEnabledFlag,
|
|
utils.MiningGPUFlag,
|
|
utils.AutoDAGFlag,
|
|
utils.TargetGasLimitFlag,
|
|
utils.NATFlag,
|
|
utils.NatspecEnabledFlag,
|
|
utils.NoDiscoverFlag,
|
|
utils.NodeKeyFileFlag,
|
|
utils.NodeKeyHexFlag,
|
|
utils.RPCEnabledFlag,
|
|
utils.RPCListenAddrFlag,
|
|
utils.RPCPortFlag,
|
|
utils.RPCApiFlag,
|
|
utils.WSEnabledFlag,
|
|
utils.WSListenAddrFlag,
|
|
utils.WSPortFlag,
|
|
utils.WSApiFlag,
|
|
utils.WSAllowedOriginsFlag,
|
|
utils.IPCDisabledFlag,
|
|
utils.IPCApiFlag,
|
|
utils.IPCPathFlag,
|
|
utils.ExecFlag,
|
|
utils.PreloadJSFlag,
|
|
utils.WhisperEnabledFlag,
|
|
utils.DevModeFlag,
|
|
utils.TestNetFlag,
|
|
utils.VMForceJitFlag,
|
|
utils.VMJitCacheFlag,
|
|
utils.VMEnableJitFlag,
|
|
utils.NetworkIdFlag,
|
|
utils.RPCCORSDomainFlag,
|
|
utils.MetricsEnabledFlag,
|
|
utils.FakePoWFlag,
|
|
utils.SolcPathFlag,
|
|
utils.GpoMinGasPriceFlag,
|
|
utils.GpoMaxGasPriceFlag,
|
|
utils.GpoFullBlockRatioFlag,
|
|
utils.GpobaseStepDownFlag,
|
|
utils.GpobaseStepUpFlag,
|
|
utils.GpobaseCorrectionFactorFlag,
|
|
utils.ExtraDataFlag,
|
|
}
|
|
app.Flags = append(app.Flags, debug.Flags...)
|
|
|
|
app.Before = func(ctx *cli.Context) error {
|
|
runtime.GOMAXPROCS(runtime.NumCPU())
|
|
if err := debug.Setup(ctx); err != nil {
|
|
return err
|
|
}
|
|
// Start system runtime metrics collection
|
|
go metrics.CollectProcessMetrics(3 * time.Second)
|
|
|
|
// This should be the only place where reporting is enabled
|
|
// because it is not intended to run while testing.
|
|
// In addition to this check, bad block reports are sent only
|
|
// for chains with the main network genesis block and network id 1.
|
|
eth.EnableBadBlockReporting = true
|
|
|
|
utils.SetupNetwork(ctx)
|
|
return nil
|
|
}
|
|
|
|
app.After = func(ctx *cli.Context) error {
|
|
logger.Flush()
|
|
debug.Exit()
|
|
console.Stdin.Close() // Resets terminal mode.
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func main() {
|
|
if err := app.Run(os.Args); err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
|
|
// geth is the main entry point into the system if no special subcommand is ran.
|
|
// It creates a default node based on the command line arguments and runs it in
|
|
// blocking mode, waiting for it to be shut down.
|
|
func geth(ctx *cli.Context) error {
|
|
node := makeFullNode(ctx)
|
|
startNode(ctx, node)
|
|
node.Wait()
|
|
return nil
|
|
}
|
|
|
|
// initGenesis will initialise the given JSON format genesis file and writes it as
|
|
// the zero'd block (i.e. genesis) or will fail hard if it can't succeed.
|
|
func initGenesis(ctx *cli.Context) error {
|
|
genesisPath := ctx.Args().First()
|
|
if len(genesisPath) == 0 {
|
|
utils.Fatalf("must supply path to genesis JSON file")
|
|
}
|
|
|
|
chainDb, err := ethdb.NewLDBDatabase(filepath.Join(utils.MustMakeDataDir(ctx), "chaindata"), 0, 0)
|
|
if err != nil {
|
|
utils.Fatalf("could not open database: %v", err)
|
|
}
|
|
|
|
genesisFile, err := os.Open(genesisPath)
|
|
if err != nil {
|
|
utils.Fatalf("failed to read genesis file: %v", err)
|
|
}
|
|
|
|
block, err := core.WriteGenesisBlock(chainDb, genesisFile)
|
|
if err != nil {
|
|
utils.Fatalf("failed to write genesis block: %v", err)
|
|
}
|
|
glog.V(logger.Info).Infof("successfully wrote genesis block and/or chain rule set: %x", block.Hash())
|
|
return nil
|
|
}
|
|
|
|
func makeFullNode(ctx *cli.Context) *node.Node {
|
|
node := utils.MakeNode(ctx, clientIdentifier, verString)
|
|
utils.RegisterEthService(ctx, node, relConfig, makeDefaultExtra())
|
|
// Whisper must be explicitly enabled, but is auto-enabled in --dev mode.
|
|
shhEnabled := ctx.GlobalBool(utils.WhisperEnabledFlag.Name)
|
|
shhAutoEnabled := !ctx.GlobalIsSet(utils.WhisperEnabledFlag.Name) && ctx.GlobalIsSet(utils.DevModeFlag.Name)
|
|
if shhEnabled || shhAutoEnabled {
|
|
utils.RegisterShhService(node)
|
|
}
|
|
return node
|
|
}
|
|
|
|
func makeDefaultExtra() []byte {
|
|
var clientInfo = struct {
|
|
Version uint
|
|
Name string
|
|
GoVersion string
|
|
Os string
|
|
}{uint(versionMajor<<16 | versionMinor<<8 | versionPatch), clientIdentifier, runtime.Version(), runtime.GOOS}
|
|
extra, err := rlp.EncodeToBytes(clientInfo)
|
|
if err != nil {
|
|
glog.V(logger.Warn).Infoln("error setting canonical miner information:", err)
|
|
}
|
|
|
|
if uint64(len(extra)) > params.MaximumExtraDataSize.Uint64() {
|
|
glog.V(logger.Warn).Infoln("error setting canonical miner information: extra exceeds", params.MaximumExtraDataSize)
|
|
glog.V(logger.Debug).Infof("extra: %x\n", extra)
|
|
return nil
|
|
}
|
|
return extra
|
|
}
|
|
|
|
// startNode boots up the system node and all registered protocols, after which
|
|
// it unlocks any requested accounts, and starts the RPC/IPC interfaces and the
|
|
// miner.
|
|
func startNode(ctx *cli.Context, stack *node.Node) {
|
|
// Report geth version
|
|
glog.V(logger.Info).Infof("instance: Geth/%s/%s/%s\n", verString, runtime.Version(), runtime.GOOS)
|
|
// Start up the node itself
|
|
utils.StartNode(stack)
|
|
|
|
// Unlock any account specifically requested
|
|
accman := stack.AccountManager()
|
|
passwords := utils.MakePasswordList(ctx)
|
|
accounts := strings.Split(ctx.GlobalString(utils.UnlockedAccountFlag.Name), ",")
|
|
for i, account := range accounts {
|
|
if trimmed := strings.TrimSpace(account); trimmed != "" {
|
|
unlockAccount(ctx, accman, trimmed, i, passwords)
|
|
}
|
|
}
|
|
// Start auxiliary services if enabled
|
|
if ctx.GlobalBool(utils.MiningEnabledFlag.Name) {
|
|
var ethereum *eth.Ethereum
|
|
if err := stack.Service(ðereum); err != nil {
|
|
utils.Fatalf("ethereum service not running: %v", err)
|
|
}
|
|
if err := ethereum.StartMining(ctx.GlobalInt(utils.MinerThreadsFlag.Name), ctx.GlobalString(utils.MiningGPUFlag.Name)); err != nil {
|
|
utils.Fatalf("Failed to start mining: %v", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func makedag(ctx *cli.Context) error {
|
|
args := ctx.Args()
|
|
wrongArgs := func() {
|
|
utils.Fatalf(`Usage: geth makedag <block number> <outputdir>`)
|
|
}
|
|
switch {
|
|
case len(args) == 2:
|
|
blockNum, err := strconv.ParseUint(args[0], 0, 64)
|
|
dir := args[1]
|
|
if err != nil {
|
|
wrongArgs()
|
|
} else {
|
|
dir = filepath.Clean(dir)
|
|
// seems to require a trailing slash
|
|
if !strings.HasSuffix(dir, "/") {
|
|
dir = dir + "/"
|
|
}
|
|
_, err = ioutil.ReadDir(dir)
|
|
if err != nil {
|
|
utils.Fatalf("Can't find dir")
|
|
}
|
|
fmt.Println("making DAG, this could take awhile...")
|
|
ethash.MakeDAG(blockNum, dir)
|
|
}
|
|
default:
|
|
wrongArgs()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func gpuinfo(ctx *cli.Context) error {
|
|
eth.PrintOpenCLDevices()
|
|
return nil
|
|
}
|
|
|
|
func gpubench(ctx *cli.Context) error {
|
|
args := ctx.Args()
|
|
wrongArgs := func() {
|
|
utils.Fatalf(`Usage: geth gpubench <gpu number>`)
|
|
}
|
|
switch {
|
|
case len(args) == 1:
|
|
n, err := strconv.ParseUint(args[0], 0, 64)
|
|
if err != nil {
|
|
wrongArgs()
|
|
}
|
|
eth.GPUBench(n)
|
|
case len(args) == 0:
|
|
eth.GPUBench(0)
|
|
default:
|
|
wrongArgs()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func version(c *cli.Context) error {
|
|
fmt.Println(clientIdentifier)
|
|
fmt.Println("Version:", verString)
|
|
fmt.Println("Protocol Versions:", eth.ProtocolVersions)
|
|
fmt.Println("Network Id:", c.GlobalInt(utils.NetworkIdFlag.Name))
|
|
fmt.Println("Go Version:", runtime.Version())
|
|
fmt.Println("OS:", runtime.GOOS)
|
|
fmt.Printf("GOPATH=%s\n", os.Getenv("GOPATH"))
|
|
fmt.Printf("GOROOT=%s\n", runtime.GOROOT())
|
|
|
|
return nil
|
|
}
|
|
|
|
func license(c *cli.Context) error {
|
|
fmt.Println(`Geth 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.
|
|
|
|
Geth is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with geth. If not, see <http://www.gnu.org/licenses/>.
|
|
`)
|
|
|
|
return nil
|
|
}
|