Skip to content

Remove duplicate help text#962

Merged
fassadlr merged 3 commits intostratisproject:release/1.3.0.0from
quantumagi:fixhelp
Apr 27, 2022
Merged

Remove duplicate help text#962
fassadlr merged 3 commits intostratisproject:release/1.3.0.0from
quantumagi:fixhelp

Conversation

@quantumagi
Copy link
Contributor

@quantumagi quantumagi commented Apr 26, 2022

After this PR:

  • No duplicate help messages
  • Help is aligned
  • Sections are named appropriately.
[info]  Stratis.Bitcoin.Configuration.NodeSettings
        Usage:
         dotnet run Stratis.CirrusMinerD.dll [arguments]

        Command line arguments:

        -help/--help                   Show this help.
        -conf=<Path>                   Path to the configuration file. Defaults to C:\Users\Gustav\AppData\Roaming\StratisNode\cirrus\CirrusMain\cirrus.conf.
        -datadir=<Path>                Path to the data directory. Defaults to C:\Users\Gustav\AppData\Roaming\StratisNode\cirrus\CirrusMain.
        -datadirroot=<Path>            The path to the root data directory, which holds all node data on the machine. Defaults to 'StratisNode'.
        -debug[=<string>]              Set 'Debug' logging level. Specify what to log via e.g. '-debug=Stratis.Bitcoin.Miner,Stratis.Bitcoin.Wallet'.
        -loglevel=<string>             Direct control over the logging level: '-loglevel=trace/debug/info/warn/error/fatal'.
        -testnet                       Use the testnet chain.
        -regtest                       Use the regtestnet chain.
        -mintxfee=<number>             Minimum fee rate. Defaults to 10000.
        -fallbackfee=<number>          Fallback fee rate. Defaults to 10000.
        -minrelaytxfee=<number>        Minimum relay fee rate. Defaults to 10000.
        -displaybenchstats=<bool>      Logs benchmark statistics to the console window (true/false).

[info]  Stratis.Bitcoin.Configuration.Settings.ConnectionManagerSettings
        -port=<port>                   The default network port to connect to. Default 16179.
        -listen=<0 or 1>               Accept connections from the outside (defaulted to 1 unless -connect args specified).
        -connect=<ip:port>             Specified node to connect to. Can be specified multiple times.
        -addnode=<ip:port>             Add a node to connect to and attempt to keep the connection open. Can be specified multiple times.
        -bind=<ip:port>                Bind to given address. Use [host]:port notation for IPv6. Can be specified multiple times.
        -whitebind=<ip:port>           Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6. Can be specified multiple times.
        -whitelist=<ip:port>           Whitelist peers having the given IP:port address, both inbound or outbound. Can be specified multiple times.
        -externalip=<ip>               Specify your own public address.
        -bantime=<number>              Number of seconds to keep misbehaving peers from reconnecting. Default 1920.
        -maxoutboundconnections=<number> The maximum number of outbound connections. Default 16.
        -maxinboundconnections=<number> The maximum number of inbound connections. Default 109.
        -initialconnectiontarget=<number> The number of connections to be reached before a 1 second connection interval (initally 100ms). Default 1.
        -synctime=<0 or 1>             Sync with peers. Default 1.
        -agentprefix=<string>          An optional prefix for the node's user agent that will be shared with peers in the version handshake.
        -blocksonly=<0 or 1>           Enable bandwidth saving setting to send and received confirmed blocks only. Defaults to False.
        -iprangefiltering=<0 or 1>     Disallow connection to peers in same IP range. Default is 1 for remote hosts.

[info]  Stratis.Bitcoin.Features.BlockStore.StoreSettings
        -prune=<amount of blocks>      Enable pruning to reduce storage requirements by enabling deleting of old blocks. Value of 0 means pruning is disabled.
        -maxblkstoremem=<number>       Max memory to use before flushing blocks to disk in MB. Default is 5 MB.
        -txindex=<0 or 1>              Enable to maintain a full transaction index.
        -reindex=<0 or 1>              Rebuild store with tx index from block data files on disk.
        -reindex-chain=<0 or 1>        Rebuild the coindb from block data files on disk.
        -addressindex=<0 or 1>         Enable to maintain a full address index.
        -compactionthreshold=<integer value>         Specify address indexer compaction threshold.

