Skip to content

Commit

Permalink
docs: update dash core help (#85)
Browse files Browse the repository at this point in the history
* docs: update dashd args and commands

* docs: update dash-cli help

* docs: update dash-tx help

* docs: update dash-wallet help
  • Loading branch information
thephez authored Dec 19, 2023
1 parent 7080b4d commit 52cdaeb
Show file tree
Hide file tree
Showing 4 changed files with 226 additions and 102 deletions.
38 changes: 31 additions & 7 deletions docs/dashcore/wallet-arguments-and-commands-dash-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ dash-cli [options] help <command>
-datadir=<dir>
Specify data directory
-generate
Generate blocks immediately, equivalent to RPC generatenewaddress
followed by RPC generatetoaddress. Optional positional integer
arguments are number of blocks to generate (default: 1) and
maximum iterations to try (default: 1000000), equivalent to RPC
generatetoaddress nblocks and maxtries arguments. Example:
dash-cli -generate 4 1000
-getinfo
Get general information from the remote server. Note that unlike
server-side RPC calls, the results of -getinfo is the result of
Expand All @@ -63,6 +71,12 @@ dash-cli [options] help <command>
-named
Pass named instead of positional arguments (default: false)
-netinfo
Get network peer connection information from the remote server. An
optional integer argument from 0 to 4 can be passed for different
peers listings (default: 0). Pass "help" for detailed help
documentation.
-rpcclienttimeout=<n>
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
900)
Expand Down Expand Up @@ -117,38 +131,48 @@ dash-cli [options] help <command>
### Chain selection options

```text
-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test,
regtest
-devnet=<name>
Use devnet chain with provided name
-highsubsidyblocks=<n>
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet-only)
-highsubsidyfactor=<n>
The factor to multiply the normal block subsidy by while in the
highsubsidyblocks window of a chain (default: 1, devnet-only)
-llmqchainlocks=<quorum name>
Override the default LLMQ type used for ChainLocks. Allows using
ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet-only)
ChainLocks with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
-llmqinstantsend=<quorum name>
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_50_60,
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_60_75, devnet-only)
llmq_devnet_dip0024, devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default: llmq_100_67,
-llmqmnhf=<quorum name>
Override the default LLMQ type used for EHF. (default: llmq_devnet,
devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default:
llmq_devnet_platform, devnet-only)
-minimumdifficultyblocks=<n>
The number of blocks that can be mined with the minimum difficulty at
the start of a chain (default: 0, devnet-only)
Expand All @@ -158,5 +182,5 @@ dash-cli [options] help <command>
minutes, devnet-only)
-testnet
Use the test chain
Use the test chain. Equivalent to -chain=test
```
35 changes: 24 additions & 11 deletions docs/dashcore/wallet-arguments-and-commands-dash-tx.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Usage:

### Options

```
```text
-?
Print this help message and exit
Expand All @@ -31,43 +31,56 @@ Usage:
-txid
Output only the hex-encoded transaction id of the resultant transaction.
-version
Print version and exit
```

### Chain selection options

```
```text
-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test,
regtest
-devnet=<name>
Use devnet chain with provided name
-highsubsidyblocks=<n>
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet-only)
-highsubsidyfactor=<n>
The factor to multiply the normal block subsidy by while in the
highsubsidyblocks window of a chain (default: 1, devnet-only)
-llmqchainlocks=<quorum name>
Override the default LLMQ type used for ChainLocks. Allows using
ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet-only)
ChainLocks with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
-llmqinstantsend=<quorum name>
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_50_60,
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_60_75, devnet-only)
llmq_devnet_dip0024, devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default: llmq_100_67,
-llmqmnhf=<quorum name>
Override the default LLMQ type used for EHF. (default: llmq_devnet,
devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default:
llmq_devnet_platform, devnet-only)
-minimumdifficultyblocks=<n>
The number of blocks that can be mined with the minimum difficulty at
the start of a chain (default: 0, devnet-only)
Expand All @@ -77,12 +90,12 @@ Usage:
minutes, devnet-only)
-testnet
Use the test chain
Use the test chain. Equivalent to -chain=test
```

### Commands

```
```text
delin=N
Delete input N from TX
Expand Down Expand Up @@ -126,7 +139,7 @@ Usage:

### Register Commands

```
```text
load=NAME:FILENAME
Load JSON file FILENAME into register NAME
Expand Down
41 changes: 29 additions & 12 deletions docs/dashcore/wallet-arguments-and-commands-dash-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,23 @@ Usage:

### Options

```
```text
-?
Print this help message and exit
-datadir=<dir>
Specify data directory
-version
Print version and exit
-wallet=<wallet-name>
Specify wallet name
```

### Debugging/Testing options

```
```text
-debug=<category>
Output debugging information (default: 0).
Expand All @@ -42,39 +45,49 @@ Usage:

### Chain selection options

```
```text
-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test,
regtest
-devnet=<name>
Use devnet chain with provided name
-highsubsidyblocks=<n>
The number of blocks with a higher than normal subsidy to mine at the
start of a chain (default: 0, devnet-only)
start of a chain. Block after that height will have fixed subsidy
base. (default: 0, devnet-only)
-highsubsidyfactor=<n>
The factor to multiply the normal block subsidy by while in the
highsubsidyblocks window of a chain (default: 1, devnet-only)
-llmqchainlocks=<quorum name>
Override the default LLMQ type used for ChainLocks. Allows using
ChainLocks with smaller LLMQs. (default: llmq_50_60, devnet-only)
ChainLocks with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
-llmqinstantsend=<quorum name>
Override the default LLMQ type used for InstantSend. Allows using
InstantSend with smaller LLMQs. (default: llmq_50_60,
InstantSend with smaller LLMQs. (default: llmq_devnet,
devnet-only)
-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
llmq_60_75, devnet-only)
llmq_devnet_dip0024, devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default: llmq_100_67,
-llmqmnhf=<quorum name>
Override the default LLMQ type used for EHF. (default: llmq_devnet,
devnet-only)
-llmqplatform=<quorum name>
Override the default LLMQ type used for Platform. (default:
llmq_devnet_platform, devnet-only)
-minimumdifficultyblocks=<n>
The number of blocks that can be mined with the minimum difficulty at
the start of a chain (default: 0, devnet-only)
Expand All @@ -84,18 +97,22 @@ Usage:
minutes, devnet-only)
-testnet
Use the test chain
Use the test chain. Equivalent to -chain=test
```

### Commands

```
```text
create
Create new wallet file
info
Get wallet info
salvage
Attempt to recover private keys from a corrupt wallet
Attempt to recover private keys from a corrupt wallet. Warning:
'salvage' is experimental.
wipetxes
Wipe all transactions from a wallet
```
Loading

0 comments on commit 52cdaeb

Please sign in to comment.