Show possible values and defaults in the node help#2099
Open
oliv3rdrt wants to merge 1 commit into
Open
Conversation
The node help did not show which values the constrained options accept or what they default to, so users had to read the source to find out. Document the possible values and defaults for --storage-backend and --node-type, and the defaults for --rpc-bind-address and --rpc-enabled, in their help text. Verified with 'node-daemon mainnet --help'.
oliv3rdrt
requested review from
ImplOfAnImpl,
anyxem and
erubboli
as code owners
July 21, 2026 14:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The node help does not show which values the constrained options accept or what they default to, so you currently have to read the source to find out (#548).
This makes a start on it by documenting the following in the help text:
--storage-backend: possible valueslmdb,inmemory, defaults tolmdb.--node-type: possible valuesfull-node,blocks-only-node, defaults tofull-node.--rpc-bind-address: defaults to127.0.0.1with the chain's default RPC port.--rpc-enabled: defaults totrue.I focused on the options where the default has a single clear source in the code. Many of the numeric run options get their defaults deeper in the individual subsystems, so I left those out for now rather than risk documenting a value that might drift out of date. I am happy to extend this to more options if that is a welcome direction.
Verified with
node-daemon mainnet --help. Addresses part of #548.