Documentation
¶
Overview ¶
Package utils contains internal helper functions for go-ethereum commands.
Package utils contains internal helper functions for go-ethereum commands.
Package utils contains internal helper functions for go-ethereum commands.
Index ¶
- Constants
- Variables
- func CheckExclusive(ctx *cli.Context, args ...interface{})
- func DialRPCWithHeaders(endpoint string, headers []string) (*rpc.Client, error)
- func ExportAppendChain(blockchain *core.BlockChain, fn string, first uint64, last uint64) error
- func ExportChain(blockchain *core.BlockChain, fn string) error
- func ExportChaindata(fn string, kind string, iter ChainDataIterator, interrupt chan struct{}) error
- func ExportHistory(bc *core.BlockChain, dir string, first, last, step uint64) error
- func ExportPreimages(db ethdb.Database, fn string) error
- func ExportSnapshotPreimages(chaindb ethdb.Database, snaptree *snapshot.Tree, fn string, root common.Hash) error
- func Fatalf(format string, args ...interface{})
- func GetPassPhrase(text string, confirmation bool) string
- func GetPassPhraseWithList(text string, confirmation bool, index int, passwords []string) string
- func ImportChain(chain *core.BlockChain, fn string) error
- func ImportHistory(chain *core.BlockChain, db ethdb.Database, dir string, network string) error
- func ImportLDBData(db ethdb.Database, f string, startIndex int64, interrupt chan struct{}) error
- func ImportPreimages(db ethdb.Database, fn string) error
- func IsNetworkPreset(ctx *cli.Context) bool
- func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error)
- func MakeChain(ctx *cli.Context, stack *node.Node, readonly bool) (*core.BlockChain, ethdb.Database)
- func MakeChainDatabase(ctx *cli.Context, stack *node.Node, readonly bool) ethdb.Database
- func MakeConsolePreloads(ctx *cli.Context) []string
- func MakeDataDir(ctx *cli.Context) string
- func MakeDatabaseHandles(max int) int
- func MakeGenesis(ctx *cli.Context) *core.Genesis
- func MakePasswordList(ctx *cli.Context) []string
- func MakeTrieDatabase(ctx *cli.Context, disk ethdb.Database, preimage bool, readOnly bool, ...) *triedb.Database
- func RegisterEthService(stack *node.Node, cfg *ethconfig.Config) (ethapi.Backend, *eth.Ethereum)
- func RegisterEthStatsService(stack *node.Node, backend ethapi.Backend, url string)
- func RegisterFilterAPI(stack *node.Node, backend ethapi.Backend, ethcfg *ethconfig.Config) *filters.FilterSystem
- func RegisterFullSyncTester(stack *node.Node, eth *eth.Ethereum, target common.Hash)
- func RegisterGraphQLService(stack *node.Node, backend ethapi.Backend, filterSystem *filters.FilterSystem, ...)
- func SetDNSDiscoveryDefaults(cfg *ethconfig.Config, genesis common.Hash)
- func SetDataDir(ctx *cli.Context, cfg *node.Config)
- func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config)
- func SetNodeConfig(ctx *cli.Context, cfg *node.Config)
- func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config)
- func SetupMetrics(ctx *cli.Context)
- func SplitAndTrim(input string) (ret []string)
- func SplitTagsFlag(tagsFlag string) map[string]string
- func StartNode(ctx *cli.Context, stack *node.Node, isConsole bool)
- type ChainDataIterator
Constants ¶
const ( OpBatchAdd = 0 OpBatchDel = 1 )
Variables ¶
var ( // General settings DataDirFlag = &flags.DirectoryFlag{ Name: "datadir", Usage: "Data directory for the databases and keystore", Value: flags.DirectoryString(node.DefaultDataDir()), Category: flags.EthCategory, } RemoteDBFlag = &cli.StringFlag{ Name: "remotedb", Usage: "URL for remote database", Category: flags.LoggingCategory, } DBEngineFlag = &cli.StringFlag{ Name: "db.engine", Usage: "Backing database implementation to use ('pebble' or 'leveldb')", Value: node.DefaultConfig.DBEngine, Category: flags.EthCategory, } AncientFlag = &flags.DirectoryFlag{ Name: "datadir.ancient", Usage: "Root directory for ancient data (default = inside chaindata)", Category: flags.EthCategory, } MinFreeDiskSpaceFlag = &flags.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)", Category: flags.EthCategory, } KeyStoreDirFlag = &flags.DirectoryFlag{ Name: "keystore", Usage: "Directory for the keystore (default = inside the datadir)", Category: flags.AccountCategory, } USBFlag = &cli.BoolFlag{ Name: "usb", Usage: "Enable monitoring and management of USB hardware wallets", Category: flags.AccountCategory, } SmartCardDaemonPathFlag = &cli.StringFlag{ Name: "pcscdpath", Usage: "Path to the smartcard daemon (pcscd) socket file", Value: pcsclite.PCSCDSockName, Category: flags.AccountCategory, } NetworkIdFlag = &cli.Uint64Flag{ Name: "networkid", Usage: "Explicitly set network id (integer)(For testnets: use --goerli, --sepolia, --holesky instead)", Value: ethconfig.Defaults.NetworkId, Category: flags.EthCategory, } MainnetFlag = &cli.BoolFlag{ Name: "mainnet", Usage: "Ethereum mainnet", Category: flags.EthCategory, } GoerliFlag = &cli.BoolFlag{ Name: "goerli", Usage: "Görli network: pre-configured proof-of-authority test network", Category: flags.EthCategory, } SepoliaFlag = &cli.BoolFlag{ Name: "sepolia", Usage: "Sepolia network: pre-configured proof-of-work test network", Category: flags.EthCategory, } HoleskyFlag = &cli.BoolFlag{ Name: "holesky", Usage: "Holesky network: pre-configured proof-of-stake test network", Category: flags.EthCategory, } // Dev mode DeveloperFlag = &cli.BoolFlag{ Name: "dev", Usage: "Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled", Category: flags.DevCategory, } DeveloperPeriodFlag = &cli.Uint64Flag{ Name: "dev.period", Usage: "Block period to use in developer mode (0 = mine only if transaction pending)", Category: flags.DevCategory, } DeveloperGasLimitFlag = &cli.Uint64Flag{ Name: "dev.gaslimit", Usage: "Initial block gas limit", Value: 11500000, Category: flags.DevCategory, } IdentityFlag = &cli.StringFlag{ Name: "identity", Usage: "Custom node name", Category: flags.NetworkingCategory, } DocRootFlag = &flags.DirectoryFlag{ Name: "docroot", Usage: "Document Root for HTTPClient file scheme", Value: flags.DirectoryString(flags.HomeDir()), Category: flags.APICategory, } ExitWhenSyncedFlag = &cli.BoolFlag{ Name: "exitwhensynced", Usage: "Exits after block synchronisation completes", Category: flags.EthCategory, } // Dump command options. IterativeOutputFlag = &cli.BoolFlag{ Name: "iterative", Usage: "Print streaming JSON iteratively, delimited by newlines", Value: true, } 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)", } StartKeyFlag = &cli.StringFlag{ Name: "start", Usage: "Start position. Either a hash or address", Value: "0x0000000000000000000000000000000000000000000000000000000000000000", } DumpLimitFlag = &cli.Uint64Flag{ Name: "limit", Usage: "Max number of elements (0 = no limit)", Value: 0, } SnapshotFlag = &cli.BoolFlag{ Name: "snapshot", Usage: `Enables snapshot-database mode (default = enable)`, Value: true, Category: flags.EthCategory, } LightKDFFlag = &cli.BoolFlag{ Name: "lightkdf", Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength", Category: flags.AccountCategory, } EthRequiredBlocksFlag = &cli.StringFlag{ Name: "eth.requiredblocks", Usage: "Comma separated block number-to-hash mappings to require for peering (<number>=<hash>)", Category: flags.EthCategory, } BloomFilterSizeFlag = &cli.Uint64Flag{ Name: "bloomfilter.size", Usage: "Megabytes of memory allocated to bloom-filter for pruning", Value: 2048, Category: flags.EthCategory, } OverrideCancun = &cli.Uint64Flag{ Name: "override.cancun", Usage: "Manually specify the Cancun fork timestamp, overriding the bundled setting", Category: flags.EthCategory, } OverrideVerkle = &cli.Uint64Flag{ Name: "override.verkle", Usage: "Manually specify the Verkle fork timestamp, overriding the bundled setting", Category: flags.EthCategory, } SyncModeFlag = &flags.TextMarshalerFlag{ Name: "syncmode", Usage: `Blockchain sync mode ("snap" or "full")`, Value: &defaultSyncMode, Category: flags.StateCategory, } GCModeFlag = &cli.StringFlag{ Name: "gcmode", Usage: `Blockchain garbage collection mode, only relevant in state.scheme=hash ("full", "archive")`, Value: "full", Category: flags.StateCategory, } StateSchemeFlag = &cli.StringFlag{ Name: "state.scheme", Usage: "Scheme to use for storing ethereum state ('hash' or 'path')", Category: flags.StateCategory, } StateHistoryFlag = &cli.Uint64Flag{ Name: "history.state", Usage: "Number of recent blocks to retain state history for (default = 90,000 blocks, 0 = entire chain)", Value: ethconfig.Defaults.StateHistory, Category: flags.StateCategory, } TransactionHistoryFlag = &cli.Uint64Flag{ Name: "history.transactions", Usage: "Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain)", Value: ethconfig.Defaults.TransactionHistory, Category: flags.StateCategory, } // Beacon client light sync settings BeaconApiFlag = &cli.StringSliceFlag{ Name: "beacon.api", Usage: "Beacon node (CL) light client API URL. This flag can be given multiple times.", Category: flags.BeaconCategory, } BeaconApiHeaderFlag = &cli.StringSliceFlag{ Name: "beacon.api.header", Usage: "Pass custom HTTP header fields to the emote beacon node API in \"key:value\" format. This flag can be given multiple times.", Category: flags.BeaconCategory, } BeaconThresholdFlag = &cli.IntFlag{ Name: "beacon.threshold", Usage: "Beacon sync committee participation threshold", Value: bparams.SyncCommitteeSupermajority, Category: flags.BeaconCategory, } BeaconNoFilterFlag = &cli.BoolFlag{ Name: "beacon.nofilter", Usage: "Disable future slot signature filter", Category: flags.BeaconCategory, } BeaconConfigFlag = &cli.StringFlag{ Name: "beacon.config", Usage: "Beacon chain config YAML file", Category: flags.BeaconCategory, } BeaconGenesisRootFlag = &cli.StringFlag{ Name: "beacon.genesis.gvroot", Usage: "Beacon chain genesis validators root", Category: flags.BeaconCategory, } BeaconGenesisTimeFlag = &cli.Uint64Flag{ Name: "beacon.genesis.time", Usage: "Beacon chain genesis time", Category: flags.BeaconCategory, } BeaconCheckpointFlag = &cli.StringFlag{ Name: "beacon.checkpoint", Usage: "Beacon chain weak subjectivity checkpoint block hash", Category: flags.BeaconCategory, } BlsyncApiFlag = &cli.StringFlag{ Name: "blsync.engine.api", Usage: "Target EL engine API URL", Category: flags.BeaconCategory, } BlsyncJWTSecretFlag = &cli.StringFlag{ Name: "blsync.jwtsecret", Usage: "Path to a JWT secret to use for target engine API endpoint", Category: flags.BeaconCategory, } // Transaction pool settings TxPoolLocalsFlag = &cli.StringFlag{ Name: "txpool.locals", Usage: "Comma separated accounts to treat as locals (no flush, priority inclusion)", Category: flags.TxPoolCategory, } TxPoolNoLocalsFlag = &cli.BoolFlag{ Name: "txpool.nolocals", Usage: "Disables price exemptions for locally submitted transactions", Category: flags.TxPoolCategory, } TxPoolJournalFlag = &cli.StringFlag{ Name: "txpool.journal", Usage: "Disk journal for local transaction to survive node restarts", Value: ethconfig.Defaults.TxPool.Journal, Category: flags.TxPoolCategory, } TxPoolRejournalFlag = &cli.DurationFlag{ Name: "txpool.rejournal", Usage: "Time interval to regenerate the local transaction journal", Value: ethconfig.Defaults.TxPool.Rejournal, Category: flags.TxPoolCategory, } TxPoolPriceLimitFlag = &cli.Uint64Flag{ Name: "txpool.pricelimit", Usage: "Minimum gas price tip to enforce for acceptance into the pool", Value: ethconfig.Defaults.TxPool.PriceLimit, Category: flags.TxPoolCategory, } TxPoolPriceBumpFlag = &cli.Uint64Flag{ Name: "txpool.pricebump", Usage: "Price bump percentage to replace an already existing transaction", Value: ethconfig.Defaults.TxPool.PriceBump, Category: flags.TxPoolCategory, } TxPoolAccountSlotsFlag = &cli.Uint64Flag{ Name: "txpool.accountslots", Usage: "Minimum number of executable transaction slots guaranteed per account", Value: ethconfig.Defaults.TxPool.AccountSlots, Category: flags.TxPoolCategory, } TxPoolGlobalSlotsFlag = &cli.Uint64Flag{ Name: "txpool.globalslots", Usage: "Maximum number of executable transaction slots for all accounts", Value: ethconfig.Defaults.TxPool.GlobalSlots, Category: flags.TxPoolCategory, } TxPoolAccountQueueFlag = &cli.Uint64Flag{ Name: "txpool.accountqueue", Usage: "Maximum number of non-executable transaction slots permitted per account", Value: ethconfig.Defaults.TxPool.AccountQueue, Category: flags.TxPoolCategory, } TxPoolGlobalQueueFlag = &cli.Uint64Flag{ Name: "txpool.globalqueue", Usage: "Maximum number of non-executable transaction slots for all accounts", Value: ethconfig.Defaults.TxPool.GlobalQueue, Category: flags.TxPoolCategory, } TxPoolLifetimeFlag = &cli.DurationFlag{ Name: "txpool.lifetime", Usage: "Maximum amount of time non-executable transaction are queued", Value: ethconfig.Defaults.TxPool.Lifetime, Category: flags.TxPoolCategory, } // Blob transaction pool settings BlobPoolDataDirFlag = &cli.StringFlag{ Name: "blobpool.datadir", Usage: "Data directory to store blob transactions in", Value: ethconfig.Defaults.BlobPool.Datadir, Category: flags.BlobPoolCategory, } BlobPoolDataCapFlag = &cli.Uint64Flag{ Name: "blobpool.datacap", Usage: "Disk space to allocate for pending blob transactions (soft limit)", Value: ethconfig.Defaults.BlobPool.Datacap, Category: flags.BlobPoolCategory, } BlobPoolPriceBumpFlag = &cli.Uint64Flag{ Name: "blobpool.pricebump", Usage: "Price bump percentage to replace an already existing blob transaction", Value: ethconfig.Defaults.BlobPool.PriceBump, Category: flags.BlobPoolCategory, } // 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, Category: flags.PerfCategory, } CacheDatabaseFlag = &cli.IntFlag{ Name: "cache.database", Usage: "Percentage of cache memory allowance to use for database io", Value: 50, Category: flags.PerfCategory, } 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, Category: flags.PerfCategory, } 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, Category: flags.PerfCategory, } CacheSnapshotFlag = &cli.IntFlag{ Name: "cache.snapshot", Usage: "Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode)", Value: 10, Category: flags.PerfCategory, } CacheNoPrefetchFlag = &cli.BoolFlag{ Name: "cache.noprefetch", Usage: "Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)", Category: flags.PerfCategory, } CachePreimagesFlag = &cli.BoolFlag{ Name: "cache.preimages", Usage: "Enable recording the SHA3/keccak preimages of trie keys", Category: flags.PerfCategory, } CacheLogSizeFlag = &cli.IntFlag{ Name: "cache.blocklogs", Usage: "Size (in number of blocks) of the log cache for filtering", Category: flags.PerfCategory, Value: ethconfig.Defaults.FilterLogCacheSize, } FDLimitFlag = &cli.IntFlag{ Name: "fdlimit", Usage: "Raise the open file descriptor resource limit (default = system fd limit)", Category: flags.PerfCategory, } CryptoKZGFlag = &cli.StringFlag{ Name: "crypto.kzg", Usage: "KZG library implementation to use; gokzg (recommended) or ckzg", Value: "gokzg", Category: flags.PerfCategory, } // Miner settings MinerGasLimitFlag = &cli.Uint64Flag{ Name: "miner.gaslimit", Usage: "Target gas ceiling for mined blocks", Value: ethconfig.Defaults.Miner.GasCeil, Category: flags.MinerCategory, } MinerGasPriceFlag = &flags.BigFlag{ Name: "miner.gasprice", Usage: "Minimum gas price for mining a transaction", Value: ethconfig.Defaults.Miner.GasPrice, Category: flags.MinerCategory, } MinerExtraDataFlag = &cli.StringFlag{ Name: "miner.extradata", Usage: "Block extra data set by the miner (default = client version)", Category: flags.MinerCategory, } MinerRecommitIntervalFlag = &cli.DurationFlag{ Name: "miner.recommit", Usage: "Time interval to recreate the block being mined", Value: ethconfig.Defaults.Miner.Recommit, Category: flags.MinerCategory, } MinerPendingFeeRecipientFlag = &cli.StringFlag{ Name: "miner.pending.feeRecipient", Usage: "0x prefixed public address for the pending block producer (not used for actual block production)", Category: flags.MinerCategory, } // Account settings UnlockedAccountFlag = &cli.StringFlag{ Name: "unlock", Usage: "Comma separated list of accounts to unlock", Value: "", Category: flags.AccountCategory, } PasswordFileFlag = &cli.PathFlag{ Name: "password", Usage: "Password file to use for non-interactive password input", TakesFile: true, Category: flags.AccountCategory, } ExternalSignerFlag = &cli.StringFlag{ Name: "signer", Usage: "External signer (url or path to ipc file)", Value: "", Category: flags.AccountCategory, } InsecureUnlockAllowedFlag = &cli.BoolFlag{ Name: "allow-insecure-unlock", Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http", Category: flags.AccountCategory, } // EVM settings VMEnableDebugFlag = &cli.BoolFlag{ Name: "vmdebug", Usage: "Record information useful for VM and contract debugging", Category: flags.VMCategory, } VMTraceFlag = &cli.StringFlag{ Name: "vmtrace", Usage: "Name of tracer which should record internal VM operations (costly)", Category: flags.VMCategory, } VMTraceJsonConfigFlag = &cli.StringFlag{ Name: "vmtrace.jsonconfig", Usage: "Tracer configuration (JSON)", Category: flags.VMCategory, } // API options. 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, Category: flags.APICategory, } RPCGlobalEVMTimeoutFlag = &cli.DurationFlag{ Name: "rpc.evmtimeout", Usage: "Sets a timeout used for eth_call (0=infinite)", Value: ethconfig.Defaults.RPCEVMTimeout, Category: flags.APICategory, } 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, Category: flags.APICategory, } // Authenticated RPC HTTP settings AuthListenFlag = &cli.StringFlag{ Name: "authrpc.addr", Usage: "Listening address for authenticated APIs", Value: node.DefaultConfig.AuthAddr, Category: flags.APICategory, } AuthPortFlag = &cli.IntFlag{ Name: "authrpc.port", Usage: "Listening port for authenticated APIs", Value: node.DefaultConfig.AuthPort, Category: flags.APICategory, } AuthVirtualHostsFlag = &cli.StringFlag{ Name: "authrpc.vhosts", Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.", Value: strings.Join(node.DefaultConfig.AuthVirtualHosts, ","), Category: flags.APICategory, } JWTSecretFlag = &flags.DirectoryFlag{ Name: "authrpc.jwtsecret", Usage: "Path to a JWT secret to use for authenticated RPC endpoints", Category: flags.APICategory, } // Logging and debug settings EthStatsURLFlag = &cli.StringFlag{ Name: "ethstats", Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)", Category: flags.MetricsCategory, } NoCompactionFlag = &cli.BoolFlag{ Name: "nocompaction", Usage: "Disables db compaction after import", Category: flags.LoggingCategory, } CollectWitnessFlag = &cli.BoolFlag{ Name: "collectwitness", Usage: "Enable state witness generation during block execution. Work in progress flag, don't use.", Category: flags.MiscCategory, } // MISC settings SyncTargetFlag = &cli.StringFlag{ Name: "synctarget", Usage: `Hash of the block to full sync to (dev testing feature)`, TakesFile: true, Category: flags.MiscCategory, } // RPC settings IPCDisabledFlag = &cli.BoolFlag{ Name: "ipcdisable", Usage: "Disable the IPC-RPC server", Category: flags.APICategory, } IPCPathFlag = &flags.DirectoryFlag{ Name: "ipcpath", Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)", Category: flags.APICategory, } HTTPEnabledFlag = &cli.BoolFlag{ Name: "http", Usage: "Enable the HTTP-RPC server", Category: flags.APICategory, } HTTPListenAddrFlag = &cli.StringFlag{ Name: "http.addr", Usage: "HTTP-RPC server listening interface", Value: node.DefaultHTTPHost, Category: flags.APICategory, } HTTPPortFlag = &cli.IntFlag{ Name: "http.port", Usage: "HTTP-RPC server listening port", Value: node.DefaultHTTPPort, Category: flags.APICategory, } HTTPCORSDomainFlag = &cli.StringFlag{ Name: "http.corsdomain", Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)", Value: "", Category: flags.APICategory, } 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, ","), Category: flags.APICategory, } HTTPApiFlag = &cli.StringFlag{ Name: "http.api", Usage: "API's offered over the HTTP-RPC interface", Value: "", Category: flags.APICategory, } HTTPPathPrefixFlag = &cli.StringFlag{ Name: "http.rpcprefix", Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.", Value: "", Category: flags.APICategory, } 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.", Category: flags.APICategory, } GraphQLCORSDomainFlag = &cli.StringFlag{ Name: "graphql.corsdomain", Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)", Value: "", Category: flags.APICategory, } 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, ","), Category: flags.APICategory, } WSEnabledFlag = &cli.BoolFlag{ Name: "ws", Usage: "Enable the WS-RPC server", Category: flags.APICategory, } WSListenAddrFlag = &cli.StringFlag{ Name: "ws.addr", Usage: "WS-RPC server listening interface", Value: node.DefaultWSHost, Category: flags.APICategory, } WSPortFlag = &cli.IntFlag{ Name: "ws.port", Usage: "WS-RPC server listening port", Value: node.DefaultWSPort, Category: flags.APICategory, } WSApiFlag = &cli.StringFlag{ Name: "ws.api", Usage: "API's offered over the WS-RPC interface", Value: "", Category: flags.APICategory, } WSAllowedOriginsFlag = &cli.StringFlag{ Name: "ws.origins", Usage: "Origins from which to accept websockets requests", Value: "", Category: flags.APICategory, } WSPathPrefixFlag = &cli.StringFlag{ Name: "ws.rpcprefix", Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.", Value: "", Category: flags.APICategory, } ExecFlag = &cli.StringFlag{ Name: "exec", Usage: "Execute JavaScript statement", Category: flags.APICategory, } PreloadJSFlag = &cli.StringFlag{ Name: "preload", Usage: "Comma separated list of JavaScript files to preload into the console", Category: flags.APICategory, } AllowUnprotectedTxs = &cli.BoolFlag{ Name: "rpc.allow-unprotected-txs", Usage: "Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC", Category: flags.APICategory, } BatchRequestLimit = &cli.IntFlag{ Name: "rpc.batch-request-limit", Usage: "Maximum number of requests in a batch", Value: node.DefaultConfig.BatchRequestLimit, Category: flags.APICategory, } BatchResponseMaxSize = &cli.IntFlag{ Name: "rpc.batch-response-max-size", Usage: "Maximum number of bytes returned from a batched call", Value: node.DefaultConfig.BatchResponseMaxSize, Category: flags.APICategory, } EnablePersonal = &cli.BoolFlag{ Name: "rpc.enabledeprecatedpersonal", Usage: "Enables the (deprecated) personal namespace", Category: flags.APICategory, } // Network Settings MaxPeersFlag = &cli.IntFlag{ Name: "maxpeers", Usage: "Maximum number of network peers (network disabled if set to 0)", Value: node.DefaultConfig.P2P.MaxPeers, Category: flags.NetworkingCategory, } MaxPendingPeersFlag = &cli.IntFlag{ Name: "maxpendpeers", Usage: "Maximum number of pending connection attempts (defaults used if set to 0)", Value: node.DefaultConfig.P2P.MaxPendingPeers, Category: flags.NetworkingCategory, } ListenPortFlag = &cli.IntFlag{ Name: "port", Usage: "Network listening port", Value: 30303, Category: flags.NetworkingCategory, } BootnodesFlag = &cli.StringFlag{ Name: "bootnodes", Usage: "Comma separated enode URLs for P2P discovery bootstrap", Value: "", Category: flags.NetworkingCategory, } NodeKeyFileFlag = &cli.StringFlag{ Name: "nodekey", Usage: "P2P node key file", Category: flags.NetworkingCategory, } NodeKeyHexFlag = &cli.StringFlag{ Name: "nodekeyhex", Usage: "P2P node key as hex (for testing)", Category: flags.NetworkingCategory, } NATFlag = &cli.StringFlag{ Name: "nat", Usage: "NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>)", Value: "any", Category: flags.NetworkingCategory, } NoDiscoverFlag = &cli.BoolFlag{ Name: "nodiscover", Usage: "Disables the peer discovery mechanism (manual peer addition)", Category: flags.NetworkingCategory, } DiscoveryV4Flag = &cli.BoolFlag{ Name: "discovery.v4", Aliases: []string{"discv4"}, Usage: "Enables the V4 discovery mechanism", Category: flags.NetworkingCategory, Value: true, } DiscoveryV5Flag = &cli.BoolFlag{ Name: "discovery.v5", Aliases: []string{"discv5"}, Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism", Category: flags.NetworkingCategory, } NetrestrictFlag = &cli.StringFlag{ Name: "netrestrict", Usage: "Restricts network communication to the given IP networks (CIDR masks)", Category: flags.NetworkingCategory, } DNSDiscoveryFlag = &cli.StringFlag{ Name: "discovery.dns", Usage: "Sets DNS discovery entry points (use \"\" to disable DNS)", Category: flags.NetworkingCategory, } DiscoveryPortFlag = &cli.IntFlag{ Name: "discovery.port", Usage: "Use a custom UDP port for P2P discovery", Value: 30303, Category: flags.NetworkingCategory, } // Console JSpathFlag = &flags.DirectoryFlag{ Name: "jspath", Usage: "JavaScript root path for `loadScript`", Value: flags.DirectoryString("."), Category: flags.APICategory, } HttpHeaderFlag = &cli.StringSliceFlag{ Name: "header", Aliases: []string{"H"}, Usage: "Pass custom headers to the RPC server when using --" + RemoteDBFlag.Name + " or the geth attach console. This flag can be given multiple times.", Category: flags.APICategory, } // 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, Category: flags.GasPriceCategory, } 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, Category: flags.GasPriceCategory, } GpoMaxGasPriceFlag = &cli.Int64Flag{ Name: "gpo.maxprice", Usage: "Maximum transaction priority fee (or gasprice before London fork) to be recommended by gpo", Value: ethconfig.Defaults.GPO.MaxPrice.Int64(), Category: flags.GasPriceCategory, } GpoIgnoreGasPriceFlag = &cli.Int64Flag{ Name: "gpo.ignoreprice", Usage: "Gas price below which gpo will ignore transactions", Value: ethconfig.Defaults.GPO.IgnorePrice.Int64(), Category: flags.GasPriceCategory, } // Metrics flags MetricsEnabledFlag = &cli.BoolFlag{ Name: "metrics", Usage: "Enable metrics collection and reporting", Category: flags.MetricsCategory, } // 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.`, Category: flags.MetricsCategory, } MetricsPortFlag = &cli.IntFlag{ Name: "metrics.port", Usage: `Metrics HTTP server listening port. Please note that --` + MetricsHTTPFlag.Name + ` must be set to start the server.`, Value: metrics.DefaultConfig.Port, Category: flags.MetricsCategory, } MetricsEnableInfluxDBFlag = &cli.BoolFlag{ Name: "metrics.influxdb", Usage: "Enable metrics export/push to an external InfluxDB database", Category: flags.MetricsCategory, } MetricsInfluxDBEndpointFlag = &cli.StringFlag{ Name: "metrics.influxdb.endpoint", Usage: "InfluxDB API endpoint to report metrics to", Value: metrics.DefaultConfig.InfluxDBEndpoint, Category: flags.MetricsCategory, } MetricsInfluxDBDatabaseFlag = &cli.StringFlag{ Name: "metrics.influxdb.database", Usage: "InfluxDB database name to push reported metrics to", Value: metrics.DefaultConfig.InfluxDBDatabase, Category: flags.MetricsCategory, } MetricsInfluxDBUsernameFlag = &cli.StringFlag{ Name: "metrics.influxdb.username", Usage: "Username to authorize access to the database", Value: metrics.DefaultConfig.InfluxDBUsername, Category: flags.MetricsCategory, } MetricsInfluxDBPasswordFlag = &cli.StringFlag{ Name: "metrics.influxdb.password", Usage: "Password to authorize access to the database", Value: metrics.DefaultConfig.InfluxDBPassword, Category: flags.MetricsCategory, } // 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, Category: flags.MetricsCategory, } MetricsEnableInfluxDBV2Flag = &cli.BoolFlag{ Name: "metrics.influxdbv2", Usage: "Enable metrics export/push to an external InfluxDB v2 database", Category: flags.MetricsCategory, } MetricsInfluxDBTokenFlag = &cli.StringFlag{ Name: "metrics.influxdb.token", Usage: "Token to authorize access to the database (v2 only)", Value: metrics.DefaultConfig.InfluxDBToken, Category: flags.MetricsCategory, } MetricsInfluxDBBucketFlag = &cli.StringFlag{ Name: "metrics.influxdb.bucket", Usage: "InfluxDB bucket name to push reported metrics to (v2 only)", Value: metrics.DefaultConfig.InfluxDBBucket, Category: flags.MetricsCategory, } MetricsInfluxDBOrganizationFlag = &cli.StringFlag{ Name: "metrics.influxdb.organization", Usage: "InfluxDB organization name (v2 only)", Value: metrics.DefaultConfig.InfluxDBOrganization, Category: flags.MetricsCategory, } )
var ( // TestnetFlags is the flag group of all built-in supported testnets. TestnetFlags = []cli.Flag{ GoerliFlag, SepoliaFlag, HoleskyFlag, } // NetworkFlags is the flag group of all built-in supported networks. NetworkFlags = append([]cli.Flag{MainnetFlag}, TestnetFlags...) // DatabaseFlags is the flag group of all database flags. DatabaseFlags = []cli.Flag{ DataDirFlag, AncientFlag, RemoteDBFlag, DBEngineFlag, StateSchemeFlag, HttpHeaderFlag, } )
var ( // Deprecated May 2020, shown in aliased flags section NoUSBFlag = &cli.BoolFlag{ Name: "nousb", Usage: "Disables monitoring for and managing USB hardware wallets (deprecated)", Category: flags.DeprecatedCategory, } // Deprecated March 2022 LegacyWhitelistFlag = &cli.StringFlag{ Name: "whitelist", Usage: "Comma separated block number-to-hash mappings to enforce (<number>=<hash>) (deprecated in favor of --eth.requiredblocks)", Category: flags.DeprecatedCategory, } // Deprecated July 2023 CacheTrieJournalFlag = &cli.StringFlag{ Name: "cache.trie.journal", Usage: "Disk journal directory for trie cache to survive node restarts", Category: flags.DeprecatedCategory, } CacheTrieRejournalFlag = &cli.DurationFlag{ Name: "cache.trie.rejournal", Usage: "Time interval to regenerate the trie cache journal", Category: flags.DeprecatedCategory, } LegacyDiscoveryV5Flag = &cli.BoolFlag{ Name: "v5disc", Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use --discv5 instead)", Category: flags.DeprecatedCategory, } // Deprecated August 2023 TxLookupLimitFlag = &cli.Uint64Flag{ Name: "txlookuplimit", Usage: "Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain) (deprecated, use history.transactions instead)", Value: ethconfig.Defaults.TransactionHistory, Category: flags.DeprecatedCategory, } // Light server and client settings, Deprecated November 2023 LightServeFlag = &cli.IntFlag{ Name: "light.serve", Usage: "Maximum percentage of time allowed for serving LES requests (deprecated)", Value: ethconfig.Defaults.LightServ, Category: flags.DeprecatedCategory, } LightIngressFlag = &cli.IntFlag{ Name: "light.ingress", Usage: "Incoming bandwidth limit for serving light clients (deprecated)", Value: ethconfig.Defaults.LightIngress, Category: flags.DeprecatedCategory, } LightEgressFlag = &cli.IntFlag{ Name: "light.egress", Usage: "Outgoing bandwidth limit for serving light clients (deprecated)", Value: ethconfig.Defaults.LightEgress, Category: flags.DeprecatedCategory, } LightMaxPeersFlag = &cli.IntFlag{ Name: "light.maxpeers", Usage: "Maximum number of light clients to serve, or light servers to attach to (deprecated)", Value: ethconfig.Defaults.LightPeers, Category: flags.DeprecatedCategory, } LightNoPruneFlag = &cli.BoolFlag{ Name: "light.nopruning", Usage: "Disable ancient light chain data pruning (deprecated)", Category: flags.DeprecatedCategory, } LightNoSyncServeFlag = &cli.BoolFlag{ Name: "light.nosyncserve", Usage: "Enables serving light clients before syncing (deprecated)", Category: flags.DeprecatedCategory, } // Deprecated November 2023 LogBacktraceAtFlag = &cli.StringFlag{ Name: "log.backtrace", Usage: "Request a stack trace at a specific logging statement (deprecated)", Value: "", Category: flags.DeprecatedCategory, } LogDebugFlag = &cli.BoolFlag{ Name: "log.debug", Usage: "Prepends log messages with call-site location (deprecated)", Category: flags.DeprecatedCategory, } // Deprecated February 2024 MinerNewPayloadTimeoutFlag = &cli.DurationFlag{ Name: "miner.newpayload-timeout", Usage: "Specify the maximum time allowance for creating a new payload (deprecated)", Value: ethconfig.Defaults.Miner.Recommit, Category: flags.DeprecatedCategory, } MinerEtherbaseFlag = &cli.StringFlag{ Name: "miner.etherbase", Usage: "0x prefixed public address for block mining rewards (deprecated)", Category: flags.DeprecatedCategory, } MiningEnabledFlag = &cli.BoolFlag{ Name: "mine", Usage: "Enable mining (deprecated)", Category: flags.DeprecatedCategory, } MetricsEnabledExpensiveFlag = &cli.BoolFlag{ Name: "metrics.expensive", Usage: "Enable expensive metrics collection and reporting (deprecated)", Category: flags.DeprecatedCategory, } )
var DeprecatedFlags = []cli.Flag{ NoUSBFlag, LegacyWhitelistFlag, CacheTrieJournalFlag, CacheTrieRejournalFlag, LegacyDiscoveryV5Flag, TxLookupLimitFlag, LightServeFlag, LightIngressFlag, LightEgressFlag, LightMaxPeersFlag, LightNoPruneFlag, LightNoSyncServeFlag, LogBacktraceAtFlag, LogDebugFlag, MinerNewPayloadTimeoutFlag, MinerEtherbaseFlag, MiningEnabledFlag, }
var ShowDeprecated = &cli.Command{
Action: showDeprecated,
Name: "show-deprecated-flags",
Usage: "Show flags that have been deprecated",
ArgsUsage: " ",
Description: "Show flags that have been deprecated and will soon be removed",
}
Functions ¶
func CheckExclusive ¶
func CheckExclusive(ctx *cli.Context, args ...interface{})
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 DialRPCWithHeaders ¶
func ExportAppendChain ¶
ExportAppendChain exports a blockchain into the specified file, appending to the file if data already exists in it.
func ExportChain ¶
func ExportChain(blockchain *core.BlockChain, fn string) error
ExportChain exports a blockchain into the specified file, truncating any data already present in the file.
func ExportChaindata ¶
func ExportChaindata(fn string, kind string, iter ChainDataIterator, interrupt chan struct{}) error
ExportChaindata exports the given data type (truncating any data already present) in the file. If the suffix is 'gz', gzip compression is used.
func ExportHistory ¶
func ExportHistory(bc *core.BlockChain, dir string, first, last, step uint64) error
ExportHistory exports blockchain history into the specified directory, following the Era format.
func ExportPreimages ¶
ExportPreimages exports all known hash preimages into the specified file, truncating any data already present in the file. It's a part of the deprecated functionality, should be removed in the future.
func ExportSnapshotPreimages ¶
func ExportSnapshotPreimages(chaindb ethdb.Database, snaptree *snapshot.Tree, fn string, root common.Hash) error
ExportSnapshotPreimages exports the preimages corresponding to the enumeration of the snapshot for a given root.
func Fatalf ¶
func Fatalf(format string, args ...interface{})
Fatalf formats a message to standard error and exits the program. The message is also printed to standard output if standard error is redirected to a different file.
func GetPassPhrase ¶
GetPassPhrase displays the given text(prompt) to the user and requests some textual data to be entered, but one which must not be echoed out into the terminal. The method returns the input provided by the user.
func GetPassPhraseWithList ¶
GetPassPhraseWithList retrieves the password associated with an account, either fetched from a list of preloaded passphrases, or requested interactively from the user.
func ImportChain ¶
func ImportChain(chain *core.BlockChain, fn string) error
func ImportHistory ¶
ImportHistory imports Era1 files containing historical block information, starting from genesis.
func ImportLDBData ¶
ImportLDBData imports a batch of snapshot data into the database
func ImportPreimages ¶
ImportPreimages imports a batch of exported hash preimages into the database. It's a part of the deprecated functionality, should be removed in the future.
func IsNetworkPreset ¶
func IsNetworkPreset(ctx *cli.Context) bool
func MakeAddress ¶
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 MakeChain ¶
func MakeChain(ctx *cli.Context, stack *node.Node, readonly bool) (*core.BlockChain, ethdb.Database)
MakeChain creates a chain manager from set command line flags.
func MakeChainDatabase ¶
MakeChainDatabase opens a database using the flags passed to the client and will hard crash if it fails.
func MakeConsolePreloads ¶
func MakeConsolePreloads(ctx *cli.Context) []string
MakeConsolePreloads retrieves the absolute paths for the console JavaScript scripts to preload before starting.
func MakeDataDir ¶
func MakeDataDir(ctx *cli.Context) string
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 MakeDatabaseHandles ¶
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 MakeGenesis ¶
func MakePasswordList ¶
func MakePasswordList(ctx *cli.Context) []string
MakePasswordList reads password lines from the file specified by the global --password flag.
func MakeTrieDatabase ¶
func MakeTrieDatabase(ctx *cli.Context, disk ethdb.Database, preimage bool, readOnly bool, isVerkle bool) *triedb.Database
MakeTrieDatabase constructs a trie database based on the configured scheme.
func RegisterEthService ¶
RegisterEthService adds an Ethereum client to the stack. The second return value is the full node instance.
func RegisterEthStatsService ¶
RegisterEthStatsService configures the Ethereum Stats daemon and adds it to the node.
func RegisterFilterAPI ¶
func RegisterFilterAPI(stack *node.Node, backend ethapi.Backend, ethcfg *ethconfig.Config) *filters.FilterSystem
RegisterFilterAPI adds the eth log filtering RPC API to the node.
func RegisterFullSyncTester ¶
RegisterFullSyncTester adds the full-sync tester service into node.
func RegisterGraphQLService ¶
func RegisterGraphQLService(stack *node.Node, backend ethapi.Backend, filterSystem *filters.FilterSystem, cfg *node.Config)
RegisterGraphQLService adds the GraphQL API to the node.
func SetDNSDiscoveryDefaults ¶
SetDNSDiscoveryDefaults configures DNS discovery with the given URL if no URLs are set.
func SetDataDir ¶
func SetEthConfig ¶
SetEthConfig applies eth-related command line flags to the config.
func SetNodeConfig ¶
SetNodeConfig applies node-related command line flags to the config.
func SetP2PConfig ¶
func SetupMetrics ¶
func SetupMetrics(ctx *cli.Context)
func SplitAndTrim ¶
SplitAndTrim splits input separated by a comma and trims excessive white space from the substrings.
func SplitTagsFlag ¶
Types ¶
type ChainDataIterator ¶
type ChainDataIterator interface { // Next returns the key-value pair for next exporting entry in the iterator. // When the end is reached, it will return (0, nil, nil, false). Next() (byte, []byte, []byte, bool) // Release releases associated resources. Release should always succeed and can // be called multiple times without causing error. Release() }
ChainDataIterator is an interface wraps all necessary functions to iterate the exporting chain data.