| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040 |
- // 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 <http://www.gnu.org/licenses/>.
- // Package utils contains internal helper functions for go-ethereum commands.
- package utils
- import (
- "crypto/ecdsa"
- "fmt"
- "io"
- "io/ioutil"
- "math"
- "math/big"
- "os"
- "path/filepath"
- godebug "runtime/debug"
- "strconv"
- "strings"
- "text/tabwriter"
- "text/template"
- "time"
- pcsclite "github.com/gballet/go-libpcsclite"
- gopsutil "github.com/shirou/gopsutil/mem"
- "gopkg.in/urfave/cli.v1"
- "github.com/ethereum/go-ethereum/accounts"
- "github.com/ethereum/go-ethereum/accounts/keystore"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/common/fdlimit"
- "github.com/ethereum/go-ethereum/consensus"
- "github.com/ethereum/go-ethereum/consensus/clique"
- "github.com/ethereum/go-ethereum/consensus/ethash"
- "github.com/ethereum/go-ethereum/core"
- "github.com/ethereum/go-ethereum/core/rawdb"
- "github.com/ethereum/go-ethereum/core/vm"
- "github.com/ethereum/go-ethereum/crypto"
- "github.com/ethereum/go-ethereum/eth"
- "github.com/ethereum/go-ethereum/eth/downloader"
- "github.com/ethereum/go-ethereum/eth/ethconfig"
- "github.com/ethereum/go-ethereum/eth/gasprice"
- "github.com/ethereum/go-ethereum/eth/tracers"
- "github.com/ethereum/go-ethereum/ethdb"
- "github.com/ethereum/go-ethereum/ethstats"
- "github.com/ethereum/go-ethereum/graphql"
- "github.com/ethereum/go-ethereum/internal/ethapi"
- "github.com/ethereum/go-ethereum/internal/flags"
- "github.com/ethereum/go-ethereum/les"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/metrics"
- "github.com/ethereum/go-ethereum/metrics/exp"
- "github.com/ethereum/go-ethereum/metrics/influxdb"
- "github.com/ethereum/go-ethereum/miner"
- "github.com/ethereum/go-ethereum/node"
- "github.com/ethereum/go-ethereum/p2p"
- "github.com/ethereum/go-ethereum/p2p/enode"
- "github.com/ethereum/go-ethereum/p2p/nat"
- "github.com/ethereum/go-ethereum/p2p/netutil"
- "github.com/ethereum/go-ethereum/params"
- )
- func init() {
- cli.AppHelpTemplate = `{{.Name}} {{if .Flags}}[global options] {{end}}command{{if .Flags}} [command options]{{end}} [arguments...]
- VERSION:
- {{.Version}}
- COMMANDS:
- {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
- {{end}}{{if .Flags}}
- GLOBAL OPTIONS:
- {{range .Flags}}{{.}}
- {{end}}{{end}}
- `
- cli.CommandHelpTemplate = flags.CommandHelpTemplate
- cli.HelpPrinter = printHelp
- }
- func printHelp(out io.Writer, templ string, data interface{}) {
- funcMap := template.FuncMap{"join": strings.Join}
- t := template.Must(template.New("help").Funcs(funcMap).Parse(templ))
- w := tabwriter.NewWriter(out, 38, 8, 2, ' ', 0)
- err := t.Execute(w, data)
- if err != nil {
- panic(err)
- }
- w.Flush()
- }
- // These are all the command line flags we support.
- // If you add to this list, please remember to include the
- // flag in the appropriate command definition.
- //
- // The flags are defined here so their names and help texts
- // are the same for all commands.
- var (
- // General settings
- DataDirFlag = DirectoryFlag{
- Name: "datadir",
- Usage: "Data directory for the databases and keystore",
- Value: DirectoryString(node.DefaultDataDir()),
- }
- DirectBroadcastFlag = cli.BoolFlag{
- Name: "directbroadcast",
- Usage: "Enable directly broadcast mined block to all peers",
- }
- DisableSnapProtocolFlag = cli.BoolFlag{
- Name: "disablesnapprotocol",
- Usage: "Disable snap protocol",
- }
- DiffSyncFlag = cli.BoolFlag{
- Name: "diffsync",
- Usage: "Enable diffy sync, Please note that enable diffsync will improve the syncing speed, " +
- "but will degrade the security to light client level",
- }
- RangeLimitFlag = cli.BoolFlag{
- Name: "rangelimit",
- Usage: "Enable 5000 blocks limit for range query",
- }
- AncientFlag = DirectoryFlag{
- Name: "datadir.ancient",
- Usage: "Data directory for ancient chain segments (default = inside chaindata)",
- }
- DiffFlag = DirectoryFlag{
- Name: "datadir.diff",
- Usage: "Data directory for difflayer segments (default = inside chaindata)",
- }
- MinFreeDiskSpaceFlag = DirectoryFlag{
- Name: "datadir.minfreedisk",
- Usage: "Minimum free disk space in MB, once reached triggers auto shut down (default = --cache.gc converted to MB, 0 = disabled)",
- }
- KeyStoreDirFlag = DirectoryFlag{
- Name: "keystore",
- Usage: "Directory for the keystore (default = inside the datadir)",
- }
- NoUSBFlag = cli.BoolFlag{
- Name: "nousb",
- Usage: "Disables monitoring for and managing USB hardware wallets (deprecated)",
- }
- USBFlag = cli.BoolFlag{
- Name: "usb",
- Usage: "Enable monitoring and management of USB hardware wallets",
- }
- SmartCardDaemonPathFlag = cli.StringFlag{
- Name: "pcscdpath",
- Usage: "Path to the smartcard daemon (pcscd) socket file",
- Value: pcsclite.PCSCDSockName,
- }
- NetworkIdFlag = cli.Uint64Flag{
- Name: "networkid",
- Usage: "Explicitly set network id (integer)(For testnets: use --ropsten, --rinkeby, --goerli instead)",
- Value: ethconfig.Defaults.NetworkId,
- }
- MainnetFlag = cli.BoolFlag{
- Name: "mainnet",
- Usage: "Ethereum mainnet",
- }
- GoerliFlag = cli.BoolFlag{
- Name: "goerli",
- Usage: "Görli network: pre-configured proof-of-authority test network",
- }
- YoloV3Flag = cli.BoolFlag{
- Name: "yolov3",
- Usage: "YOLOv3 network: pre-configured proof-of-authority shortlived test network.",
- }
- RinkebyFlag = cli.BoolFlag{
- Name: "rinkeby",
- Usage: "Rinkeby network: pre-configured proof-of-authority test network",
- }
- RopstenFlag = cli.BoolFlag{
- Name: "ropsten",
- Usage: "Ropsten network: pre-configured proof-of-work test network",
- }
- DeveloperFlag = cli.BoolFlag{
- Name: "dev",
- Usage: "Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled",
- }
- DeveloperPeriodFlag = cli.IntFlag{
- Name: "dev.period",
- Usage: "Block period to use in developer mode (0 = mine only if transaction pending)",
- }
- IdentityFlag = cli.StringFlag{
- Name: "identity",
- Usage: "Custom node name",
- }
- DocRootFlag = DirectoryFlag{
- Name: "docroot",
- Usage: "Document Root for HTTPClient file scheme",
- Value: DirectoryString(HomeDir()),
- }
- ExitWhenSyncedFlag = cli.BoolFlag{
- Name: "exitwhensynced",
- Usage: "Exits after block synchronisation completes",
- }
- IterativeOutputFlag = cli.BoolFlag{
- Name: "iterative",
- Usage: "Print streaming JSON iteratively, delimited by newlines",
- }
- ExcludeStorageFlag = cli.BoolFlag{
- Name: "nostorage",
- Usage: "Exclude storage entries (save db lookups)",
- }
- IncludeIncompletesFlag = cli.BoolFlag{
- Name: "incompletes",
- Usage: "Include accounts for which we don't have the address (missing preimage)",
- }
- ExcludeCodeFlag = cli.BoolFlag{
- Name: "nocode",
- Usage: "Exclude contract code (save db lookups)",
- }
- defaultSyncMode = ethconfig.Defaults.SyncMode
- SyncModeFlag = TextMarshalerFlag{
- Name: "syncmode",
- Usage: `Blockchain sync mode ("fast", "full", "snap" or "light")`,
- Value: &defaultSyncMode,
- }
- GCModeFlag = cli.StringFlag{
- Name: "gcmode",
- Usage: `Blockchain garbage collection mode ("full", "archive")`,
- Value: "full",
- }
- SnapshotFlag = cli.BoolTFlag{
- Name: "snapshot",
- Usage: `Enables snapshot-database mode (default = enable)`,
- }
- TxLookupLimitFlag = cli.Uint64Flag{
- Name: "txlookuplimit",
- Usage: "Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain)",
- Value: ethconfig.Defaults.TxLookupLimit,
- }
- LightKDFFlag = cli.BoolFlag{
- Name: "lightkdf",
- Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
- }
- WhitelistFlag = cli.StringFlag{
- Name: "whitelist",
- Usage: "Comma separated block number-to-hash mappings to enforce (<number>=<hash>)",
- }
- BloomFilterSizeFlag = cli.Uint64Flag{
- Name: "bloomfilter.size",
- Usage: "Megabytes of memory allocated to bloom-filter for pruning",
- Value: 2048,
- }
- TriesInMemoryFlag = cli.Uint64Flag{
- Name: "triesInMemory",
- Usage: "The layer of tries trees that keep in memory",
- Value: 128,
- }
- OverrideBerlinFlag = cli.Uint64Flag{
- Name: "override.berlin",
- Usage: "Manually specify Berlin fork-block, overriding the bundled setting",
- }
- // Light server and client settings
- LightServeFlag = cli.IntFlag{
- Name: "light.serve",
- Usage: "Maximum percentage of time allowed for serving LES requests (multi-threaded processing allows values over 100)",
- Value: ethconfig.Defaults.LightServ,
- }
- LightIngressFlag = cli.IntFlag{
- Name: "light.ingress",
- Usage: "Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
- Value: ethconfig.Defaults.LightIngress,
- }
- LightEgressFlag = cli.IntFlag{
- Name: "light.egress",
- Usage: "Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 = unlimited)",
- Value: ethconfig.Defaults.LightEgress,
- }
- LightMaxPeersFlag = cli.IntFlag{
- Name: "light.maxpeers",
- Usage: "Maximum number of light clients to serve, or light servers to attach to",
- Value: ethconfig.Defaults.LightPeers,
- }
- UltraLightServersFlag = cli.StringFlag{
- Name: "ulc.servers",
- Usage: "List of trusted ultra-light servers",
- Value: strings.Join(ethconfig.Defaults.UltraLightServers, ","),
- }
- UltraLightFractionFlag = cli.IntFlag{
- Name: "ulc.fraction",
- Usage: "Minimum % of trusted ultra-light servers required to announce a new head",
- Value: ethconfig.Defaults.UltraLightFraction,
- }
- UltraLightOnlyAnnounceFlag = cli.BoolFlag{
- Name: "ulc.onlyannounce",
- Usage: "Ultra light server sends announcements only",
- }
- LightNoPruneFlag = cli.BoolFlag{
- Name: "light.nopruning",
- Usage: "Disable ancient light chain data pruning",
- }
- LightNoSyncServeFlag = cli.BoolFlag{
- Name: "light.nosyncserve",
- Usage: "Enables serving light clients before syncing",
- }
- // Ethash settings
- EthashCacheDirFlag = DirectoryFlag{
- Name: "ethash.cachedir",
- Usage: "Directory to store the ethash verification caches (default = inside the datadir)",
- }
- EthashCachesInMemoryFlag = cli.IntFlag{
- Name: "ethash.cachesinmem",
- Usage: "Number of recent ethash caches to keep in memory (16MB each)",
- Value: ethconfig.Defaults.Ethash.CachesInMem,
- }
- EthashCachesOnDiskFlag = cli.IntFlag{
- Name: "ethash.cachesondisk",
- Usage: "Number of recent ethash caches to keep on disk (16MB each)",
- Value: ethconfig.Defaults.Ethash.CachesOnDisk,
- }
- EthashCachesLockMmapFlag = cli.BoolFlag{
- Name: "ethash.cacheslockmmap",
- Usage: "Lock memory maps of recent ethash caches",
- }
- EthashDatasetDirFlag = DirectoryFlag{
- Name: "ethash.dagdir",
- Usage: "Directory to store the ethash mining DAGs",
- Value: DirectoryString(ethconfig.Defaults.Ethash.DatasetDir),
- }
- EthashDatasetsInMemoryFlag = cli.IntFlag{
- Name: "ethash.dagsinmem",
- Usage: "Number of recent ethash mining DAGs to keep in memory (1+GB each)",
- Value: ethconfig.Defaults.Ethash.DatasetsInMem,
- }
- EthashDatasetsOnDiskFlag = cli.IntFlag{
- Name: "ethash.dagsondisk",
- Usage: "Number of recent ethash mining DAGs to keep on disk (1+GB each)",
- Value: ethconfig.Defaults.Ethash.DatasetsOnDisk,
- }
- EthashDatasetsLockMmapFlag = cli.BoolFlag{
- Name: "ethash.dagslockmmap",
- Usage: "Lock memory maps for recent ethash mining DAGs",
- }
- // Transaction pool settings
- TxPoolLocalsFlag = cli.StringFlag{
- Name: "txpool.locals",
- Usage: "Comma separated accounts to treat as locals (no flush, priority inclusion)",
- }
- TxPoolNoLocalsFlag = cli.BoolFlag{
- Name: "txpool.nolocals",
- Usage: "Disables price exemptions for locally submitted transactions",
- }
- TxPoolJournalFlag = cli.StringFlag{
- Name: "txpool.journal",
- Usage: "Disk journal for local transaction to survive node restarts",
- Value: core.DefaultTxPoolConfig.Journal,
- }
- TxPoolRejournalFlag = cli.DurationFlag{
- Name: "txpool.rejournal",
- Usage: "Time interval to regenerate the local transaction journal",
- Value: core.DefaultTxPoolConfig.Rejournal,
- }
- TxPoolPriceLimitFlag = cli.Uint64Flag{
- Name: "txpool.pricelimit",
- Usage: "Minimum gas price limit to enforce for acceptance into the pool",
- Value: ethconfig.Defaults.TxPool.PriceLimit,
- }
- TxPoolPriceBumpFlag = cli.Uint64Flag{
- Name: "txpool.pricebump",
- Usage: "Price bump percentage to replace an already existing transaction",
- Value: ethconfig.Defaults.TxPool.PriceBump,
- }
- TxPoolAccountSlotsFlag = cli.Uint64Flag{
- Name: "txpool.accountslots",
- Usage: "Minimum number of executable transaction slots guaranteed per account",
- Value: ethconfig.Defaults.TxPool.AccountSlots,
- }
- TxPoolGlobalSlotsFlag = cli.Uint64Flag{
- Name: "txpool.globalslots",
- Usage: "Maximum number of executable transaction slots for all accounts",
- Value: ethconfig.Defaults.TxPool.GlobalSlots,
- }
- TxPoolAccountQueueFlag = cli.Uint64Flag{
- Name: "txpool.accountqueue",
- Usage: "Maximum number of non-executable transaction slots permitted per account",
- Value: ethconfig.Defaults.TxPool.AccountQueue,
- }
- TxPoolGlobalQueueFlag = cli.Uint64Flag{
- Name: "txpool.globalqueue",
- Usage: "Maximum number of non-executable transaction slots for all accounts",
- Value: ethconfig.Defaults.TxPool.GlobalQueue,
- }
- TxPoolLifetimeFlag = cli.DurationFlag{
- Name: "txpool.lifetime",
- Usage: "Maximum amount of time non-executable transaction are queued",
- Value: ethconfig.Defaults.TxPool.Lifetime,
- }
- TxPoolReannounceTimeFlag = cli.DurationFlag{
- Name: "txpool.reannouncetime",
- Usage: "Duration for announcing local pending transactions again (default = 10 years, minimum = 1 minute)",
- Value: ethconfig.Defaults.TxPool.ReannounceTime,
- }
- // Performance tuning settings
- CacheFlag = cli.IntFlag{
- Name: "cache",
- Usage: "Megabytes of memory allocated to internal caching (default = 4096 mainnet full node, 128 light mode)",
- Value: 1024,
- }
- CacheDatabaseFlag = cli.IntFlag{
- Name: "cache.database",
- Usage: "Percentage of cache memory allowance to use for database io",
- Value: 40,
- }
- CacheTrieFlag = cli.IntFlag{
- Name: "cache.trie",
- Usage: "Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode)",
- Value: 15,
- }
- CacheTrieJournalFlag = cli.StringFlag{
- Name: "cache.trie.journal",
- Usage: "Disk journal directory for trie cache to survive node restarts",
- Value: ethconfig.Defaults.TrieCleanCacheJournal,
- }
- CacheTrieRejournalFlag = cli.DurationFlag{
- Name: "cache.trie.rejournal",
- Usage: "Time interval to regenerate the trie cache journal",
- Value: ethconfig.Defaults.TrieCleanCacheRejournal,
- }
- CacheGCFlag = cli.IntFlag{
- Name: "cache.gc",
- Usage: "Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode)",
- Value: 25,
- }
- CacheSnapshotFlag = cli.IntFlag{
- Name: "cache.snapshot",
- Usage: "Percentage of cache memory allowance to use for snapshot caching (default = 20%)",
- Value: 20,
- }
- CachePreimagesFlag = cli.BoolFlag{
- Name: "cache.preimages",
- Usage: "Enable recording the SHA3/keccak preimages of trie keys",
- }
- PersistDiffFlag = cli.BoolFlag{
- Name: "persistdiff",
- Usage: "Enable persistence of the diff layer",
- }
- DiffBlockFlag = cli.Uint64Flag{
- Name: "diffblock",
- Usage: "The number of blocks should be persisted in db (default = 86400)",
- Value: uint64(86400),
- }
- // Miner settings
- MiningEnabledFlag = cli.BoolFlag{
- Name: "mine",
- Usage: "Enable mining",
- }
- MinerThreadsFlag = cli.IntFlag{
- Name: "miner.threads",
- Usage: "Number of CPU threads to use for mining",
- Value: 0,
- }
- MinerNotifyFlag = cli.StringFlag{
- Name: "miner.notify",
- Usage: "Comma separated HTTP URL list to notify of new work packages",
- }
- MinerNotifyFullFlag = cli.BoolFlag{
- Name: "miner.notify.full",
- Usage: "Notify with pending block headers instead of work packages",
- }
- MinerGasTargetFlag = cli.Uint64Flag{
- Name: "miner.gastarget",
- Usage: "Target gas floor for mined blocks",
- Value: ethconfig.Defaults.Miner.GasFloor,
- }
- MinerGasLimitFlag = cli.Uint64Flag{
- Name: "miner.gaslimit",
- Usage: "Target gas ceiling for mined blocks",
- Value: ethconfig.Defaults.Miner.GasCeil,
- }
- MinerGasPriceFlag = BigFlag{
- Name: "miner.gasprice",
- Usage: "Minimum gas price for mining a transaction",
- Value: ethconfig.Defaults.Miner.GasPrice,
- }
- MinerEtherbaseFlag = cli.StringFlag{
- Name: "miner.etherbase",
- Usage: "Public address for block mining rewards (default = first account)",
- Value: "0",
- }
- MinerExtraDataFlag = cli.StringFlag{
- Name: "miner.extradata",
- Usage: "Block extra data set by the miner (default = client version)",
- }
- MinerRecommitIntervalFlag = cli.DurationFlag{
- Name: "miner.recommit",
- Usage: "Time interval to recreate the block being mined",
- Value: ethconfig.Defaults.Miner.Recommit,
- }
- MinerDelayLeftoverFlag = cli.DurationFlag{
- Name: "miner.delayleftover",
- Usage: "Time interval to for broadcast block",
- Value: ethconfig.Defaults.Miner.DelayLeftOver,
- }
- MinerNoVerfiyFlag = cli.BoolFlag{
- Name: "miner.noverify",
- Usage: "Disable remote sealing verification",
- }
- // Account settings
- UnlockedAccountFlag = cli.StringFlag{
- Name: "unlock",
- Usage: "Comma separated list of accounts to unlock",
- Value: "",
- }
- PasswordFileFlag = cli.StringFlag{
- Name: "password",
- Usage: "Password file to use for non-interactive password input",
- Value: "",
- }
- ExternalSignerFlag = cli.StringFlag{
- Name: "signer",
- Usage: "External signer (url or path to ipc file)",
- Value: "",
- }
- VMEnableDebugFlag = cli.BoolFlag{
- Name: "vmdebug",
- Usage: "Record information useful for VM and contract debugging",
- }
- InsecureUnlockAllowedFlag = cli.BoolFlag{
- Name: "allow-insecure-unlock",
- Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http",
- }
- RPCGlobalGasCapFlag = cli.Uint64Flag{
- Name: "rpc.gascap",
- Usage: "Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)",
- Value: ethconfig.Defaults.RPCGasCap,
- }
- RPCGlobalTxFeeCapFlag = cli.Float64Flag{
- Name: "rpc.txfeecap",
- Usage: "Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap)",
- Value: ethconfig.Defaults.RPCTxFeeCap,
- }
- // Logging and debug settings
- EthStatsURLFlag = cli.StringFlag{
- Name: "ethstats",
- Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
- }
- FakePoWFlag = cli.BoolFlag{
- Name: "fakepow",
- Usage: "Disables proof-of-work verification",
- }
- NoCompactionFlag = cli.BoolFlag{
- Name: "nocompaction",
- Usage: "Disables db compaction after import",
- }
- // RPC settings
- IPCDisabledFlag = cli.BoolFlag{
- Name: "ipcdisable",
- Usage: "Disable the IPC-RPC server",
- }
- IPCPathFlag = DirectoryFlag{
- Name: "ipcpath",
- Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
- }
- HTTPEnabledFlag = cli.BoolFlag{
- Name: "http",
- Usage: "Enable the HTTP-RPC server",
- }
- HTTPListenAddrFlag = cli.StringFlag{
- Name: "http.addr",
- Usage: "HTTP-RPC server listening interface",
- Value: node.DefaultHTTPHost,
- }
- HTTPPortFlag = cli.IntFlag{
- Name: "http.port",
- Usage: "HTTP-RPC server listening port",
- Value: node.DefaultHTTPPort,
- }
- HTTPCORSDomainFlag = cli.StringFlag{
- Name: "http.corsdomain",
- Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
- Value: "",
- }
- HTTPVirtualHostsFlag = cli.StringFlag{
- Name: "http.vhosts",
- Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
- Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
- }
- HTTPApiFlag = cli.StringFlag{
- Name: "http.api",
- Usage: "API's offered over the HTTP-RPC interface",
- Value: "",
- }
- HTTPPathPrefixFlag = cli.StringFlag{
- Name: "http.rpcprefix",
- Usage: "HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
- Value: "",
- }
- GraphQLEnabledFlag = cli.BoolFlag{
- Name: "graphql",
- Usage: "Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.",
- }
- GraphQLCORSDomainFlag = cli.StringFlag{
- Name: "graphql.corsdomain",
- Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
- Value: "",
- }
- GraphQLVirtualHostsFlag = cli.StringFlag{
- Name: "graphql.vhosts",
- Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
- Value: strings.Join(node.DefaultConfig.GraphQLVirtualHosts, ","),
- }
- WSEnabledFlag = cli.BoolFlag{
- Name: "ws",
- Usage: "Enable the WS-RPC server",
- }
- WSListenAddrFlag = cli.StringFlag{
- Name: "ws.addr",
- Usage: "WS-RPC server listening interface",
- Value: node.DefaultWSHost,
- }
- WSPortFlag = cli.IntFlag{
- Name: "ws.port",
- Usage: "WS-RPC server listening port",
- Value: node.DefaultWSPort,
- }
- WSApiFlag = cli.StringFlag{
- Name: "ws.api",
- Usage: "API's offered over the WS-RPC interface",
- Value: "",
- }
- WSAllowedOriginsFlag = cli.StringFlag{
- Name: "ws.origins",
- Usage: "Origins from which to accept websockets requests",
- Value: "",
- }
- WSPathPrefixFlag = cli.StringFlag{
- Name: "ws.rpcprefix",
- Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
- Value: "",
- }
- ExecFlag = cli.StringFlag{
- Name: "exec",
- Usage: "Execute JavaScript statement",
- }
- PreloadJSFlag = cli.StringFlag{
- Name: "preload",
- Usage: "Comma separated list of JavaScript files to preload into the console",
- }
- AllowUnprotectedTxs = cli.BoolFlag{
- Name: "rpc.allow-unprotected-txs",
- Usage: "Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC",
- }
- // Network Settings
- MaxPeersFlag = cli.IntFlag{
- Name: "maxpeers",
- Usage: "Maximum number of network peers (network disabled if set to 0)",
- Value: node.DefaultConfig.P2P.MaxPeers,
- }
- MaxPendingPeersFlag = cli.IntFlag{
- Name: "maxpendpeers",
- Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
- Value: node.DefaultConfig.P2P.MaxPendingPeers,
- }
- ListenPortFlag = cli.IntFlag{
- Name: "port",
- Usage: "Network listening port",
- Value: 30303,
- }
- BootnodesFlag = cli.StringFlag{
- Name: "bootnodes",
- Usage: "Comma separated enode URLs for P2P discovery bootstrap",
- Value: "",
- }
- NodeKeyFileFlag = cli.StringFlag{
- Name: "nodekey",
- Usage: "P2P node key file",
- }
- NodeKeyHexFlag = cli.StringFlag{
- Name: "nodekeyhex",
- Usage: "P2P node key as hex (for testing)",
- }
- NATFlag = cli.StringFlag{
- Name: "nat",
- Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
- Value: "any",
- }
- NoDiscoverFlag = cli.BoolFlag{
- Name: "nodiscover",
- Usage: "Disables the peer discovery mechanism (manual peer addition)",
- }
- DiscoveryV5Flag = cli.BoolFlag{
- Name: "v5disc",
- Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
- }
- NetrestrictFlag = cli.StringFlag{
- Name: "netrestrict",
- Usage: "Restricts network communication to the given IP networks (CIDR masks)",
- }
- DNSDiscoveryFlag = cli.StringFlag{
- Name: "discovery.dns",
- Usage: "Sets DNS discovery entry points (use \"\" to disable DNS)",
- }
- // ATM the url is left to the user and deployment to
- JSpathFlag = cli.StringFlag{
- Name: "jspath",
- Usage: "JavaScript root path for `loadScript`",
- Value: ".",
- }
- // Gas price oracle settings
- GpoBlocksFlag = cli.IntFlag{
- Name: "gpo.blocks",
- Usage: "Number of recent blocks to check for gas prices",
- Value: ethconfig.Defaults.GPO.Blocks,
- }
- GpoPercentileFlag = cli.IntFlag{
- Name: "gpo.percentile",
- Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
- Value: ethconfig.Defaults.GPO.Percentile,
- }
- GpoMaxGasPriceFlag = cli.Int64Flag{
- Name: "gpo.maxprice",
- Usage: "Maximum gas price will be recommended by gpo",
- Value: ethconfig.Defaults.GPO.MaxPrice.Int64(),
- }
- // Metrics flags
- MetricsEnabledFlag = cli.BoolFlag{
- Name: "metrics",
- Usage: "Enable metrics collection and reporting",
- }
- MetricsEnabledExpensiveFlag = cli.BoolFlag{
- Name: "metrics.expensive",
- Usage: "Enable expensive metrics collection and reporting",
- }
- // MetricsHTTPFlag defines the endpoint for a stand-alone metrics HTTP endpoint.
- // Since the pprof service enables sensitive/vulnerable behavior, this allows a user
- // to enable a public-OK metrics endpoint without having to worry about ALSO exposing
- // other profiling behavior or information.
- MetricsHTTPFlag = cli.StringFlag{
- Name: "metrics.addr",
- Usage: "Enable stand-alone metrics HTTP server listening interface",
- Value: metrics.DefaultConfig.HTTP,
- }
- MetricsPortFlag = cli.IntFlag{
- Name: "metrics.port",
- Usage: "Metrics HTTP server listening port",
- Value: metrics.DefaultConfig.Port,
- }
- MetricsEnableInfluxDBFlag = cli.BoolFlag{
- Name: "metrics.influxdb",
- Usage: "Enable metrics export/push to an external InfluxDB database",
- }
- MetricsInfluxDBEndpointFlag = cli.StringFlag{
- Name: "metrics.influxdb.endpoint",
- Usage: "InfluxDB API endpoint to report metrics to",
- Value: metrics.DefaultConfig.InfluxDBEndpoint,
- }
- MetricsInfluxDBDatabaseFlag = cli.StringFlag{
- Name: "metrics.influxdb.database",
- Usage: "InfluxDB database name to push reported metrics to",
- Value: metrics.DefaultConfig.InfluxDBDatabase,
- }
- MetricsInfluxDBUsernameFlag = cli.StringFlag{
- Name: "metrics.influxdb.username",
- Usage: "Username to authorize access to the database",
- Value: metrics.DefaultConfig.InfluxDBUsername,
- }
- MetricsInfluxDBPasswordFlag = cli.StringFlag{
- Name: "metrics.influxdb.password",
- Usage: "Password to authorize access to the database",
- Value: metrics.DefaultConfig.InfluxDBPassword,
- }
- // Tags are part of every measurement sent to InfluxDB. Queries on tags are faster in InfluxDB.
- // For example `host` tag could be used so that we can group all nodes and average a measurement
- // across all of them, but also so that we can select a specific node and inspect its measurements.
- // https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
- MetricsInfluxDBTagsFlag = cli.StringFlag{
- Name: "metrics.influxdb.tags",
- Usage: "Comma-separated InfluxDB tags (key/values) attached to all measurements",
- Value: metrics.DefaultConfig.InfluxDBTags,
- }
- EWASMInterpreterFlag = cli.StringFlag{
- Name: "vm.ewasm",
- Usage: "External ewasm configuration (default = built-in interpreter)",
- Value: "",
- }
- EVMInterpreterFlag = cli.StringFlag{
- Name: "vm.evm",
- Usage: "External EVM configuration (default = built-in interpreter)",
- Value: "",
- }
- // Init network
- InitNetworkSize = cli.IntFlag{
- Name: "init.size",
- Usage: "the size of the network",
- Value: 1,
- }
- InitNetworkDir = cli.StringFlag{
- Name: "init.dir",
- Usage: "the direction to store initial network data",
- Value: "",
- }
- InitNetworkIps = cli.StringFlag{
- Name: "init.ips",
- Usage: "the ips of each node in the network, example '192.168.0.1,192.168.0.2'",
- Value: "",
- }
- InitNetworkPort = cli.IntFlag{
- Name: "init.p2p-port",
- Usage: "the p2p port of the nodes in the network",
- Value: 30311,
- }
- CatalystFlag = cli.BoolFlag{
- Name: "catalyst",
- Usage: "Catalyst mode (eth2 integration testing)",
- }
- BlockAmountReserved = cli.Uint64Flag{
- Name: "block-amount-reserved",
- Usage: "Sets the expected remained amount of blocks for offline block prune",
- }
- CheckSnapshotWithMPT = cli.BoolFlag{
- Name: "check-snapshot-with-mpt",
- Usage: "Enable checking between snapshot and MPT ",
- }
- )
- // MakeDataDir retrieves the currently requested data directory, terminating
- // if none (or the empty string) is specified. If the node is starting a testnet,
- // then a subdirectory of the specified datadir will be used.
- func MakeDataDir(ctx *cli.Context) string {
- if path := ctx.GlobalString(DataDirFlag.Name); path != "" {
- if ctx.GlobalBool(RopstenFlag.Name) {
- // Maintain compatibility with older Geth configurations storing the
- // Ropsten database in `testnet` instead of `ropsten`.
- return filepath.Join(path, "ropsten")
- }
- if ctx.GlobalBool(RinkebyFlag.Name) {
- return filepath.Join(path, "rinkeby")
- }
- if ctx.GlobalBool(GoerliFlag.Name) {
- return filepath.Join(path, "goerli")
- }
- if ctx.GlobalBool(YoloV3Flag.Name) {
- return filepath.Join(path, "yolo-v3")
- }
- return path
- }
- Fatalf("Cannot determine default data directory, please set manually (--datadir)")
- return ""
- }
- // setNodeKey creates a node key from set command line flags, either loading it
- // from a file or as a specified hex value. If neither flags were provided, this
- // method returns nil and an emphemeral key is to be generated.
- func setNodeKey(ctx *cli.Context, cfg *p2p.Config) {
- var (
- hex = ctx.GlobalString(NodeKeyHexFlag.Name)
- file = ctx.GlobalString(NodeKeyFileFlag.Name)
- key *ecdsa.PrivateKey
- err error
- )
- switch {
- case file != "" && hex != "":
- Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
- case file != "":
- if key, err = crypto.LoadECDSA(file); err != nil {
- Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
- }
- cfg.PrivateKey = key
- case hex != "":
- if key, err = crypto.HexToECDSA(hex); err != nil {
- Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
- }
- cfg.PrivateKey = key
- }
- }
- // setNodeUserIdent creates the user identifier from CLI flags.
- func setNodeUserIdent(ctx *cli.Context, cfg *node.Config) {
- if identity := ctx.GlobalString(IdentityFlag.Name); len(identity) > 0 {
- cfg.UserIdent = identity
- }
- }
- // setBootstrapNodes creates a list of bootstrap nodes from the command line
- // flags, reverting to pre-configured ones if none have been specified.
- func setBootstrapNodes(ctx *cli.Context, cfg *p2p.Config) {
- urls := params.MainnetBootnodes
- switch {
- case ctx.GlobalIsSet(BootnodesFlag.Name):
- urls = SplitAndTrim(ctx.GlobalString(BootnodesFlag.Name))
- case ctx.GlobalBool(RopstenFlag.Name):
- urls = params.RopstenBootnodes
- case ctx.GlobalBool(RinkebyFlag.Name):
- urls = params.RinkebyBootnodes
- case ctx.GlobalBool(GoerliFlag.Name):
- urls = params.GoerliBootnodes
- case ctx.GlobalBool(YoloV3Flag.Name):
- urls = params.YoloV3Bootnodes
- case cfg.BootstrapNodes != nil:
- return // already set, don't apply defaults.
- }
- cfg.BootstrapNodes = make([]*enode.Node, 0, len(urls))
- for _, url := range urls {
- if url != "" {
- node, err := enode.Parse(enode.ValidSchemes, url)
- if err != nil {
- log.Crit("Bootstrap URL invalid", "enode", url, "err", err)
- continue
- }
- cfg.BootstrapNodes = append(cfg.BootstrapNodes, node)
- }
- }
- }
- // setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
- // flags, reverting to pre-configured ones if none have been specified.
- func setBootstrapNodesV5(ctx *cli.Context, cfg *p2p.Config) {
- urls := params.V5Bootnodes
- switch {
- case ctx.GlobalIsSet(BootnodesFlag.Name):
- urls = SplitAndTrim(ctx.GlobalString(BootnodesFlag.Name))
- case cfg.BootstrapNodesV5 != nil:
- return // already set, don't apply defaults.
- }
- cfg.BootstrapNodesV5 = make([]*enode.Node, 0, len(urls))
- for _, url := range urls {
- if url != "" {
- node, err := enode.Parse(enode.ValidSchemes, url)
- if err != nil {
- log.Error("Bootstrap URL invalid", "enode", url, "err", err)
- continue
- }
- cfg.BootstrapNodesV5 = append(cfg.BootstrapNodesV5, node)
- }
- }
- }
- // setListenAddress creates a TCP listening address string from set command
- // line flags.
- func setListenAddress(ctx *cli.Context, cfg *p2p.Config) {
- if ctx.GlobalIsSet(ListenPortFlag.Name) {
- cfg.ListenAddr = fmt.Sprintf(":%d", ctx.GlobalInt(ListenPortFlag.Name))
- }
- }
- // setNAT creates a port mapper from command line flags.
- func setNAT(ctx *cli.Context, cfg *p2p.Config) {
- if ctx.GlobalIsSet(NATFlag.Name) {
- natif, err := nat.Parse(ctx.GlobalString(NATFlag.Name))
- if err != nil {
- Fatalf("Option %s: %v", NATFlag.Name, err)
- }
- cfg.NAT = natif
- }
- }
- // SplitAndTrim splits input separated by a comma
- // and trims excessive white space from the substrings.
- func SplitAndTrim(input string) (ret []string) {
- l := strings.Split(input, ",")
- for _, r := range l {
- if r = strings.TrimSpace(r); r != "" {
- ret = append(ret, r)
- }
- }
- return ret
- }
- // setHTTP creates the HTTP RPC listener interface string from the set
- // command line flags, returning empty if the HTTP endpoint is disabled.
- func setHTTP(ctx *cli.Context, cfg *node.Config) {
- if ctx.GlobalBool(LegacyRPCEnabledFlag.Name) && cfg.HTTPHost == "" {
- log.Warn("The flag --rpc is deprecated and will be removed June 2021, please use --http")
- cfg.HTTPHost = "127.0.0.1"
- if ctx.GlobalIsSet(LegacyRPCListenAddrFlag.Name) {
- cfg.HTTPHost = ctx.GlobalString(LegacyRPCListenAddrFlag.Name)
- log.Warn("The flag --rpcaddr is deprecated and will be removed June 2021, please use --http.addr")
- }
- }
- if ctx.GlobalBool(HTTPEnabledFlag.Name) && cfg.HTTPHost == "" {
- cfg.HTTPHost = "127.0.0.1"
- if ctx.GlobalIsSet(HTTPListenAddrFlag.Name) {
- cfg.HTTPHost = ctx.GlobalString(HTTPListenAddrFlag.Name)
- }
- }
- if ctx.GlobalIsSet(LegacyRPCPortFlag.Name) {
- cfg.HTTPPort = ctx.GlobalInt(LegacyRPCPortFlag.Name)
- log.Warn("The flag --rpcport is deprecated and will be removed June 2021, please use --http.port")
- }
- if ctx.GlobalIsSet(HTTPPortFlag.Name) {
- cfg.HTTPPort = ctx.GlobalInt(HTTPPortFlag.Name)
- }
- if ctx.GlobalIsSet(LegacyRPCCORSDomainFlag.Name) {
- cfg.HTTPCors = SplitAndTrim(ctx.GlobalString(LegacyRPCCORSDomainFlag.Name))
- log.Warn("The flag --rpccorsdomain is deprecated and will be removed June 2021, please use --http.corsdomain")
- }
- if ctx.GlobalIsSet(HTTPCORSDomainFlag.Name) {
- cfg.HTTPCors = SplitAndTrim(ctx.GlobalString(HTTPCORSDomainFlag.Name))
- }
- if ctx.GlobalIsSet(LegacyRPCApiFlag.Name) {
- cfg.HTTPModules = SplitAndTrim(ctx.GlobalString(LegacyRPCApiFlag.Name))
- log.Warn("The flag --rpcapi is deprecated and will be removed June 2021, please use --http.api")
- }
- if ctx.GlobalIsSet(HTTPApiFlag.Name) {
- cfg.HTTPModules = SplitAndTrim(ctx.GlobalString(HTTPApiFlag.Name))
- }
- if ctx.GlobalIsSet(LegacyRPCVirtualHostsFlag.Name) {
- cfg.HTTPVirtualHosts = SplitAndTrim(ctx.GlobalString(LegacyRPCVirtualHostsFlag.Name))
- log.Warn("The flag --rpcvhosts is deprecated and will be removed June 2021, please use --http.vhosts")
- }
- if ctx.GlobalIsSet(HTTPVirtualHostsFlag.Name) {
- cfg.HTTPVirtualHosts = SplitAndTrim(ctx.GlobalString(HTTPVirtualHostsFlag.Name))
- }
- if ctx.GlobalIsSet(HTTPPathPrefixFlag.Name) {
- cfg.HTTPPathPrefix = ctx.GlobalString(HTTPPathPrefixFlag.Name)
- }
- if ctx.GlobalIsSet(AllowUnprotectedTxs.Name) {
- cfg.AllowUnprotectedTxs = ctx.GlobalBool(AllowUnprotectedTxs.Name)
- }
- }
- // setGraphQL creates the GraphQL listener interface string from the set
- // command line flags, returning empty if the GraphQL endpoint is disabled.
- func setGraphQL(ctx *cli.Context, cfg *node.Config) {
- if ctx.GlobalIsSet(GraphQLCORSDomainFlag.Name) {
- cfg.GraphQLCors = SplitAndTrim(ctx.GlobalString(GraphQLCORSDomainFlag.Name))
- }
- if ctx.GlobalIsSet(GraphQLVirtualHostsFlag.Name) {
- cfg.GraphQLVirtualHosts = SplitAndTrim(ctx.GlobalString(GraphQLVirtualHostsFlag.Name))
- }
- }
- // setWS creates the WebSocket RPC listener interface string from the set
- // command line flags, returning empty if the HTTP endpoint is disabled.
- func setWS(ctx *cli.Context, cfg *node.Config) {
- if ctx.GlobalBool(WSEnabledFlag.Name) && cfg.WSHost == "" {
- cfg.WSHost = "127.0.0.1"
- if ctx.GlobalIsSet(WSListenAddrFlag.Name) {
- cfg.WSHost = ctx.GlobalString(WSListenAddrFlag.Name)
- }
- }
- if ctx.GlobalIsSet(WSPortFlag.Name) {
- cfg.WSPort = ctx.GlobalInt(WSPortFlag.Name)
- }
- if ctx.GlobalIsSet(WSAllowedOriginsFlag.Name) {
- cfg.WSOrigins = SplitAndTrim(ctx.GlobalString(WSAllowedOriginsFlag.Name))
- }
- if ctx.GlobalIsSet(WSApiFlag.Name) {
- cfg.WSModules = SplitAndTrim(ctx.GlobalString(WSApiFlag.Name))
- }
- if ctx.GlobalIsSet(WSPathPrefixFlag.Name) {
- cfg.WSPathPrefix = ctx.GlobalString(WSPathPrefixFlag.Name)
- }
- }
- // setIPC creates an IPC path configuration from the set command line flags,
- // returning an empty string if IPC was explicitly disabled, or the set path.
- func setIPC(ctx *cli.Context, cfg *node.Config) {
- CheckExclusive(ctx, IPCDisabledFlag, IPCPathFlag)
- switch {
- case ctx.GlobalBool(IPCDisabledFlag.Name):
- cfg.IPCPath = ""
- case ctx.GlobalIsSet(IPCPathFlag.Name):
- cfg.IPCPath = ctx.GlobalString(IPCPathFlag.Name)
- }
- }
- // setLes configures the les server and ultra light client settings from the command line flags.
- func setLes(ctx *cli.Context, cfg *ethconfig.Config) {
- if ctx.GlobalIsSet(LightServeFlag.Name) {
- cfg.LightServ = ctx.GlobalInt(LightServeFlag.Name)
- }
- if ctx.GlobalIsSet(LightIngressFlag.Name) {
- cfg.LightIngress = ctx.GlobalInt(LightIngressFlag.Name)
- }
- if ctx.GlobalIsSet(LightEgressFlag.Name) {
- cfg.LightEgress = ctx.GlobalInt(LightEgressFlag.Name)
- }
- if ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
- cfg.LightPeers = ctx.GlobalInt(LightMaxPeersFlag.Name)
- }
- if ctx.GlobalIsSet(UltraLightServersFlag.Name) {
- cfg.UltraLightServers = strings.Split(ctx.GlobalString(UltraLightServersFlag.Name), ",")
- }
- if ctx.GlobalIsSet(UltraLightFractionFlag.Name) {
- cfg.UltraLightFraction = ctx.GlobalInt(UltraLightFractionFlag.Name)
- }
- if cfg.UltraLightFraction <= 0 && cfg.UltraLightFraction > 100 {
- log.Error("Ultra light fraction is invalid", "had", cfg.UltraLightFraction, "updated", ethconfig.Defaults.UltraLightFraction)
- cfg.UltraLightFraction = ethconfig.Defaults.UltraLightFraction
- }
- if ctx.GlobalIsSet(UltraLightOnlyAnnounceFlag.Name) {
- cfg.UltraLightOnlyAnnounce = ctx.GlobalBool(UltraLightOnlyAnnounceFlag.Name)
- }
- if ctx.GlobalIsSet(LightNoPruneFlag.Name) {
- cfg.LightNoPrune = ctx.GlobalBool(LightNoPruneFlag.Name)
- }
- if ctx.GlobalIsSet(LightNoSyncServeFlag.Name) {
- cfg.LightNoSyncServe = ctx.GlobalBool(LightNoSyncServeFlag.Name)
- }
- }
- // MakeDatabaseHandles raises out the number of allowed file handles per process
- // for Geth and returns half of the allowance to assign to the database.
- func MakeDatabaseHandles() int {
- limit, err := fdlimit.Maximum()
- if err != nil {
- Fatalf("Failed to retrieve file descriptor allowance: %v", err)
- }
- raised, err := fdlimit.Raise(uint64(limit))
- if err != nil {
- Fatalf("Failed to raise file descriptor allowance: %v", err)
- }
- return int(raised / 2) // Leave half for networking and other stuff
- }
- // MakeAddress converts an account specified directly as a hex encoded string or
- // a key index in the key store to an internal account representation.
- func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error) {
- // If the specified account is a valid address, return it
- if common.IsHexAddress(account) {
- return accounts.Account{Address: common.HexToAddress(account)}, nil
- }
- // Otherwise try to interpret the account as a keystore index
- index, err := strconv.Atoi(account)
- if err != nil || index < 0 {
- return accounts.Account{}, fmt.Errorf("invalid account address or index %q", account)
- }
- log.Warn("-------------------------------------------------------------------")
- log.Warn("Referring to accounts by order in the keystore folder is dangerous!")
- log.Warn("This functionality is deprecated and will be removed in the future!")
- log.Warn("Please use explicit addresses! (can search via `geth account list`)")
- log.Warn("-------------------------------------------------------------------")
- accs := ks.Accounts()
- if len(accs) <= index {
- return accounts.Account{}, fmt.Errorf("index %d higher than number of accounts %d", index, len(accs))
- }
- return accs[index], nil
- }
- // setEtherbase retrieves the etherbase either from the directly specified
- // command line flags or from the keystore if CLI indexed.
- func setEtherbase(ctx *cli.Context, ks *keystore.KeyStore, cfg *ethconfig.Config) {
- // Extract the current etherbase
- var etherbase string
- if ctx.GlobalIsSet(MinerEtherbaseFlag.Name) {
- etherbase = ctx.GlobalString(MinerEtherbaseFlag.Name)
- }
- // Convert the etherbase into an address and configure it
- if etherbase != "" {
- if ks != nil {
- account, err := MakeAddress(ks, etherbase)
- if err != nil {
- Fatalf("Invalid miner etherbase: %v", err)
- }
- cfg.Miner.Etherbase = account.Address
- } else {
- Fatalf("No etherbase configured")
- }
- }
- }
- // MakePasswordList reads password lines from the file specified by the global --password flag.
- func MakePasswordList(ctx *cli.Context) []string {
- path := ctx.GlobalString(PasswordFileFlag.Name)
- if path == "" {
- return nil
- }
- text, err := ioutil.ReadFile(path)
- if err != nil {
- Fatalf("Failed to read password file: %v", err)
- }
- lines := strings.Split(string(text), "\n")
- // Sanitise DOS line endings.
- for i := range lines {
- lines[i] = strings.TrimRight(lines[i], "\r")
- }
- return lines
- }
- func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config) {
- setNodeKey(ctx, cfg)
- setNAT(ctx, cfg)
- setListenAddress(ctx, cfg)
- setBootstrapNodes(ctx, cfg)
- setBootstrapNodesV5(ctx, cfg)
- lightClient := ctx.GlobalString(SyncModeFlag.Name) == "light"
- lightServer := (ctx.GlobalInt(LightServeFlag.Name) != 0)
- lightPeers := ctx.GlobalInt(LightMaxPeersFlag.Name)
- if lightClient && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
- // dynamic default - for clients we use 1/10th of the default for servers
- lightPeers /= 10
- }
- if ctx.GlobalIsSet(MaxPeersFlag.Name) {
- cfg.MaxPeers = ctx.GlobalInt(MaxPeersFlag.Name)
- if lightServer && !ctx.GlobalIsSet(LightMaxPeersFlag.Name) {
- cfg.MaxPeers += lightPeers
- }
- } else {
- if lightServer {
- cfg.MaxPeers += lightPeers
- }
- if lightClient && ctx.GlobalIsSet(LightMaxPeersFlag.Name) && cfg.MaxPeers < lightPeers {
- cfg.MaxPeers = lightPeers
- }
- }
- if !(lightClient || lightServer) {
- lightPeers = 0
- }
- ethPeers := cfg.MaxPeers - lightPeers
- if lightClient {
- ethPeers = 0
- }
- log.Info("Maximum peer count", "ETH", ethPeers, "LES", lightPeers, "total", cfg.MaxPeers)
- if ctx.GlobalIsSet(MaxPendingPeersFlag.Name) {
- cfg.MaxPendingPeers = ctx.GlobalInt(MaxPendingPeersFlag.Name)
- }
- if ctx.GlobalIsSet(NoDiscoverFlag.Name) || lightClient {
- cfg.NoDiscovery = true
- }
- // if we're running a light client or server, force enable the v5 peer discovery
- // unless it is explicitly disabled with --nodiscover note that explicitly specifying
- // --v5disc overrides --nodiscover, in which case the later only disables v4 discovery
- forceV5Discovery := (lightClient || lightServer) && !ctx.GlobalBool(NoDiscoverFlag.Name)
- if ctx.GlobalIsSet(DiscoveryV5Flag.Name) {
- cfg.DiscoveryV5 = ctx.GlobalBool(DiscoveryV5Flag.Name)
- } else if forceV5Discovery {
- cfg.DiscoveryV5 = true
- }
- if netrestrict := ctx.GlobalString(NetrestrictFlag.Name); netrestrict != "" {
- list, err := netutil.ParseNetlist(netrestrict)
- if err != nil {
- Fatalf("Option %q: %v", NetrestrictFlag.Name, err)
- }
- cfg.NetRestrict = list
- }
- if ctx.GlobalBool(DeveloperFlag.Name) || ctx.GlobalBool(CatalystFlag.Name) {
- // --dev mode can't use p2p networking.
- cfg.MaxPeers = 0
- cfg.ListenAddr = ""
- cfg.NoDial = true
- cfg.NoDiscovery = true
- cfg.DiscoveryV5 = false
- }
- }
- // SetNodeConfig applies node-related command line flags to the config.
- func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
- SetP2PConfig(ctx, &cfg.P2P)
- setIPC(ctx, cfg)
- setHTTP(ctx, cfg)
- setGraphQL(ctx, cfg)
- setWS(ctx, cfg)
- setNodeUserIdent(ctx, cfg)
- setDataDir(ctx, cfg)
- setSmartCard(ctx, cfg)
- if ctx.GlobalIsSet(ExternalSignerFlag.Name) {
- cfg.ExternalSigner = ctx.GlobalString(ExternalSignerFlag.Name)
- }
- if ctx.GlobalIsSet(KeyStoreDirFlag.Name) {
- cfg.KeyStoreDir = ctx.GlobalString(KeyStoreDirFlag.Name)
- }
- if ctx.GlobalIsSet(LightKDFFlag.Name) {
- cfg.UseLightweightKDF = ctx.GlobalBool(LightKDFFlag.Name)
- }
- if ctx.GlobalIsSet(NoUSBFlag.Name) || cfg.NoUSB {
- log.Warn("Option nousb is deprecated and USB is deactivated by default. Use --usb to enable")
- }
- if ctx.GlobalIsSet(USBFlag.Name) {
- cfg.USB = ctx.GlobalBool(USBFlag.Name)
- }
- if ctx.GlobalIsSet(DirectBroadcastFlag.Name) {
- cfg.DirectBroadcast = ctx.GlobalBool(DirectBroadcastFlag.Name)
- }
- if ctx.GlobalIsSet(DisableSnapProtocolFlag.Name) {
- cfg.DisableSnapProtocol = ctx.GlobalBool(DisableSnapProtocolFlag.Name)
- }
- if ctx.GlobalIsSet(RangeLimitFlag.Name) {
- cfg.RangeLimit = ctx.GlobalBool(RangeLimitFlag.Name)
- }
- if ctx.GlobalIsSet(InsecureUnlockAllowedFlag.Name) {
- cfg.InsecureUnlockAllowed = ctx.GlobalBool(InsecureUnlockAllowedFlag.Name)
- }
- }
- func setSmartCard(ctx *cli.Context, cfg *node.Config) {
- // Skip enabling smartcards if no path is set
- path := ctx.GlobalString(SmartCardDaemonPathFlag.Name)
- if path == "" {
- return
- }
- // Sanity check that the smartcard path is valid
- fi, err := os.Stat(path)
- if err != nil {
- log.Info("Smartcard socket not found, disabling", "err", err)
- return
- }
- if fi.Mode()&os.ModeType != os.ModeSocket {
- log.Error("Invalid smartcard daemon path", "path", path, "type", fi.Mode().String())
- return
- }
- // Smartcard daemon path exists and is a socket, enable it
- cfg.SmartCardDaemonPath = path
- }
- func setDataDir(ctx *cli.Context, cfg *node.Config) {
- switch {
- case ctx.GlobalIsSet(DataDirFlag.Name):
- cfg.DataDir = ctx.GlobalString(DataDirFlag.Name)
- case ctx.GlobalBool(DeveloperFlag.Name):
- cfg.DataDir = "" // unless explicitly requested, use memory databases
- case ctx.GlobalBool(RopstenFlag.Name) && cfg.DataDir == node.DefaultDataDir():
- // Maintain compatibility with older Geth configurations storing the
- // Ropsten database in `testnet` instead of `ropsten`.
- legacyPath := filepath.Join(node.DefaultDataDir(), "testnet")
- if _, err := os.Stat(legacyPath); !os.IsNotExist(err) {
- log.Warn("Using the deprecated `testnet` datadir. Future versions will store the Ropsten chain in `ropsten`.")
- cfg.DataDir = legacyPath
- } else {
- cfg.DataDir = filepath.Join(node.DefaultDataDir(), "ropsten")
- }
- cfg.DataDir = filepath.Join(node.DefaultDataDir(), "ropsten")
- case ctx.GlobalBool(RinkebyFlag.Name) && cfg.DataDir == node.DefaultDataDir():
- cfg.DataDir = filepath.Join(node.DefaultDataDir(), "rinkeby")
- case ctx.GlobalBool(GoerliFlag.Name) && cfg.DataDir == node.DefaultDataDir():
- cfg.DataDir = filepath.Join(node.DefaultDataDir(), "goerli")
- case ctx.GlobalBool(YoloV3Flag.Name) && cfg.DataDir == node.DefaultDataDir():
- cfg.DataDir = filepath.Join(node.DefaultDataDir(), "yolo-v3")
- }
- }
- func setGPO(ctx *cli.Context, cfg *gasprice.Config, light bool) {
- // If we are running the light client, apply another group
- // settings for gas oracle.
- if light {
- cfg.Blocks = ethconfig.LightClientGPO.Blocks
- cfg.Percentile = ethconfig.LightClientGPO.Percentile
- }
- if ctx.GlobalIsSet(GpoBlocksFlag.Name) {
- cfg.Blocks = ctx.GlobalInt(GpoBlocksFlag.Name)
- }
- if ctx.GlobalIsSet(GpoPercentileFlag.Name) {
- cfg.Percentile = ctx.GlobalInt(GpoPercentileFlag.Name)
- }
- if ctx.GlobalIsSet(GpoMaxGasPriceFlag.Name) {
- cfg.MaxPrice = big.NewInt(ctx.GlobalInt64(GpoMaxGasPriceFlag.Name))
- }
- }
- func setTxPool(ctx *cli.Context, cfg *core.TxPoolConfig) {
- if ctx.GlobalIsSet(TxPoolLocalsFlag.Name) {
- locals := strings.Split(ctx.GlobalString(TxPoolLocalsFlag.Name), ",")
- for _, account := range locals {
- if trimmed := strings.TrimSpace(account); !common.IsHexAddress(trimmed) {
- Fatalf("Invalid account in --txpool.locals: %s", trimmed)
- } else {
- cfg.Locals = append(cfg.Locals, common.HexToAddress(account))
- }
- }
- }
- if ctx.GlobalIsSet(TxPoolNoLocalsFlag.Name) {
- cfg.NoLocals = ctx.GlobalBool(TxPoolNoLocalsFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolJournalFlag.Name) {
- cfg.Journal = ctx.GlobalString(TxPoolJournalFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolRejournalFlag.Name) {
- cfg.Rejournal = ctx.GlobalDuration(TxPoolRejournalFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolPriceLimitFlag.Name) {
- cfg.PriceLimit = ctx.GlobalUint64(TxPoolPriceLimitFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolPriceBumpFlag.Name) {
- cfg.PriceBump = ctx.GlobalUint64(TxPoolPriceBumpFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolAccountSlotsFlag.Name) {
- cfg.AccountSlots = ctx.GlobalUint64(TxPoolAccountSlotsFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolGlobalSlotsFlag.Name) {
- cfg.GlobalSlots = ctx.GlobalUint64(TxPoolGlobalSlotsFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolAccountQueueFlag.Name) {
- cfg.AccountQueue = ctx.GlobalUint64(TxPoolAccountQueueFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolGlobalQueueFlag.Name) {
- cfg.GlobalQueue = ctx.GlobalUint64(TxPoolGlobalQueueFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolLifetimeFlag.Name) {
- cfg.Lifetime = ctx.GlobalDuration(TxPoolLifetimeFlag.Name)
- }
- if ctx.GlobalIsSet(TxPoolReannounceTimeFlag.Name) {
- cfg.ReannounceTime = ctx.GlobalDuration(TxPoolReannounceTimeFlag.Name)
- }
- }
- func setEthash(ctx *cli.Context, cfg *ethconfig.Config) {
- if ctx.GlobalIsSet(EthashCacheDirFlag.Name) {
- cfg.Ethash.CacheDir = ctx.GlobalString(EthashCacheDirFlag.Name)
- }
- if ctx.GlobalIsSet(EthashDatasetDirFlag.Name) {
- cfg.Ethash.DatasetDir = ctx.GlobalString(EthashDatasetDirFlag.Name)
- }
- if ctx.GlobalIsSet(EthashCachesInMemoryFlag.Name) {
- cfg.Ethash.CachesInMem = ctx.GlobalInt(EthashCachesInMemoryFlag.Name)
- }
- if ctx.GlobalIsSet(EthashCachesOnDiskFlag.Name) {
- cfg.Ethash.CachesOnDisk = ctx.GlobalInt(EthashCachesOnDiskFlag.Name)
- }
- if ctx.GlobalIsSet(EthashCachesLockMmapFlag.Name) {
- cfg.Ethash.CachesLockMmap = ctx.GlobalBool(EthashCachesLockMmapFlag.Name)
- }
- if ctx.GlobalIsSet(EthashDatasetsInMemoryFlag.Name) {
- cfg.Ethash.DatasetsInMem = ctx.GlobalInt(EthashDatasetsInMemoryFlag.Name)
- }
- if ctx.GlobalIsSet(EthashDatasetsOnDiskFlag.Name) {
- cfg.Ethash.DatasetsOnDisk = ctx.GlobalInt(EthashDatasetsOnDiskFlag.Name)
- }
- if ctx.GlobalIsSet(EthashDatasetsLockMmapFlag.Name) {
- cfg.Ethash.DatasetsLockMmap = ctx.GlobalBool(EthashDatasetsLockMmapFlag.Name)
- }
- }
- func setMiner(ctx *cli.Context, cfg *miner.Config) {
- if ctx.GlobalIsSet(MinerNotifyFlag.Name) {
- cfg.Notify = strings.Split(ctx.GlobalString(MinerNotifyFlag.Name), ",")
- }
- cfg.NotifyFull = ctx.GlobalBool(MinerNotifyFullFlag.Name)
- if ctx.GlobalIsSet(MinerExtraDataFlag.Name) {
- cfg.ExtraData = []byte(ctx.GlobalString(MinerExtraDataFlag.Name))
- }
- if ctx.GlobalIsSet(MinerGasTargetFlag.Name) {
- cfg.GasFloor = ctx.GlobalUint64(MinerGasTargetFlag.Name)
- }
- if ctx.GlobalIsSet(MinerGasLimitFlag.Name) {
- cfg.GasCeil = ctx.GlobalUint64(MinerGasLimitFlag.Name)
- }
- if ctx.GlobalIsSet(MinerGasPriceFlag.Name) {
- cfg.GasPrice = GlobalBig(ctx, MinerGasPriceFlag.Name)
- }
- if ctx.GlobalIsSet(MinerRecommitIntervalFlag.Name) {
- cfg.Recommit = ctx.GlobalDuration(MinerRecommitIntervalFlag.Name)
- }
- if ctx.GlobalIsSet(MinerDelayLeftoverFlag.Name) {
- cfg.DelayLeftOver = ctx.Duration(MinerDelayLeftoverFlag.Name)
- }
- if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
- cfg.Noverify = ctx.GlobalBool(MinerNoVerfiyFlag.Name)
- }
- }
- func setWhitelist(ctx *cli.Context, cfg *ethconfig.Config) {
- whitelist := ctx.GlobalString(WhitelistFlag.Name)
- if whitelist == "" {
- return
- }
- cfg.Whitelist = make(map[uint64]common.Hash)
- for _, entry := range strings.Split(whitelist, ",") {
- parts := strings.Split(entry, "=")
- if len(parts) != 2 {
- Fatalf("Invalid whitelist entry: %s", entry)
- }
- number, err := strconv.ParseUint(parts[0], 0, 64)
- if err != nil {
- Fatalf("Invalid whitelist block number %s: %v", parts[0], err)
- }
- var hash common.Hash
- if err = hash.UnmarshalText([]byte(parts[1])); err != nil {
- Fatalf("Invalid whitelist hash %s: %v", parts[1], err)
- }
- cfg.Whitelist[number] = hash
- }
- }
- // CheckExclusive verifies that only a single instance of the provided flags was
- // set by the user. Each flag might optionally be followed by a string type to
- // specialize it further.
- func CheckExclusive(ctx *cli.Context, args ...interface{}) {
- set := make([]string, 0, 1)
- for i := 0; i < len(args); i++ {
- // Make sure the next argument is a flag and skip if not set
- flag, ok := args[i].(cli.Flag)
- if !ok {
- panic(fmt.Sprintf("invalid argument, not cli.Flag type: %T", args[i]))
- }
- // Check if next arg extends current and expand its name if so
- name := flag.GetName()
- if i+1 < len(args) {
- switch option := args[i+1].(type) {
- case string:
- // Extended flag check, make sure value set doesn't conflict with passed in option
- if ctx.GlobalString(flag.GetName()) == option {
- name += "=" + option
- set = append(set, "--"+name)
- }
- // shift arguments and continue
- i++
- continue
- case cli.Flag:
- default:
- panic(fmt.Sprintf("invalid argument, not cli.Flag or string extension: %T", args[i+1]))
- }
- }
- // Mark the flag if it's set
- if ctx.GlobalIsSet(flag.GetName()) {
- set = append(set, "--"+name)
- }
- }
- if len(set) > 1 {
- Fatalf("Flags %v can't be used at the same time", strings.Join(set, ", "))
- }
- }
- // SetEthConfig applies eth-related command line flags to the config.
- func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
- // Avoid conflicting network flags
- CheckExclusive(ctx, MainnetFlag, DeveloperFlag, RopstenFlag, RinkebyFlag, GoerliFlag, YoloV3Flag)
- CheckExclusive(ctx, LightServeFlag, SyncModeFlag, "light")
- CheckExclusive(ctx, DeveloperFlag, ExternalSignerFlag) // Can't use both ephemeral unlocked and external signer
- if ctx.GlobalString(GCModeFlag.Name) == "archive" && ctx.GlobalUint64(TxLookupLimitFlag.Name) != 0 {
- ctx.GlobalSet(TxLookupLimitFlag.Name, "0")
- log.Warn("Disable transaction unindexing for archive node")
- }
- if ctx.GlobalIsSet(LightServeFlag.Name) && ctx.GlobalUint64(TxLookupLimitFlag.Name) != 0 {
- log.Warn("LES server cannot serve old transaction status and cannot connect below les/4 protocol version if transaction lookup index is limited")
- }
- var ks *keystore.KeyStore
- if keystores := stack.AccountManager().Backends(keystore.KeyStoreType); len(keystores) > 0 {
- ks = keystores[0].(*keystore.KeyStore)
- }
- setEtherbase(ctx, ks, cfg)
- setGPO(ctx, &cfg.GPO, ctx.GlobalString(SyncModeFlag.Name) == "light")
- setTxPool(ctx, &cfg.TxPool)
- setEthash(ctx, cfg)
- setMiner(ctx, &cfg.Miner)
- setWhitelist(ctx, cfg)
- setLes(ctx, cfg)
- // Cap the cache allowance and tune the garbage collector
- mem, err := gopsutil.VirtualMemory()
- if err == nil {
- if 32<<(^uintptr(0)>>63) == 32 && mem.Total > 2*1024*1024*1024 {
- log.Warn("Lowering memory allowance on 32bit arch", "available", mem.Total/1024/1024, "addressable", 2*1024)
- mem.Total = 2 * 1024 * 1024 * 1024
- }
- allowance := int(mem.Total / 1024 / 1024 / 3)
- if cache := ctx.GlobalInt(CacheFlag.Name); cache > allowance {
- log.Warn("Sanitizing cache to Go's GC limits", "provided", cache, "updated", allowance)
- ctx.GlobalSet(CacheFlag.Name, strconv.Itoa(allowance))
- }
- }
- // Ensure Go's GC ignores the database cache for trigger percentage
- cache := ctx.GlobalInt(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))
- if ctx.GlobalIsSet(SyncModeFlag.Name) {
- cfg.SyncMode = *GlobalTextMarshaler(ctx, SyncModeFlag.Name).(*downloader.SyncMode)
- }
- if ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = ctx.GlobalUint64(NetworkIdFlag.Name)
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheDatabaseFlag.Name) {
- cfg.DatabaseCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
- }
- cfg.DatabaseHandles = MakeDatabaseHandles()
- if ctx.GlobalIsSet(AncientFlag.Name) {
- cfg.DatabaseFreezer = ctx.GlobalString(AncientFlag.Name)
- }
- if ctx.GlobalIsSet(DiffFlag.Name) {
- cfg.DatabaseDiff = ctx.GlobalString(DiffFlag.Name)
- }
- if ctx.GlobalIsSet(PersistDiffFlag.Name) {
- cfg.PersistDiff = ctx.GlobalBool(PersistDiffFlag.Name)
- }
- if ctx.GlobalIsSet(DiffBlockFlag.Name) {
- cfg.DiffBlock = ctx.GlobalUint64(DiffBlockFlag.Name)
- }
- if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
- Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
- }
- if ctx.GlobalIsSet(GCModeFlag.Name) {
- cfg.NoPruning = ctx.GlobalString(GCModeFlag.Name) == "archive"
- }
- if ctx.GlobalIsSet(DirectBroadcastFlag.Name) {
- cfg.DirectBroadcast = ctx.GlobalBool(DirectBroadcastFlag.Name)
- }
- if ctx.GlobalIsSet(DisableSnapProtocolFlag.Name) {
- cfg.DisableSnapProtocol = ctx.GlobalBool(DisableSnapProtocolFlag.Name)
- }
- if ctx.GlobalIsSet(DiffSyncFlag.Name) {
- cfg.DiffSync = ctx.GlobalBool(DiffSyncFlag.Name)
- }
- if ctx.GlobalIsSet(RangeLimitFlag.Name) {
- cfg.RangeLimit = ctx.GlobalBool(RangeLimitFlag.Name)
- }
- // Read the value from the flag no matter if it's set or not.
- cfg.Preimages = ctx.GlobalBool(CachePreimagesFlag.Name)
- if cfg.NoPruning && !cfg.Preimages {
- cfg.Preimages = true
- log.Info("Enabling recording of key preimages since archive mode is used")
- }
- if ctx.GlobalIsSet(TxLookupLimitFlag.Name) {
- cfg.TxLookupLimit = ctx.GlobalUint64(TxLookupLimitFlag.Name)
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
- cfg.TrieCleanCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
- }
- if ctx.GlobalIsSet(CacheTrieJournalFlag.Name) {
- cfg.TrieCleanCacheJournal = ctx.GlobalString(CacheTrieJournalFlag.Name)
- }
- if ctx.GlobalIsSet(CacheTrieRejournalFlag.Name) {
- cfg.TrieCleanCacheRejournal = ctx.GlobalDuration(CacheTrieRejournalFlag.Name)
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
- cfg.TrieDirtyCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
- }
- if ctx.GlobalIsSet(TriesInMemoryFlag.Name) {
- cfg.TriesInMemory = ctx.GlobalUint64(TriesInMemoryFlag.Name)
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheSnapshotFlag.Name) {
- cfg.SnapshotCache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheSnapshotFlag.Name) / 100
- }
- if !ctx.GlobalBool(SnapshotFlag.Name) {
- // If snap-sync is requested, this flag is also required
- if cfg.SyncMode == downloader.SnapSync {
- log.Info("Snap sync requested, enabling --snapshot")
- } else {
- cfg.TrieCleanCache += cfg.SnapshotCache
- cfg.SnapshotCache = 0 // Disabled
- }
- }
- if ctx.GlobalIsSet(DocRootFlag.Name) {
- cfg.DocRoot = ctx.GlobalString(DocRootFlag.Name)
- }
- if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
- // TODO(fjl): force-enable this in --dev mode
- cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
- }
- if ctx.GlobalIsSet(EWASMInterpreterFlag.Name) {
- cfg.EWASMInterpreter = ctx.GlobalString(EWASMInterpreterFlag.Name)
- }
- if ctx.GlobalIsSet(EVMInterpreterFlag.Name) {
- cfg.EVMInterpreter = ctx.GlobalString(EVMInterpreterFlag.Name)
- }
- if ctx.GlobalIsSet(RPCGlobalGasCapFlag.Name) {
- cfg.RPCGasCap = ctx.GlobalUint64(RPCGlobalGasCapFlag.Name)
- }
- if cfg.RPCGasCap != 0 {
- log.Info("Set global gas cap", "cap", cfg.RPCGasCap)
- } else {
- log.Info("Global gas cap disabled")
- }
- if ctx.GlobalIsSet(RPCGlobalTxFeeCapFlag.Name) {
- cfg.RPCTxFeeCap = ctx.GlobalFloat64(RPCGlobalTxFeeCapFlag.Name)
- }
- if ctx.GlobalIsSet(NoDiscoverFlag.Name) {
- cfg.EthDiscoveryURLs, cfg.SnapDiscoveryURLs = []string{}, []string{}
- } else if ctx.GlobalIsSet(DNSDiscoveryFlag.Name) {
- urls := ctx.GlobalString(DNSDiscoveryFlag.Name)
- if urls == "" {
- cfg.EthDiscoveryURLs = []string{}
- } else {
- cfg.EthDiscoveryURLs = SplitAndTrim(urls)
- }
- }
- // Override any default configs for hard coded networks.
- switch {
- case ctx.GlobalBool(MainnetFlag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = 1
- }
- cfg.Genesis = core.DefaultGenesisBlock()
- SetDNSDiscoveryDefaults(cfg, params.MainnetGenesisHash)
- case ctx.GlobalBool(RopstenFlag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = 3
- }
- cfg.Genesis = core.DefaultRopstenGenesisBlock()
- SetDNSDiscoveryDefaults(cfg, params.RopstenGenesisHash)
- case ctx.GlobalBool(RinkebyFlag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = 4
- }
- cfg.Genesis = core.DefaultRinkebyGenesisBlock()
- SetDNSDiscoveryDefaults(cfg, params.RinkebyGenesisHash)
- case ctx.GlobalBool(GoerliFlag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = 5
- }
- cfg.Genesis = core.DefaultGoerliGenesisBlock()
- SetDNSDiscoveryDefaults(cfg, params.GoerliGenesisHash)
- case ctx.GlobalBool(YoloV3Flag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = new(big.Int).SetBytes([]byte("yolov3x")).Uint64() // "yolov3x"
- }
- cfg.Genesis = core.DefaultYoloV3GenesisBlock()
- case ctx.GlobalBool(DeveloperFlag.Name):
- if !ctx.GlobalIsSet(NetworkIdFlag.Name) {
- cfg.NetworkId = 1337
- }
- // Create new developer account or reuse existing one
- var (
- developer accounts.Account
- passphrase string
- err error
- )
- if list := MakePasswordList(ctx); len(list) > 0 {
- // Just take the first value. Although the function returns a possible multiple values and
- // some usages iterate through them as attempts, that doesn't make sense in this setting,
- // when we're definitely concerned with only one account.
- passphrase = list[0]
- }
- // setEtherbase has been called above, configuring the miner address from command line flags.
- if cfg.Miner.Etherbase != (common.Address{}) {
- developer = accounts.Account{Address: cfg.Miner.Etherbase}
- } else if accs := ks.Accounts(); len(accs) > 0 {
- developer = ks.Accounts()[0]
- } else {
- developer, err = ks.NewAccount(passphrase)
- if err != nil {
- Fatalf("Failed to create developer account: %v", err)
- }
- }
- if err := ks.Unlock(developer, passphrase); err != nil {
- Fatalf("Failed to unlock developer account: %v", err)
- }
- log.Info("Using developer account", "address", developer.Address)
- // Create a new developer genesis block or reuse existing one
- cfg.Genesis = core.DeveloperGenesisBlock(uint64(ctx.GlobalInt(DeveloperPeriodFlag.Name)), developer.Address)
- if ctx.GlobalIsSet(DataDirFlag.Name) {
- // Check if we have an already initialized chain and fall back to
- // that if so. Otherwise we need to generate a new genesis spec.
- chaindb := MakeChainDatabase(ctx, stack, false, false) // TODO (MariusVanDerWijden) make this read only
- if rawdb.ReadCanonicalHash(chaindb, 0) != (common.Hash{}) {
- cfg.Genesis = nil // fallback to db content
- }
- chaindb.Close()
- }
- if !ctx.GlobalIsSet(MinerGasPriceFlag.Name) {
- cfg.Miner.GasPrice = big.NewInt(1)
- }
- default:
- if cfg.NetworkId == 1 {
- SetDNSDiscoveryDefaults(cfg, params.MainnetGenesisHash)
- }
- }
- }
- // SetDNSDiscoveryDefaults configures DNS discovery with the given URL if
- // no URLs are set.
- func SetDNSDiscoveryDefaults(cfg *ethconfig.Config, genesis common.Hash) {
- if cfg.EthDiscoveryURLs != nil {
- return // already set through flags/config
- }
- protocol := "all"
- if cfg.SyncMode == downloader.LightSync {
- protocol = "les"
- }
- if url := params.KnownDNSNetwork(genesis, protocol); url != "" {
- cfg.EthDiscoveryURLs = []string{url}
- cfg.SnapDiscoveryURLs = cfg.EthDiscoveryURLs
- }
- }
- // RegisterEthService adds an Ethereum client to the stack.
- // The second return value is the full node instance, which may be nil if the
- // node is running as a light client.
- func RegisterEthService(stack *node.Node, cfg *ethconfig.Config) (ethapi.Backend, *eth.Ethereum) {
- if cfg.SyncMode == downloader.LightSync {
- backend, err := les.New(stack, cfg)
- if err != nil {
- Fatalf("Failed to register the Ethereum service: %v", err)
- }
- stack.RegisterAPIs(tracers.APIs(backend.ApiBackend))
- return backend.ApiBackend, nil
- }
- backend, err := eth.New(stack, cfg)
- if err != nil {
- Fatalf("Failed to register the Ethereum service: %v", err)
- }
- if cfg.LightServ > 0 {
- _, err := les.NewLesServer(stack, backend, cfg)
- if err != nil {
- Fatalf("Failed to create the LES server: %v", err)
- }
- }
- stack.RegisterAPIs(tracers.APIs(backend.APIBackend))
- return backend.APIBackend, backend
- }
- // RegisterEthStatsService configures the Ethereum Stats daemon and adds it to
- // the given node.
- func RegisterEthStatsService(stack *node.Node, backend ethapi.Backend, url string) {
- if err := ethstats.New(stack, backend, backend.Engine(), url); err != nil {
- Fatalf("Failed to register the Ethereum Stats service: %v", err)
- }
- }
- // RegisterGraphQLService is a utility function to construct a new service and register it against a node.
- func RegisterGraphQLService(stack *node.Node, backend ethapi.Backend, cfg node.Config) {
- if err := graphql.New(stack, backend, cfg.GraphQLCors, cfg.GraphQLVirtualHosts); err != nil {
- Fatalf("Failed to register the GraphQL service: %v", err)
- }
- }
- func SetupMetrics(ctx *cli.Context) {
- if metrics.Enabled {
- log.Info("Enabling metrics collection")
- var (
- enableExport = ctx.GlobalBool(MetricsEnableInfluxDBFlag.Name)
- endpoint = ctx.GlobalString(MetricsInfluxDBEndpointFlag.Name)
- database = ctx.GlobalString(MetricsInfluxDBDatabaseFlag.Name)
- username = ctx.GlobalString(MetricsInfluxDBUsernameFlag.Name)
- password = ctx.GlobalString(MetricsInfluxDBPasswordFlag.Name)
- )
- if enableExport {
- tagsMap := SplitTagsFlag(ctx.GlobalString(MetricsInfluxDBTagsFlag.Name))
- log.Info("Enabling metrics export to InfluxDB")
- go influxdb.InfluxDBWithTags(metrics.DefaultRegistry, 10*time.Second, endpoint, database, username, password, "geth.", tagsMap)
- }
- if ctx.GlobalIsSet(MetricsHTTPFlag.Name) {
- address := fmt.Sprintf("%s:%d", ctx.GlobalString(MetricsHTTPFlag.Name), ctx.GlobalInt(MetricsPortFlag.Name))
- log.Info("Enabling stand-alone metrics HTTP endpoint", "address", address)
- exp.Setup(address)
- }
- }
- }
- func SplitTagsFlag(tagsFlag string) map[string]string {
- tags := strings.Split(tagsFlag, ",")
- tagsMap := map[string]string{}
- for _, t := range tags {
- if t != "" {
- kv := strings.Split(t, "=")
- if len(kv) == 2 {
- tagsMap[kv[0]] = kv[1]
- }
- }
- }
- return tagsMap
- }
- // MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
- func MakeChainDatabase(ctx *cli.Context, stack *node.Node, readonly, disableFreeze bool) ethdb.Database {
- var (
- cache = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheDatabaseFlag.Name) / 100
- handles = MakeDatabaseHandles()
- err error
- chainDb ethdb.Database
- )
- if ctx.GlobalString(SyncModeFlag.Name) == "light" {
- name := "lightchaindata"
- chainDb, err = stack.OpenDatabase(name, cache, handles, "", readonly)
- } else {
- name := "chaindata"
- chainDb, err = stack.OpenDatabaseWithFreezer(name, cache, handles, ctx.GlobalString(AncientFlag.Name), "", readonly, disableFreeze, false)
- }
- if err != nil {
- Fatalf("Could not open database: %v", err)
- }
- return chainDb
- }
- func MakeGenesis(ctx *cli.Context) *core.Genesis {
- var genesis *core.Genesis
- switch {
- case ctx.GlobalBool(MainnetFlag.Name):
- genesis = core.DefaultGenesisBlock()
- case ctx.GlobalBool(RopstenFlag.Name):
- genesis = core.DefaultRopstenGenesisBlock()
- case ctx.GlobalBool(RinkebyFlag.Name):
- genesis = core.DefaultRinkebyGenesisBlock()
- case ctx.GlobalBool(GoerliFlag.Name):
- genesis = core.DefaultGoerliGenesisBlock()
- case ctx.GlobalBool(YoloV3Flag.Name):
- genesis = core.DefaultYoloV3GenesisBlock()
- case ctx.GlobalBool(DeveloperFlag.Name):
- Fatalf("Developer chains are ephemeral")
- }
- return genesis
- }
- // MakeChain creates a chain manager from set command line flags.
- func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb ethdb.Database) {
- var err error
- chainDb = MakeChainDatabase(ctx, stack, false, false) // TODO(rjl493456442) support read-only database
- config, _, err := core.SetupGenesisBlock(chainDb, MakeGenesis(ctx))
- if err != nil {
- Fatalf("%v", err)
- }
- var engine consensus.Engine
- if config.Clique != nil {
- engine = clique.New(config.Clique, chainDb)
- } else {
- engine = ethash.NewFaker()
- if !ctx.GlobalBool(FakePoWFlag.Name) {
- engine = ethash.New(ethash.Config{
- CacheDir: stack.ResolvePath(ethconfig.Defaults.Ethash.CacheDir),
- CachesInMem: ethconfig.Defaults.Ethash.CachesInMem,
- CachesOnDisk: ethconfig.Defaults.Ethash.CachesOnDisk,
- CachesLockMmap: ethconfig.Defaults.Ethash.CachesLockMmap,
- DatasetDir: stack.ResolvePath(ethconfig.Defaults.Ethash.DatasetDir),
- DatasetsInMem: ethconfig.Defaults.Ethash.DatasetsInMem,
- DatasetsOnDisk: ethconfig.Defaults.Ethash.DatasetsOnDisk,
- DatasetsLockMmap: ethconfig.Defaults.Ethash.DatasetsLockMmap,
- }, nil, false)
- }
- }
- if gcmode := ctx.GlobalString(GCModeFlag.Name); gcmode != "full" && gcmode != "archive" {
- Fatalf("--%s must be either 'full' or 'archive'", GCModeFlag.Name)
- }
- cache := &core.CacheConfig{
- TrieCleanLimit: ethconfig.Defaults.TrieCleanCache,
- TrieDirtyLimit: ethconfig.Defaults.TrieDirtyCache,
- TrieDirtyDisabled: ctx.GlobalString(GCModeFlag.Name) == "archive",
- TrieTimeLimit: ethconfig.Defaults.TrieTimeout,
- TriesInMemory: ethconfig.Defaults.TriesInMemory,
- SnapshotLimit: ethconfig.Defaults.SnapshotCache,
- Preimages: ctx.GlobalBool(CachePreimagesFlag.Name),
- }
- if cache.TrieDirtyDisabled && !cache.Preimages {
- cache.Preimages = true
- log.Info("Enabling recording of key preimages since archive mode is used")
- }
- if !ctx.GlobalBool(SnapshotFlag.Name) {
- cache.SnapshotLimit = 0 // Disabled
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheTrieFlag.Name) {
- cache.TrieCleanLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheTrieFlag.Name) / 100
- }
- if ctx.GlobalIsSet(CacheFlag.Name) || ctx.GlobalIsSet(CacheGCFlag.Name) {
- cache.TrieDirtyLimit = ctx.GlobalInt(CacheFlag.Name) * ctx.GlobalInt(CacheGCFlag.Name) / 100
- }
- if ctx.GlobalIsSet(TriesInMemoryFlag.Name) {
- cache.TriesInMemory = ctx.GlobalUint64(TriesInMemoryFlag.Name)
- }
- vmcfg := vm.Config{EnablePreimageRecording: ctx.GlobalBool(VMEnableDebugFlag.Name)}
- // TODO(rjl493456442) disable snapshot generation/wiping if the chain is read only.
- // Disable transaction indexing/unindexing by default.
- chain, err = core.NewBlockChain(chainDb, cache, config, engine, vmcfg, nil, nil)
- if err != nil {
- Fatalf("Can't create BlockChain: %v", err)
- }
- return chain, chainDb
- }
- // MakeConsolePreloads retrieves the absolute paths for the console JavaScript
- // scripts to preload before starting.
- func MakeConsolePreloads(ctx *cli.Context) []string {
- // Skip preloading if there's nothing to preload
- if ctx.GlobalString(PreloadJSFlag.Name) == "" {
- return nil
- }
- // Otherwise resolve absolute paths and return them
- var preloads []string
- for _, file := range strings.Split(ctx.GlobalString(PreloadJSFlag.Name), ",") {
- preloads = append(preloads, strings.TrimSpace(file))
- }
- return preloads
- }
- // MigrateFlags sets the global flag from a local flag when it's set.
- // This is a temporary function used for migrating old command/flags to the
- // new format.
- //
- // e.g. geth account new --keystore /tmp/mykeystore --lightkdf
- //
- // is equivalent after calling this method with:
- //
- // geth --keystore /tmp/mykeystore --lightkdf account new
- //
- // This allows the use of the existing configuration functionality.
- // When all flags are migrated this function can be removed and the existing
- // configuration functionality must be changed that is uses local flags
- func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error {
- return func(ctx *cli.Context) error {
- for _, name := range ctx.FlagNames() {
- if ctx.IsSet(name) {
- ctx.GlobalSet(name, ctx.String(name))
- }
- }
- return action(ctx)
- }
- }
|