1BITCOIND(1) User Commands BITCOIND(1)
2
6 bitcoind - manual page for bitcoind v24.0.1
7
9 bitcoind [options] Start Bitcoin Core
10
12 Bitcoin Core version v24.0.1
13
15 -?
16 Print this help message and exit
18 -alertnotify=<cmd>
20 Execute command when an alert is raised (%s in cmd is replaced
22 by message)
23 -assumevalid=<hex>
25 If this block is in the chain assume that it and its ancestors
27 are valid and potentially skip their script verification (0 to
28 verify all, default:
29 00000000000000000009c97098b5295f7e5f183ac811fb5d1534040adb93cabd,
30 testnet:
31 0000000000000004877fa2d36316398528de4f347df2f8a96f76613a298ce060,
32 signet:
33 000000d1a0e224fa4679d2fb2187ba55431c284fa1b74cbc8cfda866fd4d2c09)
34 -blockfilterindex=<type>
36 Maintain an index of compact filters by block (default: 0, val‐
38 ues: basic). If <type> is not supplied or if <type> = 1, indexes
39 for all known types are enabled.
40 -blocknotify=<cmd>
42 Execute command when the best block changes (%s in cmd is re‐
44 placed by block hash)
45 -blockreconstructionextratxn=<n>
47 Extra transactions to keep in memory for compact block recon‐
49 structions (default: 100)
50 -blocksdir=<dir>
52 Specify directory to hold blocks subdirectory for *.dat files
54 (default: <datadir>)
55 -blocksonly
57 Whether to reject transactions from network peers. Automatic
59 broadcast and rebroadcast of any transactions from inbound peers
60 is disabled, unless the peer has the 'forcerelay' permission.
61 RPC transactions are not affected. (default: 0)
62 -coinstatsindex
64 Maintain coinstats index used by the gettxoutsetinfo RPC (de‐
66 fault: 0)
67 -conf=<file>
69 Specify path to read-only configuration file. Relative paths
71 will be prefixed by datadir location (only useable from command
72 line, not configuration file) (default: bitcoin.conf)
73 -daemon
75 Run in the background as a daemon and accept commands (default:
77 0)
78 -daemonwait
80 Wait for initialization to be finished before exiting. This im‐
82 plies -daemon (default: 0)
83 -datadir=<dir>
85 Specify data directory
87 -dbcache=<n>
89 Maximum database cache size <n> MiB (4 to 16384, default: 450).
91 In addition, unused mempool memory is shared for this cache (see
92 -maxmempool).
93 -debuglogfile=<file>
95 Specify location of debug log file. Relative paths will be pre‐
97 fixed by a net-specific datadir location. (-nodebuglogfile to
98 disable; default: debug.log)
99 -includeconf=<file>
101 Specify additional configuration file, relative to the -datadir
103 path (only useable from configuration file, not command line)
104 -loadblock=<file>
106 Imports blocks from external file on startup
108 -maxmempool=<n>
110 Keep the transaction memory pool below <n> megabytes (default:
112 300)
113 -maxorphantx=<n>
115 Keep at most <n> unconnectable transactions in memory (default:
117 100)
118 -mempoolexpiry=<n>
120 Do not keep transactions in the mempool longer than <n> hours
122 (default: 336)
123 -par=<n>
125 Set the number of script verification threads (-10 to 15, 0 =
127 auto, <0 = leave that many cores free, default: 0)
128 -persistmempool
130 Whether to save the mempool on shutdown and load on restart (de‐
132 fault: 1)
133 -pid=<file>
135 Specify pid file. Relative paths will be prefixed by a net-spe‐
137 cific datadir location. (default: bitcoind.pid)
138 -prune=<n>
140 Reduce storage requirements by enabling pruning (deleting) of
142 old blocks. This allows the pruneblockchain RPC to be called to
143 delete specific blocks and enables automatic pruning of old
144 blocks if a target size in MiB is provided. This mode is incom‐
145 patible with -txindex. Warning: Reverting this setting requires
146 re-downloading the entire blockchain. (default: 0 = disable
147 pruning blocks, 1 = allow manual pruning via RPC, >=550 = auto‐
148 matically prune block files to stay under the specified target
149 size in MiB)
150 -reindex
152 Rebuild chain state and block index from the blk*.dat files on
154 disk. This will also rebuild active optional indexes.
155 -reindex-chainstate
157 Rebuild chain state from the currently indexed blocks. When in
159 pruning mode or if blocks on disk might be corrupted, use full
160 -reindex instead. Deactivate all optional indexes before running
161 this.
162 -sandbox=<mode>
164 Use the experimental syscall sandbox in the specified mode
166 (-sandbox=log-and-abort or -sandbox=abort). Allow only expected
167 syscalls to be used by bitcoind. Note that this is an experimen‐
168 tal new feature that may cause bitcoind to exit or crash unex‐
169 pectedly: use with caution. In the "log-and-abort" mode the in‐
170 vocation of an unexpected syscall results in a debug handler be‐
171 ing invoked which will log the incident and terminate the pro‐
172 gram (without executing the unexpected syscall). In the "abort"
173 mode the invocation of an unexpected syscall results in the en‐
174 tire process being killed immediately by the kernel without exe‐
175 cuting the unexpected syscall.
176 -settings=<file>
178 Specify path to dynamic settings data file. Can be disabled with
180 -nosettings. File is written at runtime and not meant to be
181 edited by users (use bitcoin.conf instead for custom settings).
182 Relative paths will be prefixed by datadir location. (default:
183 settings.json)
184 -startupnotify=<cmd>
186 Execute command on startup.
188 -sysperms
190 Create new files with system default permissions, instead of
192 umask 077 (only effective with disabled wallet functionality)
193 -txindex
195 Maintain a full transaction index, used by the getrawtransaction
197 rpc call (default: 0)
198 -version
200 Print version and exit
202 Connection options:
204 -addnode=<ip>
206 Add a node to connect to and attempt to keep the connection open
208 (see the addnode RPC help for more info). This option can be
209 specified multiple times to add multiple nodes; connections are
210 limited to 8 at a time and are counted separately from the -max‐
211 connections limit.
212 -asmap=<file>
214 Specify asn mapping used for bucketing of the peers (default:
216 ip_asn.map). Relative paths will be prefixed by the net-specific
217 datadir location.
218 -bantime=<n>
220 Default duration (in seconds) of manually configured bans (de‐
222 fault: 86400)
223 -bind=<addr>[:<port>][=onion]
225 Bind to given address and always listen on it (default:
227 0.0.0.0). Use [host]:port notation for IPv6. Append =onion to
228 tag any incoming connections to that address and port as incom‐
229 ing Tor connections (default: 127.0.0.1:8334=onion, testnet:
230 127.0.0.1:18334=onion, signet: 127.0.0.1:38334=onion, regtest:
231 127.0.0.1:18445=onion)
232 -cjdnsreachable
234 If set, then this host is configured for CJDNS (connecting to
236 fc00::/8 addresses would lead us to the CJDNS network, see
237 doc/cjdns.md) (default: 0)
238 -connect=<ip>
240 Connect only to the specified node; -noconnect disables auto‐
242 matic connections (the rules for this peer are the same as for
243 -addnode). This option can be specified multiple times to con‐
244 nect to multiple nodes.
245 -discover
247 Discover own IP addresses (default: 1 when listening and no -ex‐
249 ternalip or -proxy)
250 -dns
252 Allow DNS lookups for -addnode, -seednode and -connect (default:
254 1)
255 -dnsseed
257 Query for peer addresses via DNS lookup, if low on addresses
259 (default: 1 unless -connect used)
260 -externalip=<ip>
262 Specify your own public address
264 -fixedseeds
266 Allow fixed seeds if DNS seeds don't provide peers (default: 1)
268 -forcednsseed
270 Always query for peer addresses via DNS lookup (default: 0)
272 -i2pacceptincoming
274 If set and -i2psam is also set then incoming I2P connections are
276 accepted via the SAM proxy. If this is not set but -i2psam is
277 set then only outgoing connections will be made to the I2P net‐
278 work. Ignored if -i2psam is not set. Listening for incoming I2P
279 connections is done through the SAM proxy, not by binding to a
280 local address and port (default: 1)
281 -i2psam=<ip:port>
283 I2P SAM proxy to reach I2P peers and accept I2P connections (de‐
285 fault: none)
286 -listen
288 Accept connections from outside (default: 1 if no -proxy or
290 -connect)
291 -listenonion
293 Automatically create Tor onion service (default: 1)
295 -maxconnections=<n>
297 Maintain at most <n> connections to peers (default: 125). This
299 limit does not apply to connections manually added via -addnode
300 or the addnode RPC, which have a separate limit of 8.
301 -maxreceivebuffer=<n>
303 Maximum per-connection receive buffer, <n>*1000 bytes (default:
305 5000)
306 -maxsendbuffer=<n>
308 Maximum per-connection send buffer, <n>*1000 bytes (default:
310 1000)
311 -maxtimeadjustment
313 Maximum allowed median peer time offset adjustment. Local per‐
315 spective of time may be influenced by outbound peers forward or
316 backward by this amount (default: 4200 seconds).
317 -maxuploadtarget=<n>
319 Tries to keep outbound traffic under the given target per 24h.
321 Limit does not apply to peers with 'download' permission or
322 blocks created within past week. 0 = no limit (default: 0M). Op‐
323 tional suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is
324 1000 base while uppercase is 1024 base
325 -natpmp
327 Use NAT-PMP to map the listening port (default: 0)
329 -networkactive
331 Enable all P2P network activity (default: 1). Can be changed by
333 the setnetworkactive RPC command
334 -onion=<ip:port>
336 Use separate SOCKS5 proxy to reach peers via Tor onion services,
338 set -noonion to disable (default: -proxy)
339 -onlynet=<net>
341 Make automatic outbound connections only to network <net> (ipv4,
343 ipv6, onion, i2p, cjdns). Inbound and manual connections are not
344 affected by this option. It can be specified multiple times to
345 allow multiple networks.
346 -peerblockfilters
348 Serve compact block filters to peers per BIP 157 (default: 0)
350 -peerbloomfilters
352 Support filtering of blocks and transaction with bloom filters
354 (default: 0)
355 -port=<port>
357 Listen for connections on <port>. Nodes not using the default
359 ports (default: 8333, testnet: 18333, signet: 38333, regtest:
360 18444) are unlikely to get incoming connections. Not relevant
361 for I2P (see doc/i2p.md).
362 -proxy=<ip:port>
364 Connect through SOCKS5 proxy, set -noproxy to disable (default:
366 disabled)
367 -proxyrandomize
369 Randomize credentials for every proxy connection. This enables
371 Tor stream isolation (default: 1)
372 -seednode=<ip>
374 Connect to a node to retrieve peer addresses, and disconnect.
376 This option can be specified multiple times to connect to multi‐
377 ple nodes.
378 -timeout=<n>
380 Specify socket connection timeout in milliseconds. If an initial
382 attempt to connect is unsuccessful after this amount of time,
383 drop it (minimum: 1, default: 5000)
384 -torcontrol=<ip>:<port>
386 Tor control port to use if onion listening enabled (default:
388 127.0.0.1:9051)
389 -torpassword=<pass>
391 Tor control port password (default: empty)
393 -upnp
395 Use UPnP to map the listening port (default: 0)
397 -whitebind=<[permissions@]addr>
399 Bind to the given address and add permission flags to the peers
401 connecting to it. Use [host]:port notation for IPv6. Allowed
402 permissions: bloomfilter (allow requesting BIP37 filtered blocks
403 and transactions), noban (do not ban for misbehavior; implies
404 download), forcerelay (relay transactions that are already in
405 the mempool; implies relay), relay (relay even in -blocksonly
406 mode, and unlimited transaction announcements), mempool (allow
407 requesting BIP35 mempool contents), download (allow getheaders
408 during IBD, no disconnect after maxuploadtarget limit), addr
409 (responses to GETADDR avoid hitting the cache and contain random
410 records with the most up-to-date info). Specify multiple permis‐
411 sions separated by commas (default: download,noban,mempool,re‐
412 lay). Can be specified multiple times.
413 -whitelist=<[permissions@]IP address or network>
415 Add permission flags to the peers connecting from the given IP
417 address (e.g. 1.2.3.4) or CIDR-notated network (e.g.
418 1.2.3.0/24). Uses the same permissions as -whitebind. Can be
419 specified multiple times.
420 Wallet options:
422 -addresstype
424 What type of addresses to use ("legacy", "p2sh-segwit",
426 "bech32", or "bech32m", default: "bech32")
427 -avoidpartialspends
429 Group outputs by address, selecting many (possibly all) or none,
431 instead of selecting on a per-output basis. Privacy is improved
432 as addresses are mostly swept with fewer transactions and out‐
433 puts are aggregated in clean change addresses. It may result in
434 higher fees due to less optimal coin selection caused by this
435 added limitation and possibly a larger-than-necessary number of
436 inputs being used. Always enabled for wallets with "avoid_reuse"
437 enabled, otherwise default: 0.
438 -changetype
440 What type of change to use ("legacy", "p2sh-segwit", "bech32",
442 or "bech32m"). Default is "legacy" when -addresstype=legacy,
443 else it is an implementation detail.
444 -consolidatefeerate=<amt>
446 The maximum feerate (in BTC/kvB) at which transaction building
448 may use more inputs than strictly necessary so that the wallet's
449 UTXO pool can be reduced (default: 0.0001).
450 -disablewallet
452 Do not load the wallet and disable wallet RPC calls
454 -discardfee=<amt>
456 The fee rate (in BTC/kvB) that indicates your tolerance for dis‐
458 carding change by adding it to the fee (default: 0.0001). Note:
459 An output is discarded if it is dust at this rate, but we will
460 always discard up to the dust relay fee and a discard fee above
461 that is limited by the fee estimate for the longest target
462 -fallbackfee=<amt>
464 A fee rate (in BTC/kvB) that will be used when fee estimation
466 has insufficient data. 0 to entirely disable the fallbackfee
467 feature. (default: 0.00)
468 -keypool=<n>
470 Set key pool size to <n> (default: 1000). Warning: Smaller sizes
472 may increase the risk of losing funds when restoring from an old
473 backup, if none of the addresses in the original keypool have
474 been used.
475 -maxapsfee=<n>
477 Spend up to this amount in additional (absolute) fees (in BTC)
479 if it allows the use of partial spend avoidance (default: 0.00)
480 -mintxfee=<amt>
482 Fee rates (in BTC/kvB) smaller than this are considered zero fee
484 for transaction creation (default: 0.00001)
485 -paytxfee=<amt>
487 Fee rate (in BTC/kvB) to add to transactions you send (default:
489 0.00)
490 -signer=<cmd>
492 External signing tool, see doc/external-signer.md
494 -spendzeroconfchange
496 Spend unconfirmed change when sending transactions (default: 1)
498 -txconfirmtarget=<n>
500 If paytxfee is not set, include enough fee so transactions begin
502 confirmation on average within n blocks (default: 6)
503 -wallet=<path>
505 Specify wallet path to load at startup. Can be used multiple
507 times to load multiple wallets. Path is to a directory contain‐
508 ing wallet data and log files. If the path is not absolute, it
509 is interpreted relative to <walletdir>. This only loads existing
510 wallets and does not create new ones. For backwards compatibil‐
511 ity this also accepts names of existing top-level data files in
512 <walletdir>.
513 -walletbroadcast
515 Make the wallet broadcast transactions (default: 1)
517 -walletdir=<dir>
519 Specify directory to hold wallets (default: <datadir>/wallets if
521 it exists, otherwise <datadir>)
522 -walletnotify=<cmd>
524 Execute command when a wallet transaction changes. %s in cmd is
526 replaced by TxID, %w is replaced by wallet name, %b is replaced
527 by the hash of the block including the transaction (set to 'un‐
528 confirmed' if the transaction is not included) and %h is re‐
529 placed by the block height (-1 if not included). %w is not cur‐
530 rently implemented on windows. On systems where %w is supported,
531 it should NOT be quoted because this would break shell escaping
532 used to invoke the command.
533 -walletrbf
535 Send transactions with full-RBF opt-in enabled (RPC only, de‐
537 fault: 1)
538 ZeroMQ notification options:
540 -zmqpubhashblock=<address>
542 Enable publish hash block in <address>
544 -zmqpubhashblockhwm=<n>
546 Set publish hash block outbound message high water mark (de‐
548 fault: 1000)
549 -zmqpubhashtx=<address>
551 Enable publish hash transaction in <address>
553 -zmqpubhashtxhwm=<n>
555 Set publish hash transaction outbound message high water mark
557 (default: 1000)
558 -zmqpubrawblock=<address>
560 Enable publish raw block in <address>
562 -zmqpubrawblockhwm=<n>
564 Set publish raw block outbound message high water mark (default:
566 1000)
567 -zmqpubrawtx=<address>
569 Enable publish raw transaction in <address>
571 -zmqpubrawtxhwm=<n>
573 Set publish raw transaction outbound message high water mark
575 (default: 1000)
576 -zmqpubsequence=<address>
578 Enable publish hash block and tx sequence in <address>
580 -zmqpubsequencehwm=<n>
582 Set publish hash sequence message high water mark (default:
584 1000)
585 Debugging/Testing options:
587 -debug=<category>
589 Output debug and trace logging (default: -nodebug, supplying
591 <category> is optional). If <category> is not supplied or if
592 <category> = 1, output all debug and trace logging. <category>
593 can be: addrman, bench, blockstorage, cmpctblock, coindb, esti‐
594 matefee, http, i2p, ipc, leveldb, libevent, mempool, mempoolrej,
595 net, proxy, prune, qt, rand, reindex, rpc, selectcoins, tor,
596 util, validation, walletdb, zmq. This option can be specified
597 multiple times to output multiple categories.
598 -debugexclude=<category>
600 Exclude debug and trace logging for a category. Can be used in
602 conjunction with -debug=1 to output debug and trace logging for
603 all categories except the specified category. This option can be
604 specified multiple times to exclude multiple categories.
605 -help-debug
607 Print help message with debugging options and exit
609 -logips
611 Include IP addresses in debug output (default: 0)
613 -logsourcelocations
615 Prepend debug output with name of the originating source loca‐
617 tion (source file, line number and function name) (default: 0)
618 -logthreadnames
620 Prepend debug output with name of the originating thread (only
622 available on platforms supporting thread_local) (default: 0)
623 -logtimestamps
625 Prepend debug output with timestamp (default: 1)
627 -maxtxfee=<amt>
629 Maximum total fees (in BTC) to use in a single wallet transac‐
631 tion; setting this too low may abort large transactions (de‐
632 fault: 0.10)
633 -printtoconsole
635 Send trace/debug info to console (default: 1 when no -daemon. To
637 disable logging to file, set -nodebuglogfile)
638 -shrinkdebugfile
640 Shrink debug.log file on client startup (default: 1 when no -de‐
642 bug)
643 -uacomment=<cmt>
645 Append comment to the user agent string
647 Chain selection options:
649 -chain=<chain>
651 Use the chain <chain> (default: main). Allowed values: main,
653 test, signet, regtest
654 -signet
656 Use the signet chain. Equivalent to -chain=signet. Note that the
658 network is defined by the -signetchallenge parameter
659 -signetchallenge
661 Blocks must satisfy the given script to be considered valid
663 (only for signet networks; defaults to the global default signet
664 test network challenge)
665 -signetseednode
667 Specify a seed node for the signet network, in the host‐
669 name[:port] format, e.g. sig.net:1234 (may be used multiple
670 times to specify multiple seed nodes; defaults to the global de‐
671 fault signet test network seed node(s))
672 -testnet
674 Use the test chain. Equivalent to -chain=test.
676 Node relay options:
678 -bytespersigop
680 Equivalent bytes per sigop in transactions for relay and mining
682 (default: 20)
683 -datacarrier
685 Relay and mine data carrier transactions (default: 1)
687 -datacarriersize
689 Maximum size of data in data carrier transactions we relay and
691 mine (default: 83)
692 -mempoolfullrbf
694 Accept transaction replace-by-fee without requiring replaceabil‐
696 ity signaling (default: 0)
697 -minrelaytxfee=<amt>
699 Fees (in BTC/kvB) smaller than this are considered zero fee for
701 relaying, mining and transaction creation (default: 0.00001)
702 -permitbaremultisig
704 Relay non-P2SH multisig (default: 1)
706 -whitelistforcerelay
708 Add 'forcerelay' permission to whitelisted inbound peers with
710 default permissions. This will relay transactions even if the
711 transactions were already in the mempool. (default: 0)
712 -whitelistrelay
714 Add 'relay' permission to whitelisted inbound peers with default
716 permissions. This will accept relayed transactions even when not
717 relaying transactions (default: 1)
718 Block creation options:
720 -blockmaxweight=<n>
722 Set maximum BIP141 block weight (default: 3996000)
724 -blockmintxfee=<amt>
726 Set lowest fee rate (in BTC/kvB) for transactions to be included
728 in block creation. (default: 0.00001)
729 RPC server options:
731 -rest
733 Accept public REST requests (default: 0)
735 -rpcallowip=<ip>
737 Allow JSON-RPC connections from specified source. Valid for <ip>
739 are a single IP (e.g. 1.2.3.4), a network/netmask (e.g.
740 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
741 option can be specified multiple times
742 -rpcauth=<userpw>
744 Username and HMAC-SHA-256 hashed password for JSON-RPC connec‐
746 tions. The field <userpw> comes in the format: <USER‐
747 NAME>:<SALT>$<HASH>. A canonical python script is included in
748 share/rpcauth. The client then connects normally using the rp‐
749 cuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
750 option can be specified multiple times
751 -rpcbind=<addr>[:port]
753 Bind to given address to listen for JSON-RPC connections. Do not
755 expose the RPC server to untrusted networks such as the public
756 internet! This option is ignored unless -rpcallowip is also
757 passed. Port is optional and overrides -rpcport. Use [host]:port
758 notation for IPv6. This option can be specified multiple times
759 (default: 127.0.0.1 and ::1 i.e., localhost)
760 -rpccookiefile=<loc>
762 Location of the auth cookie. Relative paths will be prefixed by
764 a net-specific datadir location. (default: data dir)
765 -rpcpassword=<pw>
767 Password for JSON-RPC connections
769 -rpcport=<port>
771 Listen for JSON-RPC connections on <port> (default: 8332, test‐
773 net: 18332, signet: 38332, regtest: 18443)
774 -rpcserialversion
776 Sets the serialization of raw transaction or block hex returned
778 in non-verbose mode, non-segwit(0) or segwit(1) (default: 1)
779 -rpcthreads=<n>
781 Set the number of threads to service RPC calls (default: 4)
783 -rpcuser=<user>
785 Username for JSON-RPC connections
787 -rpcwhitelist=<whitelist>
789 Set a whitelist to filter incoming RPC calls for a specific
791 user. The field <whitelist> comes in the format: <USERNAME>:<rpc
792 1>,<rpc 2>,...,<rpc n>. If multiple whitelists are set for a
793 given user, they are set-intersected. See -rpcwhitelistdefault
794 documentation for information on default whitelist behavior.
795 -rpcwhitelistdefault
797 Sets default behavior for rpc whitelisting. Unless rpcwhitelist‐
799 default is set to 0, if any -rpcwhitelist is set, the rpc server
800 acts as if all rpc users are subject to empty-unless-other‐
801 wise-specified whitelists. If rpcwhitelistdefault is set to 1
802 and no -rpcwhitelist is set, rpc server acts as if all rpc users
803 are subject to empty whitelists.
804 -server
806 Accept command line and JSON-RPC commands
808
810 Copyright (C) 2009-2022 The Bitcoin Core developers
811 Please contribute if you find Bitcoin Core useful. Visit <https://bit‐
813 coincore.org/> for further information about the software. The source
814 code is available from <https://github.com/bitcoin/bitcoin>.
815 This is experimental software. Distributed under the MIT software li‐
817 cense, see the accompanying file COPYING or <https://opensource.org/li‐
818 censes/MIT>
819bitcoind v24.0.1 December 2022 BITCOIND(1)