Bitcoin Core 32.99.0
P2P Digital Currency
Loading...
Searching...
No Matches
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/node.h>
37#include <ipc/exception.h>
38#include <ipc/types.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>
56#include <node/blockstorage.h>
57#include <node/caches.h>
58#include <node/chainstate.h>
60#include <node/context.h>
61#include <node/interface_ui.h>
63#include <node/mempool_args.h>
66#include <node/mining_args.h>
67#include <node/peerman_args.h>
68#include <policy/feerate.h>
72#include <policy/policy.h>
73#include <policy/settings.h>
74#include <protocol.h>
75#include <random.h>
76#include <rpc/register.h>
77#include <rpc/server.h>
78#include <rpc/util.h>
79#include <scheduler.h>
80#include <script/sigcache.h>
81#include <sync.h>
82#include <tinyformat.h>
83#include <torcontrol.h>
84#include <txgraph.h>
85#include <txmempool.h>
86#include <uint256.h>
87#include <util/asmap.h>
88#include <util/batchpriority.h>
89#include <util/btcsignals.h>
90#include <util/byte_units.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/overflow.h>
97#include <util/result.h>
99#include <util/strencodings.h>
100#include <util/string.h>
101#include <util/syserror.h>
102#include <util/thread.h>
103#include <util/threadnames.h>
104#include <util/time.h>
105#include <util/translation.h>
106#include <validation.h>
107#include <validationinterface.h>
108#include <walletinitinterface.h>
109
110#include <algorithm>
111#include <any>
112#include <cerrno>
113#include <condition_variable>
114#include <cstddef>
115#include <cstdint>
116#include <exception>
117#include <fstream>
118#include <functional>
119#include <limits>
120#include <list>
121#include <memory>
122#include <new>
123#include <optional>
124#include <set>
125#include <span>
126#include <string>
127#include <system_error>
128#include <thread>
129#include <tuple>
130#include <utility>
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
167using util::Join;
168using util::ReplaceAll;
169using util::ToString;
171
172static constexpr bool DEFAULT_PROXYRANDOMIZE{true};
173static constexpr bool DEFAULT_REST_ENABLE{false};
174static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING{true};
175static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
176
177#ifdef WIN32
178// Win32 LevelDB doesn't use filedescriptors, and the ones used for
179// accessing block files don't count towards the fd_set size limit
180// anyway.
181#define MIN_LEVELDB_FDS 0
182#else
183#define MIN_LEVELDB_FDS 150
184#endif
185
187
191static const char* BITCOIN_PID_FILENAME = "bitcoind.pid";
196static bool g_generated_pid{false};
197
198static fs::path GetPidFile(const ArgsManager& args)
199{
201}
202
204{
205 if (args.IsArgNegated("-pid")) return true;
206
207 std::ofstream file{GetPidFile(args).std_path()};
208 if (file) {
209#ifdef WIN32
210 tfm::format(file, "%d\n", GetCurrentProcessId());
211#else
212 tfm::format(file, "%d\n", getpid());
213#endif
214 g_generated_pid = true;
215 return true;
216 } else {
217 return InitError(strprintf(_("Unable to create the PID file '%s': %s"), fs::PathToString(GetPidFile(args)), SysErrorString(errno)));
218 }
219}
220
221static void RemovePidFile(const ArgsManager& args)
222{
223 if (!g_generated_pid) return;
224 const auto pid_path{GetPidFile(args)};
225 if (std::error_code error; !fs::remove(pid_path, error)) {
226 std::string msg{error ? error.message() : "File does not exist"};
227 LogWarning("Unable to remove PID file (%s): %s", fs::PathToString(pid_path), msg);
228 }
229}
230
231static std::optional<util::SignalInterrupt> g_shutdown;
232
234{
236 g_shutdown.emplace();
237
238 node.args = &gArgs;
239 node.shutdown_signal = &*g_shutdown;
240 node.shutdown_request = [&node] {
241 assert(node.shutdown_signal);
242 if (!(*node.shutdown_signal)()) return false;
243 return true;
244 };
245}
246
248//
249// Shutdown
250//
251
252//
253// Thread management and startup/shutdown:
254//
255// The network-processing threads are all part of a thread group
256// created by AppInit() or the Qt main() function.
257//
258// A clean exit happens when the SignalInterrupt object is triggered, which
259// makes the main thread's SignalInterrupt::wait() call return, and join all
260// other ongoing threads in the thread group to the main thread.
261// Shutdown() is then called to clean up database connections, and stop other
262// threads that should only be stopped after the main network-processing
263// threads have exited.
264//
265// Shutdown for Qt is very similar, only it uses a QTimer to detect
266// ShutdownRequested() getting set, and then does the normal Qt
267// shutdown thing.
268//
269
271{
272 return bool{*Assert(node.shutdown_signal)};
273}
274
275#if HAVE_SYSTEM
276static void ShutdownNotify(const ArgsManager& args)
277{
278 std::vector<std::thread> threads;
279 for (const auto& cmd : args.GetArgs("-shutdownnotify")) {
280 threads.emplace_back(runCommand, cmd);
281 }
282 for (auto& t : threads) {
283 t.join();
284 }
285}
286#endif
287
289{
290#if HAVE_SYSTEM
291 ShutdownNotify(*node.args);
292#endif
293 // Wake any threads that may be waiting for the tip to change.
294 if (node.notifications) WITH_LOCK(node.notifications->m_tip_block_mutex, node.notifications->m_tip_block_cv.notify_all());
297 InterruptRPC();
299 if (node.tor_controller) {
300 node.tor_controller->Interrupt();
301 }
303 if (node.connman)
304 node.connman->Interrupt();
305 for (auto* index : node.indexes) {
306 index->Interrupt();
307 }
308}
309
311{
312 static Mutex g_shutdown_mutex;
314 if (!lock_shutdown) return;
315 LogInfo("Shutdown in progress...");
316 Assert(node.args);
317
322 util::ThreadRename("shutoff");
323 if (node.mempool) node.mempool->AddTransactionsUpdated(1);
324
325 StopHTTPRPC();
326 StopREST();
327 StopRPC();
329 for (auto& client : node.chain_clients) {
330 try {
331 client->stop();
332 } catch (const ipc::Exception& e) {
333 LogDebug(BCLog::IPC, "Chain client did not disconnect cleanly: %s", e.what());
334 client.reset();
335 }
336 }
337 StopMapPort();
338
339 // Because these depend on each-other, we make sure that neither can be
340 // using the other before destroying them.
341 if (node.peerman && node.validation_signals) node.validation_signals->UnregisterValidationInterface(node.peerman.get());
342 if (node.connman) node.connman->Stop();
343
344 if (node.tor_controller) {
345 node.tor_controller->Join();
346 node.tor_controller.reset();
347 }
348
349 if (node.background_init_thread.joinable()) node.background_init_thread.join();
350 // After everything has been shut down, but before things get flushed, stop the
351 // the scheduler. After this point, SyncWithValidationInterfaceQueue() should not be called anymore
352 // as this would prevent the shutdown from completing.
353 if (node.scheduler) node.scheduler->stop();
354
355 // After the threads that potentially access these pointers have been stopped,
356 // destruct and reset all to nullptr.
357 node.peerman.reset();
358 node.connman.reset();
359 node.banman.reset();
360 node.addrman.reset();
361 node.netgroupman.reset();
362
363 if (node.mempool && node.mempool->GetLoadTried() && ShouldPersistMempool(*node.args)) {
364 DumpMempool(*node.mempool, MempoolPath(*node.args));
365 }
366
367 // FlushStateToDisk generates a ChainStateFlushed callback, which we should avoid missing
368 if (node.chainman) {
369 LOCK(cs_main);
370 for (const auto& chainstate : node.chainman->m_chainstates) {
371 if (chainstate->CanFlushToDisk()) {
372 chainstate->ForceFlushStateToDisk();
373 }
374 }
375 }
376
377 // After there are no more peers/RPC left to give us new data which may generate
378 // CValidationInterface callbacks, flush them...
379 if (node.validation_signals) node.validation_signals->FlushBackgroundCallbacks();
380
381 // Once callbacks drain, drop tracked transactions, save estimates, and unregister the estimator
382 if (node.fee_estimator_man) {
383 node.fee_estimator_man->ShutdownFlush();
384 if (node.validation_signals) {
385 node.validation_signals->UnregisterValidationInterface(node.fee_estimator_man.get());
386 }
387 }
388
389 // Stop and delete all indexes only after flushing background callbacks.
390 for (auto* index : node.indexes) index->Stop();
391 if (g_txindex) g_txindex.reset();
395 node.indexes.clear(); // all instances are nullptr now
396
397 // Callbacks queued by this final chainstate flush will not run during shutdown
398 if (node.chainman) {
399 LOCK(cs_main);
400 for (const auto& chainstate : node.chainman->m_chainstates) {
401 if (chainstate->CanFlushToDisk()) {
402 chainstate->ForceFlushStateToDisk();
403 chainstate->ResetCoinsViews();
404 }
405 }
406 }
407
408 // If any -ipcbind clients are still connected, disconnect them now so they
409 // do not block shutdown.
410 if (interfaces::Ipc* ipc = node.init->ipc()) {
411 ipc->disconnectIncoming();
412 }
413
414#ifdef ENABLE_ZMQ
416 if (node.validation_signals) node.validation_signals->UnregisterValidationInterface(g_zmq_notification_interface.get());
418 }
419#endif
420
421 node.chain_clients.clear();
422 if (node.validation_signals) {
423 node.validation_signals->UnregisterAllValidationInterfaces();
424 }
425 node.fee_estimator_man.reset();
426 node.block_template_manager.reset();
427 node.mempool.reset();
428 node.chainman.reset();
429 node.validation_signals.reset();
430 node.scheduler.reset();
431 node.ecc_context.reset();
432 node.kernel.reset();
433
434 RemovePidFile(*node.args);
435
436 LogInfo("Shutdown done");
437}
438
444#ifndef WIN32
445static void HandleSIGTERM(int)
446{
447 // Return value is intentionally ignored because there is not a better way
448 // of handling this failure in a signal handler.
449 (void)(*Assert(g_shutdown))();
450}
451
452static void HandleSIGHUP(int)
453{
454 LogInstance().m_reopen_file = true;
455}
456#else
458{
459 if (!(*Assert(g_shutdown))()) {
460 LogError("Failed to send shutdown signal on Ctrl-C\n");
461 return false;
462 }
464 return true;
465}
466#endif
467
468#ifndef WIN32
469static void registerSignalHandler(int signal, void(*handler)(int))
470{
471 struct sigaction sa;
472 sa.sa_handler = handler;
473 sigemptyset(&sa.sa_mask);
474 sa.sa_flags = 0;
475 sigaction(signal, &sa, nullptr);
476}
477#endif
478
480{
482 argsman.AddArg("-help-debug", "Print help message with debugging options and exit", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); // server-only for now
483
485
496
497 // Hidden Options
498 std::vector<std::string> hidden_args = {
499 "-dbcrashratio", "-forcecompactdb",
500 // GUI args. These will be overwritten by SetupUIArgs for the GUI
501 "-choosedatadir", "-lang=<lang>", "-min", "-resetguisettings", "-splash", "-uiplatform"};
502
503 argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
504#if HAVE_SYSTEM
505 argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
506#endif
507 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);
508 argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
509 argsman.AddArg("-blocksxor",
510 strprintf("Whether an XOR-key applies to blocksdir *.dat files. "
511 "The created XOR-key will be zeros for an existing blocksdir or when `-blocksxor=0` is "
512 "set, and random for a freshly initialized blocksdir. "
513 "(default: %u)",
516 argsman.AddArg("-fastprune", "Use smaller block files and lower minimum prune height for testing purposes", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
517#if HAVE_SYSTEM
518 argsman.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash). Not run for blocks connected during initial block download or reindexing.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
519#endif
520 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);
521 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);
522 argsman.AddArg("-coinstatsindex", strprintf("Maintain coinstats index used by the gettxoutsetinfo RPC (default: %u)", DEFAULT_COINSTATSINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
523 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);
524 argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
525 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);
526 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);
527 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);
528 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);
529 argsman.AddArg("-loadblock=<file>", "Imports blocks from an external file on startup. Obfuscated blocks are not supported.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
530 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);
531 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);
532 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);
533 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)",
535 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);
536 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);
537 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);
538 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. "
539 "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. "
540 "(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);
541 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);
542 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);
543 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);
544#if HAVE_SYSTEM
545 argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
546 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);
547#endif
548 argsman.AddArg("-txindex", strprintf("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)", DEFAULT_TXINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
549 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);
550 argsman.AddArg("-blockfilterindex=<type>",
551 strprintf("Maintain an index of compact filters by block (default: %s, values: %s).", DEFAULT_BLOCKFILTERINDEX, ListBlockFilterTypes()) +
552 " If <type> is not supplied or if <type> = 1, indexes for all known types are enabled.",
554
555 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);
556 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",
558 " If a bool arg is given (-asmap or -asmap=1), the embedded mapping data in the binary will be used."
559 #else
560 ""
561 #endif
563 argsman.AddArg("-bantime=<n>", strprintf("Default duration (in seconds) of manually configured bans (default: %u)", DEFAULT_MISBEHAVING_BANTIME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
564 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);
565 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);
566 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);
567 argsman.AddArg("-discover", "Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
568 argsman.AddArg("-dns", strprintf("Allow DNS lookups for -addnode, -seednode and -connect (default: %u)", DEFAULT_NAME_LOOKUP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
569 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);
570 argsman.AddArg("-externalip=<ip>", "Specify your own public address", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
571 argsman.AddArg("-fixedseeds", strprintf("Allow fixed seeds if DNS seeds don't provide peers (default: %u)", DEFAULT_FIXEDSEEDS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
572 argsman.AddArg("-forcednsseed", strprintf("Always query for peer addresses via DNS lookup (default: %u)", DEFAULT_FORCEDNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
573 argsman.AddArg("-listen", strprintf("Accept connections from outside (default: %u if no -proxy, -connect or -maxconnections=0)", DEFAULT_LISTEN), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
574 argsman.AddArg("-listenonion", strprintf("Automatically create Tor onion service (default: %d)", DEFAULT_LISTEN_ONION), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
575 argsman.AddArg("-maxconnections=<n>", strprintf("Maintain at most <n> automatic connections to peers (default: %u, maximum: %u). %u slots of these are reserved for outgoing connections. See -inboundrelaypercent for more information about limits applied to transaction relay inbound peers. "
576 "This limit does not apply to connections manually added via -addnode or the addnode RPC, which have a separate limit of %u. "
577 "It does not apply to short-lived private broadcast connections either, which have a separate limit of %u.",
580 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);
581 argsman.AddArg("-maxreceivebuffer=<n>", strprintf("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXRECEIVEBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
582 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);
583 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);
584#ifdef HAVE_SOCKADDR_UN
585 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);
586#else
587 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);
588#endif
589 argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
590 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);
591 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);
592 argsman.AddArg("-v2transport", strprintf("Support v2 transport (default: %u)", DEFAULT_V2_TRANSPORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
593 argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
594 argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
595 argsman.AddArg("-txreconciliation", strprintf("Enable transaction reconciliations per BIP 330 (default: %d)", DEFAULT_TXRECONCILIATION_ENABLE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
596 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);
597 const std::string proxy_doc_for_value =
598#ifdef HAVE_SOCKADDR_UN
599 "<ip>[:<port>]|unix:<path>";
600#else
601 "<ip>[:<port>]";
602#endif
603 const std::string proxy_doc_for_unix_socket =
604#ifdef HAVE_SOCKADDR_UN
605 "May be a local file path prefixed with 'unix:' if the proxy supports it. ";
606#else
607 "";
608#endif
609 argsman.AddArg("-proxy=" + proxy_doc_for_value + "[=<network>]",
610 "Connect through SOCKS5 proxy, set -noproxy to disable. " +
612 "Could end in =network to set the proxy only for that network. " +
613 "The network can be any of " + Join(std::vector{NET_IPV4, NET_IPV6, NET_ONION, NET_CJDNS}, ", ", GetNetworkName) + ". " +
614 "(default: disabled)",
617 argsman.AddArg("-proxyrandomize", strprintf("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)", DEFAULT_PROXYRANDOMIZE), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
618 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);
619 argsman.AddArg("-networkactive", "Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
620 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);
621 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);
622 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);
623 argsman.AddArg("-torpassword=<pass>", "Tor control port password (default: empty)", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::CONNECTION);
624 argsman.AddArg("-natpmp", strprintf("Use PCP or NAT-PMP to map the listening port (default: %u)", DEFAULT_NATPMP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
625 argsman.AddArg("-whitebind=<[permissions@]addr>", "Bind to the given address and add permission flags to the peers connecting to it. "
626 "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
627 "Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
628
629 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 "
630 "CIDR-notated network (e.g. 1.2.3.0/24). Uses the same permissions as "
631 "-whitebind. "
632 "Additional flags \"in\" and \"out\" control whether permissions apply to incoming connections and/or manual (default: incoming only). "
633 "Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
634
636
637#ifdef ENABLE_ZMQ
638 argsman.AddArg("-zmqpubhashblock=<address>", "Enable publish hash block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
639 argsman.AddArg("-zmqpubhashtx=<address>", "Enable publish hash transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
640 argsman.AddArg("-zmqpubrawblock=<address>", "Enable publish raw block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
641 argsman.AddArg("-zmqpubrawtx=<address>", "Enable publish raw transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
642 argsman.AddArg("-zmqpubsequence=<address>", "Enable publish hash block and tx sequence in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
643 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);
644 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);
645 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);
646 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);
647 argsman.AddArg("-zmqpubsequencehwm=<n>", strprintf("Set publish hash sequence message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
648#else
649 hidden_args.emplace_back("-zmqpubhashblock=<address>");
650 hidden_args.emplace_back("-zmqpubhashtx=<address>");
651 hidden_args.emplace_back("-zmqpubrawblock=<address>");
652 hidden_args.emplace_back("-zmqpubrawtx=<address>");
653 hidden_args.emplace_back("-zmqpubsequence=<n>");
654 hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
655 hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
656 hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
657 hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
658 hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
659#endif
660
661 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);
662 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);
663 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);
664 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);
665 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);
666 // Checkpoints were removed. We keep `-checkpoints` as a hidden arg to display a more user friendly error when set.
667 argsman.AddArg("-checkpoints", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
668 argsman.AddArg("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
669 argsman.AddArg("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
670 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);
671 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);
672 // Ancestor and descendant size limits were removed. We keep
673 // -limitancestorsize/-limitdescendantsize as hidden args to display a more
674 // user friendly error when set.
675 argsman.AddArg("-limitancestorsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
676 argsman.AddArg("-limitdescendantsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
677 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);
678 argsman.AddArg("-test=<option>", "Pass a test-only option. Options include : " + Join(TEST_OPTIONS_DOC, ", ") + ".", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
679 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);
680 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);
681 argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
682 argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
683 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);
684 argsman.AddArg("-maxtipage=<n>",
685 strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)",
688 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);
689 argsman.AddArg("-uacomment=<cmt>", "Append comment to the user agent string", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
690
692
693 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);
694 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);
695 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);
696 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);
697 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);
698 argsman.AddArg("-datacarrier", strprintf("Relay and mine data carrier transactions (default: %u)", DEFAULT_ACCEPT_DATACARRIER), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
699 argsman.AddArg("-datacarriersize",
700 strprintf("Relay and mine transactions whose data-carrying raw scriptPubKeys in aggregate "
701 "are of this size or less, allowing multiple outputs (default: %u)",
704 argsman.AddArg("-permitbaremultisig", strprintf("Relay transactions creating non-P2SH multisig outputs (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY,
706 argsman.AddArg("-minrelaytxfee=<amt>", strprintf("Fees (in %s/kvB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)",
708 argsman.AddArg("-txsendrate=<n>",
709 strprintf("Set the maximum ongoing rate for sending transactions to (inbound) peers (default: %u tx/s)",
712 argsman.AddArg("-privatebroadcast",
713 strprintf(
714 "EXPERIMENTAL: Broadcast transactions submitted via sendrawtransaction RPC using short-lived "
715 "connections through the Tor or I2P networks, without putting them in the mempool first. "
716 "This provides best-effort concealment of the transaction's origin. "
717 "Transactions submitted through the wallet are not affected by this option "
718 "(default: %u)",
722 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);
723 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);
724
725
726 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);
727 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);
728 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);
729 argsman.AddArg("-blockversion=<n>", "Override block version to test forking scenarios", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
730
731 argsman.AddArg("-rest", strprintf("Accept public REST requests (default: %u)", DEFAULT_REST_ENABLE), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
732 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);
733 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);
734 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);
735 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);
736 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);
737 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);
738 argsman.AddArg("-rpcmaxconnections=<n>", strprintf("The maximum number of connected HTTP clients (default: %d)", DEFAULT_MAX_HTTP_CONNECTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
739 argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
740 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);
741 argsman.AddArg("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
742 argsman.AddArg("-rpcthreads=<n>", strprintf("Set the number of threads to service RPC calls (default: %d)", DEFAULT_HTTP_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
743 argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
744 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);
745 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);
746 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);
747 argsman.AddArg("-server", "Accept command line and JSON-RPC commands", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
748 if (can_listen_ipc) {
749 argsman.AddArg("-ipcbind=<address>", strprintf("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. Append \",max-connections=8\", for example \"unix:/custom/path,max-connections=8\", to limit the number of simultaneous connections on that address (default: %d, maximum: %d). 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.",ipc::DEFAULT_MAX_CONNECTIONS, ipc::MAX_CONNECTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::IPC);
750 }
751
752#if HAVE_DECL_FORK
753 argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
754 argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
755#else
756 hidden_args.emplace_back("-daemon");
757 hidden_args.emplace_back("-daemonwait");
758#endif
759
760 // Add the hidden options
761 argsman.AddHiddenArgs(hidden_args);
762}
763
764#if HAVE_SYSTEM
765static void StartupNotify(const ArgsManager& args)
766{
767 std::string cmd = args.GetArg("-startupnotify", "");
768 if (!cmd.empty()) {
769 std::thread t(runCommand, cmd);
770 t.detach(); // thread runs free
771 }
772}
773#endif
774
776{
777 const ArgsManager& args = *Assert(node.args);
778 if (!InitHTTPServer()) {
779 return false;
780 }
781 StartRPC();
782 node.rpc_interruption_point = RpcInterruptionPoint;
783 if (!StartHTTPRPC(&node))
784 return false;
787 return true;
788}
789
790// Parameter interaction based on rules
792{
793 // when specifying an explicit binding address, you want to listen on it
794 // even when -connect or -proxy is specified
795 if (!args.GetArgs("-bind").empty()) {
796 if (args.SoftSetBoolArg("-listen", true))
797 LogInfo("parameter interaction: -bind set -> setting -listen=1\n");
798 }
799 if (!args.GetArgs("-whitebind").empty()) {
800 if (args.SoftSetBoolArg("-listen", true))
801 LogInfo("parameter interaction: -whitebind set -> setting -listen=1\n");
802 }
803
804 if (!args.GetArgs("-connect").empty() || args.IsArgNegated("-connect") || args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS) <= 0) {
805 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
806 // do the same when connections are disabled
807 if (args.SoftSetBoolArg("-dnsseed", false))
808 LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0\n");
809 if (args.SoftSetBoolArg("-listen", false))
810 LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0\n");
811 }
812
813 std::string proxy_arg = args.GetArg("-proxy", "");
814 if (proxy_arg != "" && proxy_arg != "0") {
815 // to protect privacy, do not listen by default if a default proxy server is specified
816 if (args.SoftSetBoolArg("-listen", false))
817 LogInfo("parameter interaction: -proxy set -> setting -listen=0\n");
818 // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
819 // to listen locally, so don't rely on this happening through -listen below.
820 if (args.SoftSetBoolArg("-natpmp", false)) {
821 LogInfo("parameter interaction: -proxy set -> setting -natpmp=0\n");
822 }
823 // to protect privacy, do not discover addresses by default
824 if (args.SoftSetBoolArg("-discover", false))
825 LogInfo("parameter interaction: -proxy set -> setting -discover=0\n");
826 }
827
828 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
829 // do not map ports or try to retrieve public IP when not listening (pointless)
830 if (args.SoftSetBoolArg("-natpmp", false)) {
831 LogInfo("parameter interaction: -listen=0 -> setting -natpmp=0\n");
832 }
833 if (args.SoftSetBoolArg("-discover", false))
834 LogInfo("parameter interaction: -listen=0 -> setting -discover=0\n");
835 if (args.SoftSetBoolArg("-listenonion", false))
836 LogInfo("parameter interaction: -listen=0 -> setting -listenonion=0\n");
837 if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
838 LogInfo("parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n");
839 }
840 }
841
842 if (!args.GetArgs("-externalip").empty()) {
843 // if an explicit public IP is specified, do not try to find others
844 if (args.SoftSetBoolArg("-discover", false))
845 LogInfo("parameter interaction: -externalip set -> setting -discover=0\n");
846 }
847
848 if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
849 // disable whitelistrelay in blocksonly mode
850 if (args.SoftSetBoolArg("-whitelistrelay", false))
851 LogInfo("parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n");
852 // Reduce default mempool size in blocksonly mode to avoid unexpected resource usage
853 if (args.SoftSetArg("-maxmempool", ToString(DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB)))
854 LogInfo("parameter interaction: -blocksonly=1 -> setting -maxmempool=%d\n", DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB);
855 }
856
857 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
858 if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
859 if (args.SoftSetBoolArg("-whitelistrelay", true))
860 LogInfo("parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n");
861 }
862 const auto onlynets = args.GetArgs("-onlynet");
863 if (!onlynets.empty()) {
864 bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
865 const auto n = ParseNetwork(net);
866 return n == NET_IPV4 || n == NET_IPV6;
867 });
868 if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
869 LogInfo("parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n");
870 }
871 }
872}
873
885
886namespace { // Variables internal to initialization process only
887
889int available_fds;
892std::set<BlockFilterType> g_enabled_filter_types;
893
894} // namespace
895
897{
898 // Rather than throwing std::bad-alloc if allocation fails, terminate
899 // immediately to (try to) avoid chain corruption.
900 // Since logging may itself allocate memory, set the handler directly
901 // to terminate first.
902 std::set_new_handler(std::terminate);
903 LogError("Out of memory. Terminating.\n");
904
905 // The log was successful, terminate now.
906 std::terminate();
907};
908
909bool AppInitBasicSetup(const ArgsManager& args, std::atomic<int>& exit_status)
910{
911 // ********************************************************* Step 1: setup
912#ifdef _MSC_VER
913 // Turn off Microsoft heap dump noise
916 // Disable confusing "helpful" text message on abort, Ctrl-C
918#endif
919#ifdef WIN32
920 // Enable heap terminate-on-corruption
922#endif
923 if (!SetupNetworking()) {
924 return InitError(Untranslated("Initializing networking failed."));
925 }
926
927#ifndef WIN32
928 // Clean shutdown on SIGTERM
931
932 // Reopen debug.log on SIGHUP
934
935 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
936 signal(SIGPIPE, SIG_IGN);
937#else
939#endif
940
941 std::set_new_handler(new_handler_terminate);
942
943 return true;
944}
945
947{
948 const CChainParams& chainparams = Params();
949 // ********************************************************* Step 2: parameter interactions
950
951 // also see: InitParameterInteraction()
952
953 // We removed checkpoints but keep the option to warn users who still have it in their config.
954 if (args.IsArgSet("-checkpoints")) {
955 InitWarning(_("Option '-checkpoints' is set but checkpoints were removed. This option has no effect."));
956 }
957 if (args.IsArgSet("-limitancestorsize")) {
958 InitWarning(_("Option '-limitancestorsize' is given but ancestor size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
959 }
960 if (args.IsArgSet("-limitdescendantsize")) {
961 InitWarning(_("Option '-limitdescendantsize' is given but descendant size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
962 }
963
964 // Error if network-specific options (-addnode, -connect, etc) are
965 // specified in default section of config file, but not overridden
966 // on the command line or in this chain's section of the config file.
967 ChainType chain = args.GetChainType();
968 if (chain == ChainType::SIGNET) {
969 LogInfo("Signet derived magic (message start): %s", HexStr(chainparams.MessageStart()));
970 }
972 for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
973 errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section."), arg, ChainTypeToString(chain), ChainTypeToString(chain)) + Untranslated("\n");
974 }
975
976 if (!errors.empty()) {
977 return InitError(errors);
978 }
979
980 // Testnet3 deprecation warning
981 if (chain == ChainType::TESTNET) {
982 LogInfo("Warning: Support for testnet3 is deprecated and will be removed in an upcoming release. Consider switching to testnet4.\n");
983 }
984
985 // Warn if unrecognized section name are present in the config file.
986 bilingual_str warnings;
987 for (const auto& section : args.GetUnrecognizedSections()) {
988 warnings += Untranslated(strprintf("%s:%i ", section.m_file, section.m_line)) + strprintf(_("Section [%s] is not recognized."), section.m_name) + Untranslated("\n");
989 }
990
991 if (!warnings.empty()) {
992 InitWarning(warnings);
993 }
994
995 if (!fs::is_directory(args.GetBlocksDirPath())) {
996 return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
997 }
998
999 // parse and validate enabled filter types
1000 std::string blockfilterindex_value = args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
1001 if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
1003 } else if (blockfilterindex_value != "0") {
1004 const std::vector<std::string> names = args.GetArgs("-blockfilterindex");
1005 for (const auto& name : names) {
1008 return InitError(strprintf(_("Unknown -blockfilterindex value %s."), name));
1009 }
1011 }
1012 }
1013
1014 // Signal NODE_P2P_V2 if BIP324 v2 transport is enabled.
1015 if (args.GetBoolArg("-v2transport", DEFAULT_V2_TRANSPORT)) {
1017 }
1018
1019 // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index are both enabled.
1020 if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
1022 return InitError(_("Cannot set -peerblockfilters without -blockfilterindex."));
1023 }
1024
1026 }
1027
1028 if (args.GetIntArg("-prune", 0)) {
1029 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX))
1030 return InitError(_("Prune mode is incompatible with -txindex."));
1031 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX))
1032 return InitError(_("Prune mode is incompatible with -txospenderindex."));
1033 if (args.GetBoolArg("-reindex-chainstate", false)) {
1034 return InitError(_("Prune mode is incompatible with -reindex-chainstate. Use full -reindex instead."));
1035 }
1036 }
1037
1038 // If -forcednsseed is set to true, ensure -dnsseed has not been set to false
1039 if (args.GetBoolArg("-forcednsseed", DEFAULT_FORCEDNSSEED) && !args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED)){
1040 return InitError(_("Cannot set -forcednsseed to true when setting -dnsseed to false."));
1041 }
1042
1043 // -bind and -whitebind can't be set when not listening
1044 size_t num_user_p2p_bind = args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
1045 if (num_user_p2p_bind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1046 return InitError(Untranslated("Cannot set -bind or -whitebind together with -listen=0"));
1047 }
1048
1049 // if listen=0, then disallow listenonion=1
1050 if (!args.GetBoolArg("-listen", DEFAULT_LISTEN) && args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
1051 return InitError(Untranslated("Cannot set -listen=0 together with -listenonion=1"));
1052 }
1053
1054 // Make sure enough file descriptors are available. We need to reserve enough FDs to account for the bare minimum,
1055 // plus all manual connections and all bound interfaces. Any remainder will be available for connection sockets
1056
1057 // Keep IPC reservations low enough to leave room for core and P2P file descriptor reservations.
1058 constexpr size_t MAX_IPC_FDS{ipc::MAX_CONNECTIONS + 1};
1059
1060 // Number of bound interfaces (we have at least one)
1061 int num_p2p_bind = std::max(num_user_p2p_bind, size_t(1));
1062 // Maximum number of connections with other nodes, this accounts for all types of outbounds and inbounds except for manual
1064 if (user_p2p_max_connections < 0) {
1065 return InitError(Untranslated("-maxconnections must be greater or equal than zero"));
1066 }
1068 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d."), user_p2p_max_connections, MAX_PEER_CONNECTIONS));
1070 }
1071
1072 // Reserve one listening socket per -ipcbind address plus its accepted
1073 // connection slots. Unlike P2P, IPC has no default listener.
1074 size_t ipc_addresses{0};
1075 size_t ipc_max_connections{0};
1076 for (const std::string& configured_address : args.GetArgs("-ipcbind")) {
1078 if (!listen_address) {
1079 return InitError(Untranslated(strprintf("Invalid -ipcbind address '%s': %s", configured_address, util::ErrorString(listen_address).original)));
1080 }
1081 // Check the aggregate after adding this listener so multiple
1082 // individually valid -ipcbind values cannot exceed the IPC FD cap.
1083 ipc_addresses += 1;
1084 ipc_max_connections += listen_address->max_connections;
1085 }
1086 // Actual number of IPC file descriptors to be reserved.
1088
1089 if (ipc_fds > MAX_IPC_FDS) {
1090 return InitError(Untranslated(strprintf("Too many IPC file descriptors requested: %d -ipcbind listeners and connection slots exceed the limit of %d. Reduce the number of -ipcbind addresses or their max-connections values", static_cast<int>(ipc_fds), static_cast<int>(MAX_IPC_FDS))));
1091 }
1092
1093 if (ipc_addresses > 0) {
1094 LogInfo("Reserving %d file descriptors for IPC (%d listening sockets, %d connection slots)",
1095 static_cast<int>(ipc_fds),
1096 static_cast<int>(ipc_addresses),
1097 static_cast<int>(ipc_max_connections));
1098 }
1099
1100 const size_t max_private{args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)
1102 : 0};
1103 // HTTP server listen sockets: by default two (IPv4 and IPv6 loopback), or one per -rpcbind entry
1104 int num_rpc_bind = std::max(args.GetArgs("-rpcbind").size(), size_t(2));
1105 // HTTP server connected client sockets
1106 int user_rpc_max_connections = args.GetArg<int>("-rpcmaxconnections", DEFAULT_MAX_HTTP_CONNECTIONS);
1107 if (user_rpc_max_connections < 1) {
1108 return InitError(Untranslated("-rpcmaxconnections must be greater than zero. Use -server=0 to disable HTTP."));
1109 }
1110 if (!args.GetBoolArg("-server", false)) {
1111 num_rpc_bind = 0;
1113 }
1114
1115 // Reserve enough FDs to account for the bare minimum, plus any manual connections, plus the bound interfaces.
1116 // Every element is an int >= 0 so summing in int64_t cannot overflow.
1117 // RaiseFileDescriptorLimit() accepts an int so we check that limit before casting.
1120 num_p2p_bind +
1121 num_rpc_bind +
1124 static_cast<int64_t>(ipc_fds) +
1125 static_cast<int64_t>(max_private);
1126 if (total_fds > std::numeric_limits<int>::max()) {
1127 return InitError(Untranslated("Too many file descriptors requested. Try lower values for -rpcmaxconnections "
1128 "or -maxconnections, or fewer settings of "
1129 "-rpcbind, -bind, -whitebind and -ipcbind"));
1130 }
1131
1132 // Subset of total_fds must also be a safe int
1135 num_p2p_bind +
1136 num_rpc_bind +
1138 static_cast<int>(ipc_fds);
1139
1140 // Try raising the FD limit to what the user wants (available_fds may be smaller than the requested amount if this fails)
1142 // If we are using select instead of poll, our actual limit may be even smaller
1143#ifndef USE_POLL
1145#endif
1146 // The system can't support our bare minimum
1148 return InitError(strprintf(_("Not enough file descriptors available. %d available, %d required."), available_fds, min_required_fds));
1149
1150 // The system can support our minimum but not the full amount the user requested.
1151 if (available_fds < total_fds) {
1152 // If the user is requesting extra HTTP connections, abort. They need to change that.
1154 return InitError(strprintf(_("Not enough file descriptors available. "
1155 "Try reducing -rpcmaxconnections or using the default value of %d"),
1157 }
1158 }
1159
1160 // Trim requested connection counts, to fit into system limitations
1162
1164 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), user_p2p_max_connections, num_p2p_max_connections));
1165
1166 // ********************************************************* Step 3: parameter-to-internal-flags
1167 if (auto result{init::SetLoggingCategories(args)}; !result) return InitError(util::ErrorString(result));
1168 if (auto result{init::SetLoggingLevel(args)}; !result) return InitError(util::ErrorString(result));
1169
1171 if (nConnectTimeout <= 0) {
1173 }
1174
1176 if (peer_connect_timeout <= 0) {
1177 return InitError(Untranslated("peertimeout must be a positive integer."));
1178 }
1179
1181 if (!mining_result) {
1183 }
1184
1185 nBytesPerSigOp = args.GetIntArg("-bytespersigop", nBytesPerSigOp);
1186
1187 if (!g_wallet_init_interface.ParameterInteraction()) return false;
1188
1189 // Option to startup with mocktime set (used for regression testing):
1190 if (const auto mocktime{args.GetIntArg("-mocktime")}) {
1191 SetMockTime(std::chrono::seconds{*mocktime});
1192 }
1193
1194 if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1196
1197 const std::vector<std::string> test_options = args.GetArgs("-test");
1198 if (!test_options.empty()) {
1199 if (chainparams.GetChainType() != ChainType::REGTEST) {
1200 return InitError(Untranslated("-test=<option> can only be used with regtest"));
1201 }
1202 for (const std::string& option : test_options) {
1203 auto it = std::find_if(TEST_OPTIONS_DOC.begin(), TEST_OPTIONS_DOC.end(), [&option](const std::string& doc_option) {
1204 size_t pos = doc_option.find(" (");
1205 return (pos != std::string::npos) && (doc_option.substr(0, pos) == option);
1206 });
1207 if (it == TEST_OPTIONS_DOC.end()) {
1208 InitWarning(strprintf(_("Unrecognised option \"%s\" provided in -test=<option>."), option));
1209 }
1210 }
1211 }
1212
1213 // Prevent setting deployment parameters on mainnet.
1214 if (chainparams.GetChainType() == ChainType::MAIN) {
1215 if (args.IsArgSet("-testactivationheight")) {
1216 return InitError(_("The -testactivationheight option may not be used on mainnet."));
1217 }
1218 if (args.IsArgSet("-vbparams")) {
1219 return InitError(_("The -vbparams option may not be used on mainnet."));
1220 }
1221 }
1222
1223 // Also report errors from parsing before daemonization
1224 {
1225 kernel::Notifications notifications{};
1227 .chainparams = chainparams,
1228 .datadir = args.GetDataDirNet(),
1229 .notifications = notifications,
1230 };
1231 auto chainman_result{ApplyArgsManOptions(args, chainman_opts_dummy)};
1232 if (!chainman_result) {
1234 }
1236 .chainparams = chainman_opts_dummy.chainparams,
1237 .blocks_dir = args.GetBlocksDirPath(),
1238 .notifications = chainman_opts_dummy.notifications,
1239 .block_tree_db_params = DBParams{
1240 .path = args.GetDataDirNet() / "blocks" / "index",
1241 .cache_bytes = 0,
1242 },
1243 };
1244 auto blockman_result{ApplyArgsManOptions(args, blockman_opts_dummy)};
1245 if (!blockman_result) {
1247 }
1249 auto mempool_result{ApplyArgsManOptions(args, chainparams, mempool_opts)};
1250 if (!mempool_result) {
1252 }
1253 }
1254
1255 return true;
1256}
1257
1258static bool LockDirectory(const fs::path& dir, bool probeOnly)
1259{
1260 // Make sure only a single process is using the directory.
1261 switch (util::LockDirectory(dir, ".lock", probeOnly)) {
1263 return InitError(strprintf(_("Cannot write to directory '%s'; check permissions."), fs::PathToString(dir)));
1265 return InitError(strprintf(_("Cannot obtain a lock on directory %s. %s is probably already running."), fs::PathToString(dir), CLIENT_NAME));
1266 case util::LockResult::Success: return true;
1267 } // no default case, so the compiler can warn about missing cases
1268 assert(false);
1269}
1275
1277{
1278 // ********************************************************* Step 4: sanity checks
1279 auto result{kernel::SanityChecks(kernel)};
1280 if (!result) {
1282 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), CLIENT_NAME));
1283 }
1284
1285 if (!ECC_InitSanityCheck()) {
1286 return InitError(strprintf(_("Elliptic curve cryptography sanity check failure. %s is shutting down."), CLIENT_NAME));
1287 }
1288
1289 // Probe the directory locks to give an early error message, if possible
1290 // We cannot hold the directory locks here, as the forking for daemon() hasn't yet happened,
1291 // and a fork will cause weird behavior to them.
1292 return LockDirectories(true);
1293}
1294
1296{
1297 // After daemonization get the directory locks again and hold on to them until exit
1298 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1299 // will at most make us exit without printing a message to console.
1300 if (!LockDirectories(false)) {
1301 // Detailed error printed inside LockDirectory
1302 return false;
1303 }
1304 return true;
1305}
1306
1308{
1310 return true;
1311}
1312
1314 for (const std::string port_option : {
1315 "-port",
1316 "-rpcport",
1317 }) {
1318 if (const auto port{args.GetArg(port_option)}) {
1319 const auto n{ToIntegral<uint16_t>(*port)};
1320 if (!n || *n == 0) {
1321 return InitError(InvalidPortErrMsg(port_option, *port));
1322 }
1323 }
1324 }
1325
1326 for ([[maybe_unused]] const auto& [param_name, unix, suffix_allowed] : std::vector<std::tuple<std::string, bool, bool>>{
1327 // arg name UNIX socket support =suffix allowed
1328 {"-i2psam", false, false},
1329 {"-onion", true, false},
1330 {"-proxy", true, true},
1331 {"-bind", false, true},
1332 {"-rpcbind", false, false},
1333 {"-torcontrol", false, false},
1334 {"-whitebind", false, false},
1335 {"-zmqpubhashblock", true, false},
1336 {"-zmqpubhashtx", true, false},
1337 {"-zmqpubrawblock", true, false},
1338 {"-zmqpubrawtx", true, false},
1339 {"-zmqpubsequence", true, false},
1340 }) {
1341 for (const std::string& param_value : args.GetArgs(param_name)) {
1342 const std::string param_value_hostport{
1343 suffix_allowed ? param_value.substr(0, param_value.rfind('=')) : param_value};
1344 std::string host_out;
1345 uint16_t port_out{0};
1347#ifdef HAVE_SOCKADDR_UN
1348 // Allow unix domain sockets for some options e.g. unix:/some/file/path
1349 if (!unix || !param_value.starts_with(ADDR_PREFIX_UNIX)) {
1350 return InitError(InvalidPortErrMsg(param_name, param_value));
1351 }
1352#else
1353 return InitError(InvalidPortErrMsg(param_name, param_value));
1354#endif
1355 }
1356 }
1357 }
1358
1359 return true;
1360}
1361
1368static std::optional<CService> CheckBindingConflicts(const CConnman::Options& conn_options)
1369{
1370 std::set<CService> seen;
1371
1372 // Check all whitelisted bindings
1373 for (const auto& wb : conn_options.vWhiteBinds) {
1374 if (!seen.insert(wb.m_service).second) {
1375 return wb.m_service;
1376 }
1377 }
1378
1379 // Check regular bindings
1380 for (const auto& bind : conn_options.vBinds) {
1381 if (!seen.insert(bind).second) {
1382 return bind;
1383 }
1384 }
1385
1386 // Check onion bindings
1387 for (const auto& onion_bind : conn_options.onion_binds) {
1388 if (!seen.insert(onion_bind).second) {
1389 return onion_bind;
1390 }
1391 }
1392
1393 return std::nullopt;
1394}
1395
1396// A GUI user may opt to retry once with do_reindex set if there is a failure during chainstate initialization.
1397// The function therefore has to support re-entry.
1398static ChainstateLoadResult InitAndLoadChainstate(
1400 bool do_reindex,
1401 const bool do_reindex_chainstate,
1403 const ArgsManager& args)
1404{
1405 // This function may be called twice, so any dirty state must be reset.
1406 node.notifications->setChainstateLoaded(false); // Drop state, such as a cached tip block
1407 node.block_template_manager.reset();
1408 node.mempool.reset();
1409 node.chainman.reset(); // Drop state, such as an initialized m_block_tree_db
1410
1411 const CChainParams& chainparams = Params();
1412
1414 .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
1415 .signals = node.validation_signals.get(),
1416 };
1417 Assert(ApplyArgsManOptions(args, chainparams, mempool_opts)); // no error can happen, already checked in AppInitParameterInteraction
1419 Assert(!node.mempool); // Was reset above
1420 node.mempool = std::make_unique<CTxMemPool>(mempool_opts, mempool_error);
1421 if (!mempool_error.empty()) {
1422 return {ChainstateLoadStatus::FAILURE_FATAL, mempool_error};
1423 }
1424 LogInfo("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of unused mempool space)",
1425 cache_sizes.coins / double(1_MiB),
1426 mempool_opts.max_size_bytes / double(1_MiB));
1428 .chainparams = chainparams,
1429 .datadir = args.GetDataDirNet(),
1430 .notifications = *node.notifications,
1431 .signals = node.validation_signals.get(),
1432 };
1433 Assert(ApplyArgsManOptions(args, chainman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1434
1436 .chainparams = chainman_opts.chainparams,
1437 .blocks_dir = args.GetBlocksDirPath(),
1438 .notifications = chainman_opts.notifications,
1439 .block_tree_db_params = DBParams{
1440 .path = args.GetDataDirNet() / "blocks" / "index",
1441 .cache_bytes = cache_sizes.block_tree_db,
1442 .wipe_data = do_reindex,
1443 },
1444 };
1445 Assert(ApplyArgsManOptions(args, blockman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1446
1447 // Creating the chainstate manager internally creates a BlockManager, opens
1448 // the blocks tree db, and wipes existing block files in case of a reindex.
1449 // The coinsdb is opened at a later point on LoadChainstate.
1450 Assert(!node.chainman); // Was reset above
1451 try {
1452 node.chainman = std::make_unique<ChainstateManager>(*Assert(node.shutdown_signal), chainman_opts, blockman_opts);
1453 } catch (dbwrapper_error& e) {
1454 LogError("%s", e.what());
1455 return {ChainstateLoadStatus::FAILURE, _("Error opening block database")};
1456 } catch (std::exception& e) {
1457 return {ChainstateLoadStatus::FAILURE_FATAL, Untranslated(strprintf("Failed to initialize ChainstateManager: %s", e.what()))};
1458 }
1459 ChainstateManager& chainman = *node.chainman;
1460 if (chainman.m_interrupt) return {ChainstateLoadStatus::INTERRUPTED, {}};
1461
1462 // This is defined and set here instead of inline in validation.h to avoid a hard
1463 // dependency between validation and index/base, since the latter is not in
1464 // libbitcoinkernel.
1465 chainman.snapshot_download_completed = [&node]() {
1466 if (!node.chainman->m_blockman.IsPruneMode()) {
1467 LogInfo("[snapshot] re-enabling NODE_NETWORK services");
1468 node.connman->AddLocalServices(NODE_NETWORK);
1469 }
1470 LogInfo("[snapshot] restarting indexes");
1471 // Drain the validation interface queue to ensure that the old indexes
1472 // don't have any pending work.
1473 Assert(node.validation_signals)->SyncWithValidationInterfaceQueue();
1474 for (auto* index : node.indexes) {
1475 index->Interrupt();
1476 index->Stop();
1477 if (!(index->Init() && index->StartBackgroundSync())) {
1478 LogWarning("[snapshot] Failed to restart index %s on snapshot chain", index->GetName());
1479 }
1480 }
1481 };
1483 options.mempool = Assert(node.mempool.get());
1485 options.prune = chainman.m_blockman.IsPruneMode();
1486 options.check_blocks = args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
1487 options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
1488 options.require_full_verification = args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
1489 options.coins_error_cb = [] {
1491 _("Error reading from database, shutting down."),
1493 };
1494 uiInterface.InitMessage(_("Loading block index…"));
1495 auto catch_exceptions = [](auto&& f) -> ChainstateLoadResult {
1496 try {
1497 return f();
1498 } catch (const std::exception& e) {
1499 LogError("%s\n", e.what());
1500 return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1501 }
1502 };
1503 auto [status, error] = catch_exceptions([&] { return LoadChainstate(chainman, cache_sizes, options); });
1505 uiInterface.InitMessage(_("Verifying blocks…"));
1506 if (chainman.m_blockman.m_have_pruned && options.check_blocks > MIN_BLOCKS_TO_KEEP) {
1507 LogWarning("pruned datadir may not have more than %d blocks; only checking available blocks\n",
1509 }
1510 std::tie(status, error) = catch_exceptions([&] { return VerifyLoadedChainstate(chainman, options); });
1512 LogInfo("Block index and chainstate loaded");
1514 Assert(mining_args); // no error can happen, already checked in AppInitParameterInteraction
1515 // Must be set before setChainstateLoaded(true), which unblocks MakeMining waiters that assume it is non-null.
1516 node.block_template_manager = std::make_unique<node::BlockTemplateManager>(*node.mempool, chainman, *node.notifications, std::move(*mining_args));
1517 node.notifications->setChainstateLoaded(true);
1518 }
1519 }
1520 return {status, error};
1521};
1522
1524{
1525 const ArgsManager& args = *Assert(node.args);
1526 const CChainParams& chainparams = Params();
1527
1529 if (!opt_max_upload) {
1530 return InitError(strprintf(_("Unable to parse -maxuploadtarget: '%s'"), args.GetArg("-maxuploadtarget", "")));
1531 }
1532
1533 // ********************************************************* Step 4a: application initialization
1534 if (!CreatePidFile(args)) {
1535 // Detailed error printed inside CreatePidFile().
1536 return false;
1537 }
1538 if (!init::StartLogging(args)) {
1539 // Detailed error printed inside StartLogging().
1540 return false;
1541 }
1542
1543 LogInfo("Using at most %i automatic connections (%i file descriptors available)", num_p2p_max_connections, available_fds);
1544
1545 // Warn about relative -datadir path.
1546 if (args.IsArgSet("-datadir") && !args.GetPathArg("-datadir").is_absolute()) {
1547 LogWarning("Relative datadir option '%s' specified, which will be interpreted relative to the "
1548 "current working directory '%s'. This is fragile, because if bitcoin is started in the future "
1549 "from a different location, it will be unable to locate the current data files. There could "
1550 "also be data loss if bitcoin is started while in a temporary directory.",
1551 args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1552 }
1553
1554 assert(!node.scheduler);
1555 node.scheduler = std::make_unique<CScheduler>();
1556 auto& scheduler = *node.scheduler;
1557
1558 // Start the lightweight task scheduler thread
1559 scheduler.m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { scheduler.serviceQueue(); });
1560
1561 // Gather some entropy once per minute.
1562 scheduler.scheduleEvery([]{
1564 }, std::chrono::minutes{1});
1565
1566 // Check disk space every 5 minutes to avoid db corruption.
1567 scheduler.scheduleEvery([&args, &node]{
1568 constexpr uint64_t min_disk_space{50_MiB};
1570 LogError("Shutting down due to lack of disk space!\n");
1571 if (!(Assert(node.shutdown_request))()) {
1572 LogError("Failed to send shutdown signal after disk space check\n");
1573 }
1574 }
1575 }, std::chrono::minutes{5});
1576
1577 if (args.GetBoolArg("-logratelimit", BCLog::DEFAULT_LOGRATELIMIT)) {
1579 [&scheduler](auto func, auto window) { scheduler.scheduleEvery(std::move(func), window); },
1582 } else {
1583 LogInfo("Log rate limiting disabled");
1584 }
1585
1586 assert(!node.validation_signals);
1587 node.validation_signals = std::make_unique<ValidationSignals>(std::make_unique<SerialTaskRunner>(scheduler));
1588 auto& validation_signals = *node.validation_signals;
1589
1590 // Create KernelNotifications object. Important to do this early before
1591 // calling ipc->listenAddress() below so makeMining and other IPC methods
1592 // can use this.
1593 assert(!node.notifications);
1594 node.notifications = std::make_unique<KernelNotifications>(Assert(node.shutdown_request), node.exit_status, *Assert(node.warnings));
1595 ReadNotificationArgs(args, *node.notifications);
1596
1597 // Create client interfaces for wallets that are supposed to be loaded
1598 // according to -wallet and -disablewallet options. This only constructs
1599 // the interfaces, it doesn't load wallet data. Wallets actually get loaded
1600 // when load() and start() interface methods are called below.
1603
1604 if (interfaces::Ipc* ipc = node.init->ipc()) {
1605 for (const std::string& configured_address : gArgs.GetArgs("-ipcbind")) {
1607 Assert(listen_address); // Already validated in AppInitParameterInteraction.
1608 try {
1609 ipc->listenAddress(*listen_address);
1610 } catch (const std::exception& e) {
1611 return InitError(Untranslated(strprintf("Unable to bind to IPC address '%s'. %s", listen_address->address, e.what())));
1612 }
1613 LogInfo("Listening for IPC requests on address %s", listen_address->address);
1614 }
1615 }
1616
1617 /* Register RPC commands regardless of -server setting so they will be
1618 * available in the GUI RPC console even if external calls are disabled.
1619 */
1621 for (const auto& client : node.chain_clients) {
1622 client->registerRpcs();
1623 }
1624#ifdef ENABLE_ZMQ
1626#endif
1627
1628 // Check port numbers
1629 if (!CheckHostPortOptions(args)) return false;
1630
1631 // Configure reachable networks before we start the RPC server.
1632 // This is necessary for -rpcallowip to distinguish CJDNS from other RFC4193
1633 const auto onlynets = args.GetArgs("-onlynet");
1634 if (!onlynets.empty()) {
1636 for (const std::string& snet : onlynets) {
1637 enum Network net = ParseNetwork(snet);
1638 if (net == NET_UNROUTABLE)
1639 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1641 }
1642 }
1643
1644 if (!args.IsArgSet("-cjdnsreachable")) {
1645 if (!onlynets.empty() && g_reachable_nets.Contains(NET_CJDNS)) {
1646 return InitError(
1647 _("Outbound connections restricted to CJDNS (-onlynet=cjdns) but "
1648 "-cjdnsreachable is not provided"));
1649 }
1651 }
1652 // Now g_reachable_nets.Contains(NET_CJDNS) is true if:
1653 // 1. -cjdnsreachable is given and
1654 // 2.1. -onlynet is not given or
1655 // 2.2. -onlynet=cjdns is given
1656
1657 /* Start the RPC server already. It will be started in "warmup" mode
1658 * and not really process calls already (but it will signify connections
1659 * that the server is there and will be ready later). Warmup mode will
1660 * be disabled when initialisation is finished.
1661 */
1662 if (args.GetBoolArg("-server", false)) {
1664 if (!AppInitServers(node))
1665 return InitError(_("Unable to start HTTP server. See debug log for details."));
1666 }
1667
1668 // ********************************************************* Step 5: verify wallet database integrity
1669 for (const auto& client : node.chain_clients) {
1670 if (!client->verify()) {
1671 return false;
1672 }
1673 }
1674
1675 // ********************************************************* Step 6: network initialization
1676 // Note that we absolutely cannot open any actual connections
1677 // until the very end ("start node") as the UTXO/block state
1678 // is not yet setup and may end up being set up twice if we
1679 // need to reindex later.
1680
1681 fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
1682 fDiscover = args.GetBoolArg("-discover", true);
1683
1685 ApplyArgsManOptions(args, peerman_opts);
1686
1687 {
1688 // Read asmap file if configured or embedded asmap data and initialize
1689 // Netgroupman with or without it
1690 assert(!node.netgroupman);
1691 if (args.IsArgSet("-asmap") && !args.IsArgNegated("-asmap")) {
1692 if (!args.GetBoolArg("-asmap", false)) {
1693 fs::path asmap_path = args.GetPathArg("-asmap");
1694 if (!asmap_path.is_absolute()) {
1696 }
1697
1698 // If a specific path was passed with the asmap argument check if
1699 // the file actually exists in that location
1700 if (!fs::exists(asmap_path)) {
1701 InitError(strprintf(_("Could not find asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1702 return false;
1703 }
1704
1705 // If a file exists at the path, try to read the file
1706 std::vector<std::byte> asmap{DecodeAsmap(asmap_path)};
1707 if (asmap.empty()) {
1708 InitError(strprintf(_("Could not parse asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1709 return false;
1710 }
1711 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithLoadedAsmap(std::move(asmap)));
1712 } else {
1713 #ifdef ENABLE_EMBEDDED_ASMAP
1714 // Use the embedded asmap data
1715 std::span<const std::byte> asmap{node::data::ip_asn};
1716 if (asmap.empty() || !CheckStandardAsmap(asmap)) {
1717 InitError(strprintf(_("Could not read embedded asmap data")));
1718 return false;
1719 }
1720 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithEmbeddedAsmap(asmap));
1721 LogInfo("Opened asmap data (%zu bytes) from embedded byte array\n", asmap.size());
1722 #else
1723 // If there is no embedded data, fail and report it since
1724 // the user tried to use it
1725 InitError(strprintf(_("Embedded asmap data not available")));
1726 return false;
1727 #endif
1728 }
1729 LogInfo("Using asmap version %s for IP bucketing", HexStr(node.netgroupman->GetAsmapVersion()));
1730 } else {
1731 node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::NoAsmap());
1732 LogInfo("Using /16 prefix for IP bucketing");
1733 }
1734
1735 // Initialize addrman
1736 assert(!node.addrman);
1737 uiInterface.InitMessage(_("Loading P2P addresses…"));
1738 auto addrman{LoadAddrman(*node.netgroupman, args)};
1739 if (!addrman) return InitError(util::ErrorString(addrman));
1740 node.addrman = std::move(*addrman);
1741 }
1742
1744 assert(!node.banman);
1745 node.banman = std::make_unique<BanMan>(args.GetDataDirNet() / "banlist", &uiInterface, args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
1746 assert(!node.connman);
1747 node.connman = std::make_unique<CConnman>(rng.rand64(),
1748 rng.rand64(),
1749 *node.addrman, *node.netgroupman, chainparams, args.GetBoolArg("-networkactive", true));
1750
1751 for (const std::string& socket_addr : args.GetArgs("-bind")) {
1752 std::string host_out;
1753 uint16_t port_out{0};
1754 std::string bind_socket_addr = socket_addr.substr(0, socket_addr.rfind('='));
1756 return InitError(InvalidPortErrMsg("-bind", socket_addr));
1757 }
1758 }
1759
1760 // sanitize comments per BIP-0014, format user agent and check total size
1761 std::vector<std::string> uacomments;
1762 for (const std::string& cmt : args.GetArgs("-uacomment")) {
1764 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1765 uacomments.push_back(cmt);
1766 }
1768 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1769 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1771 }
1772
1773 // Requesting DNS seeds entails connecting to IPv4/IPv6, which -onlynet options may prohibit:
1774 // If -dnsseed=1 is explicitly specified, abort. If it's left unspecified by the user, we skip
1775 // the DNS seeds by adjusting -dnsseed in InitParameterInteraction.
1777 return InitError(strprintf(_("Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")));
1778 };
1779
1780 // Check for host lookup allowed before parsing any network related parameters
1782
1783 bool proxyRandomize = args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1784 // -proxy sets a proxy for outgoing network traffic, possibly per network.
1785 // -noproxy, -proxy=0 or -proxy="" can be used to remove the proxy setting, this is the default
1791 for (const std::string& param_value : args.GetArgs("-proxy")) {
1792 const auto eq_pos{param_value.rfind('=')};
1793 const std::string proxy_str{param_value.substr(0, eq_pos)}; // e.g. 127.0.0.1:9050=ipv4 -> 127.0.0.1:9050
1794 std::string net_str;
1795 if (eq_pos != std::string::npos) {
1796 if (eq_pos + 1 == param_value.length()) {
1797 return InitError(strprintf(_("Invalid -proxy address or hostname, ends with '=': '%s'"), param_value));
1798 }
1799 net_str = param_value.substr(eq_pos + 1); // e.g. 127.0.0.1:9050=ipv4 -> ipv4
1800 }
1801
1802 Proxy proxy;
1803 if (!proxy_str.empty() && proxy_str != "0") {
1805 proxy = Proxy{proxy_str, /*tor_stream_isolation=*/proxyRandomize};
1806 } else {
1807 const std::optional<CService> addr{Lookup(proxy_str, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1808 if (!addr.has_value()) {
1809 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1810 }
1811 proxy = Proxy{addr.value(), /*tor_stream_isolation=*/proxyRandomize};
1812 }
1813 if (!proxy.IsValid()) {
1814 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1815 }
1816 }
1817
1818 if (net_str.empty()) { // For all networks.
1820 } else {
1821 switch (ParseNetwork(net_str)) {
1822 case NET_IPV4: ipv4_proxy = name_proxy = proxy; break;
1823 case NET_IPV6: ipv6_proxy = name_proxy = proxy; break;
1824 case NET_ONION: onion_proxy = proxy; break;
1825 case NET_CJDNS: cjdns_proxy = proxy; break;
1826 case NET_UNROUTABLE:
1827 case NET_I2P:
1828 case NET_INTERNAL:
1829 case NET_MAX:
1830 return InitError(strprintf(_("Unrecognized network in -proxy='%s': '%s'"), param_value, net_str));
1831 } // no default case, so the compiler can warn about missing cases
1832 }
1833 }
1834 if (ipv4_proxy.IsValid()) {
1836 }
1837 if (ipv6_proxy.IsValid()) {
1839 }
1840 if (name_proxy.IsValid()) {
1842 }
1843 if (cjdns_proxy.IsValid()) {
1845 }
1846
1848
1849 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1850 // -noonion (or -onion=0) disables connecting to .onion entirely
1851 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1852 std::string onionArg = args.GetArg("-onion", "");
1853 if (onionArg != "") {
1854 if (onionArg == "0") { // Handle -noonion/-onion=0
1855 onion_proxy = Proxy{};
1857 return InitError(
1858 _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1859 "reaching the Tor network is explicitly forbidden: -onion=0"));
1860 }
1861 } else {
1863 onion_proxy = Proxy(onionArg, /*tor_stream_isolation=*/proxyRandomize);
1864 } else {
1865 const std::optional<CService> addr{Lookup(onionArg, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1866 if (!addr.has_value() || !addr->IsValid()) {
1867 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1868 }
1869
1870 onion_proxy = Proxy(addr.value(), /*tor_stream_isolation=*/proxyRandomize);
1871 }
1872 }
1873 }
1874
1875 const bool listenonion{args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
1876 if (onion_proxy.IsValid()) {
1878 } else {
1879 // If -listenonion is set, then we will (try to) connect to the Tor control port
1880 // later from the torcontrol thread and may retrieve the onion proxy from there.
1882 return InitError(
1883 _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1884 "reaching the Tor network is not provided: none of -proxy, -onion or "
1885 "-listenonion is given"));
1886 }
1888 }
1889
1890 for (const std::string& strAddr : args.GetArgs("-externalip")) {
1891 const std::optional<CService> addrLocal{Lookup(strAddr, GetListenPort(), fNameLookup)};
1892 if (addrLocal.has_value() && addrLocal->IsValid())
1893 AddLocal(addrLocal.value(), LOCAL_MANUAL, /*add_even_if_unreachable=*/true);
1894 else
1895 return InitError(ResolveErrMsg("externalip", strAddr));
1896 }
1897
1898#ifdef ENABLE_ZMQ
1900 [&chainman = node.chainman](std::vector<std::byte>& block, const CBlockIndex& index) {
1901 assert(chainman);
1902 if (auto ret{chainman->m_blockman.ReadRawBlock(WITH_LOCK(cs_main, return index.GetBlockPos()))}) {
1903 block = std::move(*ret);
1904 return true;
1905 }
1906 return false;
1907 });
1908
1910 validation_signals.RegisterValidationInterface(g_zmq_notification_interface.get());
1911 }
1912#endif
1913
1914 // ********************************************************* Step 7: load block chain
1915
1916 // cache size calculations
1919
1920 LogInfo("Cache configuration:");
1921 LogInfo("* Using %.1f MiB for block index database", kernel_cache_sizes.block_tree_db / double(1_MiB));
1922 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1923 LogInfo("* Using %.1f MiB for transaction index database", index_cache_sizes.tx_index / double(1_MiB));
1924 }
1925 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
1926 LogInfo("* Using %.1f MiB for transaction output spender index database", index_cache_sizes.txospender_index / double(1_MiB));
1927 }
1929 LogInfo("* Using %.1f MiB for %s block filter index database",
1930 index_cache_sizes.filter_index / double(1_MiB), BlockFilterTypeName(filter_type));
1931 }
1932 LogInfo("* Using %.1f MiB for chain state database", kernel_cache_sizes.coins_db / double(1_MiB));
1933
1934 assert(!node.mempool);
1935 assert(!node.chainman);
1936 assert(!node.block_template_manager);
1937
1938 bool do_reindex{args.GetBoolArg("-reindex", false)};
1939 const bool do_reindex_chainstate{args.GetBoolArg("-reindex-chainstate", false)};
1940
1941 // Chainstate initialization and loading may be retried once with reindexing by GUI users
1942 auto [status, error] = InitAndLoadChainstate(
1943 node,
1944 do_reindex,
1947 args);
1948 if (status == ChainstateLoadStatus::FAILURE && !do_reindex && !ShutdownRequested(node)) {
1949 // suggest a reindex
1950 bool do_retry{HasTestOption(args, "reindex_after_failure_noninteractive_yes") ||
1952 error + Untranslated(".\n\n") + _("Do you want to rebuild the databases now?"),
1953 error.original + (args.GetIntArg("-prune", 0) ? ".\nPlease restart with -reindex to recover." : ".\nPlease restart with -reindex or -reindex-chainstate to recover."),
1954 CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT)};
1955 if (!do_retry) {
1956 return false;
1957 }
1958 do_reindex = true;
1959 if (!Assert(node.shutdown_signal)->reset()) {
1960 LogError("Internal error: failed to reset shutdown signal.\n");
1961 }
1962 std::tie(status, error) = InitAndLoadChainstate(
1963 node,
1964 do_reindex,
1967 args);
1968 }
1969 if (status != ChainstateLoadStatus::SUCCESS && status != ChainstateLoadStatus::INTERRUPTED) {
1970 return InitError(error);
1971 }
1972
1973 // As LoadBlockIndex can take several minutes, it's possible the user
1974 // requested to kill the GUI during the last operation. If so, exit.
1975 if (ShutdownRequested(node)) {
1976 LogInfo("Shutdown requested. Exiting.");
1977 return true;
1978 }
1979
1980 ChainstateManager& chainman = *Assert(node.chainman);
1981
1982 assert(!node.fee_estimator_man);
1983 // Don't initialize fee estimation with old data if we don't relay transactions,
1984 // as they would never get updated.
1985 if (!peerman_opts.ignore_incoming_txs) {
1986 bool read_stale_estimates = args.GetBoolArg("-acceptstalefeeestimates", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES);
1987 if (read_stale_estimates && (chainparams.GetChainType() != ChainType::REGTEST)) {
1988 return InitError(strprintf(_("acceptstalefeeestimates is not supported on %s chain."), chainparams.GetChainTypeString()));
1989 }
1991 node.fee_estimator_man = std::make_unique<FeeRateEstimatorManager>(BlockPolicyFeeEstPath(args), read_stale_estimates, MempoolPolicyEstimatorPath(args), *Assert(node.mempool), chainman);
1992
1993 // Flush estimates to disk periodically
1994 FeeRateEstimatorManager* fee_estimator_man = node.fee_estimator_man.get();
1995 scheduler.scheduleEvery([fee_estimator_man] { fee_estimator_man->IntervalFlush(); }, FEE_FLUSH_INTERVAL);
1996 validation_signals.RegisterValidationInterface(fee_estimator_man);
1997 }
1998
1999 auto& kernel_notifications{*Assert(node.notifications)};
2000
2001 assert(!node.peerman);
2002 node.peerman = PeerManager::make(*node.connman, *node.addrman,
2003 node.banman.get(), chainman,
2004 *node.mempool, *node.warnings,
2005 peerman_opts);
2006 validation_signals.RegisterValidationInterface(node.peerman.get());
2007
2008 // ********************************************************* Step 8: start indexers
2009
2010 if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
2011 g_txindex = std::make_unique<TxIndex>(interfaces::MakeChain(node), index_cache_sizes.tx_index, false, do_reindex);
2012 node.indexes.emplace_back(g_txindex.get());
2013 }
2014
2015 if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
2016 g_txospenderindex = std::make_unique<TxoSpenderIndex>(interfaces::MakeChain(node), index_cache_sizes.txospender_index, false, do_reindex);
2017 node.indexes.emplace_back(g_txospenderindex.get());
2018 }
2019
2020 for (const auto& filter_type : g_enabled_filter_types) {
2022 node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
2023 }
2024
2025 if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
2026 g_coin_stats_index = std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /*cache_size=*/0, false, do_reindex);
2027 node.indexes.emplace_back(g_coin_stats_index.get());
2028 }
2029
2030 // Init indexes
2031 for (auto index : node.indexes) if (!index->Init()) return false;
2032
2033 // ********************************************************* Step 9: load wallet
2034 for (const auto& client : node.chain_clients) {
2035 if (!client->load()) {
2036 return false;
2037 }
2038 }
2039
2040 // ********************************************************* Step 10: data directory maintenance
2041
2042 // if pruning, perform the initial blockstore prune
2043 // after any wallet rescanning has taken place.
2044 if (chainman.m_blockman.IsPruneMode()) {
2045 if (chainman.m_blockman.m_blockfiles_indexed) {
2046 LOCK(cs_main);
2047 for (const auto& chainstate : chainman.m_chainstates) {
2048 uiInterface.InitMessage(_("Pruning blockstore…"));
2049 chainstate->PruneAndFlush();
2050 }
2051 }
2052 } else {
2053 // Prior to setting NODE_NETWORK, check if we can provide historical blocks.
2054 if (!WITH_LOCK(chainman.GetMutex(), return chainman.HistoricalChainstate())) {
2055 LogInfo("Setting NODE_NETWORK in non-prune mode");
2057 } else {
2058 LogInfo("Running node in NODE_NETWORK_LIMITED mode until snapshot background sync completes");
2059 }
2060 }
2061
2062 // ********************************************************* Step 11: import blocks
2063
2065 InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetDataDirNet()))));
2066 return false;
2067 }
2069 InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetBlocksDirPath()))));
2070 return false;
2071 }
2072
2073 int chain_active_height = WITH_LOCK(cs_main, return chainman.ActiveChain().Height());
2074
2075 // On first startup, warn on low block storage space
2077 uint64_t assumed_chain_bytes{chainparams.AssumedBlockchainSize() * 1_GiB};
2079 chainman.m_blockman.IsPruneMode() ?
2080 std::min(chainman.m_blockman.GetPruneTarget(), assumed_chain_bytes) :
2082
2085 "Disk space for %s may not accommodate the block files. " \
2086 "Approximately %u GiB of data will be stored in this directory."
2087 ),
2088 fs::quoted(fs::PathToString(args.GetBlocksDirPath())),
2090 ));
2091 }
2092 }
2093
2094#ifdef __APPLE__
2095 auto check_and_warn_fs{[&](const fs::path& path, std::string_view desc) {
2096 const auto path_desc{strprintf("%s (\"%s\")", desc, fs::PathToString(path))};
2097 switch (GetFilesystemType(path)) {
2098 case FSType::EXFAT:
2099 InitWarning(strprintf(_("The %s path uses exFAT, which is known to have intermittent corruption problems on macOS. "
2100 "Move this directory to a different filesystem to avoid data loss."), path_desc));
2101 break;
2102 case FSType::ERROR:
2103 LogInfo("Failed to detect filesystem type for %s", path_desc);
2104 break;
2105 case FSType::OTHER:
2106 break;
2107 }
2108 }};
2109
2110 check_and_warn_fs(args.GetDataDirNet(), "data directory");
2111 check_and_warn_fs(args.GetBlocksDirPath(), "blocks directory");
2112#endif
2113
2114#if HAVE_SYSTEM
2115 const std::string block_notify = args.GetArg("-blocknotify", "");
2116 if (!block_notify.empty()) {
2117 uiInterface.NotifyBlockTip.connect([block_notify](SynchronizationState sync_state, const CBlockIndex& block, double /* verification_progress */) {
2119 std::string command = block_notify;
2120 ReplaceAll(command, "%s", block.GetBlockHash().GetHex());
2121 std::thread t(runCommand, command);
2122 t.detach(); // thread runs free
2123 });
2124 }
2125#endif
2126
2127 std::vector<fs::path> vImportFiles;
2128 for (const std::string& strFile : args.GetArgs("-loadblock")) {
2129 vImportFiles.push_back(fs::PathFromString(strFile));
2130 }
2131
2133 node.background_init_thread = std::thread(&util::TraceThread, "initload", [=, &chainman, &args, &kernel_notifications, &node] {
2135 // Import blocks and ActivateBestChain()
2136 ImportBlocks(chainman, vImportFiles);
2137 // An interrupted import may return without activating genesis. Wake
2138 // the init thread's genesis wait, which is otherwise only notified
2139 // on blockTip, and that never fires when the import was interrupted
2140 // before activating genesis. This wakeup lets the wait observe the
2141 // shutdown request.
2142 WITH_LOCK(kernel_notifications.m_tip_block_mutex, kernel_notifications.m_tip_block_cv.notify_all());
2143 WITH_LOCK(::cs_main, chainman.UpdateIBDStatus());
2144 if (args.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
2145 LogInfo("Stopping after block import");
2146 if (!(Assert(node.shutdown_request))()) {
2147 LogError("Failed to send shutdown signal after finishing block import\n");
2148 }
2149 return;
2150 }
2151
2152 // Start indexes initial sync
2154 bilingual_str err_str = _("Failed to start indexes, shutting down…");
2156 return;
2157 }
2158 // Load mempool from disk
2159 if (auto* pool{chainman.ActiveChainstate().GetMempool()}) {
2160 const bool loaded{LoadMempool(*pool, ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{}, chainman.ActiveChainstate(), {})};
2161 // A shutdown request sets m_interrupt and aborts the mempool load, which is not a
2162 // load failure, so only notify the fee estimator when the load actually failed.
2163 if (node.fee_estimator_man && !chainman.m_interrupt && !loaded) {
2164 node.fee_estimator_man->MempoolLoadFailed();
2165 }
2166 pool->SetLoadTried(!chainman.m_interrupt);
2167 }
2168 });
2169
2170 /*
2171 * Wait for genesis block to be processed. Typically kernel_notifications.m_tip_block
2172 * has already been set by a call to LoadChainTip() in CompleteChainstateInitialization().
2173 * But this is skipped if the chainstate doesn't exist yet or is being wiped:
2174 *
2175 * 1. first startup with an empty datadir
2176 * 2. reindex
2177 * 3. reindex-chainstate
2178 *
2179 * In these case it's connected by a call to ActivateBestChain() in the initload thread.
2180 */
2181 {
2182 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
2183 kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
2184 return kernel_notifications.TipBlock() || ShutdownRequested(node);
2185 });
2186 }
2187
2188 if (ShutdownRequested(node)) {
2189 return true;
2190 }
2191
2192 // ********************************************************* Step 12: start node
2193
2195 {
2196 LOCK(chainman.GetMutex());
2197 const auto& tip{*Assert(chainman.ActiveTip())};
2198 LogInfo("block tree size = %u", chainman.BlockIndex().size());
2199 chain_active_height = tip.nHeight;
2200 best_block_time = tip.GetBlockTime();
2201 if (tip_info) {
2202 tip_info->block_height = chain_active_height;
2203 tip_info->block_time = best_block_time;
2204 tip_info->verification_progress = chainman.GuessVerificationProgress(&tip);
2205 }
2206 if (tip_info && chainman.m_best_header) {
2207 tip_info->header_height = chainman.m_best_header->nHeight;
2208 tip_info->header_time = chainman.m_best_header->GetBlockTime();
2209 }
2210 }
2211 LogInfo("nBestHeight = %d", chain_active_height);
2212 if (node.peerman) node.peerman->SetBestBlock(chain_active_height, std::chrono::seconds{best_block_time});
2213
2214 // Map ports with NAT-PMP
2216
2219 connOptions.m_max_automatic_connections = num_p2p_max_connections;
2220 connOptions.m_full_relay_inbound_percent = std::clamp<int>(args.GetIntArg("-inboundrelaypercent", DEFAULT_FULL_RELAY_INBOUND_PCT), 0, 100);
2221 connOptions.uiInterface = &uiInterface;
2222 connOptions.m_banman = node.banman.get();
2223 connOptions.m_msgproc = node.peerman.get();
2224 connOptions.nSendBufferMaxSize = 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
2225 connOptions.nReceiveFloodSize = 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
2226 for (const std::string& added_node : args.GetArgs("-addnode")) {
2227 // Such a value is not a valid connection target, but would otherwise be
2228 // treated as one and retried indefinitely.
2229 if (TrimStringView(added_node).empty()) {
2230 LogWarning("Ignoring empty -addnode value");
2231 continue;
2232 }
2233 connOptions.m_added_nodes.push_back(added_node);
2234 }
2235 connOptions.nMaxOutboundLimit = *opt_max_upload;
2236 connOptions.m_peer_connect_timeout = peer_connect_timeout;
2237 connOptions.whitelist_forcerelay = args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
2238 connOptions.whitelist_relay = args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
2239 connOptions.m_capture_messages = args.GetBoolArg("-capturemessages", false);
2240
2241 // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
2243 static_cast<uint16_t>(args.GetIntArg("-port", Params().GetDefaultPort()));
2244
2246
2247 const auto BadPortWarning = [](const char* prefix, uint16_t port) {
2248 return strprintf(_("%s request to listen on port %u. This port is considered \"bad\" and "
2249 "thus it is unlikely that any peer will connect to it. See "
2250 "doc/p2p-bad-ports.md for details and a full list."),
2251 prefix,
2252 port);
2253 };
2254
2255 for (const std::string& bind_arg : args.GetArgs("-bind")) {
2256 std::optional<CService> bind_addr;
2257 const size_t index = bind_arg.rfind('=');
2258 if (index == std::string::npos) {
2259 bind_addr = Lookup(bind_arg, default_bind_port, /*fAllowLookup=*/false);
2260 if (bind_addr.has_value()) {
2261 connOptions.vBinds.push_back(bind_addr.value());
2262 if (IsBadPort(bind_addr.value().GetPort())) {
2263 InitWarning(BadPortWarning("-bind", bind_addr.value().GetPort()));
2264 }
2265 continue;
2266 }
2267 } else {
2268 const std::string network_type = bind_arg.substr(index + 1);
2269 if (network_type == "onion") {
2270 const std::string truncated_bind_arg = bind_arg.substr(0, index);
2272 if (bind_addr.has_value()) {
2273 connOptions.onion_binds.push_back(bind_addr.value());
2274 continue;
2275 }
2276 }
2277 }
2278 return InitError(ResolveErrMsg("bind", bind_arg));
2279 }
2280
2281 for (const std::string& strBind : args.GetArgs("-whitebind")) {
2283 bilingual_str error;
2284 if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) return InitError(error);
2285 connOptions.vWhiteBinds.push_back(whitebind);
2286 }
2287
2288 // If the user did not specify -bind= or -whitebind= then we bind
2289 // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
2290 connOptions.bind_on_any = args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
2291
2292 // Emit a warning if a bad port is given to -port= but only if -bind and -whitebind are not
2293 // given, because if they are, then -port= is ignored.
2294 if (connOptions.bind_on_any && args.IsArgSet("-port")) {
2295 const uint16_t port_arg = args.GetIntArg("-port", 0);
2296 if (IsBadPort(port_arg)) {
2298 }
2299 }
2300
2302 if (!connOptions.onion_binds.empty()) {
2303 onion_service_target = connOptions.onion_binds.front();
2304 } else if (!connOptions.vBinds.empty()) {
2305 onion_service_target = connOptions.vBinds.front();
2306 } else {
2308 connOptions.onion_binds.push_back(onion_service_target);
2309 }
2310
2311 if (listenonion) {
2312 if (connOptions.onion_binds.size() > 1) {
2313 InitWarning(strprintf(_("More than one onion bind address is provided. Using %s "
2314 "for the automatically created Tor onion service."),
2315 onion_service_target.ToStringAddrPort()));
2316 }
2317 node.tor_controller = std::make_unique<TorController>(gArgs.GetArg("-torcontrol", DEFAULT_TOR_CONTROL), onion_service_target);
2318 }
2319
2320 bool should_discover = connOptions.bind_on_any;
2321 if (!should_discover) {
2322 for (const auto& bind : connOptions.vBinds) {
2323 if (bind.IsBindAny()) {
2324 should_discover = true;
2325 break;
2326 }
2327 }
2328 }
2329
2330 if (!should_discover) {
2331 for (const auto& whitebind : connOptions.vWhiteBinds) {
2332 if (whitebind.m_service.IsBindAny()) {
2333 should_discover = true;
2334 break;
2335 }
2336 }
2337 }
2338
2339 if (should_discover) {
2340 // Only add all IP addresses of the machine if we would be listening on
2341 // any address - 0.0.0.0 (IPv4) and :: (IPv6).
2342 Discover();
2343 }
2344
2345 for (const auto& net : args.GetArgs("-whitelist")) {
2348 bilingual_str error;
2349 if (!NetWhitelistPermissions::TryParse(net, subnet, connection_direction, error)) return InitError(error);
2351 connOptions.vWhitelistedRangeIncoming.push_back(subnet);
2352 }
2354 connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
2355 }
2356 }
2357
2358 connOptions.vSeedNodes = args.GetArgs("-seednode");
2359
2360 const auto connect = args.GetArgs("-connect");
2361 if (!connect.empty() || args.IsArgNegated("-connect")) {
2362 // Do not initiate other outgoing connections when connecting to trusted
2363 // nodes, or when -noconnect is specified.
2364 connOptions.m_use_addrman_outgoing = false;
2365
2366 if (connect.size() != 1 || connect[0] != "0") {
2367 connOptions.m_specified_outgoing = connect;
2368 }
2369 if (!connOptions.m_specified_outgoing.empty() && !connOptions.vSeedNodes.empty()) {
2370 LogInfo("-seednode is ignored when -connect is used");
2371 }
2372
2373 if (args.IsArgSet("-dnsseed") && args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED) && args.IsArgSet("-proxy")) {
2374 LogInfo("-dnsseed is ignored when -connect is used and -proxy is specified");
2375 }
2376 }
2377
2378 const std::string& i2psam_arg = args.GetArg("-i2psam", "");
2379 if (!i2psam_arg.empty()) {
2380 const std::optional<CService> addr{Lookup(i2psam_arg, 7656, fNameLookup)};
2381 if (!addr.has_value() || !addr->IsValid()) {
2382 return InitError(strprintf(_("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
2383 }
2384 SetProxy(NET_I2P, Proxy{addr.value()});
2385 } else {
2386 if (!onlynets.empty() && g_reachable_nets.Contains(NET_I2P)) {
2387 return InitError(
2388 _("Outbound connections restricted to i2p (-onlynet=i2p) but "
2389 "-i2psam is not provided"));
2390 }
2392 }
2393
2394 connOptions.m_i2p_accept_incoming = args.GetBoolArg("-i2pacceptincoming", DEFAULT_I2P_ACCEPT_INCOMING);
2395
2397 return InitError(strprintf(
2398 _("Duplicate binding configuration for address %s. "
2399 "Please check your -bind, -bind=...=onion and -whitebind settings."),
2400 conflict->ToStringAddrPort()));
2401 }
2402
2403 if (args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)) {
2404 // If -listenonion is set, then NET_ONION may not be reachable now
2405 // but may become reachable later, thus only error here if it is not
2406 // reachable and will not become reachable for sure.
2411 return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2412 "but none of Tor or I2P networks is reachable"));
2413 }
2414 if (!connOptions.m_use_addrman_outgoing) {
2415 return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2416 "but -connect is also configured. They are incompatible because the "
2417 "private broadcast needs to open new connections to randomly "
2418 "chosen Tor or I2P peers. Consider using -maxconnections=0 -addnode=... "
2419 "instead"));
2420 }
2422 InitWarning(_("Private broadcast of own transactions requested (-privatebroadcast) and "
2423 "-proxyrandomize is disabled. Tor circuits for private broadcast connections "
2424 "may be correlated to other connections over Tor. To reduce this risk, set "
2425 "-proxyrandomize=1."));
2426 }
2427 }
2428
2429 if (!node.connman->Start(scheduler, connOptions)) {
2430 return false;
2431 }
2432
2433 // ********************************************************* Step 13: finished
2434
2435 // At this point, the RPC is "started", but still in warmup, which means it
2436 // cannot yet be called. Before we make it callable, we need to make sure
2437 // that the RPC's view of the best block is valid and consistent with
2438 // ChainstateManager's active tip.
2440
2441 uiInterface.InitMessage(_("Done loading"));
2442
2443 for (const auto& client : node.chain_clients) {
2444 client->start(scheduler);
2445 }
2446
2447 BanMan* banman = node.banman.get();
2448 scheduler.scheduleEvery([banman]{
2449 banman->DumpBanlist();
2451
2452 if (node.peerman) node.peerman->StartScheduledTasks(scheduler);
2453
2454#if HAVE_SYSTEM
2456#endif
2457
2458 return true;
2459}
2460
2462{
2463 ChainstateManager& chainman = *Assert(node.chainman);
2464 const Chainstate& chainstate = WITH_LOCK(::cs_main, return chainman.ValidatedChainstate());
2465 const CChain& index_chain = chainstate.m_chain;
2466 const int current_height = WITH_LOCK(::cs_main, return index_chain.Height());
2467
2468 // Skip checking data availability if we have not synced any blocks yet
2469 if (current_height > 0) {
2470 // Before starting index sync, verify that all required block data is available
2471 // on disk from each index's current sync position up to the chain tip.
2472 //
2473 // This is done separately for undo and block data: First we verify block + undo
2474 // data existence from tip down to the lowest height required by any index that
2475 // needs undo data (e.g., coinstatsindex, blockfilterindex). Then, if any
2476 // block-only index needs to sync from a lower height than previously covered,
2477 // verify block data existence down to that lower height.
2478 //
2479 // This avoids checking undo data for blocks where no index requires it,
2480 // though currently block and undo data availability are synchronized on disk
2481 // under normal circumstances.
2482 std::optional<const CBlockIndex*> block_start;
2483 std::string block_start_name;
2484 std::optional<const CBlockIndex*> undo_start;
2485 std::string undo_start_name;
2486
2487 for (const auto& index : node.indexes) {
2488 const IndexSummary& summary = index->GetSummary();
2489 if (summary.synced) continue;
2490
2491 // Get the last common block between the index best block and the active chain
2492 const CBlockIndex* pindex = nullptr;
2493 {
2494 LOCK(::cs_main);
2495 pindex = chainman.m_blockman.LookupBlockIndex(summary.best_block_hash);
2496 if (!pindex) {
2497 LogWarning("Failed to find block manager entry for best block %s from %s, falling back to genesis for index sync",
2498 summary.best_block_hash.ToString(), summary.name);
2499 } else if (!index_chain.Contains(*pindex)) {
2500 pindex = index_chain.FindFork(*pindex);
2501 }
2502 }
2503 if (!pindex) {
2504 pindex = index_chain.Genesis();
2505 }
2506
2507 bool need_undo = index->CustomOptions().connect_undo_data;
2510
2511 if (op_start_index && pindex->nHeight >= op_start_index.value()->nHeight) continue;
2512 op_start_index = pindex;
2513 name_index = summary.name;
2514 }
2515
2516 // Verify all blocks needed to sync to current tip are present including undo data.
2517 if (undo_start) {
2518 LOCK(::cs_main);
2519 if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(undo_start.value()), BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO})) {
2520 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)));
2521 }
2522 }
2523
2524 // Verify all blocks needed to sync to current tip are present unless we already checked all of them above.
2525 if (block_start && !(undo_start && undo_start.value()->nHeight <= block_start.value()->nHeight)) {
2526 LOCK(::cs_main);
2527 if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(block_start.value()), BlockStatus{BLOCK_HAVE_DATA})) {
2528 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)));
2529 }
2530 }
2531 }
2532
2533 // Start threads
2534 for (auto index : node.indexes) if (!index->StartBackgroundSync()) return false;
2535 return true;
2536}
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:829
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition args.cpp:801
const char *const BITCOIN_SETTINGS_FILENAME
Definition args.cpp:37
ArgsManager gArgs
Definition args.cpp:39
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:835
const char *const BITCOIN_CONF_FILENAME
Definition args.cpp:36
fs::path AbsPathForConfigVal(const ArgsManager &args, const fs::path &path, bool net_specific=true)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
Definition 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
if(!SetupNetworking())
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.
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const ArgsManager &args, const ChainType chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 48334, 18445) have been chosen arbitra...
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:119
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:423
ChainType GetChainType() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Returns the appropriate chain type from the program arguments.
Definition args.cpp:894
@ NETWORK_ONLY
Definition args.h:123
@ ALLOW_ANY
disable validation
Definition args.h:109
@ DISALLOW_NEGATION
disallow -nofoo syntax
Definition args.h:114
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition args.h:115
@ DEBUG_ONLY
Definition args.h:117
@ SENSITIVE
Definition args.h:125
std::list< SectionInfo > GetUnrecognizedSections() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Log warnings for unrecognized section names in the config file.
Definition args.cpp:153
fs::path GetBlocksDirPath() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get blocks directory path.
Definition args.cpp:299
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:595
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:133
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:293
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:518
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:432
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:603
fs::path GetDataDirNet() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get data directory path with appended network identifier.
Definition args.cpp:329
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:513
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Definition args.h:318
bool GetBoolArg(const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return boolean argument or default value.
Definition args.cpp:561
static std::shared_ptr< LogRateLimiter > Create(SchedulerFunction &&scheduler_func, uint64_t max_bytes, std::chrono::seconds reset_window)
Definition logging.cpp:390
void SetRateLimiting(std::shared_ptr< LogRateLimiter > limiter) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Definition logging.h:210
std::atomic< bool > m_reopen_file
Definition logging.h:178
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
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.
Signals for UI communication.
btcsignals::signal< void(const std::string &message)> InitMessage
Progress message during initialization.
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.
btcsignals::signal< void()> InitWallet
Wallet loader created.
btcsignals::signal< void(const bilingual_str &message, unsigned int style)> ThreadSafeMessageBox
Show message box.
btcsignals::signal< void(SynchronizationState, const CBlockIndex &block, double verification_progress)> NotifyBlockTip
New block has been accepted.
A combination of a network address (CNetAddr) and a (TCP) port.
Definition netaddress.h:531
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:550
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition validation.h:950
Chainstate * HistoricalChainstate() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return historical chainstate targeting a specific block, if any.
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
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
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
const util::SignalInterrupt & m_interrupt
Chainstate & ValidatedChainstate() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return fully validated chainstate that should be used for indexing, to support indexes that need to i...
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
void UpdateIBDStatus() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Update and possibly latch the IBD status.
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
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.
void IntervalFlush()
Flush recorded data to disk.
Definition init.h:13
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)
bool IsValid() const
Definition netbase.h:73
void Add(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition netbase.h:100
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition netbase.h:128
void Remove(Network net) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition netbase.h:107
void RemoveAll() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition netbase.h:114
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 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:55
static util::Result< ipc::ListenAddress > parseListenAddress(std::string address)
Parse an IPC listening address and its per-listener options.
Definition listen.cpp:29
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...
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.
std::atomic_bool m_blockfiles_indexed
Whether all blockfiles have been added to the block tree database.
uint64_t GetPruneTarget() const
Attempt to stay below this number of bytes of block files.
kernel::BlockManagerOpts Options
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.
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
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:82
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition cs_main.cpp:8
const WalletInitInterface & g_wallet_init_interface
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
const std::string CURRENCY_UNIT
Definition feerate.h:19
static auto quoted(const std::string &s)
Definition fs.h:104
static bool exists(const path &p)
Definition fs.h:94
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition fs.h:160
int RaiseFileDescriptorLimit(int min_fd)
Try to raise the file descriptor limit to the requested number.
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
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:353
void StopHTTPRPC()
Stop HTTP RPC subsystem.
Definition httprpc.cpp:358
bool StartHTTPRPC(const std::any &context)
Start HTTP RPC subsystem.
Definition httprpc.cpp:339
void StartREST(const std::any &context)
Start HTTP REST subsystem.
Definition rest.cpp:1216
void StopREST()
Stop HTTP REST subsystem.
Definition rest.cpp:1228
void InterruptREST()
Interrupt RPC REST subsystem.
Definition rest.cpp:1224
void InterruptHTTPServer()
Interrupt HTTP server threads.
void StartHTTPServer()
Start HTTP server.
bool InitHTTPServer()
Initialize HTTP server.
void StopHTTPServer()
Stop HTTP server.
constexpr int DEFAULT_MAX_HTTP_CONNECTIONS
Maximum number of connected HTTP clients.
Definition httpserver.h:47
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:1258
static const char * BITCOIN_PID_FILENAME
The PID file facilities.
Definition init.cpp:191
static bool CreatePidFile(const ArgsManager &args)
Definition init.cpp:203
static bool g_generated_pid
True if this process has created a PID file.
Definition init.cpp:196
static std::optional< util::SignalInterrupt > g_shutdown
Definition init.cpp:231
static void RemovePidFile(const ArgsManager &args)
Definition init.cpp:221
void Interrupt(NodeContext &node)
Interrupt threads.
Definition init.cpp:288
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition init.cpp:880
static bool AppInitServers(NodeContext &node)
Definition init.cpp:775
static bool LockDirectories(bool probeOnly)
Definition init.cpp:1270
static constexpr int MIN_CORE_FDS
Definition init.cpp:186
void Shutdown(NodeContext &node)
Definition init.cpp:310
static void HandleSIGTERM(int)
Signal handlers are very limited in what they are allowed to do.
Definition init.cpp:445
static void HandleSIGHUP(int)
Definition init.cpp:452
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin core: Basic context setup.
Definition init.cpp:909
static fs::path GetPidFile(const ArgsManager &args)
Definition init.cpp:198
static constexpr bool DEFAULT_PROXYRANDOMIZE
Definition init.cpp:172
bool CheckHostPortOptions(const ArgsManager &args)
Definition init.cpp:1313
static std::optional< CService > CheckBindingConflicts(const CConnman::Options &conn_options)
Checks for duplicate bindings across all binding configurations.
Definition init.cpp:1368
static ChainstateLoadResult InitAndLoadChainstate(NodeContext &node, bool do_reindex, const bool do_reindex_chainstate, const kernel::CacheSizes &cache_sizes, const ArgsManager &args)
Definition init.cpp:1398
bool ShutdownRequested(node::NodeContext &node)
Return whether node shutdown was requested.
Definition init.cpp:270
bool StartIndexBackgroundSync(NodeContext &node)
Validates requirements to run the indexes and spawns each index initial sync thread.
Definition init.cpp:2461
bool AppInitParameterInteraction(const ArgsManager &args)
Initialization: parameter interaction.
Definition init.cpp:946
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition init.cpp:1307
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT
Definition init.cpp:175
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition init.cpp:791
static constexpr bool DEFAULT_REST_ENABLE
Definition init.cpp:173
#define MIN_LEVELDB_FDS
Definition init.cpp:183
static void registerSignalHandler(int signal, void(*handler)(int))
Definition init.cpp:469
bool AppInitMain(NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin core main initialization.
Definition init.cpp:1523
static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING
Definition init.cpp:174
bool AppInitLockDirectories()
Lock bitcoin core critical directories.
Definition init.cpp:1295
void SetupServerArgs(ArgsManager &argsman, bool can_listen_ipc)
Register all arguments with the ArgsManager.
Definition init.cpp:479
void InitContext(NodeContext &node)
Initialize node context shutdown and args variables.
Definition init.cpp:233
static void new_handler_terminate()
Definition init.cpp:896
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition init.cpp:1276
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.
is a home for public enum and struct type definitions that are used internally by ipc code,...
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:437
std::unique_ptr< ProxyClient< messages::FooInterface > > client
#define LogWarning(...)
Definition log.h:137
#define LogInfo(...)
Definition log.h:136
#define LogError(...)
Definition log.h:138
#define LogDebug(category,...)
Definition log.h:154
BCLog::Logger & LogInstance()
Definition logging.cpp:27
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.
is a home for simple string functions returning descriptive messages that are used in RPC and GUI int...
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
bilingual_str ResolveErrMsg(const std::string &optname, const std::string &strBind)
Definition messages.cpp:156
bilingual_str InvalidPortErrMsg(const std::string &optname, const std::string &invalid_value)
Definition messages.cpp:161
void AddLoggingArgs(ArgsManager &argsman)
Definition common.cpp:29
util::Result< void > SetLoggingCategories(const ArgsManager &args)
Definition common.cpp:81
bool StartLogging(const ArgsManager &args)
Definition common.cpp:109
util::Result< void > SetLoggingLevel(const ArgsManager &args)
Definition common.cpp:62
void SetLoggingOptions(const ArgsManager &args)
Definition common.cpp:48
void LogPackageVersion()
Definition common.cpp:150
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
Definition ipc.h:17
constexpr size_t MAX_CONNECTIONS
Maximum accepted client connection limit for an IPC listening socket.
Definition types.h:27
constexpr size_t DEFAULT_MAX_CONNECTIONS
Default accepted client connection limit for each IPC listening socket.
Definition types.h:22
constexpr bool DEFAULT_XOR_BLOCKSDIR
util::Result< void > SanityChecks(const Context &)
Ensure a usable environment with all necessary library support.
Definition checks.cpp:15
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.
bool ShouldPersistMempool(const ArgsManager &argsman)
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
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.
void ThreadRename(const std::string &)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name.
bilingual_str ErrorString(const Result< T > &result)
Definition result.h:93
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_view TrimStringView(std::string_view str LIFETIMEBOUND, std::string_view pattern=" \f\n\r\t\v")
Definition string.h:163
void ReplaceAll(std::string &in_out, std::string_view search, std::string_view substitute)
Replace every non-overlapping occurrence of search with substitute, treating both literally; the repl...
Definition string.cpp:14
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition string.h:250
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition string.h:209
LockResult LockDirectory(const fs::path &directory, const fs::path &lockfile_name, bool probe_only)
uint16_t GetListenPort()
Definition net.cpp:141
bool fDiscover
Definition net.cpp:119
bool fListen
Definition net.cpp:120
std::string strSubVersion
Subversion as sent to the P2P network in version messages.
Definition net.cpp:123
bool AddLocal(const CService &addr_, int nScore, bool add_even_if_unreachable)
Definition net.cpp:280
void Discover()
Look up IP addresses from all interfaces on the machine and add them to the list of local addresses t...
Definition net.cpp:3470
constexpr bool DEFAULT_LISTEN
-listen default
Definition net.h:80
constexpr bool DEFAULT_PRIVATE_BROADCAST
Default for -privatebroadcast.
Definition net.h:94
constexpr unsigned int MAX_SUBVERSION_LENGTH
Maximum length of the user agent string in version message.
Definition net.h:68
constexpr int MAX_FEELER_CONNECTIONS
Maximum number of feeler connections.
Definition net.h:76
constexpr bool DEFAULT_BLOCKSONLY
Default for blocks only.
Definition net.h:90
constexpr int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition net.h:72
constexpr size_t DEFAULT_MAXSENDBUFFER
Definition net.h:104
constexpr bool DEFAULT_FIXEDSEEDS
Definition net.h:102
constexpr unsigned int DEFAULT_MAX_PEER_CONNECTIONS
The maximum number of peer connections to maintain.
Definition net.h:82
constexpr int64_t DEFAULT_PEER_CONNECT_TIMEOUT
-peertimeout default
Definition net.h:92
constexpr size_t DEFAULT_MAXRECEIVEBUFFER
Definition net.h:103
const std::string DEFAULT_MAX_UPLOAD_TARGET
The default for -maxuploadtarget.
Definition net.h:88
constexpr bool DEFAULT_FORCEDNSSEED
Definition net.h:100
constexpr size_t MAX_PRIVATE_BROADCAST_CONNECTIONS
Maximum number of private broadcast connections.
Definition net.h:78
constexpr bool DEFAULT_DNSSEED
Definition net.h:101
constexpr int MAX_BLOCK_RELAY_ONLY_CONNECTIONS
Maximum number of block-relay-only outgoing connections.
Definition net.h:74
constexpr int NUM_FDS_MESSAGE_CAPTURE
Number of file descriptors required for message capture.
Definition net.h:96
constexpr int DEFAULT_FULL_RELAY_INBOUND_PCT
Default percentage of inbound connection slots that tx-relaying peers can use.
Definition net.h:86
@ LOCAL_MANUAL
Definition net.h:163
constexpr bool DEFAULT_V2_TRANSPORT
Definition net.h:106
constexpr int MAX_PEER_CONNECTIONS
Maximum value of -maxconnections.
Definition net.h:84
constexpr int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS
Maximum number of automatic outgoing nodes over which we'll relay everything (blocks,...
Definition net.h:70
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_MAX
Dummy value to indicate the number of NET_* constants.
Definition netaddress.h:57
@ 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
@ NET_INTERNAL
A set of addresses that represent the hash of a string or FQDN.
Definition netaddress.h:54
std::string GetNetworkName(enum Network net)
Definition netbase.cpp:114
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
constexpr auto CeilDiv(const Dividend dividend, const Divisor divisor)
Integer ceiling division (for unsigned values).
Definition overflow.h:70
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:1197
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition rest.cpp:1198
const char * name
Definition rest.cpp:71
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:49
constexpr bool DEFAULT_RPC_DOC_CHECK
Definition util.h:44
void SetRPCWarmupFinished()
Definition server.cpp:700
void StartRPC()
Definition server.cpp:649
void StopRPC()
Definition server.cpp:666
void InterruptRPC()
Definition server.cpp:655
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
Definition server.cpp:688
CRPCTable tableRPC
Definition server.cpp:1002
void RpcInterruptionPoint()
Throw JSONRPCError if RPC is not running.
Definition server.cpp:683
constexpr size_t DEFAULT_VALIDATION_CACHE_BYTES
Definition sigcache.h:29
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
ServiceFlags m_local_services
Definition net.h:1095
Application-specific storage settings.
Definition dbwrapper.h:43
fs::path path
Location in the filesystem where leveldb data will be stored.
Definition dbwrapper.h:45
Bilingual messages:
Definition translation.h:24
bool empty() const
Definition translation.h:35
std::string original
Definition translation.h:25
Block and header tip information.
Definition node.h:46
const CChainParams & chainparams
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:57
#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
#define EXCLUSIVE_LOCKS_REQUIRED(...)
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
const std::string DEFAULT_TOR_CONTROL
Default control ip and port.
CService DefaultOnionServiceTarget(uint16_t port)
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
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 SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
void SetMockTime(std::chrono::time_point< NodeClock, std::chrono::seconds > mock)
Definition time.cpp:52
constexpr auto Ticks(Dur2 d)
Helper to count the seconds of a duration/time_point.
Definition time.h:82
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
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
std::unique_ptr< CZMQNotificationInterface > g_zmq_notification_interface
void RegisterZMQRPCCommands(CRPCTable &t)
Definition zmqrpc.cpp:68