Bitcoin Core 31.99.0
P2P Digital Currency
init.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present 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#include <bitcoin-build-config.h> // IWYU pragma: keep
7
8#include <init.h>
9
10#include <addrdb.h>
11#include <addrman.h>
12#include <banman.h>
13#include <blockfilter.h>
14#include <chain.h>
15#include <chainparams.h>
16#include <chainparamsbase.h>
17#include <clientversion.h>
18#include <common/args.h>
19#include <common/messages.h>
20#include <common/system.h>
21#include <compat/compat.h>
22#include <consensus/params.h>
23#include <crypto/hex_base.h>
24#include <dbwrapper.h>
25#include <httprpc.h>
26#include <httpserver.h>
27#include <index/base.h>
30#include <index/txindex.h>
32#include <init/common.h>
33#include <interfaces/chain.h>
34#include <interfaces/init.h>
35#include <interfaces/ipc.h>
36#include <interfaces/mining.h>
37#include <interfaces/node.h>
38#include <ipc/exception.h>
40#include <kernel/caches.h>
42#include <kernel/checks.h>
43#include <kernel/context.h>
45#include <key.h>
46#include <logging.h>
47#include <mapport.h>
48#include <net.h>
49#include <net_permissions.h>
50#include <net_processing.h>
51#include <netaddress.h>
52#include <netbase.h>
53#include <netgroup.h>
55#include <node/blockstorage.h>
56#include <node/caches.h>
57#include <node/chainstate.h>
59#include <node/context.h>
60#include <node/interface_ui.h>
62#include <node/mempool_args.h>
65#include <node/mining_args.h>
66#include <node/mining_types.h>
67#include <node/peerman_args.h>
68#include <policy/feerate.h>
73#include <policy/policy.h>
74#include <policy/settings.h>
75#include <protocol.h>
76#include <random.h>
77#include <rpc/register.h>
78#include <rpc/server.h>
79#include <rpc/util.h>
80#include <scheduler.h>
81#include <script/sigcache.h>
82#include <sync.h>
83#include <tinyformat.h>
84#include <torcontrol.h>
85#include <txgraph.h>
86#include <txmempool.h>
87#include <uint256.h>
88#include <util/asmap.h>
89#include <util/batchpriority.h>
90#include <util/btcsignals.h>
91#include <util/chaintype.h>
92#include <util/check.h>
93#include <util/fs.h>
94#include <util/fs_helpers.h>
95#include <util/moneystr.h>
96#include <util/result.h>
98#include <util/strencodings.h>
99#include <util/string.h>
100#include <util/syserror.h>
101#include <util/thread.h>
102#include <util/threadnames.h>
103#include <util/time.h>
104#include <util/translation.h>
105#include <validation.h>
106#include <validationinterface.h>
107#include <walletinitinterface.h>
108
109#include <algorithm>
110#include <any>
111#include <cerrno>
112#include <condition_variable>
113#include <cstddef>
114#include <cstdint>
115#include <exception>
116#include <fstream>
117#include <functional>
118#include <initializer_list>
119#include <list>
120#include <memory>
121#include <new>
122#include <optional>
123#include <set>
124#include <span>
125#include <string>
126#include <system_error>
127#include <thread>
128#include <tuple>
129#include <utility>
130#include <variant>
131#include <vector>
132
133#ifndef WIN32
134#include <csignal>
135#endif
136
137#ifdef ENABLE_ZMQ
140#include <zmq/zmqrpc.h>
141#endif
142
143#ifdef ENABLE_EMBEDDED_ASMAP
144#include <node/data/ip_asn.dat.h>
145#endif
146
149
171using util::Join;
172using util::ReplaceAll;
173using util::ToString;
175
176static constexpr bool DEFAULT_PROXYRANDOMIZE{true};
177static constexpr bool DEFAULT_REST_ENABLE{false};
178static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING{true};
179static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
180
181#ifdef WIN32
182// Win32 LevelDB doesn't use filedescriptors, and the ones used for
183// accessing block files don't count towards the fd_set size limit
184// anyway.
185#define MIN_LEVELDB_FDS 0
186#else
187#define MIN_LEVELDB_FDS 150
188#endif
189
191
195static const char* BITCOIN_PID_FILENAME = "bitcoind.pid";
200static bool g_generated_pid{false};
201
202static fs::path GetPidFile(const ArgsManager& args)
203{
205}
206
207[[nodiscard]] static bool CreatePidFile(const ArgsManager& args)
208{
209 if (args.IsArgNegated("-pid")) return true;
210
211 std::ofstream file{GetPidFile(args).std_path()};
212 if (file) {
213#ifdef WIN32
214 tfm::format(file, "%d\n", GetCurrentProcessId());
215#else
216 tfm::format(file, "%d\n", getpid());
217#endif
218 g_generated_pid = true;
219 return true;
220 } else {
221 return InitError(strprintf(_("Unable to create the PID file '%s': %s"), fs::PathToString(GetPidFile(args)), SysErrorString(errno)));
222 }
223}
224
225static void RemovePidFile(const ArgsManager& args)
226{
227 if (!g_generated_pid) return;
228 const auto pid_path{GetPidFile(args)};
229 if (std::error_code error; !fs::remove(pid_path, error)) {
230 std::string msg{error ? error.message() : "File does not exist"};
231 LogWarning("Unable to remove PID file (%s): %s", fs::PathToString(pid_path), msg);
232 }
233}
234
235static std::optional<util::SignalInterrupt> g_shutdown;
236
238{
240 g_shutdown.emplace();
241
242 node.args = &gArgs;
243 node.shutdown_signal = &*g_shutdown;
244 node.shutdown_request = [&node] {
245 assert(node.shutdown_signal);
246 if (!(*node.shutdown_signal)()) return false;
247 return true;
248 };
249}
250
252//
253// Shutdown
254//
255
256//
257// Thread management and startup/shutdown:
258//
259// The network-processing threads are all part of a thread group
260// created by AppInit() or the Qt main() function.
261//
262// A clean exit happens when the SignalInterrupt object is triggered, which
263// makes the main thread's SignalInterrupt::wait() call return, and join all
264// other ongoing threads in the thread group to the main thread.
265// Shutdown() is then called to clean up database connections, and stop other
266// threads that should only be stopped after the main network-processing
267// threads have exited.
268//
269// Shutdown for Qt is very similar, only it uses a QTimer to detect
270// ShutdownRequested() getting set, and then does the normal Qt
271// shutdown thing.
272//
273
275{
276 return bool{*Assert(node.shutdown_signal)};
277}
278
279#if HAVE_SYSTEM
280static void ShutdownNotify(const ArgsManager& args)
281{
282 std::vector<std::thread> threads;
283 for (const auto& cmd : args.GetArgs("-shutdownnotify")) {
284 threads.emplace_back(runCommand, cmd);
285 }
286 for (auto& t : threads) {
287 t.join();
288 }
289}
290#endif
291
293{
294#if HAVE_SYSTEM
295 ShutdownNotify(*node.args);
296#endif
297 // Wake any threads that may be waiting for the tip to change.
298 if (node.notifications) WITH_LOCK(node.notifications->m_tip_block_mutex, node.notifications->m_tip_block_cv.notify_all());
301 InterruptRPC();
303 if (node.tor_controller) {
304 node.tor_controller->Interrupt();
305 }
307 if (node.connman)
308 node.connman->Interrupt();
309 for (auto* index : node.indexes) {
310 index->Interrupt();
311 }
312}
313
315{
316 static Mutex g_shutdown_mutex;
317 TRY_LOCK(g_shutdown_mutex, lock_shutdown);
318 if (!lock_shutdown) return;
319 LogInfo("Shutdown in progress...");
320 Assert(node.args);
321
326 util::ThreadRename("shutoff");
327 if (node.mempool) node.mempool->AddTransactionsUpdated(1);
328
329 StopHTTPRPC();
330 StopREST();
331 StopRPC();
333 for (auto& client : node.chain_clients) {
334 try {
335 client->stop();
336 } catch (const ipc::Exception& e) {
337 LogDebug(BCLog::IPC, "Chain client did not disconnect cleanly: %s", e.what());
338 client.reset();
339 }
340 }
341 StopMapPort();
342
343 // Because these depend on each-other, we make sure that neither can be
344 // using the other before destroying them.
345 if (node.peerman && node.validation_signals) node.validation_signals->UnregisterValidationInterface(node.peerman.get());
346 if (node.connman) node.connman->Stop();
347
348 if (node.tor_controller) {
349 node.tor_controller->Join();
350 node.tor_controller.reset();
351 }
352
353 if (node.background_init_thread.joinable()) node.background_init_thread.join();
354 // After everything has been shut down, but before things get flushed, stop the
355 // the scheduler. After this point, SyncWithValidationInterfaceQueue() should not be called anymore
356 // as this would prevent the shutdown from completing.
357 if (node.scheduler) node.scheduler->stop();
358
359 // After the threads that potentially access these pointers have been stopped,
360 // destruct and reset all to nullptr.
361 node.peerman.reset();
362 node.connman.reset();
363 node.banman.reset();
364 node.addrman.reset();
365 node.netgroupman.reset();
366
367 if (node.mempool && node.mempool->GetLoadTried() && ShouldPersistMempool(*node.args)) {
368 DumpMempool(*node.mempool, MempoolPath(*node.args));
369 }
370
371 // Drop transactions we were still watching, record fee estimations and unregister
372 // fee estimator from validation interface.
373 if (node.fee_estimator_man) {
374 node.fee_estimator_man->ShutdownFlush();
375 if (node.validation_signals) {
376 node.validation_signals->UnregisterValidationInterface(node.fee_estimator_man.get());
377 }
378 }
379
380 // FlushStateToDisk generates a ChainStateFlushed callback, which we should avoid missing
381 if (node.chainman) {
382 LOCK(cs_main);
383 for (const auto& chainstate : node.chainman->m_chainstates) {
384 if (chainstate->CanFlushToDisk()) {
385 chainstate->ForceFlushStateToDisk();
386 }
387 }
388 }
389
390 // After there are no more peers/RPC left to give us new data which may generate
391 // CValidationInterface callbacks, flush them...
392 if (node.validation_signals) node.validation_signals->FlushBackgroundCallbacks();
393
394 // Stop and delete all indexes only after flushing background callbacks.
395 for (auto* index : node.indexes) index->Stop();
396 if (g_txindex) g_txindex.reset();
400 node.indexes.clear(); // all instances are nullptr now
401
402 // Any future callbacks will be dropped. This should absolutely be safe - if
403 // missing a callback results in an unrecoverable situation, unclean shutdown
404 // would too. The only reason to do the above flushes is to let the wallet catch
405 // up with our current chain to avoid any strange pruning edge cases and make
406 // next startup faster by avoiding rescan.
407
408 if (node.chainman) {
409 LOCK(cs_main);
410 for (const auto& chainstate : node.chainman->m_chainstates) {
411 if (chainstate->CanFlushToDisk()) {
412 chainstate->ForceFlushStateToDisk();
413 chainstate->ResetCoinsViews();
414 }
415 }
416 }
417
418 // If any -ipcbind clients are still connected, disconnect them now so they
419 // do not block shutdown.
420 if (interfaces::Ipc* ipc = node.init->ipc()) {
421 ipc->disconnectIncoming();
422 }
423
424#ifdef ENABLE_ZMQ
426 if (node.validation_signals) node.validation_signals->UnregisterValidationInterface(g_zmq_notification_interface.get());
428 }
429#endif
430
431 node.chain_clients.clear();
432 if (node.validation_signals) {
433 node.validation_signals->UnregisterAllValidationInterfaces();
434 }
435 node.fee_estimator_man.reset();
436 node.mempool.reset();
437 node.chainman.reset();
438 node.validation_signals.reset();
439 node.scheduler.reset();
440 node.ecc_context.reset();
441 node.kernel.reset();
442
443 RemovePidFile(*node.args);
444
445 LogInfo("Shutdown done");
446}
447
453#ifndef WIN32
454static void HandleSIGTERM(int)
455{
456 // Return value is intentionally ignored because there is not a better way
457 // of handling this failure in a signal handler.
458 (void)(*Assert(g_shutdown))();
459}
460
461static void HandleSIGHUP(int)
462{
463 LogInstance().m_reopen_file = true;
464}
465#else
466static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType)
467{
468 if (!(*Assert(g_shutdown))()) {
469 LogError("Failed to send shutdown signal on Ctrl-C\n");
470 return false;
471 }
472 Sleep(INFINITE);
473 return true;
474}
475#endif
476
477#ifndef WIN32
478static void registerSignalHandler(int signal, void(*handler)(int))
479{
480 struct sigaction sa;
481 sa.sa_handler = handler;
482 sigemptyset(&sa.sa_mask);
483 sa.sa_flags = 0;
484 sigaction(signal, &sa, nullptr);
485}
486#endif
487
488void SetupServerArgs(ArgsManager& argsman, bool can_listen_ipc)
489{
490 SetupHelpOptions(argsman);
491 argsman.AddArg("-help-debug", "Print help message with debugging options and exit", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); // server-only for now
492
493 init::AddLoggingArgs(argsman);
494
495 const auto defaultBaseParams = CreateBaseChainParams(ChainType::MAIN);
496 const auto testnetBaseParams = CreateBaseChainParams(ChainType::TESTNET);
497 const auto testnet4BaseParams = CreateBaseChainParams(ChainType::TESTNET4);
498 const auto signetBaseParams = CreateBaseChainParams(ChainType::SIGNET);
499 const auto regtestBaseParams = CreateBaseChainParams(ChainType::REGTEST);
500 const auto defaultChainParams = CreateChainParams(argsman, ChainType::MAIN);
501 const auto testnetChainParams = CreateChainParams(argsman, ChainType::TESTNET);
502 const auto testnet4ChainParams = CreateChainParams(argsman, ChainType::TESTNET4);
503 const auto signetChainParams = CreateChainParams(argsman, ChainType::SIGNET);
504 const auto regtestChainParams = CreateChainParams(argsman, ChainType::REGTEST);
505
506 // Hidden Options
507 std::vector<std::string> hidden_args = {
508 "-dbcrashratio", "-forcecompactdb",
509 // GUI args. These will be overwritten by SetupUIArgs for the GUI
510 "-choosedatadir", "-lang=<lang>", "-min", "-resetguisettings", "-splash", "-uiplatform"};
511
512 argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
513#if HAVE_SYSTEM
514 argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
515#endif
516 argsman.AddArg("-assumevalid=<hex>", strprintf("If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: %s, testnet3: %s, testnet4: %s, signet: %s)", defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnetChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnet4ChainParams->GetConsensus().defaultAssumeValid.GetHex(), signetChainParams->GetConsensus().defaultAssumeValid.GetHex()), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
517 argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
518 argsman.AddArg("-blocksxor",
519 strprintf("Whether an XOR-key applies to blocksdir *.dat files. "
520 "The created XOR-key will be zeros for an existing blocksdir or when `-blocksxor=0` is "
521 "set, and random for a freshly initialized blocksdir. "
522 "(default: %u)",
525 argsman.AddArg("-fastprune", "Use smaller block files and lower minimum prune height for testing purposes", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
526#if HAVE_SYSTEM
527 argsman.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
528#endif
529 argsman.AddArg("-blockreconstructionextratxn=<n>", strprintf("Extra transactions to keep in memory for compact block reconstructions (default: %u)", DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
530 argsman.AddArg("-blocksonly", strprintf("Whether to reject transactions from network peers. Disables automatic broadcast and rebroadcast of transactions, unless the source peer has the 'forcerelay' permission. RPC transactions are not affected. (default: %u)", DEFAULT_BLOCKSONLY), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
531 argsman.AddArg("-coinstatsindex", strprintf("Maintain coinstats index used by the gettxoutsetinfo RPC (default: %u)", DEFAULT_COINSTATSINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
532 argsman.AddArg("-conf=<file>", strprintf("Specify path to read-only configuration file. Relative paths will be prefixed by datadir location (only useable from command line, not configuration file) (default: %s)", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
533 argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
534 argsman.AddArg("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", DEFAULT_DB_CACHE_BATCH), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
535 argsman.AddArg("-dbcache=<n>", strprintf("Maximum database cache size <n> MiB (minimum %d, default: %d). Make sure you have enough RAM. In addition, unused memory allocated to the mempool is shared with this cache (see -maxmempool).", MIN_DBCACHE_BYTES / 1_MiB, node::GetDefaultDBCache() / 1_MiB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
536 argsman.AddArg("-includeconf=<file>", "Specify additional configuration file, relative to the -datadir path (only useable from configuration file, not command line)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
537 argsman.AddArg("-allowignoredconf", strprintf("For backwards compatibility, treat an unused %s file in the datadir as a warning, not an error.", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
538 argsman.AddArg("-loadblock=<file>", "Imports blocks from an external file on startup. Obfuscated blocks are not supported.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
539 argsman.AddArg("-maxmempool=<n>", strprintf("Keep the transaction memory pool below <n> megabytes (default: %u)", DEFAULT_MAX_MEMPOOL_SIZE_MB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
540 argsman.AddArg("-mempoolexpiry=<n>", strprintf("Do not keep transactions in the mempool longer than <n> hours (default: %u)", DEFAULT_MEMPOOL_EXPIRY_HOURS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
541 argsman.AddArg("-minimumchainwork=<hex>", strprintf("Minimum work assumed to exist on a valid chain in hex (default: %s, testnet3: %s, testnet4: %s, signet: %s)", defaultChainParams->GetConsensus().nMinimumChainWork.GetHex(), testnetChainParams->GetConsensus().nMinimumChainWork.GetHex(), testnet4ChainParams->GetConsensus().nMinimumChainWork.GetHex(), signetChainParams->GetConsensus().nMinimumChainWork.GetHex()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
542 argsman.AddArg("-par=<n>", strprintf("Set the number of script verification threads (0 = auto, up to %d, <0 = leave that many cores free, default: %d)",
544 argsman.AddArg("-prevoutfetchthreads=<n>", strprintf("Set the number of threads used to prefetch block input prevouts from the chainstate database (0 disables, up to %d, default: %d). Negative values are rejected.", MAX_PREVOUTFETCH_THREADS, DEFAULT_PREVOUTFETCH_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
545 argsman.AddArg("-persistmempool", strprintf("Whether to save the mempool on shutdown and load on restart (default: %u)", DEFAULT_PERSIST_MEMPOOL), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
546 argsman.AddArg("-persistmempoolv1",
547 strprintf("Whether a mempool.dat file created by -persistmempool or the savemempool RPC will be written in the legacy format "
548 "(version 1) or the current format (version 2). This temporary option will be removed in the future. (default: %u)",
551 argsman.AddArg("-pid=<file>", strprintf("Specify pid file. Relative paths will be prefixed by a net-specific datadir location. (default: %s)", BITCOIN_PID_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
552 argsman.AddArg("-prune=<n>", strprintf("Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is incompatible with -txindex. "
553 "Warning: Reverting this setting requires re-downloading the entire blockchain. Wallets and indexes should be loaded at startup and kept active while pruning is enabled so they stay synchronized before old block data is deleted; wallets or indexes that fall behind pruned data may require a reindex. "
554 "(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >=%u = automatically prune block files to stay under the specified target size in MiB)", MIN_DISK_SPACE_FOR_BLOCK_FILES / 1_MiB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
555 argsman.AddArg("-reindex", "If enabled, wipe chain state and block index, and rebuild them from blk*.dat files on disk. Also wipe and rebuild other optional indexes that are active. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be reloaded via RPC.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
556 argsman.AddArg("-reindex-chainstate", "If enabled, wipe chain state, and rebuild it from blk*.dat files on disk. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be reloaded via RPC.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
557 argsman.AddArg("-settings=<file>", strprintf("Specify path to dynamic settings data file. Can be disabled with -nosettings. File is written at runtime and not meant to be edited by users (use %s instead for custom settings). Relative paths will be prefixed by datadir location. (default: %s)", BITCOIN_CONF_FILENAME, BITCOIN_SETTINGS_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
558#if HAVE_SYSTEM
559 argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
560 argsman.AddArg("-shutdownnotify=<cmd>", "Execute command immediately before beginning shutdown. The need for shutdown may be urgent, so be careful not to delay it long (if the command doesn't require interaction with the server, consider having it fork into the background).", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
561#endif
562 argsman.AddArg("-txindex", strprintf("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)", DEFAULT_TXINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
563 argsman.AddArg("-txospenderindex", strprintf("Maintain a transaction output spender index, used by the gettxspendingprevout rpc call (default: %u)", DEFAULT_TXOSPENDERINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
564 argsman.AddArg("-blockfilterindex=<type>",
565 strprintf("Maintain an index of compact filters by block (default: %s, values: %s).", DEFAULT_BLOCKFILTERINDEX, ListBlockFilterTypes()) +
566 " If <type> is not supplied or if <type> = 1, indexes for all known types are enabled.",
568
569 argsman.AddArg("-addnode=<ip>", strprintf("Add a node to connect to and attempt to keep the connection open (see the addnode RPC help for more info). This option can be specified multiple times to add multiple nodes; connections are limited to %u at a time and are counted separately from the -maxconnections limit.", MAX_ADDNODE_CONNECTIONS), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
570 argsman.AddArg("-asmap=<file>", strprintf("Specify asn mapping used for bucketing of the peers. Relative paths will be prefixed by the net-specific datadir location.%s",
571 #ifdef ENABLE_EMBEDDED_ASMAP
572 " If a bool arg is given (-asmap or -asmap=1), the embedded mapping data in the binary will be used."
573 #else
574 ""
575 #endif
577 argsman.AddArg("-bantime=<n>", strprintf("Default duration (in seconds) of manually configured bans (default: %u)", DEFAULT_MISBEHAVING_BANTIME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
578 argsman.AddArg("-bind=<addr>[:<port>][=onion]", strprintf("Bind to given address and always listen on it (default: 0.0.0.0). Use [host]:port notation for IPv6. Append =onion to tag any incoming connections to that address and port as incoming Tor connections (default: 127.0.0.1:%u=onion, testnet3: 127.0.0.1:%u=onion, testnet4: 127.0.0.1:%u=onion, signet: 127.0.0.1:%u=onion, regtest: 127.0.0.1:%u=onion)", defaultChainParams->GetDefaultPort() + 1, testnetChainParams->GetDefaultPort() + 1, testnet4ChainParams->GetDefaultPort() + 1, signetChainParams->GetDefaultPort() + 1, regtestChainParams->GetDefaultPort() + 1), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
579 argsman.AddArg("-cjdnsreachable", "If set, then this host is configured for CJDNS (connecting to fc00::/8 addresses would lead us to the CJDNS network, see doc/cjdns.md) (default: 0)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
580 argsman.AddArg("-connect=<ip>", "Connect only to the specified node; -noconnect disables automatic connections (the rules for this peer are the same as for -addnode). This option can be specified multiple times to connect to multiple nodes.", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
581 argsman.AddArg("-discover", "Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
582 argsman.AddArg("-dns", strprintf("Allow DNS lookups for -addnode, -seednode and -connect (default: %u)", DEFAULT_NAME_LOOKUP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
583 argsman.AddArg("-dnsseed", strprintf("Query for peer addresses via DNS lookup, if low on addresses (default: %u unless -connect used or -maxconnections=0)", DEFAULT_DNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
584 argsman.AddArg("-externalip=<ip>", "Specify your own public address", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
585 argsman.AddArg("-fixedseeds", strprintf("Allow fixed seeds if DNS seeds don't provide peers (default: %u)", DEFAULT_FIXEDSEEDS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
586 argsman.AddArg("-forcednsseed", strprintf("Always query for peer addresses via DNS lookup (default: %u)", DEFAULT_FORCEDNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
587 argsman.AddArg("-listen", strprintf("Accept connections from outside (default: %u if no -proxy, -connect or -maxconnections=0)", DEFAULT_LISTEN), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
588 argsman.AddArg("-listenonion", strprintf("Automatically create Tor onion service (default: %d)", DEFAULT_LISTEN_ONION), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
589 argsman.AddArg("-maxconnections=<n>", strprintf("Maintain at most <n> automatic connections to peers (default: %u). %u slots of these are reserved for outgoing connections. See -inboundrelaypercent for more information about limits applied to transaction relay inbound peers. "
590 "This limit does not apply to connections manually added via -addnode or the addnode RPC, which have a separate limit of %u. "
591 "It does not apply to short-lived private broadcast connections either, which have a separate limit of %u.",
594 argsman.AddArg("-inboundrelaypercent=<n>", strprintf("Permit a maximum percent of inbound connections to relay transactions, to limit memory utilization (0 to 100, default: %u).", DEFAULT_FULL_RELAY_INBOUND_PCT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
595 argsman.AddArg("-maxreceivebuffer=<n>", strprintf("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXRECEIVEBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
596 argsman.AddArg("-maxsendbuffer=<n>", strprintf("Maximum per-connection memory usage for the send buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXSENDBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
597 argsman.AddArg("-maxuploadtarget=<n>", strprintf("Tries to keep outbound traffic under the given target per 24h. Limit does not apply to peers with 'download' permission or blocks created within past week. 0 = no limit (default: %s). Optional suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000 base while uppercase is 1024 base", DEFAULT_MAX_UPLOAD_TARGET), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
598#ifdef HAVE_SOCKADDR_UN
599 argsman.AddArg("-onion=<ip:port|path>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy). May be a local file path prefixed with 'unix:'.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
600#else
601 argsman.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
602#endif
603 argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
604 argsman.AddArg("-i2pacceptincoming", strprintf("Whether to accept inbound I2P connections (default: %i). Ignored if -i2psam is not set. Listening for inbound I2P connections is done through the SAM proxy, not by binding to a local address and port.", DEFAULT_I2P_ACCEPT_INCOMING), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
605 argsman.AddArg("-onlynet=<net>", "Make automatic outbound connections only to network <net> (" + Join(GetNetworkNames(), ", ") + "). Inbound and manual connections are not affected by this option. It can be specified multiple times to allow multiple networks.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
606 argsman.AddArg("-v2transport", strprintf("Support v2 transport (default: %u)", DEFAULT_V2_TRANSPORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
607 argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
608 argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
609 argsman.AddArg("-txreconciliation", strprintf("Enable transaction reconciliations per BIP 330 (default: %d)", DEFAULT_TXRECONCILIATION_ENABLE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
610 argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port> (default: %u, testnet3: %u, testnet4: %u, signet: %u, regtest: %u). Not relevant for I2P (see doc/i2p.md). If set to a value x, the default onion listening port will be set to x+1.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), testnet4ChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
611 const std::string proxy_doc_for_value =
612#ifdef HAVE_SOCKADDR_UN
613 "<ip>[:<port>]|unix:<path>";
614#else
615 "<ip>[:<port>]";
616#endif
617 const std::string proxy_doc_for_unix_socket =
618#ifdef HAVE_SOCKADDR_UN
619 "May be a local file path prefixed with 'unix:' if the proxy supports it. ";
620#else
621 "";
622#endif
623 argsman.AddArg("-proxy=" + proxy_doc_for_value + "[=<network>]",
624 "Connect through SOCKS5 proxy, set -noproxy to disable. " +
625 proxy_doc_for_unix_socket +
626 "Could end in =network to set the proxy only for that network. " +
627 "The network can be any of ipv4, ipv6, tor or cjdns. " +
628 "(default: disabled)",
631 argsman.AddArg("-proxyrandomize", strprintf("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)", DEFAULT_PROXYRANDOMIZE), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
632 argsman.AddArg("-seednode=<ip>", "Connect to a node to retrieve peer addresses, and disconnect. This option can be specified multiple times to connect to multiple nodes. During startup, seednodes will be tried before dnsseeds.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
633 argsman.AddArg("-networkactive", "Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
634 argsman.AddArg("-timeout=<n>", strprintf("Specify socket connection timeout in milliseconds. If an initial attempt to connect is unsuccessful after this amount of time, drop it (minimum: 1, default: %d)", DEFAULT_CONNECT_TIMEOUT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
635 argsman.AddArg("-peertimeout=<n>", strprintf("Specify a p2p connection timeout delay in seconds. After connecting to a peer, wait this amount of time before considering disconnection based on inactivity (minimum: 1, default: %d)", DEFAULT_PEER_CONNECT_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
636 argsman.AddArg("-torcontrol=<ip>:<port>", strprintf("Tor control host and port to use if onion listening enabled (default: %s). If no port is specified, the default port of %i will be used.", DEFAULT_TOR_CONTROL, DEFAULT_TOR_CONTROL_PORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
637 argsman.AddArg("-torpassword=<pass>", "Tor control port password (default: empty)", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::CONNECTION);
638 argsman.AddArg("-natpmp", strprintf("Use PCP or NAT-PMP to map the listening port (default: %u)", DEFAULT_NATPMP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
639 argsman.AddArg("-whitebind=<[permissions@]addr>", "Bind to the given address and add permission flags to the peers connecting to it. "
640 "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
641 "Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
642
643 argsman.AddArg("-whitelist=<[permissions@]IP address or network>", "Add permission flags to the peers using the given IP address (e.g. 1.2.3.4) or "
644 "CIDR-notated network (e.g. 1.2.3.0/24). Uses the same permissions as "
645 "-whitebind. "
646 "Additional flags \"in\" and \"out\" control whether permissions apply to incoming connections and/or manual (default: incoming only). "
647 "Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
648
650
651#ifdef ENABLE_ZMQ
652 argsman.AddArg("-zmqpubhashblock=<address>", "Enable publish hash block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
653 argsman.AddArg("-zmqpubhashtx=<address>", "Enable publish hash transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
654 argsman.AddArg("-zmqpubrawblock=<address>", "Enable publish raw block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
655 argsman.AddArg("-zmqpubrawtx=<address>", "Enable publish raw transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
656 argsman.AddArg("-zmqpubsequence=<address>", "Enable publish hash block and tx sequence in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
657 argsman.AddArg("-zmqpubhashblockhwm=<n>", strprintf("Set publish hash block outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
658 argsman.AddArg("-zmqpubhashtxhwm=<n>", strprintf("Set publish hash transaction outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
659 argsman.AddArg("-zmqpubrawblockhwm=<n>", strprintf("Set publish raw block outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
660 argsman.AddArg("-zmqpubrawtxhwm=<n>", strprintf("Set publish raw transaction outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
661 argsman.AddArg("-zmqpubsequencehwm=<n>", strprintf("Set publish hash sequence message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
662#else
663 hidden_args.emplace_back("-zmqpubhashblock=<address>");
664 hidden_args.emplace_back("-zmqpubhashtx=<address>");
665 hidden_args.emplace_back("-zmqpubrawblock=<address>");
666 hidden_args.emplace_back("-zmqpubrawtx=<address>");
667 hidden_args.emplace_back("-zmqpubsequence=<n>");
668 hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
669 hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
670 hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
671 hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
672 hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
673#endif
674
675 argsman.AddArg("-checkblocks=<n>", strprintf("How many blocks to check at startup (default: %u, 0 = all)", DEFAULT_CHECKBLOCKS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
676 argsman.AddArg("-checklevel=<n>", strprintf("How thorough the block verification of -checkblocks is: %s (0-4, default: %u)", Join(CHECKLEVEL_DOC, ", "), DEFAULT_CHECKLEVEL), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
677 argsman.AddArg("-checkblockindex", strprintf("Do a consistency check for the block tree, chainstate, and other validation data structures every <n> operations. Use 0 to disable. (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
678 argsman.AddArg("-checkaddrman=<n>", strprintf("Run addrman consistency checks every <n> operations. Use 0 to disable. (default: %u)", DEFAULT_ADDRMAN_CONSISTENCY_CHECKS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
679 argsman.AddArg("-checkmempool=<n>", strprintf("Run mempool consistency checks every <n> transactions. Use 0 to disable. (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
680 // Checkpoints were removed. We keep `-checkpoints` as a hidden arg to display a more user friendly error when set.
681 argsman.AddArg("-checkpoints", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
682 argsman.AddArg("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
683 argsman.AddArg("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
684 argsman.AddArg("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u). Blocks after target height may be processed during shutdown.", DEFAULT_STOPATHEIGHT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
685 argsman.AddArg("-limitancestorcount=<n>", strprintf("Deprecated setting to not accept transactions if number of in-mempool ancestors is <n> or more (default: %u); replaced by cluster limits (see -limitclustercount) and only used by wallet for coin selection", DEFAULT_ANCESTOR_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
686 // Ancestor and descendant size limits were removed. We keep
687 // -limitancestorsize/-limitdescendantsize as hidden args to display a more
688 // user friendly error when set.
689 argsman.AddArg("-limitancestorsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
690 argsman.AddArg("-limitdescendantsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
691 argsman.AddArg("-limitdescendantcount=<n>", strprintf("Deprecated setting to not accept transactions if any ancestor would have <n> or more in-mempool descendants (default: %u); replaced by cluster limits (see -limitclustercount) and only used by wallet for coin selection", DEFAULT_DESCENDANT_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
692 argsman.AddArg("-test=<option>", "Pass a test-only option. Options include : " + Join(TEST_OPTIONS_DOC, ", ") + ".", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
693 argsman.AddArg("-limitclustercount=<n>", strprintf("Do not accept transactions into mempool which are directly or indirectly connected to <n> or more other unconfirmed transactions (default: %u, maximum: %u)", DEFAULT_CLUSTER_LIMIT, MAX_CLUSTER_COUNT_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
694 argsman.AddArg("-limitclustersize=<n>", strprintf("Do not accept transactions whose virtual size with all in-mempool connected transactions exceeds <n> kilobytes (default: %u)", DEFAULT_CLUSTER_SIZE_LIMIT_KVB), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
695 argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
696 argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
697 argsman.AddArg("-maxsigcachesize=<n>", strprintf("Limit sum of signature cache and script execution cache sizes to <n> MiB (default: %u)", DEFAULT_VALIDATION_CACHE_BYTES >> 20), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
698 argsman.AddArg("-maxtipage=<n>",
699 strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)",
700 Ticks<std::chrono::seconds>(DEFAULT_MAX_TIP_AGE)),
702 argsman.AddArg("-printpriority", strprintf("Log transaction fee rate in %s/kvB when mining blocks (default: %u)", CURRENCY_UNIT, DEFAULT_PRINT_MODIFIED_FEE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
703 argsman.AddArg("-uacomment=<cmt>", "Append comment to the user agent string", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
704
706
707 argsman.AddArg("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (test networks only; default: %u)", DEFAULT_ACCEPT_NON_STD_TXN), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
708 argsman.AddArg("-incrementalrelayfee=<amt>", strprintf("Fee rate (in %s/kvB) used to define cost of relay, used for mempool limiting and replacement policy. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_INCREMENTAL_RELAY_FEE)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
709 argsman.AddArg("-dustrelayfee=<amt>", strprintf("Fee rate (in %s/kvB) used to define dust, the value of an output such that it will cost more than its value in fees at this fee rate to spend it. (default: %s)", CURRENCY_UNIT, FormatMoney(DUST_RELAY_TX_FEE)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
710 argsman.AddArg("-acceptstalefeeestimates", strprintf("Read fee estimates even if they are stale (%sdefault: %u) fee estimates are considered stale if they are %s hours old", "regtest only; ", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES, Ticks<std::chrono::hours>(MAX_FILE_AGE)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
711 argsman.AddArg("-bytespersigop", strprintf("Equivalent bytes per sigop in transactions for relay and mining (default: %u)", DEFAULT_BYTES_PER_SIGOP), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
712 argsman.AddArg("-datacarrier", strprintf("Relay and mine data carrier transactions (default: %u)", DEFAULT_ACCEPT_DATACARRIER), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
713 argsman.AddArg("-datacarriersize",
714 strprintf("Relay and mine transactions whose data-carrying raw scriptPubKeys in aggregate "
715 "are of this size or less, allowing multiple outputs (default: %u)",
718 argsman.AddArg("-permitbaremultisig", strprintf("Relay transactions creating non-P2SH multisig outputs (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY,
720 argsman.AddArg("-minrelaytxfee=<amt>", strprintf("Fees (in %s/kvB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)",
722 argsman.AddArg("-txsendrate=<n>",
723 strprintf("Set the maximum ongoing rate for sending transactions to (inbound) peers (default: %u tx/s)",
726 argsman.AddArg("-privatebroadcast",
727 strprintf(
728 "Broadcast transactions submitted via sendrawtransaction RPC using short-lived "
729 "connections through the Tor or I2P networks, without putting them in the mempool first. "
730 "Transactions submitted through the wallet are not affected by this option "
731 "(default: %u)",
735 argsman.AddArg("-whitelistforcerelay", strprintf("Add 'forcerelay' permission to whitelisted peers with default permissions. This will relay transactions even if the transactions were already in the mempool. (default: %d)", DEFAULT_WHITELISTFORCERELAY), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
736 argsman.AddArg("-whitelistrelay", strprintf("Add 'relay' permission to whitelisted peers with default permissions. This will accept relayed transactions even when not relaying transactions (default: %d)", DEFAULT_WHITELISTRELAY), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
737
738
739 argsman.AddArg("-blockmaxweight=<n>", strprintf("Set maximum BIP141 block weight (default: %d)", DEFAULT_BLOCK_MAX_WEIGHT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
740 argsman.AddArg("-blockreservedweight=<n>", strprintf("Reserve space for the fixed-size block header plus the largest coinbase transaction the mining software may add to the block. Only affects mining RPC clients, not IPC clients. (default: %d).", DEFAULT_BLOCK_RESERVED_WEIGHT), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
741 argsman.AddArg("-blockmintxfee=<amt>", strprintf("Set lowest fee rate (in %s/kvB) for transactions to be included in block creation. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_BLOCK_MIN_TX_FEE)), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
742 argsman.AddArg("-blockversion=<n>", "Override block version to test forking scenarios", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
743
744 argsman.AddArg("-rest", strprintf("Accept public REST requests (default: %u)", DEFAULT_REST_ENABLE), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
745 argsman.AddArg("-rpcallowip=<ip>", "Allow JSON-RPC connections from specified source. Valid values for <ip> are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all ipv4 (0.0.0.0/0), or all ipv6 (::/0). RFC4193 is allowed only if -cjdnsreachable=0. This option can be specified multiple times", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
746 argsman.AddArg("-rpcauth=<userpw>", "Username and HMAC-SHA-256 hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcauth. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
747 argsman.AddArg("-rpcbind=<addr>[:port]", "Bind to given address to listen for JSON-RPC connections. Do not expose the RPC server to untrusted networks such as the public internet! This option is ignored unless -rpcallowip is also passed. Port is optional and overrides -rpcport. Use [host]:port notation for IPv6. This option can be specified multiple times (default: 127.0.0.1 and ::1 i.e., localhost)", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::RPC);
748 argsman.AddArg("-rpcdoccheck", strprintf("Throw a non-fatal error at runtime if the documentation for an RPC is incorrect (default: %u)", DEFAULT_RPC_DOC_CHECK), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
749 argsman.AddArg("-rpccookiefile=<loc>", "Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir)", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
750 argsman.AddArg("-rpccookieperms=<readable-by>", strprintf("Set permissions on the RPC auth cookie file so that it is readable by [owner|group|all] (default: owner [via umask 0077])"), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
751 argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
752 argsman.AddArg("-rpcport=<port>", strprintf("Listen for JSON-RPC connections on <port> (default: %u, testnet3: %u, testnet4: %u, signet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), testnet4BaseParams->RPCPort(), signetBaseParams->RPCPort(), regtestBaseParams->RPCPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::RPC);
753 argsman.AddArg("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
754 argsman.AddArg("-rpcthreads=<n>", strprintf("Set the number of threads to service RPC calls (default: %d)", DEFAULT_HTTP_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
755 argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
756 argsman.AddArg("-rpcwhitelist=<whitelist>", "Set a whitelist to filter incoming RPC calls for a specific user. The field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc 2>,...,<rpc n>. If multiple whitelists are set for a given user, they are set-intersected. See -rpcwhitelistdefault documentation for information on default whitelist behavior.", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
757 argsman.AddArg("-rpcwhitelistdefault", "Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault is set to 0, if any -rpcwhitelist is set, the rpc server acts as if all rpc users are subject to empty-unless-otherwise-specified whitelists. If rpcwhitelistdefault is set to 1 and no -rpcwhitelist is set, rpc server acts as if all rpc users are subject to empty whitelists.", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
758 argsman.AddArg("-rpcworkqueue=<n>", strprintf("Set the maximum depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
759 argsman.AddArg("-server", "Accept command line and JSON-RPC commands", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
760 if (can_listen_ipc) {
761 argsman.AddArg("-ipcbind=<address>", "Bind to Unix socket address and listen for incoming connections. Valid address values are \"unix\" to listen on the default path, <datadir>/node.sock, or \"unix:/custom/path\" to specify a custom path. Can be specified multiple times to listen on multiple paths. Default behavior is not to listen on any path. If relative paths are specified, they are interpreted relative to the network data directory. If paths include any parent directory components and the parent directories do not exist, they will be created. Enabling this gives local processes that can access the socket unauthenticated RPC access, so it's important to choose a path with secure permissions if customizing this.", ArgsManager::ALLOW_ANY, OptionsCategory::IPC);
762 }
763
764#if HAVE_DECL_FORK
765 argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
766 argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
767#else
768 hidden_args.emplace_back("-daemon");
769 hidden_args.emplace_back("-daemonwait");
770#endif
771
772 // Add the hidden options
773 argsman.AddHiddenArgs(hidden_args);
774}
775
776#if HAVE_SYSTEM
777static void StartupNotify(const ArgsManager& args)
778{
779 std::string cmd = args.GetArg("-startupnotify", "");
780 if (!cmd.empty()) {
781 std::thread t(runCommand, cmd);
782 t.detach(); // thread runs free
783 }
784}
785#endif
786
788{
789 const ArgsManager& args = *Assert(node.args);
790 if (!InitHTTPServer()) {
791 return false;
792 }
793 StartRPC();
794 node.rpc_interruption_point = RpcInterruptionPoint;
795 if (!StartHTTPRPC(&node))
796 return false;
799 return true;
800}
801
802// Parameter interaction based on rules
804{
805 // when specifying an explicit binding address, you want to listen on it
806 // even when -connect or -proxy is specified
807 if (!args.GetArgs("-bind").empty()) {
808 if (args.SoftSetBoolArg("-listen", true))
809 LogInfo("parameter interaction: -bind set -> setting -listen=1\n");
810 }
811 if (!args.GetArgs("-whitebind").empty()) {
812 if (args.SoftSetBoolArg("-listen", true))
813 LogInfo("parameter interaction: -whitebind set -> setting -listen=1\n");
814 }
815
816 if (!args.GetArgs("-connect").empty() || args.IsArgNegated("-connect") || args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS) <= 0) {
817 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
818 // do the same when connections are disabled
819 if (args.SoftSetBoolArg("-dnsseed", false))
820 LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0\n");
821 if (args.SoftSetBoolArg("-listen", false))
822 LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0\n");
823 }
824
825 std::string proxy_arg = args.GetArg("-proxy", "");
826 if (proxy_arg != "" && proxy_arg != "0") {
827 // to protect privacy, do not listen by default if a default proxy server is specified
828 if (args.SoftSetBoolArg("-listen", false))
829 LogInfo("parameter interaction: -proxy set -> setting -listen=0\n");
830 // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
831 // to listen locally, so don't rely on this happening through -listen below.
832 if (args.SoftSetBoolArg("-natpmp", false)) {
833 LogInfo("parameter interaction: -proxy set -> setting -natpmp=0\n");
834 }
835 // to protect privacy, do not discover addresses by default
836 if (args.SoftSetBoolArg("-discover", false))
837 LogInfo("parameter interaction: -proxy set -> setting -discover=0\n");
838 }
839
840 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
841 // do not map ports or try to retrieve public IP when not listening (pointless)
842 if (args.SoftSetBoolArg("-natpmp", false)) {
843 LogInfo("parameter interaction: -listen=0 -> setting -natpmp=0\n");
844 }
845 if (args.SoftSetBoolArg("-discover", false))
846 LogInfo("parameter interaction: -listen=0 -> setting -discover=0\n");
847 if (args.SoftSetBoolArg("-listenonion", false))
848 LogInfo("parameter interaction: -listen=0 -> setting -listenonion=0\n");
849 if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
850 LogInfo("parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n");
851 }
852 }
853
854 if (!args.GetArgs("-externalip").empty()) {
855 // if an explicit public IP is specified, do not try to find others
856 if (args.SoftSetBoolArg("-discover", false))
857 LogInfo("parameter interaction: -externalip set -> setting -discover=0\n");
858 }
859
860 if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
861 // disable whitelistrelay in blocksonly mode
862 if (args.SoftSetBoolArg("-whitelistrelay", false))
863 LogInfo("parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n");
864 // Reduce default mempool size in blocksonly mode to avoid unexpected resource usage
866 LogInfo("parameter interaction: -blocksonly=1 -> setting -maxmempool=%d\n", DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB);
867 }
868
869 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
870 if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
871 if (args.SoftSetBoolArg("-whitelistrelay", true))
872 LogInfo("parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n");
873 }
874 const auto onlynets = args.GetArgs("-onlynet");
875 if (!onlynets.empty()) {
876 bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
877 const auto n = ParseNetwork(net);
878 return n == NET_IPV4 || n == NET_IPV6;
879 });
880 if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
881 LogInfo("parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n");
882 }
883 }
884}
885
893{
896}
897
898namespace { // Variables internal to initialization process only
899
900int nMaxConnections;
901int available_fds;
903int64_t peer_connect_timeout;
904std::set<BlockFilterType> g_enabled_filter_types;
905
906} // namespace
907
908[[noreturn]] static void new_handler_terminate()
909{
910 // Rather than throwing std::bad-alloc if allocation fails, terminate
911 // immediately to (try to) avoid chain corruption.
912 // Since logging may itself allocate memory, set the handler directly
913 // to terminate first.
914 std::set_new_handler(std::terminate);
915 LogError("Out of memory. Terminating.\n");
916
917 // The log was successful, terminate now.
918 std::terminate();
919};
920
921bool AppInitBasicSetup(const ArgsManager& args, std::atomic<int>& exit_status)
922{
923 // ********************************************************* Step 1: setup
924#ifdef _MSC_VER
925 // Turn off Microsoft heap dump noise
926 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
927 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
928 // Disable confusing "helpful" text message on abort, Ctrl-C
929 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
930#endif
931#ifdef WIN32
932 // Enable heap terminate-on-corruption
933 HeapSetInformation(nullptr, HeapEnableTerminationOnCorruption, nullptr, 0);
934#endif
935 if (!SetupNetworking()) {
936 return InitError(Untranslated("Initializing networking failed."));
937 }
938
939#ifndef WIN32
940 // Clean shutdown on SIGTERM
943
944 // Reopen debug.log on SIGHUP
946
947 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
948 signal(SIGPIPE, SIG_IGN);
949#else
950 SetConsoleCtrlHandler(consoleCtrlHandler, true);
951#endif
952
953 std::set_new_handler(new_handler_terminate);
954
955 return true;
956}
957
959{
960 const CChainParams& chainparams = Params();
961 // ********************************************************* Step 2: parameter interactions
962
963 // also see: InitParameterInteraction()
964
965 // We removed checkpoints but keep the option to warn users who still have it in their config.
966 if (args.IsArgSet("-checkpoints")) {
967 InitWarning(_("Option '-checkpoints' is set but checkpoints were removed. This option has no effect."));
968 }
969 if (args.IsArgSet("-limitancestorsize")) {
970 InitWarning(_("Option '-limitancestorsize' is given but ancestor size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
971 }
972 if (args.IsArgSet("-limitdescendantsize")) {
973 InitWarning(_("Option '-limitdescendantsize' is given but descendant size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
974 }
975
976 // Error if network-specific options (-addnode, -connect, etc) are
977 // specified in default section of config file, but not overridden
978 // on the command line or in this chain's section of the config file.
979 ChainType chain = args.GetChainType();
980 if (chain == ChainType::SIGNET) {
981 LogInfo("Signet derived magic (message start): %s", HexStr(chainparams.MessageStart()));
982 }
983 bilingual_str errors;
984 for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
985 errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section."), arg, ChainTypeToString(chain), ChainTypeToString(chain)) + Untranslated("\n");
986 }
987
988 if (!errors.empty()) {
989 return InitError(errors);
990 }
991
992 // Testnet3 deprecation warning
993 if (chain == ChainType::TESTNET) {
994 LogInfo("Warning: Support for testnet3 is deprecated and will be removed in an upcoming release. Consider switching to testnet4.\n");
995 }
996
997 // Warn if unrecognized section name are present in the config file.
998 bilingual_str warnings;
999 for (const auto& section : args.GetUnrecognizedSections()) {
1000 warnings += Untranslated(strprintf("%s:%i ", section.m_file, section.m_line)) + strprintf(_("Section [%s] is not recognized."), section.m_name) + Untranslated("\n");
1001 }
1002
1003 if (!warnings.empty()) {
1004 InitWarning(warnings);
1005 }
1006
1007 if (!fs::is_directory(args.GetBlocksDirPath())) {
1008 return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
1009 }
1010
1011 // parse and validate enabled filter types
1012 std::string blockfilterindex_value = args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
1013 if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
1014 g_enabled_filter_types = AllBlockFilterTypes();
1015 } else if (blockfilterindex_value != "0") {
1016 const std::vector<std::string> names = args.GetArgs("-blockfilterindex");
1017 for (const auto& name : names) {
1018 BlockFilterType filter_type;
1019 if (!BlockFilterTypeByName(name, filter_type)) {
1020 return InitError(strprintf(_("Unknown -blockfilterindex value %s."), name));
1021 }
1022 g_enabled_filter_types.insert(filter_type);
1023 }
1024 }
1025
1026 // Signal NODE_P2P_V2 if BIP324 v2 transport is enabled.
1027 if (args.GetBoolArg("-v2transport", DEFAULT_V2_TRANSPORT)) {
1028 g_local_services = ServiceFlags(g_local_services | NODE_P2P_V2);
1029 }
1030
1031 // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index are both enabled.
1032 if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
1033 if (!g_enabled_filter_types.contains(BlockFilterType::BASIC)) {
1034 return InitError(_("Cannot set -peerblockfilters without -blockfilterindex."));
1035 }
1036
1037 g_local_services = ServiceFlags(g_local_services | NODE_COMPACT_FILTERS);
1038 }
1039
1040 if (args.GetIntArg("-prune", 0)) {
1041 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX))
1042 return InitError(_("Prune mode is incompatible with -txindex."));
1043 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX))
1044 return InitError(_("Prune mode is incompatible with -txospenderindex."));
1045 if (args.GetBoolArg("-reindex-chainstate", false)) {
1046 return InitError(_("Prune mode is incompatible with -reindex-chainstate. Use full -reindex instead."));
1047 }
1048 }
1049
1050 // If -forcednsseed is set to true, ensure -dnsseed has not been set to false
1051 if (args.GetBoolArg("-forcednsseed", DEFAULT_FORCEDNSSEED) && !args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED)){
1052 return InitError(_("Cannot set -forcednsseed to true when setting -dnsseed to false."));
1053 }
1054
1055 // -bind and -whitebind can't be set when not listening
1056 size_t nUserBind = args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
1057 if (nUserBind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1058 return InitError(Untranslated("Cannot set -bind or -whitebind together with -listen=0"));
1059 }
1060
1061 // if listen=0, then disallow listenonion=1
1062 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN) && args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
1063 return InitError(Untranslated("Cannot set -listen=0 together with -listenonion=1"));
1064 }
1065
1066 // Make sure enough file descriptors are available. We need to reserve enough FDs to account for the bare minimum,
1067 // plus all manual connections and all bound interfaces. Any remainder will be available for connection sockets
1068
1069 // Number of bound interfaces (we have at least one)
1070 int nBind = std::max(nUserBind, size_t(1));
1071 // Maximum number of connections with other nodes, this accounts for all types of outbounds and inbounds except for manual
1072 int user_max_connection = args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
1073 if (user_max_connection < 0) {
1074 return InitError(Untranslated("-maxconnections must be greater or equal than zero"));
1075 }
1076 const size_t max_private{args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)
1078 : 0};
1079 // Reserve enough FDs to account for the bare minimum, plus any manual connections, plus the bound interfaces
1080 int min_required_fds = MIN_CORE_FDS + MAX_ADDNODE_CONNECTIONS + nBind;
1081
1082 // Try raising the FD limit to what we need (available_fds may be smaller than the requested amount if this fails)
1083 available_fds = RaiseFileDescriptorLimit(user_max_connection + max_private + min_required_fds);
1084 // If we are using select instead of poll, our actual limit may be even smaller
1085#ifndef USE_POLL
1086 available_fds = std::min(FD_SETSIZE, available_fds);
1087#endif
1088 if (available_fds < min_required_fds)
1089 return InitError(strprintf(_("Not enough file descriptors available. %d available, %d required."), available_fds, min_required_fds));
1090
1091 // Trim requested connection counts, to fit into system limitations
1092 nMaxConnections = std::min(available_fds - min_required_fds, user_max_connection);
1093
1094 if (nMaxConnections < user_max_connection)
1095 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), user_max_connection, nMaxConnections));
1096
1097 // ********************************************************* Step 3: parameter-to-internal-flags
1098 if (auto result{init::SetLoggingCategories(args)}; !result) return InitError(util::ErrorString(result));
1099 if (auto result{init::SetLoggingLevel(args)}; !result) return InitError(util::ErrorString(result));
1100
1102 if (nConnectTimeout <= 0) {
1104 }
1105
1106 peer_connect_timeout = args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
1107 if (peer_connect_timeout <= 0) {
1108 return InitError(Untranslated("peertimeout must be a positive integer."));
1109 }
1110
1111 auto mining_result{node::ReadMiningArgs(args)};
1112 if (!mining_result) {
1113 return InitError(util::ErrorString(mining_result));
1114 }
1115
1116 nBytesPerSigOp = args.GetIntArg("-bytespersigop", nBytesPerSigOp);
1117
1118 if (!g_wallet_init_interface.ParameterInteraction()) return false;
1119
1120 // Option to startup with mocktime set (used for regression testing):
1121 if (const auto mocktime{args.GetIntArg("-mocktime")}) {
1122 SetMockTime(std::chrono::seconds{*mocktime});
1123 }
1124
1125 if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1126 g_local_services = ServiceFlags(g_local_services | NODE_BLOOM);
1127
1128 const std::vector<std::string> test_options = args.GetArgs("-test");
1129 if (!test_options.empty()) {
1130 if (chainparams.GetChainType() != ChainType::REGTEST) {
1131 return InitError(Untranslated("-test=<option> can only be used with regtest"));
1132 }
1133 for (const std::string& option : test_options) {
1134 auto it = std::find_if(TEST_OPTIONS_DOC.begin(), TEST_OPTIONS_DOC.end(), [&option](const std::string& doc_option) {
1135 size_t pos = doc_option.find(" (");
1136 return (pos != std::string::npos) && (doc_option.substr(0, pos) == option);
1137 });
1138 if (it == TEST_OPTIONS_DOC.end()) {
1139 InitWarning(strprintf(_("Unrecognised option \"%s\" provided in -test=<option>."), option));
1140 }
1141 }
1142 }
1143
1144 // Prevent setting deployment parameters on mainnet.
1145 if (chainparams.GetChainType() == ChainType::MAIN) {
1146 if (args.IsArgSet("-testactivationheight")) {
1147 return InitError(_("The -testactivationheight option may not be used on mainnet."));
1148 }
1149 if (args.IsArgSet("-vbparams")) {
1150 return InitError(_("The -vbparams option may not be used on mainnet."));
1151 }
1152 }
1153
1154 // Also report errors from parsing before daemonization
1155 {
1156 kernel::Notifications notifications{};
1157 ChainstateManager::Options chainman_opts_dummy{
1158 .chainparams = chainparams,
1159 .datadir = args.GetDataDirNet(),
1160 .notifications = notifications,
1161 };
1162 auto chainman_result{ApplyArgsManOptions(args, chainman_opts_dummy)};
1163 if (!chainman_result) {
1164 return InitError(util::ErrorString(chainman_result));
1165 }
1166 BlockManager::Options blockman_opts_dummy{
1167 .chainparams = chainman_opts_dummy.chainparams,
1168 .blocks_dir = args.GetBlocksDirPath(),
1169 .notifications = chainman_opts_dummy.notifications,
1170 .block_tree_db_params = DBParams{
1171 .path = args.GetDataDirNet() / "blocks" / "index",
1172 .cache_bytes = 0,
1173 },
1174 };
1175 auto blockman_result{ApplyArgsManOptions(args, blockman_opts_dummy)};
1176 if (!blockman_result) {
1177 return InitError(util::ErrorString(blockman_result));
1178 }
1179 CTxMemPool::Options mempool_opts{};
1180 auto mempool_result{ApplyArgsManOptions(args, chainparams, mempool_opts)};
1181 if (!mempool_result) {
1182 return InitError(util::ErrorString(mempool_result));
1183 }
1184 }
1185
1186 return true;
1187}
1188
1189static bool LockDirectory(const fs::path& dir, bool probeOnly)
1190{
1191 // Make sure only a single process is using the directory.
1192 switch (util::LockDirectory(dir, ".lock", probeOnly)) {
1194 return InitError(strprintf(_("Cannot write to directory '%s'; check permissions."), fs::PathToString(dir)));
1196 return InitError(strprintf(_("Cannot obtain a lock on directory %s. %s is probably already running."), fs::PathToString(dir), CLIENT_NAME));
1197 case util::LockResult::Success: return true;
1198 } // no default case, so the compiler can warn about missing cases
1199 assert(false);
1200}
1201static bool LockDirectories(bool probeOnly)
1202{
1203 return LockDirectory(gArgs.GetDataDirNet(), probeOnly) && \
1204 LockDirectory(gArgs.GetBlocksDirPath(), probeOnly);
1205}
1206
1208{
1209 // ********************************************************* Step 4: sanity checks
1210 auto result{kernel::SanityChecks(kernel)};
1211 if (!result) {
1213 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), CLIENT_NAME));
1214 }
1215
1216 if (!ECC_InitSanityCheck()) {
1217 return InitError(strprintf(_("Elliptic curve cryptography sanity check failure. %s is shutting down."), CLIENT_NAME));
1218 }
1219
1220 // Probe the directory locks to give an early error message, if possible
1221 // We cannot hold the directory locks here, as the forking for daemon() hasn't yet happened,
1222 // and a fork will cause weird behavior to them.
1223 return LockDirectories(true);
1224}
1225
1227{
1228 // After daemonization get the directory locks again and hold on to them until exit
1229 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1230 // will at most make us exit without printing a message to console.
1231 if (!LockDirectories(false)) {
1232 // Detailed error printed inside LockDirectory
1233 return false;
1234 }
1235 return true;
1236}
1237
1239{
1241 // Specify wait_loaded=false so internal mining interface can be initialized
1242 // on early startup and does not need to be tied to chainstate loading.
1243 node.mining = interfaces::MakeMining(node, /*wait_loaded=*/false);
1244 return true;
1245}
1246
1248 for (const std::string port_option : {
1249 "-port",
1250 "-rpcport",
1251 }) {
1252 if (const auto port{args.GetArg(port_option)}) {
1253 const auto n{ToIntegral<uint16_t>(*port)};
1254 if (!n || *n == 0) {
1255 return InitError(InvalidPortErrMsg(port_option, *port));
1256 }
1257 }
1258 }
1259
1260 for ([[maybe_unused]] const auto& [param_name, unix, suffix_allowed] : std::vector<std::tuple<std::string, bool, bool>>{
1261 // arg name UNIX socket support =suffix allowed
1262 {"-i2psam", false, false},
1263 {"-onion", true, false},
1264 {"-proxy", true, true},
1265 {"-bind", false, true},
1266 {"-rpcbind", false, false},
1267 {"-torcontrol", false, false},
1268 {"-whitebind", false, false},
1269 {"-zmqpubhashblock", true, false},
1270 {"-zmqpubhashtx", true, false},
1271 {"-zmqpubrawblock", true, false},
1272 {"-zmqpubrawtx", true, false},
1273 {"-zmqpubsequence", true, false},
1274 }) {
1275 for (const std::string& param_value : args.GetArgs(param_name)) {
1276 const std::string param_value_hostport{
1277 suffix_allowed ? param_value.substr(0, param_value.rfind('=')) : param_value};
1278 std::string host_out;
1279 uint16_t port_out{0};
1280 if (!SplitHostPort(param_value_hostport, port_out, host_out)) {
1281#ifdef HAVE_SOCKADDR_UN
1282 // Allow unix domain sockets for some options e.g. unix:/some/file/path
1283 if (!unix || !param_value.starts_with(ADDR_PREFIX_UNIX)) {
1284 return InitError(InvalidPortErrMsg(param_name, param_value));
1285 }
1286#else
1287 return InitError(InvalidPortErrMsg(param_name, param_value));
1288#endif
1289 }
1290 }
1291 }
1292
1293 return true;
1294}
1295
1302static std::optional<CService> CheckBindingConflicts(const CConnman::Options& conn_options)
1303{
1304 std::set<CService> seen;
1305
1306 // Check all whitelisted bindings
1307 for (const auto& wb : conn_options.vWhiteBinds) {
1308 if (!seen.insert(wb.m_service).second) {
1309 return wb.m_service;
1310 }
1311 }
1312
1313 // Check regular bindings
1314 for (const auto& bind : conn_options.vBinds) {
1315 if (!seen.insert(bind).second) {
1316 return bind;
1317 }
1318 }
1319
1320 // Check onion bindings
1321 for (const auto& onion_bind : conn_options.onion_binds) {
1322 if (!seen.insert(onion_bind).second) {
1323 return onion_bind;
1324 }
1325 }
1326
1327 return std::nullopt;
1328}
1329
1330// A GUI user may opt to retry once with do_reindex set if there is a failure during chainstate initialization.
1331// The function therefore has to support re-entry.
1334 bool do_reindex,
1335 const bool do_reindex_chainstate,
1336 const kernel::CacheSizes& cache_sizes,
1337 const ArgsManager& args)
1338{
1339 // This function may be called twice, so any dirty state must be reset.
1340 node.notifications->setChainstateLoaded(false); // Drop state, such as a cached tip block
1341 node.mempool.reset();
1342 node.chainman.reset(); // Drop state, such as an initialized m_block_tree_db
1343
1344 const CChainParams& chainparams = Params();
1345
1346 CTxMemPool::Options mempool_opts{
1347 .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
1348 .signals = node.validation_signals.get(),
1349 };
1350 Assert(ApplyArgsManOptions(args, chainparams, mempool_opts)); // no error can happen, already checked in AppInitParameterInteraction
1351 bilingual_str mempool_error;
1352 Assert(!node.mempool); // Was reset above
1353 node.mempool = std::make_unique<CTxMemPool>(mempool_opts, mempool_error);
1354 if (!mempool_error.empty()) {
1355 return {ChainstateLoadStatus::FAILURE_FATAL, mempool_error};
1356 }
1357 auto mining_args{node::ReadMiningArgs(args)};
1358 Assert(mining_args); // no error can happen, already checked in AppInitParameterInteraction
1359 node.mining_args = std::move(*mining_args);
1360 LogInfo("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of unused mempool space)",
1361 cache_sizes.coins / double(1_MiB),
1362 mempool_opts.max_size_bytes / double(1_MiB));
1363 ChainstateManager::Options chainman_opts{
1364 .chainparams = chainparams,
1365 .datadir = args.GetDataDirNet(),
1366 .notifications = *node.notifications,
1367 .signals = node.validation_signals.get(),
1368 };
1369 Assert(ApplyArgsManOptions(args, chainman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1370
1371 BlockManager::Options blockman_opts{
1372 .chainparams = chainman_opts.chainparams,
1373 .blocks_dir = args.GetBlocksDirPath(),
1374 .notifications = chainman_opts.notifications,
1375 .block_tree_db_params = DBParams{
1376 .path = args.GetDataDirNet() / "blocks" / "index",
1377 .cache_bytes = cache_sizes.block_tree_db,
1378 .wipe_data = do_reindex,
1379 },
1380 };
1381 Assert(ApplyArgsManOptions(args, blockman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1382
1383 // Creating the chainstate manager internally creates a BlockManager, opens
1384 // the blocks tree db, and wipes existing block files in case of a reindex.
1385 // The coinsdb is opened at a later point on LoadChainstate.
1386 Assert(!node.chainman); // Was reset above
1387 try {
1388 node.chainman = std::make_unique<ChainstateManager>(*Assert(node.shutdown_signal), chainman_opts, blockman_opts);
1389 } catch (dbwrapper_error& e) {
1390 LogError("%s", e.what());
1391 return {ChainstateLoadStatus::FAILURE, _("Error opening block database")};
1392 } catch (std::exception& e) {
1393 return {ChainstateLoadStatus::FAILURE_FATAL, Untranslated(strprintf("Failed to initialize ChainstateManager: %s", e.what()))};
1394 }
1395 ChainstateManager& chainman = *node.chainman;
1396 if (chainman.m_interrupt) return {ChainstateLoadStatus::INTERRUPTED, {}};
1397
1398 // This is defined and set here instead of inline in validation.h to avoid a hard
1399 // dependency between validation and index/base, since the latter is not in
1400 // libbitcoinkernel.
1401 chainman.snapshot_download_completed = [&node]() {
1402 if (!node.chainman->m_blockman.IsPruneMode()) {
1403 LogInfo("[snapshot] re-enabling NODE_NETWORK services");
1404 node.connman->AddLocalServices(NODE_NETWORK);
1405 }
1406 LogInfo("[snapshot] restarting indexes");
1407 // Drain the validation interface queue to ensure that the old indexes
1408 // don't have any pending work.
1409 Assert(node.validation_signals)->SyncWithValidationInterfaceQueue();
1410 for (auto* index : node.indexes) {
1411 index->Interrupt();
1412 index->Stop();
1413 if (!(index->Init() && index->StartBackgroundSync())) {
1414 LogWarning("[snapshot] Failed to restart index %s on snapshot chain", index->GetName());
1415 }
1416 }
1417 };
1419 options.mempool = Assert(node.mempool.get());
1420 options.wipe_chainstate_db = do_reindex || do_reindex_chainstate;
1421 options.prune = chainman.m_blockman.IsPruneMode();
1422 options.check_blocks = args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
1423 options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
1424 options.require_full_verification = args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
1425 options.coins_error_cb = [] {
1427 _("Error reading from database, shutting down."),
1429 };
1430 uiInterface.InitMessage(_("Loading block index…"));
1431 auto catch_exceptions = [](auto&& f) -> ChainstateLoadResult {
1432 try {
1433 return f();
1434 } catch (const std::exception& e) {
1435 LogError("%s\n", e.what());
1436 return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1437 }
1438 };
1439 auto [status, error] = catch_exceptions([&] { return LoadChainstate(chainman, cache_sizes, options); });
1441 uiInterface.InitMessage(_("Verifying blocks…"));
1442 if (chainman.m_blockman.m_have_pruned && options.check_blocks > MIN_BLOCKS_TO_KEEP) {
1443 LogWarning("pruned datadir may not have more than %d blocks; only checking available blocks\n",
1445 }
1446 std::tie(status, error) = catch_exceptions([&] { return VerifyLoadedChainstate(chainman, options); });
1448 LogInfo("Block index and chainstate loaded");
1449 node.notifications->setChainstateLoaded(true);
1450 }
1451 }
1452 return {status, error};
1453};
1454
1456{
1457 const ArgsManager& args = *Assert(node.args);
1458 const CChainParams& chainparams = Params();
1459
1460 auto opt_max_upload = ParseByteUnits(args.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET), ByteUnit::M);
1461 if (!opt_max_upload) {
1462 return InitError(strprintf(_("Unable to parse -maxuploadtarget: '%s'"), args.GetArg("-maxuploadtarget", "")));
1463 }
1464
1465 // ********************************************************* Step 4a: application initialization
1466 if (!CreatePidFile(args)) {
1467 // Detailed error printed inside CreatePidFile().
1468 return false;
1469 }
1470 if (!init::StartLogging(args)) {
1471 // Detailed error printed inside StartLogging().
1472 return false;
1473 }
1474
1475 LogInfo("Using at most %i automatic connections (%i file descriptors available)", nMaxConnections, available_fds);
1476
1477 // Warn about relative -datadir path.
1478 if (args.IsArgSet("-datadir") && !args.GetPathArg("-datadir").is_absolute()) {
1479 LogWarning("Relative datadir option '%s' specified, which will be interpreted relative to the "
1480 "current working directory '%s'. This is fragile, because if bitcoin is started in the future "
1481 "from a different location, it will be unable to locate the current data files. There could "
1482 "also be data loss if bitcoin is started while in a temporary directory.",
1483 args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1484 }
1485
1486 assert(!node.scheduler);
1487 node.scheduler = std::make_unique<CScheduler>();
1488 auto& scheduler = *node.scheduler;
1489
1490 // Start the lightweight task scheduler thread
1491 scheduler.m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { scheduler.serviceQueue(); });
1492
1493 // Gather some entropy once per minute.
1494 scheduler.scheduleEvery([]{
1496 }, std::chrono::minutes{1});
1497
1498 // Check disk space every 5 minutes to avoid db corruption.
1499 scheduler.scheduleEvery([&args, &node]{
1500 constexpr uint64_t min_disk_space{50_MiB};
1501 if (!CheckDiskSpace(args.GetBlocksDirPath(), min_disk_space)) {
1502 LogError("Shutting down due to lack of disk space!\n");
1503 if (!(Assert(node.shutdown_request))()) {
1504 LogError("Failed to send shutdown signal after disk space check\n");
1505 }
1506 }
1507 }, std::chrono::minutes{5});
1508
1509 if (args.GetBoolArg("-logratelimit", BCLog::DEFAULT_LOGRATELIMIT)) {
1511 [&scheduler](auto func, auto window) { scheduler.scheduleEvery(std::move(func), window); },
1514 } else {
1515 LogInfo("Log rate limiting disabled");
1516 }
1517
1518 assert(!node.validation_signals);
1519 node.validation_signals = std::make_unique<ValidationSignals>(std::make_unique<SerialTaskRunner>(scheduler));
1520 auto& validation_signals = *node.validation_signals;
1521
1522 // Create KernelNotifications object. Important to do this early before
1523 // calling ipc->listenAddress() below so makeMining and other IPC methods
1524 // can use this.
1525 assert(!node.notifications);
1526 node.notifications = std::make_unique<KernelNotifications>(Assert(node.shutdown_request), node.exit_status, *Assert(node.warnings));
1527 ReadNotificationArgs(args, *node.notifications);
1528
1529 // Create client interfaces for wallets that are supposed to be loaded
1530 // according to -wallet and -disablewallet options. This only constructs
1531 // the interfaces, it doesn't load wallet data. Wallets actually get loaded
1532 // when load() and start() interface methods are called below.
1535
1536 if (interfaces::Ipc* ipc = node.init->ipc()) {
1537 for (std::string address : gArgs.GetArgs("-ipcbind")) {
1538 try {
1539 ipc->listenAddress(address);
1540 } catch (const std::exception& e) {
1541 return InitError(Untranslated(strprintf("Unable to bind to IPC address '%s'. %s", address, e.what())));
1542 }
1543 LogInfo("Listening for IPC requests on address %s", address);
1544 }
1545 }
1546
1547 /* Register RPC commands regardless of -server setting so they will be
1548 * available in the GUI RPC console even if external calls are disabled.
1549 */
1551 for (const auto& client : node.chain_clients) {
1552 client->registerRpcs();
1553 }
1554#ifdef ENABLE_ZMQ
1556#endif
1557
1558 // Check port numbers
1559 if (!CheckHostPortOptions(args)) return false;
1560
1561 // Configure reachable networks before we start the RPC server.
1562 // This is necessary for -rpcallowip to distinguish CJDNS from other RFC4193
1563 const auto onlynets = args.GetArgs("-onlynet");
1564 if (!onlynets.empty()) {
1566 for (const std::string& snet : onlynets) {
1567 enum Network net = ParseNetwork(snet);
1568 if (net == NET_UNROUTABLE)
1569 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1570 g_reachable_nets.Add(net);
1571 }
1572 }
1573
1574 if (!args.IsArgSet("-cjdnsreachable")) {
1575 if (!onlynets.empty() && g_reachable_nets.Contains(NET_CJDNS)) {
1576 return InitError(
1577 _("Outbound connections restricted to CJDNS (-onlynet=cjdns) but "
1578 "-cjdnsreachable is not provided"));
1579 }
1581 }
1582 // Now g_reachable_nets.Contains(NET_CJDNS) is true if:
1583 // 1. -cjdnsreachable is given and
1584 // 2.1. -onlynet is not given or
1585 // 2.2. -onlynet=cjdns is given
1586
1587 /* Start the RPC server already. It will be started in "warmup" mode
1588 * and not really process calls already (but it will signify connections
1589 * that the server is there and will be ready later). Warmup mode will
1590 * be disabled when initialisation is finished.
1591 */
1592 if (args.GetBoolArg("-server", false)) {
1594 if (!AppInitServers(node))
1595 return InitError(_("Unable to start HTTP server. See debug log for details."));
1596 }
1597
1598 // ********************************************************* Step 5: verify wallet database integrity
1599 for (const auto& client : node.chain_clients) {
1600 if (!client->verify()) {
1601 return false;
1602 }
1603 }
1604
1605 // ********************************************************* Step 6: network initialization
1606 // Note that we absolutely cannot open any actual connections
1607 // until the very end ("start node") as the UTXO/block state
1608 // is not yet setup and may end up being set up twice if we
1609 // need to reindex later.
1610
1611 fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
1612 fDiscover = args.GetBoolArg("-discover", true);
1613
1614 PeerManager::Options peerman_opts{};
1615 ApplyArgsManOptions(args, peerman_opts);
1616
1617 {
1618 // Read asmap file if configured or embedded asmap data and initialize
1619 // Netgroupman with or without it
1620 assert(!node.netgroupman);
1621 if (args.IsArgSet("-asmap") && !args.IsArgNegated("-asmap")) {
1622 uint256 asmap_version{};
1623 if (!args.GetBoolArg("-asmap", false)) {
1624 fs::path asmap_path = args.GetPathArg("-asmap");
1625 if (!asmap_path.is_absolute()) {
1626 asmap_path = args.GetDataDirNet() / asmap_path;
1627 }
1628
1629 // If a specific path was passed with the asmap argument check if
1630 // the file actually exists in that location
1631 if (!fs::exists(asmap_path)) {
1632 InitError(strprintf(_("Could not find asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1633 return false;
1634 }
1635
1636 // If a file exists at the path, try to read the file
1637 std::vector<std::byte> asmap{DecodeAsmap(asmap_path)};
1638 if (asmap.empty()) {
1639 InitError(strprintf(_("Could not parse asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1640 return false;
1641 }
1642 asmap_version = AsmapVersion(asmap);
1643 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithLoadedAsmap(std::move(asmap)));
1644 } else {
1645 #ifdef ENABLE_EMBEDDED_ASMAP
1646 // Use the embedded asmap data
1647 std::span<const std::byte> asmap{node::data::ip_asn};
1648 if (asmap.empty() || !CheckStandardAsmap(asmap)) {
1649 InitError(strprintf(_("Could not read embedded asmap data")));
1650 return false;
1651 }
1652 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithEmbeddedAsmap(asmap));
1653 asmap_version = AsmapVersion(asmap);
1654 LogInfo("Opened asmap data (%zu bytes) from embedded byte array\n", asmap.size());
1655 #else
1656 // If there is no embedded data, fail and report it since
1657 // the user tried to use it
1658 InitError(strprintf(_("Embedded asmap data not available")));
1659 return false;
1660 #endif
1661 }
1662 LogInfo("Using asmap version %s for IP bucketing", asmap_version.ToString());
1663 } else {
1664 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::NoAsmap());
1665 LogInfo("Using /16 prefix for IP bucketing");
1666 }
1667
1668 // Initialize addrman
1669 assert(!node.addrman);
1670 uiInterface.InitMessage(_("Loading P2P addresses…"));
1671 auto addrman{LoadAddrman(*node.netgroupman, args)};
1672 if (!addrman) return InitError(util::ErrorString(addrman));
1673 node.addrman = std::move(*addrman);
1674 }
1675
1677 assert(!node.banman);
1678 node.banman = std::make_unique<BanMan>(args.GetDataDirNet() / "banlist", &uiInterface, args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
1679 assert(!node.connman);
1680 node.connman = std::make_unique<CConnman>(rng.rand64(),
1681 rng.rand64(),
1682 *node.addrman, *node.netgroupman, chainparams, args.GetBoolArg("-networkactive", true));
1683
1684 for (const std::string& socket_addr : args.GetArgs("-bind")) {
1685 std::string host_out;
1686 uint16_t port_out{0};
1687 std::string bind_socket_addr = socket_addr.substr(0, socket_addr.rfind('='));
1688 if (!SplitHostPort(bind_socket_addr, port_out, host_out)) {
1689 return InitError(InvalidPortErrMsg("-bind", socket_addr));
1690 }
1691 }
1692
1693 // sanitize comments per BIP-0014, format user agent and check total size
1694 std::vector<std::string> uacomments;
1695 for (const std::string& cmt : args.GetArgs("-uacomment")) {
1696 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1697 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1698 uacomments.push_back(cmt);
1699 }
1701 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1702 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1704 }
1705
1706 // Requesting DNS seeds entails connecting to IPv4/IPv6, which -onlynet options may prohibit:
1707 // If -dnsseed=1 is explicitly specified, abort. If it's left unspecified by the user, we skip
1708 // the DNS seeds by adjusting -dnsseed in InitParameterInteraction.
1710 return InitError(strprintf(_("Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")));
1711 };
1712
1713 // Check for host lookup allowed before parsing any network related parameters
1715
1716 bool proxyRandomize = args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1717 // -proxy sets a proxy for outgoing network traffic, possibly per network.
1718 // -noproxy, -proxy=0 or -proxy="" can be used to remove the proxy setting, this is the default
1719 Proxy ipv4_proxy;
1720 Proxy ipv6_proxy;
1721 Proxy onion_proxy;
1722 Proxy name_proxy;
1723 Proxy cjdns_proxy;
1724 for (const std::string& param_value : args.GetArgs("-proxy")) {
1725 const auto eq_pos{param_value.rfind('=')};
1726 const std::string proxy_str{param_value.substr(0, eq_pos)}; // e.g. 127.0.0.1:9050=ipv4 -> 127.0.0.1:9050
1727 std::string net_str;
1728 if (eq_pos != std::string::npos) {
1729 if (eq_pos + 1 == param_value.length()) {
1730 return InitError(strprintf(_("Invalid -proxy address or hostname, ends with '=': '%s'"), param_value));
1731 }
1732 net_str = ToLower(param_value.substr(eq_pos + 1)); // e.g. 127.0.0.1:9050=ipv4 -> ipv4
1733 }
1734
1735 Proxy proxy;
1736 if (!proxy_str.empty() && proxy_str != "0") {
1737 if (IsUnixSocketPath(proxy_str)) {
1738 proxy = Proxy{proxy_str, /*tor_stream_isolation=*/proxyRandomize};
1739 } else {
1740 const std::optional<CService> addr{Lookup(proxy_str, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1741 if (!addr.has_value()) {
1742 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1743 }
1744 proxy = Proxy{addr.value(), /*tor_stream_isolation=*/proxyRandomize};
1745 }
1746 if (!proxy.IsValid()) {
1747 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1748 }
1749 }
1750
1751 if (net_str.empty()) { // For all networks.
1752 ipv4_proxy = ipv6_proxy = name_proxy = cjdns_proxy = onion_proxy = proxy;
1753 } else if (net_str == "ipv4") {
1754 ipv4_proxy = name_proxy = proxy;
1755 } else if (net_str == "ipv6") {
1756 ipv6_proxy = name_proxy = proxy;
1757 } else if (net_str == "onion") {
1758 onion_proxy = proxy;
1759 } else if (net_str == "cjdns") {
1760 cjdns_proxy = proxy;
1761 } else {
1762 return InitError(strprintf(_("Unrecognized network in -proxy='%s': '%s'"), param_value, net_str));
1763 }
1764 }
1765 if (ipv4_proxy.IsValid()) {
1766 SetProxy(NET_IPV4, ipv4_proxy);
1767 }
1768 if (ipv6_proxy.IsValid()) {
1769 SetProxy(NET_IPV6, ipv6_proxy);
1770 }
1771 if (name_proxy.IsValid()) {
1772 SetNameProxy(name_proxy);
1773 }
1774 if (cjdns_proxy.IsValid()) {
1775 SetProxy(NET_CJDNS, cjdns_proxy);
1776 }
1777
1778 const bool onlynet_used_with_onion{!onlynets.empty() && g_reachable_nets.Contains(NET_ONION)};
1779
1780 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1781 // -noonion (or -onion=0) disables connecting to .onion entirely
1782 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1783 std::string onionArg = args.GetArg("-onion", "");
1784 if (onionArg != "") {
1785 if (onionArg == "0") { // Handle -noonion/-onion=0
1786 onion_proxy = Proxy{};
1787 if (onlynet_used_with_onion) {
1788 return InitError(
1789 _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1790 "reaching the Tor network is explicitly forbidden: -onion=0"));
1791 }
1792 } else {
1793 if (IsUnixSocketPath(onionArg)) {
1794 onion_proxy = Proxy(onionArg, /*tor_stream_isolation=*/proxyRandomize);
1795 } else {
1796 const std::optional<CService> addr{Lookup(onionArg, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1797 if (!addr.has_value() || !addr->IsValid()) {
1798 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1799 }
1800
1801 onion_proxy = Proxy(addr.value(), /*tor_stream_isolation=*/proxyRandomize);
1802 }
1803 }
1804 }
1805
1806 const bool listenonion{args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
1807 if (onion_proxy.IsValid()) {
1808 SetProxy(NET_ONION, onion_proxy);
1809 } else {
1810 // If -listenonion is set, then we will (try to) connect to the Tor control port
1811 // later from the torcontrol thread and may retrieve the onion proxy from there.
1812 if (onlynet_used_with_onion && !listenonion) {
1813 return InitError(
1814 _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1815 "reaching the Tor network is not provided: none of -proxy, -onion or "
1816 "-listenonion is given"));
1817 }
1819 }
1820
1821 for (const std::string& strAddr : args.GetArgs("-externalip")) {
1822 const std::optional<CService> addrLocal{Lookup(strAddr, GetListenPort(), fNameLookup)};
1823 if (addrLocal.has_value() && addrLocal->IsValid())
1824 AddLocal(addrLocal.value(), LOCAL_MANUAL, /*add_even_if_unreachable=*/true);
1825 else
1826 return InitError(ResolveErrMsg("externalip", strAddr));
1827 }
1828
1829#ifdef ENABLE_ZMQ
1831 [&chainman = node.chainman](std::vector<std::byte>& block, const CBlockIndex& index) {
1832 assert(chainman);
1833 if (auto ret{chainman->m_blockman.ReadRawBlock(WITH_LOCK(cs_main, return index.GetBlockPos()))}) {
1834 block = std::move(*ret);
1835 return true;
1836 }
1837 return false;
1838 });
1839
1841 validation_signals.RegisterValidationInterface(g_zmq_notification_interface.get());
1842 }
1843#endif
1844
1845 // ********************************************************* Step 7: load block chain
1846
1847 // cache size calculations
1849 const auto [index_cache_sizes, kernel_cache_sizes] = CalculateCacheSizes(args, g_enabled_filter_types.size());
1850
1851 LogInfo("Cache configuration:");
1852 LogInfo("* Using %.1f MiB for block index database", kernel_cache_sizes.block_tree_db / double(1_MiB));
1853 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1854 LogInfo("* Using %.1f MiB for transaction index database", index_cache_sizes.tx_index / double(1_MiB));
1855 }
1856 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
1857 LogInfo("* Using %.1f MiB for transaction output spender index database", index_cache_sizes.txospender_index / double(1_MiB));
1858 }
1859 for (BlockFilterType filter_type : g_enabled_filter_types) {
1860 LogInfo("* Using %.1f MiB for %s block filter index database",
1861 index_cache_sizes.filter_index / double(1_MiB), BlockFilterTypeName(filter_type));
1862 }
1863 LogInfo("* Using %.1f MiB for chain state database", kernel_cache_sizes.coins_db / double(1_MiB));
1864
1865 assert(!node.mempool);
1866 assert(!node.chainman);
1867
1868 bool do_reindex{args.GetBoolArg("-reindex", false)};
1869 const bool do_reindex_chainstate{args.GetBoolArg("-reindex-chainstate", false)};
1870
1871 // Chainstate initialization and loading may be retried once with reindexing by GUI users
1872 auto [status, error] = InitAndLoadChainstate(
1873 node,
1874 do_reindex,
1875 do_reindex_chainstate,
1876 kernel_cache_sizes,
1877 args);
1878 if (status == ChainstateLoadStatus::FAILURE && !do_reindex && !ShutdownRequested(node)) {
1879 // suggest a reindex
1880 bool do_retry{HasTestOption(args, "reindex_after_failure_noninteractive_yes") ||
1882 error + Untranslated(".\n\n") + _("Do you want to rebuild the databases now?"),
1883 error.original + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1885 if (!do_retry) {
1886 return false;
1887 }
1888 do_reindex = true;
1889 if (!Assert(node.shutdown_signal)->reset()) {
1890 LogError("Internal error: failed to reset shutdown signal.\n");
1891 }
1892 std::tie(status, error) = InitAndLoadChainstate(
1893 node,
1894 do_reindex,
1895 do_reindex_chainstate,
1896 kernel_cache_sizes,
1897 args);
1898 }
1899 if (status != ChainstateLoadStatus::SUCCESS && status != ChainstateLoadStatus::INTERRUPTED) {
1900 return InitError(error);
1901 }
1902
1903 // As LoadBlockIndex can take several minutes, it's possible the user
1904 // requested to kill the GUI during the last operation. If so, exit.
1905 if (ShutdownRequested(node)) {
1906 LogInfo("Shutdown requested. Exiting.");
1907 return true;
1908 }
1909
1910 ChainstateManager& chainman = *Assert(node.chainman);
1911
1912 assert(!node.fee_estimator_man);
1913 // Don't initialize fee estimation with old data if we don't relay transactions,
1914 // as they would never get updated.
1915 if (!peerman_opts.ignore_incoming_txs) {
1916 bool read_stale_estimates = args.GetBoolArg("-acceptstalefeeestimates", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES);
1917 if (read_stale_estimates && (chainparams.GetChainType() != ChainType::REGTEST)) {
1918 return InitError(strprintf(_("acceptstalefeeestimates is not supported on %s chain."), chainparams.GetChainTypeString()));
1919 }
1921 node.fee_estimator_man = std::make_unique<FeeRateEstimatorManager>(BlockPolicyFeeEstPath(args), read_stale_estimates, MempoolPolicyEstimatorPath(args), *Assert(node.mempool), chainman);
1922
1923 // Flush estimates to disk periodically
1924 FeeRateEstimatorManager* fee_estimator_man = node.fee_estimator_man.get();
1925 scheduler.scheduleEvery([fee_estimator_man] { fee_estimator_man->IntervalFlush(); }, FEE_FLUSH_INTERVAL);
1926 validation_signals.RegisterValidationInterface(fee_estimator_man);
1927 }
1928
1929 auto& kernel_notifications{*Assert(node.notifications)};
1930
1931 assert(!node.peerman);
1932 node.peerman = PeerManager::make(*node.connman, *node.addrman,
1933 node.banman.get(), chainman,
1934 *node.mempool, *node.warnings,
1935 peerman_opts);
1936 validation_signals.RegisterValidationInterface(node.peerman.get());
1937
1938 // ********************************************************* Step 8: start indexers
1939
1940 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1941 g_txindex = std::make_unique<TxIndex>(interfaces::MakeChain(node), index_cache_sizes.tx_index, false, do_reindex);
1942 node.indexes.emplace_back(g_txindex.get());
1943 }
1944
1945 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
1946 g_txospenderindex = std::make_unique<TxoSpenderIndex>(interfaces::MakeChain(node), index_cache_sizes.txospender_index, false, do_reindex);
1947 node.indexes.emplace_back(g_txospenderindex.get());
1948 }
1949
1950 for (const auto& filter_type : g_enabled_filter_types) {
1951 InitBlockFilterIndex([&]{ return interfaces::MakeChain(node); }, filter_type, index_cache_sizes.filter_index, false, do_reindex);
1952 node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
1953 }
1954
1955 if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
1956 g_coin_stats_index = std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /*cache_size=*/0, false, do_reindex);
1957 node.indexes.emplace_back(g_coin_stats_index.get());
1958 }
1959
1960 // Init indexes
1961 for (auto index : node.indexes) if (!index->Init()) return false;
1962
1963 // ********************************************************* Step 9: load wallet
1964 for (const auto& client : node.chain_clients) {
1965 if (!client->load()) {
1966 return false;
1967 }
1968 }
1969
1970 // ********************************************************* Step 10: data directory maintenance
1971
1972 // if pruning, perform the initial blockstore prune
1973 // after any wallet rescanning has taken place.
1974 if (chainman.m_blockman.IsPruneMode()) {
1975 if (chainman.m_blockman.m_blockfiles_indexed) {
1976 LOCK(cs_main);
1977 for (const auto& chainstate : chainman.m_chainstates) {
1978 uiInterface.InitMessage(_("Pruning blockstore…"));
1979 chainstate->PruneAndFlush();
1980 }
1981 }
1982 } else {
1983 // Prior to setting NODE_NETWORK, check if we can provide historical blocks.
1984 if (!WITH_LOCK(chainman.GetMutex(), return chainman.HistoricalChainstate())) {
1985 LogInfo("Setting NODE_NETWORK in non-prune mode");
1986 g_local_services = ServiceFlags(g_local_services | NODE_NETWORK);
1987 } else {
1988 LogInfo("Running node in NODE_NETWORK_LIMITED mode until snapshot background sync completes");
1989 }
1990 }
1991
1992 // ********************************************************* Step 11: import blocks
1993
1995 InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetDataDirNet()))));
1996 return false;
1997 }
1999 InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetBlocksDirPath()))));
2000 return false;
2001 }
2002
2003 int chain_active_height = WITH_LOCK(cs_main, return chainman.ActiveChain().Height());
2004
2005 // On first startup, warn on low block storage space
2006 if (!do_reindex && !do_reindex_chainstate && chain_active_height <= 1) {
2007 uint64_t assumed_chain_bytes{chainparams.AssumedBlockchainSize() * 1_GiB};
2008 uint64_t additional_bytes_needed{
2009 chainman.m_blockman.IsPruneMode() ?
2010 std::min(chainman.m_blockman.GetPruneTarget(), assumed_chain_bytes) :
2011 assumed_chain_bytes};
2012
2013 if (!CheckDiskSpace(args.GetBlocksDirPath(), additional_bytes_needed)) {
2015 "Disk space for %s may not accommodate the block files. " \
2016 "Approximately %u GB of data will be stored in this directory."
2017 ),
2018 fs::quoted(fs::PathToString(args.GetBlocksDirPath())),
2019 chainparams.AssumedBlockchainSize()
2020 ));
2021 }
2022 }
2023
2024#ifdef __APPLE__
2025 auto check_and_warn_fs{[&](const fs::path& path, std::string_view desc) {
2026 const auto path_desc{strprintf("%s (\"%s\")", desc, fs::PathToString(path))};
2027 switch (GetFilesystemType(path)) {
2028 case FSType::EXFAT:
2029 InitWarning(strprintf(_("The %s path uses exFAT, which is known to have intermittent corruption problems on macOS. "
2030 "Move this directory to a different filesystem to avoid data loss."), path_desc));
2031 break;
2032 case FSType::ERROR:
2033 LogInfo("Failed to detect filesystem type for %s", path_desc);
2034 break;
2035 case FSType::OTHER:
2036 break;
2037 }
2038 }};
2039
2040 check_and_warn_fs(args.GetDataDirNet(), "data directory");
2041 check_and_warn_fs(args.GetBlocksDirPath(), "blocks directory");
2042#endif
2043
2044#if HAVE_SYSTEM
2045 const std::string block_notify = args.GetArg("-blocknotify", "");
2046 if (!block_notify.empty()) {
2047 uiInterface.NotifyBlockTip.connect([block_notify](SynchronizationState sync_state, const CBlockIndex& block, double /* verification_progress */) {
2048 if (sync_state != SynchronizationState::POST_INIT) return;
2049 std::string command = block_notify;
2050 ReplaceAll(command, "%s", block.GetBlockHash().GetHex());
2051 std::thread t(runCommand, command);
2052 t.detach(); // thread runs free
2053 });
2054 }
2055#endif
2056
2057 std::vector<fs::path> vImportFiles;
2058 for (const std::string& strFile : args.GetArgs("-loadblock")) {
2059 vImportFiles.push_back(fs::PathFromString(strFile));
2060 }
2061
2063 node.background_init_thread = std::thread(&util::TraceThread, "initload", [=, &chainman, &args, &kernel_notifications, &node] {
2065 // Import blocks and ActivateBestChain()
2066 ImportBlocks(chainman, vImportFiles);
2067 // An interrupted import may return without activating genesis. Wake
2068 // the init thread's genesis wait, which is otherwise only notified
2069 // on blockTip, and that never fires when the import was interrupted
2070 // before activating genesis. This wakeup lets the wait observe the
2071 // shutdown request.
2072 WITH_LOCK(kernel_notifications.m_tip_block_mutex, kernel_notifications.m_tip_block_cv.notify_all());
2073 WITH_LOCK(::cs_main, chainman.UpdateIBDStatus());
2074 if (args.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
2075 LogInfo("Stopping after block import");
2076 if (!(Assert(node.shutdown_request))()) {
2077 LogError("Failed to send shutdown signal after finishing block import\n");
2078 }
2079 return;
2080 }
2081
2082 // Start indexes initial sync
2084 bilingual_str err_str = _("Failed to start indexes, shutting down…");
2085 chainman.GetNotifications().fatalError(err_str);
2086 return;
2087 }
2088 // Load mempool from disk
2089 if (auto* pool{chainman.ActiveChainstate().GetMempool()}) {
2090 LoadMempool(*pool, ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{}, chainman.ActiveChainstate(), {});
2091 pool->SetLoadTried(!chainman.m_interrupt);
2092 }
2093 });
2094
2095 /*
2096 * Wait for genesis block to be processed. Typically kernel_notifications.m_tip_block
2097 * has already been set by a call to LoadChainTip() in CompleteChainstateInitialization().
2098 * But this is skipped if the chainstate doesn't exist yet or is being wiped:
2099 *
2100 * 1. first startup with an empty datadir
2101 * 2. reindex
2102 * 3. reindex-chainstate
2103 *
2104 * In these case it's connected by a call to ActivateBestChain() in the initload thread.
2105 */
2106 {
2107 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
2108 kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
2109 return kernel_notifications.TipBlock() || ShutdownRequested(node);
2110 });
2111 }
2112
2113 if (ShutdownRequested(node)) {
2114 return true;
2115 }
2116
2117 // ********************************************************* Step 12: start node
2118
2119 int64_t best_block_time{};
2120 {
2121 LOCK(chainman.GetMutex());
2122 const auto& tip{*Assert(chainman.ActiveTip())};
2123 LogInfo("block tree size = %u", chainman.BlockIndex().size());
2124 chain_active_height = tip.nHeight;
2125 best_block_time = tip.GetBlockTime();
2126 if (tip_info) {
2127 tip_info->block_height = chain_active_height;
2128 tip_info->block_time = best_block_time;
2129 tip_info->verification_progress = chainman.GuessVerificationProgress(&tip);
2130 }
2131 if (tip_info && chainman.m_best_header) {
2132 tip_info->header_height = chainman.m_best_header->nHeight;
2133 tip_info->header_time = chainman.m_best_header->GetBlockTime();
2134 }
2135 }
2136 LogInfo("nBestHeight = %d", chain_active_height);
2137 if (node.peerman) node.peerman->SetBestBlock(chain_active_height, std::chrono::seconds{best_block_time});
2138
2139 // Map ports with NAT-PMP
2141
2142 CConnman::Options connOptions;
2143 connOptions.m_local_services = g_local_services;
2144 connOptions.m_max_automatic_connections = nMaxConnections;
2145 connOptions.m_full_relay_inbound_percent = std::clamp<int>(args.GetIntArg("-inboundrelaypercent", DEFAULT_FULL_RELAY_INBOUND_PCT), 0, 100);
2146 connOptions.uiInterface = &uiInterface;
2147 connOptions.m_banman = node.banman.get();
2148 connOptions.m_msgproc = node.peerman.get();
2149 connOptions.nSendBufferMaxSize = 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
2150 connOptions.nReceiveFloodSize = 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
2151 for (const std::string& added_node : args.GetArgs("-addnode")) {
2152 // Such a value is not a valid connection target, but would otherwise be
2153 // treated as one and retried indefinitely.
2154 if (TrimStringView(added_node).empty()) {
2155 LogWarning("Ignoring empty -addnode value");
2156 continue;
2157 }
2158 connOptions.m_added_nodes.push_back(added_node);
2159 }
2160 connOptions.nMaxOutboundLimit = *opt_max_upload;
2161 connOptions.m_peer_connect_timeout = peer_connect_timeout;
2162 connOptions.whitelist_forcerelay = args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
2163 connOptions.whitelist_relay = args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
2164 connOptions.m_capture_messages = args.GetBoolArg("-capturemessages", false);
2165
2166 // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
2167 const uint16_t default_bind_port =
2168 static_cast<uint16_t>(args.GetIntArg("-port", Params().GetDefaultPort()));
2169
2170 const uint16_t default_bind_port_onion = default_bind_port + 1;
2171
2172 const auto BadPortWarning = [](const char* prefix, uint16_t port) {
2173 return strprintf(_("%s request to listen on port %u. This port is considered \"bad\" and "
2174 "thus it is unlikely that any peer will connect to it. See "
2175 "doc/p2p-bad-ports.md for details and a full list."),
2176 prefix,
2177 port);
2178 };
2179
2180 for (const std::string& bind_arg : args.GetArgs("-bind")) {
2181 std::optional<CService> bind_addr;
2182 const size_t index = bind_arg.rfind('=');
2183 if (index == std::string::npos) {
2184 bind_addr = Lookup(bind_arg, default_bind_port, /*fAllowLookup=*/false);
2185 if (bind_addr.has_value()) {
2186 connOptions.vBinds.push_back(bind_addr.value());
2187 if (IsBadPort(bind_addr.value().GetPort())) {
2188 InitWarning(BadPortWarning("-bind", bind_addr.value().GetPort()));
2189 }
2190 continue;
2191 }
2192 } else {
2193 const std::string network_type = bind_arg.substr(index + 1);
2194 if (network_type == "onion") {
2195 const std::string truncated_bind_arg = bind_arg.substr(0, index);
2196 bind_addr = Lookup(truncated_bind_arg, default_bind_port_onion, false);
2197 if (bind_addr.has_value()) {
2198 connOptions.onion_binds.push_back(bind_addr.value());
2199 continue;
2200 }
2201 }
2202 }
2203 return InitError(ResolveErrMsg("bind", bind_arg));
2204 }
2205
2206 for (const std::string& strBind : args.GetArgs("-whitebind")) {
2207 NetWhitebindPermissions whitebind;
2208 bilingual_str error;
2209 if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) return InitError(error);
2210 connOptions.vWhiteBinds.push_back(whitebind);
2211 }
2212
2213 // If the user did not specify -bind= or -whitebind= then we bind
2214 // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
2215 connOptions.bind_on_any = args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
2216
2217 // Emit a warning if a bad port is given to -port= but only if -bind and -whitebind are not
2218 // given, because if they are, then -port= is ignored.
2219 if (connOptions.bind_on_any && args.IsArgSet("-port")) {
2220 const uint16_t port_arg = args.GetIntArg("-port", 0);
2221 if (IsBadPort(port_arg)) {
2222 InitWarning(BadPortWarning("-port", port_arg));
2223 }
2224 }
2225
2226 CService onion_service_target;
2227 if (!connOptions.onion_binds.empty()) {
2228 onion_service_target = connOptions.onion_binds.front();
2229 } else if (!connOptions.vBinds.empty()) {
2230 onion_service_target = connOptions.vBinds.front();
2231 } else {
2232 onion_service_target = DefaultOnionServiceTarget(default_bind_port_onion);
2233 connOptions.onion_binds.push_back(onion_service_target);
2234 }
2235
2236 if (listenonion) {
2237 if (connOptions.onion_binds.size() > 1) {
2238 InitWarning(strprintf(_("More than one onion bind address is provided. Using %s "
2239 "for the automatically created Tor onion service."),
2240 onion_service_target.ToStringAddrPort()));
2241 }
2242 node.tor_controller = std::make_unique<TorController>(gArgs.GetArg("-torcontrol", DEFAULT_TOR_CONTROL), onion_service_target);
2243 }
2244
2245 bool should_discover = connOptions.bind_on_any;
2246 if (!should_discover) {
2247 for (const auto& bind : connOptions.vBinds) {
2248 if (bind.IsBindAny()) {
2249 should_discover = true;
2250 break;
2251 }
2252 }
2253 }
2254
2255 if (!should_discover) {
2256 for (const auto& whitebind : connOptions.vWhiteBinds) {
2257 if (whitebind.m_service.IsBindAny()) {
2258 should_discover = true;
2259 break;
2260 }
2261 }
2262 }
2263
2264 if (should_discover) {
2265 // Only add all IP addresses of the machine if we would be listening on
2266 // any address - 0.0.0.0 (IPv4) and :: (IPv6).
2267 Discover();
2268 }
2269
2270 for (const auto& net : args.GetArgs("-whitelist")) {
2272 ConnectionDirection connection_direction;
2273 bilingual_str error;
2274 if (!NetWhitelistPermissions::TryParse(net, subnet, connection_direction, error)) return InitError(error);
2275 if (connection_direction & ConnectionDirection::In) {
2276 connOptions.vWhitelistedRangeIncoming.push_back(subnet);
2277 }
2278 if (connection_direction & ConnectionDirection::Out) {
2279 connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
2280 }
2281 }
2282
2283 connOptions.vSeedNodes = args.GetArgs("-seednode");
2284
2285 const auto connect = args.GetArgs("-connect");
2286 if (!connect.empty() || args.IsArgNegated("-connect")) {
2287 // Do not initiate other outgoing connections when connecting to trusted
2288 // nodes, or when -noconnect is specified.
2289 connOptions.m_use_addrman_outgoing = false;
2290
2291 if (connect.size() != 1 || connect[0] != "0") {
2292 connOptions.m_specified_outgoing = connect;
2293 }
2294 if (!connOptions.m_specified_outgoing.empty() && !connOptions.vSeedNodes.empty()) {
2295 LogInfo("-seednode is ignored when -connect is used");
2296 }
2297
2298 if (args.IsArgSet("-dnsseed") && args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED) && args.IsArgSet("-proxy")) {
2299 LogInfo("-dnsseed is ignored when -connect is used and -proxy is specified");
2300 }
2301 }
2302
2303 const std::string& i2psam_arg = args.GetArg("-i2psam", "");
2304 if (!i2psam_arg.empty()) {
2305 const std::optional<CService> addr{Lookup(i2psam_arg, 7656, fNameLookup)};
2306 if (!addr.has_value() || !addr->IsValid()) {
2307 return InitError(strprintf(_("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
2308 }
2309 SetProxy(NET_I2P, Proxy{addr.value()});
2310 } else {
2311 if (!onlynets.empty() && g_reachable_nets.Contains(NET_I2P)) {
2312 return InitError(
2313 _("Outbound connections restricted to i2p (-onlynet=i2p) but "
2314 "-i2psam is not provided"));
2315 }
2317 }
2318
2319 connOptions.m_i2p_accept_incoming = args.GetBoolArg("-i2pacceptincoming", DEFAULT_I2P_ACCEPT_INCOMING);
2320
2321 if (auto conflict = CheckBindingConflicts(connOptions)) {
2322 return InitError(strprintf(
2323 _("Duplicate binding configuration for address %s. "
2324 "Please check your -bind, -bind=...=onion and -whitebind settings."),
2325 conflict->ToStringAddrPort()));
2326 }
2327
2328 if (args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)) {
2329 // If -listenonion is set, then NET_ONION may not be reachable now
2330 // but may become reachable later, thus only error here if it is not
2331 // reachable and will not become reachable for sure.
2332 const bool onion_may_become_reachable{listenonion && (!args.IsArgSet("-onlynet") || onlynet_used_with_onion)};
2335 !onion_may_become_reachable) {
2336 return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2337 "but none of Tor or I2P networks is reachable"));
2338 }
2339 if (!connOptions.m_use_addrman_outgoing) {
2340 return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2341 "but -connect is also configured. They are incompatible because the "
2342 "private broadcast needs to open new connections to randomly "
2343 "chosen Tor or I2P peers. Consider using -maxconnections=0 -addnode=... "
2344 "instead"));
2345 }
2346 if (!proxyRandomize && (g_reachable_nets.Contains(NET_ONION) || onion_may_become_reachable)) {
2347 InitWarning(_("Private broadcast of own transactions requested (-privatebroadcast) and "
2348 "-proxyrandomize is disabled. Tor circuits for private broadcast connections "
2349 "may be correlated to other connections over Tor. For maximum privacy set "
2350 "-proxyrandomize=1."));
2351 }
2352 }
2353
2354 if (!node.connman->Start(scheduler, connOptions)) {
2355 return false;
2356 }
2357
2358 // ********************************************************* Step 13: finished
2359
2360 // At this point, the RPC is "started", but still in warmup, which means it
2361 // cannot yet be called. Before we make it callable, we need to make sure
2362 // that the RPC's view of the best block is valid and consistent with
2363 // ChainstateManager's active tip.
2365
2366 uiInterface.InitMessage(_("Done loading"));
2367
2368 for (const auto& client : node.chain_clients) {
2369 client->start(scheduler);
2370 }
2371
2372 BanMan* banman = node.banman.get();
2373 scheduler.scheduleEvery([banman]{
2374 banman->DumpBanlist();
2376
2377 if (node.peerman) node.peerman->StartScheduledTasks(scheduler);
2378
2379#if HAVE_SYSTEM
2380 StartupNotify(args);
2381#endif
2382
2383 return true;
2384}
2385
2387{
2388 ChainstateManager& chainman = *Assert(node.chainman);
2389 const Chainstate& chainstate = WITH_LOCK(::cs_main, return chainman.ValidatedChainstate());
2390 const CChain& index_chain = chainstate.m_chain;
2391 const int current_height = WITH_LOCK(::cs_main, return index_chain.Height());
2392
2393 // Skip checking data availability if we have not synced any blocks yet
2394 if (current_height > 0) {
2395 // Before starting index sync, verify that all required block data is available
2396 // on disk from each index's current sync position up to the chain tip.
2397 //
2398 // This is done separately for undo and block data: First we verify block + undo
2399 // data existence from tip down to the lowest height required by any index that
2400 // needs undo data (e.g., coinstatsindex, blockfilterindex). Then, if any
2401 // block-only index needs to sync from a lower height than previously covered,
2402 // verify block data existence down to that lower height.
2403 //
2404 // This avoids checking undo data for blocks where no index requires it,
2405 // though currently block and undo data availability are synchronized on disk
2406 // under normal circumstances.
2407 std::optional<const CBlockIndex*> block_start;
2408 std::string block_start_name;
2409 std::optional<const CBlockIndex*> undo_start;
2410 std::string undo_start_name;
2411
2412 for (const auto& index : node.indexes) {
2413 const IndexSummary& summary = index->GetSummary();
2414 if (summary.synced) continue;
2415
2416 // Get the last common block between the index best block and the active chain
2417 const CBlockIndex* pindex = nullptr;
2418 {
2419 LOCK(::cs_main);
2420 pindex = chainman.m_blockman.LookupBlockIndex(summary.best_block_hash);
2421 if (!pindex) {
2422 LogWarning("Failed to find block manager entry for best block %s from %s, falling back to genesis for index sync",
2423 summary.best_block_hash.ToString(), summary.name);
2424 } else if (!index_chain.Contains(*pindex)) {
2425 pindex = index_chain.FindFork(*pindex);
2426 }
2427 }
2428 if (!pindex) {
2429 pindex = index_chain.Genesis();
2430 }
2431
2432 bool need_undo = index->CustomOptions().connect_undo_data;
2433 auto& op_start_index = need_undo ? undo_start : block_start;
2434 auto& name_index = need_undo ? undo_start_name : block_start_name;
2435
2436 if (op_start_index && pindex->nHeight >= op_start_index.value()->nHeight) continue;
2437 op_start_index = pindex;
2438 name_index = summary.name;
2439 }
2440
2441 // Verify all blocks needed to sync to current tip are present including undo data.
2442 if (undo_start) {
2443 LOCK(::cs_main);
2444 if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(undo_start.value()), BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO})) {
2445 return InitError(Untranslated(strprintf("%s best block of the index goes beyond pruned data (including undo data). Please disable the index or reindex (which will download the whole blockchain again)", undo_start_name)));
2446 }
2447 }
2448
2449 // Verify all blocks needed to sync to current tip are present unless we already checked all of them above.
2450 if (block_start && !(undo_start && undo_start.value()->nHeight <= block_start.value()->nHeight)) {
2451 LOCK(::cs_main);
2452 if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(block_start.value()), BlockStatus{BLOCK_HAVE_DATA})) {
2453 return InitError(Untranslated(strprintf("%s best block of the index goes beyond pruned data. Please disable the index or reindex (which will download the whole blockchain again)", block_start_name)));
2454 }
2455 }
2456 }
2457
2458 // Start threads
2459 for (auto index : node.indexes) if (!index->StartBackgroundSync()) return false;
2460 return true;
2461}
util::Result< std::unique_ptr< AddrMan > > LoadAddrman(const NetGroupManager &netgroupman, const ArgsManager &args)
Returns an error string on failure.
Definition: addrdb.cpp:196
constexpr int32_t DEFAULT_ADDRMAN_CONSISTENCY_CHECKS
Default for -checkaddrman.
Definition: addrman.h:56
const std::vector< std::string > TEST_OPTIONS_DOC
Definition: args.cpp:845
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: args.cpp:817
const char *const BITCOIN_SETTINGS_FILENAME
Definition: args.cpp:36
ArgsManager gArgs
Definition: args.cpp:38
bool HasTestOption(const ArgsManager &args, const std::string &test_option)
Checks if a particular test option is present in -test command-line arg options.
Definition: args.cpp:851
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:35
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: config.cpp:237
constexpr unsigned int DEFAULT_MISBEHAVING_BANTIME
Definition: banman.h:19
constexpr std::chrono::minutes DUMP_BANS_INTERVAL
How often to dump banned addresses/subnets to disk.
Definition: banman.h:22
void ScheduleBatchPriority()
On platforms that support it, tell the kernel the calling thread is CPU-intensive and non-interactive...
int ret
const auto cmd
int exit_status
const auto command
ArgsManager & args
Definition: bitcoind.cpp:280
constexpr bool DEFAULT_ACCEPT_STALE_FEE_ESTIMATES
constexpr std::chrono::hours MAX_FILE_AGE
Block policy estimate files that are more than 60 hours (2.5 days) old will not be read,...
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.
bool BlockFilterTypeByName(std::string_view name, BlockFilterType &filter_type)
Find a filter type by its human-readable name.
const std::string & ListBlockFilterTypes()
Get a comma-separated list of known filter type names.
BlockFilterType
Definition: blockfilter.h:94
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
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.
constexpr const char * DEFAULT_BLOCKFILTERINDEX
BlockStatus
Definition: chain.h:42
std::unique_ptr< const CChainParams > CreateChainParams(const ArgsManager &args, const ChainType chain)
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain.
const CChainParams & Params()
Return the currently selected parameters.
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const ChainType chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 48334, 18445) have been chosen arbitra...
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
constexpr int DEFAULT_SCRIPTCHECK_THREADS
-par default (number of script-checking threads, 0 = auto)
constexpr int32_t DEFAULT_PREVOUTFETCH_THREADS
constexpr auto DEFAULT_MAX_TIP_AGE
std::string ChainTypeToString(ChainType chain)
Definition: chaintype.cpp:12
ChainType
Definition: chaintype.h:12
#define Assert(val)
Identity function.
Definition: check.h:116
std::vector< std::string > GetArgs(const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return a vector of strings of the given argument.
Definition: args.cpp:422
ChainType GetChainType() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Returns the appropriate chain type from the program arguments.
Definition: args.cpp:910
@ NETWORK_ONLY
Definition: args.h:128
@ ALLOW_ANY
disable validation
Definition: args.h:114
@ DISALLOW_NEGATION
disallow -nofoo syntax
Definition: args.h:119
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition: args.h:120
@ DEBUG_ONLY
Definition: args.h:122
@ SENSITIVE
Definition: args.h:130
std::list< SectionInfo > GetUnrecognizedSections() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Log warnings for unrecognized section names in the config file.
Definition: args.cpp:152
fs::path GetBlocksDirPath() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get blocks directory path.
Definition: args.cpp:298
bool SoftSetArg(const std::string &strArg, const std::string &strValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Set an argument if it doesn't already have a value.
Definition: args.cpp:611
std::set< std::string > GetUnsuitableSectionOnlyArgs() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Log warnings for options in m_section_only_args when they are specified in the default section but no...
Definition: args.cpp:132
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Add argument.
Definition: args.cpp:657
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return path argument or default value.
Definition: args.cpp:292
std::string GetArg(const std::string &strArg, const std::string &strDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return string argument or default value.
Definition: args.cpp:517
void AddHiddenArgs(const std::vector< std::string > &args) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Add many hidden arguments.
Definition: args.cpp:686
bool IsArgSet(const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return true if the given argument has been manually set.
Definition: args.cpp:431
bool SoftSetBoolArg(const std::string &strArg, bool fValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:619
fs::path GetDataDirNet() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get data directory path with appended network identifier.
Definition: args.cpp:328
bool IsArgNegated(const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return true if the argument was originally passed as a negated option, i.e.
Definition: args.cpp:512
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Definition: args.h:323
bool GetBoolArg(const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return boolean argument or default value.
Definition: args.cpp:571
static std::shared_ptr< LogRateLimiter > Create(SchedulerFunction &&scheduler_func, uint64_t max_bytes, std::chrono::seconds reset_window)
Definition: logging.cpp:387
void SetRateLimiting(std::shared_ptr< LogRateLimiter > limiter) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Definition: logging.h:216
std::atomic< bool > m_reopen_file
Definition: logging.h:178
Definition: banman.h:64
void DumpBanlist() EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Definition: banman.cpp:48
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:94
uint256 GetBlockHash() const
Definition: chain.h:198
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:106
An in-memory indexed chain of blocks.
Definition: chain.h:380
bool Contains(const CBlockIndex &index) const
Efficiently check whether a block is present in this chain.
Definition: chain.h:410
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:396
const CBlockIndex * FindFork(const CBlockIndex &index) const
Find the last common block between this chain and a block index entry.
Definition: chain.cpp:50
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:390
int Height() const
Return the maximal height in the chain.
Definition: chain.h:425
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:77
const MessageStartChars & MessageStart() const
Definition: chainparams.h:90
bool DefaultConsistencyChecks() const
Default value for -checkmempool and -checkblockindex argument.
Definition: chainparams.h:96
ChainType GetChainType() const
Return the chain type.
Definition: chainparams.h:111
btcsignals::signal< void(const std::string &message)> InitMessage
Progress message during initialization.
Definition: interface_ui.h:74
btcsignals::signal< bool(const bilingual_str &message, const std::string &noninteractive_message, unsigned int style), btcsignals::any_of > ThreadSafeQuestion
If possible, ask the user a question.
Definition: interface_ui.h:71
btcsignals::signal< void()> InitWallet
Wallet loader created.
Definition: interface_ui.h:77
btcsignals::signal< void(const bilingual_str &message, unsigned int style)> ThreadSafeMessageBox
Show message box.
Definition: interface_ui.h:68
btcsignals::signal< void(SynchronizationState, const CBlockIndex &block, double verification_progress)> NotifyBlockTip
New block has been accepted.
Definition: interface_ui.h:97
bool IsBindAny() const
Definition: netaddress.cpp:303
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:530
std::string ToStringAddrPort() const
Definition: netaddress.cpp:903
static constexpr int DEFAULT_ZMQ_SNDHWM
static std::unique_ptr< CZMQNotificationInterface > Create(std::function< bool(std::vector< std::byte > &, 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:554
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:628
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition: validation.h:945
Chainstate * HistoricalChainstate() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return historical chainstate targeting a specific block, if any.
Definition: validation.h:1136
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:1191
double GuessVerificationProgress(const CBlockIndex *pindex) const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Guess verification progress (as a fraction between 0.0=genesis and 1.0=current tip).
kernel::Notifications & GetNotifications() const
Definition: validation.h:1017
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:1037
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1175
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1039
Chainstate & ValidatedChainstate() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return fully validated chainstate that should be used for indexing, to support indexes that need to i...
Definition: validation.h:1147
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
Definition: validation.h:1010
void UpdateIBDStatus() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Update and possibly latch the IBD status.
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1173
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1043
Fast randomness source.
Definition: random.h:386
uint64_t rand64() noexcept
Generate a random 64-bit integer.
Definition: random.h:404
Manages fee rate estimators.
Definition: estimator_man.h:31
void IntervalFlush()
Flush recorded data to disk.
static NetGroupManager NoAsmap()
Definition: netgroup.h:32
static NetGroupManager WithEmbeddedAsmap(std::span< const std::byte > asmap)
Definition: netgroup.h:24
static NetGroupManager WithLoadedAsmap(std::vector< std::byte > &&asmap)
Definition: netgroup.h:28
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, node::Warnings &warnings, Options opts)
Definition: netbase.h:61
bool IsValid() const
Definition: netbase.h:73
void Add(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:106
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:134
void Remove(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:113
void RemoveAll() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:120
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.
std::string ToString() const
Definition: uint256.cpp:21
std::string GetHex() const
Definition: uint256.cpp:11
connection connect(Callable &&func) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: btcsignals.h:236
Interface providing access to interprocess-communication (IPC) functionality.
Definition: ipc.h:51
Exception class thrown when a call to remote method fails due to an IPC error, like a socket getting ...
Definition: exception.h:14
A base class defining functions for notifying about certain kernel events.
virtual void fatalError(const bilingual_str &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:196
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
CBlockFileInfo *GetBlockFileInfo(size_t n) EXCLUSIVE_LOCKS_REQUIRED(bool WriteBlockUndo(const CBlockUndo &blockundo, BlockValidationState &state, CBlockIndex &block) EXCLUSIVE_LOCKS_REQUIRED(FlatFilePos WriteBlock(const CBlock &block, int nHeight) EXCLUSIVE_LOCKS_REQUIRED(void UpdateBlockInfo(const CBlock &block, unsigned int nHeight, const FlatFilePos &pos) EXCLUSIVE_LOCKS_REQUIRED(bool IsPruneMode() const
Get block file info entry for one block file.
Definition: blockstorage.h:407
std::atomic_bool m_blockfiles_indexed
Whether all blockfiles have been added to the block tree database.
Definition: blockstorage.h:333
uint64_t GetPruneTarget() const
Attempt to stay below this number of bytes of block files.
Definition: blockstorage.h:410
uint64_t CalculateCurrentUsage() EXCLUSIVE_LOCKS_REQUIRED(bool CheckBlockDataAvailability(const CBlockIndex &upper_block, const CBlockIndex &lower_block, BlockStatus block_status=BLOCK_HAVE_DATA) EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex &GetFirstBlock(const CBlockIndex &upper_block LIFETIMEBOUND, uint32_t status_mask, const CBlockIndex *lower_block LIFETIMEBOUND=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(boo m_have_pruned)
Calculate the amount of disk space the block & undo files currently use.
Definition: blockstorage.h:453
256-bit opaque blob.
Definition: uint256.h:196
std::string FormatSubVersion(const std::string &name, int nClientVersion, const std::vector< std::string > &comments)
Format the subversion field according to BIP 14 spec (https://github.com/bitcoin/bips/blob/master/bip...
const std::string UA_NAME
constexpr int CLIENT_VERSION
Definition: clientversion.h:26
uint32_t current_height
Current height in the simulation.
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
constexpr bool DEFAULT_COINSTATSINDEX
bool SetupNetworking()
Definition: system.cpp:91
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
fs::path MempoolPolicyEstimatorPath(const ArgsManager &argsman)
void MaybeMigrateLegacyFeeEstimates(const ArgsManager &argsman)
Move a legacy fee_estimates.dat file to the current block policy fee estimator path,...
fs::path BlockPolicyFeeEstPath(const ArgsManager &argsman)
constexpr std::chrono::hours FEE_FLUSH_INTERVAL
Definition: estimator_man.h:25
const std::string CURRENCY_UNIT
Definition: feerate.h:19
static auto quoted(const std::string &s)
Definition: fs.h:106
static bool exists(const path &p)
Definition: fs.h:96
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:162
int RaiseFileDescriptorLimit(int min_fd)
Try to raise the file descriptor limit to the requested number.
Definition: fs_helpers.cpp:159
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: fs_helpers.cpp:93
std::string HexStr(const std::span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
Definition: hex_base.cpp:30
void InterruptHTTPRPC()
Interrupt HTTP RPC subsystem.
Definition: httprpc.cpp:354
void StopHTTPRPC()
Stop HTTP RPC subsystem.
Definition: httprpc.cpp:359
bool StartHTTPRPC(const std::any &context)
Start HTTP RPC subsystem.
Definition: httprpc.cpp:340
void StartREST(const std::any &context)
Start HTTP REST subsystem.
Definition: rest.cpp:1199
void StopREST()
Stop HTTP REST subsystem.
Definition: rest.cpp:1211
void InterruptREST()
Interrupt RPC REST subsystem.
Definition: rest.cpp:1207
constexpr int DEFAULT_HTTP_SERVER_TIMEOUT
Definition: httpserver.h:42
constexpr int DEFAULT_HTTP_THREADS
The default value for -rpcthreads.
Definition: httpserver.h:34
constexpr int DEFAULT_HTTP_WORKQUEUE
The default value for -rpcworkqueue.
Definition: httpserver.h:40
Common init functions shared by bitcoin-node, bitcoin-wallet, etc.
static bool LockDirectory(const fs::path &dir, bool probeOnly)
Definition: init.cpp:1189
static const char * BITCOIN_PID_FILENAME
The PID file facilities.
Definition: init.cpp:195
static bool CreatePidFile(const ArgsManager &args)
Definition: init.cpp:207
static bool g_generated_pid
True if this process has created a PID file.
Definition: init.cpp:200
static std::optional< util::SignalInterrupt > g_shutdown
Definition: init.cpp:235
static void RemovePidFile(const ArgsManager &args)
Definition: init.cpp:225
void Interrupt(NodeContext &node)
Interrupt threads.
Definition: init.cpp:292
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:892
static bool AppInitServers(NodeContext &node)
Definition: init.cpp:787
static bool LockDirectories(bool probeOnly)
Definition: init.cpp:1201
static constexpr int MIN_CORE_FDS
Definition: init.cpp:190
void Shutdown(NodeContext &node)
Definition: init.cpp:314
static void HandleSIGTERM(int)
Signal handlers are very limited in what they are allowed to do.
Definition: init.cpp:454
static void HandleSIGHUP(int)
Definition: init.cpp:461
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin core: Basic context setup.
Definition: init.cpp:921
static fs::path GetPidFile(const ArgsManager &args)
Definition: init.cpp:202
static constexpr bool DEFAULT_PROXYRANDOMIZE
Definition: init.cpp:176
bool CheckHostPortOptions(const ArgsManager &args)
Definition: init.cpp:1247
static std::optional< CService > CheckBindingConflicts(const CConnman::Options &conn_options)
Checks for duplicate bindings across all binding configurations.
Definition: init.cpp:1302
static ChainstateLoadResult InitAndLoadChainstate(NodeContext &node, bool do_reindex, const bool do_reindex_chainstate, const kernel::CacheSizes &cache_sizes, const ArgsManager &args)
Definition: init.cpp:1332
bool ShutdownRequested(node::NodeContext &node)
Return whether node shutdown was requested.
Definition: init.cpp:274
bool StartIndexBackgroundSync(NodeContext &node)
Validates requirements to run the indexes and spawns each index initial sync thread.
Definition: init.cpp:2386
bool AppInitParameterInteraction(const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:958
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:1238
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT
Definition: init.cpp:179
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:803
static constexpr bool DEFAULT_REST_ENABLE
Definition: init.cpp:177
#define MIN_LEVELDB_FDS
Definition: init.cpp:187
static void registerSignalHandler(int signal, void(*handler)(int))
Definition: init.cpp:478
bool AppInitMain(NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin core main initialization.
Definition: init.cpp:1455
static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING
Definition: init.cpp:178
bool AppInitLockDirectories()
Lock bitcoin core critical directories.
Definition: init.cpp:1226
void SetupServerArgs(ArgsManager &argsman, bool can_listen_ipc)
Register all arguments with the ArgsManager.
Definition: init.cpp:488
void InitContext(NodeContext &node)
Initialize node context shutdown and args variables.
Definition: init.cpp:237
static void new_handler_terminate()
Definition: init.cpp:908
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:1207
constexpr bool DEFAULT_DAEMON
Default value for -daemon option.
Definition: init.h:12
constexpr bool DEFAULT_DAEMONWAIT
Default value for -daemonwait option.
Definition: init.h:14
CClientUIInterface uiInterface
void InitWarning(const bilingual_str &str)
Show warning message.
bool InitError(const bilingual_str &str)
Show error message.
constexpr uint64_t DEFAULT_DB_CACHE_BATCH
Default LevelDB write batch size.
Definition: caches.h:21
constexpr uint64_t MIN_DBCACHE_BYTES
Minimum total database cache (bytes)
Definition: caches.h:15
bool ECC_InitSanityCheck()
Check that required EC support is available at runtime.
Definition: key.cpp:456
std::unique_ptr< ProxyClient< messages::FooInterface > > client
std::thread thread
Thread variable should be after other struct members so the thread does not start until the other mem...
#define LogWarning(...)
Definition: log.h:126
#define LogInfo(...)
Definition: log.h:125
#define LogError(...)
Definition: log.h:127
#define LogDebug(category,...)
Definition: log.h:143
BCLog::Logger & LogInstance()
Definition: logging.cpp:26
void StopMapPort()
Definition: mapport.cpp:155
void InterruptMapPort()
Definition: mapport.cpp:148
void StartMapPort(bool enable)
Definition: mapport.cpp:138
constexpr bool DEFAULT_NATPMP
Definition: mapport.h:8
constexpr unsigned int DEFAULT_MAX_MEMPOOL_SIZE_MB
Default for -maxmempool, maximum megabytes of mempool memory usage.
constexpr bool DEFAULT_ACCEPT_NON_STD_TXN
Default for -acceptnonstdtxn.
constexpr unsigned int DEFAULT_MEMPOOL_EXPIRY_HOURS
Default for -mempoolexpiry, expiration time for mempool transactions in hours.
constexpr unsigned int DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB
Default for -maxmempool when blocksonly is set.
constexpr bool DEFAULT_PERSIST_V1_DAT
Whether to fall back to legacy V1 serialization when writing mempool.dat.
is a home for simple string functions returning descriptive messages that are used in RPC and GUI int...
is used externally by mining IPC clients, so it should only declare simple data definitions.
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:19
constexpr auto RATELIMIT_WINDOW
Definition: logging.h:67
constexpr bool DEFAULT_LOGRATELIMIT
Definition: logging.h:68
constexpr uint64_t RATELIMIT_MAX_BYTES
Definition: logging.h:66
@ IPC
Definition: categories.h:38
bilingual_str ResolveErrMsg(const std::string &optname, const std::string &strBind)
Definition: messages.cpp:143
bilingual_str InvalidPortErrMsg(const std::string &optname, const std::string &invalid_value)
Definition: messages.cpp:148
void StartHTTPServer()
Start HTTP server.
void StopHTTPServer()
Stop HTTP server.
void InterruptHTTPServer()
Interrupt HTTP server threads.
bool InitHTTPServer()
Initialize HTTP server.
void AddLoggingArgs(ArgsManager &argsman)
Definition: common.cpp:27
util::Result< void > SetLoggingCategories(const ArgsManager &args)
Definition: common.cpp:79
bool StartLogging(const ArgsManager &args)
Definition: common.cpp:107
util::Result< void > SetLoggingLevel(const ArgsManager &args)
Definition: common.cpp:60
void SetLoggingOptions(const ArgsManager &args)
Definition: common.cpp:46
void LogPackageVersion()
Definition: common.cpp:148
std::unique_ptr< Mining > MakeMining(const node::NodeContext &node, bool wait_loaded=true)
Return implementation of Mining interface.
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
Definition: ipc.h:13
constexpr bool DEFAULT_XOR_BLOCKSDIR
util::Result< void > SanityChecks(const Context &)
Ensure a usable environment with all necessary library support.
Definition: checks.cpp:15
Definition: messages.h:21
ChainstateLoadStatus
Chainstate load status.
Definition: chainstate.h:44
@ FAILURE
Generic failure which reindexing may fix.
std::tuple< ChainstateLoadStatus, bilingual_str > ChainstateLoadResult
Chainstate load status code and optional error string.
Definition: chainstate.h:54
CacheSizes CalculateCacheSizes(const ArgsManager &args, size_t n_indexes)
Definition: caches.cpp:57
fs::path MempoolPath(const ArgsManager &argsman)
void LogOversizedDbCache(const ArgsManager &args) noexcept
Definition: caches.cpp:85
util::Result< void > ApplyArgsManOptions(const ArgsManager &args, BlockManager::Options &opts)
Result< BlockCreateOptions > ReadMiningArgs(const ArgsManager &args)
Read the mining options set in args.
Definition: mining_args.cpp:63
bool ShouldPersistMempool(const ArgsManager &argsman)
void ReadNotificationArgs(const ArgsManager &args, KernelNotifications &notifications)
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:151
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:240
bool LoadMempool(CTxMemPool &pool, const fs::path &load_path, Chainstate &active_chainstate, ImportMempoolOptions &&opts)
Import the file and attempt to add its contents to the mempool.
constexpr bool DEFAULT_PERSIST_MEMPOOL
Default for -persistmempool, indicating whether the node should attempt to automatically load the mem...
constexpr int DEFAULT_STOPATHEIGHT
uint64_t GetDefaultDBCache()
Definition: caches.cpp:37
constexpr bool DEFAULT_PRINT_MODIFIED_FEE
Definition: mining_args.h:15
void ImportBlocks(ChainstateManager &chainman, std::span< const fs::path > import_paths)
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
void format(std::ostream &out, FormatStringCheck< sizeof...(Args)> fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1079
void ThreadRename(const std::string &)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name.
Definition: threadnames.cpp:64
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
std::string_view TrimStringView(std::string_view str, std::string_view pattern=" \f\n\r\t\v")
Definition: string.h:162
void TraceThread(std::string_view thread_name, std::function< void()> thread_func)
A wrapper for do-something-once thread functions.
Definition: thread.cpp:15
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:249
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:208
void ReplaceAll(std::string &in_out, const std::string &search, const std::string &substitute)
Definition: string.cpp:14
LockResult LockDirectory(const fs::path &directory, const fs::path &lockfile_name, bool probe_only)
Definition: fs_helpers.cpp:53
uint16_t GetListenPort()
Definition: net.cpp:139
bool fDiscover
Definition: net.cpp:117
bool fListen
Definition: net.cpp:118
std::string strSubVersion
Subversion as sent to the P2P network in version messages.
Definition: net.cpp:121
bool AddLocal(const CService &addr_, int nScore, bool add_even_if_unreachable)
Definition: net.cpp:278
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:3440
constexpr bool DEFAULT_LISTEN
-listen default
Definition: net.h:79
constexpr bool DEFAULT_PRIVATE_BROADCAST
Default for -privatebroadcast.
Definition: net.h:91
constexpr unsigned int MAX_SUBVERSION_LENGTH
Maximum length of the user agent string in version message.
Definition: net.h:67
constexpr int MAX_FEELER_CONNECTIONS
Maximum number of feeler connections.
Definition: net.h:75
constexpr bool DEFAULT_BLOCKSONLY
Default for blocks only.
Definition: net.h:87
constexpr int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:71
constexpr size_t DEFAULT_MAXSENDBUFFER
Definition: net.h:101
constexpr bool DEFAULT_FIXEDSEEDS
Definition: net.h:99
constexpr unsigned int DEFAULT_MAX_PEER_CONNECTIONS
The maximum number of peer connections to maintain.
Definition: net.h:81
constexpr int64_t DEFAULT_PEER_CONNECT_TIMEOUT
-peertimeout default
Definition: net.h:89
constexpr size_t DEFAULT_MAXRECEIVEBUFFER
Definition: net.h:100
const std::string DEFAULT_MAX_UPLOAD_TARGET
The default for -maxuploadtarget.
Definition: net.h:85
constexpr bool DEFAULT_FORCEDNSSEED
Definition: net.h:97
constexpr size_t MAX_PRIVATE_BROADCAST_CONNECTIONS
Maximum number of private broadcast connections.
Definition: net.h:77
constexpr bool DEFAULT_DNSSEED
Definition: net.h:98
constexpr int MAX_BLOCK_RELAY_ONLY_CONNECTIONS
Maximum number of block-relay-only outgoing connections.
Definition: net.h:73
constexpr int NUM_FDS_MESSAGE_CAPTURE
Number of file descriptors required for message capture.
Definition: net.h:93
constexpr int DEFAULT_FULL_RELAY_INBOUND_PCT
Default percentage of inbound connection slots that tx-relaying peers can use.
Definition: net.h:83
@ LOCAL_MANUAL
Definition: net.h:160
constexpr bool DEFAULT_V2_TRANSPORT
Definition: net.h:103
constexpr int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS
Maximum number of automatic outgoing nodes over which we'll relay everything (blocks,...
Definition: net.h:69
const std::vector< std::string > NET_PERMISSIONS_DOC
constexpr bool DEFAULT_WHITELISTFORCERELAY
Default for -whitelistforcerelay.
constexpr bool DEFAULT_WHITELISTRELAY
Default for -whitelistrelay.
constexpr unsigned int DEFAULT_TX_SEND_RATE
Default maximum per-second rate for sending transaction inventory to peers.
constexpr bool DEFAULT_PEERBLOOMFILTERS
constexpr bool DEFAULT_TXRECONCILIATION_ENABLE
Whether transaction reconciliation protocol should be enabled by default.
constexpr bool DEFAULT_PEERBLOCKFILTERS
constexpr uint32_t DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN
Default number of non-mempool transactions to keep around for block reconstruction.
Network
A network type.
Definition: netaddress.h:33
@ NET_I2P
I2P.
Definition: netaddress.h:47
@ NET_CJDNS
CJDNS.
Definition: netaddress.h:50
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:44
@ NET_IPV6
IPv6.
Definition: netaddress.h:41
@ NET_IPV4
IPv4.
Definition: netaddress.h:38
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:35
bool SetNameProxy(const Proxy &addrProxy)
Set the name proxy to use for all connections to nodes specified by a hostname.
Definition: netbase.cpp:736
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:100
bool SetProxy(enum Network net, const Proxy &addrProxy)
Definition: netbase.cpp:717
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:191
ReachableNets g_reachable_nets
Definition: netbase.cpp:43
bool fNameLookup
Definition: netbase.cpp:37
int nConnectTimeout
Definition: netbase.cpp:36
bool IsUnixSocketPath(const std::string &name)
Check if a string is a valid UNIX domain socket path.
Definition: netbase.cpp:226
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:866
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:130
ConnectionDirection
Definition: netbase.h:35
constexpr int DEFAULT_CONNECT_TIMEOUT
-timeout default
Definition: netbase.h:28
const std::string ADDR_PREFIX_UNIX
Prefix for unix domain socket addresses (which are local filesystem paths)
Definition: netbase.h:33
constexpr int DEFAULT_NAME_LOOKUP
-dns default
Definition: netbase.h:30
unsigned int nBytesPerSigOp
Definition: settings.cpp:10
constexpr unsigned int DEFAULT_BLOCK_MIN_TX_FEE
Default for -blockmintxfee, which sets the minimum feerate for a transaction in blocks created by min...
Definition: policy.h:36
constexpr unsigned int MAX_OP_RETURN_RELAY
Default setting for -datacarriersize in vbytes.
Definition: policy.h:84
constexpr unsigned int DEFAULT_INCREMENTAL_RELAY_FEE
Default for -incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or rep...
Definition: policy.h:48
constexpr bool DEFAULT_PERMIT_BAREMULTISIG
Default for -permitbaremultisig.
Definition: policy.h:52
constexpr unsigned int DUST_RELAY_TX_FEE
Min feerate for defining dust.
Definition: policy.h:68
constexpr bool DEFAULT_ACCEPT_DATACARRIER
Default for -datacarrier.
Definition: policy.h:80
constexpr unsigned int DEFAULT_DESCENDANT_LIMIT
Default for -limitdescendantcount, max number of in-mempool descendants.
Definition: policy.h:78
constexpr unsigned int DEFAULT_BYTES_PER_SIGOP
Default for -bytespersigop.
Definition: policy.h:50
constexpr unsigned int DEFAULT_BLOCK_MAX_WEIGHT
Default for -blockmaxweight, which controls the range of block weights the mining code will create.
Definition: policy.h:25
constexpr unsigned int DEFAULT_CLUSTER_SIZE_LIMIT_KVB
Maximum size of cluster in virtual kilobytes.
Definition: policy.h:74
constexpr unsigned int DEFAULT_BLOCK_RESERVED_WEIGHT
Default for -blockreservedweight.
Definition: policy.h:27
constexpr unsigned int DEFAULT_ANCESTOR_LIMIT
Default for -limitancestorcount, max number of in-mempool ancestors.
Definition: policy.h:76
constexpr unsigned int DEFAULT_CLUSTER_LIMIT
Maximum number of transactions per cluster (default)
Definition: policy.h:72
constexpr unsigned int DEFAULT_MIN_RELAY_TX_FEE
Default for -minrelaytxfee, minimum relay fee for transactions.
Definition: policy.h:70
ServiceFlags
nServices flags
Definition: protocol.h:321
@ NODE_P2P_V2
Definition: protocol.h:342
@ NODE_WITNESS
Definition: protocol.h:332
@ NODE_NETWORK_LIMITED
Definition: protocol.h:339
@ NODE_BLOOM
Definition: protocol.h:329
@ NODE_NETWORK
Definition: protocol.h:327
@ NODE_COMPACT_FILTERS
Definition: protocol.h:335
void RandAddPeriodic() noexcept
Gather entropy from various expensive sources, and feed them to the PRNG state.
Definition: random.cpp:612
static void RegisterAllCoreRPCCommands(CRPCTable &t)
Definition: register.h:26
const char * prefix
Definition: rest.cpp:1180
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:1181
const char * name
Definition: rest.cpp:56
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:44
constexpr bool DEFAULT_RPC_DOC_CHECK
Definition: util.h:46
void SetRPCWarmupFinished()
Definition: server.cpp:696
void StartRPC()
Definition: server.cpp:645
void StopRPC()
Definition: server.cpp:662
void InterruptRPC()
Definition: server.cpp:651
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
Definition: server.cpp:684
CRPCTable tableRPC
Definition: server.cpp:998
void RpcInterruptionPoint()
Throw JSONRPCError if RPC is not running.
Definition: server.cpp:679
constexpr size_t DEFAULT_VALIDATION_CACHE_BYTES
Definition: sigcache.h:31
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
Definition: strencodings.h:34
unsigned int nReceiveFloodSize
Definition: net.h:1097
int m_full_relay_inbound_percent
Definition: net.h:1092
std::vector< NetWhitebindPermissions > vWhiteBinds
Definition: net.h:1103
uint64_t nMaxOutboundLimit
Definition: net.h:1098
CClientUIInterface * uiInterface
Definition: net.h:1093
std::vector< NetWhitelistPermissions > vWhitelistedRangeIncoming
Definition: net.h:1101
std::vector< CService > onion_binds
Definition: net.h:1105
std::vector< std::string > m_specified_outgoing
Definition: net.h:1110
bool whitelist_relay
Definition: net.h:1114
NetEventsInterface * m_msgproc
Definition: net.h:1094
std::vector< std::string > m_added_nodes
Definition: net.h:1111
int64_t m_peer_connect_timeout
Definition: net.h:1099
std::vector< CService > vBinds
Definition: net.h:1104
bool m_capture_messages
Definition: net.h:1115
unsigned int nSendBufferMaxSize
Definition: net.h:1096
int m_max_automatic_connections
Definition: net.h:1091
ServiceFlags m_local_services
Definition: net.h:1090
bool m_i2p_accept_incoming
Definition: net.h:1112
std::vector< std::string > vSeedNodes
Definition: net.h:1100
BanMan * m_banman
Definition: net.h:1095
bool m_use_addrman_outgoing
Definition: net.h:1109
bool whitelist_forcerelay
Definition: net.h:1113
bool bind_on_any
True if the user did not specify -bind= or -whitebind= and thus we should bind on 0....
Definition: net.h:1108
std::vector< NetWhitelistPermissions > vWhitelistedRangeOutgoing
Definition: net.h:1102
Application-specific storage settings.
Definition: dbwrapper.h:41
fs::path path
Location in the filesystem where leveldb data will be stored.
Definition: dbwrapper.h:43
std::string name
Definition: base.h:31
bool synced
Definition: base.h:32
uint256 best_block_hash
Definition: base.h:34
Bilingual messages:
Definition: translation.h:24
bool empty() const
Definition: translation.h:35
Block and header tip information.
Definition: node.h:51
uint64_t block_tree_db
Definition: caches.h:30
uint64_t coins
Definition: caches.h:32
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:16
Options struct containing options for constructing a CTxMemPool.
bool require_full_verification
Setting require_full_verification to true will require all checks at check_level (below) to succeed f...
Definition: chainstate.h:34
std::function< void()> coins_error_cb
Definition: chainstate.h:37
NodeContext struct containing references to chain state and connection state.
Definition: context.h:59
#define WAIT_LOCK(cs, name)
Definition: sync.h:274
#define LOCK(cs)
Definition: sync.h:268
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:299
#define TRY_LOCK(cs, name)
Definition: sync.h:273
std::string SysErrorString(int err)
Return system error string from errno value.
Definition: syserror.cpp:18
FastRandomContext rng
Definition: dbwrapper.cpp:413
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
const std::string DEFAULT_TOR_CONTROL
Default control ip and port.
Definition: torcontrol.cpp:46
CService DefaultOnionServiceTarget(uint16_t port)
Definition: torcontrol.cpp:749
constexpr uint16_t DEFAULT_TOR_SOCKS_PORT
Functionality for communicating with Tor.
Definition: torcontrol.h:24
constexpr bool DEFAULT_LISTEN_ONION
Definition: torcontrol.h:27
constexpr int DEFAULT_TOR_CONTROL_PORT
Definition: torcontrol.h:25
consteval auto _(util::TranslatedLiteral str)
Definition: translation.h:79
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82
constexpr unsigned MAX_CLUSTER_COUNT_LIMIT
Definition: txgraph.h:18
std::unique_ptr< TxIndex > g_txindex
The global transaction index, used in GetTransaction. May be null.
Definition: txindex.cpp:41
constexpr bool DEFAULT_TXINDEX
Definition: txindex.h:23
std::unique_ptr< TxoSpenderIndex > g_txospenderindex
The global txo spender index. May be null.
constexpr bool DEFAULT_TXOSPENDERINDEX
bool CheckStandardAsmap(const std::span< const std::byte > data)
Provides a safe interface for validating ASMap data before use.
Definition: asmap.cpp:308
std::vector< std::byte > DecodeAsmap(fs::path path)
Loads an ASMap file from disk and validates it.
Definition: asmap.cpp:320
uint256 AsmapVersion(const std::span< const std::byte > data)
Computes SHA256 hash of ASMap data for versioning and consistency checks.
Definition: asmap.cpp:346
bool SplitHostPort(std::string_view in, uint16_t &portOut, std::string &hostOut)
Splits socket address string into host string and port value.
std::optional< uint64_t > ParseByteUnits(std::string_view str, ByteUnit default_multiplier)
Parse a string with suffix unit [k|K|m|M|g|G|t|T].
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:52
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:102
assert(!tx.IsCoinBase())
constexpr signed int DEFAULT_CHECKBLOCKS
Definition: validation.h:77
constexpr int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
Definition: validation.h:90
constexpr int DEFAULT_CHECKLEVEL
Definition: validation.h:78
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:96
constexpr uint64_t MIN_DISK_SPACE_FOR_BLOCK_FILES
Definition: validation.h:87
constexpr int32_t MAX_PREVOUTFETCH_THREADS
Maximum number of dedicated threads allowed for prefetching block input prevouts.
Definition: validation.h:93
constexpr 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:76
const WalletInitInterface & g_wallet_init_interface
Definition: init.cpp:115
std::unique_ptr< CZMQNotificationInterface > g_zmq_notification_interface
void RegisterZMQRPCCommands(CRPCTable &t)
Definition: zmqrpc.cpp:68