aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/geth/main.go
blob: a0638605132e1ab6c0caff8ff60ba6c5df1ad2a8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
// 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"
    "math"
    "os"
    "runtime"
    godebug "runtime/debug"
    "sort"
    "strconv"
    "strings"
    "time"

    "github.com/elastic/gosigar"
    "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/console"
    "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"
    "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 = ""
    // The app that holds all commands and flags.
    app = utils.NewApp(gitCommit, "the go-ethereum command line interface")
    // flags that configure the node
    nodeFlags = []cli.Flag{
        utils.IdentityFlag,
        utils.UnlockedAccountFlag,
        utils.PasswordFileFlag,
        utils.BootnodesFlag,
        utils.BootnodesV4Flag,
        utils.BootnodesV5Flag,
        utils.DataDirFlag,
        utils.KeyStoreDirFlag,
        utils.NoUSBFlag,
        utils.DashboardEnabledFlag,
        utils.DashboardAddrFlag,
        utils.DashboardPortFlag,
        utils.DashboardRefreshFlag,
        utils.EthashCacheDirFlag,
        utils.EthashCachesInMemoryFlag,
        utils.EthashCachesOnDiskFlag,
        utils.EthashDatasetDirFlag,
        utils.EthashDatasetsInMemoryFlag,
        utils.EthashDatasetsOnDiskFlag,
        utils.TxPoolNoLocalsFlag,
        utils.TxPoolJournalFlag,
        utils.TxPoolRejournalFlag,
        utils.TxPoolPriceLimitFlag,
        utils.TxPoolPriceBumpFlag,
        utils.TxPoolAccountSlotsFlag,
        utils.TxPoolGlobalSlotsFlag,
        utils.TxPoolAccountQueueFlag,
        utils.TxPoolGlobalQueueFlag,
        utils.TxPoolLifetimeFlag,
        utils.SyncModeFlag,
        utils.GCModeFlag,
        utils.LightServFlag,
        utils.LightPeersFlag,
        utils.LightKDFFlag,
        utils.CacheFlag,
        utils.CacheDatabaseFlag,
        utils.CacheGCFlag,
        utils.TrieCacheGenFlag,
        utils.ListenPortFlag,
        utils.MaxPeersFlag,
        utils.MaxPendingPeersFlag,
        utils.MiningEnabledFlag,
        utils.MinerThreadsFlag,
        utils.MinerLegacyThreadsFlag,
        utils.MinerNotifyFlag,
        utils.MinerGasTargetFlag,
        utils.MinerLegacyGasTargetFlag,
        utils.MinerGasPriceFlag,
        utils.MinerLegacyGasPriceFlag,
        utils.MinerEtherbaseFlag,
        utils.MinerLegacyEtherbaseFlag,
        utils.MinerExtraDataFlag,
        utils.MinerLegacyExtraDataFlag,
        utils.NATFlag,
        utils.NoDiscoverFlag,
        utils.DiscoveryV5Flag,
        utils.NetrestrictFlag,
        utils.NodeKeyFileFlag,
        utils.NodeKeyHexFlag,
        utils.DeveloperFlag,
        utils.DeveloperPeriodFlag,
        utils.TestnetFlag,
        utils.RinkebyFlag,
        utils.VMEnableDebugFlag,
        utils.NetworkIdFlag,
        utils.RPCCORSDomainFlag,
        utils.RPCVirtualHostsFlag,
        utils.EthStatsURLFlag,
        utils.MetricsEnabledFlag,
        utils.FakePoWFlag,
        utils.NoCompactionFlag,
        utils.GpoBlocksFlag,
        utils.GpoPercentileFlag,
        configFileFlag,
    }

    rpcFlags = []cli.Flag{
        utils.RPCEnabledFlag,
        utils.RPCListenAddrFlag,
        utils.RPCPortFlag,
        utils.RPCApiFlag,
        utils.WSEnabledFlag,
        utils.WSListenAddrFlag,
        utils.WSPortFlag,
        utils.WSApiFlag,
        utils.WSAllowedOriginsFlag,
        utils.IPCDisabledFlag,
        utils.IPCPathFlag,
    }

    whisperFlags = []cli.Flag{
        utils.WhisperEnabledFlag,
        utils.WhisperMaxMessageSizeFlag,
        utils.WhisperMinPOWFlag,
    }

    metricsFlags = []cli.Flag{
        utils.MetricsEnableInfluxDBFlag,
        utils.MetricsInfluxDBEndpointFlag,
        utils.MetricsInfluxDBDatabaseFlag,
        utils.MetricsInfluxDBUsernameFlag,
        utils.MetricsInfluxDBPasswordFlag,
        utils.MetricsInfluxDBHostTagFlag,
    }
)

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-2018 The go-ethereum Authors"
    app.Commands = []cli.Command{
        // See chaincmd.go:
        initCommand,
        importCommand,
        exportCommand,
        importPreimagesCommand,
        exportPreimagesCommand,
        copydbCommand,
        removedbCommand,
        dumpCommand,
        // See monitorcmd.go:
        monitorCommand,
        // See accountcmd.go:
        accountCommand,
        walletCommand,
        // See consolecmd.go:
        consoleCommand,
        attachCommand,
        javascriptCommand,
        // See misccmd.go:
        makecacheCommand,
        makedagCommand,
        versionCommand,
        bugCommand,
        licenseCommand,
        // See config.go
        dumpConfigCommand,
    }
    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, whisperFlags...)
    app.Flags = append(app.Flags, metricsFlags...)

    app.Before = func(ctx *cli.Context) error {
        runtime.GOMAXPROCS(runtime.NumCPU())

        logdir := ""
        if ctx.GlobalBool(utils.DashboardEnabledFlag.Name) {
            logdir = (&node.Config{DataDir: utils.MakeDataDir(ctx)}).ResolvePath("logs")
        }
        if err := debug.Setup(ctx, logdir); err != nil {
            return err
        }
        // Cap the cache allowance and tune the garbage collector
        var mem gosigar.Mem
        if err := mem.Get(); err == nil {
            allowance := int(mem.Total / 1024 / 1024 / 3)
            if cache := ctx.GlobalInt(utils.CacheFlag.Name); cache > allowance {
                log.Warn("Sanitizing cache to Go's GC limits", "provided", cache, "updated", allowance)
                ctx.GlobalSet(utils.CacheFlag.Name, strconv.Itoa(allowance))
            }
        }
        // Ensure Go's GC ignores the database cache for trigger percentage
        cache := ctx.GlobalInt(utils.CacheFlag.Name)
        gogc := math.Max(20, math.Min(100, 100/(float64(cache)/1024)))

        log.Debug("Sanitizing Go's GC trigger", "percent", int(gogc))
        godebug.SetGCPercent(int(gogc))

        // Start metrics export if enabled
        utils.SetupMetrics(ctx)

        // Start system runtime metrics collection
        go metrics.CollectProcessMetrics(3 * time.Second)

        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 {
    if args := ctx.Args(); len(args) > 0 {
        return fmt.Errorf("invalid command: %q", args[0])
    }
    node := makeFullNode(ctx)
    startNode(ctx, node)
    node.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) {
    debug.Memsize.Add("node", stack)

    // 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 a 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 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)

                derivationPath := accounts.DefaultBaseDerivationPath
                if event.Wallet.URL().Scheme == "ledger" {
                    derivationPath = accounts.DefaultLedgerBaseDerivationPath
                }
                event.Wallet.SelfDerive(derivationPath, stateReader)

            case accounts.WalletDropped:
                log.Info("Old wallet dropped", "url", event.Wallet.URL())
                event.Wallet.Close()
            }
        }
    }()
    // 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")
        }
        var ethereum *eth.Ethereum
        if err := stack.Service(&ethereum); err != nil {
            utils.Fatalf("Ethereum service not running: %v", err)
        }
        // Use a reduced number of threads if requested
        threads := ctx.GlobalInt(utils.MinerLegacyThreadsFlag.Name)
        if ctx.GlobalIsSet(utils.MinerThreadsFlag.Name) {
            threads = ctx.GlobalInt(utils.MinerThreadsFlag.Name)
        }
        if threads > 0 {
            type threaded interface {
                SetThreads(threads int)
            }
            if th, ok := ethereum.Engine().(threaded); ok {
                th.SetThreads(threads)
            }
        }
        // Set the gas price to the limits from the CLI and start mining
        gasprice := utils.GlobalBig(ctx, utils.MinerLegacyGasPriceFlag.Name)
        if ctx.IsSet(utils.MinerGasPriceFlag.Name) {
            gasprice = utils.GlobalBig(ctx, utils.MinerGasPriceFlag.Name)
        }
        ethereum.TxPool().SetGasPrice(gasprice)
        if err := ethereum.StartMining(true); err != nil {
            utils.Fatalf("Failed to start mining: %v", err)
        }
    }
}