forked from cerc-io/plugeth
378e961d85
This PR adds a more CLI flag, so that the les-server can serve light clients even the local node is not synced yet. This functionality is needed in some testing environments(e.g. hive). After launching the les server, no more blocks will be imported so the node is always marked as "non-synced".
311 lines
8.0 KiB
Go
311 lines
8.0 KiB
Go
// Copyright 2015 The go-ethereum Authors
|
|
// This file is part of go-ethereum.
|
|
//
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// go-ethereum is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// Contains the geth command usage template and generator.
|
|
|
|
package main
|
|
|
|
import (
|
|
"io"
|
|
"sort"
|
|
|
|
"github.com/ethereum/go-ethereum/cmd/utils"
|
|
"github.com/ethereum/go-ethereum/internal/debug"
|
|
"github.com/ethereum/go-ethereum/internal/flags"
|
|
"gopkg.in/urfave/cli.v1"
|
|
)
|
|
|
|
// AppHelpFlagGroups is the application flags, grouped by functionality.
|
|
var AppHelpFlagGroups = []flags.FlagGroup{
|
|
{
|
|
Name: "ETHEREUM",
|
|
Flags: []cli.Flag{
|
|
configFileFlag,
|
|
utils.DataDirFlag,
|
|
utils.AncientFlag,
|
|
utils.MinFreeDiskSpaceFlag,
|
|
utils.KeyStoreDirFlag,
|
|
utils.USBFlag,
|
|
utils.SmartCardDaemonPathFlag,
|
|
utils.NetworkIdFlag,
|
|
utils.MainnetFlag,
|
|
utils.GoerliFlag,
|
|
utils.RinkebyFlag,
|
|
// TODO: Re-enable this when 2718/2930 is added
|
|
//utils.YoloV3Flag,
|
|
utils.RopstenFlag,
|
|
utils.SyncModeFlag,
|
|
utils.ExitWhenSyncedFlag,
|
|
utils.GCModeFlag,
|
|
utils.TxLookupLimitFlag,
|
|
utils.EthStatsURLFlag,
|
|
utils.IdentityFlag,
|
|
utils.LightKDFFlag,
|
|
utils.WhitelistFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "LIGHT CLIENT",
|
|
Flags: []cli.Flag{
|
|
utils.LightServeFlag,
|
|
utils.LightIngressFlag,
|
|
utils.LightEgressFlag,
|
|
utils.LightMaxPeersFlag,
|
|
utils.UltraLightServersFlag,
|
|
utils.UltraLightFractionFlag,
|
|
utils.UltraLightOnlyAnnounceFlag,
|
|
utils.LightNoPruneFlag,
|
|
utils.LightNoSyncServeFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "DEVELOPER CHAIN",
|
|
Flags: []cli.Flag{
|
|
utils.DeveloperFlag,
|
|
utils.DeveloperPeriodFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "ETHASH",
|
|
Flags: []cli.Flag{
|
|
utils.EthashCacheDirFlag,
|
|
utils.EthashCachesInMemoryFlag,
|
|
utils.EthashCachesOnDiskFlag,
|
|
utils.EthashCachesLockMmapFlag,
|
|
utils.EthashDatasetDirFlag,
|
|
utils.EthashDatasetsInMemoryFlag,
|
|
utils.EthashDatasetsOnDiskFlag,
|
|
utils.EthashDatasetsLockMmapFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "TRANSACTION POOL",
|
|
Flags: []cli.Flag{
|
|
utils.TxPoolLocalsFlag,
|
|
utils.TxPoolNoLocalsFlag,
|
|
utils.TxPoolJournalFlag,
|
|
utils.TxPoolRejournalFlag,
|
|
utils.TxPoolPriceLimitFlag,
|
|
utils.TxPoolPriceBumpFlag,
|
|
utils.TxPoolAccountSlotsFlag,
|
|
utils.TxPoolGlobalSlotsFlag,
|
|
utils.TxPoolAccountQueueFlag,
|
|
utils.TxPoolGlobalQueueFlag,
|
|
utils.TxPoolLifetimeFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "PERFORMANCE TUNING",
|
|
Flags: []cli.Flag{
|
|
utils.CacheFlag,
|
|
utils.CacheDatabaseFlag,
|
|
utils.CacheTrieFlag,
|
|
utils.CacheTrieJournalFlag,
|
|
utils.CacheTrieRejournalFlag,
|
|
utils.CacheGCFlag,
|
|
utils.CacheSnapshotFlag,
|
|
utils.CacheNoPrefetchFlag,
|
|
utils.CachePreimagesFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "ACCOUNT",
|
|
Flags: []cli.Flag{
|
|
utils.UnlockedAccountFlag,
|
|
utils.PasswordFileFlag,
|
|
utils.ExternalSignerFlag,
|
|
utils.InsecureUnlockAllowedFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "API AND CONSOLE",
|
|
Flags: []cli.Flag{
|
|
utils.IPCDisabledFlag,
|
|
utils.IPCPathFlag,
|
|
utils.HTTPEnabledFlag,
|
|
utils.HTTPListenAddrFlag,
|
|
utils.HTTPPortFlag,
|
|
utils.HTTPApiFlag,
|
|
utils.HTTPPathPrefixFlag,
|
|
utils.HTTPCORSDomainFlag,
|
|
utils.HTTPVirtualHostsFlag,
|
|
utils.WSEnabledFlag,
|
|
utils.WSListenAddrFlag,
|
|
utils.WSPortFlag,
|
|
utils.WSApiFlag,
|
|
utils.WSPathPrefixFlag,
|
|
utils.WSAllowedOriginsFlag,
|
|
utils.GraphQLEnabledFlag,
|
|
utils.GraphQLCORSDomainFlag,
|
|
utils.GraphQLVirtualHostsFlag,
|
|
utils.RPCGlobalGasCapFlag,
|
|
utils.RPCGlobalTxFeeCapFlag,
|
|
utils.JSpathFlag,
|
|
utils.ExecFlag,
|
|
utils.PreloadJSFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "NETWORKING",
|
|
Flags: []cli.Flag{
|
|
utils.BootnodesFlag,
|
|
utils.DNSDiscoveryFlag,
|
|
utils.ListenPortFlag,
|
|
utils.MaxPeersFlag,
|
|
utils.MaxPendingPeersFlag,
|
|
utils.NATFlag,
|
|
utils.NoDiscoverFlag,
|
|
utils.DiscoveryV5Flag,
|
|
utils.NetrestrictFlag,
|
|
utils.NodeKeyFileFlag,
|
|
utils.NodeKeyHexFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "MINER",
|
|
Flags: []cli.Flag{
|
|
utils.MiningEnabledFlag,
|
|
utils.MinerThreadsFlag,
|
|
utils.MinerNotifyFlag,
|
|
utils.MinerGasPriceFlag,
|
|
utils.MinerGasTargetFlag,
|
|
utils.MinerGasLimitFlag,
|
|
utils.MinerEtherbaseFlag,
|
|
utils.MinerExtraDataFlag,
|
|
utils.MinerRecommitIntervalFlag,
|
|
utils.MinerNoVerfiyFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "GAS PRICE ORACLE",
|
|
Flags: []cli.Flag{
|
|
utils.GpoBlocksFlag,
|
|
utils.GpoPercentileFlag,
|
|
utils.GpoMaxGasPriceFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "VIRTUAL MACHINE",
|
|
Flags: []cli.Flag{
|
|
utils.VMEnableDebugFlag,
|
|
utils.EVMInterpreterFlag,
|
|
utils.EWASMInterpreterFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "LOGGING AND DEBUGGING",
|
|
Flags: append([]cli.Flag{
|
|
utils.FakePoWFlag,
|
|
utils.NoCompactionFlag,
|
|
}, debug.Flags...),
|
|
},
|
|
{
|
|
Name: "METRICS AND STATS",
|
|
Flags: metricsFlags,
|
|
},
|
|
{
|
|
Name: "WHISPER (deprecated)",
|
|
Flags: whisperFlags,
|
|
},
|
|
{
|
|
Name: "ALIASED (deprecated)",
|
|
Flags: []cli.Flag{
|
|
utils.NoUSBFlag,
|
|
utils.LegacyRPCEnabledFlag,
|
|
utils.LegacyRPCListenAddrFlag,
|
|
utils.LegacyRPCPortFlag,
|
|
utils.LegacyRPCCORSDomainFlag,
|
|
utils.LegacyRPCVirtualHostsFlag,
|
|
utils.LegacyRPCApiFlag,
|
|
},
|
|
},
|
|
{
|
|
Name: "MISC",
|
|
Flags: []cli.Flag{
|
|
utils.SnapshotFlag,
|
|
utils.BloomFilterSizeFlag,
|
|
cli.HelpFlag,
|
|
},
|
|
},
|
|
}
|
|
|
|
func init() {
|
|
// Override the default app help template
|
|
cli.AppHelpTemplate = flags.AppHelpTemplate
|
|
|
|
// Override the default app help printer, but only for the global app help
|
|
originalHelpPrinter := cli.HelpPrinter
|
|
cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) {
|
|
if tmpl == flags.AppHelpTemplate {
|
|
// Iterate over all the flags and add any uncategorized ones
|
|
categorized := make(map[string]struct{})
|
|
for _, group := range AppHelpFlagGroups {
|
|
for _, flag := range group.Flags {
|
|
categorized[flag.String()] = struct{}{}
|
|
}
|
|
}
|
|
deprecated := make(map[string]struct{})
|
|
for _, flag := range utils.DeprecatedFlags {
|
|
deprecated[flag.String()] = struct{}{}
|
|
}
|
|
// Only add uncategorized flags if they are not deprecated
|
|
var uncategorized []cli.Flag
|
|
for _, flag := range data.(*cli.App).Flags {
|
|
if _, ok := categorized[flag.String()]; !ok {
|
|
if _, ok := deprecated[flag.String()]; !ok {
|
|
uncategorized = append(uncategorized, flag)
|
|
}
|
|
}
|
|
}
|
|
if len(uncategorized) > 0 {
|
|
// Append all ungategorized options to the misc group
|
|
miscs := len(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags)
|
|
AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = append(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags, uncategorized...)
|
|
|
|
// Make sure they are removed afterwards
|
|
defer func() {
|
|
AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags[:miscs]
|
|
}()
|
|
}
|
|
// Render out custom usage screen
|
|
originalHelpPrinter(w, tmpl, flags.HelpData{App: data, FlagGroups: AppHelpFlagGroups})
|
|
} else if tmpl == flags.CommandHelpTemplate {
|
|
// Iterate over all command specific flags and categorize them
|
|
categorized := make(map[string][]cli.Flag)
|
|
for _, flag := range data.(cli.Command).Flags {
|
|
if _, ok := categorized[flag.String()]; !ok {
|
|
categorized[flags.FlagCategory(flag, AppHelpFlagGroups)] = append(categorized[flags.FlagCategory(flag, AppHelpFlagGroups)], flag)
|
|
}
|
|
}
|
|
|
|
// sort to get a stable ordering
|
|
sorted := make([]flags.FlagGroup, 0, len(categorized))
|
|
for cat, flgs := range categorized {
|
|
sorted = append(sorted, flags.FlagGroup{Name: cat, Flags: flgs})
|
|
}
|
|
sort.Sort(flags.ByCategory(sorted))
|
|
|
|
// add sorted array to data and render with default printer
|
|
originalHelpPrinter(w, tmpl, map[string]interface{}{
|
|
"cmd": data,
|
|
"categorizedFlags": sorted,
|
|
})
|
|
} else {
|
|
originalHelpPrinter(w, tmpl, data)
|
|
}
|
|
}
|
|
}
|