diff --git a/contrib/completions/bash/bitcoin-cli.bash b/contrib/completions/bash/bitcoin-cli.bash index b04fdbcb0e..2272502578 100644 --- a/contrib/completions/bash/bitcoin-cli.bash +++ b/contrib/completions/bash/bitcoin-cli.bash @@ -1,5 +1,10 @@ -# bash programmable completion for bitcoin-cli(1) -# Copyright (c) 2012-2022 The Bitcoin Core developers +# Dynamic bash programmable completion for bitcoin-cli(1) +# DO NOT EDIT THIS FILE BY HAND -- THIS WILL FAIL THE FUNCTIONAL TEST tool_cli_completion +# This file is auto-generated by the functional test tool_cli_completion. +# If you want to modify this file, modify test/functional/tool_cli_completion.py and re-autogenerate +# this file via the --overwrite test flag. + +# Copyright (c) 2012-2024 The Bitcoin Core developers # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. @@ -30,8 +35,8 @@ _bitcoin_cli() { if ((cword > 5)); then case ${words[cword-5]} in - sendtoaddress) - COMPREPLY=( $( compgen -W "true false" -- "$cur" ) ) + descriptorprocesspsbt) + COMPREPLY=( $( compgen -W "false true" -- "$cur" ) ) return 0 ;; esac @@ -39,12 +44,12 @@ _bitcoin_cli() { if ((cword > 4)); then case ${words[cword-4]} in - importaddress|listtransactions|setban) - COMPREPLY=( $( compgen -W "true false" -- "$cur" ) ) + createpsbt|createrawtransaction|descriptorprocesspsbt|setban) + COMPREPLY=( $( compgen -W "false true" -- "$cur" ) ) return 0 ;; - signrawtransactionwithkey|signrawtransactionwithwallet) - COMPREPLY=( $( compgen -W "ALL NONE SINGLE ALL|ANYONECANPAY NONE|ANYONECANPAY SINGLE|ANYONECANPAY" -- "$cur" ) ) + signrawtransactionwithkey) + COMPREPLY=( $( compgen -W "ALL ALL|ANYONECANPAY NONE NONE|ANYONECANPAY SINGLE SINGLE|ANYONECANPAY" -- "$cur" ) ) return 0 ;; esac @@ -52,11 +57,8 @@ _bitcoin_cli() { if ((cword > 3)); then case ${words[cword-3]} in - addmultisigaddress) - return 0 - ;; - getbalance|gettxout|importaddress|importpubkey|importprivkey|listreceivedbyaddress|listsinceblock) - COMPREPLY=( $( compgen -W "true false" -- "$cur" ) ) + addnode|converttopsbt|dumptxoutset|getdescriptoractivity|gettxout|gettxoutsetinfo) + COMPREPLY=( $( compgen -W "false true" -- "$cur" ) ) return 0 ;; esac @@ -64,31 +66,32 @@ _bitcoin_cli() { if ((cword > 2)); then case ${words[cword-2]} in + converttopsbt|decoderawtransaction|finalizepsbt|getblockheader|getmempoolancestors|getmempooldescendants|getrawmempool|listmempooltransactions) + COMPREPLY=( $( compgen -W "false true" -- "$cur" ) ) + return 0 + ;; addnode) - COMPREPLY=( $( compgen -W "add remove onetry" -- "$cur" ) ) + COMPREPLY=( $( compgen -W "add onetry remove" -- "$cur" ) ) return 0 ;; setban) COMPREPLY=( $( compgen -W "add remove" -- "$cur" ) ) return 0 ;; - fundrawtransaction|getblock|getblockheader|getmempoolancestors|getmempooldescendants|getrawtransaction|gettransaction|listreceivedbyaddress|sendrawtransaction) - COMPREPLY=( $( compgen -W "true false" -- "$cur" ) ) + estimatesmartfee) + COMPREPLY=( $( compgen -W "CONSERVATIVE ECONOMICAL UNSET" -- "$cur" ) ) return 0 ;; esac fi case "$prev" in - backupwallet|dumpwallet|importwallet) + dumptxoutset|importmempool|loadtxoutset) _filedir return 0 ;; - getaddednodeinfo|getrawmempool|lockunspent) - COMPREPLY=( $( compgen -W "true false" -- "$cur" ) ) - return 0 - ;; - getbalance|getnewaddress|listtransactions|sendmany) + getrawmempool|setnetworkactive|setscriptthreadsenabled) + COMPREPLY=( $( compgen -W "false true" -- "$cur" ) ) return 0 ;; esac diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index d355289372..8a2fd9c286 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -1,21 +1,28 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-CLI "1" "December 2024" "bitcoin-cli v28.1.0" "User Commands" +.TH BITCOIN-CLI "1" "March 2025" "bitcoin-cli v28.1.0" "User Commands" .SH NAME bitcoin-cli \- manual page for bitcoin-cli v28.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 v28.1.0 +Bitcoin Knots RPC client version v28.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 \-? @@ -32,13 +39,20 @@ addresses known to the node may be higher. .IP 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. +and OS is not WIN32), never. Only applies to the output of +\fB\-getinfo\fR. .HP \fB\-conf=\fR .IP 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 +68,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 @@ -67,8 +82,10 @@ Pass named instead of positional arguments (default: false) \fB\-netinfo\fR .IP 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 +optional argument from 0 to 4 can be passed for different peers +listings (default: 0). If a non\-zero value is passed, an +additional "outonly" (or "o") argument can be passed to see +outbound peers only. Pass "help" (or "h") for detailed help documentation. .HP \fB\-rpcclienttimeout=\fR @@ -153,6 +170,12 @@ testnet4, 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 @@ -176,14 +199,15 @@ Consider moving to testnet4 now by using \fB\-testnet4\fR. .IP Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR. .SH COPYRIGHT -Copyright (C) 2009-2024 The Bitcoin Core developers +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 fe76cd970b..61b3ac97b2 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,14 +1,20 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-QT "1" "December 2024" "bitcoin-qt v28.1.0" "User Commands" +.TH BITCOIN-QT "1" "March 2025" "bitcoin-qt v28.1.0" "User Commands" .SH NAME bitcoin-qt \- manual page for bitcoin-qt v28.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 v28.1.0 +Bitcoin Knots version v28.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], in e.g. the BIP20 or BIP21 URI formats. .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: -000000000000000000011c5890365bdbe5d25b97ce0057589acaef4f1a57263f, +000000000000000000006e926737e6a349f7581525ad36e743dfe5f4bc3abbb7, testnet3: 000000000000000465b1a66c9f386308e8c75acef9201f3f577811da09fc90ad, testnet4: @@ -41,8 +47,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 @@ -82,6 +88,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) @@ -97,7 +113,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 @@ -116,6 +132,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) @@ -162,13 +183,20 @@ disable pruning blocks, 1 = allow manual pruning via RPC, >=550 = automatically prune block files to stay under the specified target size in MiB) .HP +\fB\-pruneduringinit\fR +.IP +Temporarily adjusts the \fB\-prune\fR setting until initial sync completes. +Ignored if pruning is disabled. (default: \fB\-1\fR = same value as +\fB\-prune\fR) +.HP \fB\-reindex\fR .IP 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 @@ -346,7 +374,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 @@ -388,6 +416,11 @@ Tor control host and port to use if onion listening enabled (default: .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: 0) @@ -401,14 +434,17 @@ 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 @@ -418,7 +454,8 @@ 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 -manual (default: incoming only). Can be specified multiple times. +outgoing (default: incoming only). Can be specified multiple +times. .PP Wallet options: .HP @@ -500,7 +537,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 @@ -521,16 +558,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 @@ -555,6 +596,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
@@ -572,6 +622,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
@@ -589,7 +648,7 @@ is optional). If is not supplied or if is 1 or "all", output all debug logging. If is 0 or "none", any other categories are ignored. Other valid values for are: addrman, bench, blockstorage, cmpctblock, coindb, -estimatefee, http, i2p, ipc, leveldb, libevent, mempool, +estimatefee, http, i2p, ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, txreconciliation, validation, walletdb, zmq. This option can be specified multiple times to @@ -658,6 +717,12 @@ testnet4, 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 @@ -683,24 +748,71 @@ Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\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 3. +(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 -(DEPRECATED) Accept transaction replace\-by\-fee without requiring -replaceability signaling (default: 1) +Accept transaction replace\-by\-fee without requiring replaceability +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 @@ -709,7 +821,26 @@ relaying, mining and transaction creation (default: 0.00001) .HP \fB\-permitbaremultisig\fR .IP -Relay transactions creating non\-P2SH multisig outputs (default: 1) +Relay transactions creating non\-P2SH multisig outputs (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 +Either "allow" to relay/mine transactions reusing addresses or other +pubkey scripts, or "conflict" to treat them as exclusive prior to +being mined (default: allow) .HP \fB\-whitelistforcerelay\fR .IP @@ -725,14 +856,23 @@ 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 @@ -748,14 +888,21 @@ are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be specified multiple times .HP -\fB\-rpcauth=\fR +\fB\-rpcauth=\fR[:wallet] .IP Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The field comes in the format: :$. A canonical python script is included in share/rpcauth. The client then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times +rpcuser=/rpcpassword= pair of arguments. A +single wallet name can also be specified to restrict access to +only that wallet, or '\-' to deny all wallet access. 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 @@ -787,7 +934,7 @@ Listen for JSON\-RPC connections on (default: 8332, testnet3: .HP \fB\-rpcthreads=\fR .IP -Set the number of threads to service RPC calls (default: 4) +Set the number of threads to service RPC calls (default: 16) .HP \fB\-rpcuser=\fR .IP @@ -820,6 +967,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) @@ -835,15 +986,26 @@ 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 +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 26cbd9bff7..7d151fb6d7 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -1,15 +1,19 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-TX "1" "December 2024" "bitcoin-tx v28.1.0" "User Commands" +.TH BITCOIN-TX "1" "March 2025" "bitcoin-tx v28.1.0" "User Commands" .SH NAME bitcoin-tx \- manual page for bitcoin-tx v28.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 v28.1.0 +Bitcoin Knots bitcoin\-tx utility version v28.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 @@ testnet4, 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 @@ -142,14 +152,15 @@ set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING .SH COPYRIGHT -Copyright (C) 2009-2024 The Bitcoin Core developers +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 415e6d04b1..1b52fa4424 100644 --- a/doc/man/bitcoin-util.1 +++ b/doc/man/bitcoin-util.1 @@ -1,12 +1,17 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-UTIL "1" "December 2024" "bitcoin-util v28.1.0" "User Commands" +.TH BITCOIN-UTIL "1" "March 2025" "bitcoin-util v28.1.0" "User Commands" .SH NAME bitcoin-util \- manual page for bitcoin-util v28.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 v28.1.0 +Bitcoin Knots bitcoin\-util utility version v28.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 @@ testnet4, 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 @@ -60,14 +71,15 @@ grind .IP Perform proof of work on hex header string .SH COPYRIGHT -Copyright (C) 2009-2024 The Bitcoin Core developers +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 a0431292ae..6a39cbbc22 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -1,16 +1,18 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-WALLET "1" "December 2024" "bitcoin-wallet v28.1.0" "User Commands" +.TH BITCOIN-WALLET "1" "March 2025" "bitcoin-wallet v28.1.0" "User Commands" .SH NAME bitcoin-wallet \- manual page for bitcoin-wallet v28.1.0 +.SH SYNOPSIS +.B bitcoin-wallet +[\fI\,options\/\fR] \fI\,\/\fR .SH DESCRIPTION -Bitcoin Core bitcoin\-wallet version v28.1.0 +Bitcoin Knots bitcoin\-wallet utility version v28.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/\-testnet4 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 / \fB\-testnet4\fR arguments. .SH OPTIONS .HP \-? @@ -75,6 +77,12 @@ testnet4, 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 @@ -112,6 +120,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 @@ -121,14 +133,15 @@ salvage Attempt to recover private keys from a corrupt wallet. Warning: \&'salvage' is experimental. .SH COPYRIGHT -Copyright (C) 2009-2024 The Bitcoin Core developers +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 1acb2dfa0a..155428ea90 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,12 +1,20 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIND "1" "December 2024" "bitcoind v28.1.0" "User Commands" +.TH BITCOIND "1" "March 2025" "bitcoind v28.1.0" "User Commands" .SH NAME bitcoind \- manual page for bitcoind v28.1.0 .SH SYNOPSIS .B bitcoind -[\fI\,options\/\fR] \fI\,Start Bitcoin Core\/\fR +[\fI\,options\/\fR] .SH DESCRIPTION -Bitcoin Core version v28.1.0 +Bitcoin Knots daemon version v28.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: -000000000000000000011c5890365bdbe5d25b97ce0057589acaef4f1a57263f, +000000000000000000006e926737e6a349f7581525ad36e743dfe5f4bc3abbb7, testnet3: 000000000000000465b1a66c9f386308e8c75acef9201f3f577811da09fc90ad, testnet4: @@ -39,8 +47,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 @@ -80,6 +88,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) @@ -95,7 +113,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 @@ -114,6 +132,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,13 +183,20 @@ disable pruning blocks, 1 = allow manual pruning via RPC, >=550 = automatically prune block files to stay under the specified target size in MiB) .HP +\fB\-pruneduringinit\fR +.IP +Temporarily adjusts the \fB\-prune\fR setting until initial sync completes. +Ignored if pruning is disabled. (default: \fB\-1\fR = same value as +\fB\-prune\fR) +.HP \fB\-reindex\fR .IP 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 @@ -344,7 +374,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 @@ -386,6 +416,11 @@ Tor control host and port to use if onion listening enabled (default: .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: 0) @@ -399,14 +434,17 @@ 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 @@ -416,7 +454,8 @@ 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 -manual (default: incoming only). Can be specified multiple times. +outgoing (default: incoming only). Can be specified multiple +times. .PP Wallet options: .HP @@ -498,7 +537,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 @@ -519,16 +558,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 @@ -553,6 +596,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
@@ -570,6 +622,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
@@ -587,7 +648,7 @@ is optional). If is not supplied or if is 1 or "all", output all debug logging. If is 0 or "none", any other categories are ignored. Other valid values for are: addrman, bench, blockstorage, cmpctblock, coindb, -estimatefee, http, i2p, ipc, leveldb, libevent, mempool, +estimatefee, http, i2p, ipc, leveldb, libevent, lock, mempool, mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, tor, txpackages, txreconciliation, validation, walletdb, zmq. This option can be specified multiple times to @@ -656,6 +717,12 @@ testnet4, 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 @@ -681,24 +748,71 @@ Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\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 3. +(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 -(DEPRECATED) Accept transaction replace\-by\-fee without requiring -replaceability signaling (default: 1) +Accept transaction replace\-by\-fee without requiring replaceability +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 @@ -707,7 +821,26 @@ relaying, mining and transaction creation (default: 0.00001) .HP \fB\-permitbaremultisig\fR .IP -Relay transactions creating non\-P2SH multisig outputs (default: 1) +Relay transactions creating non\-P2SH multisig outputs (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 +Either "allow" to relay/mine transactions reusing addresses or other +pubkey scripts, or "conflict" to treat them as exclusive prior to +being mined (default: allow) .HP \fB\-whitelistforcerelay\fR .IP @@ -723,14 +856,23 @@ 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 @@ -746,14 +888,21 @@ are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be specified multiple times .HP -\fB\-rpcauth=\fR +\fB\-rpcauth=\fR[:wallet] .IP Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The field comes in the format: :$. A canonical python script is included in share/rpcauth. The client then connects normally using the -rpcuser=/rpcpassword= pair of arguments. This -option can be specified multiple times +rpcuser=/rpcpassword= pair of arguments. A +single wallet name can also be specified to restrict access to +only that wallet, or '\-' to deny all wallet access. 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 @@ -785,7 +934,7 @@ Listen for JSON\-RPC connections on (default: 8332, testnet3: .HP \fB\-rpcthreads=\fR .IP -Set the number of threads to service RPC calls (default: 4) +Set the number of threads to service RPC calls (default: 16) .HP \fB\-rpcuser=\fR .IP @@ -811,15 +960,26 @@ 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 +Copyright (C) 2009-2025 The Bitcoin Knots developers +Copyright (C) 2009-2025 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 .SH "SEE ALSO" -bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1) +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 a8dfc2735d..fcdb30657a 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: -# 000000000000000000011c5890365bdbe5d25b97ce0057589acaef4f1a57263f, +# 000000000000000000006e926737e6a349f7581525ad36e743dfe5f4bc3abbb7, # testnet3: # 000000000000000465b1a66c9f386308e8c75acef9201f3f577811da09fc90ad, # testnet4: @@ -33,8 +33,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 @@ -68,6 +68,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 @@ -78,7 +86,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= @@ -95,6 +103,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= @@ -133,11 +145,17 @@ # target size in MiB) #prune= +# Temporarily adjusts the -prune setting until initial sync completes. +# Ignored if pruning is disabled. (default: -1 = same value as +# -prune) +#pruneduringinit=1 + # 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. #reindex=1 # If enabled, wipe chain state, and rebuild it from blk*.dat files on @@ -285,7 +303,7 @@ #peerblockfilters=1 # Support filtering of blocks and transaction with bloom filters (default: -# 0) +# 1) #peerbloomfilters=1 # Listen for connections on (default: 8333, testnet3: 18333, @@ -321,6 +339,10 @@ # 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: 0) #upnp=1 @@ -330,14 +352,17 @@ # 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> @@ -346,7 +371,8 @@ # 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 -# manual (default: incoming only). Can be specified multiple times. +# outgoing (default: incoming only). Can be specified multiple +# times. #whitelist=<[permissions@]IP address or network> @@ -416,7 +442,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 @@ -435,14 +461,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) @@ -465,6 +494,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=
@@ -478,6 +514,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=
@@ -493,7 +536,7 @@ # or "all", output all debug logging. If is 0 or "none", # any other categories are ignored. Other valid values for # are: addrman, bench, blockstorage, cmpctblock, coindb, -# estimatefee, http, i2p, ipc, leveldb, libevent, mempool, +# estimatefee, http, i2p, ipc, leveldb, libevent, lock, mempool, # mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, scan, # selectcoins, tor, txpackages, txreconciliation, validation, # walletdb, zmq. This option can be specified multiple times to @@ -552,6 +595,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) @@ -575,28 +623,81 @@ ### 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 -# (DEPRECATED) Accept transaction replace-by-fee without requiring -# replaceability signaling (default: 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 3. +# (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: 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 transactions creating non-P2SH multisig outputs (default: 1) +# Relay transactions creating non-P2SH multisig outputs (default: 0) #permitbaremultisig=1 +# 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 + +# Either "allow" to relay/mine transactions reusing addresses or other +# pubkey scripts, or "conflict" to treat them as exclusive prior to +# being mined (default: allow) +#spkreuse= + # Add 'forcerelay' permission to whitelisted peers with default # permissions. This will relay transactions even if the # transactions were already in the mempool. (default: 0) @@ -611,13 +712,20 @@ ### 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 @@ -636,9 +744,15 @@ # field comes in the format: :$. A # canonical python script is included in share/rpcauth. The client # then connects normally using the -# rpcuser=/rpcpassword= pair of arguments. This -# option can be specified multiple times -#rpcauth= +# rpcuser=/rpcpassword= pair of arguments. A +# single wallet name can also be specified to restrict access to +# only that wallet, or '-' to deny all wallet access. This option +# can be specified multiple times +#rpcauth=[:wallet] + +# 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! @@ -663,7 +777,7 @@ # 18332, testnet4: 48332, signet: 38332, regtest: 18443) #rpcport= -# Set the number of threads to service RPC calls (default: 4) +# Set the number of threads to service RPC calls (default: 16) #rpcthreads= # Username for JSON-RPC connections @@ -688,6 +802,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.