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