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