[info]  Stratis.Bitcoin.Configuration.Settings.ConsensusSettings
        -checkpoints=<0 or 1>          Use checkpoints. Default 1.
        -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). Defaults to bfd4a96a6c5250f18bf7c586761256fa5f8753ffa10b24160f0648a452823a95.
        -maxtipage=<number>            Max tip age. Default 768.
        -maxblkmem=<number>            Max memory to use for unconsumed blocks in MB. Default 200 (this does not include the size of objects in memory).
        -dbcache=<number>              Max cache memory for the coindb in MB. Default 200 (this does not include the size of objects in memory).
        -dbflush=<number>              How often to flush the cache to disk when in IBD in minutes. Default 10 min (min=1min, max=60min).

[info]  Stratis.Bitcoin.Features.Api.ApiSettings
        -apiuri=<string>               URI to node's API interface. Defaults to 'http://localhost'.
        -apiport=<0-65535>             Port of node's API interface. Defaults to 37223.
        -keepalive=<seconds>           Keep Alive interval (set in seconds). Default: 0 (no keep alive).
        -usehttps=<bool>               Use https protocol on the API. Defaults to false.
        -certificatefilepath=<string>  Path to the certificate used for https traffic encryption. Defaults to <null>. Password protected files are not supported. On MacOs, only p12 certificates can be used without password.

[info]  Stratis.Bitcoin.Features.MemoryPool.MempoolSettings
        -maxmempool=<megabytes>        Maximal size of the transaction memory pool in megabytes. Defaults to 300.
        -mempoolexpiry=<hours>         Maximum number of hours to keep transactions in the mempool. Defaults to 336.
        -relaypriority=<0 or 1>        Enable high priority for relaying free or low-fee transactions.
        -limitancestorcount=<count>    Maximum number of ancestors of a transaction in mempool (including itself). Defaults to 25.
        -limitancestorsize=<kB>        Maximal size in kB of ancestors of a transaction in mempool (including itself). Defaults to 101.
        -limitdescendantcount=<count>  Maximum number of descendants any ancestor can have in mempool (including itself). Defaults to 25.
        -limitdescendantsize=<kB>      Maximum size in kB of descendants any ancestor can have in mempool (including itself). Defaults to 101.
        -mempoolreplacement=<0 or 1>   Enable transaction replacement in the memory pool.
        -maxorphantx=<kB>              Maximum number of orphan transactions kept in memory. Defaults to 100.
        -whitelistrelay=<0 or 1>       Enable to accept relayed transactions received from whitelisted peers even when not relaying transactions. Defaults to True.
        -acceptnonstdtxn=<0 or 1>      Accept non-standard transactions. Default 1.
        -permitbaremultisig=<0 or 1>   Relay non-P2SH multisig. Defaults to True.

[info]  Stratis.Bitcoin.Features.RPC.RpcSettings
        -server=<0 or 1>               Accept command line and JSON-RPC commands. Default false.
        -rpcuser=<string>              Username for JSON-RPC connections
        -rpcpassword=<string>          Password for JSON-RPC connections
        -rpcport=<0-65535>             Listen for JSON-RPC connections on <port>. Default: 16175
        -rpcbind=<ip:port>             Bind to given address to listen for JSON-RPC connections. This option can be specified multiple times. Default: bind to all interfaces
        -rpcallowip=<ip>               Allow JSON-RPC connections from specified source. This option can be specified multiple times.

[info]  Stratis.Bitcoin.Features.Wallet.WalletSettings
        -savetrxhex=<0 or 1>           Save the hex of transactions in the wallet file. Default: 0.
        -defaultwalletname=<string>    Loads the specified wallet on startup. If it doesn't exist, it will be created automatically.
        -defaultwalletpassword=<string> Overrides the default wallet password. Default: default.
        -unlockdefaultwallet=<0 or 1>  Unlocks the specified default wallet. Default: 0.
        -walletaddressbuffer=<number>  Size of the buffer of unused addresses maintained in an account. Default: 20.

@fassadlr fassadlr merged commit 8399c95 into stratisproject:release/1.3.0.0 Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants