Merge pull request #419 from cffls/v0.3.0-dev-flags

CLI improvements
This commit is contained in:
Jerry 2022-06-06 20:00:31 -07:00 committed by GitHub
commit 8808c231df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 481 additions and 298 deletions

View file

@ -9,6 +9,7 @@ import (
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core"
"github.com/ethereum/go-ethereum/log"
)
type Chain struct {
@ -59,5 +60,19 @@ func importChain(content []byte) (*Chain, error) {
return nil, err
}
if chain.Genesis == nil {
log.Info("Try reading as legacy genesis")
var genesis core.Genesis
if err := json.Unmarshal(content, &genesis); err != nil {
return nil, err
}
if genesis.Config != nil {
chain.Genesis = &genesis
chain.NetworkId = genesis.Config.ChainID.Uint64()
} else {
return nil, fmt.Errorf("unable to parse chain config")
}
}
return chain, nil
}

View file

@ -18,6 +18,16 @@ func TestChain_ImportFromFile(t *testing.T) {
args: args{filename: "test_files/chain_test.json"},
wantErr: false,
},
{
name: "ImportFromFile correct legacy json file",
args: args{filename: "test_files/chain_legacy_test.json"},
wantErr: false,
},
{
name: "ImportFromFile wrong json file",
args: args{filename: "test_files/wrong_chain.json"},
wantErr: true,
},
{
name: "ImportFromFile nonexistent json file",
args: args{filename: "test_files/chain_test_nonexistent.json"},

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1 @@
{}

View file

@ -935,9 +935,15 @@ func (c *Config) buildNode() (*node.Config, error) {
if cfg.P2P.StaticNodes, err = parseBootnodes(c.P2P.Discovery.StaticNodes); err != nil {
return nil, err
}
if len(cfg.P2P.StaticNodes) == 0 {
cfg.P2P.StaticNodes = cfg.StaticNodes()
}
if cfg.P2P.TrustedNodes, err = parseBootnodes(c.P2P.Discovery.TrustedNodes); err != nil {
return nil, err
}
if len(cfg.P2P.TrustedNodes) == 0 {
cfg.P2P.TrustedNodes = cfg.TrustedNodes()
}
}
if c.P2P.NoDiscover {
@ -950,14 +956,9 @@ func (c *Config) buildNode() (*node.Config, error) {
func (c *Config) Merge(cc ...*Config) error {
for _, elem := range cc {
if err := mergo.Merge(c, elem, mergo.WithOverride, mergo.WithAppendSlice); err != nil {
if err := mergo.Merge(c, elem, mergo.WithOverwriteWithEmptyValue, mergo.WithAppendSlice); err != nil {
return fmt.Errorf("failed to merge configurations: %v", err)
}
// override max peers
if elem.P2P.MaxPeers == 0 {
c.P2P.MaxPeers = 0
}
}
return nil
}

View file

@ -54,14 +54,11 @@ func TestConfigMerge(t *testing.T) {
}
expected := &Config{
Chain: "1",
NoSnapshot: true,
NoSnapshot: false,
RequiredBlocks: map[string]string{
"a": "b",
"b": "c",
},
TxPool: &TxPoolConfig{
LifeTime: 5 * time.Second,
},
P2P: &P2PConfig{
MaxPeers: 10,
Discovery: &P2PDiscovery{

View file

@ -10,24 +10,28 @@ func (c *Command) Flags() *flagset.Flagset {
f := flagset.NewFlagSet("server")
f.StringFlag(&flagset.StringFlag{
Name: "chain",
Usage: "Name of the chain to sync",
Value: &c.cliConfig.Chain,
Name: "chain",
Usage: "Name of the chain to sync",
Value: &c.cliConfig.Chain,
Default: c.cliConfig.Chain,
})
f.StringFlag(&flagset.StringFlag{
Name: "name",
Usage: "Name/Identity of the node",
Value: &c.cliConfig.Name,
Name: "name",
Usage: "Name/Identity of the node",
Value: &c.cliConfig.Name,
Default: c.cliConfig.Name,
})
f.StringFlag(&flagset.StringFlag{
Name: "log-level",
Usage: "Set log level for the server",
Value: &c.cliConfig.LogLevel,
Name: "log-level",
Usage: "Set log level for the server",
Value: &c.cliConfig.LogLevel,
Default: c.cliConfig.LogLevel,
})
f.StringFlag(&flagset.StringFlag{
Name: "datadir",
Usage: "Path of the data directory to store information",
Value: &c.cliConfig.DataDir,
Name: "datadir",
Usage: "Path of the data directory to store information",
Value: &c.cliConfig.DataDir,
Default: c.cliConfig.DataDir,
})
f.SliceStringFlag(&flagset.SliceStringFlag{
Name: "config",
@ -35,14 +39,16 @@ func (c *Command) Flags() *flagset.Flagset {
Value: &c.configFile,
})
f.StringFlag(&flagset.StringFlag{
Name: "syncmode",
Usage: `Blockchain sync mode ("fast", "full", or "snap")`,
Value: &c.cliConfig.SyncMode,
Name: "syncmode",
Usage: `Blockchain sync mode ("fast", "full", or "snap")`,
Value: &c.cliConfig.SyncMode,
Default: c.cliConfig.SyncMode,
})
f.StringFlag(&flagset.StringFlag{
Name: "gcmode",
Usage: `Blockchain garbage collection mode ("full", "archive")`,
Value: &c.cliConfig.GcMode,
Name: "gcmode",
Usage: `Blockchain garbage collection mode ("full", "archive")`,
Value: &c.cliConfig.GcMode,
Default: c.cliConfig.GcMode,
})
f.MapStringFlag(&flagset.MapStringFlag{
Name: "requiredblocks",
@ -50,21 +56,24 @@ func (c *Command) Flags() *flagset.Flagset {
Value: &c.cliConfig.RequiredBlocks,
})
f.BoolFlag(&flagset.BoolFlag{
Name: "no-snapshot",
Usage: `Disables the snapshot-database mode (default = false)`,
Value: &c.cliConfig.NoSnapshot,
Name: "no-snapshot",
Usage: `Disables the snapshot-database mode (default = false)`,
Value: &c.cliConfig.NoSnapshot,
Default: c.cliConfig.NoSnapshot,
})
// heimdall
f.StringFlag(&flagset.StringFlag{
Name: "bor.heimdall",
Usage: "URL of Heimdall service",
Value: &c.cliConfig.Heimdall.URL,
Name: "bor.heimdall",
Usage: "URL of Heimdall service",
Value: &c.cliConfig.Heimdall.URL,
Default: c.cliConfig.Heimdall.URL,
})
f.BoolFlag(&flagset.BoolFlag{
Name: "bor.withoutheimdall",
Usage: "Run without Heimdall service (for testing purpose)",
Value: &c.cliConfig.Heimdall.Without,
Name: "bor.withoutheimdall",
Usage: "Run without Heimdall service (for testing purpose)",
Value: &c.cliConfig.Heimdall.Without,
Default: c.cliConfig.Heimdall.Without,
})
// txpool options
@ -75,90 +84,104 @@ func (c *Command) Flags() *flagset.Flagset {
Group: "Transaction Pool",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "txpool.nolocals",
Usage: "Disables price exemptions for locally submitted transactions",
Value: &c.cliConfig.TxPool.NoLocals,
Group: "Transaction Pool",
Name: "txpool.nolocals",
Usage: "Disables price exemptions for locally submitted transactions",
Value: &c.cliConfig.TxPool.NoLocals,
Default: c.cliConfig.TxPool.NoLocals,
Group: "Transaction Pool",
})
f.StringFlag(&flagset.StringFlag{
Name: "txpool.journal",
Usage: "Disk journal for local transaction to survive node restarts",
Value: &c.cliConfig.TxPool.Journal,
Group: "Transaction Pool",
Name: "txpool.journal",
Usage: "Disk journal for local transaction to survive node restarts",
Value: &c.cliConfig.TxPool.Journal,
Default: c.cliConfig.TxPool.Journal,
Group: "Transaction Pool",
})
f.DurationFlag(&flagset.DurationFlag{
Name: "txpool.rejournal",
Usage: "Time interval to regenerate the local transaction journal",
Value: &c.cliConfig.TxPool.Rejournal,
Group: "Transaction Pool",
Name: "txpool.rejournal",
Usage: "Time interval to regenerate the local transaction journal",
Value: &c.cliConfig.TxPool.Rejournal,
Default: c.cliConfig.TxPool.Rejournal,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.pricelimit",
Usage: "Minimum gas price limit to enforce for acceptance into the pool",
Value: &c.cliConfig.TxPool.PriceLimit,
Group: "Transaction Pool",
Name: "txpool.pricelimit",
Usage: "Minimum gas price limit to enforce for acceptance into the pool",
Value: &c.cliConfig.TxPool.PriceLimit,
Default: c.cliConfig.TxPool.PriceLimit,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.pricebump",
Usage: "Price bump percentage to replace an already existing transaction",
Value: &c.cliConfig.TxPool.PriceBump,
Group: "Transaction Pool",
Name: "txpool.pricebump",
Usage: "Price bump percentage to replace an already existing transaction",
Value: &c.cliConfig.TxPool.PriceBump,
Default: c.cliConfig.TxPool.PriceBump,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.accountslots",
Usage: "Minimum number of executable transaction slots guaranteed per account",
Value: &c.cliConfig.TxPool.AccountSlots,
Group: "Transaction Pool",
Name: "txpool.accountslots",
Usage: "Minimum number of executable transaction slots guaranteed per account",
Value: &c.cliConfig.TxPool.AccountSlots,
Default: c.cliConfig.TxPool.AccountSlots,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.globalslots",
Usage: "Maximum number of executable transaction slots for all accounts",
Value: &c.cliConfig.TxPool.GlobalSlots,
Group: "Transaction Pool",
Name: "txpool.globalslots",
Usage: "Maximum number of executable transaction slots for all accounts",
Value: &c.cliConfig.TxPool.GlobalSlots,
Default: c.cliConfig.TxPool.GlobalSlots,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.accountqueue",
Usage: "Maximum number of non-executable transaction slots permitted per account",
Value: &c.cliConfig.TxPool.AccountQueue,
Group: "Transaction Pool",
Name: "txpool.accountqueue",
Usage: "Maximum number of non-executable transaction slots permitted per account",
Value: &c.cliConfig.TxPool.AccountQueue,
Default: c.cliConfig.TxPool.AccountQueue,
Group: "Transaction Pool",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txpool.globalqueue",
Usage: "Maximum number of non-executable transaction slots for all accounts",
Value: &c.cliConfig.TxPool.GlobalQueue,
Group: "Transaction Pool",
Name: "txpool.globalqueue",
Usage: "Maximum number of non-executable transaction slots for all accounts",
Value: &c.cliConfig.TxPool.GlobalQueue,
Default: c.cliConfig.TxPool.GlobalQueue,
Group: "Transaction Pool",
})
f.DurationFlag(&flagset.DurationFlag{
Name: "txpool.lifetime",
Usage: "Maximum amount of time non-executable transaction are queued",
Value: &c.cliConfig.TxPool.LifeTime,
Group: "Transaction Pool",
Name: "txpool.lifetime",
Usage: "Maximum amount of time non-executable transaction are queued",
Value: &c.cliConfig.TxPool.LifeTime,
Default: c.cliConfig.TxPool.LifeTime,
Group: "Transaction Pool",
})
// sealer options
f.BoolFlag(&flagset.BoolFlag{
Name: "mine",
Usage: "Enable mining",
Value: &c.cliConfig.Sealer.Enabled,
Group: "Sealer",
Name: "mine",
Usage: "Enable mining",
Value: &c.cliConfig.Sealer.Enabled,
Default: c.cliConfig.Sealer.Enabled,
Group: "Sealer",
})
f.StringFlag(&flagset.StringFlag{
Name: "miner.etherbase",
Usage: "Public address for block mining rewards (default = first account)",
Value: &c.cliConfig.Sealer.Etherbase,
Group: "Sealer",
Name: "miner.etherbase",
Usage: "Public address for block mining rewards (default = first account)",
Value: &c.cliConfig.Sealer.Etherbase,
Default: c.cliConfig.Sealer.Etherbase,
Group: "Sealer",
})
f.StringFlag(&flagset.StringFlag{
Name: "miner.extradata",
Usage: "Block extra data set by the miner (default = client version)",
Value: &c.cliConfig.Sealer.ExtraData,
Group: "Sealer",
Name: "miner.extradata",
Usage: "Block extra data set by the miner (default = client version)",
Value: &c.cliConfig.Sealer.ExtraData,
Default: c.cliConfig.Sealer.ExtraData,
Group: "Sealer",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "miner.gaslimit",
Usage: "Target gas ceiling for mined blocks",
Value: &c.cliConfig.Sealer.GasCeil,
Group: "Sealer",
Name: "miner.gaslimit",
Usage: "Target gas ceiling for mined blocks",
Value: &c.cliConfig.Sealer.GasCeil,
Default: c.cliConfig.Sealer.GasCeil,
Group: "Sealer",
})
f.BigIntFlag(&flagset.BigIntFlag{
Name: "miner.gasprice",
@ -169,21 +192,24 @@ func (c *Command) Flags() *flagset.Flagset {
// ethstats
f.StringFlag(&flagset.StringFlag{
Name: "ethstats",
Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
Value: &c.cliConfig.Ethstats,
Name: "ethstats",
Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)",
Value: &c.cliConfig.Ethstats,
Default: c.cliConfig.Ethstats,
})
// gas price oracle
f.Uint64Flag(&flagset.Uint64Flag{
Name: "gpo.blocks",
Usage: "Number of recent blocks to check for gas prices",
Value: &c.cliConfig.Gpo.Blocks,
Name: "gpo.blocks",
Usage: "Number of recent blocks to check for gas prices",
Value: &c.cliConfig.Gpo.Blocks,
Default: c.cliConfig.Gpo.Blocks,
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "gpo.percentile",
Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
Value: &c.cliConfig.Gpo.Percentile,
Name: "gpo.percentile",
Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
Value: &c.cliConfig.Gpo.Percentile,
Default: c.cliConfig.Gpo.Percentile,
})
f.BigIntFlag(&flagset.BigIntFlag{
Name: "gpo.maxprice",
@ -198,90 +224,104 @@ func (c *Command) Flags() *flagset.Flagset {
// cache options
f.Uint64Flag(&flagset.Uint64Flag{
Name: "cache",
Usage: "Megabytes of memory allocated to internal caching (default = 4096 mainnet full node)",
Value: &c.cliConfig.Cache.Cache,
Group: "Cache",
Name: "cache",
Usage: "Megabytes of memory allocated to internal caching (default = 4096 mainnet full node)",
Value: &c.cliConfig.Cache.Cache,
Default: c.cliConfig.Cache.Cache,
Group: "Cache",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "cache.database",
Usage: "Percentage of cache memory allowance to use for database io",
Value: &c.cliConfig.Cache.PercDatabase,
Group: "Cache",
Name: "cache.database",
Usage: "Percentage of cache memory allowance to use for database io",
Value: &c.cliConfig.Cache.PercDatabase,
Default: c.cliConfig.Cache.PercDatabase,
Group: "Cache",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "cache.trie",
Usage: "Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode)",
Value: &c.cliConfig.Cache.PercTrie,
Group: "Cache",
Name: "cache.trie",
Usage: "Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode)",
Value: &c.cliConfig.Cache.PercTrie,
Default: c.cliConfig.Cache.PercTrie,
Group: "Cache",
})
f.StringFlag(&flagset.StringFlag{
Name: "cache.trie.journal",
Usage: "Disk journal directory for trie cache to survive node restarts",
Value: &c.cliConfig.Cache.Journal,
Group: "Cache",
Name: "cache.trie.journal",
Usage: "Disk journal directory for trie cache to survive node restarts",
Value: &c.cliConfig.Cache.Journal,
Default: c.cliConfig.Cache.Journal,
Group: "Cache",
})
f.DurationFlag(&flagset.DurationFlag{
Name: "cache.trie.rejournal",
Usage: "Time interval to regenerate the trie cache journal",
Value: &c.cliConfig.Cache.Rejournal,
Group: "Cache",
Name: "cache.trie.rejournal",
Usage: "Time interval to regenerate the trie cache journal",
Value: &c.cliConfig.Cache.Rejournal,
Default: c.cliConfig.Cache.Rejournal,
Group: "Cache",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "cache.gc",
Usage: "Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode)",
Value: &c.cliConfig.Cache.PercGc,
Group: "Cache",
Name: "cache.gc",
Usage: "Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode)",
Value: &c.cliConfig.Cache.PercGc,
Default: c.cliConfig.Cache.PercGc,
Group: "Cache",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "cache.snapshot",
Usage: "Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode)",
Value: &c.cliConfig.Cache.PercSnapshot,
Group: "Cache",
Name: "cache.snapshot",
Usage: "Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode)",
Value: &c.cliConfig.Cache.PercSnapshot,
Default: c.cliConfig.Cache.PercSnapshot,
Group: "Cache",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "cache.noprefetch",
Usage: "Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)",
Value: &c.cliConfig.Cache.NoPrefetch,
Group: "Cache",
Name: "cache.noprefetch",
Usage: "Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data)",
Value: &c.cliConfig.Cache.NoPrefetch,
Default: c.cliConfig.Cache.NoPrefetch,
Group: "Cache",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "cache.preimages",
Usage: "Enable recording the SHA3/keccak preimages of trie keys",
Value: &c.cliConfig.Cache.Preimages,
Group: "Cache",
Name: "cache.preimages",
Usage: "Enable recording the SHA3/keccak preimages of trie keys",
Value: &c.cliConfig.Cache.Preimages,
Default: c.cliConfig.Cache.Preimages,
Group: "Cache",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "txlookuplimit",
Usage: "Number of recent blocks to maintain transactions index for (default = about 56 days, 0 = entire chain)",
Value: &c.cliConfig.Cache.TxLookupLimit,
Group: "Cache",
Name: "txlookuplimit",
Usage: "Number of recent blocks to maintain transactions index for (default = about 56 days, 0 = entire chain)",
Value: &c.cliConfig.Cache.TxLookupLimit,
Default: c.cliConfig.Cache.TxLookupLimit,
Group: "Cache",
})
// rpc options
f.Uint64Flag(&flagset.Uint64Flag{
Name: "rpc.gascap",
Usage: "Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)",
Value: &c.cliConfig.JsonRPC.GasCap,
Group: "JsonRPC",
Name: "rpc.gascap",
Usage: "Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)",
Value: &c.cliConfig.JsonRPC.GasCap,
Default: c.cliConfig.JsonRPC.GasCap,
Group: "JsonRPC",
})
f.Float64Flag(&flagset.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: &c.cliConfig.JsonRPC.TxFeeCap,
Group: "JsonRPC",
Name: "rpc.txfeecap",
Usage: "Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap)",
Value: &c.cliConfig.JsonRPC.TxFeeCap,
Default: c.cliConfig.JsonRPC.TxFeeCap,
Group: "JsonRPC",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "ipcdisable",
Usage: "Disable the IPC-RPC server",
Value: &c.cliConfig.JsonRPC.IPCDisable,
Group: "JsonRPC",
Name: "ipcdisable",
Usage: "Disable the IPC-RPC server",
Value: &c.cliConfig.JsonRPC.IPCDisable,
Default: c.cliConfig.JsonRPC.IPCDisable,
Group: "JsonRPC",
})
f.StringFlag(&flagset.StringFlag{
Name: "ipcpath",
Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
Value: &c.cliConfig.JsonRPC.IPCPath,
Group: "JsonRPC",
Name: "ipcpath",
Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
Value: &c.cliConfig.JsonRPC.IPCPath,
Default: c.cliConfig.JsonRPC.IPCPath,
Group: "JsonRPC",
})
f.SliceStringFlag(&flagset.SliceStringFlag{
Name: "jsonrpc.corsdomain",
@ -298,28 +338,32 @@ func (c *Command) Flags() *flagset.Flagset {
// http options
f.BoolFlag(&flagset.BoolFlag{
Name: "http",
Usage: "Enable the HTTP-RPC server",
Value: &c.cliConfig.JsonRPC.Http.Enabled,
Group: "JsonRPC",
Name: "http",
Usage: "Enable the HTTP-RPC server",
Value: &c.cliConfig.JsonRPC.Http.Enabled,
Default: c.cliConfig.JsonRPC.Http.Enabled,
Group: "JsonRPC",
})
f.StringFlag(&flagset.StringFlag{
Name: "http.addr",
Usage: "HTTP-RPC server listening interface",
Value: &c.cliConfig.JsonRPC.Http.Host,
Group: "JsonRPC",
Name: "http.addr",
Usage: "HTTP-RPC server listening interface",
Value: &c.cliConfig.JsonRPC.Http.Host,
Default: c.cliConfig.JsonRPC.Http.Host,
Group: "JsonRPC",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "http.port",
Usage: "HTTP-RPC server listening port",
Value: &c.cliConfig.JsonRPC.Http.Port,
Group: "JsonRPC",
Name: "http.port",
Usage: "HTTP-RPC server listening port",
Value: &c.cliConfig.JsonRPC.Http.Port,
Default: c.cliConfig.JsonRPC.Http.Port,
Group: "JsonRPC",
})
f.StringFlag(&flagset.StringFlag{
Name: "http.rpcprefix",
Usage: "HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
Value: &c.cliConfig.JsonRPC.Http.Prefix,
Group: "JsonRPC",
Name: "http.rpcprefix",
Usage: "HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
Value: &c.cliConfig.JsonRPC.Http.Prefix,
Default: c.cliConfig.JsonRPC.Http.Prefix,
Group: "JsonRPC",
})
f.SliceStringFlag(&flagset.SliceStringFlag{
Name: "http.modules",
@ -330,28 +374,32 @@ func (c *Command) Flags() *flagset.Flagset {
// ws options
f.BoolFlag(&flagset.BoolFlag{
Name: "ws",
Usage: "Enable the WS-RPC server",
Value: &c.cliConfig.JsonRPC.Ws.Enabled,
Group: "JsonRPC",
Name: "ws",
Usage: "Enable the WS-RPC server",
Value: &c.cliConfig.JsonRPC.Ws.Enabled,
Default: c.cliConfig.JsonRPC.Ws.Enabled,
Group: "JsonRPC",
})
f.StringFlag(&flagset.StringFlag{
Name: "ws.addr",
Usage: "WS-RPC server listening interface",
Value: &c.cliConfig.JsonRPC.Ws.Host,
Group: "JsonRPC",
Name: "ws.addr",
Usage: "WS-RPC server listening interface",
Value: &c.cliConfig.JsonRPC.Ws.Host,
Default: c.cliConfig.JsonRPC.Ws.Host,
Group: "JsonRPC",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "ws.port",
Usage: "WS-RPC server listening port",
Value: &c.cliConfig.JsonRPC.Ws.Port,
Group: "JsonRPC",
Name: "ws.port",
Usage: "WS-RPC server listening port",
Value: &c.cliConfig.JsonRPC.Ws.Port,
Default: c.cliConfig.JsonRPC.Ws.Port,
Group: "JsonRPC",
})
f.StringFlag(&flagset.StringFlag{
Name: "ws.rpcprefix",
Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
Value: &c.cliConfig.JsonRPC.Ws.Prefix,
Group: "JsonRPC",
Name: "ws.rpcprefix",
Usage: "HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.",
Value: &c.cliConfig.JsonRPC.Ws.Prefix,
Default: c.cliConfig.JsonRPC.Ws.Prefix,
Group: "JsonRPC",
})
f.SliceStringFlag(&flagset.SliceStringFlag{
Name: "ws.modules",
@ -362,24 +410,27 @@ func (c *Command) Flags() *flagset.Flagset {
// graphql options
f.BoolFlag(&flagset.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.",
Value: &c.cliConfig.JsonRPC.Graphql.Enabled,
Group: "JsonRPC",
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.",
Value: &c.cliConfig.JsonRPC.Graphql.Enabled,
Default: c.cliConfig.JsonRPC.Graphql.Enabled,
Group: "JsonRPC",
})
// p2p options
f.StringFlag(&flagset.StringFlag{
Name: "bind",
Usage: "Network binding address",
Value: &c.cliConfig.P2P.Bind,
Group: "P2P",
Name: "bind",
Usage: "Network binding address",
Value: &c.cliConfig.P2P.Bind,
Default: c.cliConfig.P2P.Bind,
Group: "P2P",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "port",
Usage: "Network listening port",
Value: &c.cliConfig.P2P.Port,
Group: "P2P",
Name: "port",
Usage: "Network listening port",
Value: &c.cliConfig.P2P.Port,
Default: c.cliConfig.P2P.Port,
Group: "P2P",
})
f.SliceStringFlag(&flagset.SliceStringFlag{
Name: "bootnodes",
@ -388,78 +439,90 @@ func (c *Command) Flags() *flagset.Flagset {
Group: "P2P",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "maxpeers",
Usage: "Maximum number of network peers (network disabled if set to 0)",
Value: &c.cliConfig.P2P.MaxPeers,
Group: "P2P",
Name: "maxpeers",
Usage: "Maximum number of network peers (network disabled if set to 0)",
Value: &c.cliConfig.P2P.MaxPeers,
Default: c.cliConfig.P2P.MaxPeers,
Group: "P2P",
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "maxpendpeers",
Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
Value: &c.cliConfig.P2P.MaxPendPeers,
Group: "P2P",
Name: "maxpendpeers",
Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
Value: &c.cliConfig.P2P.MaxPendPeers,
Default: c.cliConfig.P2P.MaxPendPeers,
Group: "P2P",
})
f.StringFlag(&flagset.StringFlag{
Name: "nat",
Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
Value: &c.cliConfig.P2P.NAT,
Group: "P2P",
Name: "nat",
Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
Value: &c.cliConfig.P2P.NAT,
Default: c.cliConfig.P2P.NAT,
Group: "P2P",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "nodiscover",
Usage: "Disables the peer discovery mechanism (manual peer addition)",
Value: &c.cliConfig.P2P.NoDiscover,
Group: "P2P",
Name: "nodiscover",
Usage: "Disables the peer discovery mechanism (manual peer addition)",
Value: &c.cliConfig.P2P.NoDiscover,
Default: c.cliConfig.P2P.NoDiscover,
Group: "P2P",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "v5disc",
Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
Value: &c.cliConfig.P2P.Discovery.V5Enabled,
Group: "P2P",
Name: "v5disc",
Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
Value: &c.cliConfig.P2P.Discovery.V5Enabled,
Default: c.cliConfig.P2P.Discovery.V5Enabled,
Group: "P2P",
})
// metrics
f.BoolFlag(&flagset.BoolFlag{
Name: "metrics",
Usage: "Enable metrics collection and reporting",
Value: &c.cliConfig.Telemetry.Enabled,
Group: "Telemetry",
Name: "metrics",
Usage: "Enable metrics collection and reporting",
Value: &c.cliConfig.Telemetry.Enabled,
Default: c.cliConfig.Telemetry.Enabled,
Group: "Telemetry",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "metrics.expensive",
Usage: "Enable expensive metrics collection and reporting",
Value: &c.cliConfig.Telemetry.Expensive,
Group: "Telemetry",
Name: "metrics.expensive",
Usage: "Enable expensive metrics collection and reporting",
Value: &c.cliConfig.Telemetry.Expensive,
Default: c.cliConfig.Telemetry.Expensive,
Group: "Telemetry",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "metrics.influxdb",
Usage: "Enable metrics export/push to an external InfluxDB database (v1)",
Value: &c.cliConfig.Telemetry.InfluxDB.V1Enabled,
Group: "Telemetry",
Name: "metrics.influxdb",
Usage: "Enable metrics export/push to an external InfluxDB database (v1)",
Value: &c.cliConfig.Telemetry.InfluxDB.V1Enabled,
Default: c.cliConfig.Telemetry.InfluxDB.V1Enabled,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.endpoint",
Usage: "InfluxDB API endpoint to report metrics to",
Value: &c.cliConfig.Telemetry.InfluxDB.Endpoint,
Group: "Telemetry",
Name: "metrics.influxdb.endpoint",
Usage: "InfluxDB API endpoint to report metrics to",
Value: &c.cliConfig.Telemetry.InfluxDB.Endpoint,
Default: c.cliConfig.Telemetry.InfluxDB.Endpoint,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.database",
Usage: "InfluxDB database name to push reported metrics to",
Value: &c.cliConfig.Telemetry.InfluxDB.Database,
Group: "Telemetry",
Name: "metrics.influxdb.database",
Usage: "InfluxDB database name to push reported metrics to",
Value: &c.cliConfig.Telemetry.InfluxDB.Database,
Default: c.cliConfig.Telemetry.InfluxDB.Database,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.username",
Usage: "Username to authorize access to the database",
Value: &c.cliConfig.Telemetry.InfluxDB.Username,
Group: "Telemetry",
Name: "metrics.influxdb.username",
Usage: "Username to authorize access to the database",
Value: &c.cliConfig.Telemetry.InfluxDB.Username,
Default: c.cliConfig.Telemetry.InfluxDB.Username,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.password",
Usage: "Password to authorize access to the database",
Value: &c.cliConfig.Telemetry.InfluxDB.Password,
Group: "Telemetry",
Name: "metrics.influxdb.password",
Usage: "Password to authorize access to the database",
Value: &c.cliConfig.Telemetry.InfluxDB.Password,
Default: c.cliConfig.Telemetry.InfluxDB.Password,
Group: "Telemetry",
})
f.MapStringFlag(&flagset.MapStringFlag{
Name: "metrics.influxdb.tags",
@ -468,41 +531,47 @@ func (c *Command) Flags() *flagset.Flagset {
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.prometheus-addr",
Usage: "Address for Prometheus Server",
Value: &c.cliConfig.Telemetry.PrometheusAddr,
Group: "Telemetry",
Name: "metrics.prometheus-addr",
Usage: "Address for Prometheus Server",
Value: &c.cliConfig.Telemetry.PrometheusAddr,
Default: c.cliConfig.Telemetry.PrometheusAddr,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.opencollector-endpoint",
Usage: "OpenCollector Endpoint (host:port)",
Value: &c.cliConfig.Telemetry.OpenCollectorEndpoint,
Group: "Telemetry",
Name: "metrics.opencollector-endpoint",
Usage: "OpenCollector Endpoint (host:port)",
Value: &c.cliConfig.Telemetry.OpenCollectorEndpoint,
Default: c.cliConfig.Telemetry.OpenCollectorEndpoint,
Group: "Telemetry",
})
// influx db v2
f.BoolFlag(&flagset.BoolFlag{
Name: "metrics.influxdbv2",
Usage: "Enable metrics export/push to an external InfluxDB v2 database",
Value: &c.cliConfig.Telemetry.InfluxDB.V2Enabled,
Group: "Telemetry",
Name: "metrics.influxdbv2",
Usage: "Enable metrics export/push to an external InfluxDB v2 database",
Value: &c.cliConfig.Telemetry.InfluxDB.V2Enabled,
Default: c.cliConfig.Telemetry.InfluxDB.V2Enabled,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.token",
Usage: "Token to authorize access to the database (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Token,
Group: "Telemetry",
Name: "metrics.influxdb.token",
Usage: "Token to authorize access to the database (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Token,
Default: c.cliConfig.Telemetry.InfluxDB.Token,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.bucket",
Usage: "InfluxDB bucket name to push reported metrics to (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Bucket,
Group: "Telemetry",
Name: "metrics.influxdb.bucket",
Usage: "InfluxDB bucket name to push reported metrics to (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Bucket,
Default: c.cliConfig.Telemetry.InfluxDB.Bucket,
Group: "Telemetry",
})
f.StringFlag(&flagset.StringFlag{
Name: "metrics.influxdb.organization",
Usage: "InfluxDB organization name (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Organization,
Group: "Telemetry",
Name: "metrics.influxdb.organization",
Usage: "InfluxDB organization name (v2 only)",
Value: &c.cliConfig.Telemetry.InfluxDB.Organization,
Default: c.cliConfig.Telemetry.InfluxDB.Organization,
Group: "Telemetry",
})
// account
@ -513,46 +582,53 @@ func (c *Command) Flags() *flagset.Flagset {
Group: "Account Management",
})
f.StringFlag(&flagset.StringFlag{
Name: "password",
Usage: "Password file to use for non-interactive password input",
Value: &c.cliConfig.Accounts.PasswordFile,
Group: "Account Management",
Name: "password",
Usage: "Password file to use for non-interactive password input",
Value: &c.cliConfig.Accounts.PasswordFile,
Default: c.cliConfig.Accounts.PasswordFile,
Group: "Account Management",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "allow-insecure-unlock",
Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http",
Value: &c.cliConfig.Accounts.AllowInsecureUnlock,
Group: "Account Management",
Name: "allow-insecure-unlock",
Usage: "Allow insecure account unlocking when account-related RPCs are exposed by http",
Value: &c.cliConfig.Accounts.AllowInsecureUnlock,
Default: c.cliConfig.Accounts.AllowInsecureUnlock,
Group: "Account Management",
})
f.BoolFlag(&flagset.BoolFlag{
Name: "lightkdf",
Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
Value: &c.cliConfig.Accounts.UseLightweightKDF,
Group: "Account Management",
Name: "lightkdf",
Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength",
Value: &c.cliConfig.Accounts.UseLightweightKDF,
Default: c.cliConfig.Accounts.UseLightweightKDF,
Group: "Account Management",
})
f.BoolFlag((&flagset.BoolFlag{
Name: "disable-bor-wallet",
Usage: "Disable the personal wallet endpoints",
Value: &c.cliConfig.Accounts.DisableBorWallet,
Name: "disable-bor-wallet",
Usage: "Disable the personal wallet endpoints",
Value: &c.cliConfig.Accounts.DisableBorWallet,
Default: c.cliConfig.Accounts.DisableBorWallet,
}))
// grpc
f.StringFlag(&flagset.StringFlag{
Name: "grpc.addr",
Usage: "Address and port to bind the GRPC server",
Value: &c.cliConfig.GRPC.Addr,
Name: "grpc.addr",
Usage: "Address and port to bind the GRPC server",
Value: &c.cliConfig.GRPC.Addr,
Default: c.cliConfig.GRPC.Addr,
})
// developer
f.BoolFlag(&flagset.BoolFlag{
Name: "dev",
Usage: "Enable developer mode with ephemeral proof-of-authority network and a pre-funded developer account, mining enabled",
Value: &c.cliConfig.Developer.Enabled,
Name: "dev",
Usage: "Enable developer mode with ephemeral proof-of-authority network and a pre-funded developer account, mining enabled",
Value: &c.cliConfig.Developer.Enabled,
Default: c.cliConfig.Developer.Enabled,
})
f.Uint64Flag(&flagset.Uint64Flag{
Name: "dev.period",
Usage: "Block period to use in developer mode (0 = mine only if transaction pending)",
Value: &c.cliConfig.Developer.Period,
Name: "dev.period",
Usage: "Block period to use in developer mode (0 = mine only if transaction pending)",
Value: &c.cliConfig.Developer.Period,
Default: c.cliConfig.Developer.Period,
})
return f
}