github.com/benorgera/go-ethereum@v1.10.18-0.20220401011646-b3f57b1a73ba/cmd/geth/usage.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of go-ethereum. 3 // 4 // go-ethereum is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // go-ethereum is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>. 16 17 // Contains the geth command usage template and generator. 18 19 package main 20 21 import ( 22 "io" 23 "sort" 24 25 "github.com/ethereum/go-ethereum/cmd/utils" 26 "github.com/ethereum/go-ethereum/internal/debug" 27 "github.com/ethereum/go-ethereum/internal/flags" 28 "gopkg.in/urfave/cli.v1" 29 ) 30 31 // AppHelpFlagGroups is the application flags, grouped by functionality. 32 var AppHelpFlagGroups = []flags.FlagGroup{ 33 { 34 Name: "ETHEREUM", 35 Flags: []cli.Flag{ 36 configFileFlag, 37 utils.DataDirFlag, 38 utils.AncientFlag, 39 utils.MinFreeDiskSpaceFlag, 40 utils.KeyStoreDirFlag, 41 utils.USBFlag, 42 utils.SmartCardDaemonPathFlag, 43 utils.NetworkIdFlag, 44 utils.MainnetFlag, 45 utils.GoerliFlag, 46 utils.RinkebyFlag, 47 utils.RopstenFlag, 48 utils.SepoliaFlag, 49 utils.KilnFlag, 50 utils.SyncModeFlag, 51 utils.ExitWhenSyncedFlag, 52 utils.GCModeFlag, 53 utils.TxLookupLimitFlag, 54 utils.EthStatsURLFlag, 55 utils.IdentityFlag, 56 utils.LightKDFFlag, 57 utils.EthPeerRequiredBlocksFlag, 58 }, 59 }, 60 { 61 Name: "LIGHT CLIENT", 62 Flags: []cli.Flag{ 63 utils.LightServeFlag, 64 utils.LightIngressFlag, 65 utils.LightEgressFlag, 66 utils.LightMaxPeersFlag, 67 utils.UltraLightServersFlag, 68 utils.UltraLightFractionFlag, 69 utils.UltraLightOnlyAnnounceFlag, 70 utils.LightNoPruneFlag, 71 utils.LightNoSyncServeFlag, 72 }, 73 }, 74 { 75 Name: "DEVELOPER CHAIN", 76 Flags: []cli.Flag{ 77 utils.DeveloperFlag, 78 utils.DeveloperPeriodFlag, 79 utils.DeveloperGasLimitFlag, 80 }, 81 }, 82 { 83 Name: "ETHASH", 84 Flags: []cli.Flag{ 85 utils.EthashCacheDirFlag, 86 utils.EthashCachesInMemoryFlag, 87 utils.EthashCachesOnDiskFlag, 88 utils.EthashCachesLockMmapFlag, 89 utils.EthashDatasetDirFlag, 90 utils.EthashDatasetsInMemoryFlag, 91 utils.EthashDatasetsOnDiskFlag, 92 utils.EthashDatasetsLockMmapFlag, 93 }, 94 }, 95 { 96 Name: "TRANSACTION POOL", 97 Flags: []cli.Flag{ 98 utils.TxPoolLocalsFlag, 99 utils.TxPoolNoLocalsFlag, 100 utils.TxPoolJournalFlag, 101 utils.TxPoolRejournalFlag, 102 utils.TxPoolPriceLimitFlag, 103 utils.TxPoolPriceBumpFlag, 104 utils.TxPoolAccountSlotsFlag, 105 utils.TxPoolGlobalSlotsFlag, 106 utils.TxPoolAccountQueueFlag, 107 utils.TxPoolGlobalQueueFlag, 108 utils.TxPoolLifetimeFlag, 109 }, 110 }, 111 { 112 Name: "PERFORMANCE TUNING", 113 Flags: []cli.Flag{ 114 utils.CacheFlag, 115 utils.CacheDatabaseFlag, 116 utils.CacheTrieFlag, 117 utils.CacheTrieJournalFlag, 118 utils.CacheTrieRejournalFlag, 119 utils.CacheGCFlag, 120 utils.CacheSnapshotFlag, 121 utils.CacheNoPrefetchFlag, 122 utils.CachePreimagesFlag, 123 utils.FDLimitFlag, 124 }, 125 }, 126 { 127 Name: "ACCOUNT", 128 Flags: []cli.Flag{ 129 utils.UnlockedAccountFlag, 130 utils.PasswordFileFlag, 131 utils.ExternalSignerFlag, 132 utils.InsecureUnlockAllowedFlag, 133 }, 134 }, 135 { 136 Name: "API AND CONSOLE", 137 Flags: []cli.Flag{ 138 utils.IPCDisabledFlag, 139 utils.IPCPathFlag, 140 utils.HTTPEnabledFlag, 141 utils.HTTPListenAddrFlag, 142 utils.HTTPPortFlag, 143 utils.HTTPApiFlag, 144 utils.HTTPPathPrefixFlag, 145 utils.HTTPCORSDomainFlag, 146 utils.HTTPVirtualHostsFlag, 147 utils.WSEnabledFlag, 148 utils.WSListenAddrFlag, 149 utils.WSPortFlag, 150 utils.WSApiFlag, 151 utils.WSPathPrefixFlag, 152 utils.WSAllowedOriginsFlag, 153 utils.JWTSecretFlag, 154 utils.AuthListenFlag, 155 utils.AuthPortFlag, 156 utils.AuthVirtualHostsFlag, 157 utils.GraphQLEnabledFlag, 158 utils.GraphQLCORSDomainFlag, 159 utils.GraphQLVirtualHostsFlag, 160 utils.RPCGlobalGasCapFlag, 161 utils.RPCGlobalEVMTimeoutFlag, 162 utils.RPCGlobalTxFeeCapFlag, 163 utils.AllowUnprotectedTxs, 164 utils.JSpathFlag, 165 utils.ExecFlag, 166 utils.PreloadJSFlag, 167 }, 168 }, 169 { 170 Name: "NETWORKING", 171 Flags: []cli.Flag{ 172 utils.BootnodesFlag, 173 utils.DNSDiscoveryFlag, 174 utils.ListenPortFlag, 175 utils.MaxPeersFlag, 176 utils.MaxPendingPeersFlag, 177 utils.NATFlag, 178 utils.NoDiscoverFlag, 179 utils.DiscoveryV5Flag, 180 utils.NetrestrictFlag, 181 utils.NodeKeyFileFlag, 182 utils.NodeKeyHexFlag, 183 }, 184 }, 185 { 186 Name: "MINER", 187 Flags: []cli.Flag{ 188 utils.MiningEnabledFlag, 189 utils.MinerThreadsFlag, 190 utils.MinerNotifyFlag, 191 utils.MinerNotifyFullFlag, 192 utils.MinerGasPriceFlag, 193 utils.MinerGasLimitFlag, 194 utils.MinerEtherbaseFlag, 195 utils.MinerExtraDataFlag, 196 utils.MinerRecommitIntervalFlag, 197 utils.MinerNoVerifyFlag, 198 }, 199 }, 200 { 201 Name: "GAS PRICE ORACLE", 202 Flags: []cli.Flag{ 203 utils.GpoBlocksFlag, 204 utils.GpoPercentileFlag, 205 utils.GpoMaxGasPriceFlag, 206 utils.GpoIgnoreGasPriceFlag, 207 }, 208 }, 209 { 210 Name: "VIRTUAL MACHINE", 211 Flags: []cli.Flag{ 212 utils.VMEnableDebugFlag, 213 }, 214 }, 215 { 216 Name: "LOGGING AND DEBUGGING", 217 Flags: append([]cli.Flag{ 218 utils.FakePoWFlag, 219 utils.NoCompactionFlag, 220 }, debug.Flags...), 221 }, 222 { 223 Name: "METRICS AND STATS", 224 Flags: metricsFlags, 225 }, 226 { 227 Name: "ALIASED (deprecated)", 228 Flags: []cli.Flag{ 229 utils.NoUSBFlag, 230 utils.LegacyWhitelistFlag, 231 }, 232 }, 233 { 234 Name: "MISC", 235 Flags: []cli.Flag{ 236 utils.SnapshotFlag, 237 utils.BloomFilterSizeFlag, 238 cli.HelpFlag, 239 }, 240 }, 241 } 242 243 func init() { 244 // Override the default app help template 245 cli.AppHelpTemplate = flags.AppHelpTemplate 246 247 // Override the default app help printer, but only for the global app help 248 originalHelpPrinter := cli.HelpPrinter 249 cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) { 250 if tmpl == flags.AppHelpTemplate { 251 // Iterate over all the flags and add any uncategorized ones 252 categorized := make(map[string]struct{}) 253 for _, group := range AppHelpFlagGroups { 254 for _, flag := range group.Flags { 255 categorized[flag.String()] = struct{}{} 256 } 257 } 258 deprecated := make(map[string]struct{}) 259 for _, flag := range utils.DeprecatedFlags { 260 deprecated[flag.String()] = struct{}{} 261 } 262 // Only add uncategorized flags if they are not deprecated 263 var uncategorized []cli.Flag 264 for _, flag := range data.(*cli.App).Flags { 265 if _, ok := categorized[flag.String()]; !ok { 266 if _, ok := deprecated[flag.String()]; !ok { 267 uncategorized = append(uncategorized, flag) 268 } 269 } 270 } 271 if len(uncategorized) > 0 { 272 // Append all ungategorized options to the misc group 273 miscs := len(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags) 274 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = append(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags, uncategorized...) 275 276 // Make sure they are removed afterwards 277 defer func() { 278 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags[:miscs] 279 }() 280 } 281 // Render out custom usage screen 282 originalHelpPrinter(w, tmpl, flags.HelpData{App: data, FlagGroups: AppHelpFlagGroups}) 283 } else if tmpl == flags.CommandHelpTemplate { 284 // Iterate over all command specific flags and categorize them 285 categorized := make(map[string][]cli.Flag) 286 for _, flag := range data.(cli.Command).Flags { 287 if _, ok := categorized[flag.String()]; !ok { 288 categorized[flags.FlagCategory(flag, AppHelpFlagGroups)] = append(categorized[flags.FlagCategory(flag, AppHelpFlagGroups)], flag) 289 } 290 } 291 292 // sort to get a stable ordering 293 sorted := make([]flags.FlagGroup, 0, len(categorized)) 294 for cat, flgs := range categorized { 295 sorted = append(sorted, flags.FlagGroup{Name: cat, Flags: flgs}) 296 } 297 sort.Sort(flags.ByCategory(sorted)) 298 299 // add sorted array to data and render with default printer 300 originalHelpPrinter(w, tmpl, map[string]interface{}{ 301 "cmd": data, 302 "categorizedFlags": sorted, 303 }) 304 } else { 305 originalHelpPrinter(w, tmpl, data) 306 } 307 } 308 }