path: root/cmd/geth/main.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"
    "os"
    "runtime"
    "strings"
    "time"

    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/accounts/keystore"
    "github.com/ethereum/go-ethereum/cmd/utils"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/hexutil"
    "github.com/ethereum/go-ethereum/console"
    "github.com/ethereum/go-ethereum/contracts/release"
    "github.com/ethereum/go-ethereum/eth"
    "github.com/ethereum/go-ethereum/ethclient"
    "github.com/ethereum/go-ethereum/internal/debug"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/metrics"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/params"
    "github.com/ethereum/go-ethereum/rlp"
    "gopkg.in/urfave/cli.v1"
)

const (
    clientIdentifier = "geth" // Client identifier to advertise over the network
)

var (
    // Git SHA1 commit hash of the release (set via linker flags)
    gitCommit = ""
    // Ethereum address of the Geth release oracle.
    relOracle = common.HexToAddress("0xfa7b9770ca4cb04296cac84f37736d4041251cdf")
    // The app that holds all commands and flags.
    app = utils.NewApp(gitCommit, "the go-ethereum command line interface")
)

func init() {
    // Initialize the CLI app and start Geth
    app.Action = geth
    app.HideVersion = true // we have a command to print the version
    app.Copyright = "Copyright 2013-2016 The go-ethereum Authors"
    app.Commands = []cli.Command{
        // See chaincmd.go:
        initCommand,
        importCommand,
        exportCommand,
        removedbCommand,
        dumpCommand,
        // See monitorcmd.go:
        monitorCommand,
        // See accountcmd.go:
        accountCommand,
        walletCommand,
        // See consolecmd.go:
        consoleCommand,
        attachCommand,
        javascriptCommand,
        // See misccmd.go:
        makedagCommand,
        versionCommand,
        bugCommand,
        licenseCommand,
    }

    app.Flags = []cli.Flag{
        utils.IdentityFlag,
        utils.UnlockedAccountFlag,
        utils.PasswordFileFlag,
        utils.BootnodesFlag,
        utils.DataDirFlag,
        utils.KeyStoreDirFlag,
        utils.EthashCacheDirFlag,
        utils.EthashCachesInMemoryFlag,
        utils.EthashCachesOnDiskFlag,
        utils.EthashDatasetDirFlag,
        utils.EthashDatasetsInMemoryFlag,
        utils.EthashDatasetsOnDiskFlag,
        utils.FastSyncFlag,
        utils.LightModeFlag,
        utils.LightServFlag,
        utils.LightPeersFlag,
        utils.LightKDFFlag,
        utils.CacheFlag,
        utils.TrieCacheGenFlag,
        utils.JSpathFlag,
        utils.ListenPortFlag,
        utils.MaxPeersFlag,
        utils.MaxPendingPeersFlag,
        utils.EtherbaseFlag,
        utils.GasPriceFlag,
        utils.MinerThreadsFlag,
        utils.MiningEnabledFlag,
        utils.TargetGasLimitFlag,
        utils.NATFlag,
        utils.NoDiscoverFlag,
        utils.DiscoveryV5Flag,
        utils.NetrestrictFlag,
        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.VMEnableDebugFlag,
        utils.NetworkIdFlag,
        utils.RPCCORSDomainFlag,
        utils.EthStatsURLFlag,
        utils.MetricsEnabledFlag,
        utils.FakePoWFlag,
        utils.NoCompactionFlag,
        utils.SolcPathFlag,
        utils.GpoBlocksFlag,
        utils.GpoPercentileFlag,
        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 {
        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
}

func makeFullNode(ctx *cli.Context) *node.Node {
    // Create the default extradata and construct the base node
    var clientInfo = struct {
        Version   uint
        Name      string
        GoVersion string
        Os        string
    }{uint(params.VersionMajor<<16 | params.VersionMinor<<8 | params.VersionPatch), clientIdentifier, runtime.Version(), runtime.GOOS}
    extra, err := rlp.EncodeToBytes(clientInfo)
    if err != nil {
        log.Warn("Failed to set canonical miner information", "err", err)
    }
    if uint64(len(extra)) > params.MaximumExtraDataSize {
        log.Warn("Miner extra data exceed limit", "extra", hexutil.Bytes(extra), "limit", params.MaximumExtraDataSize)
        extra = nil
    }
    stack := utils.MakeNode(ctx, clientIdentifier, gitCommit)
    utils.RegisterEthService(ctx, stack, extra)

    // 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(stack)
    }
    // Add the Ethereum Stats daemon if requested
    if url := ctx.GlobalString(utils.EthStatsURLFlag.Name); url != "" {
        utils.RegisterEthStatsService(stack, url)
    }
    // Add the release oracle service so it boots along with node.
    if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
        config := release.Config{
            Oracle: relOracle,
            Major:  uint32(params.VersionMajor),
            Minor:  uint32(params.VersionMinor),
            Patch:  uint32(params.VersionPatch),
        }
        commit, _ := hex.DecodeString(gitCommit)
        copy(config.Commit[:], commit)
        return release.NewReleaseService(ctx, config)
    }); err != nil {
        utils.Fatalf("Failed to register the Geth release oracle service: %v", err)
    }
    return stack
}

// 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) {
    // Start up the node itself
    utils.StartNode(stack)

    // Unlock any account specifically requested
    ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)

    passwords := utils.MakePasswordList(ctx)
    unlocks := strings.Split(ctx.GlobalString(utils.UnlockedAccountFlag.Name), ",")
    for i, account := range unlocks {
        if trimmed := strings.TrimSpace(account); trimmed != "" {
            unlockAccount(ctx, ks, trimmed, i, passwords)
        }
    }
    // Register wallet event handlers to open and auto-derive wallets
    events := make(chan accounts.WalletEvent, 16)
    stack.AccountManager().Subscribe(events)

    go func() {
        // Create an chain state reader for self-derivation
        rpcClient, err := stack.Attach()
        if err != nil {
            utils.Fatalf("Failed to attach to self: %v", err)
        }
        stateReader := ethclient.NewClient(rpcClient)

        // Open and self derive any wallets already attached
        for _, wallet := range stack.AccountManager().Wallets() {
            if err := wallet.Open(""); err != nil {
                log.Warn("Failed to open wallet", "url", wallet.URL(), "err", err)
            } else {
                wallet.SelfDerive(accounts.DefaultBaseDerivationPath, stateReader)
            }
        }
        // Listen for wallet event till termination
        for event := range events {
            if event.Arrive {
                if err := event.Wallet.Open(""); err != nil {
                    log.Warn("New wallet appeared, failed to open", "url", event.Wallet.URL(), "err", err)
                } else {
                    log.Info("New wallet appeared", "url", event.Wallet.URL(), "status", event.Wallet.Status())
                    event.Wallet.SelfDerive(accounts.DefaultBaseDerivationPath, stateReader)
                }
            } else {
                log.Info("Old wallet dropped", "url", event.Wallet.URL())
                event.Wallet.Close()
            }
        }
    }()
    // Start auxiliary services if enabled
    if ctx.GlobalBool(utils.MiningEnabledFlag.Name) {
        var ethereum *eth.Ethereum
        if err := stack.Service(&ethereum); err != nil {
            utils.Fatalf("ethereum service not running: %v", err)
        }
        if threads := ctx.GlobalInt(utils.MinerThreadsFlag.Name); threads > 0 {
            type threaded interface {
                SetThreads(threads int)
            }
            if th, ok := ethereum.Engine().(threaded); ok {
                th.SetThreads(threads)
            }
        }
        if err := ethereum.StartMining(); err != nil {
            utils.Fatalf("Failed to start mining: %v", err)
        }
    }
}