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