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