// 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 // 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 . package main import ( "encoding/json" "errors" "fmt" "io" "net" "os" "path" "runtime" "strconv" "strings" "sync/atomic" "time" "github.com/olekukonko/tablewriter" "github.com/urfave/cli/v2" "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/core" "github.com/ethereum/go-ethereum/core/rawdb" "github.com/ethereum/go-ethereum/core/state" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/ethdb" "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/p2p/enode" "github.com/ethereum/go-ethereum/trie" "github.com/ethereum/go-ethereum/trie/triedb/pathdb" ) var ( initCommand = &cli.Command{ Action: initGenesis, Name: "init", Usage: "Bootstrap and initialize a new genesis block", ArgsUsage: "", Flags: flags.Merge([]cli.Flag{ utils.CachePreimagesFlag, utils.OverrideCancun, utils.OverrideVerkle, }, utils.DatabaseFlags), Description: ` The init command initializes a new genesis block and definition for the network. This is a destructive action and changes the network in which you will be participating. It expects the genesis file as argument.`, } initNetworkCommand = &cli.Command{ Action: initNetwork, Name: "init-network", Usage: "Bootstrap and initialize a new genesis block, and nodekey, config files for network nodes", ArgsUsage: "", Flags: []cli.Flag{ utils.InitNetworkDir, utils.InitNetworkPort, utils.InitNetworkSize, utils.InitNetworkIps, configFileFlag, }, Category: "BLOCKCHAIN COMMANDS", Description: ` The init-network command initializes a new genesis block, definition for the network, config files for network nodes. It expects the genesis file as argument.`, } dumpGenesisCommand = &cli.Command{ Action: dumpGenesis, Name: "dumpgenesis", Usage: "Dumps genesis block JSON configuration to stdout", ArgsUsage: "", Flags: append([]cli.Flag{utils.DataDirFlag}, utils.NetworkFlags...), Description: ` The dumpgenesis command prints the genesis configuration of the network preset if one is set. Otherwise it prints the genesis from the datadir.`, } importCommand = &cli.Command{ Action: importChain, Name: "import", Usage: "Import a blockchain file", ArgsUsage: " ( ... ) ", Flags: flags.Merge([]cli.Flag{ utils.CacheFlag, utils.SyncModeFlag, utils.GCModeFlag, utils.SnapshotFlag, utils.CacheDatabaseFlag, utils.CacheGCFlag, utils.MetricsEnabledFlag, utils.MetricsEnabledExpensiveFlag, utils.MetricsHTTPFlag, utils.MetricsPortFlag, utils.MetricsEnableInfluxDBFlag, utils.MetricsEnableInfluxDBV2Flag, utils.MetricsInfluxDBEndpointFlag, utils.MetricsInfluxDBDatabaseFlag, utils.MetricsInfluxDBUsernameFlag, utils.MetricsInfluxDBPasswordFlag, utils.MetricsInfluxDBTagsFlag, utils.MetricsInfluxDBTokenFlag, utils.MetricsInfluxDBBucketFlag, utils.MetricsInfluxDBOrganizationFlag, utils.TxLookupLimitFlag, utils.TransactionHistoryFlag, utils.StateHistoryFlag, }, utils.DatabaseFlags), Description: ` The import command imports blocks from an RLP-encoded form. The form can be one file with several RLP-encoded blocks, or several files can be used. If only one file is used, import error will result in failure. If several files are used, processing will proceed even if an individual RLP-file import failure occurs.`, } exportCommand = &cli.Command{ Action: exportChain, Name: "export", Usage: "Export blockchain into file", ArgsUsage: " [ ]", Flags: flags.Merge([]cli.Flag{ utils.CacheFlag, utils.SyncModeFlag, }, utils.DatabaseFlags), Description: ` Requires a first argument of the file to write to. Optional second and third arguments control the first and last block to write. In this mode, the file will be appended if already existing. If the file ends with .gz, the output will be gzipped.`, } importPreimagesCommand = &cli.Command{ Action: importPreimages, Name: "import-preimages", Usage: "Import the preimage database from an RLP stream", ArgsUsage: "", Flags: flags.Merge([]cli.Flag{ utils.CacheFlag, utils.SyncModeFlag, }, utils.DatabaseFlags), Description: ` The import-preimages command imports hash preimages from an RLP encoded stream. It's deprecated, please use "geth db import" instead. `, } dumpCommand = &cli.Command{ Action: dump, Name: "dump", Usage: "Dump a specific block from storage", ArgsUsage: "[? | ]", Flags: flags.Merge([]cli.Flag{ utils.CacheFlag, utils.IterativeOutputFlag, utils.ExcludeCodeFlag, utils.ExcludeStorageFlag, utils.IncludeIncompletesFlag, utils.StartKeyFlag, utils.DumpLimitFlag, }, utils.DatabaseFlags), Description: ` This command dumps out the state for a given block (or latest, if none provided). If you use "dump" command in path mode, please firstly use "dump-roothash" command to get all available state root hash. `, } dumpRootHashCommand = &cli.Command{ Action: dumpAllRootHashInPath, Name: "dump-roothash", Usage: "Dump all available state root hash in path mode", Flags: flags.Merge([]cli.Flag{}, utils.DatabaseFlags), Description: ` The dump-roothash command dump all available state root hash in path mode. If you use "dump" command in path mode, please note that it only keeps at most 129 blocks which belongs to diffLayer or diskLayer. Therefore, you must specify the blockNumber or blockHash that locates in diffLayer or diskLayer. "geth" will print all available blockNumber and related block state root hash, and you can query block hash by block number. `, } ) // 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 { if ctx.Args().Len() != 1 { utils.Fatalf("need genesis.json file as the only argument") } genesisPath := ctx.Args().First() if len(genesisPath) == 0 { utils.Fatalf("invalid path to genesis file") } file, err := os.Open(genesisPath) if err != nil { utils.Fatalf("Failed to read genesis file: %v", err) } defer file.Close() genesis := new(core.Genesis) if err := json.NewDecoder(file).Decode(genesis); err != nil { utils.Fatalf("invalid genesis file: %v", err) } // Open and initialise both full and light databases stack, _ := makeConfigNode(ctx) defer stack.Close() var overrides core.ChainOverrides if ctx.IsSet(utils.OverrideCancun.Name) { v := ctx.Uint64(utils.OverrideCancun.Name) overrides.OverrideCancun = &v } if ctx.IsSet(utils.OverrideVerkle.Name) { v := ctx.Uint64(utils.OverrideVerkle.Name) overrides.OverrideVerkle = &v } for _, name := range []string{"chaindata", "lightchaindata"} { chaindb, err := stack.OpenDatabaseWithFreezer(name, 0, 0, ctx.String(utils.AncientFlag.Name), "", false, false, false, false) if err != nil { utils.Fatalf("Failed to open database: %v", err) } defer chaindb.Close() // if the trie data dir has been set, new trie db with a new state database if ctx.IsSet(utils.SeparateDBFlag.Name) { statediskdb, dbErr := stack.OpenDatabaseWithFreezer(name+"/state", 0, 0, "", "", false, false, false, false) if dbErr != nil { utils.Fatalf("Failed to open separate trie database: %v", dbErr) } chaindb.SetStateStore(statediskdb) } triedb := utils.MakeTrieDatabase(ctx, chaindb, ctx.Bool(utils.CachePreimagesFlag.Name), false, genesis.IsVerkle()) defer triedb.Close() _, hash, err := core.SetupGenesisBlockWithOverride(chaindb, triedb, genesis, &overrides) if err != nil { utils.Fatalf("Failed to write genesis block: %v", err) } log.Info("Successfully wrote genesis state", "database", name, "hash", hash.String()) } return nil } func parseIps(ipStr string, size int) ([]string, error) { var ips []string if len(ipStr) != 0 { ips = strings.Split(ipStr, ",") if len(ips) != size { return nil, errors.New("mismatch of size and length of ips") } for i := 0; i < size; i++ { _, err := net.ResolveIPAddr("", ips[i]) if err != nil { return nil, errors.New("invalid format of ip") } } } else { ips = make([]string, size) for i := 0; i < size; i++ { ips[i] = "127.0.0.1" } } return ips, nil } func createPorts(ipStr string, port int, size int) []int { ports := make([]int, size) if len(ipStr) == 0 { // localhost , so different ports for i := 0; i < size; i++ { ports[i] = port + i } } else { // different machines, keep same port for i := 0; i < size; i++ { ports[i] = port } } return ports } // Create config for node i in the cluster func createNodeConfig(baseConfig gethConfig, enodes []*enode.Node, ip string, port int, size int, i int) gethConfig { baseConfig.Node.HTTPHost = ip baseConfig.Node.P2P.ListenAddr = fmt.Sprintf(":%d", port) baseConfig.Node.P2P.BootstrapNodes = make([]*enode.Node, size-1) // Set the P2P connections between this node and the other nodes for j := 0; j < i; j++ { baseConfig.Node.P2P.BootstrapNodes[j] = enodes[j] } for j := i + 1; j < size; j++ { baseConfig.Node.P2P.BootstrapNodes[j-1] = enodes[j] } return baseConfig } // Create configs for nodes in the cluster func createNodeConfigs(baseConfig gethConfig, initDir string, ips []string, ports []int, size int) ([]gethConfig, error) { // Create the nodes enodes := make([]*enode.Node, size) for i := 0; i < size; i++ { nodeConfig := baseConfig.Node nodeConfig.DataDir = path.Join(initDir, fmt.Sprintf("node%d", i)) stack, err := node.New(&nodeConfig) if err != nil { return nil, err } pk := stack.Config().NodeKey() enodes[i] = enode.NewV4(&pk.PublicKey, net.ParseIP(ips[i]), ports[i], ports[i]) } // Create the configs configs := make([]gethConfig, size) for i := 0; i < size; i++ { configs[i] = createNodeConfig(baseConfig, enodes, ips[i], ports[i], size, i) } return configs, nil } // initNetwork will bootstrap and initialize a new genesis block, and nodekey, config files for network nodes func initNetwork(ctx *cli.Context) error { initDir := ctx.String(utils.InitNetworkDir.Name) if len(initDir) == 0 { utils.Fatalf("init.dir is required") } size := ctx.Int(utils.InitNetworkSize.Name) if size <= 0 { utils.Fatalf("size should be greater than 0") } port := ctx.Int(utils.InitNetworkPort.Name) if port <= 0 { utils.Fatalf("port should be greater than 0") } ipStr := ctx.String(utils.InitNetworkIps.Name) cfgFile := ctx.String(configFileFlag.Name) if len(cfgFile) == 0 { utils.Fatalf("config file is required") } ips, err := parseIps(ipStr, size) if err != nil { utils.Fatalf("Failed to pase ips string: %v", err) } ports := createPorts(ipStr, port, size) // Make sure we have a valid genesis JSON genesisPath := ctx.Args().First() if len(genesisPath) == 0 { utils.Fatalf("Must supply path to genesis JSON file") } inGenesisFile, err := os.Open(genesisPath) if err != nil { utils.Fatalf("Failed to read genesis file: %v", err) } defer inGenesisFile.Close() genesis := new(core.Genesis) if err := json.NewDecoder(inGenesisFile).Decode(genesis); err != nil { utils.Fatalf("invalid genesis file: %v", err) } // load config var config gethConfig err = loadConfig(cfgFile, &config) if err != nil { return err } configs, err := createNodeConfigs(config, initDir, ips, ports, size) if err != nil { utils.Fatalf("Failed to create node configs: %v", err) } for i := 0; i < size; i++ { // Write config.toml configBytes, err := tomlSettings.Marshal(configs[i]) if err != nil { return err } configFile, err := os.OpenFile(path.Join(initDir, fmt.Sprintf("node%d", i), "config.toml"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644) if err != nil { return err } defer configFile.Close() configFile.Write(configBytes) // Write the input genesis.json to the node's directory outGenesisFile, err := os.OpenFile(path.Join(initDir, fmt.Sprintf("node%d", i), "genesis.json"), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644) if err != nil { return err } _, err = inGenesisFile.Seek(0, io.SeekStart) if err != nil { return err } _, err = io.Copy(outGenesisFile, inGenesisFile) if err != nil { return err } } return nil } func dumpGenesis(ctx *cli.Context) error { // check if there is a testnet preset enabled var genesis *core.Genesis if utils.IsNetworkPreset(ctx) { genesis = utils.MakeGenesis(ctx) } else if ctx.IsSet(utils.DeveloperFlag.Name) && !ctx.IsSet(utils.DataDirFlag.Name) { genesis = core.DeveloperGenesisBlock(11_500_000, nil) } if genesis != nil { if err := json.NewEncoder(os.Stdout).Encode(genesis); err != nil { utils.Fatalf("could not encode genesis: %s", err) } return nil } // dump whatever already exists in the datadir stack, _ := makeConfigNode(ctx) for _, name := range []string{"chaindata", "lightchaindata"} { db, err := stack.OpenDatabase(name, 0, 0, "", true) if err != nil { if !os.IsNotExist(err) { return err } continue } genesis, err := core.ReadGenesis(db) if err != nil { utils.Fatalf("failed to read genesis: %s", err) } db.Close() if err := json.NewEncoder(os.Stdout).Encode(*genesis); err != nil { utils.Fatalf("could not encode stored genesis: %s", err) } return nil } if ctx.IsSet(utils.DataDirFlag.Name) { utils.Fatalf("no existing datadir at %s", stack.Config().DataDir) } utils.Fatalf("no network preset provided, and no genesis exists in the default datadir") return nil } func importChain(ctx *cli.Context) error { if ctx.Args().Len() < 1 { utils.Fatalf("This command requires an argument.") } // Start metrics export if enabled utils.SetupMetrics(ctx) // Start system runtime metrics collection go metrics.CollectProcessMetrics(3 * time.Second) stack, _ := makeConfigNode(ctx) defer stack.Close() chain, db := utils.MakeChain(ctx, stack, false) defer db.Close() // Start periodically gathering memory profiles var peakMemAlloc, peakMemSys atomic.Uint64 go func() { stats := new(runtime.MemStats) for { runtime.ReadMemStats(stats) if peakMemAlloc.Load() < stats.Alloc { peakMemAlloc.Store(stats.Alloc) } if peakMemSys.Load() < stats.Sys { peakMemSys.Store(stats.Sys) } time.Sleep(5 * time.Second) } }() // Import the chain start := time.Now() var importErr error if ctx.Args().Len() == 1 { if err := utils.ImportChain(chain, ctx.Args().First()); err != nil { importErr = err log.Error("Import error", "err", err) } } else { for _, arg := range ctx.Args().Slice() { if err := utils.ImportChain(chain, arg); err != nil { importErr = err log.Error("Import error", "file", arg, "err", err) } } } chain.Stop() fmt.Printf("Import done in %v.\n\n", time.Since(start)) // Output pre-compaction stats mostly to see the import trashing showLeveldbStats(db) // Print the memory statistics used by the importing mem := new(runtime.MemStats) runtime.ReadMemStats(mem) fmt.Printf("Object memory: %.3f MB current, %.3f MB peak\n", float64(mem.Alloc)/1024/1024, float64(peakMemAlloc.Load())/1024/1024) fmt.Printf("System memory: %.3f MB current, %.3f MB peak\n", float64(mem.Sys)/1024/1024, float64(peakMemSys.Load())/1024/1024) fmt.Printf("Allocations: %.3f million\n", float64(mem.Mallocs)/1000000) fmt.Printf("GC pause: %v\n\n", time.Duration(mem.PauseTotalNs)) if ctx.Bool(utils.NoCompactionFlag.Name) { return nil } // Compact the entire database to more accurately measure disk io and print the stats start = time.Now() fmt.Println("Compacting entire database...") if err := db.Compact(nil, nil); err != nil { utils.Fatalf("Compaction failed: %v", err) } fmt.Printf("Compaction done in %v.\n\n", time.Since(start)) showLeveldbStats(db) return importErr } func exportChain(ctx *cli.Context) error { if ctx.Args().Len() < 1 { utils.Fatalf("This command requires an argument.") } stack, _ := makeConfigNode(ctx) defer stack.Close() chain, db := utils.MakeChain(ctx, stack, true) defer db.Close() start := time.Now() var err error fp := ctx.Args().First() if ctx.Args().Len() < 3 { err = utils.ExportChain(chain, fp) } else { // This can be improved to allow for numbers larger than 9223372036854775807 first, ferr := strconv.ParseInt(ctx.Args().Get(1), 10, 64) last, lerr := strconv.ParseInt(ctx.Args().Get(2), 10, 64) if ferr != nil || lerr != nil { utils.Fatalf("Export error in parsing parameters: block number not an integer\n") } if first < 0 || last < 0 { utils.Fatalf("Export error: block number must be greater than 0\n") } if head := chain.CurrentSnapBlock(); uint64(last) > head.Number.Uint64() { utils.Fatalf("Export error: block number %d larger than head block %d\n", uint64(last), head.Number.Uint64()) } err = utils.ExportAppendChain(chain, fp, uint64(first), uint64(last)) } if err != nil { utils.Fatalf("Export error: %v\n", err) } fmt.Printf("Export done in %v\n", time.Since(start)) return nil } // importPreimages imports preimage data from the specified file. // it is deprecated, and the export function has been removed, but // the import function is kept around for the time being so that // older file formats can still be imported. func importPreimages(ctx *cli.Context) error { if ctx.Args().Len() < 1 { utils.Fatalf("This command requires an argument.") } stack, _ := makeConfigNode(ctx) defer stack.Close() db := utils.MakeChainDatabase(ctx, stack, false, false) defer db.Close() start := time.Now() if err := utils.ImportPreimages(db, ctx.Args().First()); err != nil { utils.Fatalf("Import error: %v\n", err) } fmt.Printf("Import done in %v\n", time.Since(start)) return nil } func parseDumpConfig(ctx *cli.Context, stack *node.Node) (*state.DumpConfig, ethdb.Database, common.Hash, error) { if ctx.NArg() > 1 { return nil, nil, common.Hash{}, fmt.Errorf("expected 1 argument (number or hash), got %d", ctx.NArg()) } db := utils.MakeChainDatabase(ctx, stack, true, false) scheme, err := rawdb.ParseStateScheme(ctx.String(utils.StateSchemeFlag.Name), db) if err != nil { return nil, nil, common.Hash{}, err } if scheme == rawdb.PathScheme { fmt.Println("You are using geth dump in path mode, please use `geth dump-roothash` command to get all available blocks.") } header := &types.Header{} if ctx.NArg() == 1 { arg := ctx.Args().First() if hashish(arg) { hash := common.HexToHash(arg) if number := rawdb.ReadHeaderNumber(db, hash); number != nil { header = rawdb.ReadHeader(db, hash, *number) } else { return nil, nil, common.Hash{}, fmt.Errorf("block %x not found", hash) } } else { number, err := strconv.ParseUint(arg, 10, 64) if err != nil { return nil, nil, common.Hash{}, err } if hash := rawdb.ReadCanonicalHash(db, number); hash != (common.Hash{}) { header = rawdb.ReadHeader(db, hash, number) } else { return nil, nil, common.Hash{}, fmt.Errorf("header for block %d not found", number) } } } else { // Use latest if scheme == rawdb.PathScheme { triedb := trie.NewDatabase(db, &trie.Config{PathDB: pathdb.ReadOnly}) defer triedb.Close() if stateRoot := triedb.Head(); stateRoot != (common.Hash{}) { header.Root = stateRoot } else { return nil, nil, common.Hash{}, fmt.Errorf("no top state root hash in path db") } } else { header = rawdb.ReadHeadHeader(db) } } if header == nil { return nil, nil, common.Hash{}, errors.New("no head block found") } startArg := common.FromHex(ctx.String(utils.StartKeyFlag.Name)) var start common.Hash switch len(startArg) { case 0: // common.Hash case 32: start = common.BytesToHash(startArg) case 20: start = crypto.Keccak256Hash(startArg) log.Info("Converting start-address to hash", "address", common.BytesToAddress(startArg), "hash", start.Hex()) default: return nil, nil, common.Hash{}, fmt.Errorf("invalid start argument: %x. 20 or 32 hex-encoded bytes required", startArg) } var conf = &state.DumpConfig{ SkipCode: ctx.Bool(utils.ExcludeCodeFlag.Name), SkipStorage: ctx.Bool(utils.ExcludeStorageFlag.Name), OnlyWithAddresses: !ctx.Bool(utils.IncludeIncompletesFlag.Name), Start: start.Bytes(), Max: ctx.Uint64(utils.DumpLimitFlag.Name), } conf.StateScheme = scheme log.Info("State dump configured", "block", header.Number, "hash", header.Hash().Hex(), "skipcode", conf.SkipCode, "skipstorage", conf.SkipStorage, "start", hexutil.Encode(conf.Start), "limit", conf.Max, "state scheme", conf.StateScheme) return conf, db, header.Root, nil } func dump(ctx *cli.Context) error { stack, _ := makeConfigNode(ctx) defer stack.Close() conf, db, root, err := parseDumpConfig(ctx, stack) if err != nil { return err } triedb := utils.MakeTrieDatabase(ctx, db, true, true, false) // always enable preimage lookup defer triedb.Close() state, err := state.New(root, state.NewDatabaseWithNodeDB(db, triedb), nil) if err != nil { return err } if ctx.Bool(utils.IterativeOutputFlag.Name) { state.IterativeDump(conf, json.NewEncoder(os.Stdout)) } else { fmt.Println(string(state.Dump(conf))) } return nil } func dumpAllRootHashInPath(ctx *cli.Context) error { stack, _ := makeConfigNode(ctx) defer stack.Close() db := utils.MakeChainDatabase(ctx, stack, true, false) defer db.Close() triedb := trie.NewDatabase(db, &trie.Config{PathDB: pathdb.ReadOnly}) defer triedb.Close() scheme, err := rawdb.ParseStateScheme(ctx.String(utils.StateSchemeFlag.Name), db) if err != nil { return err } if scheme == rawdb.HashScheme { return errors.New("incorrect state scheme, you should use it in path mode") } table := tablewriter.NewWriter(os.Stdout) table.SetHeader([]string{"Block Number", "Block State Root Hash"}) table.AppendBulk(triedb.GetAllRooHash()) table.Render() return nil } // hashish returns true for strings that look like hashes. func hashish(x string) bool { _, err := strconv.Atoi(x) return err != nil }