2015-07-07 02:54:22 +02:00
// 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
2015-07-22 18:48:40 +02:00
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2015-07-07 02:54:22 +02:00
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
2015-07-22 18:48:40 +02:00
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
2015-07-07 02:54:22 +02:00
2016-11-25 17:55:06 +02:00
// Package utils contains internal helper functions for go-ethereum commands.
2015-03-06 03:00:41 +01:00
package utils
import (
2022-09-30 13:50:25 +02:00
"context"
2015-03-06 03:00:41 +01:00
"crypto/ecdsa"
2023-01-24 11:11:33 +01:00
"encoding/hex"
2022-09-30 13:50:25 +02:00
"errors"
2015-04-20 18:45:37 +03:00
"fmt"
2021-04-06 10:23:35 -04:00
"math"
2015-05-09 12:00:51 +02:00
"math/big"
2023-07-02 19:21:16 +08:00
"net"
2022-09-30 13:50:25 +02:00
"net/http"
2015-03-09 23:00:27 +01:00
"os"
2023-04-10 18:36:45 +08:00
"path/filepath"
2022-11-28 22:09:45 +08:00
"runtime"
2021-04-06 10:23:35 -04:00
godebug "runtime/debug"
2015-07-07 10:32:05 +02:00
"strconv"
2015-11-17 18:33:25 +02:00
"strings"
2018-07-02 14:51:02 +02:00
"time"
2015-05-12 14:24:11 +02:00
2015-03-07 12:39:52 +01:00
"github.com/ethereum/go-ethereum/accounts"
2017-01-24 11:49:20 +02:00
"github.com/ethereum/go-ethereum/accounts/keystore"
2015-03-18 14:44:58 +07:00
"github.com/ethereum/go-ethereum/common"
2018-01-11 21:55:21 +01:00
"github.com/ethereum/go-ethereum/common/fdlimit"
2015-03-06 03:00:41 +01:00
"github.com/ethereum/go-ethereum/core"
2020-07-21 15:53:47 +03:00
"github.com/ethereum/go-ethereum/core/rawdb"
2023-06-16 15:29:40 +03:00
"github.com/ethereum/go-ethereum/core/txpool/legacypool"
2017-01-17 11:19:50 +00:00
"github.com/ethereum/go-ethereum/core/vm"
2015-03-06 03:00:41 +01:00
"github.com/ethereum/go-ethereum/crypto"
2023-05-10 14:54:14 +03:00
"github.com/ethereum/go-ethereum/crypto/kzg4844"
2015-03-06 03:00:41 +01:00
"github.com/ethereum/go-ethereum/eth"
2017-04-12 16:27:23 +02:00
"github.com/ethereum/go-ethereum/eth/downloader"
2021-02-05 20:51:15 +08:00
"github.com/ethereum/go-ethereum/eth/ethconfig"
2022-08-19 11:14:59 +02:00
"github.com/ethereum/go-ethereum/eth/filters"
2017-04-12 16:27:23 +02:00
"github.com/ethereum/go-ethereum/eth/gasprice"
2021-01-25 21:36:39 +08:00
"github.com/ethereum/go-ethereum/eth/tracers"
2015-03-06 03:00:41 +01:00
"github.com/ethereum/go-ethereum/ethdb"
2022-05-18 16:27:17 +02:00
"github.com/ethereum/go-ethereum/ethdb/remotedb"
2016-11-25 17:55:06 +02:00
"github.com/ethereum/go-ethereum/ethstats"
2019-06-12 11:24:24 +03:00
"github.com/ethereum/go-ethereum/graphql"
2020-08-03 19:40:46 +02:00
"github.com/ethereum/go-ethereum/internal/ethapi"
2020-07-14 10:35:32 +02:00
"github.com/ethereum/go-ethereum/internal/flags"
2017-02-22 14:10:07 +02:00
"github.com/ethereum/go-ethereum/log"
2015-08-07 09:56:49 +02:00
"github.com/ethereum/go-ethereum/metrics"
2020-07-03 12:12:22 -05:00
"github.com/ethereum/go-ethereum/metrics/exp"
2018-07-02 14:51:02 +02:00
"github.com/ethereum/go-ethereum/metrics/influxdb"
2019-04-23 15:08:51 +08:00
"github.com/ethereum/go-ethereum/miner"
2015-11-17 18:33:25 +02:00
"github.com/ethereum/go-ethereum/node"
2017-04-12 16:27:23 +02:00
"github.com/ethereum/go-ethereum/p2p"
all: new p2p node representation (#17643)
Package p2p/enode provides a generalized representation of p2p nodes
which can contain arbitrary information in key/value pairs. It is also
the new home for the node database. The "v4" identity scheme is also
moved here from p2p/enr to remove the dependency on Ethereum crypto from
that package.
Record signature handling is changed significantly. The identity scheme
registry is removed and acceptable schemes must be passed to any method
that needs identity. This means records must now be validated explicitly
after decoding.
The enode API is designed to make signature handling easy and safe: most
APIs around the codebase work with enode.Node, which is a wrapper around
a valid record. Going from enr.Record to enode.Node requires a valid
signature.
* p2p/discover: port to p2p/enode
This ports the discovery code to the new node representation in
p2p/enode. The wire protocol is unchanged, this can be considered a
refactoring change. The Kademlia table can now deal with nodes using an
arbitrary identity scheme. This requires a few incompatible API changes:
- Table.Lookup is not available anymore. It used to take a public key
as argument because v4 protocol requires one. Its replacement is
LookupRandom.
- Table.Resolve takes *enode.Node instead of NodeID. This is also for
v4 protocol compatibility because nodes cannot be looked up by ID
alone.
- Types Node and NodeID are gone. Further commits in the series will be
fixes all over the the codebase to deal with those removals.
* p2p: port to p2p/enode and discovery changes
This adapts package p2p to the changes in p2p/discover. All uses of
discover.Node and discover.NodeID are replaced by their equivalents from
p2p/enode.
New API is added to retrieve the enode.Node instance of a peer. The
behavior of Server.Self with discovery disabled is improved. It now
tries much harder to report a working IP address, falling back to
127.0.0.1 if no suitable address can be determined through other means.
These changes were needed for tests of other packages later in the
series.
* p2p/simulations, p2p/testing: port to p2p/enode
No surprises here, mostly replacements of discover.Node, discover.NodeID
with their new equivalents. The 'interesting' API changes are:
- testing.ProtocolSession tracks complete nodes, not just their IDs.
- adapters.NodeConfig has a new method to create a complete node.
These changes were needed to make swarm tests work.
Note that the NodeID change makes the code incompatible with old
simulation snapshots.
* whisper/whisperv5, whisper/whisperv6: port to p2p/enode
This port was easy because whisper uses []byte for node IDs and
URL strings in the API.
* eth: port to p2p/enode
Again, easy to port because eth uses strings for node IDs and doesn't
care about node information in any way.
* les: port to p2p/enode
Apart from replacing discover.NodeID with enode.ID, most changes are in
the server pool code. It now deals with complete nodes instead
of (Pubkey, IP, Port) triples. The database format is unchanged for now,
but we should probably change it to use the node database later.
* node: port to p2p/enode
This change simply replaces discover.Node and discover.NodeID with their
new equivalents.
* swarm/network: port to p2p/enode
Swarm has its own node address representation, BzzAddr, containing both
an overlay address (the hash of a secp256k1 public key) and an underlay
address (enode:// URL).
There are no changes to the BzzAddr format in this commit, but certain
operations such as creating a BzzAddr from a node ID are now impossible
because node IDs aren't public keys anymore.
Most swarm-related changes in the series remove uses of
NewAddrFromNodeID, replacing it with NewAddr which takes a complete node
as argument. ToOverlayAddr is removed because we can just use the node
ID directly.
2018-09-25 00:59:00 +02:00
"github.com/ethereum/go-ethereum/p2p/enode"
2015-03-06 03:00:41 +01:00
"github.com/ethereum/go-ethereum/p2p/nat"
2016-11-22 20:52:31 +01:00
"github.com/ethereum/go-ethereum/p2p/netutil"
2015-10-07 18:21:13 +03:00
"github.com/ethereum/go-ethereum/params"
2022-08-19 11:14:59 +02:00
"github.com/ethereum/go-ethereum/rpc"
2024-02-13 21:49:53 +08:00
"github.com/ethereum/go-ethereum/triedb"
"github.com/ethereum/go-ethereum/triedb/hashdb"
"github.com/ethereum/go-ethereum/triedb/pathdb"
2024-02-02 15:43:33 +08:00
"github.com/fatih/structs"
2019-05-31 11:30:28 +02:00
pcsclite "github.com/gballet/go-libpcsclite"
2021-04-06 10:23:35 -04:00
gopsutil "github.com/shirou/gopsutil/mem"
2022-06-27 18:22:36 +02:00
"github.com/urfave/cli/v2"
2017-05-25 09:15:51 +02:00
)
2015-03-06 03:00:41 +01:00
// 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
2022-06-27 18:22:36 +02:00
DataDirFlag = & flags . DirectoryFlag {
Name : "datadir" ,
Usage : "Data directory for the databases and keystore" ,
Value : flags . DirectoryString ( node . DefaultDataDir ( ) ) ,
Category : flags . EthCategory ,
2015-03-06 03:00:41 +01:00
}
2024-04-18 15:12:05 +08:00
MultiDataBaseFlag = & cli . BoolFlag {
Name : "multidatabase" ,
Usage : "Enable a separated state and block database, it will be created within two subdirectory called state and block, " +
"Users can copy this state or block directory to another directory or disk, and then create a symbolic link to the state directory under the chaindata" ,
2024-03-08 16:07:29 +08:00
Category : flags . EthCategory ,
}
2023-08-23 17:46:08 +08:00
DirectBroadcastFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "directbroadcast" ,
Usage : "Enable directly broadcast mined block to all peers" ,
Category : flags . EthCategory ,
2021-03-03 17:50:30 +08:00
}
2023-08-23 17:46:08 +08:00
DisableSnapProtocolFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "disablesnapprotocol" ,
Usage : "Disable snap protocol" ,
Category : flags . EthCategory ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
EnableTrustProtocolFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "enabletrustprotocol" ,
Usage : "Enable trust protocol" ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
PipeCommitFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "pipecommit" ,
Usage : "Enable MPT pipeline commit, it will improve syncing performance. It is an experimental feature(default is false)" ,
Category : flags . DeprecatedCategory ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
RangeLimitFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "rangelimit" ,
Usage : "Enable 5000 blocks limit for range query" ,
Category : flags . APICategory ,
2021-02-23 15:12:41 +08:00
}
2023-08-23 17:46:08 +08:00
DiffFlag = flags . DirectoryFlag {
2023-09-18 20:07:03 +08:00
Name : "datadir.diff" ,
Usage : "Data directory for difflayer segments (default = inside chaindata)" ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2022-06-27 18:22:36 +02:00
RemoteDBFlag = & cli . StringFlag {
Name : "remotedb" ,
Usage : "URL for remote database" ,
Category : flags . LoggingCategory ,
}
2023-02-09 03:48:34 -05:00
DBEngineFlag = & cli . StringFlag {
Name : "db.engine" ,
2023-04-21 19:24:18 +03:00
Usage : "Backing database implementation to use ('pebble' or 'leveldb')" ,
Value : node . DefaultConfig . DBEngine ,
2023-02-09 03:48:34 -05:00
Category : flags . EthCategory ,
}
2022-06-27 18:22:36 +02:00
AncientFlag = & flags . DirectoryFlag {
Name : "datadir.ancient" ,
2022-08-08 17:08:36 +08:00
Usage : "Root directory for ancient data (default = inside chaindata)" ,
2022-06-27 18:22:36 +02:00
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 ,
}
2024-03-21 13:06:48 +08:00
InstanceFlag = & cli . IntFlag {
Name : "instance" ,
Usage : "Configures the ports to avoid conflicts when running multiple nodes on the same machine. Maximum is 200. Only applicable for: port, authrpc.port, discovery,port, http.port, ws.port" ,
Value : 1 ,
Category : flags . EthCategory ,
}
2022-06-27 18:22:36 +02:00
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" ,
2023-12-25 10:58:52 +08:00
Usage : "Explicitly set network id (integer)(For testnets: use --chapel instead)" ,
2022-06-27 18:22:36 +02:00
Value : ethconfig . Defaults . NetworkId ,
Category : flags . EthCategory ,
}
2023-11-29 15:04:50 +08:00
BSCMainnetFlag = & cli . BoolFlag {
2023-12-25 10:58:52 +08:00
Name : "mainnet" ,
2023-11-29 15:04:50 +08:00
Usage : "BSC mainnet" ,
2022-06-27 18:22:36 +02:00
Category : flags . EthCategory ,
}
2023-12-25 10:58:52 +08:00
ChapelFlag = & cli . BoolFlag {
Name : "chapel" ,
Usage : "Chapel network: pre-configured Proof-of-Stake-Authority BSC test network" ,
Category : flags . EthCategory ,
}
2022-06-27 18:22:36 +02:00
DeveloperFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "dev" ,
Usage : "Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled" ,
Category : flags . DevCategory ,
2017-10-24 13:40:42 +03:00
}
2023-07-06 10:42:34 +02:00
DeveloperPeriodFlag = & cli . Uint64Flag {
2022-06-27 18:22:36 +02:00
Name : "dev.period" ,
Usage : "Block period to use in developer mode (0 = mine only if transaction pending)" ,
Category : flags . DevCategory ,
2015-09-06 15:46:54 +02:00
}
2022-06-27 18:22:36 +02:00
DeveloperGasLimitFlag = & cli . Uint64Flag {
Name : "dev.gaslimit" ,
Usage : "Initial block gas limit" ,
Value : 11500000 ,
Category : flags . DevCategory ,
2021-11-16 07:45:02 -05:00
}
2022-06-27 18:22:36 +02:00
IdentityFlag = & cli . StringFlag {
Name : "identity" ,
Usage : "Custom node name" ,
Category : flags . NetworkingCategory ,
2015-04-18 23:53:30 +02:00
}
2022-06-27 18:22:36 +02:00
DocRootFlag = & flags . DirectoryFlag {
Name : "docroot" ,
Usage : "Document Root for HTTPClient file scheme" ,
Value : flags . DirectoryString ( flags . HomeDir ( ) ) ,
Category : flags . APICategory ,
2015-10-26 22:24:09 +01:00
}
2022-06-27 18:22:36 +02:00
ExitWhenSyncedFlag = & cli . BoolFlag {
Name : "exitwhensynced" ,
Usage : "Exits after block synchronisation completes" ,
Category : flags . EthCategory ,
cmd,eth: 16400 Add an option to stop geth once in sync. WIP for light mode (#17321)
* cmd, eth: Added in the flag to step geth once sync based on input
* cmd, eth: 16400 Add an option to stop geth once in sync.
* cmd: 16400 Add an option to stop geth once in sync. WIP
* cmd/geth/main, les/fletcher: added in light mode support
* cmd/geth/main, les/fletcher: Cleaned Comments and code for light mode
* cmd: 16400 Fixed formatting issue and cleaned code
* cmd, eth, les: 16400 Fixed formatting issues
* cmd, eth, les: Performed gofmt to update formatting
* cmd, eth, les: Fixed bugs resulting formatting
* cmd/geth, eth/, les: switched to downloader event
* eth: Fixed styling and gen_config
* eth/: Fix nil error in config file
* cmd/geth: Updated countdown log
* les/fetcher.go: Removed depcreated channel
* eth/downloader.go: Removed deprecated select
* cmd/geth, cmd/utils: Fixed minor issues
* eth: Reverted config files to proper format
* eth: Fixed typo in config file
* cmd/geth, eth/down: Updated code to use header time stamp
* eth/downloader: Changed the time threshold to 10 minutes
* cmd/geth, eth/downloader: Updated downloading event to pass latest header
* cmd/geth: Updated main to use right timer object
* cmd/geth: Removed unused failed event
* cmd/geth: added in correct time field with type assertion
* cmd/geth, cmd/utils: Updated flag to use boolean
* cmd/geth, cmd/utils, eth/downloader: Cleaned up code based on recommendations
* cmd/geth: Removed unneeded import
* cmd/geth, eth/downloader: fixed event field and suggested changes
* cmd/geth, cmd/utils: Updated flag and linting issue
2019-01-30 02:40:36 -05:00
}
2023-09-27 15:01:49 +08:00
// hbss2pbss command options
ForceFlag = & cli . BoolFlag {
Name : "force" ,
2024-04-18 15:43:57 +08:00
Usage : "Force convert hbss trie node to pbss trie node. Ignore any metadata" ,
2023-09-27 15:01:49 +08:00
Value : false ,
}
2022-06-27 18:22:36 +02:00
// Dump command options.
IterativeOutputFlag = & cli . BoolFlag {
2019-06-24 16:16:44 +02:00
Name : "iterative" ,
Usage : "Print streaming JSON iteratively, delimited by newlines" ,
2022-06-27 18:22:36 +02:00
Value : true ,
2019-06-24 16:16:44 +02:00
}
2022-06-27 18:22:36 +02:00
ExcludeStorageFlag = & cli . BoolFlag {
2019-06-24 16:16:44 +02:00
Name : "nostorage" ,
Usage : "Exclude storage entries (save db lookups)" ,
}
2022-06-27 18:22:36 +02:00
IncludeIncompletesFlag = & cli . BoolFlag {
2019-06-24 16:16:44 +02:00
Name : "incompletes" ,
Usage : "Include accounts for which we don't have the address (missing preimage)" ,
}
2022-06-27 18:22:36 +02:00
ExcludeCodeFlag = & cli . BoolFlag {
2019-06-24 16:16:44 +02:00
Name : "nocode" ,
Usage : "Exclude contract code (save db lookups)" ,
}
2022-06-27 18:22:36 +02:00
StartKeyFlag = & cli . StringFlag {
cmd/geth, eth, core: snapshot dump + unify with trie dump (#22795)
* cmd/geth, eth, core: snapshot dump + unify with trie dump
* cmd/evm: dump API fixes
* cmd/geth, core, eth: fix some remaining errors
* cmd/evm: dump - add limit, support address startkey, address review concerns
* cmd, core/state, eth: minor polishes, fix snap dump crash, unify format
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2021-05-12 10:05:39 +02:00
Name : "start" ,
Usage : "Start position. Either a hash or address" ,
Value : "0x0000000000000000000000000000000000000000000000000000000000000000" ,
}
2022-06-27 18:22:36 +02:00
DumpLimitFlag = & cli . Uint64Flag {
cmd/geth, eth, core: snapshot dump + unify with trie dump (#22795)
* cmd/geth, eth, core: snapshot dump + unify with trie dump
* cmd/evm: dump API fixes
* cmd/geth, core, eth: fix some remaining errors
* cmd/evm: dump - add limit, support address startkey, address review concerns
* cmd, core/state, eth: minor polishes, fix snap dump crash, unify format
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2021-05-12 10:05:39 +02:00
Name : "limit" ,
Usage : "Max number of elements (0 = no limit)" ,
Value : 0 ,
}
2022-06-27 18:22:36 +02:00
2021-02-05 20:51:15 +08:00
defaultSyncMode = ethconfig . Defaults . SyncMode
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
SnapshotFlag = & cli . BoolFlag {
2022-06-27 18:22:36 +02:00
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 ,
}
2023-08-23 17:46:08 +08:00
TriesInMemoryFlag = & cli . Uint64Flag {
2023-09-18 20:07:03 +08:00
Name : "triesInMemory" ,
Usage : "The layer of tries trees that keep in memory" ,
Value : 128 ,
Category : flags . PerfCategory ,
2022-07-05 11:14:21 +08:00
}
defaultVerifyMode = ethconfig . Defaults . TriesVerifyMode
2023-08-23 17:46:08 +08:00
TriesVerifyModeFlag = & flags . TextMarshalerFlag {
2022-07-05 11:14:21 +08:00
Name : "tries-verify-mode" ,
2022-06-29 06:57:12 -03:00
Usage : ` tries verify mode :
" local ( default ) : a normal full node with complete state world ( both MPT and snapshot ) , merkle state root will
be verified against the block header . " ,
" full : a fast node with only snapshot state world . Merkle state root is verified by the trustworthy remote verify node
by comparing the diffhash ( an identify of difflayer generated by the block ) and state root . " ,
"insecure: same as full mode, except that it can tolerate without verifying the diffhash when verify node does not have it." ,
2022-07-05 11:14:21 +08:00
" none : no merkle state root verification at all , there is no need to setup or connect remote verify node at all ,
it is more light comparing to full and insecure mode , but get a very small chance that the state is not consistent
with other peers . " ` ,
2023-09-18 20:07:03 +08:00
Value : & defaultVerifyMode ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2023-12-28 10:42:37 +08:00
RialtoHash = & cli . StringFlag {
Name : "rialtohash" ,
Usage : "Manually specify the Rialto Genesis Hash, to trigger builtin network logic" ,
Category : flags . EthCategory ,
}
2024-07-25 10:43:32 +08:00
OverridePassedForkTime = & cli . Uint64Flag {
Name : "override.passedforktime" ,
Usage : "Manually specify the hard fork timestamp except the last one, overriding the bundled setting" ,
Category : flags . EthCategory ,
}
2024-05-30 11:51:34 +08:00
OverrideBohr = & cli . Uint64Flag {
Name : "override.bohr" ,
Usage : "Manually specify the Bohr fork timestamp, overriding the bundled setting" ,
Category : flags . EthCategory ,
}
2023-06-28 11:08:48 +02:00
OverrideVerkle = & cli . Uint64Flag {
Name : "override.verkle" ,
Usage : "Manually specify the Verkle fork timestamp, overriding the bundled setting" ,
Category : flags . EthCategory ,
2022-07-05 11:14:21 +08:00
}
2024-03-22 22:37:47 +08:00
OverrideFullImmutabilityThreshold = & cli . Uint64Flag {
Name : "override.immutabilitythreshold" ,
Usage : "It is the number of blocks after which a chain segment is considered immutable, only for testing purpose" ,
Value : params . FullImmutabilityThreshold ,
Category : flags . EthCategory ,
}
OverrideMinBlocksForBlobRequests = & cli . Uint64Flag {
Name : "override.minforblobrequest" ,
Usage : "It keeps blob data available for min blocks in local, only for testing purpose" ,
Value : params . MinBlocksForBlobRequests ,
Category : flags . EthCategory ,
}
OverrideDefaultExtraReserveForBlobRequests = & cli . Uint64Flag {
Name : "override.defaultextrareserve" ,
Usage : "It adds more extra time for expired blobs for some request cases, only for testing purpose" ,
Value : params . DefaultExtraReserveForBlobRequests ,
2024-02-26 16:17:03 +08:00
Category : flags . EthCategory ,
}
2024-05-17 16:18:29 +08:00
OverrideBreatheBlockInterval = & cli . Uint64Flag {
Name : "override.breatheblockinterval" ,
Usage : "It changes the interval between breathe blocks, only for testing purpose" ,
Value : params . BreatheBlockInterval ,
Category : flags . EthCategory ,
}
2024-07-23 13:55:45 +08:00
OverrideFixedTurnLength = & cli . Uint64Flag {
Name : "override.fixedturnlength" ,
Usage : "It use fixed or random values for turn length instead of reading from the contract, only for testing purpose" ,
Value : params . FixedTurnLength ,
Category : flags . EthCategory ,
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
SyncModeFlag = & flags . TextMarshalerFlag {
Name : "syncmode" ,
2023-12-21 16:53:48 +01:00
Usage : ` Blockchain sync mode ("snap" or "full") ` ,
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
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 ,
}
2023-11-06 14:11:17 +08:00
PathDBSyncFlag = & cli . BoolFlag {
Name : "pathdb.sync" ,
Usage : "sync flush nodes cache to disk in path schema" ,
Value : false ,
Category : flags . StateCategory ,
}
2024-04-15 10:47:54 +08:00
JournalFileFlag = & cli . BoolFlag {
Name : "journalfile" ,
Usage : "Enable using journal file to store the TrieJournal instead of KVDB in pbss (default = false)" ,
Value : false ,
Category : flags . StateCategory ,
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
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 ,
}
2017-05-26 13:40:47 +03:00
// Transaction pool settings
2022-06-27 18:22:36 +02:00
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" ,
2023-06-16 15:29:40 +03:00
Value : ethconfig . Defaults . TxPool . Journal ,
2022-06-27 18:22:36 +02:00
Category : flags . TxPoolCategory ,
}
TxPoolRejournalFlag = & cli . DurationFlag {
Name : "txpool.rejournal" ,
Usage : "Time interval to regenerate the local transaction journal" ,
2023-06-16 15:29:40 +03:00
Value : ethconfig . Defaults . TxPool . Rejournal ,
2022-06-27 18:22:36 +02:00
Category : flags . TxPoolCategory ,
}
TxPoolPriceLimitFlag = & cli . Uint64Flag {
Name : "txpool.pricelimit" ,
2023-06-16 15:29:40 +03:00
Usage : "Minimum gas price tip to enforce for acceptance into the pool" ,
2022-06-27 18:22:36 +02:00
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 ,
2023-07-27 13:45:35 +03:00
}
2023-08-23 17:46:08 +08:00
TxPoolReannounceTimeFlag = & cli . DurationFlag {
2023-12-27 14:27:35 +08:00
Name : "txpool.reannouncetime" ,
Usage : "Duration for announcing local pending transactions again (default = 10 years, minimum = 1 minute)" ,
Value : ethconfig . Defaults . TxPool . ReannounceTime ,
Category : flags . TxPoolCategory ,
2022-07-05 11:14:21 +08:00
}
2023-07-27 13:45:35 +03:00
// 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 ,
2017-05-26 13:40:47 +03:00
}
2016-10-19 14:55:13 +03:00
// Performance tuning settings
2022-06-27 18:22:36 +02:00
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" ,
2023-08-23 17:46:08 +08:00
Value : 40 ,
2022-06-27 18:22:36 +02:00
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" ,
2023-08-23 17:46:08 +08:00
Usage : "Percentage of cache memory allowance to use for snapshot caching (default = 20%)" ,
Value : 20 ,
2022-06-27 18:22:36 +02:00
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 ,
}
2023-08-23 17:46:08 +08:00
PersistDiffFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "persistdiff" ,
Usage : "Enable persistence of the diff layer" ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
DiffBlockFlag = & cli . Uint64Flag {
2023-09-18 20:07:03 +08:00
Name : "diffblock" ,
Usage : "The number of blocks should be persisted in db (default = 86400)" ,
Value : uint64 ( 86400 ) ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
PruneAncientDataFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "pruneancient" ,
Usage : "Prune ancient data, is an optional config and disabled by default. Only keep the latest 9w blocks' data,the older blocks' data will be permanently pruned. Notice:the geth/chaindata/ancient dir will be removed, if restart without the flag, the ancient data will start with the previous point that the oldest unpruned block number. Recommends to the user who don't care about the ancient data." ,
2023-12-27 14:27:35 +08:00
Category : flags . BlockHistoryCategory ,
2022-07-05 11:14:21 +08:00
}
2022-08-19 11:14:59 +02:00
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 ,
2016-03-01 23:32:43 +01:00
}
2022-06-27 18:22:36 +02:00
FDLimitFlag = & cli . IntFlag {
Name : "fdlimit" ,
Usage : "Raise the open file descriptor resource limit (default = system fd limit)" ,
Category : flags . PerfCategory ,
2015-05-09 12:00:51 +02:00
}
2023-05-10 14:54:14 +03:00
CryptoKZGFlag = & cli . StringFlag {
Name : "crypto.kzg" ,
Usage : "KZG library implementation to use; gokzg (recommended) or ckzg" ,
Value : "gokzg" ,
Category : flags . PerfCategory ,
2018-08-15 11:01:49 +03:00
}
2022-06-27 18:22:36 +02:00
2015-10-29 19:53:24 +02:00
// Miner settings
2022-06-27 18:22:36 +02:00
MiningEnabledFlag = & cli . BoolFlag {
Name : "mine" ,
Usage : "Enable mining" ,
Category : flags . MinerCategory ,
}
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 ,
}
MinerEtherbaseFlag = & cli . StringFlag {
Name : "miner.etherbase" ,
2023-01-21 00:26:01 +08:00
Usage : "0x prefixed public address for block mining rewards" ,
2022-06-27 18:22:36 +02:00
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 ,
}
2023-08-23 17:46:08 +08:00
MinerDelayLeftoverFlag = & cli . DurationFlag {
2023-09-21 12:02:59 +08:00
Name : "miner.delayleftover" ,
Usage : "Time reserved to finalize a block" ,
Value : ethconfig . Defaults . Miner . DelayLeftOver ,
Category : flags . MinerCategory ,
2021-03-19 13:23:44 +08:00
}
2022-10-03 20:10:00 +08:00
MinerNewPayloadTimeout = & cli . DurationFlag {
2023-12-27 14:27:35 +08:00
Name : "miner.newpayload-timeout" ,
Usage : "Specify the maximum time allowance for creating a new payload" ,
Value : ethconfig . Defaults . Miner . NewPayloadTimeout ,
Category : flags . MinerCategory ,
2018-08-28 21:59:05 +08:00
}
2022-06-27 18:22:36 +02:00
2015-10-29 19:53:24 +02:00
// Account settings
2022-06-27 18:22:36 +02:00
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 ,
}
// 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 ,
2020-06-17 15:46:31 +08:00
}
2022-03-09 14:45:39 +01:00
// Authenticated RPC HTTP settings
2022-06-27 18:22:36 +02:00
AuthListenFlag = & cli . StringFlag {
2023-09-18 20:07:03 +08:00
Name : "authrpc.addr" ,
Usage : "Listening address for authenticated APIs" ,
Value : node . DefaultConfig . AuthAddr ,
// Category: flags.APICategory,
2022-06-27 18:22:36 +02:00
}
AuthPortFlag = & cli . IntFlag {
2023-09-18 20:07:03 +08:00
Name : "authrpc.port" ,
Usage : "Listening port for authenticated APIs" ,
Value : node . DefaultConfig . AuthPort ,
// Category: flags.APICategory,
2022-06-27 18:22:36 +02:00
}
AuthVirtualHostsFlag = & cli . StringFlag {
2023-09-18 20:07:03 +08:00
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,
2022-06-27 18:22:36 +02:00
}
2022-09-22 21:43:47 +08:00
JWTSecretFlag = & flags . DirectoryFlag {
2023-09-18 20:07:03 +08:00
Name : "authrpc.jwtsecret" ,
Usage : "Path to a JWT secret to use for authenticated RPC endpoints" ,
// Category: flags.APICategory,
2019-04-08 13:49:52 +02:00
}
2022-06-27 18:22:36 +02:00
2016-11-25 17:55:06 +02:00
// Logging and debug settings
2022-06-27 18:22:36 +02:00
EthStatsURLFlag = & cli . StringFlag {
Name : "ethstats" ,
Usage : "Reporting URL of a ethstats service (nodename:secret@host:port)" ,
Category : flags . MetricsCategory ,
2016-11-25 17:55:06 +02:00
}
2022-06-27 18:22:36 +02:00
NoCompactionFlag = & cli . BoolFlag {
Name : "nocompaction" ,
Usage : "Disables db compaction after import" ,
Category : flags . LoggingCategory ,
2016-04-21 12:14:57 +03:00
}
2022-06-27 18:22:36 +02:00
2022-10-28 20:48:08 +08:00
// MISC settings
2023-09-29 22:11:15 +03:00
SyncTargetFlag = & cli . StringFlag {
2022-10-28 20:48:08 +08:00
Name : "synctarget" ,
2023-09-29 22:11:15 +03:00
Usage : ` Hash of the block to full sync to (dev testing feature) ` ,
2022-10-28 20:48:08 +08:00
TakesFile : true ,
Category : flags . MiscCategory ,
2017-03-08 12:26:19 +01:00
}
2022-06-27 18:22:36 +02:00
2015-03-06 03:00:41 +01:00
// RPC settings
2022-06-27 18:22:36 +02:00
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 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 ,
2021-02-23 13:09:19 +01:00
}
rpc: add limit for batch request items and response size (#26681)
This PR adds server-side limits for JSON-RPC batch requests. Before this change, batches
were limited only by processing time. The server would pick calls from the batch and
answer them until the response timeout occurred, then stop processing the remaining batch
items.
Here, we are adding two additional limits which can be configured:
- the 'item limit': batches can have at most N items
- the 'response size limit': batches can contain at most X response bytes
These limits are optional in package rpc. In Geth, we set a default limit of 1000 items
and 25MB response size.
When a batch goes over the limit, an error response is returned to the client. However,
doing this correctly isn't always possible. In JSON-RPC, only method calls with a valid
`id` can be responded to. Since batches may also contain non-call messages or
notifications, the best effort thing we can do to report an error with the batch itself is
reporting the limit violation as an error for the first method call in the batch. If a batch is
too large, but contains only notifications and responses, the error will be reported with
a null `id`.
The RPC client was also changed so it can deal with errors resulting from too large
batches. An older client connected to the server code in this PR could get stuck
until the request timeout occurred when the batch is too large. **Upgrading to a version
of the RPC client containing this change is strongly recommended to avoid timeout issues.**
For some weird reason, when writing the original client implementation, @fjl worked off of
the assumption that responses could be distributed across batches arbitrarily. So for a
batch request containing requests `[A B C]`, the server could respond with `[A B C]` but
also with `[A B] [C]` or even `[A] [B] [C]` and it wouldn't make a difference to the
client.
So in the implementation of BatchCallContext, the client waited for all requests in the
batch individually. If the server didn't respond to some of the requests in the batch, the
client would eventually just time out (if a context was used).
With the addition of batch limits into the server, we anticipate that people will hit this
kind of error way more often. To handle this properly, the client now waits for a single
response batch and expects it to contain all responses to the requests.
---------
Co-authored-by: Felix Lange <fjl@twurst.com>
Co-authored-by: Martin Holst Swende <martin@swende.se>
2023-06-13 19:38:58 +08:00
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 ,
}
2023-02-02 12:52:19 +01:00
EnablePersonal = & cli . BoolFlag {
Name : "rpc.enabledeprecatedpersonal" ,
Usage : "Enables the (deprecated) personal namespace" ,
Category : flags . APICategory ,
2021-02-23 13:09:19 +01:00
}
2016-01-26 14:39:21 +01:00
2015-03-06 03:00:41 +01:00
// Network Settings
2022-06-27 18:22:36 +02:00
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 ,
2015-03-06 03:00:41 +01:00
}
2023-05-25 08:57:02 +08:00
2023-08-23 17:46:08 +08:00
MaxPeersPerIPFlag = & cli . IntFlag {
2023-09-18 20:07:03 +08:00
Name : "maxpeersperip" ,
Usage : "Maximum number of network peers from a single IP address, (default used if set to <= 0, which is same as MaxPeers)" ,
Value : node . DefaultConfig . P2P . MaxPeersPerIP ,
Category : flags . NetworkingCategory ,
2023-05-25 08:57:02 +08:00
}
2022-06-27 18:22:36 +02:00
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" ,
2023-01-16 19:21:41 +09:00
Usage : "NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>)" ,
2022-06-27 18:22:36 +02:00
Value : "any" ,
Category : flags . NetworkingCategory ,
}
NoDiscoverFlag = & cli . BoolFlag {
Name : "nodiscover" ,
Usage : "Disables the peer discovery mechanism (manual peer addition)" ,
Category : flags . NetworkingCategory ,
}
2024-04-18 16:11:32 +08:00
PeerFilterPatternsFlag = & cli . StringSliceFlag {
Name : "peerfilter" ,
Usage : "Disallow peers connection if peer name matches the given regular expressions" ,
Category : flags . NetworkingCategory ,
}
2023-07-11 13:21:32 -06:00
DiscoveryV4Flag = & cli . BoolFlag {
Name : "discovery.v4" ,
Aliases : [ ] string { "discv4" } ,
Usage : "Enables the V4 discovery mechanism" ,
Category : flags . NetworkingCategory ,
Value : true ,
}
2022-06-27 18:22:36 +02:00
DiscoveryV5Flag = & cli . BoolFlag {
2023-07-11 13:21:32 -06:00
Name : "discovery.v5" ,
Aliases : [ ] string { "discv5" } ,
2022-06-27 18:22:36 +02:00
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 ,
}
2022-06-28 11:25:47 -04:00
DiscoveryPortFlag = & cli . IntFlag {
Name : "discovery.port" ,
Usage : "Use a custom UDP port for P2P discovery" ,
Value : 30303 ,
Category : flags . NetworkingCategory ,
}
2022-06-27 18:22:36 +02:00
// Console
JSpathFlag = & flags . DirectoryFlag {
Name : "jspath" ,
Usage : "JavaScript root path for `loadScript`" ,
Value : flags . DirectoryString ( "." ) ,
Category : flags . APICategory ,
2015-03-15 13:31:40 +07:00
}
2022-10-06 19:59:23 +02:00
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 ,
2015-03-15 13:31:40 +07:00
}
2015-10-29 19:53:24 +02:00
// Gas price oracle settings
2022-06-27 18:22:36 +02:00
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 ,
2021-05-11 02:25:51 -07:00
}
2018-07-02 14:51:02 +02:00
// Metrics flags
2022-06-27 18:22:36 +02:00
MetricsEnabledFlag = & cli . BoolFlag {
Name : "metrics" ,
Usage : "Enable metrics collection and reporting" ,
Category : flags . MetricsCategory ,
2018-07-02 14:51:02 +02:00
}
2022-06-27 18:22:36 +02:00
MetricsEnabledExpensiveFlag = & cli . BoolFlag {
Name : "metrics.expensive" ,
Usage : "Enable expensive metrics collection and reporting" ,
Category : flags . MetricsCategory ,
2019-03-25 10:01:18 +02:00
}
2020-07-03 12:12:22 -05:00
// 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.
2022-06-27 18:22:36 +02:00
MetricsHTTPFlag = & cli . StringFlag {
2022-11-24 13:03:38 +01:00
Name : "metrics.addr" ,
Usage : ` Enable stand-alone metrics HTTP server listening interface. ` ,
2022-06-27 18:22:36 +02:00
Category : flags . MetricsCategory ,
}
MetricsPortFlag = & cli . IntFlag {
2022-11-24 11:37:58 +01:00
Name : "metrics.port" ,
Usage : ` Metrics HTTP server listening port .
Please note that -- ` + MetricsHTTPFlag.Name + ` must be set to start the server . ` ,
2022-06-27 18:22:36 +02:00
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 ,
2018-07-02 14:51:02 +02:00
}
2019-01-29 09:14:24 +01:00
// 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.
2018-07-02 14:51:02 +02:00
// https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
2022-06-27 18:22:36 +02:00
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 ,
2018-07-02 14:51:02 +02:00
}
2021-04-16 21:29:22 +02:00
2022-06-27 18:22:36 +02:00
MetricsEnableInfluxDBV2Flag = & cli . BoolFlag {
Name : "metrics.influxdbv2" ,
Usage : "Enable metrics export/push to an external InfluxDB v2 database" ,
Category : flags . MetricsCategory ,
2018-09-20 09:44:35 +02:00
}
2021-08-17 18:40:14 +02:00
2022-06-27 18:22:36 +02:00
MetricsInfluxDBTokenFlag = & cli . StringFlag {
Name : "metrics.influxdb.token" ,
Usage : "Token to authorize access to the database (v2 only)" ,
Value : metrics . DefaultConfig . InfluxDBToken ,
Category : flags . MetricsCategory ,
2021-08-17 18:40:14 +02:00
}
2022-06-27 18:22:36 +02:00
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 ,
2018-09-20 09:44:35 +02:00
}
2020-05-20 11:46:45 +08:00
// Init network
2023-08-23 17:46:08 +08:00
InitNetworkSize = & cli . IntFlag {
2020-05-20 11:46:45 +08:00
Name : "init.size" ,
Usage : "the size of the network" ,
Value : 1 ,
}
2023-08-23 17:46:08 +08:00
InitNetworkDir = & cli . StringFlag {
2020-05-20 11:46:45 +08:00
Name : "init.dir" ,
Usage : "the direction to store initial network data" ,
Value : "" ,
}
2023-08-23 17:46:08 +08:00
InitNetworkIps = & cli . StringFlag {
2020-05-20 11:46:45 +08:00
Name : "init.ips" ,
Usage : "the ips of each node in the network, example '192.168.0.1,192.168.0.2'" ,
Value : "" ,
}
2023-08-23 17:46:08 +08:00
InitNetworkPort = & cli . IntFlag {
2020-05-20 11:46:45 +08:00
Name : "init.p2p-port" ,
Usage : "the p2p port of the nodes in the network" ,
Value : 30311 ,
}
2022-06-27 18:22:36 +02:00
MetricsInfluxDBOrganizationFlag = & cli . StringFlag {
Name : "metrics.influxdb.organization" ,
Usage : "InfluxDB organization name (v2 only)" ,
Value : metrics . DefaultConfig . InfluxDBOrganization ,
Category : flags . MetricsCategory ,
2021-04-16 21:29:22 +02:00
}
2022-07-05 11:14:21 +08:00
2023-08-23 17:46:08 +08:00
BlockAmountReserved = & cli . Uint64Flag {
2023-09-18 20:07:03 +08:00
Name : "block-amount-reserved" ,
Usage : "Sets the expected remained amount of blocks for offline block prune" ,
2023-12-27 14:27:35 +08:00
Category : flags . BlockHistoryCategory ,
2024-05-29 15:11:52 +08:00
Value : params . FullImmutabilityThreshold ,
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
CheckSnapshotWithMPT = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "check-snapshot-with-mpt" ,
Usage : "Enable checking between snapshot and MPT " ,
Category : flags . FastNodeCategory ,
2022-07-05 11:14:21 +08:00
}
2023-02-03 15:53:36 +08:00
2023-08-23 17:46:08 +08:00
EnableDoubleSignMonitorFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "monitor.doublesign" ,
Usage : "Enable double sign monitor to check whether any validator signs multiple blocks" ,
2023-12-27 14:27:35 +08:00
Category : flags . MinerCategory ,
2023-02-03 15:53:36 +08:00
}
2023-04-10 18:36:45 +08:00
2023-08-23 17:46:08 +08:00
VotingEnabledFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "vote" ,
Usage : "Enable voting when mining" ,
Category : flags . FastFinalityCategory ,
2023-04-17 22:23:08 +08:00
}
2023-08-23 19:37:39 +08:00
DisableVoteAttestationFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "disablevoteattestation" ,
Usage : "Disable assembling vote attestation " ,
Category : flags . FastFinalityCategory ,
2023-08-14 17:48:36 +08:00
}
2023-08-23 17:46:08 +08:00
EnableMaliciousVoteMonitorFlag = & cli . BoolFlag {
2023-09-18 20:07:03 +08:00
Name : "monitor.maliciousvote" ,
Usage : "Enable malicious vote monitor to check whether any validator violates the voting rules of fast finality" ,
Category : flags . FastFinalityCategory ,
2023-05-11 14:45:15 +08:00
}
2023-08-23 17:46:08 +08:00
BLSPasswordFileFlag = & cli . StringFlag {
2023-09-18 20:07:03 +08:00
Name : "blspassword" ,
2023-12-05 16:37:19 +08:00
Usage : "Password file path for the BLS wallet, which contains the password to unlock BLS wallet for managing votes in fast_finality feature" ,
Category : flags . AccountCategory ,
2023-04-10 18:36:45 +08:00
}
2023-08-23 17:46:08 +08:00
BLSWalletDirFlag = & flags . DirectoryFlag {
2023-09-18 20:07:03 +08:00
Name : "blswallet" ,
Usage : "Path for the blsWallet dir in fast finality feature (default = inside the datadir)" ,
2023-12-05 16:37:19 +08:00
Category : flags . AccountCategory ,
2023-04-10 18:36:45 +08:00
}
2023-08-23 17:46:08 +08:00
VoteJournalDirFlag = & flags . DirectoryFlag {
2023-09-18 20:07:03 +08:00
Name : "vote-journal-path" ,
Usage : "Path for the voteJournal dir in fast finality feature (default = inside the datadir)" ,
Category : flags . FastFinalityCategory ,
2023-04-10 18:36:45 +08:00
}
2024-03-22 22:37:47 +08:00
// Blob setting
BlobExtraReserveFlag = & cli . Uint64Flag {
Name : "blob.extra-reserve" ,
Usage : "Extra reserve threshold for blob, blob never expires when 0 is set, default 28800" ,
Value : params . DefaultExtraReserveForBlobRequests ,
Category : flags . MiscCategory ,
}
2015-03-06 03:00:41 +01:00
)
2022-05-03 14:46:17 +08:00
var (
// TestnetFlags is the flag group of all built-in supported testnets.
2023-12-25 10:58:52 +08:00
TestnetFlags = [ ] cli . Flag {
ChapelFlag ,
}
2022-05-03 14:46:17 +08:00
// NetworkFlags is the flag group of all built-in supported networks.
2023-11-29 15:04:50 +08:00
NetworkFlags = append ( [ ] cli . Flag { BSCMainnetFlag } , TestnetFlags ... )
2022-05-03 14:46:17 +08:00
2023-09-22 14:56:48 +03:00
// DatabaseFlags is the flag group of all database flags.
DatabaseFlags = [ ] cli . Flag {
2022-05-03 14:46:17 +08:00
DataDirFlag ,
AncientFlag ,
2022-05-18 16:27:17 +02:00
RemoteDBFlag ,
2023-10-13 22:50:20 +03:00
DBEngineFlag ,
2023-09-22 14:56:48 +03:00
StateSchemeFlag ,
2022-09-30 13:50:25 +02:00
HttpHeaderFlag ,
2022-05-03 14:46:17 +08:00
}
)
2016-08-18 13:28:17 +02:00
// MakeDataDir retrieves the currently requested data directory, terminating
2015-11-17 18:33:25 +02:00
// if none (or the empty string) is specified. If the node is starting a testnet,
2020-04-09 11:09:58 +02:00
// then a subdirectory of the specified datadir will be used.
2016-08-18 13:28:17 +02:00
func MakeDataDir ( ctx * cli . Context ) string {
2022-06-27 18:22:36 +02:00
if path := ctx . String ( DataDirFlag . Name ) ; path != "" {
2015-11-17 18:33:25 +02:00
return path
2015-03-06 03:00:41 +01:00
}
2017-02-22 17:22:50 +02:00
Fatalf ( "Cannot determine default data directory, please set manually (--datadir)" )
2015-11-17 18:33:25 +02:00
return ""
2015-03-06 03:00:41 +01:00
}
2017-04-12 16:27:23 +02:00
// setNodeKey creates a node key from set command line flags, either loading it
2015-11-17 18:33:25 +02:00
// from a file or as a specified hex value. If neither flags were provided, this
2023-09-20 03:20:18 +08:00
// method returns nil and an ephemeral key is to be generated.
2017-04-12 16:27:23 +02:00
func setNodeKey ( ctx * cli . Context , cfg * p2p . Config ) {
2015-11-17 18:33:25 +02:00
var (
2022-06-27 18:22:36 +02:00
hex = ctx . String ( NodeKeyHexFlag . Name )
file = ctx . String ( NodeKeyFileFlag . Name )
2017-04-12 16:27:23 +02:00
key * ecdsa . PrivateKey
err error
2015-11-17 18:33:25 +02:00
)
2015-03-06 03:00:41 +01:00
switch {
case file != "" && hex != "" :
2017-02-22 17:22:50 +02:00
Fatalf ( "Options %q and %q are mutually exclusive" , NodeKeyFileFlag . Name , NodeKeyHexFlag . Name )
2015-03-06 03:00:41 +01:00
case file != "" :
if key , err = crypto . LoadECDSA ( file ) ; err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Option %q: %v" , NodeKeyFileFlag . Name , err )
2015-03-06 03:00:41 +01:00
}
2017-04-12 16:27:23 +02:00
cfg . PrivateKey = key
2015-03-06 03:00:41 +01:00
case hex != "" :
if key , err = crypto . HexToECDSA ( hex ) ; err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Option %q: %v" , NodeKeyHexFlag . Name , err )
2015-03-06 03:00:41 +01:00
}
2017-04-12 16:27:23 +02:00
cfg . PrivateKey = key
2015-03-06 03:00:41 +01:00
}
}
2017-04-12 16:27:23 +02:00
// setNodeUserIdent creates the user identifier from CLI flags.
func setNodeUserIdent ( ctx * cli . Context , cfg * node . Config ) {
2022-06-27 18:22:36 +02:00
if identity := ctx . String ( IdentityFlag . Name ) ; len ( identity ) > 0 {
2017-04-12 16:27:23 +02:00
cfg . UserIdent = identity
2015-11-17 18:33:25 +02:00
}
}
2017-04-12 16:27:23 +02:00
// setBootstrapNodes creates a list of bootstrap nodes from the command line
2015-11-17 18:33:25 +02:00
// flags, reverting to pre-configured ones if none have been specified.
2023-09-26 01:17:39 +08:00
// Priority order for bootnodes configuration:
//
// 1. --bootnodes flag
// 2. Config file
// 3. Network preset flags (e.g. --goerli)
// 4. default to mainnet nodes
2017-04-12 16:27:23 +02:00
func setBootstrapNodes ( ctx * cli . Context , cfg * p2p . Config ) {
2017-01-05 13:56:06 +01:00
urls := params . MainnetBootnodes
2023-09-26 01:17:39 +08:00
if ctx . IsSet ( BootnodesFlag . Name ) {
2022-06-27 18:22:36 +02:00
urls = SplitAndTrim ( ctx . String ( BootnodesFlag . Name ) )
2023-09-26 01:17:39 +08:00
} else {
if cfg . BootstrapNodes != nil {
return // Already set by config file, don't apply defaults.
}
2022-06-29 06:57:12 -03:00
}
2023-09-26 01:17:39 +08:00
cfg . BootstrapNodes = mustParseBootnodes ( urls )
}
2022-06-29 06:57:12 -03:00
2023-09-26 01:17:39 +08:00
func mustParseBootnodes ( urls [ ] string ) [ ] * enode . Node {
nodes := make ( [ ] * enode . Node , 0 , len ( urls ) )
2017-01-05 13:56:06 +01:00
for _ , url := range urls {
2019-01-24 13:02:30 +01:00
if url != "" {
2019-06-07 15:31:00 +02:00
node , err := enode . Parse ( enode . ValidSchemes , url )
2019-01-24 13:02:30 +01:00
if err != nil {
log . Crit ( "Bootstrap URL invalid" , "enode" , url , "err" , err )
2023-09-26 01:17:39 +08:00
return nil
2019-01-24 13:02:30 +01:00
}
2023-09-26 01:17:39 +08:00
nodes = append ( nodes , node )
2015-11-17 18:33:25 +02:00
}
}
2023-09-26 01:17:39 +08:00
return nodes
2015-11-17 18:33:25 +02:00
}
2017-04-12 16:27:23 +02:00
// setBootstrapNodesV5 creates a list of bootstrap nodes from the command line
2016-11-09 16:35:04 +02:00
// flags, reverting to pre-configured ones if none have been specified.
2017-04-12 16:27:23 +02:00
func setBootstrapNodesV5 ( ctx * cli . Context , cfg * p2p . Config ) {
2021-01-26 21:41:35 +01:00
urls := params . V5Bootnodes
2017-05-04 12:36:20 +03:00
switch {
2022-06-27 18:22:36 +02:00
case ctx . IsSet ( BootnodesFlag . Name ) :
urls = SplitAndTrim ( ctx . String ( BootnodesFlag . Name ) )
2017-05-04 12:36:20 +03:00
case cfg . BootstrapNodesV5 != nil :
2017-04-12 16:27:23 +02:00
return // already set, don't apply defaults.
2016-11-09 16:35:04 +02:00
}
2021-01-26 21:41:35 +01:00
cfg . BootstrapNodesV5 = make ( [ ] * enode . Node , 0 , len ( urls ) )
2017-01-05 13:56:06 +01:00
for _ , url := range urls {
2019-03-15 12:20:21 +07:00
if url != "" {
2021-01-26 21:41:35 +01:00
node , err := enode . Parse ( enode . ValidSchemes , url )
2019-03-15 12:20:21 +07:00
if err != nil {
log . Error ( "Bootstrap URL invalid" , "enode" , url , "err" , err )
continue
}
cfg . BootstrapNodesV5 = append ( cfg . BootstrapNodesV5 , node )
2016-11-09 16:35:04 +02:00
}
}
}
2022-06-28 11:25:47 -04:00
// setListenAddress creates TCP/UDP listening address strings from set command
// line flags
2017-04-12 16:27:23 +02:00
func setListenAddress ( ctx * cli . Context , cfg * p2p . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( ListenPortFlag . Name ) {
cfg . ListenAddr = fmt . Sprintf ( ":%d" , ctx . Int ( ListenPortFlag . Name ) )
2017-04-12 16:27:23 +02:00
}
2022-06-28 11:25:47 -04:00
if ctx . IsSet ( DiscoveryPortFlag . Name ) {
cfg . DiscAddr = fmt . Sprintf ( ":%d" , ctx . Int ( DiscoveryPortFlag . Name ) )
2017-04-12 16:27:23 +02:00
}
2015-11-17 18:33:25 +02:00
}
2017-04-12 16:27:23 +02:00
// setNAT creates a port mapper from command line flags.
func setNAT ( ctx * cli . Context , cfg * p2p . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( NATFlag . Name ) {
natif , err := nat . Parse ( ctx . String ( NATFlag . Name ) )
2017-04-12 16:27:23 +02:00
if err != nil {
Fatalf ( "Option %s: %v" , NATFlag . Name , err )
}
cfg . NAT = natif
2015-11-17 18:33:25 +02:00
}
}
2020-09-23 05:22:54 +08:00
// SplitAndTrim splits input separated by a comma
2017-04-12 23:04:14 +02:00
// and trims excessive white space from the substrings.
2020-09-23 05:22:54 +08:00
func SplitAndTrim ( input string ) ( ret [ ] string ) {
2020-07-07 04:09:30 +08:00
l := strings . Split ( input , "," )
for _ , r := range l {
2020-09-23 05:22:54 +08:00
if r = strings . TrimSpace ( r ) ; r != "" {
2020-07-07 04:09:30 +08:00
ret = append ( ret , r )
}
2016-04-14 16:18:35 +02:00
}
2020-07-07 04:09:30 +08:00
return ret
2016-04-14 16:18:35 +02:00
}
2017-04-12 16:27:23 +02:00
// setHTTP creates the HTTP RPC listener interface string from the set
2016-02-05 13:45:36 +02:00
// command line flags, returning empty if the HTTP endpoint is disabled.
2017-04-12 16:27:23 +02:00
func setHTTP ( ctx * cli . Context , cfg * node . Config ) {
2023-12-14 11:04:04 +08:00
if ctx . Bool ( HTTPEnabledFlag . Name ) {
if cfg . HTTPHost == "" {
cfg . HTTPHost = "127.0.0.1"
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPListenAddrFlag . Name ) {
cfg . HTTPHost = ctx . String ( HTTPListenAddrFlag . Name )
2017-04-12 16:27:23 +02:00
}
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPPortFlag . Name ) {
cfg . HTTPPort = ctx . Int ( HTTPPortFlag . Name )
2016-02-05 13:45:36 +02:00
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( AuthListenFlag . Name ) {
cfg . AuthAddr = ctx . String ( AuthListenFlag . Name )
2017-04-12 16:27:23 +02:00
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( AuthPortFlag . Name ) {
cfg . AuthPort = ctx . Int ( AuthPortFlag . Name )
2020-05-05 10:19:17 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( AuthVirtualHostsFlag . Name ) {
cfg . AuthVirtualHosts = SplitAndTrim ( ctx . String ( AuthVirtualHostsFlag . Name ) )
2020-05-05 10:19:17 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPCORSDomainFlag . Name ) {
cfg . HTTPCors = SplitAndTrim ( ctx . String ( HTTPCORSDomainFlag . Name ) )
2018-03-05 12:02:32 +01:00
}
2021-02-02 10:05:46 +01:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPApiFlag . Name ) {
cfg . HTTPModules = SplitAndTrim ( ctx . String ( HTTPApiFlag . Name ) )
2021-02-02 10:05:46 +01:00
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPVirtualHostsFlag . Name ) {
cfg . HTTPVirtualHosts = SplitAndTrim ( ctx . String ( HTTPVirtualHostsFlag . Name ) )
2018-03-05 12:02:32 +01:00
}
2021-02-02 10:05:46 +01:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( HTTPPathPrefixFlag . Name ) {
cfg . HTTPPathPrefix = ctx . String ( HTTPPathPrefixFlag . Name )
2021-02-02 10:05:46 +01:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( AllowUnprotectedTxs . Name ) {
cfg . AllowUnprotectedTxs = ctx . Bool ( AllowUnprotectedTxs . Name )
2021-02-23 13:09:19 +01:00
}
rpc: add limit for batch request items and response size (#26681)
This PR adds server-side limits for JSON-RPC batch requests. Before this change, batches
were limited only by processing time. The server would pick calls from the batch and
answer them until the response timeout occurred, then stop processing the remaining batch
items.
Here, we are adding two additional limits which can be configured:
- the 'item limit': batches can have at most N items
- the 'response size limit': batches can contain at most X response bytes
These limits are optional in package rpc. In Geth, we set a default limit of 1000 items
and 25MB response size.
When a batch goes over the limit, an error response is returned to the client. However,
doing this correctly isn't always possible. In JSON-RPC, only method calls with a valid
`id` can be responded to. Since batches may also contain non-call messages or
notifications, the best effort thing we can do to report an error with the batch itself is
reporting the limit violation as an error for the first method call in the batch. If a batch is
too large, but contains only notifications and responses, the error will be reported with
a null `id`.
The RPC client was also changed so it can deal with errors resulting from too large
batches. An older client connected to the server code in this PR could get stuck
until the request timeout occurred when the batch is too large. **Upgrading to a version
of the RPC client containing this change is strongly recommended to avoid timeout issues.**
For some weird reason, when writing the original client implementation, @fjl worked off of
the assumption that responses could be distributed across batches arbitrarily. So for a
batch request containing requests `[A B C]`, the server could respond with `[A B C]` but
also with `[A B] [C]` or even `[A] [B] [C]` and it wouldn't make a difference to the
client.
So in the implementation of BatchCallContext, the client waited for all requests in the
batch individually. If the server didn't respond to some of the requests in the batch, the
client would eventually just time out (if a context was used).
With the addition of batch limits into the server, we anticipate that people will hit this
kind of error way more often. To handle this properly, the client now waits for a single
response batch and expects it to contain all responses to the requests.
---------
Co-authored-by: Felix Lange <fjl@twurst.com>
Co-authored-by: Martin Holst Swende <martin@swende.se>
2023-06-13 19:38:58 +08:00
if ctx . IsSet ( BatchRequestLimit . Name ) {
cfg . BatchRequestLimit = ctx . Int ( BatchRequestLimit . Name )
}
if ctx . IsSet ( BatchResponseMaxSize . Name ) {
cfg . BatchResponseMaxSize = ctx . Int ( BatchResponseMaxSize . Name )
2018-03-05 12:02:32 +01:00
}
2016-02-05 13:45:36 +02:00
}
2019-01-21 06:38:13 -08:00
// 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 ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GraphQLCORSDomainFlag . Name ) {
cfg . GraphQLCors = SplitAndTrim ( ctx . String ( GraphQLCORSDomainFlag . Name ) )
2019-01-21 06:38:13 -08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GraphQLVirtualHostsFlag . Name ) {
cfg . GraphQLVirtualHosts = SplitAndTrim ( ctx . String ( GraphQLVirtualHostsFlag . Name ) )
2019-01-21 06:38:13 -08:00
}
}
2017-04-12 16:27:23 +02:00
// setWS creates the WebSocket RPC listener interface string from the set
2016-02-05 15:08:48 +02:00
// command line flags, returning empty if the HTTP endpoint is disabled.
2017-04-12 16:27:23 +02:00
func setWS ( ctx * cli . Context , cfg * node . Config ) {
2023-12-14 11:04:04 +08:00
if ctx . Bool ( WSEnabledFlag . Name ) {
if cfg . WSHost == "" {
cfg . WSHost = "127.0.0.1"
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( WSListenAddrFlag . Name ) {
cfg . WSHost = ctx . String ( WSListenAddrFlag . Name )
2017-04-12 16:27:23 +02:00
}
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( WSPortFlag . Name ) {
cfg . WSPort = ctx . Int ( WSPortFlag . Name )
2017-04-12 16:27:23 +02:00
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( WSAllowedOriginsFlag . Name ) {
cfg . WSOrigins = SplitAndTrim ( ctx . String ( WSAllowedOriginsFlag . Name ) )
2017-04-12 16:27:23 +02:00
}
2020-05-05 10:19:17 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( WSApiFlag . Name ) {
cfg . WSModules = SplitAndTrim ( ctx . String ( WSApiFlag . Name ) )
2017-04-12 16:27:23 +02:00
}
2021-02-02 10:05:46 +01:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( WSPathPrefixFlag . Name ) {
cfg . WSPathPrefix = ctx . String ( WSPathPrefixFlag . Name )
2017-04-12 16:27:23 +02:00
}
}
// 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 ) {
2019-07-08 20:59:07 +08:00
CheckExclusive ( ctx , IPCDisabledFlag , IPCPathFlag )
2017-04-12 16:27:23 +02:00
switch {
2022-06-27 18:22:36 +02:00
case ctx . Bool ( IPCDisabledFlag . Name ) :
2017-04-12 16:27:23 +02:00
cfg . IPCPath = ""
2022-06-27 18:22:36 +02:00
case ctx . IsSet ( IPCPathFlag . Name ) :
cfg . IPCPath = ctx . String ( IPCPathFlag . Name )
2016-02-05 15:08:48 +02:00
}
}
2023-12-21 16:53:48 +01:00
// setLes shows the deprecation warnings for LES flags.
2021-02-05 20:51:15 +08:00
func setLes ( ctx * cli . Context , cfg * ethconfig . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightServeFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightServeFlag . Name )
2019-07-10 10:08:59 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightIngressFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightIngressFlag . Name )
2019-07-10 10:08:59 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightEgressFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightEgressFlag . Name )
2019-07-10 10:08:59 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightMaxPeersFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightMaxPeersFlag . Name )
2019-01-24 14:18:26 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightNoPruneFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightNoPruneFlag . Name )
2019-01-24 14:18:26 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightNoSyncServeFlag . Name ) {
2023-12-21 16:53:48 +01:00
log . Warn ( "The light server has been deprecated, please remove this flag" , "flag" , LightNoSyncServeFlag . Name )
2021-02-25 20:55:07 +08:00
}
2019-01-24 14:18:26 +03:00
}
2023-05-11 14:45:15 +08:00
// setMonitors enable monitors from the command line flags.
func setMonitors ( ctx * cli . Context , cfg * node . Config ) {
2023-08-23 17:46:08 +08:00
if ctx . Bool ( EnableDoubleSignMonitorFlag . Name ) {
2023-02-03 15:53:36 +08:00
cfg . EnableDoubleSignMonitor = true
}
2023-08-23 17:46:08 +08:00
if ctx . Bool ( EnableMaliciousVoteMonitorFlag . Name ) {
2023-05-11 14:45:15 +08:00
cfg . EnableMaliciousVoteMonitor = true
}
2023-02-03 15:53:36 +08:00
}
2021-02-23 11:27:32 +01:00
// MakeDatabaseHandles raises out the number of allowed file handles per process
2016-02-19 14:29:19 +02:00
// for Geth and returns half of the allowance to assign to the database.
2022-03-07 09:21:06 +01:00
func MakeDatabaseHandles ( max int ) int {
2018-11-29 12:47:29 +02:00
limit , err := fdlimit . Maximum ( )
2016-02-19 14:29:19 +02:00
if err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Failed to retrieve file descriptor allowance: %v" , err )
2016-02-19 14:29:19 +02:00
}
2022-03-07 09:21:06 +01:00
switch {
case max == 0 :
// User didn't specify a meaningful value, use system limits
case max < 128 :
// User specified something unhealthy, just use system defaults
log . Error ( "File descriptor limit invalid (<128)" , "had" , max , "updated" , limit )
case max > limit :
// User requested more than the OS allows, notify that we can't allocate it
log . Warn ( "Requested file descriptors denied by OS" , "req" , max , "limit" , limit )
default :
// User limit is meaningful and within allowed range, use that
limit = max
}
2019-02-12 11:29:05 +01:00
raised , err := fdlimit . Raise ( uint64 ( limit ) )
if err != nil {
2018-11-29 12:47:29 +02:00
Fatalf ( "Failed to raise file descriptor allowance: %v" , err )
2016-02-19 14:29:19 +02:00
}
2019-02-12 11:29:05 +01:00
return int ( raised / 2 ) // Leave half for networking and other stuff
2016-02-19 14:29:19 +02:00
}
2015-11-17 18:33:25 +02:00
// MakeAddress converts an account specified directly as a hex encoded string or
// a key index in the key store to an internal account representation.
2017-01-24 11:49:20 +02:00
func MakeAddress ( ks * keystore . KeyStore , account string ) ( accounts . Account , error ) {
2015-11-17 18:33:25 +02:00
// If the specified account is a valid address, return it
if common . IsHexAddress ( account ) {
2016-03-03 01:09:16 +01:00
return accounts . Account { Address : common . HexToAddress ( account ) } , nil
2015-11-17 18:33:25 +02:00
}
// Otherwise try to interpret the account as a keystore index
index , err := strconv . Atoi ( account )
2017-01-24 11:49:20 +02:00
if err != nil || index < 0 {
2016-03-03 01:09:16 +01:00
return accounts . Account { } , fmt . Errorf ( "invalid account address or index %q" , account )
2015-11-17 18:33:25 +02:00
}
2017-12-10 00:42:23 +02:00
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 ( "-------------------------------------------------------------------" )
2017-01-24 11:49:20 +02:00
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
2015-11-17 18:33:25 +02:00
}
2023-01-21 00:26:01 +08:00
// setEtherbase retrieves the etherbase from the directly specified command line flags.
func setEtherbase ( ctx * cli . Context , cfg * ethconfig . Config ) {
2023-01-24 11:11:33 +01:00
if ! ctx . IsSet ( MinerEtherbaseFlag . Name ) {
return
}
addr := ctx . String ( MinerEtherbaseFlag . Name )
if strings . HasPrefix ( addr , "0x" ) || strings . HasPrefix ( addr , "0X" ) {
addr = addr [ 2 : ]
2015-07-07 12:53:36 +02:00
}
2023-01-24 11:11:33 +01:00
b , err := hex . DecodeString ( addr )
if err != nil || len ( b ) != common . AddressLength {
Fatalf ( "-%s: invalid etherbase address %q" , MinerEtherbaseFlag . Name , addr )
return
2015-07-07 12:53:36 +02:00
}
2023-01-24 11:11:33 +01:00
cfg . Miner . Etherbase = common . BytesToAddress ( b )
2015-11-17 18:33:25 +02:00
}
2017-04-28 12:38:49 +02:00
// MakePasswordList reads password lines from the file specified by the global --password flag.
2015-11-17 18:33:25 +02:00
func MakePasswordList ( ctx * cli . Context ) [ ] string {
2023-12-05 16:37:19 +08:00
return MakePasswordListFromPath ( ctx . Path ( PasswordFileFlag . Name ) )
}
func MakePasswordListFromPath ( path string ) [ ] string {
2016-03-30 23:20:06 +02:00
if path == "" {
return nil
}
2022-05-16 11:59:35 +02:00
text , err := os . ReadFile ( path )
2016-03-30 23:20:06 +02:00
if err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Failed to read password file: %v" , err )
2016-03-30 23:20:06 +02:00
}
lines := strings . Split ( string ( text ) , "\n" )
// Sanitise DOS line endings.
for i := range lines {
lines [ i ] = strings . TrimRight ( lines [ i ] , "\r" )
2015-11-17 18:33:25 +02:00
}
2016-03-30 23:20:06 +02:00
return lines
2015-11-17 18:33:25 +02:00
}
2017-04-12 16:27:23 +02:00
func SetP2PConfig ( ctx * cli . Context , cfg * p2p . Config ) {
setNodeKey ( ctx , cfg )
setNAT ( ctx , cfg )
setListenAddress ( ctx , cfg )
setBootstrapNodes ( ctx , cfg )
setBootstrapNodesV5 ( ctx , cfg )
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MaxPeersFlag . Name ) {
cfg . MaxPeers = ctx . Int ( MaxPeersFlag . Name )
2017-04-12 16:27:23 +02:00
}
2023-05-25 08:57:02 +08:00
// if max peers per ip is not set, use max peers
if cfg . MaxPeersPerIP <= 0 {
cfg . MaxPeersPerIP = cfg . MaxPeers
}
// flag like: `--maxpeersperip 10` could override the setting in config.toml
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( MaxPeersPerIPFlag . Name ) {
cfg . MaxPeersPerIP = ctx . Int ( MaxPeersPerIPFlag . Name )
2023-05-25 08:57:02 +08:00
}
2023-12-21 16:53:48 +01:00
ethPeers := cfg . MaxPeers
log . Info ( "Maximum peer count" , "ETH" , ethPeers , "total" , cfg . MaxPeers )
2018-02-05 14:41:53 +01:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MaxPendingPeersFlag . Name ) {
cfg . MaxPendingPeers = ctx . Int ( MaxPendingPeersFlag . Name )
2017-04-12 16:27:23 +02:00
}
2023-12-21 16:53:48 +01:00
if ctx . IsSet ( NoDiscoverFlag . Name ) {
2017-04-12 16:27:23 +02:00
cfg . NoDiscovery = true
2016-09-05 13:08:41 +02:00
}
2024-04-18 16:11:32 +08:00
if ctx . IsSet ( PeerFilterPatternsFlag . Name ) {
cfg . PeerFilterPatterns = ctx . StringSlice ( PeerFilterPatternsFlag . Name )
}
2016-09-05 13:08:41 +02:00
2023-07-11 13:21:32 -06:00
CheckExclusive ( ctx , DiscoveryV4Flag , NoDiscoverFlag )
CheckExclusive ( ctx , DiscoveryV5Flag , NoDiscoverFlag )
cfg . DiscoveryV4 = ctx . Bool ( DiscoveryV4Flag . Name )
cfg . DiscoveryV5 = ctx . Bool ( DiscoveryV5Flag . Name )
2022-06-27 18:22:36 +02:00
if netrestrict := ctx . String ( NetrestrictFlag . Name ) ; netrestrict != "" {
2016-11-22 20:52:31 +01:00
list , err := netutil . ParseNetlist ( netrestrict )
if err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Option %q: %v" , NetrestrictFlag . Name , err )
2016-11-22 20:52:31 +01:00
}
2017-04-12 16:27:23 +02:00
cfg . NetRestrict = list
2016-11-22 20:52:31 +01:00
}
2022-06-27 18:22:36 +02:00
if ctx . Bool ( DeveloperFlag . Name ) {
2017-04-12 16:27:23 +02:00
// --dev mode can't use p2p networking.
cfg . MaxPeers = 0
2021-04-16 21:29:22 +02:00
cfg . ListenAddr = ""
cfg . NoDial = true
2017-04-12 16:27:23 +02:00
cfg . NoDiscovery = true
cfg . DiscoveryV5 = false
2016-08-15 18:38:32 +02:00
}
}
2017-04-12 16:27:23 +02:00
// SetNodeConfig applies node-related command line flags to the config.
func SetNodeConfig ( ctx * cli . Context , cfg * node . Config ) {
2024-03-21 13:06:48 +08:00
setInstance ( ctx , cfg )
2017-04-12 16:27:23 +02:00
SetP2PConfig ( ctx , & cfg . P2P )
setIPC ( ctx , cfg )
setHTTP ( ctx , cfg )
2019-01-21 06:38:13 -08:00
setGraphQL ( ctx , cfg )
2017-04-12 16:27:23 +02:00
setWS ( ctx , cfg )
setNodeUserIdent ( ctx , cfg )
2022-06-21 11:16:05 +02:00
SetDataDir ( ctx , cfg )
2019-05-31 11:30:28 +02:00
setSmartCard ( ctx , cfg )
2023-05-11 14:45:15 +08:00
setMonitors ( ctx , cfg )
2023-04-10 18:36:45 +08:00
setBLSWalletDir ( ctx , cfg )
setVoteJournalDir ( ctx , cfg )
2017-04-12 16:27:23 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( JWTSecretFlag . Name ) {
cfg . JWTSecret = ctx . String ( JWTSecretFlag . Name )
2022-03-07 08:30:27 +01:00
}
2023-02-02 12:52:19 +01:00
if ctx . IsSet ( EnablePersonal . Name ) {
cfg . EnablePersonal = true
accounts, eth, clique, signer: support for external signer API (#18079)
* accounts, eth, clique: implement external backend + move sighash calc to backend
* signer: implement account_Version on external API
* accounts/external: enable ipc, add copyright
* accounts, internal, signer: formatting
* node: go fmt
* flags: disallow --dev in combo with --externalsigner
* accounts: remove clique-specific signing method, replace with more generic
* accounts, consensus: formatting + fix error in tests
* signer/core: remove (test-) import cycle
* clique: remove unused import
* accounts: remove CliqueHash and avoid dependency on package crypto
* consensus/clique: unduplicate header encoding
2019-02-05 11:23:57 +01:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( ExternalSignerFlag . Name ) {
cfg . ExternalSigner = ctx . String ( ExternalSignerFlag . Name )
2017-04-12 16:27:23 +02:00
}
accounts, eth, clique, signer: support for external signer API (#18079)
* accounts, eth, clique: implement external backend + move sighash calc to backend
* signer: implement account_Version on external API
* accounts/external: enable ipc, add copyright
* accounts, internal, signer: formatting
* node: go fmt
* flags: disallow --dev in combo with --externalsigner
* accounts: remove clique-specific signing method, replace with more generic
* accounts, consensus: formatting + fix error in tests
* signer/core: remove (test-) import cycle
* clique: remove unused import
* accounts: remove CliqueHash and avoid dependency on package crypto
* consensus/clique: unduplicate header encoding
2019-02-05 11:23:57 +01:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( KeyStoreDirFlag . Name ) {
cfg . KeyStoreDir = ctx . String ( KeyStoreDirFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( DeveloperFlag . Name ) {
2021-05-27 10:13:35 +02:00
cfg . UseLightweightKDF = true
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LightKDFFlag . Name ) {
cfg . UseLightweightKDF = ctx . Bool ( LightKDFFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( NoUSBFlag . Name ) || cfg . NoUSB {
2021-01-05 10:18:22 +00:00
log . Warn ( "Option nousb is deprecated and USB is deactivated by default. Use --usb to enable" )
2017-04-20 14:01:51 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( USBFlag . Name ) {
cfg . USB = ctx . Bool ( USBFlag . Name )
2017-04-20 14:01:51 +03:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DirectBroadcastFlag . Name ) {
cfg . DirectBroadcast = ctx . Bool ( DirectBroadcastFlag . Name )
2021-03-03 17:50:30 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DisableSnapProtocolFlag . Name ) {
cfg . DisableSnapProtocol = ctx . Bool ( DisableSnapProtocolFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( RangeLimitFlag . Name ) {
cfg . RangeLimit = ctx . Bool ( RangeLimitFlag . Name )
2021-02-23 15:12:41 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( InsecureUnlockAllowedFlag . Name ) {
cfg . InsecureUnlockAllowed = ctx . Bool ( InsecureUnlockAllowedFlag . Name )
2019-04-04 19:03:10 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( BLSPasswordFileFlag . Name ) {
cfg . BLSPasswordFile = ctx . String ( BLSPasswordFileFlag . Name )
}
2023-02-09 03:48:34 -05:00
if ctx . IsSet ( DBEngineFlag . Name ) {
dbEngine := ctx . String ( DBEngineFlag . Name )
if dbEngine != "leveldb" && dbEngine != "pebble" {
Fatalf ( "Invalid choice for db.engine '%s', allowed 'leveldb' or 'pebble'" , dbEngine )
}
log . Info ( fmt . Sprintf ( "Using %s as db engine" , dbEngine ) )
cfg . DBEngine = dbEngine
2023-04-10 18:36:45 +08:00
}
2023-11-29 15:33:50 +08:00
// deprecation notice for log debug flags (TODO: find a more appropriate place to put these?)
if ctx . IsSet ( LogBacktraceAtFlag . Name ) {
log . Warn ( "log.backtrace flag is deprecated" )
}
if ctx . IsSet ( LogDebugFlag . Name ) {
log . Warn ( "log.debug flag is deprecated" )
}
2017-04-12 16:27:23 +02:00
}
2019-05-31 11:30:28 +02:00
func setSmartCard ( ctx * cli . Context , cfg * node . Config ) {
// Skip enabling smartcards if no path is set
2022-06-27 18:22:36 +02:00
path := ctx . String ( SmartCardDaemonPathFlag . Name )
2019-05-31 11:30:28 +02:00
if path == "" {
return
}
// Sanity check that the smartcard path is valid
fi , err := os . Stat ( path )
if err != nil {
2019-06-04 21:17:12 +02:00
log . Info ( "Smartcard socket not found, disabling" , "err" , err )
2019-05-31 11:30:28 +02:00
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
}
2022-06-21 11:16:05 +02:00
func SetDataDir ( ctx * cli . Context , cfg * node . Config ) {
2018-11-23 01:32:34 +01:00
switch {
2022-06-27 18:22:36 +02:00
case ctx . IsSet ( DataDirFlag . Name ) :
cfg . DataDir = ctx . String ( DataDirFlag . Name )
case ctx . Bool ( DeveloperFlag . Name ) :
2018-11-23 01:32:34 +01:00
cfg . DataDir = "" // unless explicitly requested, use memory databases
}
}
2023-04-10 18:36:45 +08:00
func setVoteJournalDir ( ctx * cli . Context , cfg * node . Config ) {
dataDir := cfg . DataDir
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( VoteJournalDirFlag . Name ) {
cfg . VoteJournalDir = ctx . String ( VoteJournalDirFlag . Name )
2023-05-04 17:25:31 +08:00
} else if cfg . VoteJournalDir == "" {
2023-04-10 18:36:45 +08:00
cfg . VoteJournalDir = filepath . Join ( dataDir , "voteJournal" )
}
}
func setBLSWalletDir ( ctx * cli . Context , cfg * node . Config ) {
dataDir := cfg . DataDir
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( BLSWalletDirFlag . Name ) {
cfg . BLSWalletDir = ctx . String ( BLSWalletDirFlag . Name )
2023-05-04 17:25:31 +08:00
} else if cfg . BLSWalletDir == "" {
2023-04-10 18:36:45 +08:00
cfg . BLSWalletDir = filepath . Join ( dataDir , "bls/wallet" )
}
}
2023-12-21 16:53:48 +01:00
func setGPO ( ctx * cli . Context , cfg * gasprice . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GpoBlocksFlag . Name ) {
cfg . Blocks = ctx . Int ( GpoBlocksFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GpoPercentileFlag . Name ) {
cfg . Percentile = ctx . Int ( GpoPercentileFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GpoMaxGasPriceFlag . Name ) {
cfg . MaxPrice = big . NewInt ( ctx . Int64 ( GpoMaxGasPriceFlag . Name ) )
2020-09-09 23:38:47 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GpoIgnoreGasPriceFlag . Name ) {
cfg . IgnorePrice = big . NewInt ( ctx . Int64 ( GpoIgnoreGasPriceFlag . Name ) )
2021-05-11 02:25:51 -07:00
}
2017-04-12 16:27:23 +02:00
}
2023-06-16 15:29:40 +03:00
func setTxPool ( ctx * cli . Context , cfg * legacypool . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolLocalsFlag . Name ) {
locals := strings . Split ( ctx . String ( TxPoolLocalsFlag . Name ) , "," )
2018-08-21 20:30:06 +03:00
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 ) )
}
}
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolNoLocalsFlag . Name ) {
cfg . NoLocals = ctx . Bool ( TxPoolNoLocalsFlag . Name )
2017-05-26 13:40:47 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolJournalFlag . Name ) {
cfg . Journal = ctx . String ( TxPoolJournalFlag . Name )
2017-05-26 13:40:47 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolRejournalFlag . Name ) {
cfg . Rejournal = ctx . Duration ( TxPoolRejournalFlag . Name )
2017-05-26 13:40:47 +03:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolPriceLimitFlag . Name ) {
cfg . PriceLimit = ctx . Uint64 ( TxPoolPriceLimitFlag . Name )
2022-07-05 11:14:21 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolPriceBumpFlag . Name ) {
cfg . PriceBump = ctx . Uint64 ( TxPoolPriceBumpFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolAccountSlotsFlag . Name ) {
cfg . AccountSlots = ctx . Uint64 ( TxPoolAccountSlotsFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolGlobalSlotsFlag . Name ) {
cfg . GlobalSlots = ctx . Uint64 ( TxPoolGlobalSlotsFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolAccountQueueFlag . Name ) {
cfg . AccountQueue = ctx . Uint64 ( TxPoolAccountQueueFlag . Name )
2020-03-31 16:44:04 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolGlobalQueueFlag . Name ) {
cfg . GlobalQueue = ctx . Uint64 ( TxPoolGlobalQueueFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( TxPoolLifetimeFlag . Name ) {
cfg . Lifetime = ctx . Duration ( TxPoolLifetimeFlag . Name )
2017-04-12 16:27:23 +02:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( TxPoolReannounceTimeFlag . Name ) {
cfg . ReannounceTime = ctx . Duration ( TxPoolReannounceTimeFlag . Name )
2020-03-31 16:44:04 +08:00
}
2017-04-12 16:27:23 +02:00
}
2019-04-23 15:08:51 +08:00
func setMiner ( ctx * cli . Context , cfg * miner . Config ) {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MinerExtraDataFlag . Name ) {
cfg . ExtraData = [ ] byte ( ctx . String ( MinerExtraDataFlag . Name ) )
2019-04-23 15:08:51 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MinerGasLimitFlag . Name ) {
cfg . GasCeil = ctx . Uint64 ( MinerGasLimitFlag . Name )
2019-04-23 15:08:51 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MinerGasPriceFlag . Name ) {
cfg . GasPrice = flags . GlobalBig ( ctx , MinerGasPriceFlag . Name )
2019-04-23 15:08:51 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MinerRecommitIntervalFlag . Name ) {
cfg . Recommit = ctx . Duration ( MinerRecommitIntervalFlag . Name )
2019-04-23 15:08:51 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( MinerDelayLeftoverFlag . Name ) {
2021-03-19 13:23:44 +08:00
cfg . DelayLeftOver = ctx . Duration ( MinerDelayLeftoverFlag . Name )
}
2023-08-23 17:46:08 +08:00
if ctx . Bool ( VotingEnabledFlag . Name ) {
2023-04-17 22:23:08 +08:00
cfg . VoteEnable = true
}
2022-10-03 20:10:00 +08:00
if ctx . IsSet ( MinerNewPayloadTimeout . Name ) {
cfg . NewPayloadTimeout = ctx . Duration ( MinerNewPayloadTimeout . Name )
}
2023-08-23 19:37:39 +08:00
if ctx . Bool ( DisableVoteAttestationFlag . Name ) {
2023-08-14 17:48:36 +08:00
cfg . DisableVoteAttestation = true
}
2019-04-23 15:08:51 +08:00
}
2022-05-04 19:55:17 +03:00
func setRequiredBlocks ( ctx * cli . Context , cfg * ethconfig . Config ) {
2022-06-27 18:22:36 +02:00
requiredBlocks := ctx . String ( EthRequiredBlocksFlag . Name )
2022-05-04 19:55:17 +03:00
if requiredBlocks == "" {
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( LegacyWhitelistFlag . Name ) {
2022-05-04 19:55:17 +03:00
log . Warn ( "The flag --whitelist is deprecated and will be removed, please use --eth.requiredblocks" )
2022-06-27 18:22:36 +02:00
requiredBlocks = ctx . String ( LegacyWhitelistFlag . Name )
2022-03-15 04:20:03 -07:00
} else {
return
}
2018-12-10 14:47:01 +02:00
}
2022-05-04 19:55:17 +03:00
cfg . RequiredBlocks = make ( map [ uint64 ] common . Hash )
for _ , entry := range strings . Split ( requiredBlocks , "," ) {
2018-12-10 14:47:01 +02:00
parts := strings . Split ( entry , "=" )
if len ( parts ) != 2 {
2022-05-04 19:55:17 +03:00
Fatalf ( "Invalid required block entry: %s" , entry )
2018-11-02 13:26:45 -07:00
}
2018-12-10 14:47:01 +02:00
number , err := strconv . ParseUint ( parts [ 0 ] , 0 , 64 )
if err != nil {
2022-05-04 19:55:17 +03:00
Fatalf ( "Invalid required block number %s: %v" , parts [ 0 ] , err )
2018-12-10 14:47:01 +02:00
}
var hash common . Hash
if err = hash . UnmarshalText ( [ ] byte ( parts [ 1 ] ) ) ; err != nil {
2022-05-04 19:55:17 +03:00
Fatalf ( "Invalid required block hash %s: %v" , parts [ 1 ] , err )
2018-12-10 14:47:01 +02:00
}
2022-05-04 19:55:17 +03:00
cfg . RequiredBlocks [ number ] = hash
2018-11-02 13:26:45 -07:00
}
}
2019-07-08 20:59:07 +08:00
// CheckExclusive verifies that only a single instance of the provided flags was
2017-11-24 17:07:22 +02:00
// set by the user. Each flag might optionally be followed by a string type to
// specialize it further.
2019-07-08 20:59:07 +08:00
func CheckExclusive ( ctx * cli . Context , args ... interface { } ) {
2017-04-12 16:27:23 +02:00
set := make ( [ ] string , 0 , 1 )
2017-11-24 17:07:22 +02:00
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
2022-06-27 18:22:36 +02:00
name := flag . Names ( ) [ 0 ]
2017-11-24 17:07:22 +02:00
if i + 1 < len ( args ) {
switch option := args [ i + 1 ] . ( type ) {
case string :
2018-10-08 07:08:56 -07:00
// Extended flag check, make sure value set doesn't conflict with passed in option
2022-06-27 18:22:36 +02:00
if ctx . String ( flag . Names ( ) [ 0 ] ) == option {
2017-11-24 17:07:22 +02:00
name += "=" + option
2018-10-08 07:08:56 -07:00
set = append ( set , "--" + name )
2017-11-24 17:07:22 +02:00
}
2018-10-08 07:08:56 -07:00
// shift arguments and continue
2017-11-24 17:07:22 +02:00
i ++
2018-10-08 07:08:56 -07:00
continue
2017-11-24 17:07:22 +02:00
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
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( flag . Names ( ) [ 0 ] ) {
2017-11-24 17:07:22 +02:00
set = append ( set , "--" + name )
2015-11-17 18:33:25 +02:00
}
}
2017-04-12 16:27:23 +02:00
if len ( set ) > 1 {
2017-11-24 17:07:22 +02:00
Fatalf ( "Flags %v can't be used at the same time" , strings . Join ( set , ", " ) )
2015-11-17 18:33:25 +02:00
}
2017-04-12 16:27:23 +02:00
}
// SetEthConfig applies eth-related command line flags to the config.
2021-02-05 20:51:15 +08:00
func SetEthConfig ( ctx * cli . Context , stack * node . Node , cfg * ethconfig . Config ) {
2017-04-12 16:27:23 +02:00
// Avoid conflicting network flags
2023-12-21 16:53:48 +01:00
CheckExclusive ( ctx , BSCMainnetFlag , DeveloperFlag )
2019-07-10 08:54:06 +03:00
CheckExclusive ( ctx , DeveloperFlag , ExternalSignerFlag ) // Can't use both ephemeral unlocked and external signer
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
// Set configurations from CLI flags
2023-01-21 00:26:01 +08:00
setEtherbase ( ctx , cfg )
2023-12-21 16:53:48 +01:00
setGPO ( ctx , & cfg . GPO )
2017-05-26 13:40:47 +03:00
setTxPool ( ctx , & cfg . TxPool )
2019-04-23 15:08:51 +08:00
setMiner ( ctx , & cfg . Miner )
2022-05-04 19:55:17 +03:00
setRequiredBlocks ( ctx , cfg )
2019-07-10 10:08:59 +08:00
setLes ( ctx , cfg )
2017-04-12 16:27:23 +02:00
2021-04-06 10:23:35 -04:00
// 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 )
2022-06-27 18:22:36 +02:00
if cache := ctx . Int ( CacheFlag . Name ) ; cache > allowance {
2021-04-06 10:23:35 -04:00
log . Warn ( "Sanitizing cache to Go's GC limits" , "provided" , cache , "updated" , allowance )
2022-06-27 18:22:36 +02:00
ctx . Set ( CacheFlag . Name , strconv . Itoa ( allowance ) )
2021-04-06 10:23:35 -04:00
}
}
// Ensure Go's GC ignores the database cache for trigger percentage
2022-06-27 18:22:36 +02:00
cache := ctx . Int ( CacheFlag . Name )
2021-04-06 10:23:35 -04:00
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 ) )
2023-09-29 22:11:15 +03:00
if ctx . IsSet ( SyncTargetFlag . Name ) {
cfg . SyncMode = downloader . FullSync // dev sync target forces full sync
} else if ctx . IsSet ( SyncModeFlag . Name ) {
2022-06-27 18:22:36 +02:00
cfg . SyncMode = * flags . GlobalTextMarshaler ( ctx , SyncModeFlag . Name ) . ( * downloader . SyncMode )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( NetworkIdFlag . Name ) {
cfg . NetworkId = ctx . Uint64 ( NetworkIdFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheDatabaseFlag . Name ) {
cfg . DatabaseCache = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheDatabaseFlag . Name ) / 100
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
cfg . DatabaseHandles = MakeDatabaseHandles ( ctx . Int ( FDLimitFlag . Name ) )
if ctx . IsSet ( AncientFlag . Name ) {
cfg . DatabaseFreezer = ctx . String ( AncientFlag . Name )
2019-03-08 15:56:20 +02:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DiffFlag . Name ) {
cfg . DatabaseDiff = ctx . String ( DiffFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( PersistDiffFlag . Name ) {
cfg . PersistDiff = ctx . Bool ( PersistDiffFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DiffBlockFlag . Name ) {
cfg . DiffBlock = ctx . Uint64 ( DiffBlockFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( PruneAncientDataFlag . Name ) {
2022-07-05 11:14:21 +08:00
if cfg . SyncMode == downloader . FullSync {
2023-08-23 17:46:08 +08:00
cfg . PruneAncientData = ctx . Bool ( PruneAncientDataFlag . Name )
2022-07-05 11:14:21 +08:00
} else {
2024-01-12 15:36:26 +08:00
log . Crit ( "pruneancient parameter can only be used with syncmode=full" )
2022-07-05 11:14:21 +08:00
}
}
2022-06-27 18:22:36 +02:00
if gcmode := ctx . String ( GCModeFlag . Name ) ; gcmode != "full" && gcmode != "archive" {
2018-02-05 18:40:32 +02:00
Fatalf ( "--%s must be either 'full' or 'archive'" , GCModeFlag . Name )
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( GCModeFlag . Name ) {
cfg . NoPruning = ctx . String ( GCModeFlag . Name ) == "archive"
2019-10-15 17:19:20 +09:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DirectBroadcastFlag . Name ) {
cfg . DirectBroadcast = ctx . Bool ( DirectBroadcastFlag . Name )
2021-03-03 17:50:30 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( DisableSnapProtocolFlag . Name ) {
cfg . DisableSnapProtocol = ctx . Bool ( DisableSnapProtocolFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( EnableTrustProtocolFlag . Name ) {
cfg . EnableTrustProtocol = ctx . IsSet ( EnableTrustProtocolFlag . Name )
2022-07-05 11:14:21 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( PipeCommitFlag . Name ) {
2023-12-04 13:02:19 +08:00
log . Warn ( "The --pipecommit flag is deprecated and could be removed in the future!" )
2023-08-23 17:46:08 +08:00
}
if ctx . IsSet ( RangeLimitFlag . Name ) {
cfg . RangeLimit = ctx . Bool ( RangeLimitFlag . Name )
2022-07-05 11:14:21 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheNoPrefetchFlag . Name ) {
cfg . NoPrefetch = ctx . Bool ( CacheNoPrefetchFlag . Name )
2021-02-23 15:12:41 +08:00
}
2020-11-18 17:51:33 +08:00
// Read the value from the flag no matter if it's set or not.
2022-06-27 18:22:36 +02:00
cfg . Preimages = ctx . Bool ( CachePreimagesFlag . Name )
2020-11-18 17:51:33 +08:00
if cfg . NoPruning && ! cfg . Preimages {
cfg . Preimages = true
log . Info ( "Enabling recording of key preimages since archive mode is used" )
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
if ctx . IsSet ( StateHistoryFlag . Name ) {
cfg . StateHistory = ctx . Uint64 ( StateHistoryFlag . Name )
}
2024-02-20 17:22:27 +08:00
scheme , err := ParseCLIAndConfigStateScheme ( ctx . String ( StateSchemeFlag . Name ) , cfg . StateScheme )
2024-01-12 15:36:26 +08:00
if err != nil {
Fatalf ( "%v" , err )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
2024-01-12 15:36:26 +08:00
cfg . StateScheme = scheme
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
// Parse transaction history flag, if user is still using legacy config
// file with 'TxLookupLimit' configured, copy the value to 'TransactionHistory'.
if cfg . TransactionHistory == ethconfig . Defaults . TransactionHistory && cfg . TxLookupLimit != ethconfig . Defaults . TxLookupLimit {
all: activate pbss as experimental feature (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
log . Warn ( "The config option 'TxLookupLimit' is deprecated and will be removed, please use 'TransactionHistory'" )
cfg . TransactionHistory = cfg . TxLookupLimit
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
if ctx . IsSet ( TransactionHistoryFlag . Name ) {
cfg . TransactionHistory = ctx . Uint64 ( TransactionHistoryFlag . Name )
} else if ctx . IsSet ( TxLookupLimitFlag . Name ) {
all: activate pbss as experimental feature (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
log . Warn ( "The flag --txlookuplimit is deprecated and will be removed, please use --history.transactions" )
2023-08-14 20:58:01 +08:00
cfg . TransactionHistory = ctx . Uint64 ( TxLookupLimitFlag . Name )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
2023-11-06 14:11:17 +08:00
if ctx . IsSet ( PathDBSyncFlag . Name ) {
cfg . PathSyncFlush = true
}
2024-04-15 10:47:54 +08:00
if ctx . IsSet ( JournalFileFlag . Name ) {
cfg . JournalFileEnabled = true
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
if ctx . String ( GCModeFlag . Name ) == "archive" && cfg . TransactionHistory != 0 {
cfg . TransactionHistory = 0
log . Warn ( "Disabled transaction unindexing for archive node" )
2024-03-19 15:18:58 +08:00
cfg . StateScheme = rawdb . HashScheme
log . Warn ( "Forcing hash state-scheme for archive mode" )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheTrieFlag . Name ) {
cfg . TrieCleanCache = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheTrieFlag . Name ) / 100
2018-11-12 18:47:34 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheGCFlag . Name ) {
cfg . TrieDirtyCache = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheGCFlag . Name ) / 100
2020-07-28 21:30:31 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( TriesInMemoryFlag . Name ) {
cfg . TriesInMemory = ctx . Uint64 ( TriesInMemoryFlag . Name )
2020-07-28 21:30:31 +08:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( TriesVerifyModeFlag . Name ) {
cfg . TriesVerifyMode = * flags . GlobalTextMarshaler ( ctx , TriesVerifyModeFlag . Name ) . ( * core . VerifyMode )
2022-07-05 11:14:21 +08:00
// If a node sets verify mode to full or insecure, it's a fast node and need
// to verify blocks from verify nodes, then it should enable trust protocol.
if cfg . TriesVerifyMode . NeedRemoteVerify ( ) {
cfg . EnableTrustProtocol = true
}
2024-03-21 15:15:13 +08:00
// A node without trie is not able to provide snap data, so it should disable snap protocol.
if cfg . TriesVerifyMode != core . LocalVerify {
log . Info ( "Automatically disables snap protocol due to verify mode" , "mode" , cfg . TriesVerifyMode )
cfg . DisableSnapProtocol = true
}
2024-03-21 11:42:33 +08:00
if cfg . SyncMode == downloader . SnapSync && cfg . TriesVerifyMode . NoTries ( ) {
log . Warn ( "Only local TriesVerifyMode can support snap sync, resetting to full sync" , "mode" , cfg . TriesVerifyMode )
cfg . SyncMode = downloader . FullSync
}
2022-07-05 11:14:21 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheSnapshotFlag . Name ) {
cfg . SnapshotCache = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheSnapshotFlag . Name ) / 100
2019-11-26 09:48:29 +02:00
}
2022-08-19 11:14:59 +02:00
if ctx . IsSet ( CacheLogSizeFlag . Name ) {
cfg . FilterLogCacheSize = ctx . Int ( CacheLogSizeFlag . Name )
2019-11-26 09:48:29 +02:00
}
2023-12-08 15:16:04 +02:00
if ! ctx . Bool ( SnapshotFlag . Name ) || cfg . SnapshotCache == 0 {
2020-12-14 11:27:15 +02:00
// If snap-sync is requested, this flag is also required
if cfg . SyncMode == downloader . SnapSync {
2023-12-08 15:16:04 +02:00
if ! ctx . Bool ( SnapshotFlag . Name ) {
log . Warn ( "Snap sync requested, enabling --snapshot" )
}
if cfg . SnapshotCache == 0 {
log . Warn ( "Snap sync requested, resetting --cache.snapshot" )
cfg . SnapshotCache = ctx . Int ( CacheFlag . Name ) * CacheSnapshotFlag . Value / 100
}
2020-12-14 11:27:15 +02:00
} else {
cfg . TrieCleanCache += cfg . SnapshotCache
cfg . SnapshotCache = 0 // Disabled
}
2020-01-19 20:57:56 +01:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( DocRootFlag . Name ) {
cfg . DocRoot = ctx . String ( DocRootFlag . Name )
2017-04-12 16:27:23 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( VMEnableDebugFlag . Name ) {
2017-04-12 16:27:23 +02:00
// TODO(fjl): force-enable this in --dev mode
2022-06-27 18:22:36 +02:00
cfg . EnablePreimageRecording = ctx . Bool ( VMEnableDebugFlag . Name )
2017-04-12 16:27:23 +02:00
}
2015-11-17 18:33:25 +02:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( RPCGlobalGasCapFlag . Name ) {
cfg . RPCGasCap = ctx . Uint64 ( RPCGlobalGasCapFlag . Name )
2019-04-08 13:49:52 +02:00
}
2020-07-01 19:54:21 +02:00
if cfg . RPCGasCap != 0 {
log . Info ( "Set global gas cap" , "cap" , cfg . RPCGasCap )
} else {
log . Info ( "Global gas cap disabled" )
2019-04-08 13:49:52 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( RPCGlobalEVMTimeoutFlag . Name ) {
cfg . RPCEVMTimeout = ctx . Duration ( RPCGlobalEVMTimeoutFlag . Name )
2021-10-12 04:46:04 -04:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( RPCGlobalTxFeeCapFlag . Name ) {
cfg . RPCTxFeeCap = ctx . Float64 ( RPCGlobalTxFeeCapFlag . Name )
2020-06-17 15:46:31 +08:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( NoDiscoverFlag . Name ) {
2023-04-10 18:36:45 +08:00
cfg . EthDiscoveryURLs , cfg . SnapDiscoveryURLs , cfg . TrustDiscoveryURLs , cfg . BscDiscoveryURLs = [ ] string { } , [ ] string { } , [ ] string { } , [ ] string { }
2022-06-27 18:22:36 +02:00
} else if ctx . IsSet ( DNSDiscoveryFlag . Name ) {
urls := ctx . String ( DNSDiscoveryFlag . Name )
2020-02-13 14:38:30 +01:00
if urls == "" {
2020-12-14 11:27:15 +02:00
cfg . EthDiscoveryURLs = [ ] string { }
2020-02-13 14:38:30 +01:00
} else {
2020-12-14 11:27:15 +02:00
cfg . EthDiscoveryURLs = SplitAndTrim ( urls )
2020-02-13 14:38:30 +01:00
}
}
2017-05-04 12:36:20 +03:00
// Override any default configs for hard coded networks.
2015-11-17 18:33:25 +02:00
switch {
2023-11-29 15:04:50 +08:00
case ctx . Bool ( BSCMainnetFlag . Name ) :
2022-06-27 18:22:36 +02:00
if ! ctx . IsSet ( NetworkIdFlag . Name ) {
2023-11-29 15:04:50 +08:00
cfg . NetworkId = 56
2021-01-05 14:31:23 +01:00
}
2023-11-29 15:04:50 +08:00
cfg . Genesis = core . DefaultBSCGenesisBlock ( )
SetDNSDiscoveryDefaults ( cfg , params . BSCGenesisHash )
2024-07-10 16:10:07 +08:00
case ctx . Bool ( ChapelFlag . Name ) || cfg . NetworkId == 97 :
2023-12-25 10:58:52 +08:00
if ! ctx . IsSet ( NetworkIdFlag . Name ) {
cfg . NetworkId = 97
}
cfg . Genesis = core . DefaultChapelGenesisBlock ( )
SetDNSDiscoveryDefaults ( cfg , params . ChapelGenesisHash )
2022-06-27 18:22:36 +02:00
case ctx . Bool ( DeveloperFlag . Name ) :
if ! ctx . IsSet ( NetworkIdFlag . Name ) {
2018-06-14 02:31:31 -07:00
cfg . NetworkId = 1337
}
2021-05-27 10:13:35 +02:00
cfg . SyncMode = downloader . FullSync
2017-10-24 13:40:42 +03:00
// Create new developer account or reuse existing one
var (
2020-07-22 22:47:34 -05:00
developer accounts . Account
passphrase string
err error
2017-10-24 13:40:42 +03:00
)
2020-07-22 22:47:34 -05:00
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 ]
}
2023-01-26 10:07:20 +01:00
2023-01-21 00:26:01 +08:00
// Unlock the developer account by local keystore.
var ks * keystore . KeyStore
if keystores := stack . AccountManager ( ) . Backends ( keystore . KeyStoreType ) ; len ( keystores ) > 0 {
ks = keystores [ 0 ] . ( * keystore . KeyStore )
}
if ks == nil {
Fatalf ( "Keystore is not available" )
}
2023-01-26 10:07:20 +01:00
// Figure out the dev account address.
2020-07-22 22:47:34 -05:00
// 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 {
2017-10-24 13:40:42 +03:00
developer = ks . Accounts ( ) [ 0 ]
} else {
2020-07-22 22:47:34 -05:00
developer , err = ks . NewAccount ( passphrase )
2017-10-24 13:40:42 +03:00
if err != nil {
Fatalf ( "Failed to create developer account: %v" , err )
}
}
2023-01-26 10:07:20 +01:00
// Make sure the address is configured as fee recipient, otherwise
// the miner will fail to start.
cfg . Miner . Etherbase = developer . Address
2020-07-22 22:47:34 -05:00
if err := ks . Unlock ( developer , passphrase ) ; err != nil {
2017-10-24 13:40:42 +03:00
Fatalf ( "Failed to unlock developer account: %v" , err )
}
log . Info ( "Using developer account" , "address" , developer . Address )
2020-07-21 15:53:47 +03:00
// Create a new developer genesis block or reuse existing one
2023-11-22 19:08:39 +08:00
cfg . Genesis = core . DeveloperGenesisBlock ( ctx . Uint64 ( DeveloperGasLimitFlag . Name ) , & developer . Address )
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( DataDirFlag . Name ) {
2022-01-27 10:06:40 +01:00
// If datadir doesn't exist we need to open db in write-mode
// so leveldb can create files.
readonly := true
if ! common . FileExist ( stack . ResolvePath ( "chaindata" ) ) {
readonly = false
}
2020-07-21 15:53:47 +03:00
// Check if we have an already initialized chain and fall back to
2024-01-12 15:36:26 +08:00
// that if so. Otherwise, we need to generate a new genesis spec.
2022-07-05 11:14:21 +08:00
chaindb := MakeChainDatabase ( ctx , stack , readonly , false )
2020-07-21 15:53:47 +03:00
if rawdb . ReadCanonicalHash ( chaindb , 0 ) != ( common . Hash { } ) {
cfg . Genesis = nil // fallback to db content
2023-11-22 19:01:38 +08:00
2024-03-19 15:18:58 +08:00
// validate genesis has PoS enabled in block 0
2023-11-22 19:01:38 +08:00
genesis , err := core . ReadGenesis ( chaindb )
if err != nil {
Fatalf ( "Could not read genesis from database: %v" , err )
}
if ! genesis . Config . TerminalTotalDifficultyPassed {
Fatalf ( "Bad developer-mode genesis configuration: terminalTotalDifficultyPassed must be true in developer mode" )
}
if genesis . Config . TerminalTotalDifficulty == nil {
Fatalf ( "Bad developer-mode genesis configuration: terminalTotalDifficulty must be specified." )
}
if genesis . Difficulty . Cmp ( genesis . Config . TerminalTotalDifficulty ) != 1 {
Fatalf ( "Bad developer-mode genesis configuration: genesis block difficulty must be > terminalTotalDifficulty" )
}
2020-07-21 15:53:47 +03:00
}
chaindb . Close ( )
}
2022-06-27 18:22:36 +02:00
if ! ctx . IsSet ( MinerGasPriceFlag . Name ) {
2019-04-23 15:08:51 +08:00
cfg . Miner . GasPrice = big . NewInt ( 1 )
2015-09-06 15:46:54 +02:00
}
2020-02-13 14:38:30 +01:00
default :
if cfg . NetworkId == 1 {
2020-10-05 12:50:26 +02:00
SetDNSDiscoveryDefaults ( cfg , params . MainnetGenesisHash )
2020-02-13 14:38:30 +01:00
}
}
2023-05-10 14:54:14 +03:00
// Set any dangling config values
if ctx . String ( CryptoKZGFlag . Name ) != "gokzg" && ctx . String ( CryptoKZGFlag . Name ) != "ckzg" {
Fatalf ( "--%s flag must be 'gokzg' or 'ckzg'" , CryptoKZGFlag . Name )
}
log . Info ( "Initializing the KZG library" , "backend" , ctx . String ( CryptoKZGFlag . Name ) )
if err := kzg4844 . UseCKZG ( ctx . String ( CryptoKZGFlag . Name ) == "ckzg" ) ; err != nil {
Fatalf ( "Failed to set KZG library implementation to %s: %v" , ctx . String ( CryptoKZGFlag . Name ) , err )
}
2024-03-22 22:37:47 +08:00
// blob setting
if ctx . IsSet ( OverrideDefaultExtraReserveForBlobRequests . Name ) {
cfg . BlobExtraReserve = ctx . Uint64 ( OverrideDefaultExtraReserveForBlobRequests . Name )
}
if ctx . IsSet ( BlobExtraReserveFlag . Name ) {
extraReserve := ctx . Uint64 ( BlobExtraReserveFlag . Name )
if extraReserve > 0 && extraReserve < params . DefaultExtraReserveForBlobRequests {
extraReserve = params . DefaultExtraReserveForBlobRequests
}
cfg . BlobExtraReserve = extraReserve
}
2020-02-13 14:38:30 +01:00
}
2020-10-05 12:50:26 +02:00
// SetDNSDiscoveryDefaults configures DNS discovery with the given URL if
2020-02-13 14:38:30 +01:00
// no URLs are set.
2021-02-05 20:51:15 +08:00
func SetDNSDiscoveryDefaults ( cfg * ethconfig . Config , genesis common . Hash ) {
2020-12-14 11:27:15 +02:00
if cfg . EthDiscoveryURLs != nil {
2020-05-22 13:46:34 +02:00
return // already set through flags/config
}
2020-05-25 19:50:36 +02:00
protocol := "all"
2020-05-22 13:46:34 +02:00
if url := params . KnownDNSNetwork ( genesis , protocol ) ; url != "" {
2020-12-14 11:27:15 +02:00
cfg . EthDiscoveryURLs = [ ] string { url }
2021-05-04 11:29:32 +02:00
cfg . SnapDiscoveryURLs = cfg . EthDiscoveryURLs
2022-07-05 11:14:21 +08:00
cfg . TrustDiscoveryURLs = cfg . EthDiscoveryURLs
2023-04-10 18:36:45 +08:00
cfg . BscDiscoveryURLs = cfg . EthDiscoveryURLs
2015-09-06 15:46:54 +02:00
}
2017-04-12 16:27:23 +02:00
}
2015-12-16 04:26:23 +01:00
2017-04-12 16:27:23 +02:00
// RegisterEthService adds an Ethereum client to the stack.
2023-12-21 16:53:48 +01:00
// The second return value is the full node instance.
2021-04-16 21:29:22 +02:00
func RegisterEthService ( stack * node . Node , cfg * ethconfig . Config ) ( ethapi . Backend , * eth . Ethereum ) {
2020-11-25 09:24:50 +01:00
backend , err := eth . New ( stack , cfg )
2017-04-12 16:27:23 +02:00
if err != nil {
Fatalf ( "Failed to register the Ethereum service: %v" , err )
2015-11-17 18:33:25 +02:00
}
2021-01-25 21:36:39 +08:00
stack . RegisterAPIs ( tracers . APIs ( backend . APIBackend ) )
2021-04-16 21:29:22 +02:00
return backend . APIBackend , backend
2015-03-06 03:00:41 +01:00
}
2022-08-19 11:14:59 +02:00
// RegisterEthStatsService configures the Ethereum Stats daemon and adds it to the node.
2020-08-03 19:40:46 +02:00
func RegisterEthStatsService ( stack * node . Node , backend ethapi . Backend , url string ) {
if err := ethstats . New ( stack , backend , backend . Engine ( ) , url ) ; err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Failed to register the Ethereum Stats service: %v" , err )
2016-11-25 17:55:06 +02:00
}
}
2022-08-19 11:14:59 +02:00
// RegisterGraphQLService adds the GraphQL API to the node.
func RegisterGraphQLService ( stack * node . Node , backend ethapi . Backend , filterSystem * filters . FilterSystem , cfg * node . Config ) {
err := graphql . New ( stack , backend , filterSystem , cfg . GraphQLCors , cfg . GraphQLVirtualHosts )
if err != nil {
2019-06-12 11:24:24 +03:00
Fatalf ( "Failed to register the GraphQL service: %v" , err )
}
}
2022-11-28 22:09:45 +08:00
type SetupMetricsOption func ( )
func EnableBuildInfo ( gitCommit , gitDate string ) SetupMetricsOption {
return func ( ) {
// register build info into metrics
metrics . NewRegisteredLabel ( "build-info" , nil ) . Mark ( map [ string ] interface { } {
"version" : params . VersionWithMeta ,
"git-commit" : gitCommit ,
"git-commit-date" : gitDate ,
"go-version" : runtime . Version ( ) ,
"operating-system" : runtime . GOOS ,
"architecture" : runtime . GOARCH ,
} )
}
}
2024-03-29 15:04:33 +08:00
func EnableMinerInfo ( ctx * cli . Context , minerConfig * miner . Config ) SetupMetricsOption {
2022-12-16 07:59:16 +08:00
return func ( ) {
2023-08-23 17:46:08 +08:00
if ctx . Bool ( MiningEnabledFlag . Name ) {
2022-12-16 07:59:16 +08:00
// register miner info into metrics
minerInfo := structs . Map ( minerConfig )
2023-08-23 17:46:08 +08:00
minerInfo [ UnlockedAccountFlag . Name ] = ctx . String ( UnlockedAccountFlag . Name )
2022-12-16 07:59:16 +08:00
metrics . NewRegisteredLabel ( "miner-info" , nil ) . Mark ( minerInfo )
}
}
}
2022-08-19 11:14:59 +02:00
// RegisterFilterAPI adds the eth log filtering RPC API to the node.
func RegisterFilterAPI ( stack * node . Node , backend ethapi . Backend , ethcfg * ethconfig . Config ) * filters . FilterSystem {
filterSystem := filters . NewFilterSystem ( backend , filters . Config {
LogCacheSize : ethcfg . FilterLogCacheSize ,
} )
stack . RegisterAPIs ( [ ] rpc . API { {
Namespace : "eth" ,
2023-12-21 16:53:48 +01:00
Service : filters . NewFilterAPI ( filterSystem , ethcfg . RangeLimit ) ,
2022-08-19 11:14:59 +02:00
} } )
return filterSystem
}
2024-03-29 15:04:33 +08:00
func EnableNodeInfo ( poolConfig * legacypool . Config , nodeInfo * p2p . NodeInfo ) SetupMetricsOption {
2023-08-02 14:06:24 +08:00
return func ( ) {
// register node info into metrics
metrics . NewRegisteredLabel ( "node-info" , nil ) . Mark ( map [ string ] interface { } {
2024-03-29 15:04:33 +08:00
"Enode" : nodeInfo . Enode ,
"ENR" : nodeInfo . ENR ,
"ID" : nodeInfo . ID ,
2023-08-02 14:06:24 +08:00
"PriceLimit" : poolConfig . PriceLimit ,
"PriceBump" : poolConfig . PriceBump ,
"AccountSlots" : poolConfig . AccountSlots ,
"GlobalSlots" : poolConfig . GlobalSlots ,
"AccountQueue" : poolConfig . AccountQueue ,
"GlobalQueue" : poolConfig . GlobalQueue ,
"Lifetime" : poolConfig . Lifetime ,
} )
}
}
2022-11-28 22:09:45 +08:00
func SetupMetrics ( ctx * cli . Context , options ... SetupMetricsOption ) {
2018-07-02 14:51:02 +02:00
if metrics . Enabled {
log . Info ( "Enabling metrics collection" )
2020-07-03 12:12:22 -05:00
2018-07-02 14:51:02 +02:00
var (
2022-06-27 18:22:36 +02:00
enableExport = ctx . Bool ( MetricsEnableInfluxDBFlag . Name )
enableExportV2 = ctx . Bool ( MetricsEnableInfluxDBV2Flag . Name )
2021-08-17 18:40:14 +02:00
)
if enableExport || enableExportV2 {
CheckExclusive ( ctx , MetricsEnableInfluxDBFlag , MetricsEnableInfluxDBV2Flag )
2022-06-27 18:22:36 +02:00
v1FlagIsSet := ctx . IsSet ( MetricsInfluxDBUsernameFlag . Name ) ||
ctx . IsSet ( MetricsInfluxDBPasswordFlag . Name )
2021-08-17 18:40:14 +02:00
2022-06-27 18:22:36 +02:00
v2FlagIsSet := ctx . IsSet ( MetricsInfluxDBTokenFlag . Name ) ||
ctx . IsSet ( MetricsInfluxDBOrganizationFlag . Name ) ||
ctx . IsSet ( MetricsInfluxDBBucketFlag . Name )
2021-08-17 18:40:14 +02:00
if enableExport && v2FlagIsSet {
Fatalf ( "Flags --influxdb.metrics.organization, --influxdb.metrics.token, --influxdb.metrics.bucket are only available for influxdb-v2" )
} else if enableExportV2 && v1FlagIsSet {
Fatalf ( "Flags --influxdb.metrics.username, --influxdb.metrics.password are only available for influxdb-v1" )
}
}
var (
2022-06-27 18:22:36 +02:00
endpoint = ctx . String ( MetricsInfluxDBEndpointFlag . Name )
database = ctx . String ( MetricsInfluxDBDatabaseFlag . Name )
username = ctx . String ( MetricsInfluxDBUsernameFlag . Name )
password = ctx . String ( MetricsInfluxDBPasswordFlag . Name )
token = ctx . String ( MetricsInfluxDBTokenFlag . Name )
bucket = ctx . String ( MetricsInfluxDBBucketFlag . Name )
organization = ctx . String ( MetricsInfluxDBOrganizationFlag . Name )
2018-07-02 14:51:02 +02:00
)
if enableExport {
2022-06-27 18:22:36 +02:00
tagsMap := SplitTagsFlag ( ctx . String ( MetricsInfluxDBTagsFlag . Name ) )
2019-01-29 09:14:24 +01:00
2018-07-02 14:51:02 +02:00
log . Info ( "Enabling metrics export to InfluxDB" )
2019-01-29 09:14:24 +01:00
go influxdb . InfluxDBWithTags ( metrics . DefaultRegistry , 10 * time . Second , endpoint , database , username , password , "geth." , tagsMap )
2021-08-17 18:40:14 +02:00
} else if enableExportV2 {
2022-06-27 18:22:36 +02:00
tagsMap := SplitTagsFlag ( ctx . String ( MetricsInfluxDBTagsFlag . Name ) )
2021-08-17 18:40:14 +02:00
log . Info ( "Enabling metrics export to InfluxDB (v2)" )
go influxdb . InfluxDBV2WithTags ( metrics . DefaultRegistry , 10 * time . Second , endpoint , token , bucket , organization , "geth." , tagsMap )
2019-01-29 09:14:24 +01:00
}
2020-07-03 12:12:22 -05:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( MetricsHTTPFlag . Name ) {
2023-07-02 19:21:16 +08:00
address := net . JoinHostPort ( ctx . String ( MetricsHTTPFlag . Name ) , fmt . Sprintf ( "%d" , ctx . Int ( MetricsPortFlag . Name ) ) )
2020-07-03 12:12:22 -05:00
log . Info ( "Enabling stand-alone metrics HTTP endpoint" , "address" , address )
exp . Setup ( address )
2022-11-24 11:37:58 +01:00
} else if ctx . IsSet ( MetricsPortFlag . Name ) {
log . Warn ( fmt . Sprintf ( "--%s specified without --%s, metrics server will not start." , MetricsPortFlag . Name , MetricsHTTPFlag . Name ) )
2020-07-03 12:12:22 -05:00
}
2022-11-28 22:09:45 +08:00
for _ , opt := range options {
opt ( )
}
2022-12-16 07:59:16 +08:00
// Start system runtime metrics collection
go metrics . CollectProcessMetrics ( 3 * time . Second )
2019-01-29 09:14:24 +01:00
}
}
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 ]
}
2018-07-02 14:51:02 +02:00
}
}
2019-01-29 09:14:24 +01:00
return tagsMap
2018-07-02 14:51:02 +02:00
}
2023-11-10 20:26:13 +08:00
// MakeChainDatabase opens a database using the flags passed to the client and will hard crash if it fails.
2022-07-05 11:14:21 +08:00
func MakeChainDatabase ( ctx * cli . Context , stack * node . Node , readonly , disableFreeze bool ) ethdb . Database {
2016-03-01 23:32:43 +01:00
var (
2022-06-27 18:22:36 +02:00
cache = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheDatabaseFlag . Name ) / 100
handles = MakeDatabaseHandles ( ctx . Int ( FDLimitFlag . Name ) )
2020-07-13 17:02:54 +08:00
err error
chainDb ethdb . Database
2016-03-01 23:32:43 +01:00
)
2022-05-18 16:27:17 +02:00
switch {
2022-06-27 18:22:36 +02:00
case ctx . IsSet ( RemoteDBFlag . Name ) :
2022-09-30 13:50:25 +02:00
log . Info ( "Using remote db" , "url" , ctx . String ( RemoteDBFlag . Name ) , "headers" , len ( ctx . StringSlice ( HttpHeaderFlag . Name ) ) )
client , err := DialRPCWithHeaders ( ctx . String ( RemoteDBFlag . Name ) , ctx . StringSlice ( HttpHeaderFlag . Name ) )
if err != nil {
break
}
chainDb = remotedb . New ( client )
2022-06-27 18:22:36 +02:00
case ctx . String ( SyncModeFlag . Name ) == "light" :
2022-05-18 16:27:17 +02:00
chainDb , err = stack . OpenDatabase ( "lightchaindata" , cache , handles , "" , readonly )
default :
2023-09-07 16:39:29 +08:00
chainDb , err = stack . OpenDatabaseWithFreezer ( "chaindata" , cache , handles , ctx . String ( AncientFlag . Name ) , "" , readonly , disableFreeze , false , false )
2024-03-08 16:07:29 +08:00
// set the separate state database
2024-04-18 15:12:05 +08:00
if stack . CheckIfMultiDataBase ( ) && err == nil {
2024-03-08 16:07:29 +08:00
stateDiskDb := MakeStateDataBase ( ctx , stack , readonly , false )
chainDb . SetStateStore ( stateDiskDb )
2024-04-18 15:12:05 +08:00
blockDb := MakeBlockDatabase ( ctx , stack , readonly , false )
chainDb . SetBlockStore ( blockDb )
2024-03-08 16:07:29 +08:00
}
2017-05-03 13:35:47 +03:00
}
2016-03-01 23:32:43 +01:00
if err != nil {
2017-02-22 17:22:50 +02:00
Fatalf ( "Could not open database: %v" , err )
2015-04-13 10:13:52 +02:00
}
2016-03-01 23:32:43 +01:00
return chainDb
}
2024-03-08 16:07:29 +08:00
// MakeStateDataBase open a separate state database using the flags passed to the client and will hard crash if it fails.
func MakeStateDataBase ( ctx * cli . Context , stack * node . Node , readonly , disableFreeze bool ) ethdb . Database {
cache := ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheDatabaseFlag . Name ) / 100
2024-04-18 15:12:05 +08:00
handles := MakeDatabaseHandles ( ctx . Int ( FDLimitFlag . Name ) ) * 90 / 100
2024-03-08 16:07:29 +08:00
statediskdb , err := stack . OpenDatabaseWithFreezer ( "chaindata/state" , cache , handles , "" , "" , readonly , disableFreeze , false , false )
if err != nil {
Fatalf ( "Failed to open separate trie database: %v" , err )
}
return statediskdb
}
2024-04-18 15:12:05 +08:00
// MakeBlockDatabase open a separate block database using the flags passed to the client and will hard crash if it fails.
func MakeBlockDatabase ( ctx * cli . Context , stack * node . Node , readonly , disableFreeze bool ) ethdb . Database {
cache := ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheDatabaseFlag . Name ) / 100
handles := MakeDatabaseHandles ( ctx . Int ( FDLimitFlag . Name ) ) / 10
blockDb , err := stack . OpenDatabaseWithFreezer ( "chaindata/block" , cache , handles , "" , "" , readonly , disableFreeze , false , false )
if err != nil {
Fatalf ( "Failed to open separate block database: %v" , err )
}
return blockDb
}
2024-04-28 11:02:14 +08:00
func PathDBConfigAddJournalFilePath ( stack * node . Node , config * pathdb . Config ) * pathdb . Config {
path := fmt . Sprintf ( "%s/%s" , stack . ResolvePath ( "chaindata" ) , eth . JournalFileName )
config . JournalFilePath = path
return config
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
// tryMakeReadOnlyDatabase try to open the chain database in read-only mode,
// or fallback to write mode if the database is not initialized.
2024-01-12 15:36:26 +08:00
//
//nolint:unused
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
func tryMakeReadOnlyDatabase ( ctx * cli . Context , stack * node . Node ) ethdb . Database {
// If datadir doesn't exist we need to open db in write-mode
// so database engine can create files.
readonly := true
2023-11-14 20:10:41 +08:00
if ! common . FileExist ( stack . ResolvePath ( "chaindata" ) ) || ctx . Bool ( PruneAncientDataFlag . Name ) {
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
readonly = false
}
return MakeChainDatabase ( ctx , stack , readonly , false )
}
2022-09-26 05:55:18 -06:00
func IsNetworkPreset ( ctx * cli . Context ) bool {
for _ , flag := range NetworkFlags {
bFlag , _ := flag . ( * cli . BoolFlag )
if ctx . IsSet ( bFlag . Name ) {
return true
}
}
return false
}
2022-09-30 13:50:25 +02:00
func DialRPCWithHeaders ( endpoint string , headers [ ] string ) ( * rpc . Client , error ) {
if endpoint == "" {
return nil , errors . New ( "endpoint must be specified" )
}
if strings . HasPrefix ( endpoint , "rpc:" ) || strings . HasPrefix ( endpoint , "ipc:" ) {
// Backwards compatibility with geth < 1.5 which required
// these prefixes.
endpoint = endpoint [ 4 : ]
}
var opts [ ] rpc . ClientOption
if len ( headers ) > 0 {
2023-09-20 03:20:18 +08:00
customHeaders := make ( http . Header )
2022-09-30 13:50:25 +02:00
for _ , h := range headers {
kv := strings . Split ( h , ":" )
if len ( kv ) != 2 {
return nil , fmt . Errorf ( "invalid http header directive: %q" , h )
}
customHeaders . Add ( kv [ 0 ] , kv [ 1 ] )
}
opts = append ( opts , rpc . WithHeaders ( customHeaders ) )
}
return rpc . DialOptions ( context . Background ( ) , endpoint , opts ... )
}
2017-03-02 14:03:33 +01:00
func MakeGenesis ( ctx * cli . Context ) * core . Genesis {
var genesis * core . Genesis
switch {
2023-11-29 15:04:50 +08:00
case ctx . Bool ( BSCMainnetFlag . Name ) :
genesis = core . DefaultBSCGenesisBlock ( )
2023-12-25 10:58:52 +08:00
case ctx . Bool ( ChapelFlag . Name ) :
genesis = core . DefaultChapelGenesisBlock ( )
2022-06-27 18:22:36 +02:00
case ctx . Bool ( DeveloperFlag . Name ) :
2017-10-24 13:40:42 +03:00
Fatalf ( "Developer chains are ephemeral" )
2017-03-02 14:03:33 +01:00
}
return genesis
}
2016-03-01 23:32:43 +01:00
// MakeChain creates a chain manager from set command line flags.
2022-10-19 08:20:39 +02:00
func MakeChain ( ctx * cli . Context , stack * node . Node , readonly bool ) ( * core . BlockChain , ethdb . Database ) {
2022-08-31 00:22:28 +08:00
var (
gspec = MakeGenesis ( ctx )
2023-08-23 17:46:08 +08:00
chainDb = MakeChainDatabase ( ctx , stack , readonly , false )
2022-08-31 00:22:28 +08:00
)
2023-08-23 17:46:08 +08:00
config , genesisHash , err := core . LoadChainConfig ( chainDb , gspec )
2017-03-02 14:03:33 +01:00
if err != nil {
Fatalf ( "%v" , err )
}
2023-08-23 17:46:08 +08:00
engine , err := ethconfig . CreateConsensusEngine ( config , chainDb , nil , genesisHash )
2023-05-03 12:58:39 +03:00
if err != nil {
Fatalf ( "%v" , err )
2017-10-10 15:51:09 +03:00
}
2022-06-27 18:22:36 +02:00
if gcmode := ctx . String ( GCModeFlag . Name ) ; gcmode != "full" && gcmode != "archive" {
2018-02-05 18:40:32 +02:00
Fatalf ( "--%s must be either 'full' or 'archive'" , GCModeFlag . Name )
}
2024-02-20 17:22:27 +08:00
scheme , err := rawdb . ParseStateScheme ( ctx . String ( StateSchemeFlag . Name ) , chainDb )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
if err != nil {
Fatalf ( "%v" , err )
}
2018-02-05 18:40:32 +02:00
cache := & core . CacheConfig {
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
TrieCleanLimit : ethconfig . Defaults . TrieCleanCache ,
TrieCleanNoPrefetch : ctx . Bool ( CacheNoPrefetchFlag . Name ) ,
TrieDirtyLimit : ethconfig . Defaults . TrieDirtyCache ,
TrieDirtyDisabled : ctx . String ( GCModeFlag . Name ) == "archive" ,
TrieTimeLimit : ethconfig . Defaults . TrieTimeout ,
TriesInMemory : ethconfig . Defaults . TriesInMemory ,
SnapshotLimit : ethconfig . Defaults . SnapshotCache ,
Preimages : ctx . Bool ( CachePreimagesFlag . Name ) ,
StateScheme : scheme ,
StateHistory : ctx . Uint64 ( StateHistoryFlag . Name ) ,
2018-11-12 18:47:34 +02:00
}
2020-11-18 17:51:33 +08:00
if cache . TrieDirtyDisabled && ! cache . Preimages {
cache . Preimages = true
log . Info ( "Enabling recording of key preimages since archive mode is used" )
2018-11-12 18:47:34 +02:00
}
2022-06-27 18:22:36 +02:00
if ! ctx . Bool ( SnapshotFlag . Name ) {
2020-01-19 20:57:56 +01:00
cache . SnapshotLimit = 0 // Disabled
}
2022-10-19 08:20:39 +02:00
// If we're in readonly, do not bother generating snapshot data.
if readonly {
cache . SnapshotNoBuild = true
}
2022-09-24 02:20:36 +08:00
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheTrieFlag . Name ) {
cache . TrieCleanLimit = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheTrieFlag . Name ) / 100
2018-02-05 18:40:32 +02:00
}
2022-06-27 18:22:36 +02:00
if ctx . IsSet ( CacheFlag . Name ) || ctx . IsSet ( CacheGCFlag . Name ) {
cache . TrieDirtyLimit = ctx . Int ( CacheFlag . Name ) * ctx . Int ( CacheGCFlag . Name ) / 100
2018-02-05 18:40:32 +02:00
}
2023-08-23 17:46:08 +08:00
if ctx . IsSet ( TriesInMemoryFlag . Name ) {
cache . TriesInMemory = ctx . Uint64 ( TriesInMemoryFlag . Name )
2022-07-05 11:14:21 +08:00
}
2022-06-27 18:22:36 +02:00
vmcfg := vm . Config { EnablePreimageRecording : ctx . Bool ( VMEnableDebugFlag . Name ) }
2021-03-23 02:06:30 +08:00
// Disable transaction indexing/unindexing by default.
2022-08-31 00:22:28 +08:00
chain , err := core . NewBlockChain ( chainDb , cache , gspec , nil , engine , vmcfg , nil , nil )
2015-06-08 12:12:13 +02:00
if err != nil {
2017-03-02 14:03:33 +01:00
Fatalf ( "Can't create BlockChain: %v" , err )
2015-06-08 12:12:13 +02:00
}
2015-08-06 19:57:39 +02:00
return chain , chainDb
2015-03-06 03:00:41 +01:00
}
2016-05-06 12:40:23 +03:00
// 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
2022-06-27 18:22:36 +02:00
if ctx . String ( PreloadJSFlag . Name ) == "" {
2016-05-06 12:40:23 +03:00
return nil
}
// Otherwise resolve absolute paths and return them
2019-02-14 15:02:11 -08:00
var preloads [ ] string
2016-05-06 12:40:23 +03:00
2022-06-27 18:22:36 +02:00
for _ , file := range strings . Split ( ctx . String ( PreloadJSFlag . Name ) , "," ) {
2021-01-12 08:50:11 -06:00
preloads = append ( preloads , strings . TrimSpace ( file ) )
2016-05-06 12:40:23 +03:00
}
return preloads
}
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
// MakeTrieDatabase constructs a trie database based on the configured scheme.
2024-04-28 11:02:14 +08:00
func MakeTrieDatabase ( ctx * cli . Context , stack * node . Node , disk ethdb . Database , preimage bool , readOnly bool , isVerkle bool ) * triedb . Database {
2024-02-13 21:49:53 +08:00
config := & triedb . Config {
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
Preimages : preimage ,
2023-11-14 13:09:40 +01:00
IsVerkle : isVerkle ,
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
2024-02-20 17:22:27 +08:00
scheme , err := rawdb . ParseStateScheme ( ctx . String ( StateSchemeFlag . Name ) , disk )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
if err != nil {
Fatalf ( "%v" , err )
}
if scheme == rawdb . HashScheme {
// Read-only mode is not implemented in hash mode,
// ignore the parameter silently. TODO(rjl493456442)
// please config it if read mode is implemented.
config . HashDB = hashdb . Defaults
2024-02-13 21:49:53 +08:00
return triedb . NewDatabase ( disk , config )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
if readOnly {
config . PathDB = pathdb . ReadOnly
} else {
config . PathDB = pathdb . Defaults
}
2024-04-28 11:02:14 +08:00
config . PathDB . JournalFilePath = fmt . Sprintf ( "%s/%s" , stack . ResolvePath ( "chaindata" ) , eth . JournalFileName )
2024-02-13 21:49:53 +08:00
return triedb . NewDatabase ( disk , config )
all: activate pbss as experimental feature from eth (#26274)
* all: activate pbss
* core/rawdb: fix compilation error
* cma, core, eth, les, trie: address comments
* cmd, core, eth, trie: polish code
* core, cmd, eth: address comments
* cmd, core, eth, les, light, tests: address comment
* cmd/utils: shorten log message
* trie/triedb/pathdb: limit node buffer size to 1gb
* cmd/utils: fix opening non-existing db
* cmd/utils: rename flag name
* cmd, core: group chain history flags and fix tests
* core, eth, trie: fix memory leak in snapshot generation
* cmd, eth, internal: deprecate flags
* all: enable state tests for pathdb, fixes
* cmd, core: polish code
* trie/triedb/pathdb: limit the node buffer size to 256mb
---------
Co-authored-by: Martin Holst Swende <martin@swende.se>
Co-authored-by: Péter Szilágyi <peterke@gmail.com>
2023-08-11 03:21:36 +08:00
}
2023-12-18 15:34:58 +08:00
2024-02-20 17:22:27 +08:00
// ParseCLIAndConfigStateScheme parses state scheme in CLI and config.
func ParseCLIAndConfigStateScheme ( cliScheme , cfgScheme string ) ( string , error ) {
if cliScheme == "" {
2024-01-03 15:38:39 +08:00
if cfgScheme != "" {
log . Info ( "Use config state scheme" , "config" , cfgScheme )
}
return cfgScheme , nil
}
if ! rawdb . ValidateStateScheme ( cliScheme ) {
return "" , fmt . Errorf ( "invalid state scheme in CLI: %s" , cliScheme )
}
if cfgScheme == "" || cliScheme == cfgScheme {
log . Info ( "Use CLI state scheme" , "CLI" , cliScheme )
return cliScheme , nil
}
return "" , fmt . Errorf ( "incompatible state scheme, CLI: %s, config: %s" , cliScheme , cfgScheme )
}
2024-03-21 13:06:48 +08:00
// setInstance configures the port numbers for the given instance.
func setInstance ( ctx * cli . Context , cfg * node . Config ) {
if ctx . IsSet ( InstanceFlag . Name ) {
cfg . Instance = ctx . Int ( InstanceFlag . Name )
}
if cfg . Instance > 200 {
Fatalf ( "Instance number %d is too high, maximum is 200" , cfg . Instance )
}
if cfg . Instance == 1 { // using default ports
return
}
cfg . AuthPort = node . DefaultConfig . AuthPort + cfg . Instance * 100 - 100
cfg . HTTPPort = node . DefaultHTTPPort - cfg . Instance + 1
cfg . WSPort = node . DefaultWSPort + cfg . Instance * 2 - 2
cfg . P2P . ListenAddr = fmt . Sprintf ( ":%d" , node . DefaultListenPort + cfg . Instance - 1 )
cfg . P2P . DiscAddr = fmt . Sprintf ( ":%d" , node . DefaultDiscPort + cfg . Instance - 1 )
}