diff --git a/docs/cli/attach.md b/docs/cli/attach.md index 6e323b8d18..7430a9cfd2 100644 --- a/docs/cli/attach.md +++ b/docs/cli/attach.md @@ -6,6 +6,6 @@ Connect to remote Bor IPC console. - ```exec```: Command to run in remote console -- ```preload```: Comma separated list of JavaScript files to preload into the console +- ```jspath```: JavaScript root path for `loadScript` -- ```jspath```: JavaScript root path for `loadScript` \ No newline at end of file +- ```preload```: Comma separated list of JavaScript files to preload into the console \ No newline at end of file diff --git a/docs/cli/bootnode.md b/docs/cli/bootnode.md index e4111160a0..d68c94ff01 100644 --- a/docs/cli/bootnode.md +++ b/docs/cli/bootnode.md @@ -2,18 +2,22 @@ ## Options -- ```listen-addr```: listening address of bootnode (:) (default: 0.0.0.0:30303) - -- ```v5```: Enable UDP v5 (default: false) +- ```dry-run```: validates parameters and prints bootnode configurations, but does not start bootnode (default: false) -- ```verbosity```: Logging verbosity (5=trace|4=debug|3=info|2=warn|1=error|0=crit) (default: 3) +- ```listen-addr```: listening address of bootnode (:) (default: 0.0.0.0:30303) - ```log-level```: log level (trace|debug|info|warn|error|crit), will be deprecated soon. Use verbosity instead (default: info) +- ```metrics```: Enable metrics collection and reporting (default: true) + - ```nat```: port mapping mechanism (any|none|upnp|pmp|extip:) (default: none) - ```node-key```: file or hex node key +- ```prometheus-addr```: listening address of bootnode (:) (default: 127.0.0.1:7071) + - ```save-key```: path to save the ecdsa private key -- ```dry-run```: validates parameters and prints bootnode configurations, but does not start bootnode (default: false) \ No newline at end of file +- ```v5```: Enable UDP v5 (default: false) + +- ```verbosity```: Logging verbosity (5=trace|4=debug|3=info|2=warn|1=error|0=crit) (default: 3) \ No newline at end of file diff --git a/docs/cli/debug_pprof.md b/docs/cli/debug_pprof.md index 78e75f2134..d6cd3bee43 100644 --- a/docs/cli/debug_pprof.md +++ b/docs/cli/debug_pprof.md @@ -6,8 +6,8 @@ The ```debug pprof ``` command will create an archive containing bor ppro - ```address```: Address of the grpc endpoint (default: 127.0.0.1:3131) -- ```seconds```: seconds to profile (default: 2) - - ```output```: Output directory +- ```seconds```: seconds to profile (default: 2) + - ```skiptrace```: Skip running the trace (default: false) \ No newline at end of file diff --git a/docs/cli/server.md b/docs/cli/server.md index 865b54e3f0..ecfd4ee19b 100644 --- a/docs/cli/server.md +++ b/docs/cli/server.md @@ -4,128 +4,128 @@ The ```bor server``` command runs the Bor client. ## Options -- ```chain```: Name of the chain to sync ('mumbai', 'mainnet') or path to a genesis file (default: mainnet) - -- ```identity```: Name/Identity of the node - -- ```verbosity```: Logging verbosity for the server (5=trace|4=debug|3=info|2=warn|1=error|0=crit), default = 3 (default: 3) +- ```bor.devfakeauthor```: Run miner without validator set authorization [dev mode] : Use with '--bor.withoutheimdall' (default: false) -- ```log-level```: Log level for the server (trace|debug|info|warn|error|crit), will be deprecated soon. Use verbosity instead +- ```bor.heimdall```: URL of Heimdall service (default: http://localhost:1317) -- ```datadir```: Path of the data directory to store information +- ```bor.heimdallgRPC```: Address of Heimdall gRPC service -- ```vmdebug```: Record information useful for VM and contract debugging (default: false) +- ```bor.logs```: Enables bor log retrieval (default: false) -- ```datadir.ancient```: Data directory for ancient chain segments (default = inside chaindata) +- ```bor.runheimdall```: Run Heimdall service as a child process (default: false) -- ```db.engine```: Backing database implementation to use ('leveldb' or 'pebble') (default: leveldb) +- ```bor.runheimdallargs```: Arguments to pass to Heimdall service -- ```keystore```: Path of the directory where keystores are located +- ```bor.useheimdallapp```: Use child heimdall process to fetch data, Only works when bor.runheimdall is true (default: false) -- ```rpc.batchlimit```: Maximum number of messages in a batch (default=100, use 0 for no limits) (default: 100) +- ```bor.withoutheimdall```: Run without Heimdall service (for testing purpose) (default: false) -- ```rpc.returndatalimit```: Maximum size (in bytes) a result of an rpc request could have (default=100000, use 0 for no limits) (default: 100000) +- ```chain```: Name of the chain to sync ('mumbai', 'mainnet') or path to a genesis file (default: mainnet) - ```config```: Path to the TOML configuration file -- ```syncmode```: Blockchain sync mode (only "full" sync supported) (default: full) - -- ```gcmode```: Blockchain garbage collection mode ("full", "archive") (default: full) - -- ```eth.requiredblocks```: Comma separated block number-to-hash mappings to require for peering (=) - -- ```snapshot```: Enables the snapshot-database mode (default: true) - -- ```bor.logs```: Enables bor log retrieval (default: false) +- ```datadir```: Path of the data directory to store information -- ```bor.heimdall```: URL of Heimdall service (default: http://localhost:1317) +- ```datadir.ancient```: Data directory for ancient chain segments (default = inside chaindata) -- ```bor.withoutheimdall```: Run without Heimdall service (for testing purpose) (default: false) +- ```db.engine```: Backing database implementation to use ('leveldb' or 'pebble') (default: leveldb) -- ```bor.devfakeauthor```: Run miner without validator set authorization [dev mode] : Use with '--bor.withoutheimdall' (default: false) +- ```dev```: Enable developer mode with ephemeral proof-of-authority network and a pre-funded developer account, mining enabled (default: false) -- ```bor.heimdallgRPC```: Address of Heimdall gRPC service +- ```dev.gaslimit```: Initial block gas limit (default: 11500000) -- ```bor.runheimdall```: Run Heimdall service as a child process (default: false) +- ```dev.period```: Block period to use in developer mode (0 = mine only if transaction pending) (default: 0) -- ```bor.runheimdallargs```: Arguments to pass to Heimdall service +- ```disable-bor-wallet```: Disable the personal wallet endpoints (default: true) -- ```bor.useheimdallapp```: Use child heimdall process to fetch data, Only works when bor.runheimdall is true (default: false) +- ```eth.requiredblocks```: Comma separated block number-to-hash mappings to require for peering (=) - ```ethstats```: Reporting URL of a ethstats service (nodename:secret@host:port) -- ```gpo.blocks```: Number of recent blocks to check for gas prices (default: 20) +- ```gcmode```: Blockchain garbage collection mode ("full", "archive") (default: full) -- ```gpo.percentile```: Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60) +- ```gpo.blocks```: Number of recent blocks to check for gas prices (default: 20) -- ```gpo.maxheaderhistory```: Maximum header history of gasprice oracle (default: 1024) +- ```gpo.ignoreprice```: Gas price below which gpo will ignore transactions (default: 2) - ```gpo.maxblockhistory```: Maximum block history of gasprice oracle (default: 1024) -- ```gpo.maxprice```: Maximum gas price will be recommended by gpo (default: 500000000000) +- ```gpo.maxheaderhistory```: Maximum header history of gasprice oracle (default: 1024) -- ```gpo.ignoreprice```: Gas price below which gpo will ignore transactions (default: 2) +- ```gpo.maxprice```: Maximum gas price will be recommended by gpo (default: 500000000000) -- ```disable-bor-wallet```: Disable the personal wallet endpoints (default: true) +- ```gpo.percentile```: Suggested gas price is the given percentile of a set of recent transaction gas prices (default: 60) - ```grpc.addr```: Address and port to bind the GRPC server (default: :3131) -- ```dev```: Enable developer mode with ephemeral proof-of-authority network and a pre-funded developer account, mining enabled (default: false) +- ```identity```: Name/Identity of the node -- ```dev.period```: Block period to use in developer mode (0 = mine only if transaction pending) (default: 0) +- ```keystore```: Path of the directory where keystores are located + +- ```log-level```: Log level for the server (trace|debug|info|warn|error|crit), will be deprecated soon. Use verbosity instead - ```parallelevm.enable```: Enable Block STM (default: true) - ```parallelevm.procs```: Number of speculative processes (cores) in Block STM (default: 8) -- ```dev.gaslimit```: Initial block gas limit (default: 11500000) - - ```pprof```: Enable the pprof HTTP server (default: false) -- ```pprof.port```: pprof HTTP server listening port (default: 6060) - - ```pprof.addr```: pprof HTTP server listening interface (default: 127.0.0.1) +- ```pprof.blockprofilerate```: Turn on block profiling with the given rate (default: 0) + - ```pprof.memprofilerate```: Turn on memory profiling with the given rate (default: 524288) -- ```pprof.blockprofilerate```: Turn on block profiling with the given rate (default: 0) +- ```pprof.port```: pprof HTTP server listening port (default: 6060) -### Account Management Options +- ```rpc.batchlimit```: Maximum number of messages in a batch (use 0 for no limits) (default: 100) -- ```unlock```: Comma separated list of accounts to unlock +- ```rpc.returndatalimit```: Maximum size (in bytes) a result of an rpc request could have (use 0 for no limits) (default: 100000) -- ```password```: Password file to use for non-interactive password input +- ```snapshot```: Enables the snapshot-database mode (default: true) + +- ```syncmode```: Blockchain sync mode (only "full" sync supported) (default: full) + +- ```verbosity```: Logging verbosity for the server (5=trace|4=debug|3=info|2=warn|1=error|0=crit) (default: 3) + +- ```vmdebug```: Record information useful for VM and contract debugging (default: false) + +### Account Management Options - ```allow-insecure-unlock```: Allow insecure account unlocking when account-related RPCs are exposed by http (default: false) - ```lightkdf```: Reduce key-derivation RAM & CPU usage at some expense of KDF strength (default: false) +- ```password```: Password file to use for non-interactive password input + +- ```unlock```: Comma separated list of accounts to unlock + ### Cache Options - ```cache```: Megabytes of memory allocated to internal caching (default: 1024) - ```cache.database```: Percentage of cache memory allowance to use for database io (default: 50) -- ```cache.trie```: Percentage of cache memory allowance to use for trie caching (default: 15) - -- ```cache.trie.journal```: Disk journal directory for trie cache to survive node restarts (default: triecache) +- ```cache.gc```: Percentage of cache memory allowance to use for trie pruning (default: 25) -- ```cache.trie.rejournal```: Time interval to regenerate the trie cache journal (default: 1h0m0s) +- ```cache.noprefetch```: Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data) (default: false) -- ```cache.gc```: Percentage of cache memory allowance to use for trie pruning (default: 25) +- ```cache.preimages```: Enable recording the SHA3/keccak preimages of trie keys (default: false) - ```cache.snapshot```: Percentage of cache memory allowance to use for snapshot caching (default: 10) -- ```cache.noprefetch```: Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data) (default: false) +- ```cache.trie```: Percentage of cache memory allowance to use for trie caching (default: 15) -- ```cache.preimages```: Enable recording the SHA3/keccak preimages of trie keys (default: false) +- ```cache.trie.journal```: Disk journal directory for trie cache to survive node restarts (default: triecache) -- ```cache.triesinmemory```: Number of block states (tries) to keep in memory (default = 128) (default: 128) +- ```cache.trie.rejournal```: Time interval to regenerate the trie cache journal (default: 1h0m0s) -- ```txlookuplimit```: Number of recent blocks to maintain transactions index for (default: 2350000) +- ```cache.triesinmemory```: Number of block states (tries) to keep in memory (default: 128) - ```fdlimit```: Raise the open file descriptor resource limit (default = system fd limit) (default: 0) +- ```txlookuplimit```: Number of recent blocks to maintain transactions index for (default: 2350000) + ### ExtraDB Options - ```leveldb.compaction.table.size```: LevelDB SSTable/file size in mebibytes (default: 2) @@ -138,33 +138,15 @@ The ```bor server``` command runs the Bor client. ### JsonRPC Options -- ```rpc.gascap```: Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) (default: 50000000) - -- ```rpc.evmtimeout```: Sets a timeout used for eth_call (0=infinite) (default: 5s) - -- ```rpc.txfeecap```: Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap) (default: 5) - -- ```rpc.allow-unprotected-txs```: Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC (default: false) - -- ```rpc.enabledeprecatedpersonal```: Enables the (deprecated) personal namespace (default: false) - -- ```ipcdisable```: Disable the IPC-RPC server (default: false) - -- ```ipcpath```: Filename for IPC socket/pipe within the datadir (explicit paths escape it) +- ```authrpc.addr```: Listening address for authenticated APIs (default: localhost) - ```authrpc.jwtsecret```: Path to a JWT secret to use for authenticated RPC endpoints -- ```authrpc.addr```: Listening address for authenticated APIs (default: localhost) - - ```authrpc.port```: Listening port for authenticated APIs (default: 8551) - ```authrpc.vhosts```: Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: localhost) -- ```http.corsdomain```: Comma separated list of domains from which to accept cross origin requests (browser enforced) (default: localhost) - -- ```http.vhosts```: Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: localhost) - -- ```ws.origins```: Origins from which to accept websockets requests (default: localhost) +- ```graphql```: Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well. (default: false) - ```graphql.corsdomain```: Comma separated list of domains from which to accept cross origin requests (browser enforced) (default: localhost) @@ -174,48 +156,64 @@ The ```bor server``` command runs the Bor client. - ```http.addr```: HTTP-RPC server listening interface (default: localhost) +- ```http.api```: API's offered over the HTTP-RPC interface (default: eth,net,web3,txpool,bor) + +- ```http.corsdomain```: Comma separated list of domains from which to accept cross origin requests (browser enforced) (default: localhost) + +- ```http.ep-requesttimeout```: Request Timeout for rpc execution pool for HTTP requests (default: 0s) + +- ```http.ep-size```: Maximum size of workers to run in rpc execution pool for HTTP requests (default: 40) + - ```http.port```: HTTP-RPC server listening port (default: 8545) - ```http.rpcprefix```: HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths. -- ```http.api```: API's offered over the HTTP-RPC interface (default: eth,net,web3,txpool,bor) +- ```http.vhosts```: Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (default: localhost) -- ```http.ep-size```: Maximum size of workers to run in rpc execution pool for HTTP requests (default: 40) +- ```ipcdisable```: Disable the IPC-RPC server (default: false) -- ```http.ep-requesttimeout```: Request Timeout for rpc execution pool for HTTP requests (default: 0s) +- ```ipcpath```: Filename for IPC socket/pipe within the datadir (explicit paths escape it) -- ```ws```: Enable the WS-RPC server (default: false) +- ```rpc.allow-unprotected-txs```: Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC (default: false) -- ```ws.addr```: WS-RPC server listening interface (default: localhost) +- ```rpc.enabledeprecatedpersonal```: Enables the (deprecated) personal namespace (default: false) -- ```ws.port```: WS-RPC server listening port (default: 8546) +- ```rpc.evmtimeout```: Sets a timeout used for eth_call (0=infinite) (default: 5s) -- ```ws.rpcprefix```: HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths. +- ```rpc.gascap```: Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) (default: 50000000) -- ```ws.api```: API's offered over the WS-RPC interface (default: net,web3) +- ```rpc.txfeecap```: Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap) (default: 5) -- ```ws.ep-size```: Maximum size of workers to run in rpc execution pool for WS requests (default: 40) +- ```ws```: Enable the WS-RPC server (default: false) + +- ```ws.addr```: WS-RPC server listening interface (default: localhost) + +- ```ws.api```: API's offered over the WS-RPC interface (default: net,web3) - ```ws.ep-requesttimeout```: Request Timeout for rpc execution pool for WS requests (default: 0s) -- ```graphql```: Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well. (default: false) +- ```ws.ep-size```: Maximum size of workers to run in rpc execution pool for WS requests (default: 40) -### Logging Options +- ```ws.origins```: Origins from which to accept websockets requests (default: localhost) -- ```vmodule```: Per-module verbosity: comma-separated list of = (e.g. eth/*=5,p2p=4) +- ```ws.port```: WS-RPC server listening port (default: 8546) -- ```log.json```: Format logs with JSON (default: false) +- ```ws.rpcprefix```: HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths. + +### Logging Options - ```log.backtrace```: Request a stack trace at a specific logging statement (e.g. 'block.go:271') - ```log.debug```: Prepends log messages with call-site location (file and line number) (default: false) +- ```log.json```: Format logs with JSON (default: false) + +- ```vmodule```: Per-module verbosity: comma-separated list of = (e.g. eth/*=5,p2p=4) + ### P2P Options - ```bind```: Network binding address (default: 0.0.0.0) -- ```port```: Network listening port (default: 30303) - - ```bootnodes```: Comma separated enode URLs for P2P discovery bootstrap - ```maxpeers```: Maximum number of network peers (network disabled if set to 0) (default: 50) @@ -232,9 +230,11 @@ The ```bor server``` command runs the Bor client. - ```nodiscover```: Disables the peer discovery mechanism (manual peer addition) (default: false) -- ```v5disc```: Enables the experimental RLPx V5 (Topic Discovery) mechanism (default: false) +- ```port```: Network listening port (default: 30303) + +- ```txarrivalwait```: Maximum duration to wait for a transaction before explicitly requesting it (default: 500ms) -- ```txarrivalwait```: Maximum duration to wait for a transaction before explicitly requesting it (defaults to 500ms) (default: 500ms) +- ```v5disc```: Enables the experimental RLPx V5 (Topic Discovery) mechanism (default: false) ### Sealer Options @@ -248,10 +248,10 @@ The ```bor server``` command runs the Bor client. - ```miner.gasprice```: Minimum gas price for mining a transaction (default: 1000000000) -- ```miner.recommit```: The time interval for miner to re-create mining work (default: 2m5s) - - ```miner.interruptcommit```: Interrupt block commit when block creation time is passed (default: true) +- ```miner.recommit```: The time interval for miner to re-create mining work (default: 2m5s) + ### Telemetry Options - ```metrics```: Enable metrics collection and reporting (default: false) @@ -260,48 +260,48 @@ The ```bor server``` command runs the Bor client. - ```metrics.influxdb```: Enable metrics export/push to an external InfluxDB database (v1) (default: false) -- ```metrics.influxdb.endpoint```: InfluxDB API endpoint to report metrics to +- ```metrics.influxdb.bucket```: InfluxDB bucket name to push reported metrics to (v2 only) - ```metrics.influxdb.database```: InfluxDB database name to push reported metrics to -- ```metrics.influxdb.username```: Username to authorize access to the database +- ```metrics.influxdb.endpoint```: InfluxDB API endpoint to report metrics to + +- ```metrics.influxdb.organization```: InfluxDB organization name (v2 only) - ```metrics.influxdb.password```: Password to authorize access to the database - ```metrics.influxdb.tags```: Comma-separated InfluxDB tags (key/values) attached to all measurements -- ```metrics.prometheus-addr```: Address for Prometheus Server (default: 127.0.0.1:7071) +- ```metrics.influxdb.token```: Token to authorize access to the database (v2 only) -- ```metrics.opencollector-endpoint```: OpenCollector Endpoint (host:port) +- ```metrics.influxdb.username```: Username to authorize access to the database - ```metrics.influxdbv2```: Enable metrics export/push to an external InfluxDB v2 database (default: false) -- ```metrics.influxdb.token```: Token to authorize access to the database (v2 only) - -- ```metrics.influxdb.bucket```: InfluxDB bucket name to push reported metrics to (v2 only) +- ```metrics.opencollector-endpoint```: OpenCollector Endpoint (host:port) -- ```metrics.influxdb.organization```: InfluxDB organization name (v2 only) +- ```metrics.prometheus-addr```: Address for Prometheus Server (default: 127.0.0.1:7071) ### Transaction Pool Options -- ```txpool.locals```: Comma separated accounts to treat as locals (no flush, priority inclusion) +- ```txpool.accountqueue```: Maximum number of non-executable transaction slots permitted per account (default: 16) -- ```txpool.nolocals```: Disables price exemptions for locally submitted transactions (default: false) +- ```txpool.accountslots```: Minimum number of executable transaction slots guaranteed per account (default: 16) -- ```txpool.journal```: Disk journal for local transaction to survive node restarts (default: transactions.rlp) +- ```txpool.globalqueue```: Maximum number of non-executable transaction slots for all accounts (default: 32768) -- ```txpool.rejournal```: Time interval to regenerate the local transaction journal (default: 1h0m0s) +- ```txpool.globalslots```: Maximum number of executable transaction slots for all accounts (default: 32768) -- ```txpool.pricelimit```: Minimum gas price limit to enforce for acceptance into the pool (default: 1) +- ```txpool.journal```: Disk journal for local transaction to survive node restarts (default: transactions.rlp) -- ```txpool.pricebump```: Price bump percentage to replace an already existing transaction (default: 10) +- ```txpool.lifetime```: Maximum amount of time non-executable transaction are queued (default: 3h0m0s) -- ```txpool.accountslots```: Minimum number of executable transaction slots guaranteed per account (default: 16) +- ```txpool.locals```: Comma separated accounts to treat as locals (no flush, priority inclusion) -- ```txpool.globalslots```: Maximum number of executable transaction slots for all accounts (default: 32768) +- ```txpool.nolocals```: Disables price exemptions for locally submitted transactions (default: false) -- ```txpool.accountqueue```: Maximum number of non-executable transaction slots permitted per account (default: 16) +- ```txpool.pricebump```: Price bump percentage to replace an already existing transaction (default: 10) -- ```txpool.globalqueue```: Maximum number of non-executable transaction slots for all accounts (default: 32768) +- ```txpool.pricelimit```: Minimum gas price limit to enforce for acceptance into the pool (default: 1) -- ```txpool.lifetime```: Maximum amount of time non-executable transaction are queued (default: 3h0m0s) \ No newline at end of file +- ```txpool.rejournal```: Time interval to regenerate the local transaction journal (default: 1h0m0s) \ No newline at end of file diff --git a/docs/cli/snapshot_prune-state.md b/docs/cli/snapshot_prune-state.md index 73742faeac..bd053324da 100644 --- a/docs/cli/snapshot_prune-state.md +++ b/docs/cli/snapshot_prune-state.md @@ -4,13 +4,13 @@ The ```bor snapshot prune-state``` command will prune historical state data with ## Options -- ```datadir```: Path of the data directory to store information +- ```bloomfilter.size```: Size of the bloom filter (default: 2048) -- ```keystore```: Path of the data directory to store keys +- ```datadir```: Path of the data directory to store information - ```datadir.ancient```: Path of the ancient data directory to store information -- ```bloomfilter.size```: Size of the bloom filter (default: 2048) +- ```keystore```: Path of the data directory to store keys ### Cache Options diff --git a/internal/cli/flagset/flagset.go b/internal/cli/flagset/flagset.go index 679c78c4a7..85a846a40b 100644 --- a/internal/cli/flagset/flagset.go +++ b/internal/cli/flagset/flagset.go @@ -39,6 +39,13 @@ type FlagVar struct { Value Updatable } +// ByName implements sort.Interface for []*FlagVar based on the Name field. +type ByName []*FlagVar + +func (a ByName) Len() int { return len(a) } +func (a ByName) Swap(i, j int) { a[i], a[j] = a[j], a[i] } +func (a ByName) Less(i, j int) bool { return a[i].Name < a[j].Name } + func (f *Flagset) addFlag(fl *FlagVar) { f.flags[fl.Name] = fl } @@ -48,7 +55,14 @@ func (f *Flagset) Help() string { items := []string{} + flags := []*FlagVar{} for _, item := range f.flags { + flags = append(flags, item) + } + + sort.Sort(ByName(flags)) + + for _, item := range flags { if item.Default != nil { items = append(items, fmt.Sprintf(" -%s\n %s (default: %v)", item.Name, item.Usage, item.Default)) } else { @@ -102,7 +116,11 @@ func (f *Flagset) MarkDown() string { items = append(items, fmt.Sprintf("### %s Options", k)) } - for _, item := range groups[k] { + flags := make([]*FlagVar, len(groups[k])) + copy(flags, groups[k]) + sort.Sort(ByName(flags)) + + for _, item := range flags { if item.Default != nil { items = append(items, fmt.Sprintf("- ```%s```: %s (default: %v)", item.Name, item.Usage, item.Default)) } else { diff --git a/internal/cli/server/flags.go b/internal/cli/server/flags.go index 35150d5a48..119f3a3747 100644 --- a/internal/cli/server/flags.go +++ b/internal/cli/server/flags.go @@ -28,7 +28,7 @@ func (c *Command) Flags(config *Config) *flagset.Flagset { }) f.IntFlag(&flagset.IntFlag{ Name: "verbosity", - Usage: "Logging verbosity for the server (5=trace|4=debug|3=info|2=warn|1=error|0=crit), default = 3", + Usage: "Logging verbosity for the server (5=trace|4=debug|3=info|2=warn|1=error|0=crit)", Value: &c.cliConfig.Verbosity, Default: c.cliConfig.Verbosity, }) @@ -71,13 +71,13 @@ func (c *Command) Flags(config *Config) *flagset.Flagset { }) f.Uint64Flag(&flagset.Uint64Flag{ Name: "rpc.batchlimit", - Usage: "Maximum number of messages in a batch (default=100, use 0 for no limits)", + Usage: "Maximum number of messages in a batch (use 0 for no limits)", Value: &c.cliConfig.RPCBatchLimit, Default: c.cliConfig.RPCBatchLimit, }) f.Uint64Flag(&flagset.Uint64Flag{ Name: "rpc.returndatalimit", - Usage: "Maximum size (in bytes) a result of an rpc request could have (default=100000, use 0 for no limits)", + Usage: "Maximum size (in bytes) a result of an rpc request could have (use 0 for no limits)", Value: &c.cliConfig.RPCReturnDataLimit, Default: c.cliConfig.RPCReturnDataLimit, }) @@ -433,7 +433,7 @@ func (c *Command) Flags(config *Config) *flagset.Flagset { }) f.Uint64Flag(&flagset.Uint64Flag{ Name: "cache.triesinmemory", - Usage: "Number of block states (tries) to keep in memory (default = 128)", + Usage: "Number of block states (tries) to keep in memory", Value: &c.cliConfig.Cache.TriesInMemory, Default: c.cliConfig.Cache.TriesInMemory, Group: "Cache", @@ -788,7 +788,7 @@ func (c *Command) Flags(config *Config) *flagset.Flagset { }) f.DurationFlag(&flagset.DurationFlag{ Name: "txarrivalwait", - Usage: "Maximum duration to wait for a transaction before explicitly requesting it (defaults to 500ms)", + Usage: "Maximum duration to wait for a transaction before explicitly requesting it", Value: &c.cliConfig.P2P.TxArrivalWait, Default: c.cliConfig.P2P.TxArrivalWait, Group: "P2P",