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