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