123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552 |
- // 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 (
- "fmt"
- "os"
- "sort"
- "strconv"
- "strings"
- "time"
- "github.com/ethereum/go-ethereum/accounts"
- "github.com/ethereum/go-ethereum/accounts/keystore"
- "github.com/ethereum/go-ethereum/accounts/pluggable"
- "github.com/ethereum/go-ethereum/cmd/utils"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/console/prompt"
- "github.com/ethereum/go-ethereum/eth"
- "github.com/ethereum/go-ethereum/eth/downloader"
- "github.com/ethereum/go-ethereum/ethclient"
- "github.com/ethereum/go-ethereum/internal/debug"
- "github.com/ethereum/go-ethereum/internal/ethapi"
- "github.com/ethereum/go-ethereum/internal/flags"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/metrics"
- "github.com/ethereum/go-ethereum/node"
- "github.com/ethereum/go-ethereum/permission"
- "github.com/ethereum/go-ethereum/plugin"
- "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 = ""
- gitDate = ""
- // The app that holds all commands and flags.
- app = flags.NewApp(gitCommit, gitDate, "the go-ethereum command line interface")
- // flags that configure the node
- nodeFlags = []cli.Flag{
- utils.IdentityFlag,
- utils.UnlockedAccountFlag,
- utils.PasswordFileFlag,
- utils.BootnodesFlag,
- utils.DataDirFlag,
- utils.AncientFlag,
- utils.MinFreeDiskSpaceFlag,
- utils.KeyStoreDirFlag,
- utils.ExternalSignerFlag,
- utils.NoUSBFlag,
- utils.USBFlag,
- utils.SmartCardDaemonPathFlag,
- utils.OverrideBerlinFlag,
- utils.EthashCacheDirFlag,
- utils.EthashCachesInMemoryFlag,
- utils.EthashCachesOnDiskFlag,
- utils.EthashCachesLockMmapFlag,
- utils.EthashDatasetDirFlag,
- utils.EthashDatasetsInMemoryFlag,
- utils.EthashDatasetsOnDiskFlag,
- utils.EthashDatasetsLockMmapFlag,
- utils.TxPoolLocalsFlag,
- utils.TxPoolNoLocalsFlag,
- utils.TxPoolJournalFlag,
- utils.TxPoolRejournalFlag,
- utils.TxPoolPriceLimitFlag,
- utils.TxPoolPriceBumpFlag,
- utils.TxPoolAccountSlotsFlag,
- utils.TxPoolGlobalSlotsFlag,
- utils.TxPoolAccountQueueFlag,
- utils.TxPoolGlobalQueueFlag,
- utils.TxPoolLifetimeFlag,
- utils.SyncModeFlag,
- utils.ExitWhenSyncedFlag,
- utils.GCModeFlag,
- utils.SnapshotFlag,
- utils.TxLookupLimitFlag,
- utils.LightServeFlag,
- utils.LightIngressFlag,
- utils.LightEgressFlag,
- utils.LightMaxPeersFlag,
- utils.LightNoPruneFlag,
- utils.LightKDFFlag,
- utils.UltraLightServersFlag,
- utils.UltraLightFractionFlag,
- utils.UltraLightOnlyAnnounceFlag,
- utils.LightNoSyncServeFlag,
- utils.AuthorizationListFlag,
- utils.BloomFilterSizeFlag,
- utils.CacheFlag,
- utils.CacheDatabaseFlag,
- utils.CacheTrieFlag,
- utils.CacheTrieJournalFlag,
- utils.CacheTrieRejournalFlag,
- utils.CacheGCFlag,
- utils.CacheSnapshotFlag,
- utils.CacheNoPrefetchFlag,
- utils.CachePreimagesFlag,
- utils.ListenPortFlag,
- utils.MaxPeersFlag,
- utils.MaxPendingPeersFlag,
- utils.MiningEnabledFlag,
- utils.MinerThreadsFlag,
- utils.MinerNotifyFlag,
- utils.MinerGasTargetFlag,
- utils.MinerGasLimitFlag,
- utils.MinerGasPriceFlag,
- utils.MinerEtherbaseFlag,
- utils.MinerExtraDataFlag,
- utils.MinerRecommitIntervalFlag,
- utils.MinerNoVerfiyFlag,
- utils.NATFlag,
- utils.NoDiscoverFlag,
- utils.DiscoveryV5Flag,
- utils.NetrestrictFlag,
- utils.NodeKeyFileFlag,
- utils.NodeKeyHexFlag,
- utils.DNSDiscoveryFlag,
- utils.MainnetFlag,
- utils.DeveloperFlag,
- utils.DeveloperPeriodFlag,
- utils.RopstenFlag,
- utils.RinkebyFlag,
- utils.GoerliFlag,
- utils.YoloV3Flag,
- utils.VMEnableDebugFlag,
- utils.NetworkIdFlag,
- utils.EthStatsURLFlag,
- utils.FakePoWFlag,
- utils.NoCompactionFlag,
- utils.GpoBlocksFlag,
- utils.GpoPercentileFlag,
- utils.GpoMaxGasPriceFlag,
- utils.EWASMInterpreterFlag,
- utils.EVMInterpreterFlag,
- utils.MinerNotifyFullFlag,
- configFileFlag,
- utils.CatalystFlag,
- // Quorum
- utils.QuorumImmutabilityThreshold,
- utils.EnableNodePermissionFlag,
- utils.RaftLogDirFlag,
- utils.RaftModeFlag,
- utils.RaftBlockTimeFlag,
- utils.RaftJoinExistingFlag,
- utils.RaftPortFlag,
- utils.RaftDNSEnabledFlag,
- utils.EmitCheckpointsFlag,
- utils.IstanbulRequestTimeoutFlag,
- utils.IstanbulBlockPeriodFlag,
- utils.PluginSettingsFlag,
- utils.PluginSkipVerifyFlag,
- utils.PluginLocalVerifyFlag,
- utils.PluginPublicKeyFlag,
- utils.AllowedFutureBlockTimeFlag,
- utils.EVMCallTimeOutFlag,
- utils.MultitenancyFlag,
- utils.RevertReasonFlag,
- utils.QuorumEnablePrivateTrieCache,
- utils.QuorumEnablePrivacyMarker,
- utils.QuorumPTMUnixSocketFlag,
- utils.QuorumPTMUrlFlag,
- utils.QuorumPTMTimeoutFlag,
- utils.QuorumPTMDialTimeoutFlag,
- utils.QuorumPTMHttpIdleTimeoutFlag,
- utils.QuorumPTMHttpWriteBufferSizeFlag,
- utils.QuorumPTMHttpReadBufferSizeFlag,
- utils.QuorumPTMTlsModeFlag,
- utils.QuorumPTMTlsRootCaFlag,
- utils.QuorumPTMTlsClientCertFlag,
- utils.QuorumPTMTlsClientKeyFlag,
- utils.QuorumPTMTlsInsecureSkipVerify,
- utils.QuorumLightServerFlag,
- utils.QuorumLightServerP2PListenPortFlag,
- utils.QuorumLightServerP2PMaxPeersFlag,
- utils.QuorumLightServerP2PNetrestrictFlag,
- utils.QuorumLightServerP2PPermissioningFlag,
- utils.QuorumLightServerP2PPermissioningPrefixFlag,
- utils.QuorumLightClientFlag,
- utils.QuorumLightClientPSIFlag,
- utils.QuorumLightClientTokenEnabledFlag,
- utils.QuorumLightClientTokenValueFlag,
- utils.QuorumLightClientTokenManagementFlag,
- utils.QuorumLightClientRPCTLSFlag,
- utils.QuorumLightClientRPCTLSInsecureSkipVerifyFlag,
- utils.QuorumLightClientRPCTLSCACertFlag,
- utils.QuorumLightClientRPCTLSCertFlag,
- utils.QuorumLightClientRPCTLSKeyFlag,
- utils.QuorumLightClientServerNodeFlag,
- utils.QuorumLightClientServerNodeRPCFlag,
- utils.QuorumLightTLSFlag,
- utils.QuorumLightTLSCertFlag,
- utils.QuorumLightTLSKeyFlag,
- utils.QuorumLightTLSCACertsFlag,
- utils.QuorumLightTLSClientAuthFlag,
- utils.QuorumLightTLSCipherSuitesFlag,
- // End-Quorum
- }
- rpcFlags = []cli.Flag{
- utils.HTTPEnabledFlag,
- utils.HTTPListenAddrFlag,
- utils.HTTPPortFlag,
- utils.HTTPCORSDomainFlag,
- utils.HTTPVirtualHostsFlag,
- utils.LegacyRPCEnabledFlag,
- utils.LegacyRPCListenAddrFlag,
- utils.LegacyRPCPortFlag,
- utils.LegacyRPCCORSDomainFlag,
- utils.LegacyRPCVirtualHostsFlag,
- utils.LegacyRPCApiFlag,
- utils.GraphQLEnabledFlag,
- utils.GraphQLCORSDomainFlag,
- utils.GraphQLVirtualHostsFlag,
- utils.HTTPApiFlag,
- utils.HTTPPathPrefixFlag,
- utils.WSEnabledFlag,
- utils.WSListenAddrFlag,
- utils.WSPortFlag,
- utils.WSApiFlag,
- utils.WSAllowedOriginsFlag,
- utils.WSPathPrefixFlag,
- utils.IPCDisabledFlag,
- utils.IPCPathFlag,
- utils.InsecureUnlockAllowedFlag,
- utils.RPCGlobalGasCapFlag,
- utils.RPCGlobalTxFeeCapFlag,
- utils.AllowUnprotectedTxs,
- }
- metricsFlags = []cli.Flag{
- utils.MetricsEnabledFlag,
- utils.MetricsEnabledExpensiveFlag,
- utils.MetricsHTTPFlag,
- utils.MetricsPortFlag,
- utils.MetricsEnableInfluxDBFlag,
- utils.MetricsInfluxDBEndpointFlag,
- utils.MetricsInfluxDBDatabaseFlag,
- utils.MetricsInfluxDBUsernameFlag,
- utils.MetricsInfluxDBPasswordFlag,
- utils.MetricsInfluxDBTagsFlag,
- }
- )
- 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-2021 The go-ethereum Authors"
- app.Commands = []cli.Command{
- // See chaincmd.go:
- initCommand,
- mpsdbUpgradeCommand,
- importCommand,
- exportCommand,
- importPreimagesCommand,
- exportPreimagesCommand,
- removedbCommand,
- dumpCommand,
- dumpGenesisCommand,
- // See accountcmd.go:
- accountCommand,
- walletCommand,
- // See consolecmd.go:
- consoleCommand,
- attachCommand,
- javascriptCommand,
- // See misccmd.go:
- makecacheCommand,
- makedagCommand,
- versionCommand,
- versionCheckCommand,
- licenseCommand,
- // See config.go
- dumpConfigCommand,
- // see dbcmd.go
- dbCommand,
- // See cmd/utils/flags_legacy.go
- utils.ShowDeprecated,
- // See snapshot.go
- snapshotCommand,
- }
- sort.Sort(cli.CommandsByName(app.Commands))
- app.Flags = append(app.Flags, nodeFlags...)
- app.Flags = append(app.Flags, rpcFlags...)
- app.Flags = append(app.Flags, consoleFlags...)
- app.Flags = append(app.Flags, debug.Flags...)
- app.Flags = append(app.Flags, metricsFlags...)
- app.Before = func(ctx *cli.Context) error {
- return debug.Setup(ctx)
- }
- app.After = func(ctx *cli.Context) error {
- debug.Exit()
- prompt.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)
- }
- }
- // prepare manipulates memory cache allowance and setups metric system.
- // This function should be called before launching devp2p stack.
- func prepare(ctx *cli.Context) {
- // If we're running a known preset, log it for convenience.
- switch {
- case ctx.GlobalIsSet(utils.RopstenFlag.Name):
- log.Info("Starting Geth on Ropsten testnet...")
- case ctx.GlobalIsSet(utils.RinkebyFlag.Name):
- log.Info("Starting Geth on Rinkeby testnet...")
- case ctx.GlobalIsSet(utils.GoerliFlag.Name):
- log.Info("Starting Geth on Görli testnet...")
- case ctx.GlobalIsSet(utils.YoloV3Flag.Name):
- log.Info("Starting Geth on YOLOv3 testnet...")
- case ctx.GlobalIsSet(utils.DeveloperFlag.Name):
- log.Info("Starting Geth in ephemeral dev mode...")
- case !ctx.GlobalIsSet(utils.NetworkIdFlag.Name):
- log.Info("Starting Geth on Ethereum mainnet...")
- }
- // If we're a full node on mainnet without --cache specified, bump default cache allowance
- if ctx.GlobalString(utils.SyncModeFlag.Name) != "light" && !ctx.GlobalIsSet(utils.CacheFlag.Name) && !ctx.GlobalIsSet(utils.NetworkIdFlag.Name) {
- // Make sure we're not on any supported preconfigured testnet either
- if !ctx.GlobalIsSet(utils.RopstenFlag.Name) && !ctx.GlobalIsSet(utils.RinkebyFlag.Name) && !ctx.GlobalIsSet(utils.GoerliFlag.Name) && !ctx.GlobalIsSet(utils.DeveloperFlag.Name) {
- // Nope, we're really on mainnet. Bump that cache up!
- log.Info("Bumping default cache on mainnet", "provided", ctx.GlobalInt(utils.CacheFlag.Name), "updated", 4096)
- ctx.GlobalSet(utils.CacheFlag.Name, strconv.Itoa(4096))
- }
- }
- // If we're running a light client on any network, drop the cache to some meaningfully low amount
- if ctx.GlobalString(utils.SyncModeFlag.Name) == "light" && !ctx.GlobalIsSet(utils.CacheFlag.Name) {
- log.Info("Dropping default light client cache", "provided", ctx.GlobalInt(utils.CacheFlag.Name), "updated", 128)
- ctx.GlobalSet(utils.CacheFlag.Name, strconv.Itoa(128))
- }
- // Start metrics export if enabled
- utils.SetupMetrics(ctx)
- // Start system runtime metrics collection
- go metrics.CollectProcessMetrics(3 * time.Second)
- }
- // 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 {
- if args := ctx.Args(); len(args) > 0 {
- return fmt.Errorf("invalid command: %q", args[0])
- }
- prepare(ctx)
- stack, backend := makeFullNode(ctx)
- defer stack.Close()
- startNode(ctx, stack, backend)
- stack.Wait()
- return nil
- }
- // 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, backend ethapi.Backend) {
- log.DoEmitCheckpoints = ctx.GlobalBool(utils.EmitCheckpointsFlag.Name)
- debug.Memsize.Add("node", stack)
- // raft mode does not support --exitwhensynced
- if ctx.GlobalBool(utils.ExitWhenSyncedFlag.Name) && ctx.GlobalBool(utils.RaftModeFlag.Name) {
- utils.Fatalf("raft consensus does not support --exitwhensynced")
- }
- // Start up the node itself
- utils.StartNode(ctx, stack)
- // Now that the plugin manager has been started we register the account plugin with the corresponding account backend. All other account management is disabled when using External Signer
- if !ctx.IsSet(utils.ExternalSignerFlag.Name) && stack.PluginManager().IsEnabled(plugin.AccountPluginInterfaceName) {
- b := stack.AccountManager().Backends(pluggable.BackendType)[0].(*pluggable.Backend)
- if err := stack.PluginManager().AddAccountPluginToBackend(b); err != nil {
- log.Error("failed to setup account plugin", "err", err)
- }
- }
- // Unlock any account specifically requested
- unlockAccounts(ctx, stack)
- // Register wallet event handlers to open and auto-derive wallets
- events := make(chan accounts.WalletEvent, 16)
- stack.AccountManager().Subscribe(events)
- // Create a client to interact with local geth node.
- rpcClient, err := stack.Attach()
- if err != nil {
- utils.Fatalf("Failed to attach to self: %v", err)
- }
- ethClient := ethclient.NewClient(rpcClient)
- // Quorum
- if ctx.GlobalBool(utils.MultitenancyFlag.Name) && !stack.PluginManager().IsEnabled(plugin.SecurityPluginInterfaceName) {
- utils.Fatalf("multitenancy requires RPC Security Plugin to be configured")
- }
- // End Quorum
- go func() {
- // Open 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)
- }
- }
- // Listen for wallet event till termination
- for event := range events {
- switch event.Kind {
- case accounts.WalletArrived:
- if err := event.Wallet.Open(""); err != nil {
- log.Warn("New wallet appeared, failed to open", "url", event.Wallet.URL(), "err", err)
- }
- case accounts.WalletOpened:
- status, _ := event.Wallet.Status()
- log.Info("New wallet appeared", "url", event.Wallet.URL(), "status", status)
- var derivationPaths []accounts.DerivationPath
- if event.Wallet.URL().Scheme == "ledger" {
- derivationPaths = append(derivationPaths, accounts.LegacyLedgerBaseDerivationPath)
- }
- derivationPaths = append(derivationPaths, accounts.DefaultBaseDerivationPath)
- event.Wallet.SelfDerive(derivationPaths, ethClient)
- case accounts.WalletDropped:
- log.Info("Old wallet dropped", "url", event.Wallet.URL())
- event.Wallet.Close()
- }
- }
- }()
- // Spawn a standalone goroutine for status synchronization monitoring,
- // close the node when synchronization is complete if user required.
- if ctx.GlobalBool(utils.ExitWhenSyncedFlag.Name) {
- go func() {
- sub := stack.EventMux().Subscribe(downloader.DoneEvent{})
- defer sub.Unsubscribe()
- for {
- event := <-sub.Chan()
- if event == nil {
- continue
- }
- done, ok := event.Data.(downloader.DoneEvent)
- if !ok {
- continue
- }
- if timestamp := time.Unix(int64(done.Latest.Time), 0); time.Since(timestamp) < 10*time.Minute {
- log.Info("Synchronisation completed", "latestnum", done.Latest.Number, "latesthash", done.Latest.Hash(),
- "age", common.PrettyAge(timestamp))
- stack.Close()
- }
- }
- }()
- }
- // Quorum
- //
- // checking if permissions is enabled and staring the permissions service
- if stack.Config().EnableNodePermission {
- stack.Server().SetIsNodePermissioned(permission.IsNodePermissioned)
- if stack.IsPermissionEnabled() {
- var permissionService *permission.PermissionCtrl
- if err := stack.Lifecycle(&permissionService); err != nil {
- utils.Fatalf("Permission service not runnning: %v", err)
- }
- if err := permissionService.AfterStart(); err != nil {
- utils.Fatalf("Permission service post construct failure: %v", err)
- }
- }
- }
- // Start auxiliary services if enabled
- if ctx.GlobalBool(utils.MiningEnabledFlag.Name) || ctx.GlobalBool(utils.DeveloperFlag.Name) {
- // Mining only makes sense if a full Ethereum node is running
- if ctx.GlobalString(utils.SyncModeFlag.Name) == "light" {
- utils.Fatalf("Light clients do not support mining")
- }
- ethBackend, ok := backend.(*eth.EthAPIBackend)
- if !ok {
- utils.Fatalf("Ethereum service not running: %v", err)
- }
- // Set the gas price to the limits from the CLI and start mining
- gasprice := utils.GlobalBig(ctx, utils.MinerGasPriceFlag.Name)
- ethBackend.TxPool().SetGasPrice(gasprice)
- // start mining
- threads := ctx.GlobalInt(utils.MinerThreadsFlag.Name)
- if err := ethBackend.StartMining(threads); err != nil {
- utils.Fatalf("Failed to start mining: %v", err)
- }
- }
- // checks quorum features that depend on the ethereum service
- quorumValidateEthService(stack, ctx.GlobalBool(utils.RaftModeFlag.Name))
- }
- // unlockAccounts unlocks any account specifically requested.
- func unlockAccounts(ctx *cli.Context, stack *node.Node) {
- var unlocks []string
- inputs := strings.Split(ctx.GlobalString(utils.UnlockedAccountFlag.Name), ",")
- for _, input := range inputs {
- if trimmed := strings.TrimSpace(input); trimmed != "" {
- unlocks = append(unlocks, trimmed)
- }
- }
- // Short circuit if there is no account to unlock.
- if len(unlocks) == 0 {
- return
- }
- // If insecure account unlocking is not allowed if node's APIs are exposed to external.
- // Print warning log to user and skip unlocking.
- if !stack.Config().InsecureUnlockAllowed && stack.Config().ExtRPCEnabled() {
- utils.Fatalf("Account unlock with HTTP access is forbidden!")
- }
- ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
- passwords := utils.MakePasswordList(ctx)
- for i, account := range unlocks {
- unlockAccount(ks, account, i, passwords)
- }
- }
|