Skip to content

Bitcoin Cash Node Daemon version v0.21.2

Usage Description
bitcoind [options] Start Bitcoin Cash Node Daemon

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: 000000000000000000c0fd281da21c51356771c89b34cb55ea1413d9c1ca4e66, testnet: 0000000000002b1dcad9b546e9de3eda59dea9547f48cd8803c75fb0cf3a18a0)
-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 operate in a blocks only mode (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 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> Do not accept blocks larger than this limit, in bytes (default: 32000000)
-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)
-includeconf=<file> Specify additional configuration file, relative to the -datadir path (only useable from configuration file, not command line)
-loadblock=<file> Imports blocks from external blk000??.dat file on startup
-maxmempool=<n> Keep the transaction memory pool below <n> megabytes (default: 300)
-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)
-minimumchainwork=<hex> Minimum work assumed to exist on a valid chain in hex (default: 00000000000000000000000000000000000000000131410982cd0adc8ef33d88, testnet: 0000000000000000000000000000000000000000000000594d3c47e367215741)
-par=<n> Set the number of script verification threads (up to 16, 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)
-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)
-banscore=<n> Threshold for disconnecting misbehaving peers (default: 100)
-bantime=<n> Number of seconds to keep misbehaving peers from reconnecting (default: 86400)
-bind=<addr> Bind to given address and always listen on it. Use [host]:port notation for IPv6
-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 hidden 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)
-onion=<ip:port> Use separate SOCKS5 proxy to reach peers via Tor hidden 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)
-port=<port> Listen for connections on <port> (default: 8333, testnet: 18333, 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)
-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
-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
-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)
-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)
-walletrejectlongchains Wallet will not create transactions that violate mempool chain limits (default: 0)

ZeroMQ notification options

Argument Description
-zmqpubhashblock=<address> Enable publish hash block in <address>
-zmqpubhashtx=<address> Enable publish hash transaction in <address>
-zmqpubrawblock=<address> Enable publish raw block in <address>
-zmqpubrawtx=<address> Enable publish raw transaction in <address>

Debugging/Testing options

Argument Description
-addrmantest Allows to test address relay on localhost
-checkblockindex Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, ::ChainActive() and mapBlocksUnlinked occasionally. (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, output all debugging information.<category> can be: net, tor, mempool, http, bench, zmq, db, rpc, estimatefee, addrman, selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej, libevent, coindb, qt, leveldb.
-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
-limitancestorcount=<n> Do not accept transactions if number of in-mempool ancestors is <n> or more (pre-phonon-upgrade default: 25, post-phonon-upgrade default: 50)
-limitancestorsize=<n> Do not accept transactions whose size with all in-mempool ancestors exceeds <n> kilobytes (default: 101)
-limitdescendantcount=<n> Do not accept transactions if any ancestor would have <n> or more in-mempool descendants (default pre-phonon-upgrade: 25, default post-phonon-upgrade: 50)
-limitdescendantsize=<n> Do not accept transactions if any ancestor would have more than <n> kilobytes of in-mempool descendants (default: 101).
-logips Include IP addresses in debug output (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)
-phononactivationtime=<n> Activation time of the May 2020 Bitcoin Cash Network Upgrade (<n> seconds since epoch, default: 1589544000)
-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)
-replayprotectionactivationtime=<n> Activation time of the automatic replay protection mechanism that will fork this node off the Bitcoin Cash network, intended to coincide with the activation of the first Bitcoin Cash Network Upgrade not yet implemented in this version of the node, which is scheduled for November 2020 (<n> seconds since epoch, default: 1605441600)
-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

Chain selection options

Argument Description
-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.
-testnet Use the test chain

Node relay options

Argument Description
-acceptnonstdtxn Relay and mine "non-standard" transactions (testnet/regtest only, default: 1)
-bytespersigop=<n> Equivalent bytes per sigop in transactions for relay and mining (default: 50)
-datacarrier Relay and mine OP_RETURN transactions (deprecated, will be removed in v0.22, use -datacarriersize instead; default: 1)
-datacarriersize=<n> Maximum size of data script in OP_RETURN transactions we relay and mine (in bytes, 0 to reject all OP_RETURN transactions, default: 223)
-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)
-whitelistforcerelay Force relay of transactions from whitelisted peers even if they violate local relay policy (default: 1)
-whitelistrelay Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: 1)

Block creation options

Argument Description
-blockmaxsize=<n> Set maximum block size in bytes (default: 2000000)
-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

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/rpcuser. 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. 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, or if -rpcallowip has been specified, 0.0.0.0 and :: i.e., all addresses)
-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, 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