Bitcoin Cash Node version v27.1.1-1ce1d89 (64-bit)
| Usage |
|---|
bitcoin-qt [command-line options] |
Options
| Argument | Description |
|---|---|
-?, -h, -help |
Print this help message and exit |
-??, -hh, -help-debug |
Print this help message including advanced debugging options and exit |
-alertnotify=<cmd> |
Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message) |
-assumevalid=<hex> |
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: 000000000000000000d680d0fe34e4dd4446efdb78cff40ebbde6703709f17df, testnet: 000000005f098c543e1b0fceede28b1e8d55a4673f4ec14bfe4181cb279a931b) |
-automaticunparking |
If a new block is connected to a parked chain with now much more proof-of-work than the active chain, then unpark the parked chain automatically (default: 1) |
-blocknotify=<cmd> |
Execute command when the best block changes (%s in cmd is replaced by block hash) |
-blockreconstructionextratxn=<n> |
Extra transactions to keep in memory for compact block reconstructions (default: 100) |
-blocksdir=<dir> |
Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>) |
-blocksonly |
Whether to reject transactions from network peers. Transactions from the wallet or RPC are not affected. (default: 0) |
-conf=<file> |
Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) |
-daemon |
Run in the background as a daemon and accept commands |
-datadir=<dir> |
Specify data directory |
-dbbatchsize=<n> |
Maximum database write batch size in bytes (default: 16777216) |
-dbcache=<n> |
Set database cache size in megabytes (4 to 16384, default: 450) |
-debuglogfile=<file> |
Specify location of debug log file. Relative paths will be prefixed by a net-specific datadir location. (0 to disable, default: debug.log) |
-excessiveblocksize=<n> |
Before upgrade 10 activates: Do not accept blocks larger than this limit, in bytes. After upgrade 10 activates: The minimum (floor) maximum block size used by the adaptive blocksize limit algorithm, in bytes. (default: 32000000, testnet: 32000000, testnet4: 2000000, scalenet: 256000000, chipnet: 2000000, regtest: 32000000) |
-expire |
Limit functionality of this node after the tentative upgrade date of May 15, 2025 (date can be set with -upgrade11activationtime=<n>). To avoid inadvertently using the wrong chain, the RPC interface will be disabled at that time. (default: 1) |
-feefilter |
Tell other nodes to filter invs to us by our mempool min fee (default: 1) |
-finalizationdelay=<n> |
Set the minimum amount of time to wait between a block header reception and the block finalization. Unit is seconds (default: 7200) |
-finalizeheaders |
Whether to reject new headers below maxreorgdepth if a finalized block exists (default: 1) |
-finalizeheaderspenalty=<n> |
Penalize peers sending headers below with DoS score <n> (default: 100) |
-includeconf=<file> |
Specify additional configuration file, relative to the -datadir path (only useable from configuration file, not command line) |
-indexdir=<dir> |
Specify directory to hold leveldb files (default: <datadir>) |
-loadblock=<file> |
Imports blocks from external blk000??.dat file on startup |
-maxmempool=<n> |
Keep the transaction memory pool below <n> megabytes (default: 320, testnet: 320, testnet4: 20, scalenet: 2560, chipnet: 20) |
-maxorphantx=<n> |
Keep at most <n> unconnectable transactions in memory (default: 100) |
-maxreorgdepth=<n> |
Configure at what depth blocks are considered final (-1 to disable, default: 10) |
-mempoolexpiry=<n> |
Do not keep transactions in the mempool longer than <n> hours (default: 336) |
-mempoolexpirytaskperiod=<n> |
Execute the mempool expiry task this often in hours (default: 24) |
-minimumchainwork=<hex> |
Minimum work assumed to exist on a valid chain in hex (default: 00000000000000000000000000000000000000000213bd5f21e666b57af9d26b, testnet: 00000000000000000000000000000000000000000000010c9369b9bb65c9b68d) |
-par=<n> |
Set the number of script verification threads (up to 256, 0 = auto, <0 = leave that many cores free, default: 0) |
-parkdeepreorg |
If connecting a new block would require rewinding more than one block from the active chain (i.e., a "deep reorg"), then mark the new block as parked (default: 1) |
-persistmempool |
Whether to save the mempool on shutdown and load on restart (default: 1) |
-pid=<file> |
Specify pid file. Relative paths will be prefixed by a net-specific datadir location. (default: bitcoind.pid) |
-prune=<n> |
Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is incompatible with -txindex and -rescan. Warning: Reverting this setting requires re-downloading the entire blockchain. (default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >=550 = automatically prune block files to stay under the specified target size in MiB) |
-reindex |
Rebuild chain state and block index from the blk*.dat files on disk |
-reindex-chainstate |
Rebuild chain state from the currently indexed blocks. When in pruning mode or if blocks on disk might be corrupted, use full -reindex instead. |
-sysperms |
Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality) |
-txindex |
Maintain a full transaction index, used by the getrawtransaction rpc call (default: 0) |
-usecashaddr |
Use CashAddr address format for destination encoding instead of the legacy base58 format (default: 1). Warning: Disabling this option will also disable all safety checks related to legacy address use. For example, attempts to send to legacy P2SH addresses will be allowed without warning. |
-version |
Print version and exit |
Connection options
| Argument | Description |
|---|---|
-addnode=<ip> |
Add a node to connect to and attempt to keep the connection open (see the addnode RPC command help for more info) |
-asmap=<file> |
Specify asn mapping used for bucketing of the peers (default: ip_asn.map). Relative paths will be prefixed by the net-specific datadir location. |
-banscore=<n> |
Threshold for disconnecting and discouraging misbehaving peers (default: 100) |
-bantime=<n> |
Default bantime (in seconds) for manually configured bans (default: 86400) |
-bind=<addr>[:<port>][=onion] |
Bind to given address and always listen on it (default: 0.0.0.0). Use [host]:port notation for IPv6. Append =onion to tag any incoming connections to that address and port as incoming Tor connections (default: 127.0.0.1:8334=onion, testnet: 127.0.0.1:18334=onion, testnet4: 127.0.0.1:28334=onion, scalenet: 127.0.0.1:38334=onion, chipnet: 127.0.0.1:48334=onion, regtest: 127.0.0.1:18445=onion) |
-connect=<ip> |
Connect only to the specified node(s); -connect=0 disables automatic connections (the rules for this peer are the same as for -addnode) |
-discover |
Discover own IP addresses (default: 1 when listening and no -externalip or -proxy) |
-dns |
Allow DNS lookups for -addnode, -seednode and -connect (default: 1) |
-dnsseed |
Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used) |
-enablebip61 |
Send reject messages per BIP61 (default: 1) |
-externalip=<ip> |
Specify your own public address |
-forcednsseed |
Always query for peer addresses via DNS lookup (default: 0) |
-listen |
Accept connections from outside (default: 1 if no -proxy or -connect) |
-listenonion |
Automatically create Tor onion service (default: 1) |
-maxconnections=<n> |
Maintain at most <n> connections to peers (default: 125) |
-maxreceivebuffer=<n> |
Maximum per-connection receive buffer, <n>*1000 bytes (default: 5000) |
-maxsendbuffer=<n> |
Maximum per-connection send buffer, <n>*1000 bytes (default: 1000) |
-maxtimeadjustment |
Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: 4200 seconds) |
-maxuploadtarget=<n> |
Tries to keep outbound traffic under the given target in MiB per 24h (0 for no limit, default: 0) |
-natpmp |
Use NAT-PMP to map the listening port (default: 0) |
-onion=<ip:port> |
Use separate SOCKS5 proxy to reach peers via Tor onion services (default: -proxy) |
-onlynet=<net> |
Only connect to nodes in network <net> (ipv4, ipv6 or onion) |
-peerbloomfilters |
Support filtering of blocks and transaction with bloom filters (default: 1) |
-peertimeout=<n> |
Specify p2p connection timeout in seconds. This option determines the amount of time a peer may be inactive before the connection to it is dropped. (minimum: 1, default: 60) |
-port=<port> |
Listen for connections on <port> (default: 8333, testnet: 18333, testnet4: 28333, scalenet: 38333, chipnet: 48333, regtest: 18444) |
-proxy=<ip:port> |
Connect through SOCKS5 proxy |
-proxyrandomize |
Randomize credentials for every proxy connection. This enables Tor stream isolation (default: 1) |
-seednode=<ip> |
Connect to a node to retrieve peer addresses, and disconnect |
-timeout=<n> |
Specify connection timeout in milliseconds (minimum: 1, default: 5000) |
-torcontrol=<ip>:<port> |
Tor control port to use if onion listening enabled (default: 127.0.0.1:9051) |
-torpassword=<pass> |
Tor control port password (default: empty) |
-upnp |
Use UPnP to map the listening port (default: 0) |
-useextversion |
Enable extended versioning handshake (default: 0) |
-whitebind=<addr> |
Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6 |
-whitelist=<IP address or network> |
Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple times. Whitelisted peers cannot be DoS banned and their transactions are always relayed, even if they are already in the mempool, useful e.g. for a gateway |
Wallet options
| Argument | Description |
|---|---|
-allowlegacyp2sh |
Re-enable deprecated legacy P2SH destination address types in the GUI wallet (default: 0) |
-avoidpartialspends |
Group outputs by address, selecting all or none, instead of selecting on a per-output basis. Privacy is improved as an address is only used once (unless someone sends to it after spending from it), but may result in slightly higher fees as suboptimal coin selection may result due to the added limitation (default: 0) |
-disablewallet |
Do not load the wallet and disable wallet RPC calls |
-fallbackfee=<amt> |
A fee rate (in BCH/kB) that will be used when fee estimation has insufficient data (default: 0.0002) |
-keypool=<n> |
Set key pool size to <n> (default: 1000) |
-mintxfee=<amt> |
Fees (in BCH/kB) smaller than this are considered zero fee for transaction creation (default: 0.00001) |
-paytxfee=<amt> |
Fee (in BCH/kB) to add to transactions you send (default: 0.00) |
-rescan |
Rescan the block chain for missing wallet transactions on startup |
-salvagewallet |
Attempt to recover private keys from a corrupt wallet on startup |
-spendzeroconfchange |
Spend unconfirmed change when sending transactions (default: 1) |
-upgradewallet |
Upgrade wallet to latest format on startup |
-usebip69 |
Lexicographically sort transaction inputs and outputs as defined in BIP69 (default: 1) |
-wallet=<path> |
Specify wallet database path. Can be specified multiple times to load multiple wallets. Path is interpreted relative to <walletdir> if it is not absolute, and will be created if it does not exist (as a directory containing a wallet.dat file and log files). For backwards compatibility this will also accept names of existing data files in <walletdir>.) |
-walletbroadcast |
Make the wallet broadcast transactions (default: 1) |
-walletdir=<dir> |
Specify directory to hold wallets (default: <datadir>/wallets if it exists, otherwise <datadir>) |
-walletnotify=<cmd> |
Execute command when a wallet transaction changes. %s in cmd is replaced by TxID and %w is replaced by wallet name. %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. |
-zapwallettxes=<mode> |
Delete all wallet transactions and only recover those parts of the blockchain through -rescan on startup (1 = keep tx meta data e.g. payment request information, 2 = drop tx meta data) |
Wallet debugging/testing options
| Argument | Description |
|---|---|
-dblogsize=<n> |
Flush wallet database activity from memory to disk log every <n> megabytes (default: 100) |
-flushwallet |
Run a thread to flush wallet periodically (default: 1) |
-privdb |
Sets the DB_PRIVATE flag in the wallet db environment (default: 1) |
ZeroMQ notification options
| Argument | Description |
|---|---|
-zmqpubhashblock=<address> |
Enable publish hash block in <address> |
-zmqpubhashds=<address> |
Enable publish hash double spend transaction in <address> |
-zmqpubhashtx=<address> |
Enable publish hash transaction in <address> |
-zmqpubrawblock=<address> |
Enable publish raw block in <address> |
-zmqpubrawds=<address> |
Enable publish raw double spend transaction in <address> |
-zmqpubrawtx=<address> |
Enable publish raw transaction in <address> |
Debugging/Testing options
| Argument | Description |
|---|---|
-addrmantest |
Allows to test address relay on localhost |
-allowunconnectedmining |
Set whether to allow the getblocktemplate RPC interface to work correctly even if the node is offline or otherwise not connected to any other nodes on the p2p network. (default: 0) |
-axionactivationtime=<n> |
Activation time of the November 2020 Bitcoin Cash Network Upgrade (<n> seconds since epoch, default: 1605441600). This option only has an effect on regtest or scalenet. |
-checkblockindex |
Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, ::ChainActive() and mapBlocksUnlinked occasionally. (default: 0, regtest: 1) |
-checkblockreads |
Do extra sanity checking for blocks read from disk that are to be served up for the p2p network or RPC. This option is intented for testing and may negatively impact performance. (default: 0, regtest: 1) |
-checkblocks=<n> |
How many blocks to check at startup (default: 6, 0 = all) |
-checklevel=<n> |
How thorough the block verification of -checkblocks is: level 0 reads the blocks from disk, level 1 verifies block validity, level 2 verifies undo data, level 3 checks disconnection of tip blocks, and level 4 tries to reconnect the blocks. Each level includes the checks of the previous levels (0-4, default: 3) |
-checkmempool=<n> |
Run checks every <n> transactions (default: 0, regtest: 1) |
-checkpoints |
Only accept block chain matching built-in checkpoints (default: 1) |
-debug=<category> |
Output debugging information (default: 0, supplying <category> is optional). If <category> is not supplied or if <category> = 1 or all, output all debugging information (except for httptrace). <category> can be: net, tor, mempool, http, bench, zmq, db, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb, finalization, parking, dsproof, httptrace, abla. |
-debugexclude=<category> |
Exclude debugging information for a category. Can be used in conjunction with -debug=1 to output debug logs for all categories except one or more specified categories. |
-deprecatedrpc=<method> |
Allows deprecated RPC method(s) to be used |
-dropmessagestest=<n> |
Randomly drop 1 of every <n> network messages |
-logips |
Include IP addresses in debug output (default: 0) |
-logthreadnames |
Prepend debug output with name of the originating thread (only available on platforms supporting thread_local) (default: 0) |
-logtimemicros |
Add microsecond precision to debug timestamps (default: 0) |
-logtimestamps |
Prepend debug output with timestamp (default: 1) |
-maxscriptcachesize=<n> |
Limit size of script cache to <n> MiB (0 to 16384, default: 32) |
-maxsigcachesize=<n> |
Limit size of signature cache to <n> MiB (0 to 16384, default: 32) |
-maxtipage=<n> |
Maximum tip age in seconds to consider node in initial block download (default: 86400) |
-maxtxfee=<amt> |
Maximum total fees (in BCH) to use in a single wallet transaction or raw transaction; setting this too low may abort large transactions (default: 0.10) |
-mocktime=<n> |
Replace actual time with <n> seconds since epoch (default: 0) |
-printpriority |
Log transaction priority and fee per kB when mining blocks (default: 0) |
-printtoconsole |
Send trace/debug info to console instead of debug.log file (default: 1 when no -daemon. To disable logging to file, set debuglogfile=0) |
-rejectsubversion=<substring> |
Reject peers having a user agent string containing <substring> (case-sensitive) |
-shrinkdebugfile |
Shrink debug.log file on client startup (default: 1 when no -debug) |
-stopafterblockimport |
Stop running after importing blocks from disk (default: 0) |
-stopatheight |
Stop running after reaching the given height in the main chain (default: 0) |
-uacomment=<cmt> |
Append comment to the user agent string |
-upgrade10activationheight=<n> |
Activation height of the May 2024 Bitcoin Cash Network Upgrade; first block using new rules will be after this height (default: 845890, testnet: 1605520, testnet4: 200740, scalenet: 10006, chipnet: 174519, regtest: 0) |
-upgrade11activationtime=<n> |
Activation time of the tentative May 2025 Bitcoin Cash Network Upgrade (<n> seconds since epoch, default: 1747310400, chipnet: 1731672000) |
-upgrade9activationheight=<n> |
Activation height of the May 2023 Bitcoin Cash Network Upgrade; first block using new rules will be after this height (default: 792772, testnet: 1552787, testnet4: 148043, scalenet: 10006, chipnet: 121956, regtest: 0) |
Chain selection options
| Argument | Description |
|---|---|
-chipnet |
Use the upcoming upgrade activation chain |
-regtest |
Enter regression test mode, which uses a special chain in which blocks can be solved instantly. This is intended for regression testing tools and app development. |
-scalenet |
Use the scaling test chain |
-testnet |
Use the test chain |
-testnet4 |
Use the test4 chain |
Node relay options
| Argument | Description |
|---|---|
-acceptnonstdtxn |
Relay and mine "non-standard" transactions (testnet/regtest only, default: 1) |
-bytespersigcheck=<n> |
Equivalent bytes per sigcheck in transactions for relay and mining (default: 50) |
-bytespersigop=<n> |
(Deprecated) Alias for -bytespersigcheck (default: 50) |
-datacarriersize=<n> |
Maximum total size of OP_RETURN output scripts in a single transaction we relay and mine (in bytes, 0 to reject all OP_RETURN transactions, default: 223) |
-doublespendproof |
Specify whether to enable or disable the double-spend proof subsystem. If enabled, the node will send and receive double-spend proof messages (default: 1). |
-dustrelayfee=<amt> |
Fee rate (in BCH/kB) used to defined dust, the value of an output such that it will cost about 1/3 of its value in fees at this fee rate to spend it. (default: 0.00001) |
-excessutxocharge=<amt> |
Fees (in BCH/kB) to charge per utxo created for relaying, and mining (default: 0.00) |
-minrelaytxfee=<amt> |
Fees (in BCH/kB) smaller than this are rejected for relaying, mining and transaction creation (default: 0.00001) |
-permitbaremultisig |
Relay non-P2SH multisig (default: 1) |
-txbroadcastinterval=<ms> |
Average time (in ms) between broadcasts of transaction inv messages. Higher values reduce outbound bandwidth dramatically by batching inv messages and reducing protocol overhead. Lower values will help transactions propagate faster. A value of 500 ms will begin to batch invs when tx throughput approaches 2 tx/sec. (default: 500) |
-txbroadcastrate=<tx/sec/mb> |
Rate at which transaction invs can be broadcast, in terms of the maximum block size. For example, a value of 7 with a blocksize limit of 32 MB will result in a tx inv broadcast rate of at most 224 tx/sec. (default: 7) |
-whitelistforcerelay |
Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 0) |
-whitelistrelay |
Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: 1) |
Block creation options
| Argument | Description |
|---|---|
-blockmaxsize=<n> |
Set maximum mined block size in bytes (default: 16000000, testnet: 16000000, testnet4: 2000000, scalenet: 16000000, chipnet: 2000000, regtest: 16000000) |
-blockmintxfee=<amt> |
Set lowest fee rate (in BCH/kB) for transactions to be included in block creation. (default: 0.00001) |
-blockversion=<n> |
Override block version to test forking scenarios |
-gbtcheckvalidity |
Set whether to test generated block templates for validity in getblocktemplate and/or getblocktemplatelight. Mining nodes may wish to skip validity checks as a performance optimization, particularly when mining large blocks. Validity checking can also be set on individual gbt calls by specifying the "checkvalidity": boolean key in the template_request object given to gbt. (default: 1) |
-maxgbttime=<n> |
Maximum time (in ms, 0 for no limit) to spend adding transactions to block templates in 'getblocktemplate' and 'generate' RPC calls (default: 0) |
-maxinitialgbttime=<n> |
Maximum time (in ms, 0 for no limit) to spend adding transactions in the first getblocktemplate (but not generate) call after receiving a new block (default: 0). If -maxgbttime is stricter than -maxinitialgbttime, then -maxinitialgbttime willbe ignored. |
-percentblockmaxsize=<percent> |
Set maximum mined block size as a floating-point percentage of the excessive block size. This is an alternative to -blockmaxsize. This option and -blockmaxsize cannot both be specified at the same time. (default: 50.0, testnet: 50.0, testnet4: 100.0, scalenet: 6.250, chipnet: 100.0, regtest: 50.0) |
RPC server options
| Argument | Description |
|---|---|
-gbtcachesize=<n> |
Specify how many recent getblocktemplatelight jobs to keep cached in memory (default: 10) |
-gbtstoredir=<dir> |
Specify a directory for storing getblocktemplatelight data (default: <datadir>/gbt/) |
-gbtstoretime=<secs> |
Specify time in seconds to keep getblocktemplatelight data in the -gbtstoredir before it is automatically deleted (0 to disable autodeletion, default: 3600). |
-rest |
Accept public REST requests (default: 0) |
-rpcallowip=<ip> |
Allow JSON-RPC connections from specified source. Valid for <ip> are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified multiple times |
-rpcauth=<userpw> |
Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcauth. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times |
-rpcbind=<addr>[:port] |
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 optional and overrides -rpcport. Use [host]:port notation for IPv6. This option can be specified multiple times (default: 127.0.0.1 and ::1 i.e., localhost) |
-rpccookiefile=<loc> |
Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir) |
-rpccorsdomain=value |
Domain from which to accept cross origin requests (browser enforced) |
-rpcpassword=<pw> |
Password for JSON-RPC connections |
-rpcport=<port> |
Listen for JSON-RPC connections on <port> (default: 8332, testnet: 18332, testnet4: 28332, scalenet: 38332, chipnet: 48332, regtest: 18443) |
-rpcservertimeout=<n> |
Timeout during HTTP requests (default: 30) |
-rpcthreads=<n> |
Set the number of threads to service RPC calls (default: 4) |
-rpcuser=<user> |
Username for JSON-RPC connections |
-rpcworkqueue=<n> |
Set the depth of the work queue to service RPC calls (default: 16) |
-server |
Accept command line and JSON-RPC commands |
UI Options
| Argument | Description |
|---|---|
-choosedatadir |
Choose data directory on startup (default: 0) |
-lang=<lang> |
Set language, for example "de_DE" (default: system locale) |
-min |
Start minimized (default: 0) |
-resetguisettings |
Reset all settings changed in the GUI |
-splash |
Show splash screen on startup (default: 1) |
-uiplatform |
Select platform to customize UI for (one of windows, macosx, other; default: other) |
Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.