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