Bitcoin ABC 0.32.4
P2P Digital Currency
init.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-2018 The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#if defined(HAVE_CONFIG_H)
7#include <config/bitcoin-config.h>
8#endif
9
10#include <init.h>
11
12#include <kernel/checks.h>
14
15#include <addrman.h>
16#include <avalanche/avalanche.h>
17#include <avalanche/processor.h>
18#include <avalanche/proof.h> // For AVALANCHE_LEGACY_PROOF_DEFAULT
20#include <avalanche/voterecord.h> // For AVALANCHE_VOTE_STALE_*
21#include <banman.h>
22#include <blockfilter.h>
23#include <chain.h>
24#include <chainparams.h>
25#include <chainparamsbase.h>
26#include <common/args.h>
27#include <config.h>
28#include <consensus/amount.h>
29#include <currencyunit.h>
30#include <flatfile.h>
31#include <hash.h>
32#include <httprpc.h>
33#include <httpserver.h>
36#include <index/txindex.h>
37#include <init/common.h>
38#include <interfaces/chain.h>
39#include <interfaces/node.h>
40#include <kernel/caches.h>
41#include <mapport.h>
42#include <mempool_args.h>
43#include <net.h>
44#include <net_permissions.h>
45#include <net_processing.h>
46#include <netbase.h>
48#include <node/blockstorage.h>
49#include <node/caches.h>
50#include <node/chainstate.h>
52#include <node/context.h>
55#include <node/miner.h>
56#include <node/peerman_args.h>
57#include <node/ui_interface.h>
58#include <policy/block/rtt.h>
59#include <policy/policy.h>
60#include <policy/settings.h>
61#include <rpc/blockchain.h>
62#include <rpc/register.h>
63#include <rpc/server.h>
64#include <rpc/util.h>
65#include <scheduler.h>
66#include <script/scriptcache.h>
67#include <script/sigcache.h>
68#include <script/standard.h>
69#include <shutdown.h>
70#include <sync.h>
71#include <timedata.h>
72#include <torcontrol.h>
73#include <txdb.h>
74#include <txmempool.h>
75#include <util/asmap.h>
76#include <util/chaintype.h>
77#include <util/check.h>
78#include <util/fs.h>
79#include <util/fs_helpers.h>
80#include <util/moneystr.h>
81#include <util/string.h>
82#include <util/syserror.h>
83#include <util/thread.h>
84#include <util/threadnames.h>
85#include <util/translation.h>
86#include <validation.h>
87#include <validationinterface.h>
88#include <walletinitinterface.h>
89
90#include <boost/signals2/signal.hpp>
91
92#if ENABLE_CHRONIK
93#include <chronik-cpp/chronik.h>
94#endif
95
96#if ENABLE_ZMQ
99#include <zmq/zmqrpc.h>
100#endif
101
102#ifndef WIN32
103#include <cerrno>
104#include <csignal>
105#include <sys/stat.h>
106#endif
107#include <algorithm>
108#include <condition_variable>
109#include <cstdint>
110#include <cstdio>
111#include <fstream>
112#include <functional>
113#include <set>
114#include <string>
115#include <thread>
116#include <vector>
117
120
125using node::fReindex;
133
134static const bool DEFAULT_PROXYRANDOMIZE = true;
135static const bool DEFAULT_REST_ENABLE = false;
136static constexpr bool DEFAULT_CHRONIK = false;
137static constexpr bool DEFAULT_USEASHADDR = true;
138
139#ifdef WIN32
140// Win32 LevelDB doesn't use filedescriptors, and the ones used for accessing
141// block files don't count towards the fd_set size limit anyway.
142#define MIN_CORE_FILEDESCRIPTORS 0
143#else
144#define MIN_CORE_FILEDESCRIPTORS 150
145#endif
146
147static const char *DEFAULT_ASMAP_FILENAME = "ip_asn.map";
148
149static const std::string HEADERS_TIME_FILE_NAME{"headerstime.dat"};
150
154static const char *BITCOIN_PID_FILENAME = "bitcoind.pid";
155
156static fs::path GetPidFile(const ArgsManager &args) {
157 return AbsPathForConfigVal(args,
158 args.GetPathArg("-pid", BITCOIN_PID_FILENAME));
159}
160
161[[nodiscard]] static bool CreatePidFile(const ArgsManager &args) {
162 std::ofstream file{GetPidFile(args)};
163 if (file) {
164#ifdef WIN32
165 tfm::format(file, "%d\n", GetCurrentProcessId());
166#else
167 tfm::format(file, "%d\n", getpid());
168#endif
169 return true;
170 } else {
171 return InitError(strprintf(_("Unable to create the PID file '%s': %s"),
173 SysErrorString(errno)));
174 }
175}
176
178//
179// Shutdown
180//
181
182//
183// Thread management and startup/shutdown:
184//
185// The network-processing threads are all part of a thread group created by
186// AppInit() or the Qt main() function.
187//
188// A clean exit happens when StartShutdown() or the SIGTERM signal handler sets
189// fRequestShutdown, which makes main thread's WaitForShutdown() interrupts the
190// thread group.
191// And then, WaitForShutdown() makes all other on-going threads in the thread
192// group join the main thread.
193// Shutdown() is then called to clean up database connections, and stop other
194// threads that should only be stopped after the main network-processing threads
195// have exited.
196//
197// Shutdown for Qt is very similar, only it uses a QTimer to detect
198// ShutdownRequested() getting set, and then does the normal Qt shutdown thing.
199//
200
204 InterruptRPC();
208 if (node.avalanche) {
209 // Avalanche needs to be stopped before we interrupt the thread group as
210 // the scheduler will stop working then.
211 node.avalanche->stopEventLoop();
212 }
213 if (node.connman) {
214 node.connman->Interrupt();
215 }
216 if (g_txindex) {
217 g_txindex->Interrupt();
218 }
219 ForEachBlockFilterIndex([](BlockFilterIndex &index) { index.Interrupt(); });
220 if (g_coin_stats_index) {
221 g_coin_stats_index->Interrupt();
222 }
223}
224
226 static Mutex g_shutdown_mutex;
227 TRY_LOCK(g_shutdown_mutex, lock_shutdown);
228 if (!lock_shutdown) {
229 return;
230 }
231 LogPrintf("%s: In progress...\n", __func__);
232 Assert(node.args);
233
238 util::ThreadRename("shutoff");
239 if (node.mempool) {
240 node.mempool->AddTransactionsUpdated(1);
241 }
242
243 StopHTTPRPC();
244 StopREST();
245 StopRPC();
247 for (const auto &client : node.chain_clients) {
248 client->flush();
249 }
250 StopMapPort();
251
252 // Because avalanche and the network depend on each other, it is important
253 // to shut them down in this order:
254 // 1. Stop avalanche event loop.
255 // 2. Shutdown network processing.
256 // 3. Destroy avalanche::Processor.
257 // 4. Destroy CConnman
258 if (node.avalanche) {
259 node.avalanche->stopEventLoop();
260 }
261
262 // Because these depend on each-other, we make sure that neither can be
263 // using the other before destroying them.
264 if (node.peerman) {
265 UnregisterValidationInterface(node.peerman.get());
266 }
267 if (node.connman) {
268 node.connman->Stop();
269 }
270
272
273 // After everything has been shut down, but before things get flushed, stop
274 // the CScheduler/checkqueue, scheduler and load block thread.
275 if (node.scheduler) {
276 node.scheduler->stop();
277 }
278 if (node.chainman && node.chainman->m_thread_load.joinable()) {
279 node.chainman->m_thread_load.join();
280 }
282
283 // After the threads that potentially access these pointers have been
284 // stopped, destruct and reset all to nullptr.
285 node.peerman.reset();
286
287 // Destroy various global instances
288 node.avalanche.reset();
289 node.connman.reset();
290 node.banman.reset();
291 node.addrman.reset();
292
293 if (node.mempool && node.mempool->GetLoadTried() &&
294 ShouldPersistMempool(*node.args)) {
295 DumpMempool(*node.mempool, MempoolPath(*node.args));
296 }
297
298 // FlushStateToDisk generates a ChainStateFlushed callback, which we should
299 // avoid missing
300 if (node.chainman) {
301 LOCK(cs_main);
302 for (Chainstate *chainstate : node.chainman->GetAll()) {
303 if (chainstate->CanFlushToDisk()) {
304 chainstate->ForceFlushStateToDisk();
305 }
306 }
307 }
308
309 // After there are no more peers/RPC left to give us new data which may
310 // generate CValidationInterface callbacks, flush them...
312
313#if ENABLE_CHRONIK
314 if (node.args->GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
315 chronik::Stop();
316 }
317#endif
318
319 // Stop and delete all indexes only after flushing background callbacks.
320 if (g_txindex) {
321 g_txindex->Stop();
322 g_txindex.reset();
323 }
324 if (g_coin_stats_index) {
325 g_coin_stats_index->Stop();
326 g_coin_stats_index.reset();
327 }
328 ForEachBlockFilterIndex([](BlockFilterIndex &index) { index.Stop(); });
330
331 // Any future callbacks will be dropped. This should absolutely be safe - if
332 // missing a callback results in an unrecoverable situation, unclean
333 // shutdown would too. The only reason to do the above flushes is to let the
334 // wallet catch up with our current chain to avoid any strange pruning edge
335 // cases and make next startup faster by avoiding rescan.
336
337 if (node.chainman) {
338 LOCK(cs_main);
339 for (Chainstate *chainstate : node.chainman->GetAll()) {
340 if (chainstate->CanFlushToDisk()) {
341 chainstate->ForceFlushStateToDisk();
342 chainstate->ResetCoinsViews();
343 }
344 }
345
346 node.chainman->DumpRecentHeadersTime(node.chainman->m_options.datadir /
348 }
349 for (const auto &client : node.chain_clients) {
350 client->stop();
351 }
352
353#if ENABLE_ZMQ
357 }
358#endif
359
360 node.chain_clients.clear();
363 node.kernel.reset();
364 node.mempool.reset();
365 node.chainman.reset();
366 node.scheduler.reset();
367
368 try {
369 if (!fs::remove(GetPidFile(*node.args))) {
370 LogPrintf("%s: Unable to remove PID file: File does not exist\n",
371 __func__);
372 }
373 } catch (const fs::filesystem_error &e) {
374 LogPrintf("%s: Unable to remove PID file: %s\n", __func__,
376 }
377
378 LogPrintf("%s: done\n", __func__);
379}
380
386#ifndef WIN32
387static void HandleSIGTERM(int) {
389}
390
391static void HandleSIGHUP(int) {
392 LogInstance().m_reopen_file = true;
393}
394#else
395static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType) {
397 Sleep(INFINITE);
398 return true;
399}
400#endif
401
402#ifndef WIN32
403static void registerSignalHandler(int signal, void (*handler)(int)) {
404 struct sigaction sa;
405 sa.sa_handler = handler;
406 sigemptyset(&sa.sa_mask);
407 sa.sa_flags = 0;
408 sigaction(signal, &sa, NULL);
409}
410#endif
411
412static boost::signals2::connection rpc_notify_block_change_connection;
413static void OnRPCStarted() {
414 rpc_notify_block_change_connection = uiInterface.NotifyBlockTip_connect(
415 std::bind(RPCNotifyBlockChange, std::placeholders::_2));
416}
417
418static void OnRPCStopped() {
420 RPCNotifyBlockChange(nullptr);
421 g_best_block_cv.notify_all();
422 LogPrint(BCLog::RPC, "RPC stopped.\n");
423}
424
426 assert(!node.args);
427 node.args = &gArgs;
428 ArgsManager &argsman = *node.args;
429
430 SetupHelpOptions(argsman);
432 // server-only for now
433 argsman.AddArg("-help-debug",
434 "Print help message with debugging options and exit", false,
436
437 init::AddLoggingArgs(argsman);
438
439 const auto defaultBaseParams = CreateBaseChainParams(ChainType::MAIN);
440 const auto testnetBaseParams = CreateBaseChainParams(ChainType::TESTNET);
441 const auto regtestBaseParams = CreateBaseChainParams(ChainType::REGTEST);
442 const auto defaultChainParams = CreateChainParams(argsman, ChainType::MAIN);
443 const auto testnetChainParams =
445 const auto regtestChainParams =
447
448 // Hidden Options
449 std::vector<std::string> hidden_args = {
450 "-dbcrashratio",
451 "-forcecompactdb",
452 "-maxaddrtosend",
453 "-parkdeepreorg",
454 "-automaticunparking",
455 "-replayprotectionactivationtime",
456 "-enableminerfund",
457 "-chronikallowpause",
458 "-chronikcors",
459 // GUI args. These will be overwritten by SetupUIArgs for the GUI
460 "-allowselfsignedrootcertificates",
461 "-choosedatadir",
462 "-lang=<lang>",
463 "-min",
464 "-resetguisettings",
465 "-rootcertificates=<file>",
466 "-splash",
467 "-uiplatform",
468 // TODO remove after the May 2026 upgrade
469 "-obolenskyactivationtime",
470 };
471
472 // Set all of the args and their help
473 // When adding new options to the categories, please keep and ensure
474 // alphabetical ordering. Do not translate _(...) -help-debug options, Many
475 // technical terms, and only a very small audience, so is unnecessary stress
476 // to translators.
477 argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY,
479#if defined(HAVE_SYSTEM)
480 argsman.AddArg(
481 "-alertnotify=<cmd>",
482 "Execute command when a relevant alert is received or we see "
483 "a really long fork (%s in cmd is replaced by message)",
485#endif
486 argsman.AddArg(
487 "-assumevalid=<hex>",
488 strprintf(
489 "If this block is in the chain assume that it and its ancestors "
490 "are valid and potentially skip their script verification (0 to "
491 "verify all, default: %s, testnet: %s)",
492 defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(),
493 testnetChainParams->GetConsensus().defaultAssumeValid.GetHex()),
495 argsman.AddArg("-blocksdir=<dir>",
496 "Specify directory to hold blocks subdirectory for *.dat "
497 "files (default: <datadir>)",
499 argsman.AddArg("-fastprune",
500 "Use smaller block files and lower minimum prune height for "
501 "testing purposes",
504#if defined(HAVE_SYSTEM)
505 argsman.AddArg("-blocknotify=<cmd>",
506 "Execute command when the best block changes (%s in cmd is "
507 "replaced by block hash)",
509#endif
510 argsman.AddArg("-blockreconstructionextratxn=<n>",
511 strprintf("Extra transactions to keep in memory for compact "
512 "block reconstructions (default: %u)",
515 argsman.AddArg(
516 "-blocksonly",
517 strprintf("Whether to reject transactions from network peers. "
518 "Disables automatic broadcast and rebroadcast of "
519 "transactions, unless the source peer has the "
520 "'forcerelay' permission. RPC transactions are"
521 " not affected. (default: %u)",
524 argsman.AddArg("-coinstatsindex",
525 strprintf("Maintain coinstats index used by the "
526 "gettxoutsetinfo RPC (default: %u)",
529 argsman.AddArg(
530 "-conf=<file>",
531 strprintf("Specify path to read-only configuration file. Relative "
532 "paths will be prefixed by datadir location. (default: %s)",
535 argsman.AddArg("-datadir=<dir>", "Specify data directory",
537 argsman.AddArg(
538 "-dbbatchsize",
539 strprintf("Maximum database write batch size in bytes (default: %u)",
543 argsman.AddArg("-dbcache=<n>",
544 strprintf("Maximum database cache size <n> MiB (minimum %d, "
545 "default: %d). Make sure you have enough RAM. In "
546 "addition, unused memory allocated to the mempool "
547 "is shared with this cache (see -maxmempool).",
548 MIN_DB_CACHE >> 20, DEFAULT_DB_CACHE >> 20),
550 argsman.AddArg(
551 "-includeconf=<file>",
552 "Specify additional configuration file, relative to the -datadir path "
553 "(only useable from configuration file, not command line)",
555 argsman.AddArg("-allowignoredconf",
556 strprintf("For backwards compatibility, treat an unused %s "
557 "file in the datadir as a warning, not an error.",
560 argsman.AddArg("-loadblock=<file>",
561 "Imports blocks from external file on startup",
563 argsman.AddArg("-maxmempool=<n>",
564 strprintf("Keep the transaction memory pool below <n> "
565 "megabytes (default: %u)",
568 argsman.AddArg("-maxorphantx=<n>",
569 strprintf("Keep at most <n> unconnectable transactions in "
570 "memory (default: %u)",
573 argsman.AddArg("-mempoolexpiry=<n>",
574 strprintf("Do not keep transactions in the mempool longer "
575 "than <n> hours (default: %u)",
578 argsman.AddArg(
579 "-minimumchainwork=<hex>",
580 strprintf(
581 "Minimum work assumed to exist on a valid chain in hex "
582 "(default: %s, testnet: %s)",
583 defaultChainParams->GetConsensus().nMinimumChainWork.GetHex(),
584 testnetChainParams->GetConsensus().nMinimumChainWork.GetHex()),
587 argsman.AddArg(
588 "-par=<n>",
589 strprintf("Set the number of script verification threads (%u to %d, 0 "
590 "= auto, <0 = leave that many cores free, default: %d)",
594 argsman.AddArg("-persistmempool",
595 strprintf("Whether to save the mempool on shutdown and load "
596 "on restart (default: %u)",
599 argsman.AddArg(
600 "-persistrecentheaderstime",
601 strprintf(
602 "Whether the node stores the recent headers reception time to a "
603 "file and load it upon startup. This is intended for mining nodes "
604 "to overestimate the real time target upon restart (default: %u)",
607 argsman.AddArg(
608 "-pid=<file>",
609 strprintf("Specify pid file. Relative paths will be prefixed "
610 "by a net-specific datadir location. (default: %s)",
613 argsman.AddArg(
614 "-prune=<n>",
615 strprintf("Reduce storage requirements by enabling pruning (deleting) "
616 "of old blocks. This allows the pruneblockchain RPC to be "
617 "called to delete specific blocks and enables automatic "
618 "pruning of old blocks if a target size in MiB is provided. "
619 "This mode is incompatible with -txindex and -rescan. "
620 "Warning: Reverting this setting requires re-downloading the "
621 "entire blockchain. (default: 0 = disable pruning blocks, "
622 "1 = allow manual pruning via RPC, >=%u = automatically "
623 "prune block files to stay under the specified target size "
624 "in MiB)",
625 MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024),
627 argsman.AddArg(
628 "-reindex-chainstate",
629 "Rebuild chain state from the currently indexed blocks. When "
630 "in pruning mode or if blocks on disk might be corrupted, use "
631 "full -reindex instead.",
633 argsman.AddArg(
634 "-reindex",
635 "Rebuild chain state and block index from the blk*.dat files on disk."
636 " This will also rebuild active optional indexes.",
638 argsman.AddArg(
639 "-settings=<file>",
640 strprintf(
641 "Specify path to dynamic settings data file. Can be disabled with "
642 "-nosettings. File is written at runtime and not meant to be "
643 "edited by users (use %s instead for custom settings). Relative "
644 "paths will be prefixed by datadir location. (default: %s)",
647#if HAVE_SYSTEM
648 argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.",
650#endif
651#ifndef WIN32
652 argsman.AddArg(
653 "-sysperms",
654 "Create new files with system default permissions, instead of umask "
655 "077 (only effective with disabled wallet functionality)",
657#else
658 hidden_args.emplace_back("-sysperms");
659#endif
660 argsman.AddArg("-txindex",
661 strprintf("Maintain a full transaction index, used by the "
662 "getrawtransaction rpc call (default: %d)",
665#if ENABLE_CHRONIK
666 argsman.AddArg(
667 "-chronik",
668 strprintf("Enable the Chronik indexer, which can be read via a "
669 "dedicated HTTP/Protobuf interface (default: %d)",
672 argsman.AddArg(
673 "-chronikbind=<addr>[:port]",
674 strprintf(
675 "Bind the Chronik indexer to the given address to listen for "
676 "HTTP/Protobuf connections to access the index. Unlike the "
677 "JSON-RPC, it's ok to have this publicly exposed on the internet. "
678 "This option can be specified multiple times (default: %s; default "
679 "port: %u, testnet: %u, regtest: %u)",
680 Join(chronik::DEFAULT_BINDS, ", "),
681 defaultBaseParams->ChronikPort(), testnetBaseParams->ChronikPort(),
682 regtestBaseParams->ChronikPort()),
686 argsman.AddArg("-chroniktokenindex",
687 "Enable token indexing in Chronik (default: 1)",
689 argsman.AddArg("-chroniklokadidindex",
690 "Enable LOKAD ID indexing in Chronik (default: 1)",
692 argsman.AddArg("-chronikreindex",
693 "Reindex the Chronik indexer from genesis, but leave the "
694 "other indexes untouched",
696 argsman.AddArg(
697 "-chroniktxnumcachebuckets",
698 strprintf(
699 "Tuning param of the TxNumCache, specifies how many buckets "
700 "to use on the belt. Caution against setting this too high, "
701 "it may slow down indexing. Set to 0 to disable. (default: %d)",
702 chronik::DEFAULT_TX_NUM_CACHE_BUCKETS),
705 argsman.AddArg(
706 "-chroniktxnumcachebucketsize",
707 strprintf(
708 "Tuning param of the TxNumCache, specifies the size of each bucket "
709 "on the belt. Unlike the number of buckets, this may be increased "
710 "without much danger of slowing the indexer down. The total cache "
711 "size will be `num_buckets * bucket_size * 40B`, so by default the "
712 "cache will require %dkB of memory. (default: %d)",
713 chronik::DEFAULT_TX_NUM_CACHE_BUCKETS *
714 chronik::DEFAULT_TX_NUM_CACHE_BUCKET_SIZE * 40 / 1000,
715 chronik::DEFAULT_TX_NUM_CACHE_BUCKET_SIZE),
718 argsman.AddArg("-chronikperfstats",
719 "Output some performance statistics (e.g. num cache hits, "
720 "seconds spent) into a <datadir>/perf folder. (default: 0)",
722 argsman.AddArg("-chronikscripthashindex",
723 "Enable the scripthash index for the Chronik indexer "
724 "(default: 1 if chronikelectrumbind is set, 0 otherwise) ",
726 argsman.AddArg(
727 "-chronikelectrumbind=<addr>[:port][:t|s|w|y]",
728 strprintf(
729 "Bind the Chronik Electrum interface to the given "
730 "address:port:protocol. If not set, the Electrum interface will "
731 "not start. This option can be specified multiple times. The "
732 "protocol is selected by a single letter, where 't' means TCP, 's' "
733 "means TLS, 'w' means WS and 'y' means WSS. If TLS and/or WSS is "
734 "selected, the certificate chain and private key must both be "
735 "passed (see -chronikelectrumcert and -chronikelectrumprivkey "
736 "(default: disabled; default port: %u, testnet: %u, regtest: %u; "
737 "default protocol: TLS)",
738 defaultBaseParams->ChronikElectrumPort(),
739 testnetBaseParams->ChronikElectrumPort(),
740 regtestBaseParams->ChronikElectrumPort()),
744 argsman.AddArg(
745 "-chronikelectrumcert",
746 "Path to the certificate file to be used by the Chronik Electrum "
747 "server when the TLS protocol is selected. The file should contain "
748 "the whole certificate chain (typically a .pem file). If used the "
749 "-chronikelectrumprivkey must be set as well.",
753 argsman.AddArg(
754 "-chronikelectrumprivkey",
755 "Path to the private key file to be used by the Chronik Electrum "
756 "server when the TLS protocol is selected. If used the "
757 "-chronikelectrumcert must be set as well.",
761 argsman.AddArg(
762 "-chronikelectrumurl",
763 "The URL to advertise to the Electrum peers. This needs to be set to "
764 "the server public URL to instruct the other Electrum peers that they "
765 "don't have to drop the connection. See the 'hosts' key in "
766 "https://electrum-cash-protocol.readthedocs.io/en/latest/"
767 "protocol-methods.html#server.features (default: 127.0.0.1).",
771 argsman.AddArg(
772 "-chronikelectrummaxhistory",
773 strprintf("Largest tx history we are willing to serve. (default: %u)",
774 chronik::DEFAULT_ELECTRUM_MAX_HISTORY),
777 argsman.AddArg(
778 "-chronikelectrumdonationaddress",
779 strprintf(
780 "The server donation address. No checks are done on the server "
781 "side to ensure this is a valid eCash address, it is just relayed "
782 "to clients verbatim as a text string (%u characters maximum).",
783 chronik::MAX_LENGTH_DONATION_ADDRESS),
786 argsman.AddArg(
787 "-chronikelectrumpeersvalidationinterval",
788 strprintf(
789 "The peers submitted via the Chronik Electrum server.add_peer "
790 "endpoint are periodically checked for validity and are only "
791 "returned after they passed the validation. This option controls "
792 "the interval duration between successive peers validation "
793 "processes in seconds (default: %u). Setting this value to 0 "
794 "disables the peer validation completely.",
795 std::chrono::duration_cast<std::chrono::seconds>(
796 chronik::DEFAULT_ELECTRUM_PEER_VALIDATION_INTERVAL)
797 .count()),
800#endif
801 argsman.AddArg(
802 "-blockfilterindex=<type>",
803 strprintf("Maintain an index of compact filters by block "
804 "(default: %s, values: %s).",
806 " If <type> is not supplied or if <type> = 1, indexes for "
807 "all known types are enabled.",
809 argsman.AddArg(
810 "-usecashaddr",
811 strprintf("Use Cash Address for destination encoding instead of legacy "
812 "base58 addresses (default: %d)",
815
816 argsman.AddArg(
817 "-addnode=<ip>",
818 "Add a node to connect to and attempt to keep the connection "
819 "open (see the `addnode` RPC command help for more info)",
822 argsman.AddArg("-asmap=<file>",
823 strprintf("Specify asn mapping used for bucketing of the "
824 "peers (default: %s). Relative paths will be "
825 "prefixed by the net-specific datadir location.",
828 argsman.AddArg("-bantime=<n>",
829 strprintf("Default duration (in seconds) of manually "
830 "configured bans (default: %u)",
833 argsman.AddArg(
834 "-bind=<addr>[:<port>][=onion]",
835 strprintf("Bind to given address and always listen on it (default: "
836 "0.0.0.0). Use [host]:port notation for IPv6. Append =onion "
837 "to tag any incoming connections to that address and port as "
838 "incoming Tor connections (default: 127.0.0.1:%u=onion, "
839 "testnet: 127.0.0.1:%u=onion, regtest: 127.0.0.1:%u=onion)",
840 defaultBaseParams->OnionServiceTargetPort(),
841 testnetBaseParams->OnionServiceTargetPort(),
842 regtestBaseParams->OnionServiceTargetPort()),
845 argsman.AddArg(
846 "-connect=<ip>",
847 "Connect only to the specified node(s); -connect=0 disables automatic "
848 "connections (the rules for this peer are the same as for -addnode)",
851 argsman.AddArg(
852 "-discover",
853 "Discover own IP addresses (default: 1 when listening and no "
854 "-externalip or -proxy)",
856 argsman.AddArg("-dns",
857 strprintf("Allow DNS lookups for -addnode, -seednode and "
858 "-connect (default: %d)",
861 argsman.AddArg(
862 "-dnsseed",
863 strprintf(
864 "Query for peer addresses via DNS lookup, if low on addresses "
865 "(default: %u unless -connect used)",
868 argsman.AddArg("-externalip=<ip>", "Specify your own public address",
870 argsman.AddArg(
871 "-fixedseeds",
872 strprintf(
873 "Allow fixed seeds if DNS seeds don't provide peers (default: %u)",
876 argsman.AddArg(
877 "-forcednsseed",
878 strprintf(
879 "Always query for peer addresses via DNS lookup (default: %d)",
882 argsman.AddArg("-overridednsseed",
883 "If set, only use the specified DNS seed when "
884 "querying for peer addresses via DNS lookup.",
886 argsman.AddArg(
887 "-listen",
888 "Accept connections from outside (default: 1 if no -proxy or -connect)",
890 argsman.AddArg(
891 "-listenonion",
892 strprintf("Automatically create Tor onion service (default: %d)",
895 argsman.AddArg(
896 "-maxconnections=<n>",
897 strprintf("Maintain at most <n> connections to peers. The effective "
898 "limit depends on system limitations and might be lower than "
899 "the specified value (default: %u)",
902 argsman.AddArg("-maxreceivebuffer=<n>",
903 strprintf("Maximum per-connection receive buffer, <n>*1000 "
904 "bytes (default: %u)",
907 argsman.AddArg(
908 "-maxsendbuffer=<n>",
909 strprintf(
910 "Maximum per-connection send buffer, <n>*1000 bytes (default: %u)",
913 argsman.AddArg(
914 "-maxtimeadjustment",
915 strprintf("Maximum allowed median peer time offset adjustment. Local "
916 "perspective of time may be influenced by peers forward or "
917 "backward by this amount. (default: %u seconds)",
920 argsman.AddArg("-onion=<ip:port>",
921 strprintf("Use separate SOCKS5 proxy to reach peers via Tor "
922 "onion services (default: %s)",
923 "-proxy"),
925 argsman.AddArg("-i2psam=<ip:port>",
926 "I2P SAM proxy to reach I2P peers and accept I2P "
927 "connections (default: none)",
929 argsman.AddArg(
930 "-i2pacceptincoming",
931 "If set and -i2psam is also set then incoming I2P connections are "
932 "accepted via the SAM proxy. If this is not set but -i2psam is set "
933 "then only outgoing connections will be made to the I2P network. "
934 "Ignored if -i2psam is not set. Listening for incoming I2P connections "
935 "is done through the SAM proxy, not by binding to a local address and "
936 "port (default: 1)",
938
939 argsman.AddArg(
940 "-onlynet=<net>",
941 "Make outgoing connections only through network <net> (" +
942 Join(GetNetworkNames(), ", ") +
943 "). Incoming connections are not affected by this option. This "
944 "option can be specified multiple times to allow multiple "
945 "networks. Warning: if it is used with non-onion networks "
946 "and the -onion or -proxy option is set, then outbound onion "
947 "connections will still be made; use -noonion or -onion=0 to "
948 "disable outbound onion connections in this case",
950 argsman.AddArg("-peerbloomfilters",
951 strprintf("Support filtering of blocks and transaction with "
952 "bloom filters (default: %d)",
955 argsman.AddArg(
956 "-peerblockfilters",
957 strprintf(
958 "Serve compact block filters to peers per BIP 157 (default: %u)",
961 argsman.AddArg("-permitbaremultisig",
962 strprintf("Relay non-P2SH multisig (default: %d)",
965 // TODO: remove the sentence "Nodes not using ... incoming connections."
966 // once the changes from https://github.com/bitcoin/bitcoin/pull/23542 have
967 // become widespread.
968 argsman.AddArg("-port=<port>",
969 strprintf("Listen for connections on <port>. Nodes not "
970 "using the default ports (default: %u, "
971 "testnet: %u, regtest: %u) are unlikely to get "
972 "incoming connections. Not relevant for I2P (see "
973 "doc/i2p.md).",
974 defaultChainParams->GetDefaultPort(),
975 testnetChainParams->GetDefaultPort(),
976 regtestChainParams->GetDefaultPort()),
979 argsman.AddArg("-proxy=<ip:port>", "Connect through SOCKS5 proxy",
982 argsman.AddArg(
983 "-proxyrandomize",
984 strprintf("Randomize credentials for every proxy connection. "
985 "This enables Tor stream isolation (default: %d)",
988 argsman.AddArg(
989 "-seednode=<ip>",
990 "Connect to a node to retrieve peer addresses, and disconnect",
992 argsman.AddArg(
993 "-networkactive",
994 "Enable all P2P network activity (default: 1). Can be changed "
995 "by the setnetworkactive RPC command",
997 argsman.AddArg("-timeout=<n>",
998 strprintf("Specify connection timeout in milliseconds "
999 "(minimum: 1, default: %d)",
1002 argsman.AddArg(
1003 "-peertimeout=<n>",
1004 strprintf("Specify p2p connection timeout in seconds. This option "
1005 "determines the amount of time a peer may be inactive before "
1006 "the connection to it is dropped. (minimum: 1, default: %d)",
1009 argsman.AddArg(
1010 "-torcontrol=<ip>:<port>",
1011 strprintf(
1012 "Tor control port to use if onion listening enabled (default: %s)",
1015 argsman.AddArg("-torpassword=<pass>",
1016 "Tor control port password (default: empty)",
1019#ifdef USE_UPNP
1020#if USE_UPNP
1021 argsman.AddArg("-upnp",
1022 "Use UPnP to map the listening port (default: 1 when "
1023 "listening and no -proxy)",
1025#else
1026 argsman.AddArg(
1027 "-upnp",
1028 strprintf("Use UPnP to map the listening port (default: %u)", 0),
1030#endif
1031#else
1032 hidden_args.emplace_back("-upnp");
1033#endif
1034#ifdef USE_NATPMP
1035 argsman.AddArg(
1036 "-natpmp",
1037 strprintf("Use NAT-PMP to map the listening port (default: %s)",
1038 DEFAULT_NATPMP ? "1 when listening and no -proxy" : "0"),
1040#else
1041 hidden_args.emplace_back("-natpmp");
1042#endif // USE_NATPMP
1043 argsman.AddArg(
1044 "-whitebind=<[permissions@]addr>",
1045 "Bind to the given address and add permission flags to the peers "
1046 "connecting to it."
1047 "Use [host]:port notation for IPv6. Allowed permissions: " +
1048 Join(NET_PERMISSIONS_DOC, ", ") +
1049 ". "
1050 "Specify multiple permissions separated by commas (default: "
1051 "download,noban,mempool,relay). Can be specified multiple times.",
1053
1054 argsman.AddArg("-whitelist=<[permissions@]IP address or network>",
1055 "Add permission flags to the peers using the given "
1056 "IP address (e.g. 1.2.3.4) or CIDR-notated network "
1057 "(e.g. 1.2.3.0/24). "
1058 "Uses the same permissions as -whitebind. "
1059 "Additional flags \"in\" and \"out\" control whether "
1060 "permissions apply to incoming connections and/or manual "
1061 "(default: incoming only). "
1062 "Can be specified multiple times.",
1064 argsman.AddArg(
1065 "-maxuploadtarget=<n>",
1066 strprintf("Tries to keep outbound traffic under the given target (in "
1067 "MiB per 24h). Limit does not apply to peers with 'download' "
1068 "permission. 0 = no limit (default: %d)",
1071
1073
1074#if ENABLE_ZMQ
1075 argsman.AddArg("-zmqpubhashblock=<address>",
1076 "Enable publish hash block in <address>",
1078 argsman.AddArg("-zmqpubhashtx=<address>",
1079 "Enable publish hash transaction in <address>",
1081 argsman.AddArg("-zmqpubrawblock=<address>",
1082 "Enable publish raw block in <address>",
1084 argsman.AddArg("-zmqpubrawtx=<address>",
1085 "Enable publish raw transaction in <address>",
1087 argsman.AddArg("-zmqpubsequence=<address>",
1088 "Enable publish hash block and tx sequence in <address>",
1090 argsman.AddArg(
1091 "-zmqpubhashblockhwm=<n>",
1092 strprintf("Set publish hash block outbound message high water "
1093 "mark (default: %d)",
1096 argsman.AddArg(
1097 "-zmqpubhashtxhwm=<n>",
1098 strprintf("Set publish hash transaction outbound message high "
1099 "water mark (default: %d)",
1101 false, OptionsCategory::ZMQ);
1102 argsman.AddArg(
1103 "-zmqpubrawblockhwm=<n>",
1104 strprintf("Set publish raw block outbound message high water "
1105 "mark (default: %d)",
1108 argsman.AddArg(
1109 "-zmqpubrawtxhwm=<n>",
1110 strprintf("Set publish raw transaction outbound message high "
1111 "water mark (default: %d)",
1114 argsman.AddArg("-zmqpubsequencehwm=<n>",
1115 strprintf("Set publish hash sequence message high water mark"
1116 " (default: %d)",
1119#else
1120 hidden_args.emplace_back("-zmqpubhashblock=<address>");
1121 hidden_args.emplace_back("-zmqpubhashtx=<address>");
1122 hidden_args.emplace_back("-zmqpubrawblock=<address>");
1123 hidden_args.emplace_back("-zmqpubrawtx=<address>");
1124 hidden_args.emplace_back("-zmqpubsequence=<n>");
1125 hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
1126 hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
1127 hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
1128 hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
1129 hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
1130#endif
1131
1132 argsman.AddArg(
1133 "-checkblocks=<n>",
1134 strprintf("How many blocks to check at startup (default: %u, 0 = all)",
1138 argsman.AddArg("-checklevel=<n>",
1139 strprintf("How thorough the block verification of "
1140 "-checkblocks is: %s (0-4, default: %u)",
1144 argsman.AddArg("-checkblockindex",
1145 strprintf("Do a consistency check for the block tree, "
1146 "chainstate, and other validation data structures "
1147 "occasionally. (default: %u, regtest: %u)",
1148 defaultChainParams->DefaultConsistencyChecks(),
1149 regtestChainParams->DefaultConsistencyChecks()),
1152 argsman.AddArg("-checkaddrman=<n>",
1153 strprintf("Run addrman consistency checks every <n> "
1154 "operations. Use 0 to disable. (default: %u)",
1158 argsman.AddArg(
1159 "-checkmempool=<n>",
1160 strprintf("Run mempool consistency checks every <n> transactions. Use "
1161 "0 to disable. (default: %u, regtest: %u)",
1162 defaultChainParams->DefaultConsistencyChecks(),
1163 regtestChainParams->DefaultConsistencyChecks()),
1166 argsman.AddArg("-checkpoints",
1167 strprintf("Only accept block chain matching built-in "
1168 "checkpoints (default: %d)",
1172 argsman.AddArg("-deprecatedrpc=<method>",
1173 "Allows deprecated RPC method(s) to be used",
1176 argsman.AddArg(
1177 "-stopafterblockimport",
1178 strprintf("Stop running after importing blocks from disk (default: %d)",
1182 argsman.AddArg("-stopatheight",
1183 strprintf("Stop running after reaching the given height in "
1184 "the main chain (default: %u)",
1188 argsman.AddArg("-addrmantest", "Allows to test address relay on localhost",
1191 argsman.AddArg("-capturemessages", "Capture all P2P messages to disk",
1194 argsman.AddArg("-mocktime=<n>",
1195 "Replace actual time with " + UNIX_EPOCH_TIME +
1196 " (default: 0)",
1199 argsman.AddArg(
1200 "-maxsigcachesize=<n>",
1201 strprintf("Limit size of signature cache to <n> MiB (default: %u)",
1205 argsman.AddArg(
1206 "-maxscriptcachesize=<n>",
1207 strprintf("Limit size of script cache to <n> MiB (default: %u)",
1211 argsman.AddArg("-maxtipage=<n>",
1212 strprintf("Maximum tip age in seconds to consider node in "
1213 "initial block download (default: %u)",
1214 Ticks<std::chrono::seconds>(DEFAULT_MAX_TIP_AGE)),
1217
1218 argsman.AddArg("-uacomment=<cmt>",
1219 "Append comment to the user agent string",
1221 argsman.AddArg("-uaclientname=<clientname>", "Set user agent client name",
1223 argsman.AddArg("-uaclientversion=<clientversion>",
1224 "Set user agent client version", ArgsManager::ALLOW_ANY,
1226
1228
1229 argsman.AddArg(
1230 "-acceptnonstdtxn",
1231 strprintf(
1232 "Relay and mine \"non-standard\" transactions (%sdefault: %u)",
1233 "testnet/regtest only; ", defaultChainParams->RequireStandard()),
1236 argsman.AddArg("-excessiveblocksize=<n>",
1237 strprintf("Do not accept blocks larger than this limit, in "
1238 "bytes (default: %d)",
1242 const auto &ticker = Currency::get().ticker;
1243 argsman.AddArg(
1244 "-dustrelayfee=<amt>",
1245 strprintf("Fee rate (in %s/kB) used to define dust, the value of an "
1246 "output such that it will cost about 1/3 of its value in "
1247 "fees at this fee rate to spend it. (default: %s)",
1251
1252 argsman.AddArg(
1253 "-bytespersigcheck",
1254 strprintf("Equivalent bytes per sigCheck in transactions for relay and "
1255 "mining (default: %u).",
1258 argsman.AddArg(
1259 "-bytespersigop",
1260 strprintf("DEPRECATED: Equivalent bytes per sigCheck in transactions "
1261 "for relay and mining (default: %u). This has been "
1262 "deprecated since v0.26.8 and will be removed in the future, "
1263 "please use -bytespersigcheck instead.",
1266 argsman.AddArg(
1267 "-datacarrier",
1268 strprintf("Relay and mine data carrier transactions (default: %d)",
1271 argsman.AddArg(
1272 "-datacarriersize",
1273 strprintf("Maximum size of data in data carrier transactions "
1274 "we relay and mine (default: %u)",
1277 argsman.AddArg(
1278 "-minrelaytxfee=<amt>",
1279 strprintf("Fees (in %s/kB) smaller than this are rejected for "
1280 "relaying, mining and transaction creation (default: %s)",
1283 argsman.AddArg(
1284 "-whitelistrelay",
1285 strprintf("Add 'relay' permission to whitelisted peers "
1286 "with default permissions. This will accept relayed "
1287 "transactions even when not relaying transactions "
1288 "(default: %d)",
1291 argsman.AddArg(
1292 "-whitelistforcerelay",
1293 strprintf("Add 'forcerelay' permission to whitelisted peers "
1294 "with default permissions. This will relay transactions "
1295 "even if the transactions were already in the mempool "
1296 "(default: %d)",
1299
1300 argsman.AddArg("-blockmaxsize=<n>",
1301 strprintf("Set maximum block size in bytes (default: %d)",
1304 argsman.AddArg(
1305 "-blockmintxfee=<amt>",
1306 strprintf("Set lowest fee rate (in %s/kB) for transactions to "
1307 "be included in block creation. (default: %s)",
1310 argsman.AddArg("-simplegbt",
1311 "Use a simplified getblocktemplate output (default: 0)",
1313
1314 argsman.AddArg("-blockversion=<n>",
1315 "Override block version to test forking scenarios",
1318
1319 argsman.AddArg("-server", "Accept command line and JSON-RPC commands",
1321 argsman.AddArg("-rest",
1322 strprintf("Accept public REST requests (default: %d)",
1325 argsman.AddArg(
1326 "-rpcbind=<addr>[:port]",
1327 "Bind to given address to listen for JSON-RPC connections. Do not "
1328 "expose the RPC server to untrusted networks such as the public "
1329 "internet! This option is ignored unless -rpcallowip is also passed. "
1330 "Port is optional and overrides -rpcport. Use [host]:port notation "
1331 "for IPv6. This option can be specified multiple times (default: "
1332 "127.0.0.1 and ::1 i.e., localhost)",
1336 argsman.AddArg(
1337 "-rpcdoccheck",
1338 strprintf("Throw a non-fatal error at runtime if the documentation for "
1339 "an RPC is incorrect (default: %u)",
1342 argsman.AddArg(
1343 "-rpccookiefile=<loc>",
1344 "Location of the auth cookie. Relative paths will be prefixed "
1345 "by a net-specific datadir location. (default: data dir)",
1347 argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections",
1350 argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections",
1353 argsman.AddArg(
1354 "-rpcwhitelist=<whitelist>",
1355 "Set a whitelist to filter incoming RPC calls for a specific user. The "
1356 "field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc "
1357 "2>,...,<rpc n>. If multiple whitelists are set for a given user, they "
1358 "are set-intersected. See -rpcwhitelistdefault documentation for "
1359 "information on default whitelist behavior.",
1361 argsman.AddArg(
1362 "-rpcwhitelistdefault",
1363 "Sets default behavior for rpc whitelisting. Unless "
1364 "rpcwhitelistdefault is set to 0, if any -rpcwhitelist is set, the rpc "
1365 "server acts as if all rpc users are subject to "
1366 "empty-unless-otherwise-specified whitelists. If rpcwhitelistdefault "
1367 "is set to 1 and no -rpcwhitelist is set, rpc server acts as if all "
1368 "rpc users are subject to empty whitelists.",
1370 argsman.AddArg(
1371 "-rpcauth=<userpw>",
1372 "Username and HMAC-SHA-256 hashed password for JSON-RPC connections. "
1373 "The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A "
1374 "canonical python script is included in share/rpcauth. The client then "
1375 "connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> "
1376 "pair of arguments. This option can be specified multiple times",
1378 argsman.AddArg("-rpcport=<port>",
1379 strprintf("Listen for JSON-RPC connections on <port> "
1380 "(default: %u, testnet: %u, regtest: %u)",
1381 defaultBaseParams->RPCPort(),
1382 testnetBaseParams->RPCPort(),
1383 regtestBaseParams->RPCPort()),
1386 argsman.AddArg(
1387 "-rpcallowip=<ip>",
1388 "Allow JSON-RPC connections from specified source. Valid for "
1389 "<ip> are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. "
1390 "1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). "
1391 "This option can be specified multiple times",
1393 argsman.AddArg(
1394 "-rpcthreads=<n>",
1395 strprintf(
1396 "Set the number of threads to service RPC calls (default: %d)",
1399 argsman.AddArg(
1400 "-rpccorsdomain=value",
1401 "Domain from which to accept cross origin requests (browser enforced)",
1403
1404 argsman.AddArg("-rpcworkqueue=<n>",
1405 strprintf("Set the depth of the work queue to service RPC "
1406 "calls (default: %d)",
1410 argsman.AddArg("-rpcservertimeout=<n>",
1411 strprintf("Timeout during HTTP requests (default: %d)",
1415
1416#if HAVE_DECL_FORK
1417 argsman.AddArg("-daemon",
1418 strprintf("Run in the background as a daemon and accept "
1419 "commands (default: %d)",
1422 argsman.AddArg("-daemonwait",
1423 strprintf("Wait for initialization to be finished before "
1424 "exiting. This implies -daemon (default: %d)",
1427#else
1428 hidden_args.emplace_back("-daemon");
1429 hidden_args.emplace_back("-daemonwait");
1430#endif
1431
1432 // Avalanche options.
1433 argsman.AddArg("-avalanche",
1434 strprintf("Enable the avalanche feature (default: %u)",
1437 argsman.AddArg(
1438 "-avalanchestakingrewards",
1439 strprintf("Enable the avalanche staking rewards feature (default: %u, "
1440 "testnet: %u, regtest: %u)",
1441 defaultChainParams->GetConsensus().enableStakingRewards,
1442 testnetChainParams->GetConsensus().enableStakingRewards,
1443 regtestChainParams->GetConsensus().enableStakingRewards),
1445 argsman.AddArg("-avalanchestakingpreconsensus",
1446 strprintf("Enable the avalanche staking rewards "
1447 "preconsensus feature (default: %u)",
1450 argsman.AddArg(
1451 "-avalanchepreconsensus",
1452 strprintf("Enable the avalanche preconsensus feature (default: %u)",
1455 argsman.AddArg("-avalanchepreconsensusmining",
1456 strprintf("Enable mining only the avalanche finalized "
1457 "transactions (default: %u)",
1460 argsman.AddArg("-avalancheconflictingproofcooldown",
1461 strprintf("Mandatory cooldown before a proof conflicting "
1462 "with an already registered one can be considered "
1463 "in seconds (default: %u)",
1467 argsman.AddArg("-avalanchepeerreplacementcooldown",
1468 strprintf("Mandatory cooldown before a peer can be replaced "
1469 "in seconds (default: %u)",
1473 argsman.AddArg(
1474 "-avaminquorumstake",
1475 strprintf(
1476 "Minimum amount of known stake for a usable quorum (default: %s)",
1479 argsman.AddArg(
1480 "-avaminquorumconnectedstakeratio",
1481 strprintf("Minimum proportion of known stake we"
1482 " need nodes for to have a usable quorum (default: %s). "
1483 "This parameter is parsed with a maximum precision of "
1484 "0.000001.",
1488 argsman.AddArg(
1489 "-avaminavaproofsnodecount",
1490 strprintf("Minimum number of node that needs to send us an avaproofs"
1491 " message before we consider we have a usable quorum"
1492 " (default: %s)",
1496 argsman.AddArg(
1497 "-avastalevotethreshold",
1498 strprintf("Number of avalanche votes before a voted item goes stale "
1499 "when voting confidence is low (default: %u)",
1503 argsman.AddArg(
1504 "-avastalevotefactor",
1505 strprintf(
1506 "Factor affecting the number of avalanche votes before a voted "
1507 "item goes stale when voting confidence is high (default: %u)",
1511 argsman.AddArg("-avacooldown",
1512 strprintf("Mandatory cooldown between two avapoll in "
1513 "milliseconds (default: %u)",
1516 argsman.AddArg(
1517 "-avatimeout",
1518 strprintf("Avalanche query timeout in milliseconds (default: %u)",
1521 argsman.AddArg(
1522 "-avadelegation",
1523 "Avalanche proof delegation to the master key used by this node "
1524 "(default: none). Should be used in conjunction with -avaproof and "
1525 "-avamasterkey",
1527 argsman.AddArg("-avaproof",
1528 "Avalanche proof to be used by this node (default: none)",
1530 argsman.AddArg(
1531 "-avaproofstakeutxoconfirmations",
1532 strprintf(
1533 "Minimum number of confirmations before a stake utxo is mature"
1534 " enough to be included into a proof. Utxos in the mempool are not "
1535 "accepted (i.e this value must be greater than 0) (default: %s)",
1539 argsman.AddArg("-avaproofstakeutxodustthreshold",
1540 strprintf("Minimum value each stake utxo must have to be "
1541 "considered valid (default: %s)",
1544 argsman.AddArg("-avamasterkey",
1545 "Master key associated with the proof. If a proof is "
1546 "required, this is mandatory.",
1549 argsman.AddArg("-avasessionkey", "Avalanche session key (default: random)",
1552 argsman.AddArg("-enablertt",
1553 strprintf("Whether to enforce Real Time Targeting via "
1554 "Avalanche, default (%u)",
1557 argsman.AddArg(
1558 "-maxavalancheoutbound",
1559 strprintf(
1560 "Set the maximum number of avalanche outbound peers to connect to. "
1561 "Note that this option takes precedence over the -maxconnections "
1562 "option (default: %u).",
1566 argsman.AddArg(
1567 "-persistavapeers",
1568 strprintf("Whether to save the avalanche peers upon shutdown and load "
1569 "them upon startup (default: %u).",
1572
1573 // Add the hidden options
1574 argsman.AddHiddenArgs(hidden_args);
1575}
1576
1577static bool fHaveGenesis = false;
1579static std::condition_variable g_genesis_wait_cv;
1580
1581static void BlockNotifyGenesisWait(const CBlockIndex *pBlockIndex) {
1582 if (pBlockIndex != nullptr) {
1583 {
1585 fHaveGenesis = true;
1586 }
1587 g_genesis_wait_cv.notify_all();
1588 }
1589}
1590
1591#if HAVE_SYSTEM
1592static void StartupNotify(const ArgsManager &args) {
1593 std::string cmd = args.GetArg("-startupnotify", "");
1594 if (!cmd.empty()) {
1595 std::thread t(runCommand, cmd);
1596 // thread runs free
1597 t.detach();
1598 }
1599}
1600#endif
1601
1602static bool AppInitServers(Config &config,
1603 HTTPRPCRequestProcessor &httpRPCRequestProcessor,
1604 NodeContext &node) {
1605 const ArgsManager &args = *Assert(node.args);
1608 if (!InitHTTPServer(config)) {
1609 return false;
1610 }
1611
1612 StartRPC();
1613 node.rpc_interruption_point = RpcInterruptionPoint;
1614
1615 if (!StartHTTPRPC(httpRPCRequestProcessor)) {
1616 return false;
1617 }
1618 if (args.GetBoolArg("-rest", DEFAULT_REST_ENABLE)) {
1619 StartREST(&node);
1620 }
1621
1623 return true;
1624}
1625
1626// Parameter interaction based on rules
1628 // when specifying an explicit binding address, you want to listen on it
1629 // even when -connect or -proxy is specified.
1630 if (args.IsArgSet("-bind")) {
1631 if (args.SoftSetBoolArg("-listen", true)) {
1632 LogPrintf(
1633 "%s: parameter interaction: -bind set -> setting -listen=1\n",
1634 __func__);
1635 }
1636 }
1637 if (args.IsArgSet("-whitebind")) {
1638 if (args.SoftSetBoolArg("-listen", true)) {
1639 LogPrintf("%s: parameter interaction: -whitebind set -> setting "
1640 "-listen=1\n",
1641 __func__);
1642 }
1643 }
1644
1645 if (args.IsArgSet("-connect")) {
1646 // when only connecting to trusted nodes, do not seed via DNS, or listen
1647 // by default.
1648 if (args.SoftSetBoolArg("-dnsseed", false)) {
1649 LogPrintf("%s: parameter interaction: -connect set -> setting "
1650 "-dnsseed=0\n",
1651 __func__);
1652 }
1653 if (args.SoftSetBoolArg("-listen", false)) {
1654 LogPrintf("%s: parameter interaction: -connect set -> setting "
1655 "-listen=0\n",
1656 __func__);
1657 }
1658 }
1659
1660 if (args.IsArgSet("-proxy")) {
1661 // to protect privacy, do not listen by default if a default proxy
1662 // server is specified.
1663 if (args.SoftSetBoolArg("-listen", false)) {
1664 LogPrintf(
1665 "%s: parameter interaction: -proxy set -> setting -listen=0\n",
1666 __func__);
1667 }
1668 // to protect privacy, do not map ports when a proxy is set. The user
1669 // may still specify -listen=1 to listen locally, so don't rely on this
1670 // happening through -listen below.
1671 if (args.SoftSetBoolArg("-upnp", false)) {
1672 LogPrintf(
1673 "%s: parameter interaction: -proxy set -> setting -upnp=0\n",
1674 __func__);
1675 }
1676 if (args.SoftSetBoolArg("-natpmp", false)) {
1677 LogPrintf(
1678 "%s: parameter interaction: -proxy set -> setting -natpmp=0\n",
1679 __func__);
1680 }
1681 // to protect privacy, do not discover addresses by default
1682 if (args.SoftSetBoolArg("-discover", false)) {
1683 LogPrintf("%s: parameter interaction: -proxy set -> setting "
1684 "-discover=0\n",
1685 __func__);
1686 }
1687 }
1688
1689 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1690 // do not map ports or try to retrieve public IP when not listening
1691 // (pointless)
1692 if (args.SoftSetBoolArg("-upnp", false)) {
1693 LogPrintf(
1694 "%s: parameter interaction: -listen=0 -> setting -upnp=0\n",
1695 __func__);
1696 }
1697 if (args.SoftSetBoolArg("-natpmp", false)) {
1698 LogPrintf(
1699 "%s: parameter interaction: -listen=0 -> setting -natpmp=0\n",
1700 __func__);
1701 }
1702 if (args.SoftSetBoolArg("-discover", false)) {
1703 LogPrintf(
1704 "%s: parameter interaction: -listen=0 -> setting -discover=0\n",
1705 __func__);
1706 }
1707 if (args.SoftSetBoolArg("-listenonion", false)) {
1708 LogPrintf("%s: parameter interaction: -listen=0 -> setting "
1709 "-listenonion=0\n",
1710 __func__);
1711 }
1712 if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
1713 LogPrintf("%s: parameter interaction: -listen=0 -> setting "
1714 "-i2pacceptincoming=0\n",
1715 __func__);
1716 }
1717 }
1718
1719 if (args.IsArgSet("-externalip")) {
1720 // if an explicit public IP is specified, do not try to find others
1721 if (args.SoftSetBoolArg("-discover", false)) {
1722 LogPrintf("%s: parameter interaction: -externalip set -> setting "
1723 "-discover=0\n",
1724 __func__);
1725 }
1726 }
1727
1728 // disable whitelistrelay in blocksonly mode
1729 if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
1730 if (args.SoftSetBoolArg("-whitelistrelay", false)) {
1731 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting "
1732 "-whitelistrelay=0\n",
1733 __func__);
1734 }
1735 }
1736
1737 // Forcing relay from whitelisted hosts implies we will accept relays from
1738 // them in the first place.
1739 if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
1740 if (args.SoftSetBoolArg("-whitelistrelay", true)) {
1741 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> "
1742 "setting -whitelistrelay=1\n",
1743 __func__);
1744 }
1745 }
1746
1747 // If avalanche is set, soft set all the feature flags accordingly.
1748 if (args.IsArgSet("-avalanche")) {
1749 const bool fAvalanche =
1750 args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED);
1751 args.SoftSetBoolArg("-automaticunparking", !fAvalanche);
1752 }
1753}
1754
1761void InitLogging(const ArgsManager &args) {
1764}
1765
1766namespace { // Variables internal to initialization process only
1767
1768int nMaxConnections;
1769int nUserMaxConnections;
1770int nFD;
1772int64_t peer_connect_timeout;
1773std::set<BlockFilterType> g_enabled_filter_types;
1774
1775} // namespace
1776
1777[[noreturn]] static void new_handler_terminate() {
1778 // Rather than throwing std::bad-alloc if allocation fails, terminate
1779 // immediately to (try to) avoid chain corruption. Since LogPrintf may
1780 // itself allocate memory, set the handler directly to terminate first.
1781 std::set_new_handler(std::terminate);
1782 LogPrintf("Error: Out of memory. Terminating.\n");
1783
1784 // The log was successful, terminate now.
1785 std::terminate();
1786};
1787
1788bool AppInitBasicSetup(const ArgsManager &args, std::atomic<int> &exit_status) {
1789// Step 1: setup
1790#ifdef _MSC_VER
1791 // Turn off Microsoft heap dump noise
1792 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
1793 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr,
1794 OPEN_EXISTING, 0, 0));
1795 // Disable confusing "helpful" text message on abort, Ctrl-C
1796 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
1797#endif
1798#ifdef WIN32
1799 // Enable Data Execution Prevention (DEP)
1800 SetProcessDEPPolicy(PROCESS_DEP_ENABLE);
1801#endif
1802 if (!SetupNetworking()) {
1803 return InitError(Untranslated("Initializing networking failed"));
1804 }
1805
1806#ifndef WIN32
1807 if (!args.GetBoolArg("-sysperms", false)) {
1808 umask(077);
1809 }
1810
1811 // Clean shutdown on SIGTERM
1814
1815 // Reopen debug.log on SIGHUP
1817
1818 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client
1819 // closes unexpectedly
1820 signal(SIGPIPE, SIG_IGN);
1821#else
1822 SetConsoleCtrlHandler(consoleCtrlHandler, true);
1823#endif
1824
1825 std::set_new_handler(new_handler_terminate);
1826
1827 return true;
1828}
1829
1831 const CChainParams &chainparams = config.GetChainParams();
1832 // Step 2: parameter interactions
1833
1834 // also see: InitParameterInteraction()
1835
1836 // Error if network-specific options (-addnode, -connect, etc) are
1837 // specified in default section of config file, but not overridden
1838 // on the command line or in this chain's section of the config file.
1839 ChainType chain = args.GetChainType();
1840 bilingual_str errors;
1841 for (const auto &arg : args.GetUnsuitableSectionOnlyArgs()) {
1842 errors +=
1843 strprintf(_("Config setting for %s only applied on %s "
1844 "network when in [%s] section.") +
1845 Untranslated("\n"),
1846 arg, ChainTypeToString(chain), ChainTypeToString(chain));
1847 }
1848
1849 if (!errors.empty()) {
1850 return InitError(errors);
1851 }
1852
1853 // Warn if unrecognized section name are present in the config file.
1854 bilingual_str warnings;
1855 for (const auto &section : args.GetUnrecognizedSections()) {
1856 warnings += strprintf(Untranslated("%s:%i ") +
1857 _("Section [%s] is not recognized.") +
1858 Untranslated("\n"),
1859 section.m_file, section.m_line, section.m_name);
1860 }
1861
1862 if (!warnings.empty()) {
1863 InitWarning(warnings);
1864 }
1865
1866 if (!fs::is_directory(args.GetBlocksDirPath())) {
1867 return InitError(
1868 strprintf(_("Specified blocks directory \"%s\" does not exist."),
1869 args.GetArg("-blocksdir", "")));
1870 }
1871
1872 // parse and validate enabled filter types
1873 std::string blockfilterindex_value =
1874 args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
1875 if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
1876 g_enabled_filter_types = AllBlockFilterTypes();
1877 } else if (blockfilterindex_value != "0") {
1878 const std::vector<std::string> names =
1879 args.GetArgs("-blockfilterindex");
1880 for (const auto &name : names) {
1881 BlockFilterType filter_type;
1882 if (!BlockFilterTypeByName(name, filter_type)) {
1883 return InitError(
1884 strprintf(_("Unknown -blockfilterindex value %s."), name));
1885 }
1886 g_enabled_filter_types.insert(filter_type);
1887 }
1888 }
1889
1890 // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index
1891 // are both enabled.
1892 if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
1893 if (g_enabled_filter_types.count(BlockFilterType::BASIC) != 1) {
1894 return InitError(
1895 _("Cannot set -peerblockfilters without -blockfilterindex."));
1896 }
1897
1898 nLocalServices = ServiceFlags(nLocalServices | NODE_COMPACT_FILTERS);
1899 }
1900
1901 if (args.GetIntArg("-prune", 0)) {
1902 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1903 return InitError(_("Prune mode is incompatible with -txindex."));
1904 }
1905 if (args.GetBoolArg("-reindex-chainstate", false)) {
1906 return InitError(
1907 _("Prune mode is incompatible with -reindex-chainstate. Use "
1908 "full -reindex instead."));
1909 }
1910 if (args.GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
1911 return InitError(_("Prune mode is incompatible with -chronik."));
1912 }
1913 }
1914
1915 // -bind and -whitebind can't be set when not listening
1916 size_t nUserBind =
1917 args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
1918 if (nUserBind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1919 return InitError(Untranslated(
1920 "Cannot set -bind or -whitebind together with -listen=0"));
1921 }
1922
1923 // Make sure enough file descriptors are available
1924 int nBind = std::max(nUserBind, size_t(1));
1925 nUserMaxConnections =
1926 args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
1927 nMaxConnections = std::max(nUserMaxConnections, 0);
1928
1929 // -maxavalancheoutbound takes precedence over -maxconnections
1930 const int maxAvalancheOutbound = args.GetIntArg(
1931 "-maxavalancheoutbound", DEFAULT_MAX_AVALANCHE_OUTBOUND_CONNECTIONS);
1932 const bool fAvalanche =
1933 args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED);
1934 if (fAvalanche && maxAvalancheOutbound > nMaxConnections) {
1935 nMaxConnections = std::max(maxAvalancheOutbound, nMaxConnections);
1936 // Indicate the value set by the user
1937 LogPrintf("Increasing -maxconnections from %d to %d to comply with "
1938 "-maxavalancheoutbound\n",
1939 nUserMaxConnections, nMaxConnections);
1940 }
1941
1942 // Trim requested connection counts, to fit into system limitations
1943 // <int> in std::min<int>(...) to work around FreeBSD compilation issue
1944 // described in #2695
1946 nMaxConnections + nBind + MIN_CORE_FILEDESCRIPTORS +
1948#ifdef USE_POLL
1949 int fd_max = nFD;
1950#else
1951 int fd_max = FD_SETSIZE;
1952#endif
1953 nMaxConnections = std::max(
1954 std::min<int>(nMaxConnections,
1955 fd_max - nBind - MIN_CORE_FILEDESCRIPTORS -
1957 0);
1958 if (nFD < MIN_CORE_FILEDESCRIPTORS) {
1959 return InitError(_("Not enough file descriptors available."));
1960 }
1961 nMaxConnections =
1963 nMaxConnections);
1964
1965 if (nMaxConnections < nUserMaxConnections) {
1966 // Not categorizing as "Warning" because this is the normal behavior for
1967 // platforms using the select() interface for which FD_SETSIZE is
1968 // usually 1024.
1969 LogPrintf("Reducing -maxconnections from %d to %d, because of system "
1970 "limitations.\n",
1971 nUserMaxConnections, nMaxConnections);
1972 }
1973
1974 // Step 3: parameter-to-internal-flags
1977
1978 // Configure excessive block size.
1979 const int64_t nProposedExcessiveBlockSize =
1980 args.GetIntArg("-excessiveblocksize", DEFAULT_MAX_BLOCK_SIZE);
1981 if (nProposedExcessiveBlockSize <= 0 ||
1982 !config.SetMaxBlockSize(nProposedExcessiveBlockSize)) {
1983 return InitError(
1984 _("Excessive block size must be > 1,000,000 bytes (1MB)"));
1985 }
1986
1987 // Check blockmaxsize does not exceed maximum accepted block size.
1988 const int64_t nProposedMaxGeneratedBlockSize =
1989 args.GetIntArg("-blockmaxsize", DEFAULT_MAX_GENERATED_BLOCK_SIZE);
1990 if (nProposedMaxGeneratedBlockSize <= 0) {
1991 return InitError(_("Max generated block size must be greater than 0"));
1992 }
1993 if (uint64_t(nProposedMaxGeneratedBlockSize) > config.GetMaxBlockSize()) {
1994 return InitError(_("Max generated block size (blockmaxsize) cannot "
1995 "exceed the excessive block size "
1996 "(excessiveblocksize)"));
1997 }
1998
2000 if (nConnectTimeout <= 0) {
2002 }
2003
2004 peer_connect_timeout =
2005 args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
2006 if (peer_connect_timeout <= 0) {
2007 return InitError(Untranslated(
2008 "peertimeout cannot be configured with a negative value."));
2009 }
2010
2011 // Sanity check argument for min fee for including tx in block
2012 // TODO: Harmonize which arguments need sanity checking and where that
2013 // happens.
2014 if (args.IsArgSet("-blockmintxfee")) {
2015 Amount n = Amount::zero();
2016 if (!ParseMoney(args.GetArg("-blockmintxfee", ""), n)) {
2017 return InitError(AmountErrMsg("blockmintxfee",
2018 args.GetArg("-blockmintxfee", "")));
2019 }
2020 }
2021
2023 args.IsArgSet("-bytespersigcheck")
2024 ? args.GetIntArg("-bytespersigcheck", nBytesPerSigCheck)
2025 : args.GetIntArg("-bytespersigop", nBytesPerSigCheck);
2026
2028 return false;
2029 }
2030
2031 // Option to startup with mocktime set (used for regression testing):
2032 SetMockTime(args.GetIntArg("-mocktime", 0)); // SetMockTime(0) is a no-op
2033
2034 if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS)) {
2035 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
2036 }
2037
2038 // Avalanche parameters
2039 const int64_t stakeUtxoMinConfirmations =
2040 args.GetIntArg("-avaproofstakeutxoconfirmations",
2042
2043 if (!chainparams.IsTestChain() &&
2044 stakeUtxoMinConfirmations !=
2046 return InitError(_("Avalanche stake UTXO minimum confirmations can "
2047 "only be set on test chains."));
2048 }
2049
2050 if (stakeUtxoMinConfirmations <= 0) {
2051 return InitError(_("Avalanche stake UTXO minimum confirmations must be "
2052 "a positive integer."));
2053 }
2054
2055 if (args.IsArgSet("-avaproofstakeutxodustthreshold")) {
2056 Amount amount = Amount::zero();
2057 auto parsed = ParseMoney(
2058 args.GetArg("-avaproofstakeutxodustthreshold", ""), amount);
2059 if (!parsed || Amount::zero() == amount) {
2060 return InitError(AmountErrMsg(
2061 "avaproofstakeutxodustthreshold",
2062 args.GetArg("-avaproofstakeutxodustthreshold", "")));
2063 }
2064
2065 if (!chainparams.IsTestChain() &&
2067 return InitError(_("Avalanche stake UTXO dust threshold can "
2068 "only be set on test chains."));
2069 }
2070 }
2071
2072 // This is a staking node
2073 if (fAvalanche && args.IsArgSet("-avaproof")) {
2074 if (!args.GetBoolArg("-listen", true)) {
2075 return InitError(_("Running a staking node requires accepting "
2076 "inbound connections. Please enable -listen."));
2077 }
2078 if (args.IsArgSet("-proxy")) {
2079 return InitError(_("Running a staking node behind a proxy is not "
2080 "supported. Please disable -proxy."));
2081 }
2082 if (args.IsArgSet("-i2psam")) {
2083 return InitError(_("Running a staking node behind I2P is not "
2084 "supported. Please disable -i2psam."));
2085 }
2086 if (args.IsArgSet("-onlynet")) {
2087 return InitError(
2088 _("Restricting the outbound network is not supported when "
2089 "running a staking node. Please disable -onlynet."));
2090 }
2091 }
2092
2093 // Also report errors from parsing before daemonization
2094 {
2095 kernel::Notifications notifications{};
2096 ChainstateManager::Options chainman_opts_dummy{
2097 .config = config,
2098 .datadir = args.GetDataDirNet(),
2099 .notifications = notifications,
2100 };
2101 if (const auto error{ApplyArgsManOptions(args, chainman_opts_dummy)}) {
2102 return InitError(*error);
2103 }
2104 BlockManager::Options blockman_opts_dummy{
2105 .chainparams = chainman_opts_dummy.config.GetChainParams(),
2106 .blocks_dir = args.GetBlocksDirPath(),
2107 .notifications = chainman_opts_dummy.notifications,
2108 };
2109 if (const auto error{ApplyArgsManOptions(args, blockman_opts_dummy)}) {
2110 return InitError(*error);
2111 }
2112 }
2113
2114 return true;
2115}
2116
2117static bool LockDataDirectory(bool probeOnly) {
2118 // Make sure only a single Bitcoin process is using the data directory.
2119 const fs::path &datadir = gArgs.GetDataDirNet();
2120 if (!DirIsWritable(datadir)) {
2121 return InitError(strprintf(
2122 _("Cannot write to data directory '%s'; check permissions."),
2123 fs::PathToString(datadir)));
2124 }
2125 if (!LockDirectory(datadir, ".lock", probeOnly)) {
2126 return InitError(strprintf(_("Cannot obtain a lock on data directory "
2127 "%s. %s is probably already running."),
2128 fs::PathToString(datadir), PACKAGE_NAME));
2129 }
2130 return true;
2131}
2132
2134 // Step 4: sanity checks
2135 auto result{kernel::SanityChecks(kernel)};
2136 if (!result) {
2138 return InitError(strprintf(
2139 _("Initialization sanity check failed. %s is shutting down."),
2140 PACKAGE_NAME));
2141 }
2142
2143 // Probe the data directory lock to give an early error message, if possible
2144 // We cannot hold the data directory lock here, as the forking for daemon()
2145 // hasn't yet happened, and a fork will cause weird behavior to it.
2146 return LockDataDirectory(true);
2147}
2148
2150 // After daemonization get the data directory lock again and hold on to it
2151 // until exit. This creates a slight window for a race condition to happen,
2152 // however this condition is harmless: it will at most make us exit without
2153 // printing a message to console.
2154 if (!LockDataDirectory(false)) {
2155 // Detailed error printed inside LockDataDirectory
2156 return false;
2157 }
2158 return true;
2159}
2160
2163 // Create client interfaces for wallets that are supposed to be loaded
2164 // according to -wallet and -disablewallet options. This only constructs
2165 // the interfaces, it doesn't load wallet data. Wallets actually get loaded
2166 // when load() and start() interface methods are called below.
2168 return true;
2169}
2170
2171bool AppInitMain(Config &config, RPCServer &rpcServer,
2172 HTTPRPCRequestProcessor &httpRPCRequestProcessor,
2175 // Step 4a: application initialization
2176 const ArgsManager &args = *Assert(node.args);
2177 const CChainParams &chainparams = config.GetChainParams();
2178
2179 if (!CreatePidFile(args)) {
2180 // Detailed error printed inside CreatePidFile().
2181 return false;
2182 }
2183 if (!init::StartLogging(args)) {
2184 // Detailed error printed inside StartLogging().
2185 return false;
2186 }
2187
2188 LogPrintf("Using at most %i automatic connections (%i file descriptors "
2189 "available)\n",
2190 nMaxConnections, nFD);
2191
2192 // Warn about relative -datadir path.
2193 if (args.IsArgSet("-datadir") &&
2194 !args.GetPathArg("-datadir").is_absolute()) {
2195 LogPrintf("Warning: relative datadir option '%s' specified, which will "
2196 "be interpreted relative to the current working directory "
2197 "'%s'. This is fragile, because if bitcoin is started in the "
2198 "future from a different location, it will be unable to "
2199 "locate the current data files. There could also be data "
2200 "loss if bitcoin is started while in a temporary "
2201 "directory.\n",
2202 args.GetArg("-datadir", ""),
2203 fs::PathToString(fs::current_path()));
2204 }
2205
2206 int script_threads = args.GetIntArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
2207 if (script_threads <= 0) {
2208 // -par=0 means autodetect (number of cores - 1 script threads)
2209 // -par=-n means "leave n cores free" (number of cores - n - 1 script
2210 // threads)
2211 script_threads += GetNumCores();
2212 }
2213
2214 // Subtract 1 because the main thread counts towards the par threads
2215 script_threads = std::max(script_threads - 1, 0);
2216
2217 // Number of script-checking threads <= MAX_SCRIPTCHECK_THREADS
2218 script_threads = std::min(script_threads, MAX_SCRIPTCHECK_THREADS);
2219
2220 LogPrintf("Script verification uses %d additional threads\n",
2221 script_threads);
2222 if (script_threads >= 1) {
2223 StartScriptCheckWorkerThreads(script_threads);
2224 }
2225
2226 assert(!node.scheduler);
2227 node.scheduler = std::make_unique<CScheduler>();
2228 auto &scheduler = *node.scheduler;
2229
2230 // Start the lightweight task scheduler thread
2231 node.scheduler->m_service_thread =
2232 std::thread(&util::TraceThread, "scheduler",
2233 [&] { node.scheduler->serviceQueue(); });
2234
2235 // Gather some entropy once per minute.
2236 node.scheduler->scheduleEvery(
2237 [] {
2239 return true;
2240 },
2241 std::chrono::minutes{1});
2242
2243 if (args.GetBoolArg("-logratelimit", BCLog::DEFAULT_LOGRATELIMIT)) {
2245 [&scheduler](auto func, auto window) {
2246 scheduler.scheduleEvery(std::move(func), window);
2247 },
2249 } else {
2250 LogInfo("Log rate limiting disabled\n");
2251 }
2252
2254
2259 RegisterAllRPCCommands(config, rpcServer, tableRPC);
2260 for (const auto &client : node.chain_clients) {
2261 client->registerRpcs();
2262 }
2263#if ENABLE_ZMQ
2265#endif
2266
2273 if (args.GetBoolArg("-server", false)) {
2274 uiInterface.InitMessage_connect(SetRPCWarmupStatus);
2275 if (!AppInitServers(config, httpRPCRequestProcessor, node)) {
2276 return InitError(
2277 _("Unable to start HTTP server. See debug log for details."));
2278 }
2279 }
2280
2281 // Step 5: verify wallet database integrity
2282 for (const auto &client : node.chain_clients) {
2283 if (!client->verify()) {
2284 return false;
2285 }
2286 }
2287
2288 // Step 6: network initialization
2289
2290 // Note that we absolutely cannot open any actual connections
2291 // until the very end ("start node") as the UTXO/block state
2292 // is not yet setup and may end up being set up twice if we
2293 // need to reindex later.
2294
2295 fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
2296 fDiscover = args.GetBoolArg("-discover", true);
2297
2298 {
2299 // Initialize addrman
2300 assert(!node.addrman);
2301
2302 // Read asmap file if configured
2303 std::vector<bool> asmap;
2304 if (args.IsArgSet("-asmap")) {
2305 fs::path asmap_path =
2306 args.GetPathArg("-asmap", DEFAULT_ASMAP_FILENAME);
2307 if (!asmap_path.is_absolute()) {
2308 asmap_path = args.GetDataDirNet() / asmap_path;
2309 }
2310 if (!fs::exists(asmap_path)) {
2311 InitError(strprintf(_("Could not find asmap file %s"),
2312 fs::quoted(fs::PathToString(asmap_path))));
2313 return false;
2314 }
2315 asmap = DecodeAsmap(asmap_path);
2316 if (asmap.size() == 0) {
2317 InitError(strprintf(_("Could not parse asmap file %s"),
2318 fs::quoted(fs::PathToString(asmap_path))));
2319 return false;
2320 }
2321 const uint256 asmap_version = (HashWriter{} << asmap).GetHash();
2322 LogPrintf("Using asmap version %s for IP bucketing\n",
2323 asmap_version.ToString());
2324 } else {
2325 LogPrintf("Using /16 prefix for IP bucketing\n");
2326 }
2327
2328 uiInterface.InitMessage(_("Loading P2P addresses...").translated);
2329 auto addrman{LoadAddrman(chainparams, asmap, args)};
2330 if (!addrman) {
2331 return InitError(util::ErrorString(addrman));
2332 }
2333 node.addrman = std::move(*addrman);
2334 }
2335
2336 assert(!node.banman);
2337 node.banman = std::make_unique<BanMan>(
2338 args.GetDataDirNet() / "banlist.dat", config.GetChainParams(),
2340 assert(!node.connman);
2341 node.connman = std::make_unique<CConnman>(
2342 config, GetRand<uint64_t>(), GetRand<uint64_t>(), *node.addrman,
2343 args.GetBoolArg("-networkactive", true));
2344
2345 // sanitize comments per BIP-0014, format user agent and check total size
2346 std::vector<std::string> uacomments;
2347 for (const std::string &cmt : args.GetArgs("-uacomment")) {
2348 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT)) {
2349 return InitError(strprintf(
2350 _("User Agent comment (%s) contains unsafe characters."), cmt));
2351 }
2352 uacomments.push_back(cmt);
2353 }
2354 const std::string client_name = args.GetArg("-uaclientname", CLIENT_NAME);
2355 const std::string client_version =
2356 args.GetArg("-uaclientversion", FormatVersion(CLIENT_VERSION));
2357 if (client_name != SanitizeString(client_name, SAFE_CHARS_UA_COMMENT)) {
2358 return InitError(strprintf(
2359 _("-uaclientname (%s) contains invalid characters."), client_name));
2360 }
2361 if (client_version !=
2362 SanitizeString(client_version, SAFE_CHARS_UA_COMMENT)) {
2363 return InitError(
2364 strprintf(_("-uaclientversion (%s) contains invalid characters."),
2365 client_version));
2366 }
2367 const std::string strSubVersion =
2368 FormatUserAgent(client_name, client_version, uacomments);
2369 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
2370 return InitError(strprintf(
2371 _("Total length of network version string (%i) exceeds maximum "
2372 "length (%i). Reduce the number or size of uacomments."),
2373 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
2374 }
2375
2376 if (args.IsArgSet("-onlynet")) {
2377 std::set<enum Network> nets;
2378 for (const std::string &snet : args.GetArgs("-onlynet")) {
2379 enum Network net = ParseNetwork(snet);
2380 if (net == NET_UNROUTABLE) {
2381 return InitError(strprintf(
2382 _("Unknown network specified in -onlynet: '%s'"), snet));
2383 }
2384 nets.insert(net);
2385 }
2386 for (int n = 0; n < NET_MAX; n++) {
2387 enum Network net = (enum Network)n;
2388 if (!nets.count(net)) {
2389 SetReachable(net, false);
2390 }
2391 }
2392 }
2393
2394 // Check for host lookup allowed before parsing any network related
2395 // parameters
2397
2398 bool proxyRandomize =
2399 args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
2400 // -proxy sets a proxy for all outgoing network traffic
2401 // -noproxy (or -proxy=0) as well as the empty string can be used to not set
2402 // a proxy, this is the default
2403 std::string proxyArg = args.GetArg("-proxy", "");
2404 SetReachable(NET_ONION, false);
2405 if (proxyArg != "" && proxyArg != "0") {
2406 CService proxyAddr;
2407 if (!Lookup(proxyArg, proxyAddr, 9050, fNameLookup)) {
2408 return InitError(strprintf(
2409 _("Invalid -proxy address or hostname: '%s'"), proxyArg));
2410 }
2411
2412 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
2413 if (!addrProxy.IsValid()) {
2414 return InitError(strprintf(
2415 _("Invalid -proxy address or hostname: '%s'"), proxyArg));
2416 }
2417
2418 SetProxy(NET_IPV4, addrProxy);
2419 SetProxy(NET_IPV6, addrProxy);
2420 SetProxy(NET_ONION, addrProxy);
2421 SetNameProxy(addrProxy);
2422 // by default, -proxy sets onion as reachable, unless -noonion later
2423 SetReachable(NET_ONION, true);
2424 }
2425
2426 // -onion can be used to set only a proxy for .onion, or override normal
2427 // proxy for .onion addresses.
2428 // -noonion (or -onion=0) disables connecting to .onion entirely. An empty
2429 // string is used to not override the onion proxy (in which case it defaults
2430 // to -proxy set above, or none)
2431 std::string onionArg = args.GetArg("-onion", "");
2432 if (onionArg != "") {
2433 if (onionArg == "0") {
2434 // Handle -noonion/-onion=0
2435 SetReachable(NET_ONION, false);
2436 } else {
2437 CService onionProxy;
2438 if (!Lookup(onionArg, onionProxy, 9050, fNameLookup)) {
2439 return InitError(strprintf(
2440 _("Invalid -onion address or hostname: '%s'"), onionArg));
2441 }
2442 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
2443 if (!addrOnion.IsValid()) {
2444 return InitError(strprintf(
2445 _("Invalid -onion address or hostname: '%s'"), onionArg));
2446 }
2447 SetProxy(NET_ONION, addrOnion);
2448 SetReachable(NET_ONION, true);
2449 }
2450 }
2451
2452 for (const std::string &strAddr : args.GetArgs("-externalip")) {
2453 CService addrLocal;
2454 if (Lookup(strAddr, addrLocal, GetListenPort(), fNameLookup) &&
2455 addrLocal.IsValid()) {
2456 AddLocal(addrLocal, LOCAL_MANUAL);
2457 } else {
2458 return InitError(ResolveErrMsg("externalip", strAddr));
2459 }
2460 }
2461
2462#if ENABLE_ZMQ
2464 [&chainman = node.chainman](CBlock &block, const CBlockIndex &index) {
2465 assert(chainman);
2466 return chainman->m_blockman.ReadBlockFromDisk(block, index);
2467 });
2468
2471 }
2472#endif
2473
2474 // Step 7: load block chain
2475
2476 node.notifications =
2477 std::make_unique<KernelNotifications>(node.exit_status);
2478 fReindex = args.GetBoolArg("-reindex", false);
2479 bool fReindexChainState = args.GetBoolArg("-reindex-chainstate", false);
2480
2481 ChainstateManager::Options chainman_opts{
2482 .config = config,
2483 .datadir = args.GetDataDirNet(),
2484 .adjusted_time_callback = GetAdjustedTime,
2485 .notifications = *node.notifications,
2486 };
2487 // no error can happen, already checked in AppInitParameterInteraction
2488 Assert(!ApplyArgsManOptions(args, chainman_opts));
2489
2490 if (chainman_opts.checkpoints_enabled) {
2491 LogPrintf("Checkpoints will be verified.\n");
2492 } else {
2493 LogPrintf("Skipping checkpoint verification.\n");
2494 }
2495
2496 BlockManager::Options blockman_opts{
2497 .chainparams = chainman_opts.config.GetChainParams(),
2498 .blocks_dir = args.GetBlocksDirPath(),
2499 .notifications = chainman_opts.notifications,
2500 };
2501 // no error can happen, already checked in AppInitParameterInteraction
2502 Assert(!ApplyArgsManOptions(args, blockman_opts));
2503
2504 // cache size calculations
2505 const auto [index_cache_sizes, kernel_cache_sizes] =
2506 CalculateCacheSizes(args, g_enabled_filter_types.size());
2507
2508 LogInfo("Cache configuration:\n");
2509 LogInfo("* Using %.1f MiB for block index database\n",
2510 kernel_cache_sizes.block_tree_db * (1.0 / 1024 / 1024));
2511 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
2512 LogInfo("* Using %.1f MiB for transaction index database\n",
2513 index_cache_sizes.tx_index * (1.0 / 1024 / 1024));
2514 }
2515 for (BlockFilterType filter_type : g_enabled_filter_types) {
2516 LogInfo("* Using %.1f MiB for %s block filter index database\n",
2517 index_cache_sizes.filter_index * (1.0 / 1024 / 1024),
2518 BlockFilterTypeName(filter_type));
2519 }
2520 LogInfo("* Using %.1f MiB for chain state database\n",
2521 kernel_cache_sizes.coins_db * (1.0 / 1024 / 1024));
2522
2523 assert(!node.mempool);
2524 assert(!node.chainman);
2525
2526 CTxMemPool::Options mempool_opts{
2527 .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
2528 };
2529 if (const auto err{ApplyArgsManOptions(args, chainparams, mempool_opts)}) {
2530 return InitError(*err);
2531 }
2532 mempool_opts.check_ratio =
2533 std::clamp<int>(mempool_opts.check_ratio, 0, 1'000'000);
2534
2535 // FIXME: this legacy limit comes from the DEFAULT_DESCENDANT_SIZE_LIMIT
2536 // (101) that was enforced before the wellington activation. While it's
2537 // still a good idea to have some minimum mempool size, using this value as
2538 // a threshold is no longer relevant.
2539 int64_t nMempoolSizeMin = 101 * 1000 * 40;
2540 if (mempool_opts.max_size_bytes < 0 ||
2541 (!chainparams.IsTestChain() &&
2542 mempool_opts.max_size_bytes < nMempoolSizeMin)) {
2543 return InitError(strprintf(_("-maxmempool must be at least %d MB"),
2544 std::ceil(nMempoolSizeMin / 1000000.0)));
2545 }
2546 LogInfo("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of "
2547 "unused mempool space)\n",
2548 kernel_cache_sizes.coins * (1.0 / 1024 / 1024),
2549 mempool_opts.max_size_bytes * (1.0 / 1024 / 1024));
2550
2551 for (bool fLoaded = false; !fLoaded && !ShutdownRequested();) {
2552 node.mempool = std::make_unique<CTxMemPool>(config, mempool_opts);
2553
2554 node.chainman = std::make_unique<ChainstateManager>(
2555 node.kernel->interrupt, chainman_opts, blockman_opts);
2556 ChainstateManager &chainman = *node.chainman;
2557
2558 // This is defined and set here instead of inline in validation.h to
2559 // avoid a hard dependency between validation and index/base, since the
2560 // latter is not in libbitcoinkernel.
2561 chainman.snapshot_download_completed = [&node]() {
2562 if (!node.chainman->m_blockman.IsPruneMode()) {
2563 LogPrintf("[snapshot] re-enabling NODE_NETWORK services\n");
2564 node.connman->AddLocalServices(NODE_NETWORK);
2565 }
2566
2567 LogPrintf("[snapshot] restarting indexes\n");
2568
2569 // Drain the validation interface queue to ensure that the old
2570 // indexes don't have any pending work.
2572
2573 for (auto *index : node.indexes) {
2574 index->Interrupt();
2575 index->Stop();
2576 if (!(index->Init() && index->StartBackgroundSync())) {
2577 LogPrintf("[snapshot] WARNING failed to restart index %s "
2578 "on snapshot chain\n",
2579 index->GetName());
2580 }
2581 }
2582 };
2583
2585 options.mempool = Assert(node.mempool.get());
2586 options.reindex = node::fReindex;
2587 options.reindex_chainstate = fReindexChainState;
2588 options.prune = chainman.m_blockman.IsPruneMode();
2589 options.check_blocks =
2590 args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
2591 options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
2593 args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
2595 options.coins_error_cb = [] {
2596 uiInterface.ThreadSafeMessageBox(
2597 _("Error reading from database, shutting down."), "",
2599 };
2600
2601 uiInterface.InitMessage(_("Loading block index...").translated);
2602
2603 const int64_t load_block_index_start_time = GetTimeMillis();
2604 auto catch_exceptions = [](auto &&f) {
2605 try {
2606 return f();
2607 } catch (const std::exception &e) {
2608 LogPrintf("%s\n", e.what());
2609 return std::make_tuple(node::ChainstateLoadStatus::FAILURE,
2610 _("Error opening block database"));
2611 }
2612 };
2613 auto [status, error] =
2614 catch_exceptions([&, &kernel_cache_sizes_ = kernel_cache_sizes] {
2615 return LoadChainstate(chainman, kernel_cache_sizes_, options);
2616 });
2618 uiInterface.InitMessage(_("Verifying blocks...").translated);
2619 if (chainman.m_blockman.m_have_pruned &&
2620 options.check_blocks > MIN_BLOCKS_TO_KEEP) {
2621 LogWarning("pruned datadir may not have more than %d "
2622 "blocks; only checking available blocks\n",
2624 }
2625 std::tie(status, error) = catch_exceptions(
2626 [&] { return VerifyLoadedChainstate(chainman, options); });
2628 WITH_LOCK(cs_main, return node.chainman->LoadRecentHeadersTime(
2629 node.chainman->m_options.datadir /
2631 fLoaded = true;
2632 LogPrintf(" block index %15dms\n",
2633 GetTimeMillis() - load_block_index_start_time);
2634 }
2635 }
2636
2639 status ==
2641 return InitError(error);
2642 }
2643
2644 if (!fLoaded && !ShutdownRequested()) {
2645 // first suggest a reindex
2646 if (!options.reindex) {
2647 bool fRet = uiInterface.ThreadSafeQuestion(
2648 error + Untranslated(".\n\n") +
2649 _("Do you want to rebuild the block database now?"),
2650 error.original + ".\nPlease restart with -reindex or "
2651 "-reindex-chainstate to recover.",
2652 "",
2655 if (fRet) {
2656 fReindex = true;
2657 AbortShutdown();
2658 } else {
2659 LogPrintf("Aborted block database rebuild. Exiting.\n");
2660 return false;
2661 }
2662 } else {
2663 return InitError(error);
2664 }
2665 }
2666 }
2667
2668 // As LoadBlockIndex can take several minutes, it's possible the user
2669 // requested to kill the GUI during the last operation. If so, exit.
2670 // As the program has not fully started yet, Shutdown() is possibly
2671 // overkill.
2672 if (ShutdownRequested()) {
2673 LogPrintf("Shutdown requested. Exiting.\n");
2674 return false;
2675 }
2676
2677 ChainstateManager &chainman = *Assert(node.chainman);
2678
2679 if (args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED)) {
2680 // Initialize Avalanche.
2681 bilingual_str avalancheError;
2683 args, *node.chain, node.connman.get(), chainman, node.mempool.get(),
2684 *node.scheduler, avalancheError);
2685 if (!node.avalanche) {
2686 InitError(avalancheError);
2687 return false;
2688 }
2689
2690 if (node.avalanche->isAvalancheServiceAvailable()) {
2691 nLocalServices = ServiceFlags(nLocalServices | NODE_AVALANCHE);
2692 }
2693 }
2694
2695 PeerManager::Options peerman_opts{};
2696 ApplyArgsManOptions(args, peerman_opts);
2697
2698 assert(!node.peerman);
2699 node.peerman = PeerManager::make(*node.connman, *node.addrman,
2700 node.banman.get(), chainman, *node.mempool,
2701 node.avalanche.get(), peerman_opts);
2702 RegisterValidationInterface(node.peerman.get());
2703
2704 // Encoded addresses using cashaddr instead of base58.
2705 // We do this by default to avoid confusion with BTC addresses.
2706 config.SetCashAddrEncoding(
2707 args.GetBoolArg("-usecashaddr", DEFAULT_USEASHADDR));
2708
2709 // Step 8: load indexers
2710
2711 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
2712 auto result{
2714 chainman.m_blockman.m_block_tree_db)))};
2715 if (!result) {
2716 return InitError(util::ErrorString(result));
2717 }
2718
2719 g_txindex = std::make_unique<TxIndex>(
2720 interfaces::MakeChain(node, Params()), index_cache_sizes.tx_index,
2721 false, fReindex);
2722 node.indexes.emplace_back(g_txindex.get());
2723 }
2724
2725 for (const auto &filter_type : g_enabled_filter_types) {
2727 [&] { return interfaces::MakeChain(node, Params()); }, filter_type,
2728 index_cache_sizes.filter_index, false, fReindex);
2729 node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
2730 }
2731
2732 if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
2733 g_coin_stats_index = std::make_unique<CoinStatsIndex>(
2734 interfaces::MakeChain(node, Params()), /* cache size */ 0, false,
2735 fReindex);
2736 node.indexes.emplace_back(g_coin_stats_index.get());
2737 }
2738
2739 // Init indexes
2740 for (auto index : node.indexes) {
2741 if (!index->Init()) {
2742 return false;
2743 }
2744 }
2745
2746 const bool background_sync_in_progress{WITH_LOCK(
2747 chainman.GetMutex(), return chainman.BackgroundSyncInProgress())};
2748#if ENABLE_CHRONIK
2749 if (args.GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
2750 if (background_sync_in_progress) {
2751 return InitError(
2752 _("Assumeutxo is incompatible with -chronik. Wait for "
2753 "background sync to complete before enabling Chronik."));
2754 }
2755
2756 const bool fReindexChronik =
2757 fReindex || args.GetBoolArg("-chronikreindex", false);
2758 if (!chronik::Start(args, config, node, fReindexChronik)) {
2759 return false;
2760 }
2761 }
2762#endif
2763
2764 // Step 9: load wallet
2765 for (const auto &client : node.chain_clients) {
2766 if (!client->load()) {
2767 return false;
2768 }
2769 }
2770
2771 // Step 10: data directory maintenance
2772
2773 // if pruning, perform the initial blockstore prune
2774 // after any wallet rescanning has taken place.
2775 if (chainman.m_blockman.IsPruneMode()) {
2776 if (!fReindex) {
2777 LOCK(cs_main);
2778 for (Chainstate *chainstate : chainman.GetAll()) {
2779 uiInterface.InitMessage(_("Pruning blockstore...").translated);
2780 chainstate->PruneAndFlush();
2781 }
2782 }
2783 } else {
2784 // Prior to setting NODE_NETWORK, check if we can provide historical
2785 // blocks.
2786 if (!background_sync_in_progress) {
2787 LogPrintf("Setting NODE_NETWORK on non-prune mode\n");
2788 nLocalServices = ServiceFlags(nLocalServices | NODE_NETWORK);
2789 } else {
2790 LogPrintf("Running node in NODE_NETWORK_LIMITED mode until "
2791 "snapshot background sync completes\n");
2792 }
2793 }
2794
2795 // Step 11: import blocks
2796 if (!CheckDiskSpace(args.GetDataDirNet())) {
2797 InitError(
2798 strprintf(_("Error: Disk space is low for %s"),
2800 return false;
2801 }
2802 if (!CheckDiskSpace(args.GetBlocksDirPath())) {
2803 InitError(
2804 strprintf(_("Error: Disk space is low for %s"),
2806 return false;
2807 }
2808
2809 // Either install a handler to notify us when genesis activates, or set
2810 // fHaveGenesis directly.
2811 // No locking, as this happens before any background thread is started.
2812 boost::signals2::connection block_notify_genesis_wait_connection;
2813 if (WITH_LOCK(chainman.GetMutex(),
2814 return chainman.ActiveChain().Tip() == nullptr)) {
2815 block_notify_genesis_wait_connection =
2816 uiInterface.NotifyBlockTip_connect(
2817 std::bind(BlockNotifyGenesisWait, std::placeholders::_2));
2818 } else {
2819 fHaveGenesis = true;
2820 }
2821
2822#if defined(HAVE_SYSTEM)
2823 const std::string block_notify = args.GetArg("-blocknotify", "");
2824 if (!block_notify.empty()) {
2825 uiInterface.NotifyBlockTip_connect([block_notify](
2826 SynchronizationState sync_state,
2827 const CBlockIndex *pBlockIndex) {
2828 if (sync_state != SynchronizationState::POST_INIT || !pBlockIndex) {
2829 return;
2830 }
2831 std::string command = block_notify;
2832 ReplaceAll(command, "%s", pBlockIndex->GetBlockHash().GetHex());
2833 std::thread t(runCommand, command);
2834 // thread runs free
2835 t.detach();
2836 });
2837 }
2838#endif
2839
2840 std::vector<fs::path> vImportFiles;
2841 for (const std::string &strFile : args.GetArgs("-loadblock")) {
2842 vImportFiles.push_back(fs::PathFromString(strFile));
2843 }
2844
2845 avalanche::Processor *const avalanche = node.avalanche.get();
2846 chainman.m_thread_load = std::thread(
2847 &util::TraceThread, "initload", [=, &chainman, &args, &node] {
2848 // Import blocks
2849 ImportBlocks(chainman, avalanche, vImportFiles);
2850 // Start indexes initial sync
2852 bilingual_str err_str =
2853 _("Failed to start indexes, shutting down..");
2854 chainman.GetNotifications().fatalError(err_str.original,
2855 err_str);
2856 return;
2857 }
2858 // Load mempool from disk
2859 chainman.ActiveChainstate().LoadMempool(
2860 ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{});
2861 });
2862
2863 // Wait for genesis block to be processed
2864 {
2866 // We previously could hang here if StartShutdown() is called prior to
2867 // ImportBlocks getting started, so instead we just wait on a timer to
2868 // check ShutdownRequested() regularly.
2869 while (!fHaveGenesis && !ShutdownRequested()) {
2870 g_genesis_wait_cv.wait_for(lock, std::chrono::milliseconds(500));
2871 }
2872 block_notify_genesis_wait_connection.disconnect();
2873 }
2874
2875 if (ShutdownRequested()) {
2876 return false;
2877 }
2878
2879 // Step 12: start node
2880
2881 int chain_active_height;
2882
2884 {
2885 LOCK(cs_main);
2886 LogPrintf("block tree size = %u\n", chainman.BlockIndex().size());
2887 chain_active_height = chainman.ActiveChain().Height();
2888 if (tip_info) {
2889 tip_info->block_height = chain_active_height;
2890 tip_info->block_time =
2891 chainman.ActiveChain().Tip()
2892 ? chainman.ActiveChain().Tip()->GetBlockTime()
2893 : chainman.GetParams().GenesisBlock().GetBlockTime();
2895 chainman.GetParams().TxData(), chainman.ActiveChain().Tip());
2896 }
2897 if (tip_info && chainman.m_best_header) {
2898 tip_info->header_height = chainman.m_best_header->nHeight;
2899 tip_info->header_time = chainman.m_best_header->GetBlockTime();
2900 }
2901 }
2902 LogPrintf("nBestHeight = %d\n", chain_active_height);
2903 if (node.peerman) {
2904 node.peerman->SetBestHeight(chain_active_height);
2905 }
2906
2907 // Map ports with UPnP or NAT-PMP.
2908 StartMapPort(args.GetBoolArg("-upnp", DEFAULT_UPNP),
2909 args.GetBoolArg("-natpmp", DEFAULT_NATPMP));
2910
2911 CConnman::Options connOptions;
2912 connOptions.nLocalServices = nLocalServices;
2913 connOptions.nMaxConnections = nMaxConnections;
2914 connOptions.m_max_avalanche_outbound =
2915 node.avalanche
2916 ? args.GetIntArg("-maxavalancheoutbound",
2918 : 0;
2919 connOptions.m_max_outbound_full_relay = std::min(
2921 connOptions.nMaxConnections - connOptions.m_max_avalanche_outbound);
2922 connOptions.m_max_outbound_block_relay = std::min(
2924 connOptions.nMaxConnections - connOptions.m_max_avalanche_outbound -
2925 connOptions.m_max_outbound_full_relay);
2927 connOptions.nMaxFeeler = MAX_FEELER_CONNECTIONS;
2928 connOptions.uiInterface = &uiInterface;
2929 connOptions.m_banman = node.banman.get();
2930 connOptions.m_msgproc.push_back(node.peerman.get());
2931 if (node.avalanche) {
2932 connOptions.m_msgproc.push_back(node.avalanche.get());
2933 }
2934 connOptions.nSendBufferMaxSize =
2935 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
2936 connOptions.nReceiveFloodSize =
2937 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
2938 connOptions.m_added_nodes = args.GetArgs("-addnode");
2939
2940 connOptions.nMaxOutboundLimit =
2941 1024 * 1024 *
2942 args.GetIntArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET);
2943 connOptions.m_peer_connect_timeout = peer_connect_timeout;
2944 connOptions.whitelist_forcerelay =
2945 args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
2946 connOptions.whitelist_relay =
2947 args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
2948
2949 // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
2950 const uint16_t default_bind_port = static_cast<uint16_t>(
2951 args.GetIntArg("-port", config.GetChainParams().GetDefaultPort()));
2952
2953 const auto BadPortWarning = [](const char *prefix, uint16_t port) {
2954 return strprintf(_("%s request to listen on port %u. This port is "
2955 "considered \"bad\" and "
2956 "thus it is unlikely that any Bitcoin ABC peers "
2957 "connect to it. See "
2958 "doc/p2p-bad-ports.md for details and a full list."),
2959 prefix, port);
2960 };
2961
2962 for (const std::string &bind_arg : args.GetArgs("-bind")) {
2963 CService bind_addr;
2964 const size_t index = bind_arg.rfind('=');
2965 if (index == std::string::npos) {
2966 if (Lookup(bind_arg, bind_addr, default_bind_port,
2967 /*fAllowLookup=*/false)) {
2968 connOptions.vBinds.push_back(bind_addr);
2969 if (IsBadPort(bind_addr.GetPort())) {
2970 InitWarning(BadPortWarning("-bind", bind_addr.GetPort()));
2971 }
2972 continue;
2973 }
2974 } else {
2975 const std::string network_type = bind_arg.substr(index + 1);
2976 if (network_type == "onion") {
2977 const std::string truncated_bind_arg =
2978 bind_arg.substr(0, index);
2979 if (Lookup(truncated_bind_arg, bind_addr,
2980 BaseParams().OnionServiceTargetPort(), false)) {
2981 connOptions.onion_binds.push_back(bind_addr);
2982 continue;
2983 }
2984 }
2985 }
2986 return InitError(ResolveErrMsg("bind", bind_arg));
2987 }
2988
2989 for (const std::string &strBind : args.GetArgs("-whitebind")) {
2990 NetWhitebindPermissions whitebind;
2991 bilingual_str error;
2992 if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) {
2993 return InitError(error);
2994 }
2995 connOptions.vWhiteBinds.push_back(whitebind);
2996 }
2997
2998 // If the user did not specify -bind= or -whitebind= then we bind
2999 // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
3000 connOptions.bind_on_any =
3001 args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
3002
3003 // Emit a warning if a bad port is given to -port= but only if -bind and
3004 // -whitebind are not given, because if they are, then -port= is ignored.
3005 if (connOptions.bind_on_any && args.IsArgSet("-port")) {
3006 const uint16_t port_arg = args.GetIntArg("-port", 0);
3007 if (IsBadPort(port_arg)) {
3008 InitWarning(BadPortWarning("-port", port_arg));
3009 }
3010 }
3011
3012 CService onion_service_target;
3013 if (!connOptions.onion_binds.empty()) {
3014 onion_service_target = connOptions.onion_binds.front();
3015 } else if (!connOptions.vBinds.empty()) {
3016 onion_service_target = connOptions.vBinds.front();
3017 } else {
3018 onion_service_target = DefaultOnionServiceTarget();
3019 connOptions.onion_binds.push_back(onion_service_target);
3020 }
3021
3022 if (args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
3023 if (connOptions.onion_binds.size() > 1) {
3025 _("More than one onion bind address is provided. Using %s "
3026 "for the automatically created Tor onion service."),
3027 onion_service_target.ToStringIPPort()));
3028 }
3029 StartTorControl(onion_service_target);
3030 }
3031
3032 if (connOptions.bind_on_any) {
3033 // Only add all IP addresses of the machine if we would be listening on
3034 // any address - 0.0.0.0 (IPv4) and :: (IPv6).
3035 Discover();
3036 }
3037
3038 for (const auto &net : args.GetArgs("-whitelist")) {
3040 ConnectionDirection connection_direction;
3041 bilingual_str error;
3042 if (!NetWhitelistPermissions::TryParse(net, subnet,
3043 connection_direction, error)) {
3044 return InitError(error);
3045 }
3046 if (connection_direction & ConnectionDirection::In) {
3047 connOptions.vWhitelistedRangeIncoming.push_back(subnet);
3048 }
3049 if (connection_direction & ConnectionDirection::Out) {
3050 connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
3051 }
3052 }
3053
3054 connOptions.vSeedNodes = args.GetArgs("-seednode");
3055
3056 // Initiate outbound connections unless connect=0
3057 connOptions.m_use_addrman_outgoing = !args.IsArgSet("-connect");
3058 if (!connOptions.m_use_addrman_outgoing) {
3059 const auto connect = args.GetArgs("-connect");
3060 if (connect.size() != 1 || connect[0] != "0") {
3061 connOptions.m_specified_outgoing = connect;
3062 }
3063 }
3064
3065 const std::string &i2psam_arg = args.GetArg("-i2psam", "");
3066 if (!i2psam_arg.empty()) {
3067 CService addr;
3068 if (!Lookup(i2psam_arg, addr, 7656, fNameLookup) || !addr.IsValid()) {
3069 return InitError(strprintf(
3070 _("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
3071 }
3072 SetReachable(NET_I2P, true);
3073 SetProxy(NET_I2P, proxyType{addr});
3074 } else {
3075 SetReachable(NET_I2P, false);
3076 }
3077
3078 connOptions.m_i2p_accept_incoming =
3079 args.GetBoolArg("-i2pacceptincoming", true);
3080
3081 if (!node.connman->Start(*node.scheduler, connOptions)) {
3082 return false;
3083 }
3084
3085 // Step 13: finished
3086
3087 // At this point, the RPC is "started", but still in warmup, which means it
3088 // cannot yet be called. Before we make it callable, we need to make sure
3089 // that the RPC's view of the best block is valid and consistent with
3090 // ChainstateManager's active tip.
3091 //
3092 // If we do not do this, RPC's view of the best block will be height=0 and
3093 // hash=0x0. This will lead to erroroneous responses for things like
3094 // waitforblockheight.
3096 WITH_LOCK(chainman.GetMutex(), return chainman.ActiveTip()));
3098
3099 uiInterface.InitMessage(_("Done loading").translated);
3100
3101 for (const auto &client : node.chain_clients) {
3102 client->start(*node.scheduler);
3103 }
3104
3105 BanMan *banman = node.banman.get();
3106 node.scheduler->scheduleEvery(
3107 [banman] {
3108 banman->DumpBanlist();
3109 return true;
3110 },
3112
3113 // Start Avalanche's event loop.
3114 if (node.avalanche) {
3115 node.avalanche->startEventLoop(*node.scheduler);
3116 }
3117
3118 if (node.peerman) {
3119 node.peerman->StartScheduledTasks(*node.scheduler);
3120 }
3121
3122#if HAVE_SYSTEM
3123 StartupNotify(args);
3124#endif
3125
3126 return true;
3127}
3128
3130 // Find the oldest block among all indexes.
3131 // This block is used to verify that we have the required blocks' data
3132 // stored on disk, starting from that point up to the current tip.
3133 // indexes_start_block='nullptr' means "start from height 0".
3134 std::optional<const CBlockIndex *> indexes_start_block;
3135 std::string older_index_name;
3136 ChainstateManager &chainman = *Assert(node.chainman);
3137 const Chainstate &chainstate =
3138 WITH_LOCK(::cs_main, return chainman.GetChainstateForIndexing());
3139 const CChain &index_chain = chainstate.m_chain;
3140
3141 for (auto index : node.indexes) {
3142 const IndexSummary &summary = index->GetSummary();
3143 if (summary.synced) {
3144 continue;
3145 }
3146
3147 // Get the last common block between the index best block and the active
3148 // chain
3149 LOCK(::cs_main);
3150 const CBlockIndex *pindex = chainman.m_blockman.LookupBlockIndex(
3151 BlockHash{summary.best_block_hash});
3152 if (!index_chain.Contains(pindex)) {
3153 pindex = index_chain.FindFork(pindex);
3154 }
3155
3156 if (!indexes_start_block || !pindex ||
3157 pindex->nHeight < indexes_start_block.value()->nHeight) {
3158 indexes_start_block = pindex;
3159 older_index_name = summary.name;
3160 if (!pindex) {
3161 // Starting from genesis so no need to look for earlier block.
3162 break;
3163 }
3164 }
3165 };
3166
3167 // Verify all blocks needed to sync to current tip are present.
3168 if (indexes_start_block) {
3169 LOCK(::cs_main);
3170 const CBlockIndex *start_block = *indexes_start_block;
3171 if (!start_block) {
3172 start_block = chainman.ActiveChain().Genesis();
3173 }
3174 if (!chainman.m_blockman.CheckBlockDataAvailability(
3175 *index_chain.Tip(), *Assert(start_block))) {
3176 return InitError(strprintf(
3177 Untranslated("%s best block of the index goes beyond pruned "
3178 "data. Please disable the index or reindex (which "
3179 "will download the whole blockchain again)"),
3180 older_index_name));
3181 }
3182 }
3183
3184 // Start threads
3185 for (auto index : node.indexes) {
3186 if (!index->StartBackgroundSync()) {
3187 return false;
3188 }
3189 }
3190 return true;
3191}
util::Result< std::unique_ptr< AddrMan > > LoadAddrman(const CChainParams &chainparams, const std::vector< bool > &asmap, const ArgsManager &args)
Returns an error string on failure.
Definition: addrdb.cpp:168
static constexpr int32_t DEFAULT_ADDRMAN_CONSISTENCY_CHECKS
Default for -checkaddrman.
Definition: addrman.h:28
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: args.cpp:706
const char *const BITCOIN_SETTINGS_FILENAME
Definition: args.cpp:38
ArgsManager gArgs
Definition: args.cpp:40
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:37
fs::path AbsPathForConfigVal(const ArgsManager &args, const fs::path &path, bool net_specific=true)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
Definition: configfile.cpp:236
std::vector< bool > DecodeAsmap(fs::path path)
Read asmap from provided binary file.
Definition: asmap.cpp:294
static constexpr bool DEFAULT_PERSIST_AVAPEERS
Default for -persistavapeers.
Definition: avalanche.h:63
static constexpr double AVALANCHE_DEFAULT_MIN_QUORUM_CONNECTED_STAKE_RATIO
Default minimum percentage of stake-weighted peers we must have a node for to constitute a usable quo...
Definition: avalanche.h:53
static constexpr bool DEFAULT_AVALANCHE_STAKING_PRECONSENSUS
Default for -avalanchestakingpreconsensus.
Definition: avalanche.h:69
static constexpr size_t AVALANCHE_DEFAULT_PEER_REPLACEMENT_COOLDOWN
Peer replacement cooldown time default value in seconds.
Definition: avalanche.h:34
static constexpr double AVALANCHE_DEFAULT_MIN_AVAPROOFS_NODE_COUNT
Default minimum number of nodes that sent us an avaproofs message before we can consider our quorum s...
Definition: avalanche.h:60
static constexpr bool DEFAULT_AVALANCHE_PRECONSENSUS
Default for -avalanchepreconsensus.
Definition: avalanche.h:66
static constexpr Amount AVALANCHE_DEFAULT_MIN_QUORUM_STAKE
Default minimum cumulative stake of all known peers that constitutes a usable quorum.
Definition: avalanche.h:46
static constexpr size_t AVALANCHE_DEFAULT_CONFLICTING_PROOF_COOLDOWN
Conflicting proofs cooldown time default value in seconds.
Definition: avalanche.h:28
static constexpr bool DEFAULT_AVALANCHE_MINING_PRECONSENSUS
Default for -avalanchepreconsensusmining.
Definition: avalanche.h:72
static constexpr bool AVALANCHE_DEFAULT_ENABLED
Is avalanche enabled by default.
Definition: avalanche.h:22
static constexpr size_t AVALANCHE_DEFAULT_COOLDOWN
Avalanche default cooldown in milliseconds.
Definition: avalanche.h:40
static constexpr unsigned int DEFAULT_MISBEHAVING_BANTIME
Definition: banman.h:20
static constexpr std::chrono::minutes DUMP_BANS_INTERVAL
Definition: banman.h:22
void RPCNotifyBlockChange(const CBlockIndex *pindex)
Callback for when block tip changed.
Definition: blockchain.cpp:248
const std::string & BlockFilterTypeName(BlockFilterType filter_type)
Get the human-readable name for a filter type.
const std::set< BlockFilterType > & AllBlockFilterTypes()
Get a list of known filter types.
const std::string & ListBlockFilterTypes()
Get a comma-separated list of known filter type names.
bool BlockFilterTypeByName(const std::string &name, BlockFilterType &filter_type)
Find a filter type by its human-readable name.
BlockFilterType
Definition: blockfilter.h:88
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
void ForEachBlockFilterIndex(std::function< void(BlockFilterIndex &)> fn)
Iterate over all running block filter indexes, invoking fn on each.
bool InitBlockFilterIndex(std::function< std::unique_ptr< interfaces::Chain >()> make_chain, BlockFilterType filter_type, size_t n_cache_size, bool f_memory, bool f_wipe)
Initialize a block filter index for the given type if one does not already exist.
static const char *const DEFAULT_BLOCKFILTERINDEX
std::unique_ptr< const CChainParams > CreateChainParams(const ArgsManager &args, const ChainType chain)
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain.
Definition: chainparams.cpp:33
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:21
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const ChainType chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 18445) have been chosen arbitrarily to...
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
static constexpr bool DEFAULT_CHECKPOINTS_ENABLED
static constexpr auto DEFAULT_MAX_TIP_AGE
static constexpr int DEFAULT_STOPATHEIGHT
static constexpr bool DEFAULT_STORE_RECENT_HEADERS_TIME
std::string ChainTypeToString(ChainType chain)
Definition: chaintype.cpp:11
ChainType
Definition: chaintype.h:11
#define Assert(val)
Identity function.
Definition: check.h:84
std::set< std::string > GetUnsuitableSectionOnlyArgs() const
Log warnings for options in m_section_only_args when they are specified in the default section but no...
Definition: args.cpp:141
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
Definition: args.cpp:165
@ NETWORK_ONLY
Definition: args.h:134
@ ALLOW_ANY
disable validation
Definition: args.h:114
@ DISALLOW_NEGATION
unimplemented, draft implementation in #16545
Definition: args.h:124
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition: args.h:126
@ DEBUG_ONLY
Definition: args.h:128
@ SENSITIVE
Definition: args.h:136
ChainType GetChainType() const
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.
Definition: args.cpp:762
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:362
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:239
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: args.cpp:372
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:495
fs::path GetBlocksDirPath() const
Get blocks directory path.
Definition: args.cpp:300
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:463
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:558
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:525
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: args.cpp:611
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:589
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:286
static std::shared_ptr< LogRateLimiter > Create(SchedulerFunction &&scheduler_func, uint64_t max_bytes, std::chrono::seconds reset_window)
Definition: logging.cpp:364
void SetRateLimiting(std::shared_ptr< LogRateLimiter > limiter) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Definition: logging.h:314
std::atomic< bool > m_reopen_file
Definition: logging.h:266
Definition: banman.h:58
void DumpBanlist()
Definition: banman.cpp:49
void Stop()
Stops the instance from staying in sync with blockchain updates.
Definition: base.cpp:418
bool BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void Interrupt()
Blocks the current thread until the index is caught up to the current state of the block chain.
Definition: base.cpp:404
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
int64_t GetBlockTime() const
Definition: block.h:57
Definition: block.h:60
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: blockindex.h:25
int64_t GetBlockTime() const
Definition: blockindex.h:160
BlockHash GetBlockHash() const
Definition: blockindex.h:130
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: blockindex.h:38
An in-memory indexed chain of blocks.
Definition: chain.h:134
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:150
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:143
int Height() const
Return the maximal height in the chain.
Definition: chain.h:186
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
Definition: chain.cpp:49
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
Definition: chain.h:166
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:86
const CBlock & GenesisBlock() const
Definition: chainparams.h:112
bool DefaultConsistencyChecks() const
Default value for -checkmempool and -checkblockindex argument.
Definition: chainparams.h:114
const ChainTxData & TxData() const
Definition: chainparams.h:158
bool IsTestChain() const
If this chain is exclusively used for testing.
Definition: chainparams.h:118
uint16_t GetDefaultPort() const
Definition: chainparams.h:101
void UnregisterBackgroundSignalScheduler()
Unregister a CScheduler to give callbacks which should run in the background - these callbacks will n...
void RegisterBackgroundSignalScheduler(CScheduler &scheduler)
Register a CScheduler to give callbacks which should run in the background (may only be called once)
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
bool IsValid() const
Definition: netaddress.cpp:474
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:545
std::string ToStringIPPort() const
uint16_t GetPort() const
static const int DEFAULT_ZMQ_SNDHWM
static std::unique_ptr< CZMQNotificationInterface > Create(std::function< bool(CBlock &, const CBlockIndex &)> get_block_by_index)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:734
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:833
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:1186
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:1463
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
Definition: validation.h:1437
std::thread m_thread_load
Definition: validation.h:1324
kernel::Notifications & GetNotifications() const
Definition: validation.h:1294
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:1318
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1444
bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
The state of a background sync (for net processing)
Definition: validation.h:1451
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
Definition: validation.h:1275
const CChainParams & GetParams() const
Definition: validation.h:1279
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1438
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1403
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1327
Definition: config.h:19
virtual uint64_t GetMaxBlockSize() const =0
virtual const CChainParams & GetChainParams() const =0
virtual bool SetMaxBlockSize(uint64_t maxBlockSize)=0
virtual void SetCashAddrEncoding(bool)=0
Different type to mark Mutex at global scope.
Definition: sync.h:144
A writer stream (for serialization) that computes a 256-bit hash.
Definition: hash.h:100
static bool TryParse(const std::string &str, NetWhitebindPermissions &output, bilingual_str &error)
static bool TryParse(const std::string &str, NetWhitelistPermissions &output, ConnectionDirection &output_connection_direction, bilingual_str &error)
static std::unique_ptr< PeerManager > make(CConnman &connman, AddrMan &addrman, BanMan *banman, ChainstateManager &chainman, CTxMemPool &pool, avalanche::Processor *const avalanche, Options opts)
Class for registering and managing all RPC calls.
Definition: server.h:40
virtual void AddWalletOptions(ArgsManager &argsman) const =0
Get wallet help string.
virtual void Construct(node::NodeContext &node) const =0
Add wallets that should be opened to list of chain clients.
virtual bool ParameterInteraction() const =0
Check wallet parameter interaction.
static std::unique_ptr< Processor > MakeProcessor(const ArgsManager &argsman, interfaces::Chain &chain, CConnman *connman, ChainstateManager &chainman, CTxMemPool *mempoolIn, CScheduler &scheduler, bilingual_str &error)
Definition: processor.cpp:224
std::string ToString() const
Definition: uint256.h:80
std::string GetHex() const
Definition: uint256.cpp:16
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:30
A base class defining functions for notifying about certain kernel events.
virtual void fatalError(const std::string &debug_message, const bilingual_str &user_message={})
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
Definition: blockstorage.h:107
bool CheckBlockDataAvailability(const CBlockIndex &upper_block LIFETIMEBOUND, const CBlockIndex &lower_block LIFETIMEBOUND) EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetFirstBlock(const CBlockIndex &upper_block LIFETIMEBOUND, std::function< bool(BlockStatus)> status_test, const CBlockIndex *lower_block=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(boo m_have_pruned)
Check if all blocks in the [upper_block, lower_block] range have data available.
Definition: blockstorage.h:421
CBlockIndex * LookupBlockIndex(const BlockHash &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool IsPruneMode() const
Whether running in -prune mode.
Definition: blockstorage.h:359
bool IsValid() const
Definition: netbase.h:58
256-bit opaque blob.
Definition: uint256.h:129
std::string FormatVersion(int nVersion)
std::string FormatUserAgent(const std::string &name, const std::string &version, const std::vector< std::string > &comments)
Format the subversion field according to BIP 14 spec.
static constexpr int CLIENT_VERSION
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
Definition: clientversion.h:38
const std::string CLIENT_NAME
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
static constexpr bool DEFAULT_COINSTATSINDEX
static const uint64_t DEFAULT_MAX_BLOCK_SIZE
Default setting for maximum allowed size for a block, in bytes.
Definition: consensus.h:20
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:7
void SetupCurrencyUnitOptions(ArgsManager &argsman)
Definition: currencyunit.cpp:9
bilingual_str AmountErrMsg(const std::string &optname, const std::string &strValue)
Definition: error.cpp:53
bilingual_str ResolveErrMsg(const std::string &optname, const std::string &strBind)
Definition: error.cpp:44
bool LockDirectory(const fs::path &directory, const std::string lockfile_name, bool probe_only)
Definition: fs_helpers.cpp:58
bool DirIsWritable(const fs::path &directory)
Definition: fs_helpers.cpp:98
int RaiseFileDescriptorLimit(int nMinFD)
This function tries to raise the file descriptor limit to the requested number.
Definition: fs_helpers.cpp:183
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: fs_helpers.cpp:112
void InterruptHTTPRPC()
Interrupt HTTP RPC subsystem.
Definition: httprpc.cpp:477
void StopHTTPRPC()
Stop HTTP RPC subsystem.
Definition: httprpc.cpp:481
bool StartHTTPRPC(HTTPRPCRequestProcessor &httpRPCRequestProcessor)
Start HTTP RPC subsystem.
Definition: httprpc.cpp:456
void StartREST(const std::any &context)
Start HTTP REST subsystem.
Definition: rest.cpp:827
void StopREST()
Stop HTTP REST subsystem.
Definition: rest.cpp:839
void InterruptREST()
Interrupt RPC REST subsystem.
Definition: rest.cpp:837
void InterruptHTTPServer()
Interrupt HTTP server threads.
Definition: httpserver.cpp:555
void StartHTTPServer()
Start HTTP server.
Definition: httpserver.cpp:544
void StopHTTPServer()
Stop HTTP server.
Definition: httpserver.cpp:566
bool InitHTTPServer(Config &config)
Initialize HTTP server.
Definition: httpserver.cpp:477
static const int DEFAULT_HTTP_SERVER_TIMEOUT
Definition: httpserver.h:14
static const int DEFAULT_HTTP_WORKQUEUE
Definition: httpserver.h:13
static const int DEFAULT_HTTP_THREADS
Definition: httpserver.h:12
Common init functions shared by bitcoin-node, bitcoin-wallet, etc.
static const char * BITCOIN_PID_FILENAME
The PID file facilities.
Definition: init.cpp:154
static bool CreatePidFile(const ArgsManager &args)
Definition: init.cpp:161
static const bool DEFAULT_PROXYRANDOMIZE
Definition: init.cpp:134
void Interrupt(NodeContext &node)
Interrupt threads.
Definition: init.cpp:201
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:1761
bool AppInitLockDataDirectory()
Lock bitcoin data directory.
Definition: init.cpp:2149
void SetupServerArgs(NodeContext &node)
Register all arguments with the ArgsManager.
Definition: init.cpp:425
static bool AppInitServers(Config &config, HTTPRPCRequestProcessor &httpRPCRequestProcessor, NodeContext &node)
Definition: init.cpp:1602
#define MIN_CORE_FILEDESCRIPTORS
Definition: init.cpp:144
static bool fHaveGenesis
Definition: init.cpp:1577
void Shutdown(NodeContext &node)
Definition: init.cpp:225
static void HandleSIGTERM(int)
Signal handlers are very limited in what they are allowed to do.
Definition: init.cpp:387
static GlobalMutex g_genesis_wait_mutex
Definition: init.cpp:1578
static void OnRPCStarted()
Definition: init.cpp:413
static constexpr bool DEFAULT_USEASHADDR
Definition: init.cpp:137
static void HandleSIGHUP(int)
Definition: init.cpp:391
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin: Basic context setup.
Definition: init.cpp:1788
static fs::path GetPidFile(const ArgsManager &args)
Definition: init.cpp:156
static std::condition_variable g_genesis_wait_cv
Definition: init.cpp:1579
bool AppInitMain(Config &config, RPCServer &rpcServer, HTTPRPCRequestProcessor &httpRPCRequestProcessor, NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin main initialization.
Definition: init.cpp:2171
static constexpr bool DEFAULT_CHRONIK
Definition: init.cpp:136
bool StartIndexBackgroundSync(NodeContext &node)
Validates requirements to run the indexes and spawns each index initial sync thread.
Definition: init.cpp:3129
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:2161
static const char * DEFAULT_ASMAP_FILENAME
Definition: init.cpp:147
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:1627
static void BlockNotifyGenesisWait(const CBlockIndex *pBlockIndex)
Definition: init.cpp:1581
static void OnRPCStopped()
Definition: init.cpp:418
static bool LockDataDirectory(bool probeOnly)
Definition: init.cpp:2117
static void registerSignalHandler(int signal, void(*handler)(int))
Definition: init.cpp:403
bool AppInitParameterInteraction(Config &config, const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:1830
static const bool DEFAULT_REST_ENABLE
Definition: init.cpp:135
static boost::signals2::connection rpc_notify_block_change_connection
Definition: init.cpp:412
static void new_handler_terminate()
Definition: init.cpp:1777
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:2133
static const std::string HEADERS_TIME_FILE_NAME
Definition: init.cpp:149
static constexpr bool DEFAULT_DAEMON
Default value for -daemon option.
Definition: init.h:16
static constexpr bool DEFAULT_DAEMONWAIT
Default value for -daemonwait option.
Definition: init.h:18
static constexpr size_t DEFAULT_DB_CACHE_BATCH
Default LevelDB write batch size.
Definition: caches.h:16
BCLog::Logger & LogInstance()
Definition: logging.cpp:25
#define LogWarning(...)
Definition: logging.h:416
#define LogPrint(category,...)
Definition: logging.h:452
#define LogInfo(...)
Definition: logging.h:413
#define LogPrintf(...)
Definition: logging.h:424
void StartMapPort(bool use_upnp, bool use_natpmp)
Definition: mapport.cpp:362
void StopMapPort()
Definition: mapport.cpp:368
void InterruptMapPort()
Definition: mapport.cpp:365
static constexpr bool DEFAULT_NATPMP
Definition: mapport.h:17
static constexpr bool DEFAULT_UPNP
Definition: mapport.h:11
std::optional< bilingual_str > ApplyArgsManOptions(const ArgsManager &argsman, const CChainParams &chainparams, MemPoolOptions &mempool_opts)
Overlay the options set in argsman on top of corresponding members in mempool_opts.
static constexpr unsigned int DEFAULT_MAX_MEMPOOL_SIZE_MB
Default for -maxmempool, maximum megabytes of mempool memory usage.
static constexpr unsigned int DEFAULT_MEMPOOL_EXPIRY_HOURS
Default for -mempoolexpiry, expiration time for mempool transactions in hours.
std::string FormatMoney(const Amount amt)
Do not use these functions to represent or parse monetary amounts to or from JSON but use AmountFromV...
Definition: moneystr.cpp:13
bool ParseMoney(const std::string &money_string, Amount &nRet)
Parse an amount denoted in full coins.
Definition: moneystr.cpp:37
constexpr auto RATELIMIT_WINDOW
Definition: logging.h:120
constexpr bool DEFAULT_LOGRATELIMIT
Definition: logging.h:121
constexpr uint64_t RATELIMIT_MAX_BYTES
Definition: logging.h:118
@ RPC
Definition: logging.h:76
void OnStarted(std::function< void()> slot)
Definition: server.cpp:113
void OnStopped(std::function< void()> slot)
Definition: server.cpp:117
static constexpr Amount PROOF_DUST_THRESHOLD
Minimum amount per utxo.
Definition: proof.h:41
static auto quoted(const std::string &s)
Definition: fs.h:112
static bool exists(const path &p)
Definition: fs.h:107
static std::string PathToString(const path &path)
Convert path object to byte string.
Definition: fs.h:147
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:170
std::string get_filesystem_error_message(const fs::filesystem_error &e)
Definition: fs.cpp:142
void AddLoggingArgs(ArgsManager &argsman)
Definition: common.cpp:22
void SetLoggingCategories(const ArgsManager &args)
Definition: common.cpp:177
bool StartLogging(const ArgsManager &args)
Definition: common.cpp:205
void SetLoggingLevel(const ArgsManager &args)
Definition: common.cpp:147
void SetLoggingOptions(const ArgsManager &args)
Definition: common.cpp:124
void LogPackageVersion()
Definition: common.cpp:252
std::unique_ptr< Chain > MakeChain(node::NodeContext &node, const CChainParams &params)
Return implementation of Chain interface.
Definition: interfaces.cpp:832
Definition: init.h:28
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
util::Result< void > SanityChecks(const Context &)
Ensure a usable environment with all necessary library support.
Definition: checks.cpp:14
Definition: init.h:31
@ FAILURE_FATAL
Fatal error which should not prompt to reindex.
@ FAILURE
Generic failure which reindexing may fix.
CacheSizes CalculateCacheSizes(const ArgsManager &args, size_t n_indexes)
Definition: caches.cpp:26
fs::path MempoolPath(const ArgsManager &argsman)
bool ShouldPersistMempool(const ArgsManager &argsman)
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:171
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:275
static constexpr bool DEFAULT_PERSIST_MEMPOOL
Default for -persistmempool, indicating whether the node should attempt to automatically load the mem...
std::atomic_bool fReindex
void ImportBlocks(ChainstateManager &chainman, avalanche::Processor *const avalanche, std::vector< fs::path > vImportFiles)
void ApplyArgsManOptions(const ArgsManager &args, const Config &config, BlockFitter::Options &options)
Apply options from ArgsManager to BlockFitter options.
Definition: blockfitter.cpp:40
void format(std::ostream &out, const char *fmt, const Args &...args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1112
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:90
void TraceThread(std::string_view thread_name, std::function< void()> thread_func)
A wrapper for do-something-once thread functions.
Definition: thread.cpp:14
void ThreadRename(std::string &&)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name.
Definition: threadnames.cpp:48
uint16_t GetListenPort()
Definition: net.cpp:139
bool fDiscover
Definition: net.cpp:127
bool fListen
Definition: net.cpp:128
void SetReachable(enum Network net, bool reachable)
Mark a network as reachable or unreachable (no automatic connects to it)
Definition: net.cpp:319
bool AddLocal(const CService &addr, int nScore)
Definition: net.cpp:280
void Discover()
Look up IP addresses from all interfaces on the machine and add them to the list of local addresses t...
Definition: net.cpp:2299
static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS
The maximum number of peer connections to maintain.
Definition: net.h:92
static const unsigned int MAX_SUBVERSION_LENGTH
Maximum length of the user agent string in version message.
Definition: net.h:68
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:75
static const size_t DEFAULT_MAXSENDBUFFER
Definition: net.h:106
static const int NUM_FDS_MESSAGE_CAPTURE
Number of file descriptors required for message capture.
Definition: net.h:100
static const bool DEFAULT_BLOCKSONLY
Default for blocks only.
Definition: net.h:96
static const bool DEFAULT_FORCEDNSSEED
Definition: net.h:102
static constexpr uint64_t DEFAULT_MAX_UPLOAD_TARGET
The default for -maxuploadtarget.
Definition: net.h:94
static const size_t DEFAULT_MAXRECEIVEBUFFER
Definition: net.h:105
static const int DEFAULT_MAX_AVALANCHE_OUTBOUND_CONNECTIONS
Maximum number of avalanche enabled outgoing connections by default.
Definition: net.h:82
static const bool DEFAULT_FIXEDSEEDS
Definition: net.h:104
static const int MAX_FEELER_CONNECTIONS
Maximum number of feeler connections.
Definition: net.h:84
static const bool DEFAULT_LISTEN
-listen default
Definition: net.h:86
static const int64_t DEFAULT_PEER_CONNECT_TIMEOUT
-peertimeout default
Definition: net.h:98
static const bool DEFAULT_DNSSEED
Definition: net.h:103
static const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS
Maximum number of automatic outgoing nodes over which we'll relay everything (blocks,...
Definition: net.h:73
@ LOCAL_MANUAL
Definition: net.h:165
static const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS
Maximum number of block-relay-only outgoing connections.
Definition: net.h:77
const std::vector< std::string > NET_PERMISSIONS_DOC
static const bool DEFAULT_WHITELISTFORCERELAY
Default for -whitelistforcerelay.
static const bool DEFAULT_WHITELISTRELAY
Default for -whitelistrelay.
static const uint32_t DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN
Default number of non-mempool transactions to keep around for block reconstruction.
static const uint32_t DEFAULT_MAX_ORPHAN_TRANSACTIONS
Default for -maxorphantx, maximum number of orphan transactions kept in memory.
static const bool DEFAULT_PEERBLOCKFILTERS
Network
A network type.
Definition: netaddress.h:44
@ NET_I2P
I2P.
Definition: netaddress.h:59
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:69
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:56
@ NET_IPV6
IPv6.
Definition: netaddress.h:53
@ NET_IPV4
IPv4.
Definition: netaddress.h:50
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:47
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:90
bool Lookup(const std::string &name, std::vector< CService > &vAddr, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:221
bool fNameLookup
Definition: netbase.cpp:38
int nConnectTimeout
Definition: netbase.cpp:37
bool SetNameProxy(const proxyType &addrProxy)
Set the name proxy to use for all connections to nodes specified by a hostname.
Definition: netbase.cpp:740
bool IsBadPort(uint16_t port)
Determine if a port is "bad" from the perspective of attempting to connect to a node on that port.
Definition: netbase.cpp:869
bool SetProxy(enum Network net, const proxyType &addrProxy)
Definition: netbase.cpp:720
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:135
ConnectionDirection
Definition: netbase.h:32
static const int DEFAULT_NAME_LOOKUP
-dns default
Definition: netbase.h:30
static const int DEFAULT_CONNECT_TIMEOUT
-timeout default
Definition: netbase.h:28
static constexpr size_t MIN_DB_CACHE
min. -dbcache (bytes)
Definition: caches.h:16
static constexpr size_t DEFAULT_DB_CACHE
-dbcache default (bytes)
Definition: caches.h:18
uint32_t nBytesPerSigCheck
Definition: settings.cpp:10
static constexpr uint64_t DEFAULT_MAX_GENERATED_BLOCK_SIZE
Default for -blockmaxsize, which controls the maximum size of block the mining code will create.
Definition: policy.h:25
static constexpr Amount DUST_RELAY_TX_FEE(1000 *SATOSHI)
Min feerate for defining dust.
static constexpr bool DEFAULT_PERMIT_BAREMULTISIG
Default for -permitbaremultisig.
Definition: policy.h:56
static constexpr Amount DEFAULT_MIN_RELAY_TX_FEE_PER_KB(1000 *SATOSHI)
Default for -minrelaytxfee, minimum relay fee for transactions.
static constexpr unsigned int DEFAULT_BYTES_PER_SIGCHECK
Default for -bytespersigcheck .
Definition: policy.h:54
static constexpr Amount DEFAULT_BLOCK_MIN_TX_FEE_PER_KB(1000 *SATOSHI)
Default for -blockmintxfee, which sets the minimum feerate for a transaction in blocks created by min...
static constexpr std::chrono::milliseconds AVALANCHE_DEFAULT_QUERY_TIMEOUT
How long before we consider that a query timed out.
Definition: processor.h:65
static constexpr int AVALANCHE_DEFAULT_STAKE_UTXO_CONFIRMATIONS
Minimum number of confirmations before a stake utxo is mature enough to be included into a proof.
Definition: proof.h:36
ServiceFlags
nServices flags.
Definition: protocol.h:336
@ NODE_NETWORK_LIMITED
Definition: protocol.h:366
@ NODE_BLOOM
Definition: protocol.h:353
@ NODE_NETWORK
Definition: protocol.h:343
@ NODE_COMPACT_FILTERS
Definition: protocol.h:361
@ NODE_AVALANCHE
Definition: protocol.h:381
void RandAddPeriodic() noexcept
Gather entropy from various expensive sources, and feed them to the PRNG state.
Definition: random.cpp:648
static void RegisterAllRPCCommands(const Config &config, RPCServer &rpcServer, CRPCTable &rpcTable)
Register all context-sensitive RPC commands.
Definition: register.h:42
const char * prefix
Definition: rest.cpp:812
bool(* handler)(Config &config, const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:813
const char * name
Definition: rest.cpp:47
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.
Definition: util.cpp:25
static constexpr bool DEFAULT_RPC_DOC_CHECK
Definition: util.h:44
static constexpr bool DEFAULT_ENABLE_RTT
Default for -enablertt.
Definition: rtt.h:22
static constexpr size_t DEFAULT_SCRIPT_EXECUTION_CACHE_BYTES
Definition: scriptcache.h:102
void SetRPCWarmupFinished()
Mark warmup as done.
Definition: server.cpp:394
void StartRPC()
Definition: server.cpp:349
void StopRPC()
Definition: server.cpp:366
void InterruptRPC()
Definition: server.cpp:355
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
Definition: server.cpp:389
CRPCTable tableRPC
Definition: server.cpp:681
void RpcInterruptionPoint()
Throw JSONRPCError if RPC is not running.
Definition: server.cpp:383
bool ShutdownRequested()
Returns true if a shutdown is requested, false otherwise.
Definition: shutdown.cpp:29
void StartShutdown()
Request shutdown of the application.
Definition: shutdown.cpp:16
void AbortShutdown()
Clear shutdown flag.
Definition: shutdown.cpp:25
static constexpr size_t DEFAULT_SIGNATURE_CACHE_BYTES
Definition: sigcache.h:26
static const unsigned int MAX_OP_RETURN_RELAY
Default setting for nMaxDatacarrierBytes.
Definition: standard.h:36
static const bool DEFAULT_ACCEPT_DATACARRIER
Definition: standard.h:17
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
Definition: strencodings.h:27
void ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition: string.cpp:10
auto Join(const std::vector< T > &list, const BaseType &separator, UnaryOp unary_op) -> decltype(unary_op(list.at(0)))
Join a list of items.
Definition: string.h:63
Definition: amount.h:19
static constexpr Amount zero() noexcept
Definition: amount.h:32
A BlockHash is a unqiue identifier for a block.
Definition: blockhash.h:13
int m_max_outbound_block_relay
Definition: net.h:830
unsigned int nReceiveFloodSize
Definition: net.h:838
int m_max_outbound_full_relay
Definition: net.h:829
std::vector< NetWhitebindPermissions > vWhiteBinds
Definition: net.h:844
uint64_t nMaxOutboundLimit
Definition: net.h:839
CClientUIInterface * uiInterface
Definition: net.h:834
std::vector< NetWhitelistPermissions > vWhitelistedRangeIncoming
Definition: net.h:842
int m_max_avalanche_outbound
Definition: net.h:831
std::vector< CService > onion_binds
Definition: net.h:846
int nMaxFeeler
Definition: net.h:833
std::vector< std::string > m_specified_outgoing
Definition: net.h:851
bool whitelist_relay
Definition: net.h:855
int nMaxConnections
Definition: net.h:828
ServiceFlags nLocalServices
Definition: net.h:827
std::vector< std::string > m_added_nodes
Definition: net.h:852
int64_t m_peer_connect_timeout
Definition: net.h:840
std::vector< CService > vBinds
Definition: net.h:845
unsigned int nSendBufferMaxSize
Definition: net.h:837
bool m_i2p_accept_incoming
Definition: net.h:853
std::vector< std::string > vSeedNodes
Definition: net.h:841
BanMan * m_banman
Definition: net.h:836
bool m_use_addrman_outgoing
Definition: net.h:850
std::vector< NetEventsInterface * > m_msgproc
Definition: net.h:835
bool whitelist_forcerelay
Definition: net.h:854
bool bind_on_any
True if the user did not specify -bind= or -whitebind= and thus we should bind on 0....
Definition: net.h:849
std::vector< NetWhitelistPermissions > vWhitelistedRangeOutgoing
Definition: net.h:843
int nMaxAddnode
Definition: net.h:832
static const Currency & get()
Definition: amount.cpp:18
std::string ticker
Definition: amount.h:150
std::string name
Definition: base.h:21
bool synced
Definition: base.h:22
BlockHash best_block_hash
Definition: base.h:24
Bilingual messages:
Definition: translation.h:17
bool empty() const
Definition: translation.h:27
std::string translated
Definition: translation.h:19
std::string original
Definition: translation.h:18
Block and header tip information.
Definition: node.h:50
An options struct for ChainstateManager, more ergonomically referred to as ChainstateManager::Options...
Context struct holding the kernel library's logically global state, and passed to external libbitcoin...
Definition: context.h:22
Options struct containing options for constructing a CTxMemPool.
int check_ratio
The ratio used to determine how often sanity checks will run.
std::function< void()> coins_error_cb
Definition: chainstate.h:39
std::function< bool()> check_interrupt
Definition: chainstate.h:38
NodeContext struct containing references to chain state and connection state.
Definition: context.h:48
#define WAIT_LOCK(cs, name)
Definition: sync.h:317
#define LOCK(cs)
Definition: sync.h:306
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:357
#define TRY_LOCK(cs, name)
Definition: sync.h:314
std::string SysErrorString(int err)
Return system error string from errno value.
Definition: syserror.cpp:14
bool SetupNetworking()
Definition: system.cpp:99
int GetNumCores()
Return the number of cores available on the current system.
Definition: system.cpp:112
static int count
Definition: tests.c:31
int64_t GetTimeMillis()
Returns the system time (not mockable)
Definition: time.cpp:101
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:89
NodeClock::time_point GetAdjustedTime()
Definition: timedata.cpp:35
static const int64_t DEFAULT_MAX_TIME_ADJUSTMENT
Definition: timedata.h:16
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1202
CService DefaultOnionServiceTarget()
Definition: torcontrol.cpp:870
const std::string DEFAULT_TOR_CONTROL
Default control port.
Definition: torcontrol.cpp:38
void InterruptTorControl()
Definition: torcontrol.cpp:852
void StartTorControl(CService onion_service_target)
Definition: torcontrol.cpp:833
void StopTorControl()
Definition: torcontrol.cpp:862
static const bool DEFAULT_LISTEN_ONION
Definition: torcontrol.h:16
bilingual_str _(const char *psz)
Translation function.
Definition: translation.h:68
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:36
util::Result< void > CheckLegacyTxindex(CBlockTreeDB &block_tree_db)
Definition: txdb.cpp:36
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
Definition: txindex.cpp:16
static constexpr bool DEFAULT_TXINDEX
Definition: txindex.h:15
CClientUIInterface uiInterface
void InitWarning(const bilingual_str &str)
Show warning message.
bool InitError(const bilingual_str &str)
Show error message.
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
void StartScriptCheckWorkerThreads(int threads_num)
Run instances of script checking worker threads.
std::condition_variable g_best_block_cv
Definition: validation.cpp:120
double GuessVerificationProgress(const ChainTxData &data, const CBlockIndex *pindex)
Guess how far we are in the verification process at the given block index require cs_main if pindex h...
void StopScriptCheckWorkerThreads()
Stop all of the script checking worker threads.
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:101
assert(!tx.IsCoinBase())
static constexpr int DEFAULT_CHECKLEVEL
Definition: validation.h:102
static const uint64_t MIN_DISK_SPACE_FOR_BLOCK_FILES
Require that user allocate at least 550 MiB for block & undo files (blk???.dat and rev?...
Definition: validation.h:116
static const unsigned int MIN_BLOCKS_TO_KEEP
Block files containing a block-height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pr...
Definition: validation.h:100
static const int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
Definition: validation.h:90
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:119
static const int DEFAULT_SCRIPTCHECK_THREADS
-par default (number of script-checking threads, 0 = auto)
Definition: validation.h:92
static const signed int DEFAULT_CHECKBLOCKS
Definition: validation.h:101
static const bool DEFAULT_PEERBLOOMFILTERS
Definition: validation.h:94
CMainSignals & GetMainSignals()
void UnregisterAllValidationInterfaces()
Unregister all subscribers.
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
void RegisterValidationInterface(CValidationInterface *callbacks)
Register subscriber.
void SyncWithValidationInterfaceQueue()
This is a synonym for the following, which asserts certain locks are not held: std::promise<void> pro...
static constexpr uint32_t AVALANCHE_VOTE_STALE_FACTOR
Scaling factor applied to confidence to determine staleness threshold.
Definition: voterecord.h:35
static constexpr uint32_t AVALANCHE_VOTE_STALE_THRESHOLD
Number of votes before a record may be considered as stale.
Definition: voterecord.h:22
const WalletInitInterface & g_wallet_init_interface
Definition: init.cpp:41
std::unique_ptr< CZMQNotificationInterface > g_zmq_notification_interface
void RegisterZMQRPCCommands(CRPCTable &t)
Definition: zmqrpc.cpp:68