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