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