Skip to content

Missing default argument values in the node help #548

Description

@pavel-kokolemin

Node binary does not show default values in the help.
We should show default (and possible allowed values) so users could easily tweak what they need.

For example from bitcoind --help:

...
  -assumevalid=<hex>
       If this block is in the chain assume that it and its ancestors are valid
       and potentially skip their script verification (0 to verify all,
       default:
       0000000000000000000b9d2ec5a352ecba0592946514a92f14319dc2b367fc72,
       testnet:
       000000000000006433d1efec504c53ca332b64963c425395515b01977bd7b3b0,
       signet:
       0000002a1de0f46379358c1fd09906f7ac59adf3712323ed90eb59e4c183c020)

  -blockfilterindex=<type>
       Maintain an index of compact filters by block (default: 0, values:
       basic). If <type> is not supplied or if <type> = 1, indexes for
       all known types are enabled.
...
  -blockreconstructionextratxn=<n>
       Extra transactions to keep in memory for compact block reconstructions
       (default: 100)

  -blocksdir=<dir>
       Specify directory to hold blocks subdirectory for *.dat files (default:
       <datadir>)

  -blocksonly
       Whether to reject transactions from network peers. Automatic broadcast
       and rebroadcast of any transactions from inbound peers is
       disabled, unless the peer has the 'forcerelay' permission. RPC
       transactions are not affected. (default: 0)

  -conf=<file>
       Specify path to read-only configuration file. Relative paths will be
       prefixed by datadir location. (default: bitcoin.conf)
...

Compare to node regtest --help:

...
        --chain-address-prefix <CHAIN_ADDRESS_PREFIX>                                            
            Address prefix                                                                       
                                                                                                 
        --chain-coin-decimals <CHAIN_COIN_DECIMALS>                                              
            Coin decimals         
                                                                                                 
        --chain-max-block-header-size <CHAIN_MAX_BLOCK_HEADER_SIZE>                              
            The maximum block header size in bytes             
                                                                                                 
        --chain-max-block-size-with-smart-contracts <CHAIN_MAX_BLOCK_SIZE_WITH_SMART_CONTRACTS>
            The maximum smart contracts size ib block in bytes                                   
...

Activity

  1. added
    documentationImprovements or additions to documentation
    daemonIssues related to daemon instances (whether it's wallet, node or otherwise)
    on Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    daemonIssues related to daemon instances (whether it's wallet, node or otherwise)documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions