Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update core commands to v21 #110

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/dashcore/wallet-arguments-and-commands-dash-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ dash-cli [options] help <command>
-?
Print this help message and exit

-addrinfo
Get the number of addresses known to the node, per network and total.

-color=<when>
Color setting for CLI output (default: auto). Valid values: always, auto
(add color codes when standard output is connected to a terminal
and OS is not WIN32), never.

-conf=<file>
Specify configuration file. Relative paths will be prefixed by datadir
location. (default: dash.conf)
Expand Down Expand Up @@ -101,6 +109,10 @@ dash-cli [options] help <command>
-rpcwait
Wait for RPC server to start

-rpcwaittimeout=<n>
Timeout in seconds to wait for the RPC server to start, or 0 for no
timeout. (default: 0)

-rpcwallet=<walletname>
Send RPC for non-default wallet on RPC server (needs to exactly match
corresponding -wallet option passed to dashd). This changes the
Expand Down Expand Up @@ -153,8 +165,7 @@ dash-cli [options] help <command>
devnet-only)

-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet-only)

-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
Expand Down
3 changes: 1 addition & 2 deletions docs/dashcore/wallet-arguments-and-commands-dash-tx.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ Usage:
devnet-only)

-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet-only)

-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
Expand Down
23 changes: 21 additions & 2 deletions docs/dashcore/wallet-arguments-and-commands-dash-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ Usage:
-datadir=<dir>
Specify data directory

-descriptors
Create descriptors wallet. Only for 'create'

-dumpfile=<file name>
When used with 'dump', writes out the records to this file. When used
with 'createfromdump', loads the records into a new wallet.

-format=<format>
The format of the wallet file to create. Either "bdb" or "sqlite". Only
used with 'createfromdump'

-usehd
Create HD (hierarchical deterministic) wallet (default: 1)

-version
Print version and exit

Expand Down Expand Up @@ -68,8 +82,7 @@ Usage:
devnet-only)

-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet-only)

-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
Expand Down Expand Up @@ -101,6 +114,12 @@ Usage:
create
Create new wallet file

createfromdump
Create new wallet file from dumped records

dump
Print out all of the wallet key-value records

info
Get wallet info

