Skip to content

Commit 3036395

Browse files
committed
docs: update cli info and script
Script now can take help output and directly update the markdown file
1 parent 32b2d34 commit 3036395

6 files changed

+325
-248
lines changed

docs/core/dashcore/wallet-arguments-and-commands-dash-cli.md

Lines changed: 7 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ View [the list of RPCs](../api/remote-procedure-call-quick-reference.md) for mor
4848
Print this help message and exit
4949
5050
-addrinfo
51-
Get the number of addresses known to the node, per network and total.
51+
Get the number of addresses known to the node, per network and total,
52+
after filtering for quality and recency. The total number of
53+
addresses known to the node may be higher.
5254
5355
-color=<when>
5456
Color setting for CLI output (default: auto). Valid values: always, auto
@@ -63,17 +65,17 @@ View [the list of RPCs](../api/remote-procedure-call-quick-reference.md) for mor
6365
Specify data directory
6466
6567
-generate
66-
Generate blocks immediately, equivalent to RPC getnewaddress followed by
67-
RPC generatetoaddress. Optional positional integer arguments are
68+
Generate blocks, equivalent to RPC getnewaddress followed by RPC
69+
generatetoaddress. Optional positional integer arguments are
6870
number of blocks to generate (default: 1) and maximum iterations
6971
to try (default: 1000000), equivalent to RPC generatetoaddress
7072
nblocks and maxtries arguments. Example: dash-cli -generate 4
7173
1000
7274
7375
-getinfo
7476
Get general information from the remote server. Note that unlike
75-
server-side RPC calls, the results of -getinfo is the result of
76-
multiple non-atomic requests. Some entries in the result may
77+
server-side RPC calls, the output of -getinfo is the result of
78+
multiple non-atomic requests. Some entries in the output may
7779
represent results from different states (e.g. wallet balance may
7880
be as of a different block from the chain state reported)
7981
@@ -153,43 +155,6 @@ View [the list of RPCs](../api/remote-procedure-call-quick-reference.md) for mor
153155
-devnet=<name>
154156
Use devnet chain with provided name
155157
156-
-highsubsidyblocks=<n>
157-
The number of blocks with a higher than normal subsidy to mine at the
158-
start of a chain. Block after that height will have fixed subsidy
159-
base. (default: 0, devnet-only)
160-
161-
-highsubsidyfactor=<n>
162-
The factor to multiply the normal block subsidy by while in the
163-
highsubsidyblocks window of a chain (default: 1, devnet-only)
164-
165-
-llmqchainlocks=<quorum name>
166-
Override the default LLMQ type used for ChainLocks. Allows using
167-
ChainLocks with smaller LLMQs. (default: llmq_devnet,
168-
devnet-only)
169-
170-
-llmqdevnetparams=<size>:<threshold>
171-
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet-only)
172-
173-
-llmqinstantsenddip0024=<quorum name>
174-
Override the default LLMQ type used for InstantSendDIP0024. (default:
175-
llmq_devnet_dip0024, devnet-only)
176-
177-
-llmqmnhf=<quorum name>
178-
Override the default LLMQ type used for EHF. (default: llmq_devnet,
179-
devnet-only)
180-
181-
-llmqplatform=<quorum name>
182-
Override the default LLMQ type used for Platform. (default:
183-
llmq_devnet_platform, devnet-only)
184-
185-
-minimumdifficultyblocks=<n>
186-
The number of blocks that can be mined with the minimum difficulty at
187-
the start of a chain (default: 0, devnet-only)
188-
189-
-powtargetspacing=<n>
190-
Override the default PowTargetSpacing value in seconds (default: 2.5
191-
minutes, devnet-only)
192-
193158
-testnet
194159
Use the test chain. Equivalent to -chain=test
195160

docs/core/dashcore/wallet-arguments-and-commands-dash-qt.md

