github.com/shyftnetwork/go-empyrean@v1.8.3-0.20191127201940-fbfca9338f04/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 "strings" 26 27 "github.com/ShyftNetwork/go-empyrean/cmd/utils" 28 "github.com/ShyftNetwork/go-empyrean/internal/debug" 29 "gopkg.in/urfave/cli.v1" 30 ) 31 32 // AppHelpTemplate is the test template for the default, global app help topic. 33 var AppHelpTemplate = `NAME: 34 {{.App.Name}} - {{.App.Usage}} 35 36 Copyright 2013-2018 The go-ethereum Authors 37 38 USAGE: 39 {{.App.HelpName}} [options]{{if .App.Commands}} command [command options]{{end}} {{if .App.ArgsUsage}}{{.App.ArgsUsage}}{{else}}[arguments...]{{end}} 40 {{if .App.Version}} 41 VERSION: 42 {{.App.Version}} 43 {{end}}{{if len .App.Authors}} 44 AUTHOR(S): 45 {{range .App.Authors}}{{ . }}{{end}} 46 {{end}}{{if .App.Commands}} 47 COMMANDS: 48 {{range .App.Commands}}{{join .Names ", "}}{{ "\t" }}{{.Usage}} 49 {{end}}{{end}}{{if .FlagGroups}} 50 {{range .FlagGroups}}{{.Name}} OPTIONS: 51 {{range .Flags}}{{.}} 52 {{end}} 53 {{end}}{{end}}{{if .App.Copyright }} 54 COPYRIGHT: 55 {{.App.Copyright}} 56 {{end}} 57 ` 58 59 // flagGroup is a collection of flags belonging to a single topic. 60 type flagGroup struct { 61 Name string 62 Flags []cli.Flag 63 } 64 65 // AppHelpFlagGroups is the application flags, grouped by functionality. 66 var AppHelpFlagGroups = []flagGroup{ 67 { 68 Name: "ETHEREUM", 69 Flags: []cli.Flag{ 70 configFileFlag, 71 utils.DataDirFlag, 72 utils.KeyStoreDirFlag, 73 utils.NoUSBFlag, 74 utils.NetworkIdFlag, 75 utils.TestnetFlag, 76 utils.RinkebyFlag, 77 utils.SyncModeFlag, 78 utils.GCModeFlag, 79 utils.EthStatsURLFlag, 80 utils.IdentityFlag, 81 utils.LightServFlag, 82 utils.LightPeersFlag, 83 utils.LightKDFFlag, 84 utils.WhitelistFlag, 85 }, 86 }, 87 { 88 Name: "DEVELOPER CHAIN", 89 Flags: []cli.Flag{ 90 utils.DeveloperFlag, 91 utils.DeveloperPeriodFlag, 92 }, 93 }, 94 { 95 Name: "ETHASH", 96 Flags: []cli.Flag{ 97 utils.EthashCacheDirFlag, 98 utils.EthashCachesInMemoryFlag, 99 utils.EthashCachesOnDiskFlag, 100 utils.EthashDatasetDirFlag, 101 utils.EthashDatasetsInMemoryFlag, 102 utils.EthashDatasetsOnDiskFlag, 103 }, 104 }, 105 //{ 106 // Name: "DASHBOARD", 107 // Flags: []cli.Flag{ 108 // utils.DashboardEnabledFlag, 109 // utils.DashboardAddrFlag, 110 // utils.DashboardPortFlag, 111 // utils.DashboardRefreshFlag, 112 // utils.DashboardAssetsFlag, 113 // }, 114 //}, 115 { 116 Name: "TRANSACTION POOL", 117 Flags: []cli.Flag{ 118 utils.TxPoolLocalsFlag, 119 utils.TxPoolNoLocalsFlag, 120 utils.TxPoolJournalFlag, 121 utils.TxPoolRejournalFlag, 122 utils.TxPoolPriceLimitFlag, 123 utils.TxPoolPriceBumpFlag, 124 utils.TxPoolAccountSlotsFlag, 125 utils.TxPoolGlobalSlotsFlag, 126 utils.TxPoolAccountQueueFlag, 127 utils.TxPoolGlobalQueueFlag, 128 utils.TxPoolLifetimeFlag, 129 }, 130 }, 131 { 132 Name: "PERFORMANCE TUNING", 133 Flags: []cli.Flag{ 134 utils.CacheFlag, 135 utils.CacheDatabaseFlag, 136 utils.CacheTrieFlag, 137 utils.CacheGCFlag, 138 utils.TrieCacheGenFlag, 139 }, 140 }, 141 { 142 Name: "ACCOUNT", 143 Flags: []cli.Flag{ 144 utils.UnlockedAccountFlag, 145 utils.PasswordFileFlag, 146 }, 147 }, 148 { 149 Name: "WHISPER BROADCAST KEYS", 150 Flags: []cli.Flag{ 151 utils.WhisperKeys, 152 utils.PasswordFileFlag, 153 }, 154 }, 155 { 156 Name: "API AND CONSOLE", 157 Flags: []cli.Flag{ 158 utils.RPCEnabledFlag, 159 utils.RPCListenAddrFlag, 160 utils.RPCPortFlag, 161 utils.RPCApiFlag, 162 utils.WSEnabledFlag, 163 utils.WSListenAddrFlag, 164 utils.WSPortFlag, 165 utils.WSApiFlag, 166 utils.WSAllowedOriginsFlag, 167 utils.IPCDisabledFlag, 168 utils.IPCPathFlag, 169 utils.RPCCORSDomainFlag, 170 utils.RPCVirtualHostsFlag, 171 utils.JSpathFlag, 172 utils.ExecFlag, 173 utils.PreloadJSFlag, 174 }, 175 }, 176 { 177 Name: "NETWORKING", 178 Flags: []cli.Flag{ 179 utils.BootnodesFlag, 180 utils.BootnodesV4Flag, 181 utils.BootnodesV5Flag, 182 utils.ListenPortFlag, 183 utils.MaxPeersFlag, 184 utils.MaxPendingPeersFlag, 185 utils.NATFlag, 186 utils.NoDiscoverFlag, 187 utils.DiscoveryV5Flag, 188 utils.NetrestrictFlag, 189 utils.NodeKeyFileFlag, 190 utils.NodeKeyHexFlag, 191 }, 192 }, 193 { 194 Name: "MINER", 195 Flags: []cli.Flag{ 196 utils.MiningEnabledFlag, 197 utils.MinerThreadsFlag, 198 utils.MinerNotifyFlag, 199 utils.MinerGasPriceFlag, 200 utils.MinerGasTargetFlag, 201 utils.MinerGasLimitFlag, 202 utils.MinerEtherbaseFlag, 203 utils.MinerExtraDataFlag, 204 utils.MinerRecommitIntervalFlag, 205 utils.MinerNoVerfiyFlag, 206 }, 207 }, 208 { 209 Name: "GAS PRICE ORACLE", 210 Flags: []cli.Flag{ 211 utils.GpoBlocksFlag, 212 utils.GpoPercentileFlag, 213 }, 214 }, 215 { 216 Name: "VIRTUAL MACHINE", 217 Flags: []cli.Flag{ 218 utils.VMEnableDebugFlag, 219 utils.EVMInterpreterFlag, 220 utils.EWASMInterpreterFlag, 221 }, 222 }, 223 { 224 Name: "LOGGING AND DEBUGGING", 225 Flags: append([]cli.Flag{ 226 utils.FakePoWFlag, 227 utils.NoCompactionFlag, 228 }, debug.Flags...), 229 }, 230 { 231 Name: "METRICS AND STATS", 232 Flags: []cli.Flag{ 233 utils.MetricsEnabledFlag, 234 utils.MetricsEnableInfluxDBFlag, 235 utils.MetricsInfluxDBEndpointFlag, 236 utils.MetricsInfluxDBDatabaseFlag, 237 utils.MetricsInfluxDBUsernameFlag, 238 utils.MetricsInfluxDBPasswordFlag, 239 utils.MetricsInfluxDBHostTagFlag, 240 }, 241 }, 242 { 243 Name: "WHISPER (EXPERIMENTAL)", 244 Flags: whisperFlags, 245 }, 246 { 247 Name: "DEPRECATED", 248 Flags: []cli.Flag{ 249 utils.MinerLegacyThreadsFlag, 250 utils.MinerLegacyGasTargetFlag, 251 utils.MinerLegacyGasPriceFlag, 252 utils.MinerLegacyEtherbaseFlag, 253 utils.MinerLegacyExtraDataFlag, 254 }, 255 }, 256 { 257 Name: "SHYFT", 258 Flags: []cli.Flag{ 259 utils.PostgresFlag, 260 }, 261 }, 262 { 263 Name: "MISC", 264 }, 265 } 266 267 // byCategory sorts an array of flagGroup by Name in the order 268 // defined in AppHelpFlagGroups. 269 type byCategory []flagGroup 270 271 func (a byCategory) Len() int { return len(a) } 272 func (a byCategory) Swap(i, j int) { a[i], a[j] = a[j], a[i] } 273 func (a byCategory) Less(i, j int) bool { 274 iCat, jCat := a[i].Name, a[j].Name 275 iIdx, jIdx := len(AppHelpFlagGroups), len(AppHelpFlagGroups) // ensure non categorized flags come last 276 277 for i, group := range AppHelpFlagGroups { 278 if iCat == group.Name { 279 iIdx = i 280 } 281 if jCat == group.Name { 282 jIdx = i 283 } 284 } 285 286 return iIdx < jIdx 287 } 288 289 func flagCategory(flag cli.Flag) string { 290 for _, category := range AppHelpFlagGroups { 291 for _, flg := range category.Flags { 292 if flg.GetName() == flag.GetName() { 293 return category.Name 294 } 295 } 296 } 297 return "MISC" 298 } 299 300 func init() { 301 // Override the default app help template 302 cli.AppHelpTemplate = AppHelpTemplate 303 304 // Define a one shot struct to pass to the usage template 305 type helpData struct { 306 App interface{} 307 FlagGroups []flagGroup 308 } 309 310 // Override the default app help printer, but only for the global app help 311 originalHelpPrinter := cli.HelpPrinter 312 cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) { 313 if tmpl == AppHelpTemplate { 314 // Iterate over all the flags and add any uncategorized ones 315 categorized := make(map[string]struct{}) 316 for _, group := range AppHelpFlagGroups { 317 for _, flag := range group.Flags { 318 categorized[flag.String()] = struct{}{} 319 } 320 } 321 uncategorized := []cli.Flag{} 322 for _, flag := range data.(*cli.App).Flags { 323 if _, ok := categorized[flag.String()]; !ok { 324 if strings.HasPrefix(flag.GetName(), "dashboard") { 325 continue 326 } 327 uncategorized = append(uncategorized, flag) 328 } 329 } 330 if len(uncategorized) > 0 { 331 // Append all ungategorized options to the misc group 332 miscs := len(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags) 333 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = append(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags, uncategorized...) 334 335 // Make sure they are removed afterwards 336 defer func() { 337 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags[:miscs] 338 }() 339 } 340 // Render out custom usage screen 341 originalHelpPrinter(w, tmpl, helpData{data, AppHelpFlagGroups}) 342 } else if tmpl == utils.CommandHelpTemplate { 343 // Iterate over all command specific flags and categorize them 344 categorized := make(map[string][]cli.Flag) 345 for _, flag := range data.(cli.Command).Flags { 346 if _, ok := categorized[flag.String()]; !ok { 347 categorized[flagCategory(flag)] = append(categorized[flagCategory(flag)], flag) 348 } 349 } 350 351 // sort to get a stable ordering 352 sorted := make([]flagGroup, 0, len(categorized)) 353 for cat, flgs := range categorized { 354 sorted = append(sorted, flagGroup{cat, flgs}) 355 } 356 sort.Sort(byCategory(sorted)) 357 358 // add sorted array to data and render with default printer 359 originalHelpPrinter(w, tmpl, map[string]interface{}{ 360 "cmd": data, 361 "categorizedFlags": sorted, 362 }) 363 } else { 364 originalHelpPrinter(w, tmpl, data) 365 } 366 } 367 }