From 01ac32f90b6de7510c35a7fa2f35ca1ff6c0a5c2 Mon Sep 17 00:00:00 2001 From: Luke Dashjr Date: Sat, 22 Jun 2024 18:06:18 +0000 Subject: [PATCH] Update manpages & example bitcoin.conf --- doc/man/bitcoin-cli.1 | 50 ++++++-- doc/man/bitcoin-qt.1 | 248 ++++++++++++++++++++++++++++++------ doc/man/bitcoin-tx.1 | 26 +++- doc/man/bitcoin-util.1 | 25 +++- doc/man/bitcoin-wallet.1 | 34 +++-- doc/man/bitcoind.1 | 244 +++++++++++++++++++++++++++++------ share/examples/bitcoin.conf | 194 +++++++++++++++++++++++----- 7 files changed, 669 insertions(+), 152 deletions(-) diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 2db27ebf422a9..23e46d73d286f 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -4,18 +4,25 @@ bitcoin-cli \- manual page for bitcoin-cli v27.1.0 .SH SYNOPSIS .B bitcoin-cli -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR +[\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] .br .B bitcoin-cli -[\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR +[\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... .br .B bitcoin-cli -[\fI\,options\/\fR] \fI\,help List commands\/\fR +[\fI\,options\/\fR] \fI\,help\/\fR .br .B bitcoin-cli -[\fI\,options\/\fR] \fI\,help Get help for a command\/\fR +[\fI\,options\/\fR] \fI\,help \/\fR .SH DESCRIPTION -Bitcoin Core RPC client version v27.1.0 +Bitcoin Knots RPC client version v27.1.0 +.PP +The bitcoin\-cli utility provides a command line interface to interact with a bitcoind/bitcoin\-qt RPC server. +.PP +It can be used to query network information, manage wallets, create or broadcast transactions, and control the bitcoind server. +.PP +Use the "help" command to list all commands. Use "help " to show help for that command. +The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters. .SH OPTIONS .HP \-? @@ -39,6 +46,12 @@ and OS is not WIN32), never. Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) .HP +\fB\-confrw=\fR +.IP +Specify read/write configuration file. Relative paths will be prefixed +by the network\-specific datadir location. (default: +bitcoin_rw.conf) +.HP \fB\-datadir=\fR .IP Specify data directory @@ -54,11 +67,12 @@ nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4 .HP \fB\-getinfo\fR .IP -Get general information from the remote server. Note that unlike -server\-side RPC calls, the output of \fB\-getinfo\fR is the result of -multiple non\-atomic requests. Some entries in the output may -represent results from different states (e.g. wallet balance may -be as of a different block from the chain state reported) +Get general information from the remote server, including the total +balance and the balances of each loaded wallet when in +multiwallet mode. Note that \fB\-getinfo\fR is the combined result of +several RPCs (getnetworkinfo, getblockchaininfo, getwalletinfo, +getbalances, and in multiwallet mode, listwallets), each with +potentially different state. .HP \fB\-named\fR .IP @@ -153,6 +167,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -172,10 +192,12 @@ Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoind(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index d91f0e7c57057..e6c72ea6ba7af 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -4,11 +4,17 @@ bitcoin-qt \- manual page for bitcoin-qt v27.1.0 .SH SYNOPSIS .B bitcoin-qt -[\fI\,command-line options\/\fR] [\fI\,URI\/\fR] +[\fI\,options\/\fR] [\fI\,URI\/\fR] .SH DESCRIPTION -Bitcoin Core version v27.1.0 +Bitcoin Knots version v27.1.0 .PP -Optional URI is a Bitcoin address in BIP21 URI format. +The bitcoin\-qt application provides a graphical interface for interacting with Bitcoin Knots. +.PP +It combines the core functionalities of bitcoind with a user\-friendly interface for wallet management, transaction history, and network statistics. +.PP +It is suitable for users who prefer a graphical over a command\-line interface. +.PP +You can optionally specify a payment [URI]. .SH OPTIONS .HP \-? @@ -30,7 +36,7 @@ datadir as a warning, not an error. 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: -000000000000000000026811d149d4d261995ec5b3f64f439a0a10e1a464af9a, +000000000000000000032b91acdaaf16f8c40d46afeb835c3ac604860f905d56, testnet: 000000000001323071f38f21ea5aae529ece491eadaccce506a59bcc2d968917, signet: @@ -39,8 +45,8 @@ signet: \fB\-blockfilterindex=\fR .IP Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. +basic, v0). If is not supplied or if = 1, certain +indexes are enabled (currently just basic). .HP \fB\-blocknotify=\fR .IP @@ -59,10 +65,10 @@ Specify directory to hold blocks subdirectory for *.dat files (default: .HP \fB\-blocksonly\fR .IP -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) +Whether to reject transactions from network peers. Disables automatic +broadcast and rebroadcast of transactions, unless the source peer +has the 'forcerelay' permission. RPC transactions are not +affected. (default: 0) .HP \fB\-coinstatsindex\fR .IP @@ -74,6 +80,16 @@ Specify path to read\-only configuration file. Relative paths will be prefixed by datadir location (only useable from command line, not configuration file) (default: bitcoin.conf) .HP +\fB\-confrw=\fR +.IP +Specify read/write configuration file. Relative paths will be prefixed +by the network\-specific datadir location (default: +bitcoin_rw.conf) +.HP +\fB\-corepolicy\fR +.IP +Use Bitcoin Core policy defaults (default: 0) +.HP \fB\-daemon\fR .IP Run in the background as a daemon and accept commands (default: 0) @@ -89,7 +105,7 @@ Specify data directory .HP \fB\-dbcache=\fR .IP -Maximum database cache size MiB (4 to 16384, default: 450). In +Maximum database cache size MiB (4 to 1048576, default: 450). In addition, unused mempool memory is shared for this cache (see \fB\-maxmempool\fR). .HP @@ -108,6 +124,11 @@ Specify additional configuration file, relative to the \fB\-datadir\fR path .IP Imports blocks from external file on startup .HP +\fB\-lowmem=\fR +.IP +If system available memory falls below MiB, flush caches (0 to +disable, default: 10) +.HP \fB\-maxmempool=\fR .IP Keep the transaction memory pool below megabytes (default: 300) @@ -160,7 +181,8 @@ If enabled, wipe chain state and block index, and rebuild them from blk*.dat files on disk. Also wipe and rebuild other optional indexes that are active. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be -reloaded via RPC. +reloaded via RPC. Setting this to auto automatically reindexes +the block database if it is corrupted. .HP \fB\-reindex\-chainstate\fR .IP @@ -316,7 +338,8 @@ base while uppercase is 1024 base .HP \fB\-natpmp\fR .IP -Use NAT\-PMP to map the listening port (default: 0) +Use NAT\-PMP to map the listening port (default: 1 when listening and no +\fB\-proxy\fR) .HP \fB\-networkactive\fR .IP @@ -342,7 +365,7 @@ Serve compact block filters to peers per BIP 157 (default: 0) \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -0) +1) .HP \fB\-port=\fR .IP @@ -379,10 +402,19 @@ Tor control host and port to use if onion listening enabled (default: 127.0.0.1:9051). If no port is specified, the default port of 9051 will be used. .HP +\fB\-torexecute=\fR +.IP +Tor command to use if not already running (default: tor) +.HP \fB\-torpassword=\fR .IP Tor control port password (default: empty) .HP +\fB\-uaappend=\fR +.IP +Append literal to the user agent string (should only be used for +software embedding) +.HP \fB\-upnp\fR .IP Use UPnP to map the listening port (default: 1 when listening and no @@ -397,22 +429,27 @@ Support v2 transport (default: 1) Bind to the given address and add permission flags to the peers connecting to it. Use [host]:port notation for IPv6. Allowed permissions: bloomfilter (allow requesting BIP37 filtered blocks -and transactions), noban (do not ban for misbehavior; implies +and transactions), blockfilters (serve compact block filters to +peers per BIP157), noban (do not ban for misbehavior; implies download), forcerelay (relay transactions that are already in the mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, and unlimited transaction announcements), mempool (allow requesting BIP35 mempool contents), download (allow getheaders during IBD, no disconnect after maxuploadtarget limit), addr (responses to GETADDR avoid hitting the cache and contain random -records with the most up\-to\-date info). Specify multiple +records with the most up\-to\-date info), forceinbound (when +connections are full, attempt to evict a random unprotected +inbound peer to open a slot; implies noban). Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times. .HP \fB\-whitelist=\fR<[permissions@]IP address or network> .IP -Add permission flags to the peers connecting from the given IP address -(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses -the same permissions as \fB\-whitebind\fR. Can be specified multiple +Add permission flags to the peers using the given IP address (e.g. +1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses the same +permissions as \fB\-whitebind\fR. Additional flags "in" and "out" +control whether permissions apply to incoming connections and/or +outgoing (default: incoming only). Can be specified multiple times. .PP Wallet options: @@ -495,7 +532,7 @@ Spend unconfirmed change when sending transactions (default: 1) \fB\-txconfirmtarget=\fR .IP If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 6) +confirmation on average within n blocks (default: 144) .HP \fB\-wallet=\fR .IP @@ -516,16 +553,20 @@ Make the wallet broadcast transactions (default: 1) Specify directory to hold wallets (default: /wallets if it exists, otherwise ) .HP +\fB\-walletimplicitsegwit\fR +.IP +Support segwit when restoring wallet backups and importing keys +(default: 0) +.HP \fB\-walletnotify=\fR .IP Execute command when a wallet transaction changes. %s in cmd is replaced by TxID, %w is replaced by wallet name, %b is replaced by the hash of the block including the transaction (set to 'unconfirmed' if the transaction is not included) and %h is replaced by the -block height (\fB\-1\fR if not included). %w is not currently -implemented on windows. On systems where %w is supported, it -should NOT be quoted because this would break shell escaping used -to invoke the command. +block height (\fB\-1\fR if not included). %w should NOT be quoted +because this would break shell escaping used to invoke the +command. .HP \fB\-walletrbf\fR .IP @@ -550,6 +591,15 @@ Enable publish hash transaction in
Set publish hash transaction outbound message high water mark (default: 1000) .HP +\fB\-zmqpubhashwallettx=\fR
+.IP +Enable publish hash wallet transaction in
+.HP +\fB\-zmqpubhashwallettxhwm=\fR +.IP +Set publish hash wallet transaction outbound message high water mark +(default: 1000) +.HP \fB\-zmqpubrawblock=\fR
.IP Enable publish raw block in
@@ -567,6 +617,15 @@ Enable publish raw transaction in
Set publish raw transaction outbound message high water mark (default: 1000) .HP +\fB\-zmqpubrawwallettx=\fR
+.IP +Enable publish raw wallet transaction in
+.HP +\fB\-zmqpubrawwallettxhwm=\fR +.IP +Set publish raw wallet transaction outbound message high water mark +(default: 1000) +.HP \fB\-zmqpubsequence=\fR
.IP Enable publish hash block and tx sequence in
@@ -583,10 +642,11 @@ Output debug and trace logging (default: \fB\-nodebug\fR, supplying is optional). If is not supplied or if = 1, output all debug and trace logging. can be: addrman, bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p, -ipc, leveldb, libevent, mempool, mempoolrej, net, proxy, prune, -qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, -txreconciliation, util, validation, walletdb, zmq. This option -can be specified multiple times to output multiple categories. +ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, +prune, qt, rand, reindex, rpc, scan, selectcoins, tor, +txpackages, txreconciliation, util, validation, walletdb, zmq. +This option can be specified multiple times to output multiple +categories. .HP \fB\-debugexclude=\fR .IP @@ -651,6 +711,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -670,24 +736,71 @@ Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Node relay options: .HP +\fB\-acceptnonstddatacarrier\fR +.IP +Relay and mine non\-OP_RETURN datacarrier injection (default: 0) +.HP +\fB\-acceptnonstdtxn\fR +.IP +Relay and mine "non\-standard" transactions (default: 0) +.HP \fB\-bytespersigop\fR .IP Equivalent bytes per sigop in transactions for relay and mining (default: 20) .HP +\fB\-bytespersigopstrict\fR +.IP +Minimum bytes per sigop in transactions we relay and mine (default: 20) +.HP \fB\-datacarrier\fR .IP Relay and mine data carrier transactions (default: 1) .HP +\fB\-datacarriercost\fR +.IP +Treat extra data in transactions as at least N vbytes per actual byte +(default: 1) +.HP \fB\-datacarriersize\fR .IP -Relay and mine transactions whose data\-carrying raw scriptPubKey is of -this size or less (default: 83) +Maximum size of data in data carrier transactions we relay and mine, in +bytes (default: 42) +.HP +\fB\-dustdynamic\fR=\fI\,off\/\fR|[*]target:|[*]mempool: +.IP +Automatically raise dustrelayfee based on either the expected fee to be +mined within blocks, or to be within the best kvB +of this node's mempool. If unspecified, multiplier is 3000. +(default: off) +.HP +\fB\-dustrelayfee=\fR +.IP +Fee rate (in BTC/kvB) used to define dust, the value of an output such +that it will cost more than its value in fees at this fee rate to +spend it. (default: 0.00003) +.HP +\fB\-maxscriptsize\fR +.IP +Maximum size of scripts we relay and mine, in bytes (default: 1650) .HP \fB\-mempoolfullrbf\fR .IP Accept transaction replace\-by\-fee without requiring replaceability -signaling (default: 0) +signaling (default: 1) +.HP +\fB\-mempoolreplacement\fR +.IP +Set to 0 to disable RBF entirely, "fee,optin" to honour RBF opt\-out +signal, or "fee,\-optin" to always RBF aka full RBF (default: +fee,\-optin) +.HP +\fB\-mempooltruc\fR +.IP +Behaviour for transactions requesting TRUC limits: "reject" the +transactions entirely, "accept" them just like any other, or +"enforce" to impose their requested restrictions (default: +accept) .HP \fB\-minrelaytxfee=\fR .IP @@ -696,30 +809,57 @@ relaying, mining and transaction creation (default: 0.00001) .HP \fB\-permitbaremultisig\fR .IP -Relay non\-P2SH multisig (default: 1) +Relay non\-P2SH multisig (default: 0) +.HP +\fB\-permitbarepubkey\fR +.IP +Relay legacy pubkey outputs (default: 0) +.HP +\fB\-rejectparasites\fR +.IP +Refuse to relay or mine parasitic overlay protocols (default: 1) +.HP +\fB\-rejecttokens\fR +.IP +Refuse to relay or mine transactions involving non\-bitcoin tokens +(default: 0) +.HP +\fB\-spkreuse\fR +.IP +Accept transactions reusing addresses or other pubkey scripts (default: +allow) .HP \fB\-whitelistforcerelay\fR .IP -Add 'forcerelay' permission to whitelisted inbound peers with default +Add 'forcerelay' permission to whitelisted peers with default permissions. This will relay transactions even if the transactions were already in the mempool. (default: 0) .HP \fB\-whitelistrelay\fR .IP -Add 'relay' permission to whitelisted inbound peers with default -permissions. This will accept relayed transactions even when not -relaying transactions (default: 1) +Add 'relay' permission to whitelisted peers with default permissions. +This will accept relayed transactions even when not relaying +transactions (default: 1) .PP Block creation options: .HP +\fB\-blockmaxsize=\fR +.IP +Set maximum block size in bytes (default: 300000) +.HP \fB\-blockmaxweight=\fR .IP -Set maximum BIP141 block weight (default: 3996000) +Set maximum BIP141 block weight (default: 1200000) .HP \fB\-blockmintxfee=\fR .IP Set lowest fee rate (in BTC/kvB) for transactions to be included in block creation. (default: 0.00001) +.HP +\fB\-blockprioritysize=\fR +.IP +Set maximum size of high\-priority/low\-fee transactions in bytes +(default: 100000) .PP RPC server options: .HP @@ -744,6 +884,11 @@ then connects normally using the rpcuser=/rpcpassword= pair of arguments. This option can be specified multiple times .HP +\fB\-rpcauthfile=\fR +.IP +A file with a single lines with same format as rpcauth. This option can +be specified multiple times +.HP \fB\-rpcbind=\fR[:port] .IP Bind to given address to listen for JSON\-RPC connections. Do not expose @@ -758,6 +903,11 @@ IPv6. This option can be specified multiple times (default: Location of the auth cookie. Relative paths will be prefixed by a net\-specific datadir location. (default: data dir) .HP +\fB\-rpccookieperms=\fR +.IP +Set permissions on the RPC auth cookie file so that it is readable by +[owner|group|all] (default: rw\-\-\-\-\-\-\-) +.HP \fB\-rpcpassword=\fR .IP Password for JSON\-RPC connections @@ -802,6 +952,10 @@ UI Options: .IP Choose data directory on startup (default: 0) .HP +\fB\-guisettingsdir=\fR +.IP +Choose a custom data directory especially for the Qt Settings +.HP \fB\-lang=\fR .IP Set language, for example "de_DE" (default: system locale) @@ -817,13 +971,25 @@ Reset all settings changed in the GUI \fB\-splash\fR .IP Show splash screen on startup (default: 1) +.PP +Statistic options: +.HP +\fB\-statsenable\fR +.IP +Enable statistics (default: 0) +.HP +\fB\-statsmaxmemorytarget=\fR +.IP +Set the memory limit target for statistics in bytes (default: 10485760) .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1) diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index 92e3f2a2c2985..8c06e1259b158 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -4,12 +4,16 @@ bitcoin-tx \- manual page for bitcoin-tx v27.1.0 .SH SYNOPSIS .B bitcoin-tx -[\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR +[\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] .br .B bitcoin-tx -[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR +[\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] .SH DESCRIPTION -Bitcoin Core bitcoin\-tx utility version v27.1.0 +Bitcoin Knots bitcoin\-tx utility version v27.1.0 +.PP +The bitcoin\-tx tool is used for creating and modifying bitcoin transactions. +.PP +bitcoin\-tx can be used with " [commands]" to update a hex\-encoded bitcoin transaction, or with "\-create [commands]" to create a hex\-encoded bitcoin transaction. .SH OPTIONS .HP \-? @@ -46,6 +50,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -138,10 +148,12 @@ Set register NAME to given JSON\-STRING .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoind(1), bitcoin-cli(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1 index e3252cbe1e755..2b868dae1f138 100644 --- a/doc/man/bitcoin-util.1 +++ b/doc/man/bitcoin-util.1 @@ -4,9 +4,14 @@ bitcoin-util \- manual page for bitcoin-util v27.1.0 .SH SYNOPSIS .B bitcoin-util -[\fI\,options\/\fR] [\fI\,commands\/\fR] \fI\,Do stuff\/\fR +[\fI\,options\/\fR] [\fI\,command\/\fR] +.br +.B bitcoin-util +[\fI\,options\/\fR] \fI\,grind \/\fR .SH DESCRIPTION -Bitcoin Core bitcoin\-util utility version v27.1.0 +Bitcoin Knots bitcoin\-util utility version v27.1.0 +.PP +The bitcoin\-util tool provides bitcoin related functionality that does not rely on the ability to access a running node. Available [commands] are listed below. .SH OPTIONS .HP \-? @@ -31,6 +36,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -56,10 +67,12 @@ Perform proof of work on hex header string .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-qt(1) diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 index 2b4593beeebea..bb5c0837e9345 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -2,15 +2,17 @@ .TH BITCOIN-WALLET "1" "June 2024" "bitcoin-wallet v27.1.0" "User Commands" .SH NAME bitcoin-wallet \- manual page for bitcoin-wallet v27.1.0 +.SH SYNOPSIS +.B bitcoin-wallet +[\fI\,options\/\fR] \fI\,\/\fR .SH DESCRIPTION -Bitcoin Core bitcoin\-wallet version v27.1.0 +Bitcoin Knots bitcoin\-wallet version v27.1.0 +.PP +bitcoin\-wallet is an offline tool for creating and interacting with Bitcoin Knots wallet files. .PP -bitcoin\-wallet is an offline tool for creating and interacting with Bitcoin Core wallet files. By default bitcoin\-wallet will act on wallets in the default mainnet wallet directory in the datadir. -To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-regtest\fR/\-signet/\-testnet arguments. -.SS "Usage:" -.IP -bitcoin\-wallet [options] +.PP +To change the target wallet, use the \fB\-datadir\fR, \fB\-wallet\fR and \fB\-regtest\fR / \fB\-signet\fR / \fB\-testnet\fR arguments. .SH OPTIONS .HP \-? @@ -70,6 +72,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -101,6 +109,10 @@ dump .IP Print out all of the wallet key\-value records .IP +importfromcoldcard +.IP +Create new wallet file and import descriptors from Coldcard wallet +.IP info .IP Get wallet info @@ -112,10 +124,12 @@ Attempt to recover private keys from a corrupt wallet. Warning: .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index bc7f41a5a7a4e..6d198a5193bd7 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -4,9 +4,17 @@ bitcoind \- manual page for bitcoind v27.1.0 .SH SYNOPSIS .B bitcoind -[\fI\,options\/\fR] \fI\,Start Bitcoin Core\/\fR +[\fI\,options\/\fR] .SH DESCRIPTION -Bitcoin Core version v27.1.0 +Bitcoin Knots version v27.1.0 +.PP +The Bitcoin Knots daemon (bitcoind) is a headless program that connects to the Bitcoin network to validate and relay transactions and blocks, as well as relaying addresses. +.PP +It provides the backbone of the Bitcoin network and its RPC, REST and ZMQ services can provide various transaction, block and address\-related services. +.PP +There is an optional wallet component which provides cutting\-edge transaction services. +.PP +It can be used in a headless environment or as part of a server setup. .SH OPTIONS .HP \-? @@ -28,7 +36,7 @@ datadir as a warning, not an error. 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: -000000000000000000026811d149d4d261995ec5b3f64f439a0a10e1a464af9a, +000000000000000000032b91acdaaf16f8c40d46afeb835c3ac604860f905d56, testnet: 000000000001323071f38f21ea5aae529ece491eadaccce506a59bcc2d968917, signet: @@ -37,8 +45,8 @@ signet: \fB\-blockfilterindex=\fR .IP Maintain an index of compact filters by block (default: 0, values: -basic). If is not supplied or if = 1, indexes for -all known types are enabled. +basic, v0). If is not supplied or if = 1, certain +indexes are enabled (currently just basic). .HP \fB\-blocknotify=\fR .IP @@ -57,10 +65,10 @@ Specify directory to hold blocks subdirectory for *.dat files (default: .HP \fB\-blocksonly\fR .IP -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) +Whether to reject transactions from network peers. Disables automatic +broadcast and rebroadcast of transactions, unless the source peer +has the 'forcerelay' permission. RPC transactions are not +affected. (default: 0) .HP \fB\-coinstatsindex\fR .IP @@ -72,6 +80,16 @@ Specify path to read\-only configuration file. Relative paths will be prefixed by datadir location (only useable from command line, not configuration file) (default: bitcoin.conf) .HP +\fB\-confrw=\fR +.IP +Specify read/write configuration file. Relative paths will be prefixed +by the network\-specific datadir location (default: +bitcoin_rw.conf) +.HP +\fB\-corepolicy\fR +.IP +Use Bitcoin Core policy defaults (default: 0) +.HP \fB\-daemon\fR .IP Run in the background as a daemon and accept commands (default: 0) @@ -87,7 +105,7 @@ Specify data directory .HP \fB\-dbcache=\fR .IP -Maximum database cache size MiB (4 to 16384, default: 450). In +Maximum database cache size MiB (4 to 1048576, default: 450). In addition, unused mempool memory is shared for this cache (see \fB\-maxmempool\fR). .HP @@ -106,6 +124,11 @@ Specify additional configuration file, relative to the \fB\-datadir\fR path .IP Imports blocks from external file on startup .HP +\fB\-lowmem=\fR +.IP +If system available memory falls below MiB, flush caches (0 to +disable, default: 10) +.HP \fB\-maxmempool=\fR .IP Keep the transaction memory pool below megabytes (default: 300) @@ -158,7 +181,8 @@ If enabled, wipe chain state and block index, and rebuild them from blk*.dat files on disk. Also wipe and rebuild other optional indexes that are active. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be -reloaded via RPC. +reloaded via RPC. Setting this to auto automatically reindexes +the block database if it is corrupted. .HP \fB\-reindex\-chainstate\fR .IP @@ -314,7 +338,8 @@ base while uppercase is 1024 base .HP \fB\-natpmp\fR .IP -Use NAT\-PMP to map the listening port (default: 0) +Use NAT\-PMP to map the listening port (default: 1 when listening and no +\fB\-proxy\fR) .HP \fB\-networkactive\fR .IP @@ -340,7 +365,7 @@ Serve compact block filters to peers per BIP 157 (default: 0) \fB\-peerbloomfilters\fR .IP Support filtering of blocks and transaction with bloom filters (default: -0) +1) .HP \fB\-port=\fR .IP @@ -377,10 +402,19 @@ Tor control host and port to use if onion listening enabled (default: 127.0.0.1:9051). If no port is specified, the default port of 9051 will be used. .HP +\fB\-torexecute=\fR +.IP +Tor command to use if not already running (default: tor) +.HP \fB\-torpassword=\fR .IP Tor control port password (default: empty) .HP +\fB\-uaappend=\fR +.IP +Append literal to the user agent string (should only be used for +software embedding) +.HP \fB\-upnp\fR .IP Use UPnP to map the listening port (default: 1 when listening and no @@ -395,22 +429,27 @@ Support v2 transport (default: 1) Bind to the given address and add permission flags to the peers connecting to it. Use [host]:port notation for IPv6. Allowed permissions: bloomfilter (allow requesting BIP37 filtered blocks -and transactions), noban (do not ban for misbehavior; implies +and transactions), blockfilters (serve compact block filters to +peers per BIP157), noban (do not ban for misbehavior; implies download), forcerelay (relay transactions that are already in the mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode, and unlimited transaction announcements), mempool (allow requesting BIP35 mempool contents), download (allow getheaders during IBD, no disconnect after maxuploadtarget limit), addr (responses to GETADDR avoid hitting the cache and contain random -records with the most up\-to\-date info). Specify multiple +records with the most up\-to\-date info), forceinbound (when +connections are full, attempt to evict a random unprotected +inbound peer to open a slot; implies noban). Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times. .HP \fB\-whitelist=\fR<[permissions@]IP address or network> .IP -Add permission flags to the peers connecting from the given IP address -(e.g. 1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses -the same permissions as \fB\-whitebind\fR. Can be specified multiple +Add permission flags to the peers using the given IP address (e.g. +1.2.3.4) or CIDR\-notated network (e.g. 1.2.3.0/24). Uses the same +permissions as \fB\-whitebind\fR. Additional flags "in" and "out" +control whether permissions apply to incoming connections and/or +outgoing (default: incoming only). Can be specified multiple times. .PP Wallet options: @@ -493,7 +532,7 @@ Spend unconfirmed change when sending transactions (default: 1) \fB\-txconfirmtarget=\fR .IP If paytxfee is not set, include enough fee so transactions begin -confirmation on average within n blocks (default: 6) +confirmation on average within n blocks (default: 144) .HP \fB\-wallet=\fR .IP @@ -514,16 +553,20 @@ Make the wallet broadcast transactions (default: 1) Specify directory to hold wallets (default: /wallets if it exists, otherwise ) .HP +\fB\-walletimplicitsegwit\fR +.IP +Support segwit when restoring wallet backups and importing keys +(default: 0) +.HP \fB\-walletnotify=\fR .IP Execute command when a wallet transaction changes. %s in cmd is replaced by TxID, %w is replaced by wallet name, %b is replaced by the hash of the block including the transaction (set to 'unconfirmed' if the transaction is not included) and %h is replaced by the -block height (\fB\-1\fR if not included). %w is not currently -implemented on windows. On systems where %w is supported, it -should NOT be quoted because this would break shell escaping used -to invoke the command. +block height (\fB\-1\fR if not included). %w should NOT be quoted +because this would break shell escaping used to invoke the +command. .HP \fB\-walletrbf\fR .IP @@ -548,6 +591,15 @@ Enable publish hash transaction in
Set publish hash transaction outbound message high water mark (default: 1000) .HP +\fB\-zmqpubhashwallettx=\fR
+.IP +Enable publish hash wallet transaction in
+.HP +\fB\-zmqpubhashwallettxhwm=\fR +.IP +Set publish hash wallet transaction outbound message high water mark +(default: 1000) +.HP \fB\-zmqpubrawblock=\fR
.IP Enable publish raw block in
@@ -565,6 +617,15 @@ Enable publish raw transaction in
Set publish raw transaction outbound message high water mark (default: 1000) .HP +\fB\-zmqpubrawwallettx=\fR
+.IP +Enable publish raw wallet transaction in
+.HP +\fB\-zmqpubrawwallettxhwm=\fR +.IP +Set publish raw wallet transaction outbound message high water mark +(default: 1000) +.HP \fB\-zmqpubsequence=\fR
.IP Enable publish hash block and tx sequence in
@@ -581,10 +642,11 @@ Output debug and trace logging (default: \fB\-nodebug\fR, supplying is optional). If is not supplied or if = 1, output all debug and trace logging. can be: addrman, bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p, -ipc, leveldb, libevent, mempool, mempoolrej, net, proxy, prune, -qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, -txreconciliation, util, validation, walletdb, zmq. This option -can be specified multiple times to output multiple categories. +ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, +prune, qt, rand, reindex, rpc, scan, selectcoins, tor, +txpackages, txreconciliation, util, validation, walletdb, zmq. +This option can be specified multiple times to output multiple +categories. .HP \fB\-debugexclude=\fR .IP @@ -649,6 +711,12 @@ signet, regtest Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP +\fB\-signetblocktime\fR +.IP +Difficulty adjustment will target a block time of the given amount in +seconds (only for custom signet networks, must have +\fB\-signetchallenge\fR set; defaults to 10 minutes) +.HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for @@ -668,24 +736,71 @@ Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .PP Node relay options: .HP +\fB\-acceptnonstddatacarrier\fR +.IP +Relay and mine non\-OP_RETURN datacarrier injection (default: 0) +.HP +\fB\-acceptnonstdtxn\fR +.IP +Relay and mine "non\-standard" transactions (default: 0) +.HP \fB\-bytespersigop\fR .IP Equivalent bytes per sigop in transactions for relay and mining (default: 20) .HP +\fB\-bytespersigopstrict\fR +.IP +Minimum bytes per sigop in transactions we relay and mine (default: 20) +.HP \fB\-datacarrier\fR .IP Relay and mine data carrier transactions (default: 1) .HP +\fB\-datacarriercost\fR +.IP +Treat extra data in transactions as at least N vbytes per actual byte +(default: 1) +.HP \fB\-datacarriersize\fR .IP -Relay and mine transactions whose data\-carrying raw scriptPubKey is of -this size or less (default: 83) +Maximum size of data in data carrier transactions we relay and mine, in +bytes (default: 42) +.HP +\fB\-dustdynamic\fR=\fI\,off\/\fR|[*]target:|[*]mempool: +.IP +Automatically raise dustrelayfee based on either the expected fee to be +mined within blocks, or to be within the best kvB +of this node's mempool. If unspecified, multiplier is 3000. +(default: off) +.HP +\fB\-dustrelayfee=\fR +.IP +Fee rate (in BTC/kvB) used to define dust, the value of an output such +that it will cost more than its value in fees at this fee rate to +spend it. (default: 0.00003) +.HP +\fB\-maxscriptsize\fR +.IP +Maximum size of scripts we relay and mine, in bytes (default: 1650) .HP \fB\-mempoolfullrbf\fR .IP Accept transaction replace\-by\-fee without requiring replaceability -signaling (default: 0) +signaling (default: 1) +.HP +\fB\-mempoolreplacement\fR +.IP +Set to 0 to disable RBF entirely, "fee,optin" to honour RBF opt\-out +signal, or "fee,\-optin" to always RBF aka full RBF (default: +fee,\-optin) +.HP +\fB\-mempooltruc\fR +.IP +Behaviour for transactions requesting TRUC limits: "reject" the +transactions entirely, "accept" them just like any other, or +"enforce" to impose their requested restrictions (default: +accept) .HP \fB\-minrelaytxfee=\fR .IP @@ -694,30 +809,57 @@ relaying, mining and transaction creation (default: 0.00001) .HP \fB\-permitbaremultisig\fR .IP -Relay non\-P2SH multisig (default: 1) +Relay non\-P2SH multisig (default: 0) +.HP +\fB\-permitbarepubkey\fR +.IP +Relay legacy pubkey outputs (default: 0) +.HP +\fB\-rejectparasites\fR +.IP +Refuse to relay or mine parasitic overlay protocols (default: 1) +.HP +\fB\-rejecttokens\fR +.IP +Refuse to relay or mine transactions involving non\-bitcoin tokens +(default: 0) +.HP +\fB\-spkreuse\fR +.IP +Accept transactions reusing addresses or other pubkey scripts (default: +allow) .HP \fB\-whitelistforcerelay\fR .IP -Add 'forcerelay' permission to whitelisted inbound peers with default +Add 'forcerelay' permission to whitelisted peers with default permissions. This will relay transactions even if the transactions were already in the mempool. (default: 0) .HP \fB\-whitelistrelay\fR .IP -Add 'relay' permission to whitelisted inbound peers with default -permissions. This will accept relayed transactions even when not -relaying transactions (default: 1) +Add 'relay' permission to whitelisted peers with default permissions. +This will accept relayed transactions even when not relaying +transactions (default: 1) .PP Block creation options: .HP +\fB\-blockmaxsize=\fR +.IP +Set maximum block size in bytes (default: 300000) +.HP \fB\-blockmaxweight=\fR .IP -Set maximum BIP141 block weight (default: 3996000) +Set maximum BIP141 block weight (default: 1200000) .HP \fB\-blockmintxfee=\fR .IP Set lowest fee rate (in BTC/kvB) for transactions to be included in block creation. (default: 0.00001) +.HP +\fB\-blockprioritysize=\fR +.IP +Set maximum size of high\-priority/low\-fee transactions in bytes +(default: 100000) .PP RPC server options: .HP @@ -742,6 +884,11 @@ then connects normally using the rpcuser=/rpcpassword= pair of arguments. This option can be specified multiple times .HP +\fB\-rpcauthfile=\fR +.IP +A file with a single lines with same format as rpcauth. This option can +be specified multiple times +.HP \fB\-rpcbind=\fR[:port] .IP Bind to given address to listen for JSON\-RPC connections. Do not expose @@ -756,6 +903,11 @@ IPv6. This option can be specified multiple times (default: Location of the auth cookie. Relative paths will be prefixed by a net\-specific datadir location. (default: data dir) .HP +\fB\-rpccookieperms=\fR +.IP +Set permissions on the RPC auth cookie file so that it is readable by +[owner|group|all] (default: rw\-\-\-\-\-\-\-) +.HP \fB\-rpcpassword=\fR .IP Password for JSON\-RPC connections @@ -793,13 +945,25 @@ subject to empty whitelists. \fB\-server\fR .IP Accept command line and JSON\-RPC commands +.PP +Statistic options: +.HP +\fB\-statsenable\fR +.IP +Enable statistics (default: 0) +.HP +\fB\-statsmaxmemorytarget=\fR +.IP +Set the memory limit target for statistics in bytes (default: 10485760) .SH COPYRIGHT Copyright (C) 2009-2024 The Bitcoin Core developers -Please contribute if you find Bitcoin Core useful. Visit - for further information about the software. -The source code is available from . +Please contribute if you find Bitcoin Knots useful. Visit + for further information about the software. +The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING -or \ No newline at end of file +or +.SH "SEE ALSO" +bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) diff --git a/share/examples/bitcoin.conf b/share/examples/bitcoin.conf index 5b0c7a3b501fe..e9e2d5d3b7e9d 100644 --- a/share/examples/bitcoin.conf +++ b/share/examples/bitcoin.conf @@ -23,7 +23,7 @@ # 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: -# 000000000000000000026811d149d4d261995ec5b3f64f439a0a10e1a464af9a, +# 000000000000000000032b91acdaaf16f8c40d46afeb835c3ac604860f905d56, # testnet: # 000000000001323071f38f21ea5aae529ece491eadaccce506a59bcc2d968917, # signet: @@ -31,8 +31,8 @@ #assumevalid= # Maintain an index of compact filters by block (default: 0, values: -# basic). If is not supplied or if = 1, indexes for -# all known types are enabled. +# basic, v0). If is not supplied or if = 1, certain +# indexes are enabled (currently just basic). #blockfilterindex= # Execute command when the best block changes (%s in cmd is replaced by @@ -47,10 +47,10 @@ # ) #blocksdir= -# 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) +# Whether to reject transactions from network peers. Disables automatic +# broadcast and rebroadcast of transactions, unless the source peer +# has the 'forcerelay' permission. RPC transactions are not +# affected. (default: 0) #blocksonly=1 # Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0) @@ -61,6 +61,14 @@ # configuration file) (default: bitcoin.conf) #conf= +# Specify read/write configuration file. Relative paths will be prefixed +# by the network-specific datadir location (default: +# bitcoin_rw.conf) +#confrw= + +# Use Bitcoin Core policy defaults (default: 0) +#corepolicy=1 + # Run in the background as a daemon and accept commands (default: 0) #daemon=1 @@ -71,7 +79,7 @@ # Specify data directory #datadir= -# Maximum database cache size MiB (4 to 16384, default: 450). In +# Maximum database cache size MiB (4 to 1048576, default: 450). In # addition, unused mempool memory is shared for this cache (see # -maxmempool). #dbcache= @@ -88,6 +96,10 @@ # Imports blocks from external file on startup #loadblock= +# If system available memory falls below MiB, flush caches (0 to +# disable, default: 10) +#lowmem= + # Keep the transaction memory pool below megabytes (default: 300) #maxmempool= @@ -130,7 +142,8 @@ # blk*.dat files on disk. Also wipe and rebuild other optional # indexes that are active. If an assumeutxo snapshot was loaded, # its chainstate will be wiped as well. The snapshot can then be -# reloaded via RPC. +# reloaded via RPC. Setting this to auto automatically reindexes +# the block database if it is corrupted. #reindex=1 # If enabled, wipe chain state, and rebuild it from blk*.dat files on @@ -260,7 +273,8 @@ # base while uppercase is 1024 base #maxuploadtarget= -# Use NAT-PMP to map the listening port (default: 0) +# Use NAT-PMP to map the listening port (default: 1 when listening and no +# -proxy) #natpmp=1 # Enable all P2P network activity (default: 1). Can be changed by the @@ -281,7 +295,7 @@ #peerblockfilters=1 # Support filtering of blocks and transaction with bloom filters (default: -# 0) +# 1) #peerbloomfilters=1 # Listen for connections on . Nodes not using the default ports @@ -313,9 +327,16 @@ # 9051 will be used. #torcontrol=: +# Tor command to use if not already running (default: tor) +#torexecute= + # Tor control port password (default: empty) #torpassword= +# Append literal to the user agent string (should only be used for +# software embedding) +#uaappend= + # Use UPnP to map the listening port (default: 1 when listening and no # -proxy) #upnp=1 @@ -326,21 +347,26 @@ # Bind to the given address and add permission flags to the peers # connecting to it. Use [host]:port notation for IPv6. Allowed # permissions: bloomfilter (allow requesting BIP37 filtered blocks -# and transactions), noban (do not ban for misbehavior; implies +# and transactions), blockfilters (serve compact block filters to +# peers per BIP157), noban (do not ban for misbehavior; implies # download), forcerelay (relay transactions that are already in the # mempool; implies relay), relay (relay even in -blocksonly mode, # and unlimited transaction announcements), mempool (allow # requesting BIP35 mempool contents), download (allow getheaders # during IBD, no disconnect after maxuploadtarget limit), addr # (responses to GETADDR avoid hitting the cache and contain random -# records with the most up-to-date info). Specify multiple +# records with the most up-to-date info), forceinbound (when +# connections are full, attempt to evict a random unprotected +# inbound peer to open a slot; implies noban). Specify multiple # permissions separated by commas (default: # download,noban,mempool,relay). Can be specified multiple times. #whitebind=<[permissions@]addr> -# Add permission flags to the peers connecting from the given IP address -# (e.g. 1.2.3.4) or CIDR-notated network (e.g. 1.2.3.0/24). Uses -# the same permissions as -whitebind. Can be specified multiple +# Add permission flags to the peers using the given IP address (e.g. +# 1.2.3.4) or CIDR-notated network (e.g. 1.2.3.0/24). Uses the same +# permissions as -whitebind. Additional flags "in" and "out" +# control whether permissions apply to incoming connections and/or +# outgoing (default: incoming only). Can be specified multiple # times. #whitelist=<[permissions@]IP address or network> @@ -411,7 +437,7 @@ #spendzeroconfchange=1 # If paytxfee is not set, include enough fee so transactions begin -# confirmation on average within n blocks (default: 6) +# confirmation on average within n blocks (default: 144) #txconfirmtarget= # Specify wallet path to load at startup. Can be used multiple times to @@ -430,14 +456,17 @@ # exists, otherwise ) #walletdir= +# Support segwit when restoring wallet backups and importing keys +# (default: 0) +#walletimplicitsegwit=1 + # Execute command when a wallet transaction changes. %s in cmd is replaced # by TxID, %w is replaced by wallet name, %b is replaced by the # hash of the block including the transaction (set to 'unconfirmed' # if the transaction is not included) and %h is replaced by the -# block height (-1 if not included). %w is not currently -# implemented on windows. On systems where %w is supported, it -# should NOT be quoted because this would break shell escaping used -# to invoke the command. +# block height (-1 if not included). %w should NOT be quoted +# because this would break shell escaping used to invoke the +# command. #walletnotify= # Send transactions with full-RBF opt-in enabled (RPC only, default: 1) @@ -460,6 +489,13 @@ # 1000) #zmqpubhashtxhwm= +# Enable publish hash wallet transaction in
+#zmqpubhashwallettx=
+ +# Set publish hash wallet transaction outbound message high water mark +# (default: 1000) +#zmqpubhashwallettxhwm= + # Enable publish raw block in
#zmqpubrawblock=
@@ -473,6 +509,13 @@ # 1000) #zmqpubrawtxhwm= +# Enable publish raw wallet transaction in
+#zmqpubrawwallettx=
+ +# Set publish raw wallet transaction outbound message high water mark +# (default: 1000) +#zmqpubrawwallettxhwm= + # Enable publish hash block and tx sequence in
#zmqpubsequence=
@@ -487,10 +530,11 @@ # is optional). If is not supplied or if = 1, # output all debug and trace logging. can be: addrman, # bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p, -# ipc, leveldb, libevent, mempool, mempoolrej, net, proxy, prune, -# qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, -# txreconciliation, util, validation, walletdb, zmq. This option -# can be specified multiple times to output multiple categories. +# ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, +# prune, qt, rand, reindex, rpc, scan, selectcoins, tor, +# txpackages, txreconciliation, util, validation, walletdb, zmq. +# This option can be specified multiple times to output multiple +# categories. #debug= # Exclude debug and trace logging for a category. Can be used in @@ -545,6 +589,11 @@ # is defined by the -signetchallenge parameter #signet=1 +# Difficulty adjustment will target a block time of the given amount in +# seconds (only for custom signet networks, must have +# -signetchallenge set; defaults to 10 minutes) +#signetblocktime=1 + # Blocks must satisfy the given script to be considered valid (only for # signet networks; defaults to the global default signet test # network challenge) @@ -563,49 +612,108 @@ ### Node relay options +# Relay and mine non-OP_RETURN datacarrier injection (default: 0) +#acceptnonstddatacarrier=1 + +# Relay and mine "non-standard" transactions (default: 0) +#acceptnonstdtxn=1 + # Equivalent bytes per sigop in transactions for relay and mining # (default: 20) #bytespersigop=1 +# Minimum bytes per sigop in transactions we relay and mine (default: 20) +#bytespersigopstrict=1 + # Relay and mine data carrier transactions (default: 1) #datacarrier=1 -# Relay and mine transactions whose data-carrying raw scriptPubKey is of -# this size or less (default: 83) +# Treat extra data in transactions as at least N vbytes per actual byte +# (default: 1) +#datacarriercost=1 + +# Maximum size of data in data carrier transactions we relay and mine, in +# bytes (default: 42) #datacarriersize=1 +# Automatically raise dustrelayfee based on either the expected fee to be +# mined within blocks, or to be within the best kvB +# of this node's mempool. If unspecified, multiplier is 3000. +# (default: off) +#dustdynamic=off|[*]target:|[*]mempool: + +# Fee rate (in BTC/kvB) used to define dust, the value of an output such +# that it will cost more than its value in fees at this fee rate to +# spend it. (default: 0.00003) +#dustrelayfee= + +# Maximum size of scripts we relay and mine, in bytes (default: 1650) +#maxscriptsize=1 + # Accept transaction replace-by-fee without requiring replaceability -# signaling (default: 0) +# signaling (default: 1) #mempoolfullrbf=1 +# Set to 0 to disable RBF entirely, "fee,optin" to honour RBF opt-out +# signal, or "fee,-optin" to always RBF aka full RBF (default: +# fee,-optin) +#mempoolreplacement=1 + +# Behaviour for transactions requesting TRUC limits: "reject" the +# transactions entirely, "accept" them just like any other, or +# "enforce" to impose their requested restrictions (default: +# accept) +#mempooltruc=1 + # Fees (in BTC/kvB) smaller than this are considered zero fee for # relaying, mining and transaction creation (default: 0.00001) #minrelaytxfee= -# Relay non-P2SH multisig (default: 1) +# Relay non-P2SH multisig (default: 0) #permitbaremultisig=1 -# Add 'forcerelay' permission to whitelisted inbound peers with default +# Relay legacy pubkey outputs (default: 0) +#permitbarepubkey=1 + +# Refuse to relay or mine parasitic overlay protocols (default: 1) +#rejectparasites=1 + +# Refuse to relay or mine transactions involving non-bitcoin tokens +# (default: 0) +#rejecttokens=1 + +# Accept transactions reusing addresses or other pubkey scripts (default: +# allow) +#spkreuse=1 + +# Add 'forcerelay' permission to whitelisted peers with default # permissions. This will relay transactions even if the # transactions were already in the mempool. (default: 0) #whitelistforcerelay=1 -# Add 'relay' permission to whitelisted inbound peers with default -# permissions. This will accept relayed transactions even when not -# relaying transactions (default: 1) +# Add 'relay' permission to whitelisted peers with default permissions. +# This will accept relayed transactions even when not relaying +# transactions (default: 1) #whitelistrelay=1 ### Block creation options -# Set maximum BIP141 block weight (default: 3996000) +# Set maximum block size in bytes (default: 300000) +#blockmaxsize= + +# Set maximum BIP141 block weight (default: 1200000) #blockmaxweight= # Set lowest fee rate (in BTC/kvB) for transactions to be included in # block creation. (default: 0.00001) #blockmintxfee= +# Set maximum size of high-priority/low-fee transactions in bytes +# (default: 100000) +#blockprioritysize= + ### RPC server options @@ -628,6 +736,10 @@ # option can be specified multiple times #rpcauth= +# A file with a single lines with same format as rpcauth. This option can +# be specified multiple times +#rpcauthfile= + # Bind to given address to listen for JSON-RPC connections. Do not expose # the RPC server to untrusted networks such as the public internet! # This option is ignored unless -rpcallowip is also passed. Port is @@ -640,6 +752,10 @@ # net-specific datadir location. (default: data dir) #rpccookiefile= +# Set permissions on the RPC auth cookie file so that it is readable by +# [owner|group|all] (default: rw-------) +#rpccookieperms= + # Password for JSON-RPC connections #rpcpassword= @@ -672,6 +788,16 @@ #server=1 +### Statistic options + + +# Enable statistics (default: 0) +#statsenable=1 + +# Set the memory limit target for statistics in bytes (default: 10485760) +#statsmaxmemorytarget= + + # [Sections] # Most options will apply to all networks. To confine an option to a specific # network, add it under the relevant section below.