Lines changed: 77 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,15 @@ options](#ui-options).
3636
If this block is in the chain assume that it and its ancestors are valid
3737
and potentially skip their script verification (0 to verify all,
3838
default:
39-
000000000000001cf26547602d982dcaa909231bbcd1e70c0eb3c65de25473ba,
39+
0000000000000009ba1e8f47851d036bb618a4f6565eb3c32d1f647d450ff195,
4040
testnet:
41-
000000eef20eb0062abd4e799967e98bdebb165dd1c567ab4118c1c86c6e948f)
41+
00000107d42829a38e31c1a38c660d621e1ca376a880df1520e85e38af175d3a)
4242
4343
-blockfilterindex=<type>
4444
Maintain an index of compact filters by block (default: 0, values:
4545
basic). If <type> is not supplied or if <type> = 1, indexes for
46-
all known types are enabled.
46+
all known types are enabled. Automatically enabled for
47+
masternodes with value 'basic'.
4748
4849
-blocknotify=<cmd>
4950
Execute command when the best block changes (%s in cmd is replaced by
@@ -119,14 +120,18 @@ options](#ui-options).
119120
120121
-minimumchainwork=<hex>
121122
Minimum work assumed to exist on a valid chain in hex (default:
122-
000000000000000000000000000000000000000000009eb0f1d7fefc8750aebb,
123+
00000000000000000000000000000000000000000000ae8d578b28f390b9c630,
123124
testnet:
124-
000000000000000000000000000000000000000000000000031ee38bc0876cef)
125+
000000000000000000000000000000000000000000000000036073cd80626b9c)
125126
126127
-par=<n>
127128
Set the number of script verification threads (-16 to 15, 0 = auto, <0 =
128129
leave that many cores free, default: 0)
129130
131+
-parbls=<n>
132+
Set the number of BLS verification threads (-16 to 33, 0 = auto, <0 =
133+
leave that many cores free, default: 0)
134+
130135
-persistmempool
131136
Whether to save the mempool on shutdown and load on restart (default: 1)
132137
@@ -217,7 +222,7 @@ options](#ui-options).
217222
218223
-dnsseed
219224
Query for peer addresses via DNS lookup, if low on addresses (default: 1
220-
unless -connect used)
225+
unless -connect used or -maxconnections=0)
221226
222227
-externalip=<ip>
223228
Specify your own public address
@@ -239,7 +244,8 @@ options](#ui-options).
239244
none)
240245
241246
-listen
242-
Accept connections from outside (default: 1 if no -proxy or -connect)
247+
Accept connections from outside (default: 1 if no -proxy, -connect or
248+
-maxconnections=0)
243249
244250
-listenonion
245251
Automatically create Tor onion service (default: 1)
@@ -259,8 +265,8 @@ options](#ui-options).
259265
260266
-maxtimeadjustment
261267
Maximum allowed median peer time offset adjustment. Local perspective of
262-
time may be influenced by peers forward or backward by this
263-
amount. (default: 4200 seconds)
268+
time may be influenced by outbound peers forward or backward by
269+
this amount (default: 4200 seconds).
264270
265271
-maxuploadtarget=<n>
266272
Tries to keep outbound traffic under the given target per 24h. Limit
@@ -276,9 +282,10 @@ options](#ui-options).
276282
Enable all P2P network activity (default: 1). Can be changed by the
277283
setnetworkactive RPC command
278284
279-
-onion=<ip:port>
285+
-onion=<ip:port|path>
280286
Use separate SOCKS5 proxy to reach peers via Tor onion services, set
281-
-noonion to disable (default: -proxy)
287+
-noonion to disable (default: -proxy). May be a local file path
288+
prefixed with 'unix:'.
282289
283290
-onlynet=<net>
284291
Make automatic outbound connections only to network <net> (ipv4, ipv6,
@@ -287,7 +294,8 @@ options](#ui-options).
287294
allow multiple networks.
288295
289296
-peerblockfilters
290-
Serve compact block filters to peers per BIP 157 (default: 0)
297+
Serve compact block filters to peers per BIP 157 (default: 0,
298+
automatically enabled for masternodes)
291299
292300
-peerbloomfilters
293301
Support filtering of blocks and transaction with bloom filters (default:
@@ -298,17 +306,15 @@ options](#ui-options).
298306
peer, wait this amount of time before considering disconnection
299307
based on inactivity (minimum: 1, default: 60)
300308
301-
-permitbaremultisig
302-
Relay non-P2SH multisig (default: 1)
303-
304309
-port=<port>
305310
Listen for connections on <port>. Nodes not using the default ports
306311
(default: 9999, testnet: 19999, regtest: 19899) are unlikely to
307312
get incoming connections. Not relevant for I2P (see doc/i2p.md).
308313
309-
-proxy=<ip:port>
314+
-proxy=<ip:port|path>
310315
Connect through SOCKS5 proxy, set -noproxy to disable (default:
311-
disabled)
316+
disabled). May be a local file path prefixed with 'unix:' if the
317+
proxy supports it.
312318
313319
-proxyrandomize
314320
Randomize credentials for every proxy connection. This enables Tor
@@ -340,11 +346,10 @@ options](#ui-options).
340346
Enable transaction reconciliations per BIP 330 (default: 0)
341347
342348
-upnp
343-
Use UPnP to map the listening port (default: 1 when listening and no
344-
-proxy)
349+
Use UPnP to map the listening port (default: 0)
345350
346351
-v2transport
347-
Support v2 transport (default: 0)
352+
Support v2 transport (default: 1)
348353
349354
-whitebind=<[permissions@]addr>
350355
Bind to the given address and add permission flags to the peers
@@ -441,9 +446,6 @@ options](#ui-options).
441446
Specify the number of seconds between periodic measurements (default:
442447
60)
443448
444-
-statsport=<port>
445-
Specify statsd port (default: 8125)
446-
447449
-statsprefix=<string>
448450
Specify an optional string prepended to every stats key (default: )
449451
@@ -466,6 +468,11 @@ options](#ui-options).
466468
being used. Always enabled for wallets with "avoid_reuse"
467469
enabled, otherwise default: 0.
468470
471+
-consolidatefeerate=<amt>
472+
The maximum feerate (in DASH/kvB) at which transaction building may use
473+
more inputs than strictly necessary so that the wallet's UTXO
474+
pool can be reduced (default: 0.00001).
475+
469476
-createwalletbackups=<n>
470477
Number of automatic wallet backups (default: 10)
471478
@@ -637,9 +644,12 @@ options](#ui-options).
637644
This option is only used by tests to improve their performance
638645
(default: false)
639646
647+
-walletcrosschain
648+
Allow reusing wallet files across chains (default: 0)
649+
640650
-walletrejectlongchains
641651
Wallet will not create transactions that violate mempool chain limits
642-
(default: 0)
652+
(default: 1)
643653
644654
```
645655

@@ -816,25 +826,25 @@ options](#ui-options).
816826
817827
-checkpoints
818828
Enable rejection of any forks from the known historical chain until
819-
block 2175051 (default: 1)
829+
block 2361500 (default: 1)
820830
821831
-debug=<category>
822-
Output debugging information (default: -nodebug, supplying <category> is
823-
optional). If <category> is not supplied or if <category> = 1,
824-
output all debugging information. <category> can be: addrman,
825-
bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf,
826-
estimatefee, gobject, http, i2p, instantsend, ipc, leveldb,
827-
libevent, llmq, llmq-dkg, llmq-sigs, lock, mempool, mempoolrej,
828-
mnpayments, mnsync, net, netconn, proxy, prune, qt, rand,
829-
reindex, rpc, selectcoins, spork, tor, txreconciliation,
832+
Output debug and trace logging (default: -nodebug, supplying <category>
833+
is optional). If <category> is not supplied or if <category> = 1,
834+
output all debug and trace logging. <category> can be: addrman,
835+
bench, blockstorage, chainlocks, cmpctblock, coindb, coinjoin,
836+
creditpool, ehf, estimatefee, gobject, http, i2p, instantsend,
837+
ipc, leveldb, libevent, llmq, llmq-dkg, llmq-sigs, mempool,
838+
mempoolrej, mnpayments, mnsync, net, netconn, proxy, prune, qt,
839+
rand, reindex, rpc, selectcoins, spork, tor, txreconciliation,
830840
validation, walletdb, zmq. This option can be specified multiple
831841
times to output multiple categories.
832842
833843
-debugexclude=<category>
834-
Exclude debugging information for a category. Can be used in conjunction
835-
with -debug=1 to output debug logs for all categories except the
836-
specified category. This option can be specified multiple times
837-
to exclude multiple categories.
844+
Exclude debug and trace logging for a category. Can be used in
845+
conjunction with -debug=1 to output debug and trace logging for
846+
all categories except the specified category. This option can be
847+
specified multiple times to exclude multiple categories.
838848
839849
-deprecatedrpc=<method>
840850
Allows deprecated RPC method(s) to be used
@@ -868,6 +878,20 @@ options](#ui-options).
868878
-logips
869879
Include IP addresses in debug output (default: 0)
870880
881+
-loglevel=<level>|<category>:<level>
882+
Set the global or per-category severity level for logging categories
883+
enabled with the -debug configuration option or the logging RPC:
884+
info, debug, trace (default=debug); warning and error levels are
885+
always logged. If <category>:<level> is supplied, the setting
886+
will override the global one and may be specified multiple times
887+
to set multiple category-specific levels. <category> can be:
888+
addrman, bench, blockstorage, chainlocks, cmpctblock, coindb,
889+
coinjoin, creditpool, ehf, estimatefee, gobject, http, i2p,
890+
instantsend, ipc, leveldb, libevent, llmq, llmq-dkg, llmq-sigs,
891+
mempool, mempoolrej, mnpayments, mnsync, net, netconn, proxy,
892+
prune, qt, rand, reindex, rpc, selectcoins, spork, tor,
893+
txreconciliation, validation, walletdb, zmq.
894+
871895
-logsourcelocations
872896
Prepend debug output with name of the originating source location
873897
(source file, line number and function name) (default: 0)
@@ -929,10 +953,6 @@ options](#ui-options).
929953
Stop running after reaching the given height in the main chain (default:
930954
0)
931955
932-
-testactivationheight=name@height.
933-
Set the activation height of 'name' (bip147, bip34, dersig, cltv, csv,
934-
brr, dip0001, dip0008, v20, mn_rr). (regtest-only)
935-
936956
-uacomment=<cmt>
937957
Append comment to the user agent string
938958
@@ -945,9 +965,6 @@ options](#ui-options).
945965

946966
```text
947967
948-
-bip147height=<activation>
949-
Override BIP147 activation height (regtest-only)
950-
951968
-budgetparams=<masternode>:<budget>:<superblock>
952969
Override masternode, budget and superblock start heights (regtest-only)
953970
@@ -961,9 +978,6 @@ options](#ui-options).
961978
-dip3params=<activation>:<enforcement>
962979
Override DIP3 activation and enforcement heights (regtest-only)
963980
964-
-dip8params=<activation>
965-
Override DIP8 activation height (regtest-only)
966-
967981
-highsubsidyblocks=<n>
968982
The number of blocks with a higher than normal subsidy to mine at the
969983
start of a chain. Block after that height will have fixed subsidy
@@ -1005,6 +1019,10 @@ options](#ui-options).
10051019
Override the default LLMQ size for the LLMQ_TEST quorum (default: 3:2,
10061020
regtest-only)
10071021
1022+
-llmqtestplatformparams=<size>:<threshold>
1023+
Override the default LLMQ size for the LLMQ_TEST_PLATFORM quorum
1024+
(default: 3:2, regtest-only)
1025+
10081026
-minimumdifficultyblocks=<n>
10091027
The number of blocks that can be mined with the minimum difficulty at
10101028
the start of a chain (default: 0, devnet-only)
@@ -1018,6 +1036,10 @@ options](#ui-options).
10181036
can be solved instantly. This is intended for regression testing
10191037
tools and app development. Equivalent to -chain=regtest
10201038
1039+
-testactivationheight=name@height.
1040+
Set the activation height of 'name' (bip147, bip34, dersig, cltv, csv,
1041+
brr, dip0001, dip0008, dip0024, v19, v20, mn_rr). (regtest-only)
1042+
10211043
-testnet
10221044
Use the test chain. Equivalent to -chain=test
10231045
@@ -1061,6 +1083,9 @@ options](#ui-options).
10611083
Fees (in DASH/kB) smaller than this are considered zero fee for
10621084
relaying, mining and transaction creation (default: 0.00001)
10631085
1086+
-permitbaremultisig
1087+
Relay non-P2SH multisig (default: 1)
1088+
10641089
-whitelistforcerelay
10651090
Add 'forcerelay' permission to whitelisted inbound peers with default
10661091
permissions. This will relay transactions even if the
@@ -1097,10 +1122,11 @@ options](#ui-options).
10971122
Accept public REST requests (default: 0)
10981123
10991124
-rpcallowip=<ip>
1100-
Allow JSON-RPC connections from specified source. Valid for <ip> are a
1101-
single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1102-
1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
1103-
option can be specified multiple times
1125+
Allow JSON-RPC connections from specified source. Valid values for <ip>
1126+
are a single IP (e.g. 1.2.3.4), a network/netmask (e.g.
1127+
1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all
1128+
ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be
1129+
specified multiple times
11041130
11051131
-rpcauth=<userpw>
11061132
Username and HMAC-SHA-256 hashed password for JSON-RPC connections. The

0 commit comments

Comments
 (0)