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