Expand Down
105 changes: 68 additions & 37 deletions docs/dashcore/wallet-arguments-and-commands-dashd.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ dashd [options]
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:
0000000000000020d5e38b6aef5bc8e430029444d7977b46f710c7d281ef1281,
000000000000001889bd33ef019065e250d32bd46911f4003d3fdd8128b5358d,
testnet:
0000000386cf5061ea16404c66deb83eb67892fa4f79b9e58e5eaab097ec2bd6)
00000034bfeb926662ba547c0b8dd4ba8cbb6e0c581f4e7d1bddce8f9ca3a608)
-blockfilterindex=<type>
Maintain an index of compact filters by block (default: 0, values:
Expand Down Expand Up @@ -72,7 +72,11 @@ dashd [options]
prefixed by datadir location. (default: dash.conf)
-daemon
Run in the background as a daemon and accept commands
Run in the background as a daemon and accept commands (default: 0)
-daemonwait
Wait for initialization to be finished before exiting. This implies
-daemon (default: 0)
-datadir=<dir>
Specify data directory
Expand Down Expand Up @@ -112,9 +116,9 @@ dashd [options]
-minimumchainwork=<hex>
Minimum work assumed to exist on a valid chain in hex (default:
000000000000000000000000000000000000000000009134566d753c5e08ab88,
00000000000000000000000000000000000000000000988117deadb0db9cd5b8,
testnet:
00000000000000000000000000000000000000000000000002ecd6cf5ad0f774)
000000000000000000000000000000000000000000000000031779704a0f54b4)
-par=<n>
Set the number of script verification threads (-16 to 15, 0 = auto, <0 =
Expand Down Expand Up @@ -165,8 +169,10 @@ dashd [options]
```text
-addnode=<ip>
Add a node to connect to and attempt to keep the connection open (see
the `addnode` RPC command help for more info). This option can be
specified multiple times to add multiple nodes.
the addnode RPC help for more info). This option can be specified
multiple times to add multiple nodes; connections are limited to
8 at a time and are counted separately from the -maxconnections
limit.
-allowprivatenet
Allow RFC1918 addresses to be relayed and connected to (default: 0)
Expand All @@ -176,10 +182,6 @@ dashd [options]
ip_asn.map). Relative paths will be prefixed by the net-specific
datadir location.
-banscore=<n>
Threshold for disconnecting and discouraging misbehaving peers (default:
100)
-bantime=<n>
Default duration (in seconds) of manually configured bans (default:
86400)
Expand All @@ -191,6 +193,11 @@ dashd [options]
(default: 127.0.0.1:9996=onion, testnet: 127.0.0.1:19996=onion,
regtest: 127.0.0.1:19896=onion)
-cjdnsreachable
If set, then this host is configured for CJDNS (connecting to fc00::/8
addresses would lead us to the CJDNS network, see doc/cjdns.md)
(default: 0)
-connect=<ip>
Connect only to the specified node; -noconnect disables automatic
connections (the rules for this peer are the same as for
Expand All @@ -211,16 +218,17 @@ dashd [options]
-externalip=<ip>
Specify your own public address
-fixedseeds
Allow fixed seeds if DNS seeds don't provide peers (default: 1)
-forcednsseed
Always query for peer addresses via DNS lookup (default: 0)
-i2pacceptincoming
If set and -i2psam is also set then incoming I2P connections are
accepted via the SAM proxy. If this is not set but -i2psam is set
then only outgoing connections will be made to the I2P network.
Ignored if -i2psam is not set. Listening for incoming I2P
connections is done through the SAM proxy, not by binding to a
local address and port (default: 1)
Whether to accept inbound I2P connections (default: 1). Ignored if
-i2psam is not set. Listening for inbound I2P connections is done
through the SAM proxy, not by binding to a local address and
port.
-i2psam=<ip:port>
I2P SAM proxy to reach I2P peers and accept I2P connections (default:
Expand All @@ -234,7 +242,9 @@ dashd [options]
-maxconnections=<n>
Maintain at most <n> connections to peers (temporary service connections
excluded) (default: 125)
excluded) (default: 125). This limit does not apply to
connections manually added via -addnode or the addnode RPC, which
have a separate limit of 8.
-maxreceivebuffer=<n>
Maximum per-connection receive buffer, <n>*1000 bytes (default: 5000)
Expand All @@ -255,18 +265,19 @@ dashd [options]
-natpmp
Use NAT-PMP to map the listening port (default: 0)
-networkactive
Enable all P2P network activity (default: 1). Can be changed by the
setnetworkactive RPC command
-onion=<ip:port>
Use separate SOCKS5 proxy to reach peers via Tor onion services, set
-noonion to disable (default: -proxy)
-onlynet=<net>
Make outgoing connections only through network <net> (ipv4, ipv6, onion,
i2p). Incoming connections are not affected by this option. This
option can be specified multiple times to allow multiple
networks. Warning: if it is used with non-onion networks and the
-onion or -proxy option is set, then outbound onion connections
will still be made; use -noonion or -onion=0 to disable outbound
onion connections in this case.
Make automatic outbound connections only to network <net> (ipv4, ipv6,
onion, i2p, cjdns). Inbound and manual connections are not
affected by this option. It can be specified multiple times to
allow multiple networks.
-peerblockfilters
Serve compact block filters to peers per BIP 157 (default: 0)
Expand Down Expand Up @@ -407,6 +418,10 @@ dashd [options]
backup, if none of the addresses in the original keypool have
been used.
-maxapsfee=<n>
Spend up to this amount in additional (absolute) fees (in DASH) if it
allows the use of partial spend avoidance (default: 0.00)
-rescan=<mode>
Rescan the block chain for missing wallet transactions on startup (1 =
start from wallet creation time, 2 = start from genesis block)
Expand Down Expand Up @@ -668,6 +683,10 @@ dashd [options]
-capturemessages
Capture all P2P messages to disk
-checkaddrman=<n>
Run addrman consistency checks every <n> operations. Use 0 to disable.
(default: 0)
-checkblockindex
Do a consistency check for the block tree, and occasionally. (default:
0, regtest: 1)
Expand All @@ -683,19 +702,20 @@ dashd [options]
checks of the previous levels (0-4, default: 3)
-checkmempool=<n>
Run checks every <n> transactions (default: 0, regtest: 1)
Run mempool consistency checks every <n> transactions. Use 0 to disable.
(default: 0, regtest: 1)
-checkpoints
Enable rejection of any forks from the known historical chain until
block 2029000 (default: 1)
block 2109672 (default: 1)
-debug=<category>
Output debugging information (default: -nodebug, supplying <category> is
optional). If <category> is not supplied or if <category> = 1,
output all debugging information. <category> can be: addrman,
bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf,
estimatefee, gobject, http, i2p, instantsend, leveldb, libevent,
llmq, llmq-dkg, llmq-sigs, mempool, mempoolrej, mnpayments,
llmq, llmq-dkg, llmq-sigs, lock, mempool, mempoolrej, mnpayments,
mnsync, net, netconn, proxy, prune, qt, rand, reindex, rpc,
selectcoins, spork, tor, validation, walletdb, zmq. This option
can be specified multiple times to output multiple categories.
Expand Down Expand Up @@ -738,16 +758,17 @@ dashd [options]
-logips
Include IP addresses in debug output (default: 0)
-logsourcelocations
Prepend debug output with name of the originating source location
(source file, line number and function name) (default: 0)
-logthreadnames
Prepend debug output with name of the originating thread (only available
on platforms supporting thread_local) (default: 0)
-logtimemicros
Add microsecond precision to debug timestamps (default: 0)
-logtimestamps
Prepend debug output with timestamp (default: 1)
-maxsigcachesize=<n>
Limit sum of signature cache and script execution cache sizes to <n> MiB
(default: 32)
Expand Down Expand Up @@ -805,6 +826,9 @@ dashd [options]
### Chain selection options

```text
-bip147height=<activation>
Override BIP147 activation height (regtest-only)
-budgetparams=<masternode>:<budget>:<superblock>
Override masternode, budget and superblock start heights (regtest-only)
Expand Down Expand Up @@ -836,8 +860,7 @@ dashd [options]
devnet-only)
-llmqdevnetparams=<size>:<threshold>
Override the default LLMQ size for the LLMQ_DEVNET quorum (default: 3:2,
devnet-only)
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet-only)
-llmqinstantsenddip0024=<quorum name>
Override the default LLMQ type used for InstantSendDIP0024. (default:
Expand Down Expand Up @@ -879,10 +902,11 @@ dashd [options]
-testnet
Use the test chain. Equivalent to -chain=test
-vbparams=<deployment>:<start>:<end>(:<window>:<threshold/thresholdstart>(:<thresholdmin>:<falloffcoeff>:<mnactivation>))
Use given start/end times for specified version bits deployment
(regtest-only). Specifying window, threshold/thresholdstart,
thresholdmin, falloffcoeff and mnactivation is optional.
-vbparams=<deployment>:<start>:<end>(:min_activation_height(:<window>:<threshold/thresholdstart>(:<thresholdmin>:<falloffcoeff>:<mnactivation>)))
Use given start/end times and min_activation_height for specified
version bits deployment (regtest-only). Specifying window,
threshold/thresholdstart, thresholdmin, falloffcoeff and
mnactivation is optional.
```

### Masternode options
Expand Down Expand Up @@ -996,6 +1020,13 @@ dashd [options]
Location of the auth cookie. Relative paths will be prefixed by a
net-specific datadir location. (default: data dir)
-rpcexternaluser=<users>
List of comma-separated usernames for JSON-RPC external connections
-rpcexternalworkqueue=<n>
Set the depth of the work queue to service external RPC calls (default:
16)
-rpcpassword=<pw>
Password for JSON-RPC connections
Expand Down
4 changes: 0 additions & 4 deletions docs/dashcore/wallet-arguments-and-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,6 @@ Usage:

### dash-wallet

> 👍
>
> Introduced in Dash Core 18.0.0
View all [command line options for dash-wallet](../dashcore/wallet-arguments-and-commands-dash-wallet.md).

```bash
Expand Down
2 changes: 0 additions & 2 deletions docs/dashcore/wallet-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ The options to choose a network (`regtest=` and `testnet=`) must be specified ou

## settings.json

> 👍 Added in Dash Core 18.1.0
Since Dash Core 18.1, wallets created or loaded in the GUI will now be automatically loaded on startup so they don't need to be manually reloaded the next time Dash is started. The list of wallets to load on startup is stored in `\<datadir\>/settings.json`. Additionally, any wallets specified in `-wallet=` settings on the command line or in the `dash.conf` file are also loaded. Wallets that are unloaded in the GUI are also removed from the settings list so they won't automatically load on the next startup.

The `createwallet`, `loadwallet`, and `unloadwallet` RPCs now accept `load_on_startup` options to modify the settings list. Unless these options are explicitly set to true or false, the list is not modified, so the RPC methods remain backwards compatible.
Loading