Bitcoin ABC 0.33.11
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 <clientversion.h>
27#include <common/args.h>
28#include <common/messages.h>
29#include <config.h>
30#include <consensus/amount.h>
31#include <currencyunit.h>
32#include <flatfile.h>
33#include <hash.h>
34#include <httprpc.h>
35#include <httpserver.h>
38#include <index/txindex.h>
39#include <init/common.h>
40#include <interfaces/chain.h>
41#include <interfaces/node.h>
42#include <kernel/caches.h>
43#include <mapport.h>
44#include <mempool_args.h>
45#include <net.h>
46#include <net_permissions.h>
47#include <net_processing.h>
48#include <netbase.h>
50#include <node/blockstorage.h>
51#include <node/caches.h>
52#include <node/chainstate.h>
54#include <node/context.h>
57#include <node/miner.h>
58#include <node/peerman_args.h>
59#include <node/ui_interface.h>
60#include <policy/block/rtt.h>
61#include <policy/policy.h>
62#include <policy/settings.h>
63#include <rpc/blockchain.h>
64#include <rpc/register.h>
65#include <rpc/server.h>
66#include <rpc/util.h>
67#include <scheduler.h>
68#include <script/scriptcache.h>
69#include <script/sigcache.h>
70#include <script/standard.h>
71#include <shutdown.h>
72#include <sync.h>
73#include <timedata.h>
74#include <torcontrol.h>
75#include <txdb.h>
76#include <txmempool.h>
77#include <util/asmap.h>
78#include <util/chaintype.h>
79#include <util/check.h>
80#include <util/fs.h>
81#include <util/fs_helpers.h>
82#include <util/moneystr.h>
83#include <util/string.h>
84#include <util/syserror.h>
85#include <util/thread.h>
86#include <util/threadnames.h>
87#include <util/translation.h>
88#include <validation.h>
89#include <validationinterface.h>
90#include <walletinitinterface.h>
91
92#include <boost/signals2/signal.hpp>
93
94#if ENABLE_CHRONIK
95#include <chronik-cpp/chronik.h>
96#endif
97
98#if ENABLE_ZMQ
101#include <zmq/zmqrpc.h>
102#endif
103
104#ifndef WIN32
105#include <cerrno>
106#include <csignal>
107#include <sys/stat.h>
108#endif
109#include <algorithm>
110#include <condition_variable>
111#include <cstdint>
112#include <cstdio>
113#include <fstream>
114#include <functional>
115#include <set>
116#include <string>
117#include <thread>
118#include <vector>
119
123
126
139using util::Join;
140using util::ReplaceAll;
141
142static const bool DEFAULT_PROXYRANDOMIZE = true;
143static const bool DEFAULT_REST_ENABLE = false;
144static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
145static constexpr bool DEFAULT_CHRONIK = false;
146static constexpr bool DEFAULT_USEASHADDR = true;
147
148#ifdef WIN32
149// Win32 LevelDB doesn't use filedescriptors, and the ones used for accessing
150// block files don't count towards the fd_set size limit anyway.
151#define MIN_CORE_FILEDESCRIPTORS 0
152#else
153#define MIN_CORE_FILEDESCRIPTORS 150
154#endif
155
156static const char *DEFAULT_ASMAP_FILENAME = "ip_asn.map";
157
158static const std::string HEADERS_TIME_FILE_NAME{"headerstime.dat"};
159
163static const char *BITCOIN_PID_FILENAME = "bitcoind.pid";
164
165static fs::path GetPidFile(const ArgsManager &args) {
166 return AbsPathForConfigVal(args,
167 args.GetPathArg("-pid", BITCOIN_PID_FILENAME));
168}
169
170[[nodiscard]] static bool CreatePidFile(const ArgsManager &args) {
171 std::ofstream file{GetPidFile(args)};
172 if (file) {
173#ifdef WIN32
174 tfm::format(file, "%d\n", GetCurrentProcessId());
175#else
176 tfm::format(file, "%d\n", getpid());
177#endif
178 return true;
179 } else {
180 return InitError(strprintf(_("Unable to create the PID file '%s': %s"),
182 SysErrorString(errno)));
183 }
184}
185
187//
188// Shutdown
189//
190
191//
192// Thread management and startup/shutdown:
193//
194// The network-processing threads are all part of a thread group created by
195// AppInit() or the Qt main() function.
196//
197// A clean exit happens when StartShutdown() or the SIGTERM signal handler sets
198// fRequestShutdown, which makes main thread's WaitForShutdown() interrupts the
199// thread group.
200// And then, WaitForShutdown() makes all other on-going threads in the thread
201// group join the main thread.
202// Shutdown() is then called to clean up database connections, and stop other
203// threads that should only be stopped after the main network-processing threads
204// have exited.
205//
206// Shutdown for Qt is very similar, only it uses a QTimer to detect
207// ShutdownRequested() getting set, and then does the normal Qt shutdown thing.
208//
209
213 InterruptRPC();
217 if (node.avalanche) {
218 // Avalanche needs to be stopped before we interrupt the thread group as
219 // the scheduler will stop working then.
220 node.avalanche->stopEventLoop();
221 }
222 if (node.connman) {
223 node.connman->Interrupt();
224 }
225 if (g_txindex) {
226 g_txindex->Interrupt();
227 }
228 ForEachBlockFilterIndex([](BlockFilterIndex &index) { index.Interrupt(); });
229 if (g_coin_stats_index) {
230 g_coin_stats_index->Interrupt();
231 }
232}
233
235 static Mutex g_shutdown_mutex;
236 TRY_LOCK(g_shutdown_mutex, lock_shutdown);
237 if (!lock_shutdown) {
238 return;
239 }
240 LogPrintf("%s: In progress...\n", __func__);
241 Assert(node.args);
242
247 util::ThreadRename("shutoff");
248 if (node.mempool) {
249 node.mempool->AddTransactionsUpdated(1);
250 }
251
252 StopHTTPRPC();
253 StopREST();
254 StopRPC();
256 for (const auto &client : node.chain_clients) {
257 client->flush();
258 }
259 StopMapPort();
260
261 // Because avalanche and the network depend on each other, it is important
262 // to shut them down in this order:
263 // 1. Stop avalanche event loop.
264 // 2. Shutdown network processing.
265 // 3. Destroy avalanche::Processor.
266 // 4. Destroy CConnman
267 if (node.avalanche) {
268 node.avalanche->stopEventLoop();
269 }
270
271 // Because these depend on each-other, we make sure that neither can be
272 // using the other before destroying them.
273 if (node.peerman && node.validation_signals) {
274 node.validation_signals->UnregisterValidationInterface(
275 node.peerman.get());
276 }
277 if (node.connman) {
278 node.connman->Stop();
279 }
280
282
283 // After everything has been shut down, but before things get flushed, stop
284 // scheduler and load block thread.
285 if (node.scheduler) {
286 node.scheduler->stop();
287 }
288 if (node.chainman && node.chainman->m_thread_load.joinable()) {
289 node.chainman->m_thread_load.join();
290 }
291
292 // After the threads that potentially access these pointers have been
293 // stopped, destruct and reset all to nullptr.
294 node.peerman.reset();
295
296 // Destroy various global instances
297 node.avalanche.reset();
298 node.connman.reset();
299 node.banman.reset();
300 node.addrman.reset();
301
302 if (node.mempool && node.mempool->GetLoadTried() &&
303 ShouldPersistMempool(*node.args)) {
304 DumpMempool(*node.mempool, MempoolPath(*node.args));
305 }
306
307 // FlushStateToDisk generates a ChainStateFlushed callback, which we should
308 // avoid missing
309 if (node.chainman) {
310 LOCK(cs_main);
311 for (Chainstate *chainstate : node.chainman->GetAll()) {
312 if (chainstate->CanFlushToDisk()) {
313 chainstate->ForceFlushStateToDisk();
314 }
315 }
316 }
317
318 // After there are no more peers/RPC left to give us new data which may
319 // generate CValidationInterface callbacks, flush them...
320 if (node.validation_signals) {
321 node.validation_signals->FlushBackgroundCallbacks();
322 }
323
324#if ENABLE_CHRONIK
325 if (node.args->GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
326 chronik::Stop();
327 }
328#endif
329
330 // Stop and delete all indexes only after flushing background callbacks.
331 if (g_txindex) {
332 g_txindex->Stop();
333 g_txindex.reset();
334 }
335 if (g_coin_stats_index) {
336 g_coin_stats_index->Stop();
337 g_coin_stats_index.reset();
338 }
339 ForEachBlockFilterIndex([](BlockFilterIndex &index) { index.Stop(); });
341
342 // Any future callbacks will be dropped. This should absolutely be safe - if
343 // missing a callback results in an unrecoverable situation, unclean
344 // shutdown would too. The only reason to do the above flushes is to let the
345 // wallet catch up with our current chain to avoid any strange pruning edge
346 // cases and make next startup faster by avoiding rescan.
347
348 if (node.chainman) {
349 LOCK(cs_main);
350 for (Chainstate *chainstate : node.chainman->GetAll()) {
351 if (chainstate->CanFlushToDisk()) {
352 chainstate->ForceFlushStateToDisk();
353 chainstate->ResetCoinsViews();
354 }
355 }
356
357 node.chainman->DumpRecentHeadersTime(node.chainman->m_options.datadir /
359 }
360 for (const auto &client : node.chain_clients) {
361 client->stop();
362 }
363
364#if ENABLE_ZMQ
366 if (node.validation_signals) {
367 node.validation_signals->UnregisterValidationInterface(
369 }
371 }
372#endif
373
374 node.chain_clients.clear();
375 if (node.validation_signals) {
376 node.validation_signals->UnregisterAllValidationInterfaces();
377 }
378 node.kernel.reset();
379 node.mempool.reset();
380 node.chainman.reset();
381 node.validation_signals.reset();
382 node.scheduler.reset();
383
384 try {
385 if (!fs::remove(GetPidFile(*node.args))) {
386 LogPrintf("%s: Unable to remove PID file: File does not exist\n",
387 __func__);
388 }
389 } catch (const fs::filesystem_error &e) {
390 LogPrintf("%s: Unable to remove PID file: %s\n", __func__,
392 }
393
394 LogPrintf("%s: done\n", __func__);
395}
396
402#ifndef WIN32
403static void HandleSIGTERM(int) {
405}
406
407static void HandleSIGHUP(int) {
408 LogInstance().m_reopen_file = true;
409}
410#else
411static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType) {
413 Sleep(INFINITE);
414 return true;
415}
416#endif
417
418#ifndef WIN32
419static void registerSignalHandler(int signal, void (*handler)(int)) {
420 struct sigaction sa;
421 sa.sa_handler = handler;
422 sigemptyset(&sa.sa_mask);
423 sa.sa_flags = 0;
424 sigaction(signal, &sa, NULL);
425}
426#endif
427
428static boost::signals2::connection rpc_notify_block_change_connection;
429static void OnRPCStarted() {
430 rpc_notify_block_change_connection = uiInterface.NotifyBlockTip_connect(
431 std::bind(RPCNotifyBlockChange, std::placeholders::_2));
432}
433
434static void OnRPCStopped() {
436 RPCNotifyBlockChange(nullptr);
437 g_best_block_cv.notify_all();
438 LogPrint(BCLog::RPC, "RPC stopped.\n");
439}
440
442 assert(!node.args);
443 node.args = &gArgs;
444 ArgsManager &argsman = *node.args;
445
446 SetupHelpOptions(argsman);
448 // server-only for now
449 argsman.AddArg("-help-debug",
450 "Print help message with debugging options and exit", false,
452
453 init::AddLoggingArgs(argsman);
454
455 const auto defaultBaseParams = CreateBaseChainParams(ChainType::MAIN);
456 const auto testnetBaseParams = CreateBaseChainParams(ChainType::TESTNET);
457 const auto regtestBaseParams = CreateBaseChainParams(ChainType::REGTEST);
458 const auto defaultChainParams = CreateChainParams(argsman, ChainType::MAIN);
459 const auto testnetChainParams =
461 const auto regtestChainParams =
463
464 // Hidden Options
465 std::vector<std::string> hidden_args = {
466 "-dbcrashratio",
467 "-forcecompactdb",
468 "-maxaddrtosend",
469 "-parkdeepreorg",
470 "-automaticunparking",
471 "-replayprotectionactivationtime",
472 "-enableminerfund",
473 "-chronikallowpause",
474 "-chronikcors",
475 // GUI args. These will be overwritten by SetupUIArgs for the GUI
476 "-allowselfsignedrootcertificates",
477 "-choosedatadir",
478 "-lang=<lang>",
479 "-min",
480 "-resetguisettings",
481 "-rootcertificates=<file>",
482 "-splash",
483 "-uiplatform",
484 // TODO remove after the May 2026 upgrade
485 "-obolenskyactivationtime",
486 };
487
488 // Set all of the args and their help
489 // When adding new options to the categories, please keep and ensure
490 // alphabetical ordering. Do not translate _(...) -help-debug options, Many
491 // technical terms, and only a very small audience, so is unnecessary stress
492 // to translators.
493 argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY,
495#if defined(HAVE_SYSTEM)
496 argsman.AddArg(
497 "-alertnotify=<cmd>",
498 "Execute command when a relevant alert is received or we see "
499 "a really long fork (%s in cmd is replaced by message)",
501#endif
502 argsman.AddArg(
503 "-assumevalid=<hex>",
504 strprintf(
505 "If this block is in the chain assume that it and its ancestors "
506 "are valid and potentially skip their script verification (0 to "
507 "verify all, default: %s, testnet: %s)",
508 defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(),
509 testnetChainParams->GetConsensus().defaultAssumeValid.GetHex()),
511 argsman.AddArg("-blocksdir=<dir>",
512 "Specify directory to hold blocks subdirectory for *.dat "
513 "files (default: <datadir>)",
515 argsman.AddArg("-fastprune",
516 "Use smaller block files and lower minimum prune height for "
517 "testing purposes",
520#if defined(HAVE_SYSTEM)
521 argsman.AddArg("-blocknotify=<cmd>",
522 "Execute command when the best block changes (%s in cmd is "
523 "replaced by block hash)",
525#endif
526 argsman.AddArg("-blockreconstructionextratxn=<n>",
527 strprintf("Extra transactions to keep in memory for compact "
528 "block reconstructions (default: %u)",
531 argsman.AddArg(
532 "-blocksonly",
533 strprintf("Whether to reject transactions from network peers. "
534 "Disables automatic broadcast and rebroadcast of "
535 "transactions, unless the source peer has the "
536 "'forcerelay' permission. RPC transactions are"
537 " not affected. (default: %u)",
540 argsman.AddArg("-coinstatsindex",
541 strprintf("Maintain coinstats index used by the "
542 "gettxoutsetinfo RPC (default: %u)",
545 argsman.AddArg(
546 "-conf=<file>",
547 strprintf("Specify path to read-only configuration file. Relative "
548 "paths will be prefixed by datadir location. (default: %s)",
551 argsman.AddArg("-datadir=<dir>", "Specify data directory",
553 argsman.AddArg(
554 "-dbbatchsize",
555 strprintf("Maximum database write batch size in bytes (default: %u)",
559 argsman.AddArg("-dbcache=<n>",
560 strprintf("Maximum database cache size <n> MiB (minimum %d, "
561 "default: %d). Make sure you have enough RAM. In "
562 "addition, unused memory allocated to the mempool "
563 "is shared with this cache (see -maxmempool).",
564 MIN_DB_CACHE >> 20, DEFAULT_DB_CACHE >> 20),
566 argsman.AddArg(
567 "-includeconf=<file>",
568 "Specify additional configuration file, relative to the -datadir path "
569 "(only useable from configuration file, not command line)",
571 argsman.AddArg("-allowignoredconf",
572 strprintf("For backwards compatibility, treat an unused %s "
573 "file in the datadir as a warning, not an error.",
576 argsman.AddArg("-loadblock=<file>",
577 "Imports blocks from external file on startup",
579 argsman.AddArg("-maxmempool=<n>",
580 strprintf("Keep the transaction memory pool below <n> "
581 "megabytes (default: %u)",
584 argsman.AddArg("-maxorphantx=<n>",
585 strprintf("Keep at most <n> unconnectable transactions in "
586 "memory (default: %u)",
589 argsman.AddArg("-mempoolexpiry=<n>",
590 strprintf("Do not keep transactions in the mempool longer "
591 "than <n> hours (default: %u)",
594 argsman.AddArg(
595 "-minimumchainwork=<hex>",
596 strprintf(
597 "Minimum work assumed to exist on a valid chain in hex "
598 "(default: %s, testnet: %s)",
599 defaultChainParams->GetConsensus().nMinimumChainWork.GetHex(),
600 testnetChainParams->GetConsensus().nMinimumChainWork.GetHex()),
603 argsman.AddArg(
604 "-par=<n>",
605 strprintf("Set the number of script verification threads (0 = auto, "
606 "up to %d, <0 = leave that many cores free, default: %d)",
609 argsman.AddArg("-persistmempool",
610 strprintf("Whether to save the mempool on shutdown and load "
611 "on restart (default: %u)",
614 argsman.AddArg(
615 "-persistrecentheaderstime",
616 strprintf(
617 "Whether the node stores the recent headers reception time to a "
618 "file and load it upon startup. This is intended for mining nodes "
619 "to overestimate the real time target upon restart (default: %u)",
622 argsman.AddArg(
623 "-pid=<file>",
624 strprintf("Specify pid file. Relative paths will be prefixed "
625 "by a net-specific datadir location. (default: %s)",
628 argsman.AddArg(
629 "-prune=<n>",
630 strprintf("Reduce storage requirements by enabling pruning (deleting) "
631 "of old blocks. This allows the pruneblockchain RPC to be "
632 "called to delete specific blocks and enables automatic "
633 "pruning of old blocks if a target size in MiB is provided. "
634 "This mode is incompatible with -txindex and -rescan. "
635 "Warning: Reverting this setting requires re-downloading the "
636 "entire blockchain. (default: 0 = disable pruning blocks, "
637 "1 = allow manual pruning via RPC, >=%u = automatically "
638 "prune block files to stay under the specified target size "
639 "in MiB)",
640 MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024),
642 argsman.AddArg(
643 "-reindex-chainstate",
644 "Rebuild chain state from the currently indexed blocks. When "
645 "in pruning mode or if blocks on disk might be corrupted, use "
646 "full -reindex instead.",
648 argsman.AddArg(
649 "-reindex",
650 "Rebuild chain state and block index from the blk*.dat files on disk."
651 " This will also rebuild active optional indexes.",
653 argsman.AddArg(
654 "-settings=<file>",
655 strprintf(
656 "Specify path to dynamic settings data file. Can be disabled with "
657 "-nosettings. File is written at runtime and not meant to be "
658 "edited by users (use %s instead for custom settings). Relative "
659 "paths will be prefixed by datadir location. (default: %s)",
662#if HAVE_SYSTEM
663 argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.",
665#endif
666#ifndef WIN32
667 argsman.AddArg(
668 "-sysperms",
669 "Create new files with system default permissions, instead of umask "
670 "077 (only effective with disabled wallet functionality)",
672#else
673 hidden_args.emplace_back("-sysperms");
674#endif
675 argsman.AddArg("-txindex",
676 strprintf("Maintain a full transaction index, used by the "
677 "getrawtransaction rpc call (default: %d)",
680#if ENABLE_CHRONIK
681 argsman.AddArg(
682 "-chronik",
683 strprintf("Enable the Chronik indexer, which can be read via a "
684 "dedicated HTTP/Protobuf interface (default: %d)",
687 argsman.AddArg(
688 "-chronikbind=<addr>[:port]",
689 strprintf(
690 "Bind the Chronik indexer to the given address to listen for "
691 "HTTP/Protobuf connections to access the index. Unlike the "
692 "JSON-RPC, it's ok to have this publicly exposed on the internet. "
693 "This option can be specified multiple times (default: %s; default "
694 "port: %u, testnet: %u, regtest: %u)",
695 Join(chronik::DEFAULT_BINDS, ", "),
696 defaultBaseParams->ChronikPort(), testnetBaseParams->ChronikPort(),
697 regtestBaseParams->ChronikPort()),
701 argsman.AddArg("-chroniktokenindex",
702 "Enable token indexing in Chronik (default: 1)",
704 argsman.AddArg("-chroniklokadidindex",
705 "Enable LOKAD ID indexing in Chronik (default: 1)",
707 argsman.AddArg("-chronikreindex",
708 "Reindex the Chronik indexer from genesis, but leave the "
709 "other indexes untouched",
711 argsman.AddArg(
712 "-chroniktxnumcachebuckets",
713 strprintf(
714 "Tuning param of the TxNumCache, specifies how many buckets "
715 "to use on the belt. Caution against setting this too high, "
716 "it may slow down indexing. Set to 0 to disable. (default: %d)",
717 chronik::DEFAULT_TX_NUM_CACHE_BUCKETS),
720 argsman.AddArg(
721 "-chroniktxnumcachebucketsize",
722 strprintf(
723 "Tuning param of the TxNumCache, specifies the size of each bucket "
724 "on the belt. Unlike the number of buckets, this may be increased "
725 "without much danger of slowing the indexer down. The total cache "
726 "size will be `num_buckets * bucket_size * 40B`, so by default the "
727 "cache will require %dkB of memory. (default: %d)",
728 chronik::DEFAULT_TX_NUM_CACHE_BUCKETS *
729 chronik::DEFAULT_TX_NUM_CACHE_BUCKET_SIZE * 40 / 1000,
730 chronik::DEFAULT_TX_NUM_CACHE_BUCKET_SIZE),
733 argsman.AddArg("-chronikperfstats",
734 "Output some performance statistics (e.g. num cache hits, "
735 "seconds spent) into a <datadir>/perf folder. (default: 0)",
737 argsman.AddArg("-chronikscripthashindex",
738 "Enable the scripthash index for the Chronik indexer "
739 "(default: 1 if chronikelectrumbind is set, 0 otherwise) ",
741 argsman.AddArg(
742 "-chronikelectrumbind=<addr>[:port][:t|s|w|y]",
743 strprintf(
744 "Bind the Chronik Electrum interface to the given "
745 "address:port:protocol. If not set, the Electrum interface will "
746 "not start. This option can be specified multiple times. The "
747 "protocol is selected by a single letter, where 't' means TCP, 's' "
748 "means TLS, 'w' means WS and 'y' means WSS. If TLS and/or WSS is "
749 "selected, the certificate chain and private key must both be "
750 "passed (see -chronikelectrumcert and -chronikelectrumprivkey "
751 "(default: disabled; default port: %u, testnet: %u, regtest: %u; "
752 "default protocol: TLS)",
753 defaultBaseParams->ChronikElectrumPort(),
754 testnetBaseParams->ChronikElectrumPort(),
755 regtestBaseParams->ChronikElectrumPort()),
759 argsman.AddArg(
760 "-chronikelectrumcert",
761 "Path to the certificate file to be used by the Chronik Electrum "
762 "server when the TLS protocol is selected. The file should contain "
763 "the whole certificate chain (typically a .pem file). If used the "
764 "-chronikelectrumprivkey must be set as well.",
768 argsman.AddArg(
769 "-chronikelectrumprivkey",
770 "Path to the private key file to be used by the Chronik Electrum "
771 "server when the TLS protocol is selected. If used the "
772 "-chronikelectrumcert must be set as well.",
776 argsman.AddArg(
777 "-chronikelectrumurl",
778 "The URL to advertise to the Electrum peers. This needs to be set to "
779 "the server public URL to instruct the other Electrum peers that they "
780 "don't have to drop the connection. See the 'hosts' key in "
781 "https://electrum-cash-protocol.readthedocs.io/en/latest/"
782 "protocol-methods.html#server.features (default: 127.0.0.1).",
786 argsman.AddArg(
787 "-chronikelectrummaxhistory",
788 strprintf("Largest tx history we are willing to serve. (default: %u)",
789 chronik::DEFAULT_ELECTRUM_MAX_HISTORY),
792 argsman.AddArg(
793 "-chronikelectrumdonationaddress",
794 strprintf(
795 "The server donation address. No checks are done on the server "
796 "side to ensure this is a valid eCash address, it is just relayed "
797 "to clients verbatim as a text string (%u characters maximum).",
798 chronik::MAX_LENGTH_DONATION_ADDRESS),
801 argsman.AddArg(
802 "-chronikelectrumpeersvalidationinterval",
803 strprintf(
804 "The peers submitted via the Chronik Electrum server.add_peer "
805 "endpoint are periodically checked for validity and are only "
806 "returned after they passed the validation. This option controls "
807 "the interval duration between successive peers validation "
808 "processes in seconds (default: %u). Setting this value to 0 "
809 "disables the peer validation completely.",
810 std::chrono::duration_cast<std::chrono::seconds>(
811 chronik::DEFAULT_ELECTRUM_PEER_VALIDATION_INTERVAL)
812 .count()),
815#endif
816 argsman.AddArg(
817 "-blockfilterindex=<type>",
818 strprintf("Maintain an index of compact filters by block "
819 "(default: %s, values: %s).",
821 " If <type> is not supplied or if <type> = 1, indexes for "
822 "all known types are enabled.",
824 argsman.AddArg(
825 "-usecashaddr",
826 strprintf("Use Cash Address for destination encoding instead of legacy "
827 "base58 addresses (default: %d)",
830
831 argsman.AddArg(
832 "-addnode=<ip>",
833 "Add a node to connect to and attempt to keep the connection "
834 "open (see the `addnode` RPC command help for more info)",
837 argsman.AddArg("-asmap=<file>",
838 strprintf("Specify asn mapping used for bucketing of the "
839 "peers (default: %s). Relative paths will be "
840 "prefixed by the net-specific datadir location.",
843 argsman.AddArg("-bantime=<n>",
844 strprintf("Default duration (in seconds) of manually "
845 "configured bans (default: %u)",
848 argsman.AddArg(
849 "-bind=<addr>[:<port>][=onion]",
850 strprintf("Bind to given address and always listen on it (default: "
851 "0.0.0.0). Use [host]:port notation for IPv6. Append =onion "
852 "to tag any incoming connections to that address and port as "
853 "incoming Tor connections (default: 127.0.0.1:%u=onion, "
854 "testnet: 127.0.0.1:%u=onion, regtest: 127.0.0.1:%u=onion)",
855 defaultBaseParams->OnionServiceTargetPort(),
856 testnetBaseParams->OnionServiceTargetPort(),
857 regtestBaseParams->OnionServiceTargetPort()),
860 argsman.AddArg(
861 "-connect=<ip>",
862 "Connect only to the specified node(s); -noconnect disables automatic "
863 "connections (the rules for this peer are the same as for -addnode)",
866 argsman.AddArg(
867 "-discover",
868 "Discover own IP addresses (default: 1 when listening and no "
869 "-externalip or -proxy)",
871 argsman.AddArg("-dns",
872 strprintf("Allow DNS lookups for -addnode, -seednode and "
873 "-connect (default: %d)",
876 argsman.AddArg(
877 "-dnsseed",
878 strprintf(
879 "Query for peer addresses via DNS lookup, if low on addresses "
880 "(default: %u unless -connect used)",
883 argsman.AddArg("-externalip=<ip>", "Specify your own public address",
885 argsman.AddArg(
886 "-fixedseeds",
887 strprintf(
888 "Allow fixed seeds if DNS seeds don't provide peers (default: %u)",
891 argsman.AddArg(
892 "-forcednsseed",
893 strprintf(
894 "Always query for peer addresses via DNS lookup (default: %d)",
897 argsman.AddArg("-overridednsseed",
898 "If set, only use the specified DNS seed when "
899 "querying for peer addresses via DNS lookup.",
901 argsman.AddArg(
902 "-listen",
903 "Accept connections from outside (default: 1 if no -proxy or -connect)",
905 argsman.AddArg(
906 "-listenonion",
907 strprintf("Automatically create Tor onion service (default: %d)",
910 argsman.AddArg(
911 "-maxconnections=<n>",
912 strprintf("Maintain at most <n> connections to peers. The effective "
913 "limit depends on system limitations and might be lower than "
914 "the specified value (default: %u)",
917 argsman.AddArg("-maxreceivebuffer=<n>",
918 strprintf("Maximum per-connection receive buffer, <n>*1000 "
919 "bytes (default: %u)",
922 argsman.AddArg(
923 "-maxsendbuffer=<n>",
924 strprintf(
925 "Maximum per-connection send buffer, <n>*1000 bytes (default: %u)",
928 argsman.AddArg(
929 "-maxtimeadjustment",
930 strprintf("Maximum allowed median peer time offset adjustment. Local "
931 "perspective of time may be influenced by peers forward or "
932 "backward by this amount. (default: %u seconds)",
935#if HAVE_SOCKADDR_UN
936 argsman.AddArg("-onion=<ip:port|path>",
937 "Use separate SOCKS5 proxy to reach peers via Tor onion "
938 "services, set -noonion to disable (default: -proxy). May "
939 "be a local file path prefixed with 'unix:'.",
941#else
942 argsman.AddArg(
943 "-onion=<ip:port>",
944 strprintf("Use separate SOCKS5 proxy to reach peers via Tor "
945 "onion services, set -noonion to disable (default: %s)",
946 "-proxy"),
948#endif
949 argsman.AddArg("-i2psam=<ip:port>",
950 "I2P SAM proxy to reach I2P peers and accept I2P "
951 "connections (default: none)",
953 argsman.AddArg(
954 "-i2pacceptincoming",
955 "If set and -i2psam is also set then incoming I2P connections are "
956 "accepted via the SAM proxy. If this is not set but -i2psam is set "
957 "then only outgoing connections will be made to the I2P network. "
958 "Ignored if -i2psam is not set. Listening for incoming I2P connections "
959 "is done through the SAM proxy, not by binding to a local address and "
960 "port (default: 1)",
962
963 argsman.AddArg(
964 "-onlynet=<net>",
965 "Make outgoing connections only through network <net> (" +
966 Join(GetNetworkNames(), ", ") +
967 "). Incoming connections are not affected by this option. This "
968 "option can be specified multiple times to allow multiple "
969 "networks.",
971 argsman.AddArg("-peerbloomfilters",
972 strprintf("Support filtering of blocks and transaction with "
973 "bloom filters (default: %d)",
976 argsman.AddArg(
977 "-peerblockfilters",
978 strprintf(
979 "Serve compact block filters to peers per BIP 157 (default: %u)",
982 argsman.AddArg("-permitbaremultisig",
983 strprintf("Relay non-P2SH multisig (default: %d)",
986 // TODO: remove the sentence "Nodes not using ... incoming connections."
987 // once the changes from https://github.com/bitcoin/bitcoin/pull/23542 have
988 // become widespread.
989 argsman.AddArg("-port=<port>",
990 strprintf("Listen for connections on <port>. Nodes not "
991 "using the default ports (default: %u, "
992 "testnet: %u, regtest: %u) are unlikely to get "
993 "incoming connections. Not relevant for I2P (see "
994 "doc/i2p.md).",
995 defaultChainParams->GetDefaultPort(),
996 testnetChainParams->GetDefaultPort(),
997 regtestChainParams->GetDefaultPort()),
1000#if HAVE_SOCKADDR_UN
1001 argsman.AddArg("-proxy=<ip:port|path>",
1002 "Connect through SOCKS5 proxy, set -noproxy to disable "
1003 "(default: disabled). May be a local file path prefixed "
1004 "with 'unix:' if the proxy supports it.",
1007#else
1008 argsman.AddArg("-proxy=<ip:port>",
1009 "Connect through SOCKS5 proxy, set -noproxy to disable "
1010 "(default: disabled)",
1013#endif
1014 argsman.AddArg(
1015 "-proxyrandomize",
1016 strprintf("Randomize credentials for every proxy connection. "
1017 "This enables Tor stream isolation (default: %d)",
1020 argsman.AddArg(
1021 "-seednode=<ip>",
1022 "Connect to a node to retrieve peer addresses, and disconnect",
1024 argsman.AddArg(
1025 "-networkactive",
1026 "Enable all P2P network activity (default: 1). Can be changed "
1027 "by the setnetworkactive RPC command",
1029 argsman.AddArg("-timeout=<n>",
1030 strprintf("Specify connection timeout in milliseconds "
1031 "(minimum: 1, default: %d)",
1034 argsman.AddArg(
1035 "-peertimeout=<n>",
1036 strprintf("Specify p2p connection timeout in seconds. This option "
1037 "determines the amount of time a peer may be inactive before "
1038 "the connection to it is dropped. (minimum: 1, default: %d)",
1041 argsman.AddArg(
1042 "-torcontrol=<ip>:<port>",
1043 strprintf(
1044 "Tor control port to use if onion listening enabled (default: %s)",
1047 argsman.AddArg("-torpassword=<pass>",
1048 "Tor control port password (default: empty)",
1051 // UPnP support was dropped. We keep `-upnp` as a hidden arg to display a
1052 // more user friendly error when set. TODO: remove (here and below) for
1053 // 0.34.0.
1054 argsman.AddArg("-upnp", "", ArgsManager::ALLOW_ANY,
1056 argsman.AddArg(
1057 "-natpmp",
1058 strprintf("Use PCP or NAT-PMP to map the listening port (default: %u)",
1061 argsman.AddArg(
1062 "-whitebind=<[permissions@]addr>",
1063 "Bind to the given address and add permission flags to the peers "
1064 "connecting to it."
1065 "Use [host]:port notation for IPv6. Allowed permissions: " +
1066 Join(NET_PERMISSIONS_DOC, ", ") +
1067 ". "
1068 "Specify multiple permissions separated by commas (default: "
1069 "download,noban,mempool,relay). Can be specified multiple times.",
1071
1072 argsman.AddArg("-whitelist=<[permissions@]IP address or network>",
1073 "Add permission flags to the peers using the given "
1074 "IP address (e.g. 1.2.3.4) or CIDR-notated network "
1075 "(e.g. 1.2.3.0/24). "
1076 "Uses the same permissions as -whitebind. "
1077 "Additional flags \"in\" and \"out\" control whether "
1078 "permissions apply to incoming connections and/or manual "
1079 "(default: incoming only). "
1080 "Can be specified multiple times.",
1082 argsman.AddArg(
1083 "-maxuploadtarget=<n>",
1084 strprintf("Tries to keep outbound traffic under the given target (in "
1085 "MiB per 24h). Limit does not apply to peers with 'download' "
1086 "permission. 0 = no limit (default: %d)",
1089
1091
1092#if ENABLE_ZMQ
1093 argsman.AddArg("-zmqpubhashblock=<address>",
1094 "Enable publish hash block in <address>",
1096 argsman.AddArg("-zmqpubhashtx=<address>",
1097 "Enable publish hash transaction in <address>",
1099 argsman.AddArg("-zmqpubrawblock=<address>",
1100 "Enable publish raw block in <address>",
1102 argsman.AddArg("-zmqpubrawtx=<address>",
1103 "Enable publish raw transaction in <address>",
1105 argsman.AddArg("-zmqpubsequence=<address>",
1106 "Enable publish hash block and tx sequence in <address>",
1108 argsman.AddArg(
1109 "-zmqpubhashblockhwm=<n>",
1110 strprintf("Set publish hash block outbound message high water "
1111 "mark (default: %d)",
1114 argsman.AddArg(
1115 "-zmqpubhashtxhwm=<n>",
1116 strprintf("Set publish hash transaction outbound message high "
1117 "water mark (default: %d)",
1119 false, OptionsCategory::ZMQ);
1120 argsman.AddArg(
1121 "-zmqpubrawblockhwm=<n>",
1122 strprintf("Set publish raw block outbound message high water "
1123 "mark (default: %d)",
1126 argsman.AddArg(
1127 "-zmqpubrawtxhwm=<n>",
1128 strprintf("Set publish raw transaction outbound message high "
1129 "water mark (default: %d)",
1132 argsman.AddArg("-zmqpubsequencehwm=<n>",
1133 strprintf("Set publish hash sequence message high water mark"
1134 " (default: %d)",
1137#else
1138 hidden_args.emplace_back("-zmqpubhashblock=<address>");
1139 hidden_args.emplace_back("-zmqpubhashtx=<address>");
1140 hidden_args.emplace_back("-zmqpubrawblock=<address>");
1141 hidden_args.emplace_back("-zmqpubrawtx=<address>");
1142 hidden_args.emplace_back("-zmqpubsequence=<n>");
1143 hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
1144 hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
1145 hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
1146 hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
1147 hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
1148#endif
1149
1150 argsman.AddArg(
1151 "-checkblocks=<n>",
1152 strprintf("How many blocks to check at startup (default: %u, 0 = all)",
1156 argsman.AddArg("-checklevel=<n>",
1157 strprintf("How thorough the block verification of "
1158 "-checkblocks is: %s (0-4, default: %u)",
1162 argsman.AddArg("-checkblockindex",
1163 strprintf("Do a consistency check for the block tree, "
1164 "chainstate, and other validation data structures "
1165 "occasionally. (default: %u, regtest: %u)",
1166 defaultChainParams->DefaultConsistencyChecks(),
1167 regtestChainParams->DefaultConsistencyChecks()),
1170 argsman.AddArg("-checkaddrman=<n>",
1171 strprintf("Run addrman consistency checks every <n> "
1172 "operations. Use 0 to disable. (default: %u)",
1176 argsman.AddArg(
1177 "-checkmempool=<n>",
1178 strprintf("Run mempool consistency checks every <n> transactions. Use "
1179 "0 to disable. (default: %u, regtest: %u)",
1180 defaultChainParams->DefaultConsistencyChecks(),
1181 regtestChainParams->DefaultConsistencyChecks()),
1184 argsman.AddArg("-checkpoints",
1185 strprintf("Only accept block chain matching built-in "
1186 "checkpoints (default: %d)",
1190 argsman.AddArg("-deprecatedrpc=<method>",
1191 "Allows deprecated RPC method(s) to be used",
1194 argsman.AddArg(
1195 "-stopafterblockimport",
1196 strprintf("Stop running after importing blocks from disk (default: %d)",
1200 argsman.AddArg("-stopatheight",
1201 strprintf("Stop running after reaching the given height in "
1202 "the main chain (default: %u)",
1206 argsman.AddArg("-addrmantest", "Allows to test address relay on localhost",
1209 argsman.AddArg("-capturemessages", "Capture all P2P messages to disk",
1212 argsman.AddArg("-mocktime=<n>",
1213 "Replace actual time with " + UNIX_EPOCH_TIME +
1214 " (default: 0)",
1217 argsman.AddArg(
1218 "-maxsigcachesize=<n>",
1219 strprintf("Limit size of signature cache to <n> MiB (default: %u)",
1223 argsman.AddArg(
1224 "-maxscriptcachesize=<n>",
1225 strprintf("Limit size of script cache to <n> MiB (default: %u)",
1229 argsman.AddArg("-maxtipage=<n>",
1230 strprintf("Maximum tip age in seconds to consider node in "
1231 "initial block download (default: %u)",
1232 Ticks<std::chrono::seconds>(DEFAULT_MAX_TIP_AGE)),
1235
1236 argsman.AddArg("-uacomment=<cmt>",
1237 "Append comment to the user agent string",
1239 argsman.AddArg("-uaclientname=<clientname>", "Set user agent client name",
1241 argsman.AddArg("-uaclientversion=<clientversion>",
1242 "Set user agent client version", ArgsManager::ALLOW_ANY,
1244
1246
1247 argsman.AddArg(
1248 "-acceptnonstdtxn",
1249 strprintf(
1250 "Relay and mine \"non-standard\" transactions (%sdefault: %u)",
1251 "testnet/regtest only; ", defaultChainParams->RequireStandard()),
1254 argsman.AddArg("-excessiveblocksize=<n>",
1255 strprintf("Do not accept blocks larger than this limit, in "
1256 "bytes (default: %d)",
1260 const auto ticker = Currency::getTicker();
1261 argsman.AddArg(
1262 "-dustrelayfee=<amt>",
1263 strprintf("Fee rate (in %s/kB) used to define dust, the value of an "
1264 "output such that it will cost about 1/3 of its value in "
1265 "fees at this fee rate to spend it. (default: %s)",
1269
1270 argsman.AddArg(
1271 "-bytespersigcheck",
1272 strprintf("Equivalent bytes per sigCheck in transactions for relay and "
1273 "mining (default: %u).",
1276 argsman.AddArg(
1277 "-bytespersigop",
1278 strprintf("DEPRECATED: Equivalent bytes per sigCheck in transactions "
1279 "for relay and mining (default: %u). This has been "
1280 "deprecated since v0.26.8 and will be removed in the future, "
1281 "please use -bytespersigcheck instead.",
1284 argsman.AddArg(
1285 "-datacarrier",
1286 strprintf("Relay and mine data carrier transactions (default: %d)",
1289 argsman.AddArg(
1290 "-datacarriersize",
1291 strprintf("Maximum size of data in data carrier transactions "
1292 "we relay and mine (default: %u)",
1295 argsman.AddArg(
1296 "-minrelaytxfee=<amt>",
1297 strprintf("Fees (in %s/kB) smaller than this are rejected for "
1298 "relaying, mining and transaction creation (default: %s)",
1301 argsman.AddArg(
1302 "-whitelistrelay",
1303 strprintf("Add 'relay' permission to whitelisted peers "
1304 "with default permissions. This will accept relayed "
1305 "transactions even when not relaying transactions "
1306 "(default: %d)",
1309 argsman.AddArg(
1310 "-whitelistforcerelay",
1311 strprintf("Add 'forcerelay' permission to whitelisted peers "
1312 "with default permissions. This will relay transactions "
1313 "even if the transactions were already in the mempool "
1314 "(default: %d)",
1317
1318 argsman.AddArg("-blockmaxsize=<n>",
1319 strprintf("Set maximum block size in bytes (default: %d)",
1322 argsman.AddArg(
1323 "-blockmintxfee=<amt>",
1324 strprintf("Set lowest fee rate (in %s/kB) for transactions to "
1325 "be included in block creation. (default: %s)",
1328 argsman.AddArg("-simplegbt",
1329 "Use a simplified getblocktemplate output (default: 0)",
1331
1332 argsman.AddArg("-blockversion=<n>",
1333 "Override block version to test forking scenarios",
1336
1337 argsman.AddArg("-server", "Accept command line and JSON-RPC commands",
1339 argsman.AddArg("-rest",
1340 strprintf("Accept public REST requests (default: %d)",
1343 argsman.AddArg(
1344 "-rpcbind=<addr>[:port]",
1345 "Bind to given address to listen for JSON-RPC connections. Do not "
1346 "expose the RPC server to untrusted networks such as the public "
1347 "internet! This option is ignored unless -rpcallowip is also passed. "
1348 "Port is optional and overrides -rpcport. Use [host]:port notation "
1349 "for IPv6. This option can be specified multiple times (default: "
1350 "127.0.0.1 and ::1 i.e., localhost)",
1354 argsman.AddArg(
1355 "-rpcdoccheck",
1356 strprintf("Throw a non-fatal error at runtime if the documentation for "
1357 "an RPC is incorrect (default: %u)",
1360 argsman.AddArg(
1361 "-rpccookiefile=<loc>",
1362 "Location of the auth cookie. Relative paths will be prefixed "
1363 "by a net-specific datadir location. (default: data dir)",
1365 argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections",
1368 argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections",
1371 argsman.AddArg(
1372 "-rpcwhitelist=<whitelist>",
1373 "Set a whitelist to filter incoming RPC calls for a specific user. The "
1374 "field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc "
1375 "2>,...,<rpc n>. If multiple whitelists are set for a given user, they "
1376 "are set-intersected. See -rpcwhitelistdefault documentation for "
1377 "information on default whitelist behavior.",
1379 argsman.AddArg(
1380 "-rpcwhitelistdefault",
1381 "Sets default behavior for rpc whitelisting. Unless "
1382 "rpcwhitelistdefault is set to 0, if any -rpcwhitelist is set, the rpc "
1383 "server acts as if all rpc users are subject to "
1384 "empty-unless-otherwise-specified whitelists. If rpcwhitelistdefault "
1385 "is set to 1 and no -rpcwhitelist is set, rpc server acts as if all "
1386 "rpc users are subject to empty whitelists.",
1388 argsman.AddArg(
1389 "-rpcauth=<userpw>",
1390 "Username and HMAC-SHA-256 hashed password for JSON-RPC connections. "
1391 "The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A "
1392 "canonical python script is included in share/rpcauth. The client then "
1393 "connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> "
1394 "pair of arguments. This option can be specified multiple times",
1396 argsman.AddArg("-rpcport=<port>",
1397 strprintf("Listen for JSON-RPC connections on <port> "
1398 "(default: %u, testnet: %u, regtest: %u)",
1399 defaultBaseParams->RPCPort(),
1400 testnetBaseParams->RPCPort(),
1401 regtestBaseParams->RPCPort()),
1404 argsman.AddArg(
1405 "-rpcallowip=<ip>",
1406 "Allow JSON-RPC connections from specified source. Valid for "
1407 "<ip> are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. "
1408 "1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). "
1409 "This option can be specified multiple times",
1411 argsman.AddArg(
1412 "-rpcthreads=<n>",
1413 strprintf(
1414 "Set the number of threads to service RPC calls (default: %d)",
1417 argsman.AddArg(
1418 "-rpccorsdomain=value",
1419 "Domain from which to accept cross origin requests (browser enforced)",
1421
1422 argsman.AddArg("-rpcworkqueue=<n>",
1423 strprintf("Set the depth of the work queue to service RPC "
1424 "calls (default: %d)",
1428 argsman.AddArg("-rpcservertimeout=<n>",
1429 strprintf("Timeout during HTTP requests (default: %d)",
1433
1434#if HAVE_DECL_FORK
1435 argsman.AddArg("-daemon",
1436 strprintf("Run in the background as a daemon and accept "
1437 "commands (default: %d)",
1440 argsman.AddArg("-daemonwait",
1441 strprintf("Wait for initialization to be finished before "
1442 "exiting. This implies -daemon (default: %d)",
1445#else
1446 hidden_args.emplace_back("-daemon");
1447 hidden_args.emplace_back("-daemonwait");
1448#endif
1449
1450 // Avalanche options.
1451 argsman.AddArg("-avalanche",
1452 strprintf("Enable the avalanche feature (default: %u)",
1455 argsman.AddArg(
1456 "-avalanchestakingrewards",
1457 strprintf("Enable the avalanche staking rewards feature (default: %u, "
1458 "testnet: %u, regtest: %u)",
1459 defaultChainParams->GetConsensus().enableStakingRewards,
1460 testnetChainParams->GetConsensus().enableStakingRewards,
1461 regtestChainParams->GetConsensus().enableStakingRewards),
1463 argsman.AddArg("-avalanchestakingpreconsensus",
1464 strprintf("Enable the avalanche staking rewards "
1465 "preconsensus feature (default: %u)",
1468 argsman.AddArg(
1469 "-avalanchepreconsensus",
1470 strprintf("Enable the avalanche preconsensus feature (default: %u)",
1473 argsman.AddArg("-avalanchepreconsensusmining",
1474 strprintf("Enable mining only the avalanche finalized "
1475 "transactions (default: %u)",
1478 argsman.AddArg("-avalancheconflictingproofcooldown",
1479 strprintf("Mandatory cooldown before a proof conflicting "
1480 "with an already registered one can be considered "
1481 "in seconds (default: %u)",
1485 argsman.AddArg("-avalanchepeerreplacementcooldown",
1486 strprintf("Mandatory cooldown before a peer can be replaced "
1487 "in seconds (default: %u)",
1491 argsman.AddArg(
1492 "-avaminquorumstake",
1493 strprintf(
1494 "Minimum amount of known stake for a usable quorum (default: %s)",
1497 argsman.AddArg(
1498 "-avaminquorumconnectedstakeratio",
1499 strprintf("Minimum proportion of known stake we"
1500 " need nodes for to have a usable quorum (default: %s). "
1501 "This parameter is parsed with a maximum precision of "
1502 "0.000001.",
1506 argsman.AddArg(
1507 "-avaminavaproofsnodecount",
1508 strprintf("Minimum number of node that needs to send us an avaproofs"
1509 " message before we consider we have a usable quorum"
1510 " (default: %s)",
1514 argsman.AddArg(
1515 "-avastalevotethreshold",
1516 strprintf("Number of avalanche votes before a voted item goes stale "
1517 "when voting confidence is low (default: %u)",
1521 argsman.AddArg(
1522 "-avastalevotefactor",
1523 strprintf(
1524 "Factor affecting the number of avalanche votes before a voted "
1525 "item goes stale when voting confidence is high (default: %u)",
1529 argsman.AddArg("-avacooldown",
1530 strprintf("Mandatory cooldown between two avapoll in "
1531 "milliseconds (default: %u)",
1534 argsman.AddArg(
1535 "-avatimeout",
1536 strprintf("Avalanche query timeout in milliseconds (default: %u)",
1539 argsman.AddArg(
1540 "-avamaxelementpoll",
1541 strprintf("Maximum number of elements to include and accept in an "
1542 "avapoll (default: %u)",
1545 argsman.AddArg(
1546 "-avadelegation",
1547 "Avalanche proof delegation to the master key used by this node "
1548 "(default: none). Should be used in conjunction with -avaproof and "
1549 "-avamasterkey",
1551 argsman.AddArg("-avaproof",
1552 "Avalanche proof to be used by this node (default: none)",
1554 argsman.AddArg(
1555 "-avaproofstakeutxoconfirmations",
1556 strprintf(
1557 "Minimum number of confirmations before a stake utxo is mature"
1558 " enough to be included into a proof. Utxos in the mempool are not "
1559 "accepted (i.e this value must be greater than 0) (default: %s)",
1563 argsman.AddArg("-avaproofstakeutxodustthreshold",
1564 strprintf("Minimum value each stake utxo must have to be "
1565 "considered valid (default: %s)",
1568 argsman.AddArg("-avamasterkey",
1569 "Master key associated with the proof. If a proof is "
1570 "required, this is mandatory.",
1573 argsman.AddArg("-avasessionkey", "Avalanche session key (default: random)",
1576 argsman.AddArg("-enablertt",
1577 strprintf("Whether to enforce Real Time Targeting via "
1578 "Avalanche, default (%u)",
1581 argsman.AddArg(
1582 "-maxavalancheoutbound",
1583 strprintf(
1584 "Set the maximum number of avalanche outbound peers to connect to. "
1585 "Note that this option takes precedence over the -maxconnections "
1586 "option (default: %u).",
1590 argsman.AddArg(
1591 "-persistavapeers",
1592 strprintf("Whether to save the avalanche peers upon shutdown and load "
1593 "them upon startup (default: %u).",
1596
1597 // Add the hidden options
1598 argsman.AddHiddenArgs(hidden_args);
1599}
1600
1601static bool fHaveGenesis = false;
1603static std::condition_variable g_genesis_wait_cv;
1604
1605static void BlockNotifyGenesisWait(const CBlockIndex *pBlockIndex) {
1606 if (pBlockIndex != nullptr) {
1607 {
1609 fHaveGenesis = true;
1610 }
1611 g_genesis_wait_cv.notify_all();
1612 }
1613}
1614
1615#if HAVE_SYSTEM
1616static void StartupNotify(const ArgsManager &args) {
1617 std::string cmd = args.GetArg("-startupnotify", "");
1618 if (!cmd.empty()) {
1619 std::thread t(runCommand, cmd);
1620 // thread runs free
1621 t.detach();
1622 }
1623}
1624#endif
1625
1626static bool AppInitServers(Config &config,
1627 HTTPRPCRequestProcessor &httpRPCRequestProcessor,
1628 NodeContext &node) {
1629 const ArgsManager &args = *Assert(node.args);
1632 if (!InitHTTPServer(config)) {
1633 return false;
1634 }
1635
1636 StartRPC();
1637 node.rpc_interruption_point = RpcInterruptionPoint;
1638
1639 if (!StartHTTPRPC(httpRPCRequestProcessor)) {
1640 return false;
1641 }
1642 if (args.GetBoolArg("-rest", DEFAULT_REST_ENABLE)) {
1643 StartREST(&node);
1644 }
1645
1647 return true;
1648}
1649
1650// Parameter interaction based on rules
1652 // when specifying an explicit binding address, you want to listen on it
1653 // even when -connect or -proxy is specified.
1654 if (args.IsArgSet("-bind")) {
1655 if (args.SoftSetBoolArg("-listen", true)) {
1656 LogPrintf(
1657 "%s: parameter interaction: -bind set -> setting -listen=1\n",
1658 __func__);
1659 }
1660 }
1661 if (args.IsArgSet("-whitebind")) {
1662 if (args.SoftSetBoolArg("-listen", true)) {
1663 LogPrintf("%s: parameter interaction: -whitebind set -> setting "
1664 "-listen=1\n",
1665 __func__);
1666 }
1667 }
1668
1669 if (args.IsArgSet("-connect")) {
1670 // when only connecting to trusted nodes, do not seed via DNS, or listen
1671 // by default.
1672 if (args.SoftSetBoolArg("-dnsseed", false)) {
1673 LogPrintf("%s: parameter interaction: -connect set -> setting "
1674 "-dnsseed=0\n",
1675 __func__);
1676 }
1677 if (args.SoftSetBoolArg("-listen", false)) {
1678 LogPrintf("%s: parameter interaction: -connect set -> setting "
1679 "-listen=0\n",
1680 __func__);
1681 }
1682 }
1683
1684 if (args.IsArgSet("-proxy")) {
1685 // to protect privacy, do not listen by default if a default proxy
1686 // server is specified.
1687 if (args.SoftSetBoolArg("-listen", false)) {
1688 LogPrintf(
1689 "%s: parameter interaction: -proxy set -> setting -listen=0\n",
1690 __func__);
1691 }
1692 // to protect privacy, do not map ports when a proxy is set. The user
1693 // may still specify -listen=1 to listen locally, so don't rely on this
1694 // happening through -listen below.
1695 if (args.SoftSetBoolArg("-natpmp", false)) {
1696 LogPrintf(
1697 "%s: parameter interaction: -proxy set -> setting -natpmp=0\n",
1698 __func__);
1699 }
1700 // to protect privacy, do not discover addresses by default
1701 if (args.SoftSetBoolArg("-discover", false)) {
1702 LogPrintf("%s: parameter interaction: -proxy set -> setting "
1703 "-discover=0\n",
1704 __func__);
1705 }
1706 }
1707
1708 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1709 // do not map ports or try to retrieve public IP when not listening
1710 // (pointless)
1711 if (args.SoftSetBoolArg("-natpmp", false)) {
1712 LogPrintf(
1713 "%s: parameter interaction: -listen=0 -> setting -natpmp=0\n",
1714 __func__);
1715 }
1716 if (args.SoftSetBoolArg("-discover", false)) {
1717 LogPrintf(
1718 "%s: parameter interaction: -listen=0 -> setting -discover=0\n",
1719 __func__);
1720 }
1721 if (args.SoftSetBoolArg("-listenonion", false)) {
1722 LogPrintf("%s: parameter interaction: -listen=0 -> setting "
1723 "-listenonion=0\n",
1724 __func__);
1725 }
1726 if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
1727 LogPrintf("%s: parameter interaction: -listen=0 -> setting "
1728 "-i2pacceptincoming=0\n",
1729 __func__);
1730 }
1731 }
1732
1733 if (args.IsArgSet("-externalip")) {
1734 // if an explicit public IP is specified, do not try to find others
1735 if (args.SoftSetBoolArg("-discover", false)) {
1736 LogPrintf("%s: parameter interaction: -externalip set -> setting "
1737 "-discover=0\n",
1738 __func__);
1739 }
1740 }
1741
1742 // disable whitelistrelay in blocksonly mode
1743 if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
1744 if (args.SoftSetBoolArg("-whitelistrelay", false)) {
1745 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting "
1746 "-whitelistrelay=0\n",
1747 __func__);
1748 }
1749 }
1750
1751 // Forcing relay from whitelisted hosts implies we will accept relays from
1752 // them in the first place.
1753 if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
1754 if (args.SoftSetBoolArg("-whitelistrelay", true)) {
1755 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> "
1756 "setting -whitelistrelay=1\n",
1757 __func__);
1758 }
1759 }
1760
1761 // If avalanche is set, soft set all the feature flags accordingly.
1762 if (args.IsArgSet("-avalanche")) {
1763 const bool fAvalanche =
1764 args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED);
1765 args.SoftSetBoolArg("-automaticunparking", !fAvalanche);
1766 }
1767}
1768
1775void InitLogging(const ArgsManager &args) {
1778}
1779
1780namespace { // Variables internal to initialization process only
1781
1782int nMaxConnections;
1783int nUserMaxConnections;
1784int nFD;
1786int64_t peer_connect_timeout;
1787std::set<BlockFilterType> g_enabled_filter_types;
1788
1789} // namespace
1790
1791[[noreturn]] static void new_handler_terminate() {
1792 // Rather than throwing std::bad-alloc if allocation fails, terminate
1793 // immediately to (try to) avoid chain corruption. Since LogPrintf may
1794 // itself allocate memory, set the handler directly to terminate first.
1795 std::set_new_handler(std::terminate);
1796 LogPrintf("Error: Out of memory. Terminating.\n");
1797
1798 // The log was successful, terminate now.
1799 std::terminate();
1800};
1801
1802bool AppInitBasicSetup(const ArgsManager &args, std::atomic<int> &exit_status) {
1803// Step 1: setup
1804#ifdef _MSC_VER
1805 // Turn off Microsoft heap dump noise
1806 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
1807 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr,
1808 OPEN_EXISTING, 0, 0));
1809 // Disable confusing "helpful" text message on abort, Ctrl-C
1810 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
1811#endif
1812#ifdef WIN32
1813 // Enable Data Execution Prevention (DEP)
1814 SetProcessDEPPolicy(PROCESS_DEP_ENABLE);
1815#endif
1816 if (!SetupNetworking()) {
1817 return InitError(Untranslated("Initializing networking failed"));
1818 }
1819
1820#ifndef WIN32
1821 if (!args.GetBoolArg("-sysperms", false)) {
1822 umask(077);
1823 }
1824
1825 // Clean shutdown on SIGTERM
1828
1829 // Reopen debug.log on SIGHUP
1831
1832 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client
1833 // closes unexpectedly
1834 signal(SIGPIPE, SIG_IGN);
1835#else
1836 SetConsoleCtrlHandler(consoleCtrlHandler, true);
1837#endif
1838
1839 std::set_new_handler(new_handler_terminate);
1840
1841 return true;
1842}
1843
1845 const CChainParams &chainparams = config.GetChainParams();
1846 // Step 2: parameter interactions
1847
1848 // also see: InitParameterInteraction()
1849
1850 // Error if network-specific options (-addnode, -connect, etc) are
1851 // specified in default section of config file, but not overridden
1852 // on the command line or in this chain's section of the config file.
1853 ChainType chain = args.GetChainType();
1854 bilingual_str errors;
1855 for (const auto &arg : args.GetUnsuitableSectionOnlyArgs()) {
1856 errors +=
1857 strprintf(_("Config setting for %s only applied on %s "
1858 "network when in [%s] section.") +
1859 Untranslated("\n"),
1860 arg, ChainTypeToString(chain), ChainTypeToString(chain));
1861 }
1862
1863 if (!errors.empty()) {
1864 return InitError(errors);
1865 }
1866
1867 // Warn if unrecognized section name are present in the config file.
1868 bilingual_str warnings;
1869 for (const auto &section : args.GetUnrecognizedSections()) {
1870 warnings += strprintf(Untranslated("%s:%i ") +
1871 _("Section [%s] is not recognized.") +
1872 Untranslated("\n"),
1873 section.m_file, section.m_line, section.m_name);
1874 }
1875
1876 if (!warnings.empty()) {
1877 InitWarning(warnings);
1878 }
1879
1880 if (!fs::is_directory(args.GetBlocksDirPath())) {
1881 return InitError(
1882 strprintf(_("Specified blocks directory \"%s\" does not exist."),
1883 args.GetArg("-blocksdir", "")));
1884 }
1885
1886 // parse and validate enabled filter types
1887 std::string blockfilterindex_value =
1888 args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
1889 if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
1890 g_enabled_filter_types = AllBlockFilterTypes();
1891 } else if (blockfilterindex_value != "0") {
1892 const std::vector<std::string> names =
1893 args.GetArgs("-blockfilterindex");
1894 for (const auto &name : names) {
1895 BlockFilterType filter_type;
1896 if (!BlockFilterTypeByName(name, filter_type)) {
1897 return InitError(
1898 strprintf(_("Unknown -blockfilterindex value %s."), name));
1899 }
1900 g_enabled_filter_types.insert(filter_type);
1901 }
1902 }
1903
1904 // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index
1905 // are both enabled.
1906 if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
1907 if (g_enabled_filter_types.count(BlockFilterType::BASIC) != 1) {
1908 return InitError(
1909 _("Cannot set -peerblockfilters without -blockfilterindex."));
1910 }
1911
1912 nLocalServices = ServiceFlags(nLocalServices | NODE_COMPACT_FILTERS);
1913 }
1914
1915 if (args.GetIntArg("-prune", 0)) {
1916 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1917 return InitError(_("Prune mode is incompatible with -txindex."));
1918 }
1919 if (args.GetBoolArg("-reindex-chainstate", false)) {
1920 return InitError(
1921 _("Prune mode is incompatible with -reindex-chainstate. Use "
1922 "full -reindex instead."));
1923 }
1924 if (args.GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
1925 return InitError(_("Prune mode is incompatible with -chronik."));
1926 }
1927 }
1928
1929 // -bind and -whitebind can't be set when not listening
1930 size_t nUserBind =
1931 args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
1932 if (nUserBind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1933 return InitError(Untranslated(
1934 "Cannot set -bind or -whitebind together with -listen=0"));
1935 }
1936
1937 // Make sure enough file descriptors are available
1938 int nBind = std::max(nUserBind, size_t(1));
1939 nUserMaxConnections =
1940 args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
1941 nMaxConnections = std::max(nUserMaxConnections, 0);
1942
1943 // -maxavalancheoutbound takes precedence over -maxconnections
1944 const int maxAvalancheOutbound = args.GetIntArg(
1945 "-maxavalancheoutbound", DEFAULT_MAX_AVALANCHE_OUTBOUND_CONNECTIONS);
1946 const bool fAvalanche =
1947 args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED);
1948 if (fAvalanche && maxAvalancheOutbound > nMaxConnections) {
1949 nMaxConnections = std::max(maxAvalancheOutbound, nMaxConnections);
1950 // Indicate the value set by the user
1951 LogPrintf("Increasing -maxconnections from %d to %d to comply with "
1952 "-maxavalancheoutbound\n",
1953 nUserMaxConnections, nMaxConnections);
1954 }
1955
1956 // Trim requested connection counts, to fit into system limitations
1957 // <int> in std::min<int>(...) to work around FreeBSD compilation issue
1958 // described in #2695
1960 nMaxConnections + nBind + MIN_CORE_FILEDESCRIPTORS +
1962#ifdef USE_POLL
1963 int fd_max = nFD;
1964#else
1965 int fd_max = FD_SETSIZE;
1966#endif
1967 nMaxConnections = std::max(
1968 std::min<int>(nMaxConnections,
1969 fd_max - nBind - MIN_CORE_FILEDESCRIPTORS -
1971 0);
1972 if (nFD < MIN_CORE_FILEDESCRIPTORS) {
1973 return InitError(_("Not enough file descriptors available."));
1974 }
1975 nMaxConnections =
1977 nMaxConnections);
1978
1979 if (nMaxConnections < nUserMaxConnections) {
1980 // Not categorizing as "Warning" because this is the normal behavior for
1981 // platforms using the select() interface for which FD_SETSIZE is
1982 // usually 1024.
1983 LogPrintf("Reducing -maxconnections from %d to %d, because of system "
1984 "limitations.\n",
1985 nUserMaxConnections, nMaxConnections);
1986 }
1987
1988 // Step 3: parameter-to-internal-flags
1991
1992 // Configure excessive block size.
1993 const int64_t nProposedExcessiveBlockSize =
1994 args.GetIntArg("-excessiveblocksize", DEFAULT_MAX_BLOCK_SIZE);
1995 if (nProposedExcessiveBlockSize <= 0 ||
1996 !config.SetMaxBlockSize(nProposedExcessiveBlockSize)) {
1997 return InitError(
1998 _("Excessive block size must be > 1,000,000 bytes (1MB)"));
1999 }
2000
2001 // Check blockmaxsize does not exceed maximum accepted block size.
2002 const int64_t nProposedMaxGeneratedBlockSize =
2003 args.GetIntArg("-blockmaxsize", DEFAULT_MAX_GENERATED_BLOCK_SIZE);
2004 if (nProposedMaxGeneratedBlockSize <= 0) {
2005 return InitError(_("Max generated block size must be greater than 0"));
2006 }
2007 if (uint64_t(nProposedMaxGeneratedBlockSize) > config.GetMaxBlockSize()) {
2008 return InitError(_("Max generated block size (blockmaxsize) cannot "
2009 "exceed the excessive block size "
2010 "(excessiveblocksize)"));
2011 }
2012
2014 if (nConnectTimeout <= 0) {
2016 }
2017
2018 peer_connect_timeout =
2019 args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
2020 if (peer_connect_timeout <= 0) {
2021 return InitError(Untranslated(
2022 "peertimeout cannot be configured with a negative value."));
2023 }
2024
2025 // Sanity check argument for min fee for including tx in block
2026 // TODO: Harmonize which arguments need sanity checking and where that
2027 // happens.
2028 if (args.IsArgSet("-blockmintxfee")) {
2029 Amount n = Amount::zero();
2030 if (!ParseMoney(args.GetArg("-blockmintxfee", ""), n)) {
2031 return InitError(AmountErrMsg("blockmintxfee",
2032 args.GetArg("-blockmintxfee", "")));
2033 }
2034 }
2035
2037 args.IsArgSet("-bytespersigcheck")
2038 ? args.GetIntArg("-bytespersigcheck", nBytesPerSigCheck)
2039 : args.GetIntArg("-bytespersigop", nBytesPerSigCheck);
2040
2042 return false;
2043 }
2044
2045 // Option to startup with mocktime set (used for regression testing):
2046 SetMockTime(args.GetIntArg("-mocktime", 0)); // SetMockTime(0) is a no-op
2047
2048 if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS)) {
2049 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
2050 }
2051
2052 // Avalanche parameters
2053 const int64_t stakeUtxoMinConfirmations =
2054 args.GetIntArg("-avaproofstakeutxoconfirmations",
2056
2057 if (!chainparams.IsTestChain() &&
2058 stakeUtxoMinConfirmations !=
2060 return InitError(_("Avalanche stake UTXO minimum confirmations can "
2061 "only be set on test chains."));
2062 }
2063
2064 if (stakeUtxoMinConfirmations <= 0) {
2065 return InitError(_("Avalanche stake UTXO minimum confirmations must be "
2066 "a positive integer."));
2067 }
2068
2069 if (args.IsArgSet("-avaproofstakeutxodustthreshold")) {
2070 Amount amount = Amount::zero();
2071 auto parsed = ParseMoney(
2072 args.GetArg("-avaproofstakeutxodustthreshold", ""), amount);
2073 if (!parsed || Amount::zero() == amount) {
2074 return InitError(AmountErrMsg(
2075 "avaproofstakeutxodustthreshold",
2076 args.GetArg("-avaproofstakeutxodustthreshold", "")));
2077 }
2078
2079 if (!chainparams.IsTestChain() &&
2081 return InitError(_("Avalanche stake UTXO dust threshold can "
2082 "only be set on test chains."));
2083 }
2084 }
2085
2086 // This is a staking node
2087 if (fAvalanche && args.IsArgSet("-avaproof")) {
2088 if (!args.GetBoolArg("-listen", true)) {
2089 return InitError(_("Running a staking node requires accepting "
2090 "inbound connections. Please enable -listen."));
2091 }
2092 if (args.IsArgSet("-proxy")) {
2093 return InitError(_("Running a staking node behind a proxy is not "
2094 "supported. Please disable -proxy."));
2095 }
2096 if (args.IsArgSet("-i2psam")) {
2097 return InitError(_("Running a staking node behind I2P is not "
2098 "supported. Please disable -i2psam."));
2099 }
2100 if (args.IsArgSet("-onlynet")) {
2101 return InitError(
2102 _("Restricting the outbound network is not supported when "
2103 "running a staking node. Please disable -onlynet."));
2104 }
2105 if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
2106 return InitError(
2107 _("Running a staking node in -blocksonly mode is not "
2108 "supported. Please disable -blocksonly."));
2109 }
2110 }
2111
2112 // Also report errors from parsing before daemonization
2113 {
2114 kernel::Notifications notifications{};
2115 ChainstateManager::Options chainman_opts_dummy{
2116 .config = config,
2117 .datadir = args.GetDataDirNet(),
2118 .notifications = notifications,
2119 };
2120 if (const auto error{ApplyArgsManOptions(args, chainman_opts_dummy)}) {
2121 return InitError(*error);
2122 }
2123 BlockManager::Options blockman_opts_dummy{
2124 .chainparams = chainman_opts_dummy.config.GetChainParams(),
2125 .blocks_dir = args.GetBlocksDirPath(),
2126 .notifications = chainman_opts_dummy.notifications,
2127 };
2128 if (const auto error{ApplyArgsManOptions(args, blockman_opts_dummy)}) {
2129 return InitError(*error);
2130 }
2131 }
2132
2133 return true;
2134}
2135
2136static bool LockDataDirectory(bool probeOnly) {
2137 // Make sure only a single Bitcoin process is using the data directory.
2138 const fs::path &datadir = gArgs.GetDataDirNet();
2139 switch (util::LockDirectory(datadir, ".lock", probeOnly)) {
2141 return InitError(
2142 strprintf(_("Cannot obtain a lock on data directory %s. %s is "
2143 "probably already running."),
2144 fs::PathToString(datadir), PACKAGE_NAME));
2146 return true;
2148 return InitError(strprintf(
2149 _("Cannot write to data directory '%s'; check permissions."),
2150 fs::PathToString(datadir)));
2151 } // no default case, so the compiler can warn about missing cases
2152 assert(false);
2153}
2154
2156 // Step 4: sanity checks
2157 auto result{kernel::SanityChecks(kernel)};
2158 if (!result) {
2160 return InitError(strprintf(
2161 _("Initialization sanity check failed. %s is shutting down."),
2162 PACKAGE_NAME));
2163 }
2164
2165 // Probe the data directory lock to give an early error message, if possible
2166 // We cannot hold the data directory lock here, as the forking for daemon()
2167 // hasn't yet happened, and a fork will cause weird behavior to it.
2168 return LockDataDirectory(true);
2169}
2170
2172 // After daemonization get the data directory lock again and hold on to it
2173 // until exit. This creates a slight window for a race condition to happen,
2174 // however this condition is harmless: it will at most make us exit without
2175 // printing a message to console.
2176 if (!LockDataDirectory(false)) {
2177 // Detailed error printed inside LockDataDirectory
2178 return false;
2179 }
2180 return true;
2181}
2182
2185 // Create client interfaces for wallets that are supposed to be loaded
2186 // according to -wallet and -disablewallet options. This only constructs
2187 // the interfaces, it doesn't load wallet data. Wallets actually get loaded
2188 // when load() and start() interface methods are called below.
2190 return true;
2191}
2192
2193bool AppInitMain(Config &config, RPCServer &rpcServer,
2194 HTTPRPCRequestProcessor &httpRPCRequestProcessor,
2197 // Step 4a: application initialization
2198 const ArgsManager &args = *Assert(node.args);
2199 const CChainParams &chainparams = config.GetChainParams();
2200
2201 if (!CreatePidFile(args)) {
2202 // Detailed error printed inside CreatePidFile().
2203 return false;
2204 }
2205 if (!init::StartLogging(args)) {
2206 // Detailed error printed inside StartLogging().
2207 return false;
2208 }
2209
2210 LogPrintf("Using at most %i automatic connections (%i file descriptors "
2211 "available)\n",
2212 nMaxConnections, nFD);
2213
2214 // Warn about relative -datadir path.
2215 if (args.IsArgSet("-datadir") &&
2216 !args.GetPathArg("-datadir").is_absolute()) {
2217 LogPrintf("Warning: relative datadir option '%s' specified, which will "
2218 "be interpreted relative to the current working directory "
2219 "'%s'. This is fragile, because if bitcoin is started in the "
2220 "future from a different location, it will be unable to "
2221 "locate the current data files. There could also be data "
2222 "loss if bitcoin is started while in a temporary "
2223 "directory.\n",
2224 args.GetArg("-datadir", ""),
2225 fs::PathToString(fs::current_path()));
2226 }
2227
2228 assert(!node.scheduler);
2229 node.scheduler = std::make_unique<CScheduler>();
2230 auto &scheduler = *node.scheduler;
2231
2232 // Start the lightweight task scheduler thread
2233 scheduler.m_service_thread =
2234 std::thread(&util::TraceThread, "scheduler",
2235 [&] { node.scheduler->serviceQueue(); });
2236
2237 // Gather some entropy once per minute.
2238 scheduler.scheduleEvery(
2239 [] {
2241 return true;
2242 },
2243 std::chrono::minutes{1});
2244
2245 if (args.GetBoolArg("-logratelimit", BCLog::DEFAULT_LOGRATELIMIT)) {
2247 [&scheduler](auto func, auto window) {
2248 scheduler.scheduleEvery(std::move(func), window);
2249 },
2251 } else {
2252 LogInfo("Log rate limiting disabled\n");
2253 }
2254
2255 // Check disk space every 5 minutes to avoid db corruption.
2256 scheduler.scheduleEvery(
2257 [&args] {
2258 constexpr uint64_t min_disk_space = 250_MiB;
2259 if (!CheckDiskSpace(args.GetBlocksDirPath(), min_disk_space)) {
2260 LogPrintf("Shutting down due to lack of disk space!\n");
2261 StartShutdown();
2262 }
2263 return true;
2264 },
2265 std::chrono::minutes{5});
2266
2267 assert(!node.validation_signals);
2268 node.validation_signals = std::make_unique<ValidationSignals>(
2269 std::make_unique<SerialTaskRunner>(scheduler));
2270 auto &validation_signals = *node.validation_signals;
2271
2276 RegisterAllRPCCommands(config, rpcServer, tableRPC);
2277 for (const auto &client : node.chain_clients) {
2278 client->registerRpcs();
2279 }
2280#if ENABLE_ZMQ
2282#endif
2283
2290 if (args.GetBoolArg("-server", false)) {
2291 uiInterface.InitMessage_connect(SetRPCWarmupStatus);
2292 if (!AppInitServers(config, httpRPCRequestProcessor, node)) {
2293 return InitError(
2294 _("Unable to start HTTP server. See debug log for details."));
2295 }
2296 }
2297
2298 // Step 5: verify wallet database integrity
2299 for (const auto &client : node.chain_clients) {
2300 if (!client->verify()) {
2301 return false;
2302 }
2303 }
2304
2305 // Step 6: network initialization
2306
2307 // Note that we absolutely cannot open any actual connections
2308 // until the very end ("start node") as the UTXO/block state
2309 // is not yet setup and may end up being set up twice if we
2310 // need to reindex later.
2311
2312 fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
2313 fDiscover = args.GetBoolArg("-discover", true);
2314
2315 {
2316 // Initialize addrman
2317 assert(!node.addrman);
2318
2319 // Read asmap file if configured
2320 std::vector<bool> asmap;
2321 if (args.IsArgSet("-asmap")) {
2322 fs::path asmap_path =
2323 args.GetPathArg("-asmap", DEFAULT_ASMAP_FILENAME);
2324 if (!asmap_path.is_absolute()) {
2325 asmap_path = args.GetDataDirNet() / asmap_path;
2326 }
2327 if (!fs::exists(asmap_path)) {
2328 InitError(strprintf(_("Could not find asmap file %s"),
2329 fs::quoted(fs::PathToString(asmap_path))));
2330 return false;
2331 }
2332 asmap = DecodeAsmap(asmap_path);
2333 if (asmap.size() == 0) {
2334 InitError(strprintf(_("Could not parse asmap file %s"),
2335 fs::quoted(fs::PathToString(asmap_path))));
2336 return false;
2337 }
2338 const uint256 asmap_version = (HashWriter{} << asmap).GetHash();
2339 LogPrintf("Using asmap version %s for IP bucketing\n",
2340 asmap_version.ToString());
2341 } else {
2342 LogPrintf("Using /16 prefix for IP bucketing\n");
2343 }
2344
2345 uiInterface.InitMessage(_("Loading P2P addresses...").translated);
2346 auto addrman{LoadAddrman(chainparams, asmap, args)};
2347 if (!addrman) {
2348 return InitError(util::ErrorString(addrman));
2349 }
2350 node.addrman = std::move(*addrman);
2351 }
2352
2354 assert(!node.banman);
2355 node.banman = std::make_unique<BanMan>(
2356 args.GetDataDirNet() / "banlist", config.GetChainParams(), &uiInterface,
2357 args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
2358 assert(!node.connman);
2359 node.connman = std::make_unique<CConnman>(
2360 config, rng.rand64(), rng.rand64(), *node.addrman,
2361 args.GetBoolArg("-networkactive", true));
2362
2363 // Check port numbers
2364 for (const std::string port_option : {
2365 "-port",
2366 "-rpcport",
2367 }) {
2368 if (args.IsArgSet(port_option)) {
2369 const std::string port = args.GetArg(port_option, "");
2370 uint16_t n;
2371 if (!ParseUInt16(port, &n) || n == 0) {
2372 return InitError(InvalidPortErrMsg(port_option, port));
2373 }
2374 }
2375 }
2376
2377 for ([[maybe_unused]] const auto &[arg, supports_unix_socket] :
2378 std::vector<std::pair<std::string, bool>>{
2379 // arg name UNIX socket support
2380 {"-i2psam", false},
2381 {"-onion", true},
2382 {"-proxy", true},
2383 {"-rpcbind", false},
2384 {"-torcontrol", false},
2385 {"-whitebind", false},
2386 {"-zmqpubhashblock", true},
2387 {"-zmqpubhashtx", true},
2388 {"-zmqpubrawblock", true},
2389 {"-zmqpubrawtx", true},
2390 {"-zmqpubsequence", true},
2391 }) {
2392 for (const std::string &socket_addr : args.GetArgs(arg)) {
2393 std::string host_out;
2394 uint16_t port_out{0};
2395 if (!SplitHostPort(socket_addr, port_out, host_out)) {
2396#if HAVE_SOCKADDR_UN
2397 // Allow unix domain sockets for some options e.g.
2398 // unix:/some/file/path
2399 if (!supports_unix_socket ||
2400 socket_addr.find(ADDR_PREFIX_UNIX) != 0) {
2401 return InitError(InvalidPortErrMsg(arg, socket_addr));
2402 }
2403#else
2404 return InitError(InvalidPortErrMsg(arg, socket_addr));
2405#endif
2406 }
2407 }
2408 }
2409
2410 for (const std::string &socket_addr : args.GetArgs("-bind")) {
2411 std::string host_out;
2412 uint16_t port_out{0};
2413 std::string bind_socket_addr =
2414 socket_addr.substr(0, socket_addr.rfind('='));
2415 if (!SplitHostPort(bind_socket_addr, port_out, host_out)) {
2416 return InitError(InvalidPortErrMsg("-bind", socket_addr));
2417 }
2418 }
2419
2420 // sanitize comments per BIP-0014, format user agent and check total size
2421 std::vector<std::string> uacomments;
2422 for (const std::string &cmt : args.GetArgs("-uacomment")) {
2423 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT)) {
2424 return InitError(strprintf(
2425 _("User Agent comment (%s) contains unsafe characters."), cmt));
2426 }
2427 uacomments.push_back(cmt);
2428 }
2429 const std::string client_name = args.GetArg("-uaclientname", CLIENT_NAME);
2430 const std::string client_version =
2431 args.GetArg("-uaclientversion", FormatVersion(CLIENT_VERSION));
2432 if (client_name != SanitizeString(client_name, SAFE_CHARS_UA_COMMENT)) {
2433 return InitError(strprintf(
2434 _("-uaclientname (%s) contains invalid characters."), client_name));
2435 }
2436 if (client_version !=
2437 SanitizeString(client_version, SAFE_CHARS_UA_COMMENT)) {
2438 return InitError(
2439 strprintf(_("-uaclientversion (%s) contains invalid characters."),
2440 client_version));
2441 }
2442 const std::string strSubVersion =
2443 FormatUserAgent(client_name, client_version, uacomments);
2444 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
2445 return InitError(strprintf(
2446 _("Total length of network version string (%i) exceeds maximum "
2447 "length (%i). Reduce the number or size of uacomments."),
2448 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
2449 }
2450
2451 if (args.IsArgSet("-onlynet")) {
2452 std::set<enum Network> nets;
2453 for (const std::string &snet : args.GetArgs("-onlynet")) {
2454 enum Network net = ParseNetwork(snet);
2455 if (net == NET_UNROUTABLE) {
2456 return InitError(strprintf(
2457 _("Unknown network specified in -onlynet: '%s'"), snet));
2458 }
2459 nets.insert(net);
2460 }
2461 for (int n = 0; n < NET_MAX; n++) {
2462 enum Network net = (enum Network)n;
2463 assert(IsReachable(net));
2464 if (!nets.count(net)) {
2465 SetReachable(net, false);
2466 }
2467 }
2468 }
2469
2470 // Check for host lookup allowed before parsing any network related
2471 // parameters
2473
2474 Proxy onion_proxy;
2475
2476 bool proxyRandomize =
2477 args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
2478 // -proxy sets a proxy for all outgoing network traffic
2479 // -noproxy (or -proxy=0) as well as the empty string can be used to not set
2480 // a proxy, this is the default
2481 std::string proxyArg = args.GetArg("-proxy", "");
2482 if (proxyArg != "" && proxyArg != "0") {
2483 Proxy addrProxy;
2484 if (IsUnixSocketPath(proxyArg)) {
2485 addrProxy = Proxy(proxyArg, proxyRandomize);
2486 } else {
2487 const std::optional<CService> proxyAddr{
2488 Lookup(proxyArg, 9050, fNameLookup)};
2489 if (!proxyAddr.has_value()) {
2490 return InitError(strprintf(
2491 _("Invalid -proxy address or hostname: '%s'"), proxyArg));
2492 }
2493
2494 addrProxy = Proxy(proxyAddr.value(), proxyRandomize);
2495 }
2496
2497 if (!addrProxy.IsValid()) {
2498 return InitError(strprintf(
2499 _("Invalid -proxy address or hostname: '%s'"), proxyArg));
2500 }
2501
2502 SetProxy(NET_IPV4, addrProxy);
2503 SetProxy(NET_IPV6, addrProxy);
2504 SetNameProxy(addrProxy);
2505 onion_proxy = addrProxy;
2506 }
2507
2508 const bool onlynet_used_with_onion{args.IsArgSet("-onlynet") &&
2510
2511 // -onion can be used to set only a proxy for .onion, or override normal
2512 // proxy for .onion addresses.
2513 // -noonion (or -onion=0) disables connecting to .onion entirely. An empty
2514 // string is used to not override the onion proxy (in which case it defaults
2515 // to -proxy set above, or none)
2516 std::string onionArg = args.GetArg("-onion", "");
2517 if (onionArg != "") {
2518 if (onionArg == "0") {
2519 // Handle -noonion/-onion=0
2520 onion_proxy = Proxy{};
2521 if (onlynet_used_with_onion) {
2522 return InitError(_("Outbound connections restricted to Tor "
2523 "(-onlynet=onion) but the proxy for "
2524 "reaching the Tor network is explicitly "
2525 "forbidden: -onion=0"));
2526 }
2527 } else {
2528 if (IsUnixSocketPath(onionArg)) {
2529 onion_proxy = Proxy(onionArg, proxyRandomize);
2530 } else {
2531 const std::optional<CService> addr{
2532 Lookup(onionArg, 9050, fNameLookup)};
2533 if (!addr.has_value() || !addr->IsValid()) {
2534 return InitError(
2535 strprintf(_("Invalid -onion address or hostname: '%s'"),
2536 onionArg));
2537 }
2538
2539 onion_proxy = Proxy(addr.value(), proxyRandomize);
2540 }
2541 }
2542 }
2543
2544 if (onion_proxy.IsValid()) {
2545 SetProxy(NET_ONION, onion_proxy);
2546 } else {
2547 // If -listenonion is set, then we will (try to) connect to the Tor
2548 // control port later from the torcontrol thread and may retrieve the
2549 // onion proxy from there.
2550 const bool listenonion_disabled{
2551 !args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
2552 if (onlynet_used_with_onion && listenonion_disabled) {
2553 return InitError(_("Outbound connections restricted to Tor "
2554 "(-onlynet=onion) but the proxy for "
2555 "reaching the Tor network is not provided: none "
2556 "of -proxy, -onion or "
2557 "-listenonion is given"));
2558 }
2559 SetReachable(NET_ONION, false);
2560 }
2561
2562 for (const std::string &strAddr : args.GetArgs("-externalip")) {
2563 const std::optional<CService> addrLocal{
2564 Lookup(strAddr, GetListenPort(), fNameLookup)};
2565 if (addrLocal.has_value() && addrLocal->IsValid()) {
2566 AddLocal(addrLocal.value(), LOCAL_MANUAL);
2567 } else {
2568 return InitError(ResolveErrMsg("externalip", strAddr));
2569 }
2570 }
2571
2572#if ENABLE_ZMQ
2574 [&chainman = node.chainman](CBlock &block, const CBlockIndex &index) {
2575 assert(chainman);
2576 return chainman->m_blockman.ReadBlock(block, index);
2577 });
2578
2580 validation_signals.RegisterValidationInterface(
2582 }
2583#endif
2584
2585 // Step 7: load block chain
2586
2587 node.notifications =
2588 std::make_unique<KernelNotifications>(node.exit_status);
2589 ReadNotificationArgs(args, *node.notifications);
2590 bool fReindexChainState = args.GetBoolArg("-reindex-chainstate", false);
2591
2592 ChainstateManager::Options chainman_opts{
2593 .config = config,
2594 .datadir = args.GetDataDirNet(),
2595 .adjusted_time_callback = GetAdjustedTime,
2596 .notifications = *node.notifications,
2597 .signals = &validation_signals,
2598 };
2599 // no error can happen, already checked in AppInitParameterInteraction
2600 Assert(!ApplyArgsManOptions(args, chainman_opts));
2601
2602 if (chainman_opts.checkpoints_enabled) {
2603 LogPrintf("Checkpoints will be verified.\n");
2604 } else {
2605 LogPrintf("Skipping checkpoint verification.\n");
2606 }
2607
2608 BlockManager::Options blockman_opts{
2609 .chainparams = chainman_opts.config.GetChainParams(),
2610 .blocks_dir = args.GetBlocksDirPath(),
2611 .notifications = chainman_opts.notifications,
2612 };
2613 // no error can happen, already checked in AppInitParameterInteraction
2614 Assert(!ApplyArgsManOptions(args, blockman_opts));
2615
2616 // cache size calculations
2617 const auto [index_cache_sizes, kernel_cache_sizes] =
2618 CalculateCacheSizes(args, g_enabled_filter_types.size());
2619
2620 LogInfo("Cache configuration:\n");
2621 LogInfo("* Using %.1f MiB for block index database\n",
2622 kernel_cache_sizes.block_tree_db * (1.0 / 1024 / 1024));
2623 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
2624 LogInfo("* Using %.1f MiB for transaction index database\n",
2625 index_cache_sizes.tx_index * (1.0 / 1024 / 1024));
2626 }
2627 for (BlockFilterType filter_type : g_enabled_filter_types) {
2628 LogInfo("* Using %.1f MiB for %s block filter index database\n",
2629 index_cache_sizes.filter_index * (1.0 / 1024 / 1024),
2630 BlockFilterTypeName(filter_type));
2631 }
2632 LogInfo("* Using %.1f MiB for chain state database\n",
2633 kernel_cache_sizes.coins_db * (1.0 / 1024 / 1024));
2634
2635 assert(!node.mempool);
2636 assert(!node.chainman);
2637
2638 CTxMemPool::Options mempool_opts{
2639 .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
2640 .signals = &validation_signals,
2641 };
2642 if (const auto err{ApplyArgsManOptions(args, chainparams, mempool_opts)}) {
2643 return InitError(*err);
2644 }
2645 mempool_opts.check_ratio =
2646 std::clamp<int>(mempool_opts.check_ratio, 0, 1'000'000);
2647
2648 // FIXME: this legacy limit comes from the DEFAULT_DESCENDANT_SIZE_LIMIT
2649 // (101) that was enforced before the wellington activation. While it's
2650 // still a good idea to have some minimum mempool size, using this value as
2651 // a threshold is no longer relevant.
2652 int64_t nMempoolSizeMin = 101 * 1000 * 40;
2653 if (mempool_opts.max_size_bytes < 0 ||
2654 (!chainparams.IsTestChain() &&
2655 mempool_opts.max_size_bytes < nMempoolSizeMin)) {
2656 return InitError(strprintf(_("-maxmempool must be at least %d MB"),
2657 std::ceil(nMempoolSizeMin / 1000000.0)));
2658 }
2659 LogInfo("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of "
2660 "unused mempool space)\n",
2661 kernel_cache_sizes.coins * (1.0 / 1024 / 1024),
2662 mempool_opts.max_size_bytes * (1.0 / 1024 / 1024));
2663
2664 for (bool fLoaded = false; !fLoaded && !ShutdownRequested();) {
2665 node.mempool = std::make_unique<CTxMemPool>(config, mempool_opts);
2666
2667 node.chainman = std::make_unique<ChainstateManager>(
2668 node.kernel->interrupt, chainman_opts, blockman_opts);
2669 ChainstateManager &chainman = *node.chainman;
2670
2671 // This is defined and set here instead of inline in validation.h to
2672 // avoid a hard dependency between validation and index/base, since the
2673 // latter is not in libbitcoinkernel.
2674 chainman.snapshot_download_completed = [&node]() {
2675 if (!node.chainman->m_blockman.IsPruneMode()) {
2676 LogPrintf("[snapshot] re-enabling NODE_NETWORK services\n");
2677 node.connman->AddLocalServices(NODE_NETWORK);
2678 }
2679
2680 LogPrintf("[snapshot] restarting indexes\n");
2681
2682 // Drain the validation interface queue to ensure that the old
2683 // indexes don't have any pending work.
2684 Assert(node.validation_signals)->SyncWithValidationInterfaceQueue();
2685
2686 for (auto *index : node.indexes) {
2687 index->Interrupt();
2688 index->Stop();
2689 if (!(index->Init() && index->StartBackgroundSync())) {
2690 LogPrintf("[snapshot] WARNING failed to restart index %s "
2691 "on snapshot chain\n",
2692 index->GetName());
2693 }
2694 }
2695 };
2696
2698 options.mempool = Assert(node.mempool.get());
2699 options.reindex = blockman_opts.reindex;
2700 options.reindex_chainstate = fReindexChainState;
2701 options.prune = chainman.m_blockman.IsPruneMode();
2702 options.check_blocks =
2703 args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
2704 options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
2706 args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
2708 options.coins_error_cb = [] {
2709 uiInterface.ThreadSafeMessageBox(
2710 _("Error reading from database, shutting down."), "",
2712 };
2713
2714 uiInterface.InitMessage(_("Loading block index...").translated);
2715
2716 const int64_t load_block_index_start_time = GetTimeMillis();
2717 auto catch_exceptions = [](auto &&f) {
2718 try {
2719 return f();
2720 } catch (const std::exception &e) {
2721 LogPrintf("%s\n", e.what());
2722 return std::make_tuple(node::ChainstateLoadStatus::FAILURE,
2723 _("Error opening block database"));
2724 }
2725 };
2726 auto [status, error] =
2727 catch_exceptions([&, &kernel_cache_sizes_ = kernel_cache_sizes] {
2728 return LoadChainstate(chainman, kernel_cache_sizes_, options);
2729 });
2731 uiInterface.InitMessage(_("Verifying blocks...").translated);
2732 if (chainman.m_blockman.m_have_pruned &&
2733 options.check_blocks > MIN_BLOCKS_TO_KEEP) {
2734 LogWarning("pruned datadir may not have more than %d "
2735 "blocks; only checking available blocks\n",
2737 }
2738 std::tie(status, error) = catch_exceptions(
2739 [&] { return VerifyLoadedChainstate(chainman, options); });
2741 WITH_LOCK(cs_main, return node.chainman->LoadRecentHeadersTime(
2742 node.chainman->m_options.datadir /
2744 fLoaded = true;
2745 LogPrintf(" block index %15dms\n",
2746 GetTimeMillis() - load_block_index_start_time);
2747 }
2748 }
2749
2752 status ==
2754 return InitError(error);
2755 }
2756
2757 if (!fLoaded && !ShutdownRequested()) {
2758 // first suggest a reindex
2759 if (!blockman_opts.reindex) {
2760 bool fRet = uiInterface.ThreadSafeQuestion(
2761 error + Untranslated(".\n\n") +
2762 _("Do you want to rebuild the block database now?"),
2763 error.original + ".\nPlease restart with -reindex or "
2764 "-reindex-chainstate to recover.",
2765 "",
2768 if (fRet) {
2769 blockman_opts.reindex = true;
2770 AbortShutdown();
2771 } else {
2772 LogPrintf("Aborted block database rebuild. Exiting.\n");
2773 return false;
2774 }
2775 } else {
2776 return InitError(error);
2777 }
2778 }
2779 }
2780
2781 // As LoadBlockIndex can take several minutes, it's possible the user
2782 // requested to kill the GUI during the last operation. If so, exit.
2783 // As the program has not fully started yet, Shutdown() is possibly
2784 // overkill.
2785 if (ShutdownRequested()) {
2786 LogPrintf("Shutdown requested. Exiting.\n");
2787 return false;
2788 }
2789
2790 ChainstateManager &chainman = *Assert(node.chainman);
2791
2792 if (args.GetBoolArg("-avalanche", AVALANCHE_DEFAULT_ENABLED)) {
2793 // Initialize Avalanche.
2794 bilingual_str avalancheError;
2796 args, *node.chain, node.connman.get(), chainman, node.mempool.get(),
2797 scheduler, avalancheError);
2798 if (!node.avalanche) {
2799 InitError(avalancheError);
2800 return false;
2801 }
2802
2803 if (node.avalanche->isAvalancheServiceAvailable()) {
2804 nLocalServices = ServiceFlags(nLocalServices | NODE_AVALANCHE);
2805 }
2806 }
2807
2808 PeerManager::Options peerman_opts{};
2809 ApplyArgsManOptions(args, peerman_opts);
2810
2811 assert(!node.peerman);
2812 node.peerman = PeerManager::make(*node.connman, *node.addrman,
2813 node.banman.get(), chainman, *node.mempool,
2814 node.avalanche.get(), peerman_opts);
2815 validation_signals.RegisterValidationInterface(node.peerman.get());
2816
2817 // Encoded addresses using cashaddr instead of base58.
2818 // We do this by default to avoid confusion with BTC addresses.
2819 config.SetCashAddrEncoding(
2820 args.GetBoolArg("-usecashaddr", DEFAULT_USEASHADDR));
2821
2822 // Step 8: load indexers
2823
2824 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
2825 auto result{
2827 chainman.m_blockman.m_block_tree_db)))};
2828 if (!result) {
2829 return InitError(util::ErrorString(result));
2830 }
2831
2832 g_txindex = std::make_unique<TxIndex>(
2833 interfaces::MakeChain(node, Params()), index_cache_sizes.tx_index,
2834 false, chainman.m_blockman.m_reindexing);
2835 node.indexes.emplace_back(g_txindex.get());
2836 }
2837
2838 for (const auto &filter_type : g_enabled_filter_types) {
2840 [&] { return interfaces::MakeChain(node, Params()); }, filter_type,
2841 index_cache_sizes.filter_index, false,
2842 chainman.m_blockman.m_reindexing);
2843 node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
2844 }
2845
2846 if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
2847 g_coin_stats_index = std::make_unique<CoinStatsIndex>(
2848 interfaces::MakeChain(node, Params()), /* cache size */ 0, false,
2849 chainman.m_blockman.m_reindexing);
2850 node.indexes.emplace_back(g_coin_stats_index.get());
2851 }
2852
2853 // Init indexes
2854 for (auto index : node.indexes) {
2855 if (!index->Init()) {
2856 return false;
2857 }
2858 }
2859
2860 const bool background_sync_in_progress{WITH_LOCK(
2861 chainman.GetMutex(), return chainman.BackgroundSyncInProgress())};
2862#if ENABLE_CHRONIK
2863 if (args.GetBoolArg("-chronik", DEFAULT_CHRONIK)) {
2864 if (background_sync_in_progress) {
2865 return InitError(
2866 _("Assumeutxo is incompatible with -chronik. Wait for "
2867 "background sync to complete before enabling Chronik."));
2868 }
2869
2870 const bool fReindexChronik = chainman.m_blockman.m_reindexing ||
2871 args.GetBoolArg("-chronikreindex", false);
2872 if (!chronik::Start(args, config, node, fReindexChronik)) {
2873 return false;
2874 }
2875 }
2876#endif
2877
2878 // Step 9: load wallet
2879 for (const auto &client : node.chain_clients) {
2880 if (!client->load()) {
2881 return false;
2882 }
2883 }
2884
2885 // Step 10: data directory maintenance
2886
2887 // if pruning, perform the initial blockstore prune
2888 // after any wallet rescanning has taken place.
2889 if (chainman.m_blockman.IsPruneMode()) {
2890 if (!chainman.m_blockman.m_reindexing) {
2891 LOCK(cs_main);
2892 for (Chainstate *chainstate : chainman.GetAll()) {
2893 uiInterface.InitMessage(_("Pruning blockstore...").translated);
2894 chainstate->PruneAndFlush();
2895 }
2896 }
2897 } else {
2898 // Prior to setting NODE_NETWORK, check if we can provide historical
2899 // blocks.
2900 if (!background_sync_in_progress) {
2901 LogPrintf("Setting NODE_NETWORK on non-prune mode\n");
2902 nLocalServices = ServiceFlags(nLocalServices | NODE_NETWORK);
2903 } else {
2904 LogPrintf("Running node in NODE_NETWORK_LIMITED mode until "
2905 "snapshot background sync completes\n");
2906 }
2907 }
2908
2909 // Step 11: import blocks
2910 if (!CheckDiskSpace(args.GetDataDirNet())) {
2911 InitError(
2912 strprintf(_("Error: Disk space is low for %s"),
2914 return false;
2915 }
2916 if (!CheckDiskSpace(args.GetBlocksDirPath())) {
2917 InitError(
2918 strprintf(_("Error: Disk space is low for %s"),
2920 return false;
2921 }
2922
2923 // Either install a handler to notify us when genesis activates, or set
2924 // fHaveGenesis directly.
2925 // No locking, as this happens before any background thread is started.
2926 boost::signals2::connection block_notify_genesis_wait_connection;
2927 if (WITH_LOCK(chainman.GetMutex(),
2928 return chainman.ActiveChain().Tip() == nullptr)) {
2929 block_notify_genesis_wait_connection =
2930 uiInterface.NotifyBlockTip_connect(
2931 std::bind(BlockNotifyGenesisWait, std::placeholders::_2));
2932 } else {
2933 fHaveGenesis = true;
2934 }
2935
2936#if defined(HAVE_SYSTEM)
2937 const std::string block_notify = args.GetArg("-blocknotify", "");
2938 if (!block_notify.empty()) {
2939 uiInterface.NotifyBlockTip_connect([block_notify](
2940 SynchronizationState sync_state,
2941 const CBlockIndex *pBlockIndex) {
2942 if (sync_state != SynchronizationState::POST_INIT || !pBlockIndex) {
2943 return;
2944 }
2945 std::string command = block_notify;
2946 ReplaceAll(command, "%s", pBlockIndex->GetBlockHash().GetHex());
2947 std::thread t(runCommand, command);
2948 // thread runs free
2949 t.detach();
2950 });
2951 }
2952#endif
2953
2954 std::vector<fs::path> vImportFiles;
2955 for (const std::string &strFile : args.GetArgs("-loadblock")) {
2956 vImportFiles.push_back(fs::PathFromString(strFile));
2957 }
2958
2959 avalanche::Processor *const avalanche = node.avalanche.get();
2960 chainman.m_thread_load = std::thread(
2961 &util::TraceThread, "initload", [=, &chainman, &args, &node] {
2962 // Import blocks
2963 ImportBlocks(chainman, avalanche, vImportFiles);
2964 if (args.GetBoolArg("-stopafterblockimport",
2966 LogPrintf("Stopping after block import\n");
2967 StartShutdown();
2968 return;
2969 }
2970 // Start indexes initial sync
2972 bilingual_str err_str =
2973 _("Failed to start indexes, shutting down..");
2974 chainman.GetNotifications().fatalError(err_str.original,
2975 err_str);
2976 return;
2977 }
2978 // Load mempool from disk
2979 if (auto *pool{chainman.ActiveChainstate().GetMempool()}) {
2980 LoadMempool(*pool,
2981 ShouldPersistMempool(args) ? MempoolPath(args)
2982 : fs::path{},
2983 chainman.ActiveChainstate(), {});
2984 pool->SetLoadTried(!chainman.m_interrupt);
2985 }
2986 });
2987
2988 // Wait for genesis block to be processed
2989 {
2991 // We previously could hang here if StartShutdown() is called prior to
2992 // ImportBlocks getting started, so instead we just wait on a timer to
2993 // check ShutdownRequested() regularly.
2994 while (!fHaveGenesis && !ShutdownRequested()) {
2995 g_genesis_wait_cv.wait_for(lock, std::chrono::milliseconds(500));
2996 }
2997 block_notify_genesis_wait_connection.disconnect();
2998 }
2999
3000 if (ShutdownRequested()) {
3001 return false;
3002 }
3003
3004 // Step 12: start node
3005
3006 int chain_active_height;
3007
3009 {
3010 LOCK(cs_main);
3011 LogPrintf("block tree size = %u\n", chainman.BlockIndex().size());
3012 chain_active_height = chainman.ActiveChain().Height();
3013 if (tip_info) {
3014 tip_info->block_height = chain_active_height;
3015 tip_info->block_time =
3016 chainman.ActiveChain().Tip()
3017 ? chainman.ActiveChain().Tip()->GetBlockTime()
3018 : chainman.GetParams().GenesisBlock().GetBlockTime();
3020 chainman.GetParams().TxData(), chainman.ActiveChain().Tip());
3021 }
3022 if (tip_info && chainman.m_best_header) {
3023 tip_info->header_height = chainman.m_best_header->nHeight;
3024 tip_info->header_time = chainman.m_best_header->GetBlockTime();
3025 }
3026 }
3027 LogPrintf("nBestHeight = %d\n", chain_active_height);
3028 if (node.peerman) {
3029 node.peerman->SetBestHeight(chain_active_height);
3030 }
3031
3032 // Map ports with NAT-PMP
3033 StartMapPort(args.GetBoolArg("-natpmp", DEFAULT_NATPMP));
3034
3035 CConnman::Options connOptions;
3036 connOptions.nLocalServices = nLocalServices;
3037 connOptions.nMaxConnections = nMaxConnections;
3038 connOptions.m_max_avalanche_outbound =
3039 node.avalanche
3040 ? args.GetIntArg("-maxavalancheoutbound",
3042 : 0;
3043 connOptions.m_max_outbound_full_relay = std::min(
3045 connOptions.nMaxConnections - connOptions.m_max_avalanche_outbound);
3046 connOptions.m_max_outbound_block_relay = std::min(
3048 connOptions.nMaxConnections - connOptions.m_max_avalanche_outbound -
3049 connOptions.m_max_outbound_full_relay);
3051 connOptions.nMaxFeeler = MAX_FEELER_CONNECTIONS;
3052 connOptions.uiInterface = &uiInterface;
3053 connOptions.m_banman = node.banman.get();
3054 connOptions.m_msgproc.push_back(node.peerman.get());
3055 if (node.avalanche) {
3056 connOptions.m_msgproc.push_back(node.avalanche.get());
3057 }
3058 connOptions.nSendBufferMaxSize =
3059 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
3060 connOptions.nReceiveFloodSize =
3061 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
3062 connOptions.m_added_nodes = args.GetArgs("-addnode");
3063
3064 connOptions.nMaxOutboundLimit =
3065 1024 * 1024 *
3066 args.GetIntArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET);
3067 connOptions.m_peer_connect_timeout = peer_connect_timeout;
3068 connOptions.whitelist_forcerelay =
3069 args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
3070 connOptions.whitelist_relay =
3071 args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
3072
3073 // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
3074 const uint16_t default_bind_port = static_cast<uint16_t>(
3075 args.GetIntArg("-port", config.GetChainParams().GetDefaultPort()));
3076
3077 const auto BadPortWarning = [](const char *prefix, uint16_t port) {
3078 return strprintf(_("%s request to listen on port %u. This port is "
3079 "considered \"bad\" and "
3080 "thus it is unlikely that any Bitcoin ABC peers "
3081 "connect to it. See "
3082 "doc/p2p-bad-ports.md for details and a full list."),
3083 prefix, port);
3084 };
3085
3086 for (const std::string &bind_arg : args.GetArgs("-bind")) {
3087 std::optional<CService> bind_addr;
3088 const size_t index = bind_arg.rfind('=');
3089 if (index == std::string::npos) {
3090 bind_addr =
3091 Lookup(bind_arg, default_bind_port, /*fAllowLookup=*/false);
3092 if (bind_addr.has_value()) {
3093 connOptions.vBinds.push_back(bind_addr.value());
3094 if (IsBadPort(bind_addr.value().GetPort())) {
3096 BadPortWarning("-bind", bind_addr.value().GetPort()));
3097 }
3098 continue;
3099 }
3100 } else {
3101 const std::string network_type = bind_arg.substr(index + 1);
3102 if (network_type == "onion") {
3103 const std::string truncated_bind_arg =
3104 bind_arg.substr(0, index);
3105 bind_addr =
3106 Lookup(truncated_bind_arg,
3107 BaseParams().OnionServiceTargetPort(), false);
3108 if (bind_addr.has_value()) {
3109 connOptions.onion_binds.push_back(bind_addr.value());
3110 continue;
3111 }
3112 }
3113 }
3114 return InitError(ResolveErrMsg("bind", bind_arg));
3115 }
3116
3117 for (const std::string &strBind : args.GetArgs("-whitebind")) {
3118 NetWhitebindPermissions whitebind;
3119 bilingual_str error;
3120 if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) {
3121 return InitError(error);
3122 }
3123 connOptions.vWhiteBinds.push_back(whitebind);
3124 }
3125
3126 // If the user did not specify -bind= or -whitebind= then we bind
3127 // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
3128 connOptions.bind_on_any =
3129 args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
3130
3131 // Emit a warning if a bad port is given to -port= but only if -bind and
3132 // -whitebind are not given, because if they are, then -port= is ignored.
3133 if (connOptions.bind_on_any && args.IsArgSet("-port")) {
3134 const uint16_t port_arg = args.GetIntArg("-port", 0);
3135 if (IsBadPort(port_arg)) {
3136 InitWarning(BadPortWarning("-port", port_arg));
3137 }
3138 }
3139
3140 CService onion_service_target;
3141 if (!connOptions.onion_binds.empty()) {
3142 onion_service_target = connOptions.onion_binds.front();
3143 } else if (!connOptions.vBinds.empty()) {
3144 onion_service_target = connOptions.vBinds.front();
3145 } else {
3146 onion_service_target = DefaultOnionServiceTarget();
3147 connOptions.onion_binds.push_back(onion_service_target);
3148 }
3149
3150 if (args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
3151 if (connOptions.onion_binds.size() > 1) {
3153 _("More than one onion bind address is provided. Using %s "
3154 "for the automatically created Tor onion service."),
3155 onion_service_target.ToStringAddrPort()));
3156 }
3157 StartTorControl(onion_service_target);
3158 }
3159
3160 if (connOptions.bind_on_any) {
3161 // Only add all IP addresses of the machine if we would be listening on
3162 // any address - 0.0.0.0 (IPv4) and :: (IPv6).
3163 Discover();
3164 }
3165
3166 for (const auto &net : args.GetArgs("-whitelist")) {
3168 ConnectionDirection connection_direction;
3169 bilingual_str error;
3170 if (!NetWhitelistPermissions::TryParse(net, subnet,
3171 connection_direction, error)) {
3172 return InitError(error);
3173 }
3174 if (connection_direction & ConnectionDirection::In) {
3175 connOptions.vWhitelistedRangeIncoming.push_back(subnet);
3176 }
3177 if (connection_direction & ConnectionDirection::Out) {
3178 connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
3179 }
3180 }
3181
3182 connOptions.vSeedNodes = args.GetArgs("-seednode");
3183
3184 // Initiate outbound connections unless connect=0
3185 connOptions.m_use_addrman_outgoing = !args.IsArgSet("-connect");
3186 if (!connOptions.m_use_addrman_outgoing) {
3187 const auto connect = args.GetArgs("-connect");
3188 if (connect.size() != 1 || connect[0] != "0") {
3189 connOptions.m_specified_outgoing = connect;
3190 }
3191 }
3192
3193 const std::string &i2psam_arg = args.GetArg("-i2psam", "");
3194 if (!i2psam_arg.empty()) {
3195 const std::optional<CService> addr{
3196 Lookup(i2psam_arg, 7656, fNameLookup)};
3197 if (!addr.has_value() || !addr->IsValid()) {
3198 return InitError(strprintf(
3199 _("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
3200 }
3201 SetProxy(NET_I2P, Proxy{addr.value()});
3202 } else {
3203 SetReachable(NET_I2P, false);
3204 }
3205
3206 connOptions.m_i2p_accept_incoming =
3207 args.GetBoolArg("-i2pacceptincoming", true);
3208
3209 if (!node.connman->Start(scheduler, connOptions)) {
3210 return false;
3211 }
3212
3213 // Step 13: finished
3214
3215 // At this point, the RPC is "started", but still in warmup, which means it
3216 // cannot yet be called. Before we make it callable, we need to make sure
3217 // that the RPC's view of the best block is valid and consistent with
3218 // ChainstateManager's active tip.
3219 //
3220 // If we do not do this, RPC's view of the best block will be height=0 and
3221 // hash=0x0. This will lead to erroroneous responses for things like
3222 // waitforblockheight.
3224 WITH_LOCK(chainman.GetMutex(), return chainman.ActiveTip()));
3226
3227 uiInterface.InitMessage(_("Done loading").translated);
3228
3229 for (const auto &client : node.chain_clients) {
3230 client->start(scheduler);
3231 }
3232
3233 BanMan *banman = node.banman.get();
3234 scheduler.scheduleEvery(
3235 [banman] {
3236 banman->DumpBanlist();
3237 return true;
3238 },
3240
3241 // Start Avalanche's event loop.
3242 if (node.avalanche) {
3243 node.avalanche->startEventLoop(scheduler);
3244 }
3245
3246 if (node.peerman) {
3247 node.peerman->StartScheduledTasks(scheduler);
3248 }
3249
3250#if HAVE_SYSTEM
3251 StartupNotify(args);
3252#endif
3253
3254 return true;
3255}
3256
3258 // Find the oldest block among all indexes.
3259 // This block is used to verify that we have the required blocks' data
3260 // stored on disk, starting from that point up to the current tip.
3261 // indexes_start_block='nullptr' means "start from height 0".
3262 std::optional<const CBlockIndex *> indexes_start_block;
3263 std::string older_index_name;
3264 ChainstateManager &chainman = *Assert(node.chainman);
3265 const Chainstate &chainstate =
3266 WITH_LOCK(::cs_main, return chainman.GetChainstateForIndexing());
3267 const CChain &index_chain = chainstate.m_chain;
3268
3269 for (auto index : node.indexes) {
3270 const IndexSummary &summary = index->GetSummary();
3271 if (summary.synced) {
3272 continue;
3273 }
3274
3275 // Get the last common block between the index best block and the active
3276 // chain
3277 LOCK(::cs_main);
3278 const CBlockIndex *pindex = chainman.m_blockman.LookupBlockIndex(
3279 BlockHash{summary.best_block_hash});
3280 if (!index_chain.Contains(pindex)) {
3281 pindex = index_chain.FindFork(pindex);
3282 }
3283
3284 if (!indexes_start_block || !pindex ||
3285 pindex->nHeight < indexes_start_block.value()->nHeight) {
3286 indexes_start_block = pindex;
3287 older_index_name = summary.name;
3288 if (!pindex) {
3289 // Starting from genesis so no need to look for earlier block.
3290 break;
3291 }
3292 }
3293 };
3294
3295 // Verify all blocks needed to sync to current tip are present.
3296 if (indexes_start_block) {
3297 LOCK(::cs_main);
3298 const CBlockIndex *start_block = *indexes_start_block;
3299 if (!start_block) {
3300 start_block = chainman.ActiveChain().Genesis();
3301 }
3302 if (!chainman.m_blockman.CheckBlockDataAvailability(
3303 *index_chain.Tip(), *Assert(start_block))) {
3304 return InitError(strprintf(
3305 Untranslated("%s best block of the index goes beyond pruned "
3306 "data. Please disable the index or reindex (which "
3307 "will download the whole blockchain again)"),
3308 older_index_name));
3309 }
3310 }
3311
3312 // Start threads
3313 for (auto index : node.indexes) {
3314 if (!index->StartBackgroundSync()) {
3315 return false;
3316 }
3317 }
3318 return true;
3319}
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:271
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:705
const char *const BITCOIN_SETTINGS_FILENAME
Definition: args.cpp:37
ArgsManager gArgs
Definition: args.cpp:39
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:36
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:239
std::vector< bool > DecodeAsmap(fs::path path)
Read asmap from provided binary file.
Definition: asmap.cpp:295
static constexpr bool DEFAULT_PERSIST_AVAPEERS
Default for -persistavapeers.
Definition: avalanche.h:56
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:46
static constexpr bool DEFAULT_AVALANCHE_STAKING_PRECONSENSUS
Default for -avalanchestakingpreconsensus.
Definition: avalanche.h:62
static constexpr size_t AVALANCHE_DEFAULT_PEER_REPLACEMENT_COOLDOWN
Peer replacement cooldown time default value in seconds.
Definition: avalanche.h:27
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:53
static constexpr bool DEFAULT_AVALANCHE_PRECONSENSUS
Default for -avalanchepreconsensus.
Definition: avalanche.h:59
static constexpr Amount AVALANCHE_DEFAULT_MIN_QUORUM_STAKE
Default minimum cumulative stake of all known peers that constitutes a usable quorum.
Definition: avalanche.h:39
static constexpr size_t AVALANCHE_DEFAULT_CONFLICTING_PROOF_COOLDOWN
Conflicting proofs cooldown time default value in seconds.
Definition: avalanche.h:21
static constexpr bool DEFAULT_AVALANCHE_MINING_PRECONSENSUS
Default for -avalanchepreconsensusmining.
Definition: avalanche.h:65
static constexpr bool AVALANCHE_DEFAULT_ENABLED
Is avalanche enabled by default.
Definition: avalanche.h:15
static constexpr size_t AVALANCHE_DEFAULT_COOLDOWN
Avalanche default cooldown in milliseconds.
Definition: avalanche.h:33
static constexpr unsigned int DEFAULT_MISBEHAVING_BANTIME
Definition: banman.h:20
static constexpr std::chrono::minutes DUMP_BANS_INTERVAL
How often to dump banned addresses/subnets to disk.
Definition: banman.h:23
void RPCNotifyBlockChange(const CBlockIndex *pindex)
Callback for when block tip changed.
Definition: blockchain.cpp:256
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 int DEFAULT_SCRIPTCHECK_THREADS
-par default (number of script-checking threads, 0 = auto)
static constexpr int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
static constexpr bool DEFAULT_CHECKPOINTS_ENABLED
static constexpr auto DEFAULT_MAX_TIP_AGE
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:87
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:140
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
Definition: args.cpp:164
@ 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:761
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:361
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:371
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:494
fs::path GetBlocksDirPath() const
Get blocks directory path.
Definition: args.cpp:299
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:462
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:557
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:524
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: args.cpp:610
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:588
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:285
static std::shared_ptr< LogRateLimiter > Create(SchedulerFunction &&scheduler_func, uint64_t max_bytes, std::chrono::seconds reset_window)
Definition: logging.cpp:367
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:59
void DumpBanlist()
Definition: banman.cpp:43
void Stop()
Stops the instance from staying in sync with blockchain updates.
Definition: base.cpp:417
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:403
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:138
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:154
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:147
int Height() const
Return the maximal height in the chain.
Definition: chain.h:190
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:170
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
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:573
std::string ToStringAddrPort() 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:725
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:824
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:1174
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:1454
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:1428
std::thread m_thread_load
Definition: validation.h:1315
kernel::Notifications & GetNotifications() const
Definition: validation.h:1286
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:1309
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1435
bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
The state of a background sync (for net processing)
Definition: validation.h:1442
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1313
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
Definition: validation.h:1267
const CChainParams & GetParams() const
Definition: validation.h:1271
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1429
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1394
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1318
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
Fast randomness source.
Definition: random.h:411
uint64_t rand64() noexcept
Generate a random 64-bit integer.
Definition: random.h:432
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:99
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)
Definition: netbase.h:67
bool IsValid() const
Definition: netbase.h:82
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:225
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:114
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:415
CBlockIndex * LookupBlockIndex(const BlockHash &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
std::atomic_bool m_reindexing
Tracks if a reindex is currently in progress.
Definition: blockstorage.h:267
bool IsPruneMode() const
Whether running in -prune mode.
Definition: blockstorage.h:355
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
int RaiseFileDescriptorLimit(int nMinFD)
This function tries to raise the file descriptor limit to the requested number.
Definition: fs_helpers.cpp:168
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: fs_helpers.cpp:97
void InterruptHTTPRPC()
Interrupt HTTP RPC subsystem.
Definition: httprpc.cpp:487
void StopHTTPRPC()
Stop HTTP RPC subsystem.
Definition: httprpc.cpp:491
bool StartHTTPRPC(HTTPRPCRequestProcessor &httpRPCRequestProcessor)
Start HTTP RPC subsystem.
Definition: httprpc.cpp:466
void StartREST(const std::any &context)
Start HTTP REST subsystem.
Definition: rest.cpp:828
void StopREST()
Stop HTTP REST subsystem.
Definition: rest.cpp:840
void InterruptREST()
Interrupt RPC REST subsystem.
Definition: rest.cpp:838
void InterruptHTTPServer()
Interrupt HTTP server threads.
Definition: httpserver.cpp:551
void StartHTTPServer()
Start HTTP server.
Definition: httpserver.cpp:540
void StopHTTPServer()
Stop HTTP server.
Definition: httpserver.cpp:562
bool InitHTTPServer(Config &config)
Initialize HTTP server.
Definition: httpserver.cpp:473
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:163
static bool CreatePidFile(const ArgsManager &args)
Definition: init.cpp:170
static const bool DEFAULT_PROXYRANDOMIZE
Definition: init.cpp:142
void Interrupt(NodeContext &node)
Interrupt threads.
Definition: init.cpp:210
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:1775
bool AppInitLockDataDirectory()
Lock bitcoin data directory.
Definition: init.cpp:2171
void SetupServerArgs(NodeContext &node)
Register all arguments with the ArgsManager.
Definition: init.cpp:441
static bool AppInitServers(Config &config, HTTPRPCRequestProcessor &httpRPCRequestProcessor, NodeContext &node)
Definition: init.cpp:1626
#define MIN_CORE_FILEDESCRIPTORS
Definition: init.cpp:153
static bool fHaveGenesis
Definition: init.cpp:1601
void Shutdown(NodeContext &node)
Definition: init.cpp:234
static void HandleSIGTERM(int)
Signal handlers are very limited in what they are allowed to do.
Definition: init.cpp:403
static GlobalMutex g_genesis_wait_mutex
Definition: init.cpp:1602
static void OnRPCStarted()
Definition: init.cpp:429
static constexpr bool DEFAULT_USEASHADDR
Definition: init.cpp:146
static void HandleSIGHUP(int)
Definition: init.cpp:407
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin: Basic context setup.
Definition: init.cpp:1802
static fs::path GetPidFile(const ArgsManager &args)
Definition: init.cpp:165
static std::condition_variable g_genesis_wait_cv
Definition: init.cpp:1603
bool AppInitMain(Config &config, RPCServer &rpcServer, HTTPRPCRequestProcessor &httpRPCRequestProcessor, NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin main initialization.
Definition: init.cpp:2193
static constexpr bool DEFAULT_CHRONIK
Definition: init.cpp:145
bool StartIndexBackgroundSync(NodeContext &node)
Validates requirements to run the indexes and spawns each index initial sync thread.
Definition: init.cpp:3257
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:2183
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT
Definition: init.cpp:144
static const char * DEFAULT_ASMAP_FILENAME
Definition: init.cpp:156
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:1651
static void BlockNotifyGenesisWait(const CBlockIndex *pBlockIndex)
Definition: init.cpp:1605
static void OnRPCStopped()
Definition: init.cpp:434
static bool LockDataDirectory(bool probeOnly)
Definition: init.cpp:2136
static void registerSignalHandler(int signal, void(*handler)(int))
Definition: init.cpp:419
bool AppInitParameterInteraction(Config &config, const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:1844
static const bool DEFAULT_REST_ENABLE
Definition: init.cpp:143
static boost::signals2::connection rpc_notify_block_change_connection
Definition: init.cpp:428
static void new_handler_terminate()
Definition: init.cpp:1791
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:2155
static const std::string HEADERS_TIME_FILE_NAME
Definition: init.cpp:158
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:28
#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 StopMapPort()
Definition: mapport.cpp:191
void InterruptMapPort()
Definition: mapport.cpp:185
void StartMapPort(bool enable)
Definition: mapport.cpp:176
static constexpr bool DEFAULT_NATPMP
Definition: mapport.h:8
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:41
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:115
void OnStopped(std::function< void()> slot)
Definition: server.cpp:119
static constexpr Amount PROOF_DUST_THRESHOLD
Minimum amount per utxo.
Definition: proof.h:38
bilingual_str AmountErrMsg(const std::string &optname, const std::string &strValue)
Definition: messages.cpp:73
bilingual_str ResolveErrMsg(const std::string &optname, const std::string &strBind)
Definition: messages.cpp:58
bilingual_str InvalidPortErrMsg(const std::string &optname, const std::string &invalid_value)
Definition: messages.cpp:63
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:133
void AddLoggingArgs(ArgsManager &argsman)
Definition: common.cpp:24
void SetLoggingCategories(const ArgsManager &args)
Definition: common.cpp:179
bool StartLogging(const ArgsManager &args)
Definition: common.cpp:207
void SetLoggingLevel(const ArgsManager &args)
Definition: common.cpp:149
void SetLoggingOptions(const ArgsManager &args)
Definition: common.cpp:126
void LogPackageVersion()
Definition: common.cpp:254
std::unique_ptr< Chain > MakeChain(node::NodeContext &node, const CChainParams &params)
Return implementation of Chain interface.
Definition: interfaces.cpp:835
Definition: init.h:28
bool LoadMempool(CTxMemPool &pool, const fs::path &load_path, Chainstate &active_chainstate, ImportMempoolOptions &&opts)
Import the file and attempt to add its contents to the mempool.
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:13
Definition: messages.h:12
@ 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)
void ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:172
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:276
static constexpr bool DEFAULT_PERSIST_MEMPOOL
Default for -persistmempool, indicating whether the node should attempt to automatically load the mem...
static constexpr int DEFAULT_STOPATHEIGHT
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
LockResult LockDirectory(const fs::path &directory, const std::string lockfile_name, bool probe_only)
Definition: fs_helpers.cpp:56
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:90
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:105
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 ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition: string.cpp:11
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:140
bool fDiscover
Definition: net.cpp:128
bool fListen
Definition: net.cpp:129
void SetReachable(enum Network net, bool reachable)
Mark a network as reachable or unreachable (no automatic connects to it)
Definition: net.cpp:320
bool AddLocal(const CService &addr, int nScore)
Definition: net.cpp:281
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:2461
bool IsReachable(enum Network net)
Definition: net.cpp:328
static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS
The maximum number of peer connections to maintain.
Definition: net.h:95
static const unsigned int MAX_SUBVERSION_LENGTH
Maximum length of the user agent string in version message.
Definition: net.h:71
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:78
static const size_t DEFAULT_MAXSENDBUFFER
Definition: net.h:109
static const int NUM_FDS_MESSAGE_CAPTURE
Number of file descriptors required for message capture.
Definition: net.h:103
static const bool DEFAULT_BLOCKSONLY
Default for blocks only.
Definition: net.h:99
static const bool DEFAULT_FORCEDNSSEED
Definition: net.h:105
static constexpr uint64_t DEFAULT_MAX_UPLOAD_TARGET
The default for -maxuploadtarget.
Definition: net.h:97
static const size_t DEFAULT_MAXRECEIVEBUFFER
Definition: net.h:108
static const int DEFAULT_MAX_AVALANCHE_OUTBOUND_CONNECTIONS
Maximum number of avalanche enabled outgoing connections by default.
Definition: net.h:85
static const bool DEFAULT_FIXEDSEEDS
Definition: net.h:107
static const int MAX_FEELER_CONNECTIONS
Maximum number of feeler connections.
Definition: net.h:87
static const bool DEFAULT_LISTEN
-listen default
Definition: net.h:89
static const int64_t DEFAULT_PEER_CONNECT_TIMEOUT
-peertimeout default
Definition: net.h:101
static const bool DEFAULT_DNSSEED
Definition: net.h:106
static const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS
Maximum number of automatic outgoing nodes over which we'll relay everything (blocks,...
Definition: net.h:76
@ LOCAL_MANUAL
Definition: net.h:169
static const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS
Maximum number of block-relay-only outgoing connections.
Definition: net.h:80
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:37
@ NET_I2P
I2P.
Definition: netaddress.h:52
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:62
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:49
@ NET_IPV6
IPv6.
Definition: netaddress.h:46
@ NET_IPV4
IPv4.
Definition: netaddress.h:43
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:40
bool SetNameProxy(const Proxy &addrProxy)
Set the name proxy to use for all connections to nodes specified by a hostname.
Definition: netbase.cpp:819
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:100
bool SetProxy(enum Network net, const Proxy &addrProxy)
Definition: netbase.cpp:799
std::vector< CService > Lookup(const std::string &name, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:224
bool fNameLookup
Definition: netbase.cpp:48
int nConnectTimeout
Definition: netbase.cpp:47
bool IsUnixSocketPath(const std::string &name)
Check if a string is a valid UNIX domain socket path.
Definition: netbase.cpp:269
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:919
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:145
ConnectionDirection
Definition: netbase.h:37
static const int DEFAULT_NAME_LOOKUP
-dns default
Definition: netbase.h:30
const std::string ADDR_PREFIX_UNIX
Prefix for unix domain socket addresses (which are local filesystem paths)
Definition: netbase.h:35
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 size_t DEFAULT_AVALANCHE_MAX_ELEMENT_POLL
Maximum item that can be polled at once.
Definition: processor.h:55
static constexpr std::chrono::milliseconds AVALANCHE_DEFAULT_QUERY_TIMEOUT
How long before we consider that a query timed out.
Definition: processor.h:74
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:33
ServiceFlags
nServices flags.
Definition: protocol.h:335
@ NODE_NETWORK_LIMITED
Definition: protocol.h:365
@ NODE_BLOOM
Definition: protocol.h:352
@ NODE_NETWORK
Definition: protocol.h:342
@ NODE_COMPACT_FILTERS
Definition: protocol.h:360
@ NODE_AVALANCHE
Definition: protocol.h:380
void RandAddPeriodic() noexcept
Gather entropy from various expensive sources, and feed them to the PRNG state.
Definition: random.cpp:700
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:813
bool(* handler)(Config &config, const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:814
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:35
static constexpr bool DEFAULT_RPC_DOC_CHECK
Definition: util.h:49
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:396
void StartRPC()
Definition: server.cpp:351
void StopRPC()
Definition: server.cpp:368
void InterruptRPC()
Definition: server.cpp:357
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
Definition: server.cpp:391
CRPCTable tableRPC
Definition: server.cpp:683
void RpcInterruptionPoint()
Throw JSONRPCError if RPC is not running.
Definition: server.cpp:385
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:28
Definition: amount.h:23
static constexpr Amount zero() noexcept
Definition: amount.h:36
A BlockHash is a unqiue identifier for a block.
Definition: blockhash.h:13
int m_max_outbound_block_relay
Definition: net.h:847
unsigned int nReceiveFloodSize
Definition: net.h:855
int m_max_outbound_full_relay
Definition: net.h:846
std::vector< NetWhitebindPermissions > vWhiteBinds
Definition: net.h:861
uint64_t nMaxOutboundLimit
Definition: net.h:856
CClientUIInterface * uiInterface
Definition: net.h:851
std::vector< NetWhitelistPermissions > vWhitelistedRangeIncoming
Definition: net.h:859
int m_max_avalanche_outbound
Definition: net.h:848
std::vector< CService > onion_binds
Definition: net.h:863
int nMaxFeeler
Definition: net.h:850
std::vector< std::string > m_specified_outgoing
Definition: net.h:868
bool whitelist_relay
Definition: net.h:872
int nMaxConnections
Definition: net.h:845
ServiceFlags nLocalServices
Definition: net.h:844
std::vector< std::string > m_added_nodes
Definition: net.h:869
int64_t m_peer_connect_timeout
Definition: net.h:857
std::vector< CService > vBinds
Definition: net.h:862
unsigned int nSendBufferMaxSize
Definition: net.h:854
bool m_i2p_accept_incoming
Definition: net.h:870
std::vector< std::string > vSeedNodes
Definition: net.h:858
BanMan * m_banman
Definition: net.h:853
bool m_use_addrman_outgoing
Definition: net.h:867
std::vector< NetEventsInterface * > m_msgproc
Definition: net.h:852
bool whitelist_forcerelay
Definition: net.h:871
bool bind_on_any
True if the user did not specify -bind= or -whitebind= and thus we should bind on 0....
Definition: net.h:866
std::vector< NetWhitelistPermissions > vWhitelistedRangeOutgoing
Definition: net.h:860
int nMaxAddnode
Definition: net.h:849
static std::string getTicker()
Definition: amount.h:163
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:20
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:49
#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:20
bool SetupNetworking()
Definition: system.cpp:101
static int count
int64_t GetTimeMillis()
Returns the system time (not mockable)
Definition: time.cpp:76
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:64
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:890
const std::string DEFAULT_TOR_CONTROL
Default control port.
Definition: torcontrol.cpp:41
void InterruptTorControl()
Definition: torcontrol.cpp:872
void StartTorControl(CService onion_service_target)
Definition: torcontrol.cpp:853
void StopTorControl()
Definition: torcontrol.cpp:882
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:40
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
Definition: txindex.cpp:17
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.
bool ParseUInt16(std::string_view str, uint16_t *out)
Convert decimal string to unsigned 16-bit integer with strict parse error feedback.
bool SplitHostPort(std::string_view in, uint16_t &portOut, std::string &hostOut)
Splits socket address string into host string and port value.
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
std::condition_variable g_best_block_cv
Definition: validation.cpp:114
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...
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:95
assert(!tx.IsCoinBase())
static constexpr int DEFAULT_CHECKLEVEL
Definition: validation.h:93
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:107
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:91
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:110
static const signed int DEFAULT_CHECKBLOCKS
Definition: validation.h:92
static const bool DEFAULT_PEERBLOOMFILTERS
Definition: validation.h:85
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