Bitcoin Core  24.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-2021 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 <consensus/amount.h>
22 #include <deploymentstatus.h>
23 #include <fs.h>
24 #include <hash.h>
25 #include <httprpc.h>
26 #include <httpserver.h>
27 #include <index/blockfilterindex.h>
28 #include <index/coinstatsindex.h>
29 #include <index/txindex.h>
30 #include <init/common.h>
31 #include <interfaces/chain.h>
32 #include <interfaces/init.h>
33 #include <interfaces/node.h>
34 #include <mapport.h>
35 #include <net.h>
36 #include <net_permissions.h>
37 #include <net_processing.h>
38 #include <netbase.h>
39 #include <netgroup.h>
40 #include <node/blockstorage.h>
41 #include <node/caches.h>
42 #include <node/chainstate.h>
43 #include <node/context.h>
44 #include <node/interface_ui.h>
45 #include <node/mempool_args.h>
47 #include <node/miner.h>
49 #include <policy/feerate.h>
50 #include <policy/fees.h>
51 #include <policy/fees_args.h>
52 #include <policy/policy.h>
53 #include <policy/settings.h>
54 #include <protocol.h>
55 #include <rpc/blockchain.h>
56 #include <rpc/register.h>
57 #include <rpc/server.h>
58 #include <rpc/util.h>
59 #include <scheduler.h>
60 #include <script/sigcache.h>
61 #include <script/standard.h>
62 #include <shutdown.h>
63 #include <sync.h>
64 #include <timedata.h>
65 #include <torcontrol.h>
66 #include <txdb.h>
67 #include <txmempool.h>
68 #include <txorphanage.h>
69 #include <util/asmap.h>
70 #include <util/check.h>
71 #include <util/moneystr.h>
72 #include <util/strencodings.h>
73 #include <util/string.h>
74 #include <util/syscall_sandbox.h>
75 #include <util/syserror.h>
76 #include <util/system.h>
77 #include <util/thread.h>
78 #include <util/threadnames.h>
79 #include <util/translation.h>
80 #include <validation.h>
81 #include <validationinterface.h>
82 #include <walletinitinterface.h>
83 
84 #include <algorithm>
85 #include <condition_variable>
86 #include <cstdint>
87 #include <cstdio>
88 #include <fstream>
89 #include <functional>
90 #include <set>
91 #include <string>
92 #include <thread>
93 #include <vector>
94 
95 #ifndef WIN32
96 #include <cerrno>
97 #include <signal.h>
98 #include <sys/stat.h>
99 #endif
100 
101 #include <boost/signals2/signal.hpp>
102 
103 #if ENABLE_ZMQ
104 #include <zmq/zmqabstractnotifier.h>
106 #include <zmq/zmqrpc.h>
107 #endif
108 
109 using kernel::DumpMempool;
111 
113 using node::CacheSizes;
119 using node::MempoolPath;
121 using node::NodeContext;
122 using node::ThreadImport;
124 using node::fPruneMode;
125 using node::fReindex;
126 using node::nPruneTarget;
127 
128 static const bool DEFAULT_PROXYRANDOMIZE = true;
129 static const bool DEFAULT_REST_ENABLE = false;
130 
131 #ifdef WIN32
132 // Win32 LevelDB doesn't use filedescriptors, and the ones used for
133 // accessing block files don't count towards the fd_set size limit
134 // anyway.
135 #define MIN_CORE_FILEDESCRIPTORS 0
136 #else
137 #define MIN_CORE_FILEDESCRIPTORS 150
138 #endif
139 
140 static const char* DEFAULT_ASMAP_FILENAME="ip_asn.map";
141 
145 static const char* BITCOIN_PID_FILENAME = "bitcoind.pid";
146 
148 {
150 }
151 
152 [[nodiscard]] static bool CreatePidFile(const ArgsManager& args)
153 {
154  std::ofstream file{GetPidFile(args)};
155  if (file) {
156 #ifdef WIN32
157  tfm::format(file, "%d\n", GetCurrentProcessId());
158 #else
159  tfm::format(file, "%d\n", getpid());
160 #endif
161  return true;
162  } else {
163  return InitError(strprintf(_("Unable to create the PID file '%s': %s"), fs::PathToString(GetPidFile(args)), SysErrorString(errno)));
164  }
165 }
166 
168 //
169 // Shutdown
170 //
171 
172 //
173 // Thread management and startup/shutdown:
174 //
175 // The network-processing threads are all part of a thread group
176 // created by AppInit() or the Qt main() function.
177 //
178 // A clean exit happens when StartShutdown() or the SIGTERM
179 // signal handler sets ShutdownRequested(), which makes main thread's
180 // WaitForShutdown() interrupts the thread group.
181 // And then, WaitForShutdown() makes all other on-going threads
182 // in the thread group join the main thread.
183 // Shutdown() is then called to clean up database connections, and stop other
184 // threads that should only be stopped after the main network-processing
185 // threads have exited.
186 //
187 // Shutdown for Qt is very similar, only it uses a QTimer to detect
188 // ShutdownRequested() getting set, and then does the normal Qt
189 // shutdown thing.
190 //
191 
193 {
196  InterruptRPC();
197  InterruptREST();
200  if (node.connman)
201  node.connman->Interrupt();
202  if (g_txindex) {
203  g_txindex->Interrupt();
204  }
205  ForEachBlockFilterIndex([](BlockFilterIndex& index) { index.Interrupt(); });
206  if (g_coin_stats_index) {
207  g_coin_stats_index->Interrupt();
208  }
209 }
210 
212 {
213  static Mutex g_shutdown_mutex;
214  TRY_LOCK(g_shutdown_mutex, lock_shutdown);
215  if (!lock_shutdown) return;
216  LogPrintf("%s: In progress...\n", __func__);
217  Assert(node.args);
218 
223  util::ThreadRename("shutoff");
224  if (node.mempool) node.mempool->AddTransactionsUpdated(1);
225 
226  StopHTTPRPC();
227  StopREST();
228  StopRPC();
229  StopHTTPServer();
230  for (const auto& client : node.chain_clients) {
231  client->flush();
232  }
233  StopMapPort();
234 
235  // Because these depend on each-other, we make sure that neither can be
236  // using the other before destroying them.
237  if (node.peerman) UnregisterValidationInterface(node.peerman.get());
238  if (node.connman) node.connman->Stop();
239 
240  StopTorControl();
241 
242  // After everything has been shut down, but before things get flushed, stop the
243  // CScheduler/checkqueue, scheduler and load block thread.
244  if (node.scheduler) node.scheduler->stop();
245  if (node.chainman && node.chainman->m_load_block.joinable()) node.chainman->m_load_block.join();
247 
248  // After the threads that potentially access these pointers have been stopped,
249  // destruct and reset all to nullptr.
250  node.peerman.reset();
251  node.connman.reset();
252  node.banman.reset();
253  node.addrman.reset();
254  node.netgroupman.reset();
255 
256  if (node.mempool && node.mempool->GetLoadTried() && ShouldPersistMempool(*node.args)) {
257  DumpMempool(*node.mempool, MempoolPath(*node.args));
258  }
259 
260  // Drop transactions we were still watching, and record fee estimations.
261  if (node.fee_estimator) node.fee_estimator->Flush();
262 
263  // FlushStateToDisk generates a ChainStateFlushed callback, which we should avoid missing
264  if (node.chainman) {
265  LOCK(cs_main);
266  for (Chainstate* chainstate : node.chainman->GetAll()) {
267  if (chainstate->CanFlushToDisk()) {
268  chainstate->ForceFlushStateToDisk();
269  }
270  }
271  }
272 
273  // After there are no more peers/RPC left to give us new data which may generate
274  // CValidationInterface callbacks, flush them...
276 
277  // Stop and delete all indexes only after flushing background callbacks.
278  if (g_txindex) {
279  g_txindex->Stop();
280  g_txindex.reset();
281  }
282  if (g_coin_stats_index) {
283  g_coin_stats_index->Stop();
284  g_coin_stats_index.reset();
285  }
286  ForEachBlockFilterIndex([](BlockFilterIndex& index) { index.Stop(); });
288 
289  // Any future callbacks will be dropped. This should absolutely be safe - if
290  // missing a callback results in an unrecoverable situation, unclean shutdown
291  // would too. The only reason to do the above flushes is to let the wallet catch
292  // up with our current chain to avoid any strange pruning edge cases and make
293  // next startup faster by avoiding rescan.
294 
295  if (node.chainman) {
296  LOCK(cs_main);
297  for (Chainstate* chainstate : node.chainman->GetAll()) {
298  if (chainstate->CanFlushToDisk()) {
299  chainstate->ForceFlushStateToDisk();
300  chainstate->ResetCoinsViews();
301  }
302  }
303  }
304  for (const auto& client : node.chain_clients) {
305  client->stop();
306  }
307 
308 #if ENABLE_ZMQ
313  }
314 #endif
315 
316  node.chain_clients.clear();
319  node.kernel.reset();
320  node.mempool.reset();
321  node.fee_estimator.reset();
322  node.chainman.reset();
323  node.scheduler.reset();
324 
325  try {
326  if (!fs::remove(GetPidFile(*node.args))) {
327  LogPrintf("%s: Unable to remove PID file: File does not exist\n", __func__);
328  }
329  } catch (const fs::filesystem_error& e) {
330  LogPrintf("%s: Unable to remove PID file: %s\n", __func__, fsbridge::get_filesystem_error_message(e));
331  }
332 
333  LogPrintf("%s: done\n", __func__);
334 }
335 
341 #ifndef WIN32
342 static void HandleSIGTERM(int)
343 {
344  StartShutdown();
345 }
346 
347 static void HandleSIGHUP(int)
348 {
349  LogInstance().m_reopen_file = true;
350 }
351 #else
352 static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType)
353 {
354  StartShutdown();
355  Sleep(INFINITE);
356  return true;
357 }
358 #endif
359 
360 #ifndef WIN32
361 static void registerSignalHandler(int signal, void(*handler)(int))
362 {
363  struct sigaction sa;
364  sa.sa_handler = handler;
365  sigemptyset(&sa.sa_mask);
366  sa.sa_flags = 0;
367  sigaction(signal, &sa, nullptr);
368 }
369 #endif
370 
371 static boost::signals2::connection rpc_notify_block_change_connection;
372 static void OnRPCStarted()
373 {
374  rpc_notify_block_change_connection = uiInterface.NotifyBlockTip_connect(std::bind(RPCNotifyBlockChange, std::placeholders::_2));
375 }
376 
377 static void OnRPCStopped()
378 {
380  RPCNotifyBlockChange(nullptr);
381  g_best_block_cv.notify_all();
382  LogPrint(BCLog::RPC, "RPC stopped.\n");
383 }
384 
386 {
387  SetupHelpOptions(argsman);
388  argsman.AddArg("-help-debug", "Print help message with debugging options and exit", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); // server-only for now
389 
390  init::AddLoggingArgs(argsman);
391 
392  const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
393  const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
394  const auto signetBaseParams = CreateBaseChainParams(CBaseChainParams::SIGNET);
395  const auto regtestBaseParams = CreateBaseChainParams(CBaseChainParams::REGTEST);
396  const auto defaultChainParams = CreateChainParams(argsman, CBaseChainParams::MAIN);
397  const auto testnetChainParams = CreateChainParams(argsman, CBaseChainParams::TESTNET);
398  const auto signetChainParams = CreateChainParams(argsman, CBaseChainParams::SIGNET);
399  const auto regtestChainParams = CreateChainParams(argsman, CBaseChainParams::REGTEST);
400 
401  // Hidden Options
402  std::vector<std::string> hidden_args = {
403  "-dbcrashratio", "-forcecompactdb",
404  // GUI args. These will be overwritten by SetupUIArgs for the GUI
405  "-choosedatadir", "-lang=<lang>", "-min", "-resetguisettings", "-splash", "-uiplatform"};
406 
407  argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
408 #if HAVE_SYSTEM
409  argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
410 #endif
411  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);
412  argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
413  argsman.AddArg("-fastprune", "Use smaller block files and lower minimum prune height for testing purposes", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
414 #if HAVE_SYSTEM
415  argsman.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
416 #endif
417  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);
418  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);
419  argsman.AddArg("-coinstatsindex", strprintf("Maintain coinstats index used by the gettxoutsetinfo RPC (default: %u)", DEFAULT_COINSTATSINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
420  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);
421  argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
422  argsman.AddArg("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
423  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);
424  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);
425  argsman.AddArg("-loadblock=<file>", "Imports blocks from external file on startup", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
426  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);
427  argsman.AddArg("-maxorphantx=<n>", strprintf("Keep at most <n> unconnectable transactions in memory (default: %u)", DEFAULT_MAX_ORPHAN_TRANSACTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
428  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);
429  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);
430  argsman.AddArg("-par=<n>", strprintf("Set the number of script verification threads (%u to %d, 0 = auto, <0 = leave that many cores free, default: %d)",
432  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);
433  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);
434  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. "
435  "Warning: Reverting this setting requires re-downloading the entire blockchain. "
436  "(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);
437  argsman.AddArg("-reindex", "Rebuild chain state and block index from the blk*.dat files on disk. This will also rebuild active optional indexes.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
438  argsman.AddArg("-reindex-chainstate", "Rebuild chain state from the currently indexed blocks. When in pruning mode or if blocks on disk might be corrupted, use full -reindex instead. Deactivate all optional indexes before running this.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
439  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);
440 #if HAVE_SYSTEM
441  argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
442 #endif
443 #ifndef WIN32
444  argsman.AddArg("-sysperms", "Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
445 #else
446  hidden_args.emplace_back("-sysperms");
447 #endif
448  argsman.AddArg("-txindex", strprintf("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)", DEFAULT_TXINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
449  argsman.AddArg("-blockfilterindex=<type>",
450  strprintf("Maintain an index of compact filters by block (default: %s, values: %s).", DEFAULT_BLOCKFILTERINDEX, ListBlockFilterTypes()) +
451  " If <type> is not supplied or if <type> = 1, indexes for all known types are enabled.",
453 
454  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);
455  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);
456  argsman.AddArg("-bantime=<n>", strprintf("Default duration (in seconds) of manually configured bans (default: %u)", DEFAULT_MISBEHAVING_BANTIME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
457  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);
458  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);
459  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);
460  argsman.AddArg("-discover", "Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
461  argsman.AddArg("-dns", strprintf("Allow DNS lookups for -addnode, -seednode and -connect (default: %u)", DEFAULT_NAME_LOOKUP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
462  argsman.AddArg("-dnsseed", strprintf("Query for peer addresses via DNS lookup, if low on addresses (default: %u unless -connect used)", DEFAULT_DNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
463  argsman.AddArg("-externalip=<ip>", "Specify your own public address", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
464  argsman.AddArg("-fixedseeds", strprintf("Allow fixed seeds if DNS seeds don't provide peers (default: %u)", DEFAULT_FIXEDSEEDS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
465  argsman.AddArg("-forcednsseed", strprintf("Always query for peer addresses via DNS lookup (default: %u)", DEFAULT_FORCEDNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
466  argsman.AddArg("-listen", "Accept connections from outside (default: 1 if no -proxy or -connect)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
467  argsman.AddArg("-listenonion", strprintf("Automatically create Tor onion service (default: %d)", DEFAULT_LISTEN_ONION), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
468  argsman.AddArg("-maxconnections=<n>", strprintf("Maintain at most <n> 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);
469  argsman.AddArg("-maxreceivebuffer=<n>", strprintf("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXRECEIVEBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
470  argsman.AddArg("-maxsendbuffer=<n>", strprintf("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXSENDBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
471  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);
472  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);
473  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);
474  argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections (default: none)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
475  argsman.AddArg("-i2pacceptincoming", "If set and -i2psam is also set then incoming I2P connections are accepted via the SAM proxy. If this is not set but -i2psam is set then only outgoing connections will be made to the I2P network. Ignored if -i2psam is not set. Listening for incoming I2P connections is done through the SAM proxy, not by binding to a local address and port (default: 1)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
476  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);
477  argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
478  argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
479  // TODO: remove the sentence "Nodes not using ... incoming connections." once the changes from
480  // https://github.com/bitcoin/bitcoin/pull/23542 have become widespread.
481  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);
482  argsman.AddArg("-proxy=<ip:port>", "Connect through SOCKS5 proxy, set -noproxy to disable (default: disabled)", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_ELISION, OptionsCategory::CONNECTION);
483  argsman.AddArg("-proxyrandomize", strprintf("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)", DEFAULT_PROXYRANDOMIZE), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
484  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);
485  argsman.AddArg("-networkactive", "Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
486  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);
487  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);
488  argsman.AddArg("-torcontrol=<ip>:<port>", strprintf("Tor control port to use if onion listening enabled (default: %s)", DEFAULT_TOR_CONTROL), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
489  argsman.AddArg("-torpassword=<pass>", "Tor control port password (default: empty)", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::CONNECTION);
490 #ifdef USE_UPNP
491 #if USE_UPNP
492  argsman.AddArg("-upnp", "Use UPnP to map the listening port (default: 1 when listening and no -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
493 #else
494  argsman.AddArg("-upnp", strprintf("Use UPnP to map the listening port (default: %u)", 0), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
495 #endif
496 #else
497  hidden_args.emplace_back("-upnp");
498 #endif
499 #ifdef USE_NATPMP
500  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);
501 #else
502  hidden_args.emplace_back("-natpmp");
503 #endif // USE_NATPMP
504  argsman.AddArg("-whitebind=<[permissions@]addr>", "Bind to the given address and add permission flags to the peers connecting to it. "
505  "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
506  "Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
507 
508  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 "
509  "CIDR-notated network (e.g. 1.2.3.0/24). Uses the same permissions as "
510  "-whitebind. Can be specified multiple times." , ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
511 
513 
514 #if ENABLE_ZMQ
515  argsman.AddArg("-zmqpubhashblock=<address>", "Enable publish hash block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
516  argsman.AddArg("-zmqpubhashtx=<address>", "Enable publish hash transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
517  argsman.AddArg("-zmqpubrawblock=<address>", "Enable publish raw block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
518  argsman.AddArg("-zmqpubrawtx=<address>", "Enable publish raw transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
519  argsman.AddArg("-zmqpubsequence=<address>", "Enable publish hash block and tx sequence in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
520  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);
521  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);
522  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);
523  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);
524  argsman.AddArg("-zmqpubsequencehwm=<n>", strprintf("Set publish hash sequence message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
525 #else
526  hidden_args.emplace_back("-zmqpubhashblock=<address>");
527  hidden_args.emplace_back("-zmqpubhashtx=<address>");
528  hidden_args.emplace_back("-zmqpubrawblock=<address>");
529  hidden_args.emplace_back("-zmqpubrawtx=<address>");
530  hidden_args.emplace_back("-zmqpubsequence=<n>");
531  hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
532  hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
533  hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
534  hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
535  hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
536 #endif
537 
538  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);
539  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);
540  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);
541  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);
542  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);
543  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);
544  argsman.AddArg("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
545  argsman.AddArg("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
546  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);
547  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);
548  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);
549  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);
550  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);
551  argsman.AddArg("-addrmantest", "Allows to test address relay on localhost", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
552  argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
553  argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
554  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);
555  argsman.AddArg("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
556  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);
557  argsman.AddArg("-uacomment=<cmt>", "Append comment to the user agent string", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
558 
560 
561  argsman.AddArg("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", !testnetChainParams->RequireStandard()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
562  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);
563  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);
564  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);
565  argsman.AddArg("-datacarrier", strprintf("Relay and mine data carrier transactions (default: %u)", DEFAULT_ACCEPT_DATACARRIER), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
566  argsman.AddArg("-datacarriersize", strprintf("Maximum size of data in data carrier transactions we relay and mine (default: %u)", MAX_OP_RETURN_RELAY), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
567  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);
568  argsman.AddArg("-permitbaremultisig", strprintf("Relay non-P2SH multisig (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY,
570  argsman.AddArg("-minrelaytxfee=<amt>", strprintf("Fees (in %s/kvB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)",
572  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);
573  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);
574 
575 
576  argsman.AddArg("-blockmaxweight=<n>", strprintf("Set maximum BIP141 block weight (default: %d)", DEFAULT_BLOCK_MAX_WEIGHT), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
577  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);
578  argsman.AddArg("-blockversion=<n>", "Override block version to test forking scenarios", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
579 
580  argsman.AddArg("-rest", strprintf("Accept public REST requests (default: %u)", DEFAULT_REST_ENABLE), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
581  argsman.AddArg("-rpcallowip=<ip>", "Allow JSON-RPC connections from specified source. Valid 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) or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified multiple times", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
582  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);
583  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 | ArgsManager::SENSITIVE, OptionsCategory::RPC);
584  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);
585  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);
586  argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
587  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);
588  argsman.AddArg("-rpcserialversion", strprintf("Sets the serialization of raw transaction or block hex returned in non-verbose mode, non-segwit(0) or segwit(1) (default: %d)", DEFAULT_RPC_SERIALIZE_VERSION), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
589  argsman.AddArg("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
590  argsman.AddArg("-rpcthreads=<n>", strprintf("Set the number of threads to service RPC calls (default: %d)", DEFAULT_HTTP_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
591  argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
592  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);
593  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);
594  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);
595  argsman.AddArg("-server", "Accept command line and JSON-RPC commands", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
596 
597 #if HAVE_DECL_FORK
598  argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
599  argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
600 #else
601  hidden_args.emplace_back("-daemon");
602  hidden_args.emplace_back("-daemonwait");
603 #endif
604 
605 #if defined(USE_SYSCALL_SANDBOX)
606  argsman.AddArg("-sandbox=<mode>", "Use the experimental syscall sandbox in the specified mode (-sandbox=log-and-abort or -sandbox=abort). Allow only expected syscalls to be used by bitcoind. Note that this is an experimental new feature that may cause bitcoind to exit or crash unexpectedly: use with caution. In the \"log-and-abort\" mode the invocation of an unexpected syscall results in a debug handler being invoked which will log the incident and terminate the program (without executing the unexpected syscall). In the \"abort\" mode the invocation of an unexpected syscall results in the entire process being killed immediately by the kernel without executing the unexpected syscall.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
607 #endif // USE_SYSCALL_SANDBOX
608 
609  // Add the hidden options
610  argsman.AddHiddenArgs(hidden_args);
611 }
612 
613 static bool fHaveGenesis = false;
615 static std::condition_variable g_genesis_wait_cv;
616 
617 static void BlockNotifyGenesisWait(const CBlockIndex* pBlockIndex)
618 {
619  if (pBlockIndex != nullptr) {
620  {
622  fHaveGenesis = true;
623  }
624  g_genesis_wait_cv.notify_all();
625  }
626 }
627 
628 #if HAVE_SYSTEM
629 static void StartupNotify(const ArgsManager& args)
630 {
631  std::string cmd = args.GetArg("-startupnotify", "");
632  if (!cmd.empty()) {
633  std::thread t(runCommand, cmd);
634  t.detach(); // thread runs free
635  }
636 }
637 #endif
638 
640 {
641  const ArgsManager& args = *Assert(node.args);
644  if (!InitHTTPServer())
645  return false;
646  StartRPC();
647  node.rpc_interruption_point = RpcInterruptionPoint;
648  if (!StartHTTPRPC(&node))
649  return false;
651  StartHTTPServer();
652  return true;
653 }
654 
655 // Parameter interaction based on rules
657 {
658  // when specifying an explicit binding address, you want to listen on it
659  // even when -connect or -proxy is specified
660  if (args.IsArgSet("-bind")) {
661  if (args.SoftSetBoolArg("-listen", true))
662  LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
663  }
664  if (args.IsArgSet("-whitebind")) {
665  if (args.SoftSetBoolArg("-listen", true))
666  LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
667  }
668 
669  if (args.IsArgSet("-connect")) {
670  // when only connecting to trusted nodes, do not seed via DNS, or listen by default
671  if (args.SoftSetBoolArg("-dnsseed", false))
672  LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
673  if (args.SoftSetBoolArg("-listen", false))
674  LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
675  }
676 
677  std::string proxy_arg = args.GetArg("-proxy", "");
678  if (proxy_arg != "" && proxy_arg != "0") {
679  // to protect privacy, do not listen by default if a default proxy server is specified
680  if (args.SoftSetBoolArg("-listen", false))
681  LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
682  // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
683  // to listen locally, so don't rely on this happening through -listen below.
684  if (args.SoftSetBoolArg("-upnp", false))
685  LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
686  if (args.SoftSetBoolArg("-natpmp", false)) {
687  LogPrintf("%s: parameter interaction: -proxy set -> setting -natpmp=0\n", __func__);
688  }
689  // to protect privacy, do not discover addresses by default
690  if (args.SoftSetBoolArg("-discover", false))
691  LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
692  }
693 
694  if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
695  // do not map ports or try to retrieve public IP when not listening (pointless)
696  if (args.SoftSetBoolArg("-upnp", false))
697  LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
698  if (args.SoftSetBoolArg("-natpmp", false)) {
699  LogPrintf("%s: parameter interaction: -listen=0 -> setting -natpmp=0\n", __func__);
700  }
701  if (args.SoftSetBoolArg("-discover", false))
702  LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
703  if (args.SoftSetBoolArg("-listenonion", false))
704  LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
705  if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
706  LogPrintf("%s: parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n", __func__);
707  }
708  }
709 
710  if (args.IsArgSet("-externalip")) {
711  // if an explicit public IP is specified, do not try to find others
712  if (args.SoftSetBoolArg("-discover", false))
713  LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
714  }
715 
716  // disable whitelistrelay in blocksonly mode
717  if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
718  if (args.SoftSetBoolArg("-whitelistrelay", false))
719  LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
720  }
721 
722  // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
723  if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
724  if (args.SoftSetBoolArg("-whitelistrelay", true))
725  LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
726  }
727  if (args.IsArgSet("-onlynet")) {
728  const auto onlynets = args.GetArgs("-onlynet");
729  bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
730  const auto n = ParseNetwork(net);
731  return n == NET_IPV4 || n == NET_IPV6;
732  });
733  if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
734  LogPrintf("%s: parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n", __func__);
735  }
736  }
737 }
738 
746 {
749 }
750 
751 namespace { // Variables internal to initialization process only
752 
753 int nMaxConnections;
754 int nUserMaxConnections;
755 int nFD;
757 int64_t peer_connect_timeout;
758 std::set<BlockFilterType> g_enabled_filter_types;
759 
760 } // namespace
761 
762 [[noreturn]] static void new_handler_terminate()
763 {
764  // Rather than throwing std::bad-alloc if allocation fails, terminate
765  // immediately to (try to) avoid chain corruption.
766  // Since LogPrintf may itself allocate memory, set the handler directly
767  // to terminate first.
768  std::set_new_handler(std::terminate);
769  LogPrintf("Error: Out of memory. Terminating.\n");
770 
771  // The log was successful, terminate now.
772  std::terminate();
773 };
774 
776 {
777  // ********************************************************* Step 1: setup
778 #ifdef _MSC_VER
779  // Turn off Microsoft heap dump noise
780  _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
781  _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
782  // Disable confusing "helpful" text message on abort, Ctrl-C
783  _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
784 #endif
785 #ifdef WIN32
786  // Enable heap terminate-on-corruption
787  HeapSetInformation(nullptr, HeapEnableTerminationOnCorruption, nullptr, 0);
788 #endif
789  if (!InitShutdownState()) {
790  return InitError(Untranslated("Initializing wait-for-shutdown state failed."));
791  }
792 
793  if (!SetupNetworking()) {
794  return InitError(Untranslated("Initializing networking failed."));
795  }
796 
797 #ifndef WIN32
798  if (!args.GetBoolArg("-sysperms", false)) {
799  umask(077);
800  }
801 
802  // Clean shutdown on SIGTERM
805 
806  // Reopen debug.log on SIGHUP
808 
809  // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
810  signal(SIGPIPE, SIG_IGN);
811 #else
812  SetConsoleCtrlHandler(consoleCtrlHandler, true);
813 #endif
814 
815  std::set_new_handler(new_handler_terminate);
816 
817  return true;
818 }
819 
820 bool AppInitParameterInteraction(const ArgsManager& args, bool use_syscall_sandbox)
821 {
822  const CChainParams& chainparams = Params();
823  // ********************************************************* Step 2: parameter interactions
824 
825  // also see: InitParameterInteraction()
826 
827  // Error if network-specific options (-addnode, -connect, etc) are
828  // specified in default section of config file, but not overridden
829  // on the command line or in this network's section of the config file.
830  std::string network = args.GetChainName();
831  if (network == CBaseChainParams::SIGNET) {
832  LogPrintf("Signet derived magic (message start): %s\n", HexStr(chainparams.MessageStart()));
833  }
834  bilingual_str errors;
835  for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
836  errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section.") + Untranslated("\n"), arg, network, network);
837  }
838 
839  if (!errors.empty()) {
840  return InitError(errors);
841  }
842 
843  // Warn if unrecognized section name are present in the config file.
844  bilingual_str warnings;
845  for (const auto& section : args.GetUnrecognizedSections()) {
846  warnings += strprintf(Untranslated("%s:%i ") + _("Section [%s] is not recognized.") + Untranslated("\n"), section.m_file, section.m_line, section.m_name);
847  }
848 
849  if (!warnings.empty()) {
850  InitWarning(warnings);
851  }
852 
853  if (!fs::is_directory(gArgs.GetBlocksDirPath())) {
854  return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
855  }
856 
857  // parse and validate enabled filter types
858  std::string blockfilterindex_value = args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
859  if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
860  g_enabled_filter_types = AllBlockFilterTypes();
861  } else if (blockfilterindex_value != "0") {
862  const std::vector<std::string> names = args.GetArgs("-blockfilterindex");
863  for (const auto& name : names) {
864  BlockFilterType filter_type;
865  if (!BlockFilterTypeByName(name, filter_type)) {
866  return InitError(strprintf(_("Unknown -blockfilterindex value %s."), name));
867  }
868  g_enabled_filter_types.insert(filter_type);
869  }
870  }
871 
872  // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index are both enabled.
873  if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
874  if (g_enabled_filter_types.count(BlockFilterType::BASIC) != 1) {
875  return InitError(_("Cannot set -peerblockfilters without -blockfilterindex."));
876  }
877 
878  nLocalServices = ServiceFlags(nLocalServices | NODE_COMPACT_FILTERS);
879  }
880 
881  if (args.GetIntArg("-prune", 0)) {
882  if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX))
883  return InitError(_("Prune mode is incompatible with -txindex."));
884  if (args.GetBoolArg("-reindex-chainstate", false)) {
885  return InitError(_("Prune mode is incompatible with -reindex-chainstate. Use full -reindex instead."));
886  }
887  }
888 
889  // If -forcednsseed is set to true, ensure -dnsseed has not been set to false
890  if (args.GetBoolArg("-forcednsseed", DEFAULT_FORCEDNSSEED) && !args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED)){
891  return InitError(_("Cannot set -forcednsseed to true when setting -dnsseed to false."));
892  }
893 
894  // -bind and -whitebind can't be set when not listening
895  size_t nUserBind = args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
896  if (nUserBind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
897  return InitError(Untranslated("Cannot set -bind or -whitebind together with -listen=0"));
898  }
899 
900  // if listen=0, then disallow listenonion=1
901  if (!args.GetBoolArg("-listen", DEFAULT_LISTEN) && args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
902  return InitError(Untranslated("Cannot set -listen=0 together with -listenonion=1"));
903  }
904 
905  // Make sure enough file descriptors are available
906  int nBind = std::max(nUserBind, size_t(1));
907  nUserMaxConnections = args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
908  nMaxConnections = std::max(nUserMaxConnections, 0);
909 
911 
912 #ifdef USE_POLL
913  int fd_max = nFD;
914 #else
915  int fd_max = FD_SETSIZE;
916 #endif
917  // Trim requested connection counts, to fit into system limitations
918  // <int> in std::min<int>(...) to work around FreeBSD compilation issue described in #2695
919  nMaxConnections = std::max(std::min<int>(nMaxConnections, fd_max - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS - NUM_FDS_MESSAGE_CAPTURE), 0);
920  if (nFD < MIN_CORE_FILEDESCRIPTORS)
921  return InitError(_("Not enough file descriptors available."));
922  nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS - NUM_FDS_MESSAGE_CAPTURE, nMaxConnections);
923 
924  if (nMaxConnections < nUserMaxConnections)
925  InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
926 
927  // ********************************************************* Step 3: parameter-to-internal-flags
930 
931  fCheckBlockIndex = args.GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
933 
934  hashAssumeValid = uint256S(args.GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
935 
936  if (args.IsArgSet("-minimumchainwork")) {
937  const std::string minChainWorkStr = args.GetArg("-minimumchainwork", "");
938  if (!IsHexNumber(minChainWorkStr)) {
939  return InitError(strprintf(Untranslated("Invalid non-hex (%s) minimum chain work value specified"), minChainWorkStr));
940  }
941  nMinimumChainWork = UintToArith256(uint256S(minChainWorkStr));
942  } else {
944  }
945 
946  // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
947  int64_t nPruneArg = args.GetIntArg("-prune", 0);
948  if (nPruneArg < 0) {
949  return InitError(_("Prune cannot be configured with a negative value."));
950  }
951  nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
952  if (nPruneArg == 1) { // manual pruning: -prune=1
953  nPruneTarget = std::numeric_limits<uint64_t>::max();
954  fPruneMode = true;
955  } else if (nPruneTarget) {
957  return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
958  }
959  fPruneMode = true;
960  }
961 
963  if (nConnectTimeout <= 0) {
965  }
966 
967  peer_connect_timeout = args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
968  if (peer_connect_timeout <= 0) {
969  return InitError(Untranslated("peertimeout must be a positive integer."));
970  }
971 
972  // Sanity check argument for min fee for including tx in block
973  // TODO: Harmonize which arguments need sanity checking and where that happens
974  if (args.IsArgSet("-blockmintxfee")) {
975  if (!ParseMoney(args.GetArg("-blockmintxfee", ""))) {
976  return InitError(AmountErrMsg("blockmintxfee", args.GetArg("-blockmintxfee", "")));
977  }
978  }
979 
980  nBytesPerSigOp = args.GetIntArg("-bytespersigop", nBytesPerSigOp);
981 
982  if (!g_wallet_init_interface.ParameterInteraction()) return false;
983 
984  // Option to startup with mocktime set (used for regression testing):
985  SetMockTime(args.GetIntArg("-mocktime", 0)); // SetMockTime(0) is a no-op
986 
987  if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
988  nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
989 
990  if (args.GetIntArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
991  return InitError(Untranslated("rpcserialversion must be non-negative."));
992 
993  if (args.GetIntArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
994  return InitError(Untranslated("Unknown rpcserialversion requested."));
995 
996  nMaxTipAge = args.GetIntArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
997 
998  if (args.GetBoolArg("-reindex-chainstate", false)) {
999  // indexes that must be deactivated to prevent index corruption, see #24630
1000  if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
1001  return InitError(_("-reindex-chainstate option is not compatible with -coinstatsindex. Please temporarily disable coinstatsindex while using -reindex-chainstate, or replace -reindex-chainstate with -reindex to fully rebuild all indexes."));
1002  }
1003  if (g_enabled_filter_types.count(BlockFilterType::BASIC)) {
1004  return InitError(_("-reindex-chainstate option is not compatible with -blockfilterindex. Please temporarily disable blockfilterindex while using -reindex-chainstate, or replace -reindex-chainstate with -reindex to fully rebuild all indexes."));
1005  }
1006  if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1007  return InitError(_("-reindex-chainstate option is not compatible with -txindex. Please temporarily disable txindex while using -reindex-chainstate, or replace -reindex-chainstate with -reindex to fully rebuild all indexes."));
1008  }
1009  }
1010 
1011 #if defined(USE_SYSCALL_SANDBOX)
1012  if (args.IsArgSet("-sandbox") && !args.IsArgNegated("-sandbox")) {
1013  const std::string sandbox_arg{args.GetArg("-sandbox", "")};
1014  bool log_syscall_violation_before_terminating{false};
1015  if (sandbox_arg == "log-and-abort") {
1016  log_syscall_violation_before_terminating = true;
1017  } else if (sandbox_arg == "abort") {
1018  // log_syscall_violation_before_terminating is false by default.
1019  } else {
1020  return InitError(Untranslated("Unknown syscall sandbox mode (-sandbox=<mode>). Available modes are \"log-and-abort\" and \"abort\"."));
1021  }
1022  // execve(...) is not allowed by the syscall sandbox.
1023  const std::vector<std::string> features_using_execve{
1024  "-alertnotify",
1025  "-blocknotify",
1026  "-signer",
1027  "-startupnotify",
1028  "-walletnotify",
1029  };
1030  for (const std::string& feature_using_execve : features_using_execve) {
1031  if (!args.GetArg(feature_using_execve, "").empty()) {
1032  return InitError(Untranslated(strprintf("The experimental syscall sandbox feature (-sandbox=<mode>) is incompatible with %s (which uses execve).", feature_using_execve)));
1033  }
1034  }
1035  if (!SetupSyscallSandbox(log_syscall_violation_before_terminating)) {
1036  return InitError(Untranslated("Installation of the syscall sandbox failed."));
1037  }
1038  if (use_syscall_sandbox) {
1040  }
1041  LogPrintf("Experimental syscall sandbox enabled (-sandbox=%s): bitcoind will terminate if an unexpected (not allowlisted) syscall is invoked.\n", sandbox_arg);
1042  }
1043 #endif // USE_SYSCALL_SANDBOX
1044 
1045  return true;
1046 }
1047 
1048 static bool LockDataDirectory(bool probeOnly)
1049 {
1050  // Make sure only a single Bitcoin process is using the data directory.
1051  const fs::path& datadir = gArgs.GetDataDirNet();
1052  if (!DirIsWritable(datadir)) {
1053  return InitError(strprintf(_("Cannot write to data directory '%s'; check permissions."), fs::PathToString(datadir)));
1054  }
1055  if (!LockDirectory(datadir, ".lock", probeOnly)) {
1056  return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), fs::PathToString(datadir), PACKAGE_NAME));
1057  }
1058  return true;
1059 }
1060 
1062 {
1063  // ********************************************************* Step 4: sanity checks
1064  if (auto error = kernel::SanityChecks(kernel)) {
1065  InitError(*error);
1066  return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), PACKAGE_NAME));
1067  }
1068 
1069  // Probe the data directory lock to give an early error message, if possible
1070  // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1071  // and a fork will cause weird behavior to it.
1072  return LockDataDirectory(true);
1073 }
1074 
1076 {
1077  // After daemonization get the data directory lock again and hold on to it until exit
1078  // This creates a slight window for a race condition to happen, however this condition is harmless: it
1079  // will at most make us exit without printing a message to console.
1080  if (!LockDataDirectory(false)) {
1081  // Detailed error printed inside LockDataDirectory
1082  return false;
1083  }
1084  return true;
1085 }
1086 
1088 {
1089  node.chain = node.init->makeChain();
1090  return true;
1091 }
1092 
1094 {
1095  const ArgsManager& args = *Assert(node.args);
1096  const CChainParams& chainparams = Params();
1097 
1098  auto opt_max_upload = ParseByteUnits(args.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET), ByteUnit::M);
1099  if (!opt_max_upload) {
1100  return InitError(strprintf(_("Unable to parse -maxuploadtarget: '%s'"), args.GetArg("-maxuploadtarget", "")));
1101  }
1102 
1103  // ********************************************************* Step 4a: application initialization
1104  if (!CreatePidFile(args)) {
1105  // Detailed error printed inside CreatePidFile().
1106  return false;
1107  }
1108  if (!init::StartLogging(args)) {
1109  // Detailed error printed inside StartLogging().
1110  return false;
1111  }
1112 
1113  LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1114 
1115  // Warn about relative -datadir path.
1116  if (args.IsArgSet("-datadir") && !args.GetPathArg("-datadir").is_absolute()) {
1117  LogPrintf("Warning: relative datadir option '%s' specified, which will be interpreted relative to the " /* Continued */
1118  "current working directory '%s'. This is fragile, because if bitcoin is started in the future "
1119  "from a different location, it will be unable to locate the current data files. There could "
1120  "also be data loss if bitcoin is started while in a temporary directory.\n",
1121  args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1122  }
1123 
1124  ValidationCacheSizes validation_cache_sizes{};
1125  ApplyArgsManOptions(args, validation_cache_sizes);
1126  if (!InitSignatureCache(validation_cache_sizes.signature_cache_bytes)
1127  || !InitScriptExecutionCache(validation_cache_sizes.script_execution_cache_bytes))
1128  {
1129  return InitError(strprintf(_("Unable to allocate memory for -maxsigcachesize: '%s' MiB"), args.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_BYTES >> 20)));
1130  }
1131 
1132  int script_threads = args.GetIntArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
1133  if (script_threads <= 0) {
1134  // -par=0 means autodetect (number of cores - 1 script threads)
1135  // -par=-n means "leave n cores free" (number of cores - n - 1 script threads)
1136  script_threads += GetNumCores();
1137  }
1138 
1139  // Subtract 1 because the main thread counts towards the par threads
1140  script_threads = std::max(script_threads - 1, 0);
1141 
1142  // Number of script-checking threads <= MAX_SCRIPTCHECK_THREADS
1143  script_threads = std::min(script_threads, MAX_SCRIPTCHECK_THREADS);
1144 
1145  LogPrintf("Script verification uses %d additional threads\n", script_threads);
1146  if (script_threads >= 1) {
1147  g_parallel_script_checks = true;
1148  StartScriptCheckWorkerThreads(script_threads);
1149  }
1150 
1151  assert(!node.scheduler);
1152  node.scheduler = std::make_unique<CScheduler>();
1153 
1154  // Start the lightweight task scheduler thread
1155  node.scheduler->m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { node.scheduler->serviceQueue(); });
1156 
1157  // Gather some entropy once per minute.
1158  node.scheduler->scheduleEvery([]{
1159  RandAddPeriodic();
1160  }, std::chrono::minutes{1});
1161 
1163 
1164  // Create client interfaces for wallets that are supposed to be loaded
1165  // according to -wallet and -disablewallet options. This only constructs
1166  // the interfaces, it doesn't load wallet data. Wallets actually get loaded
1167  // when load() and start() interface methods are called below.
1169  uiInterface.InitWallet();
1170 
1171  /* Register RPC commands regardless of -server setting so they will be
1172  * available in the GUI RPC console even if external calls are disabled.
1173  */
1175  for (const auto& client : node.chain_clients) {
1176  client->registerRpcs();
1177  }
1178 #if ENABLE_ZMQ
1180 #endif
1181 
1182  /* Start the RPC server already. It will be started in "warmup" mode
1183  * and not really process calls already (but it will signify connections
1184  * that the server is there and will be ready later). Warmup mode will
1185  * be disabled when initialisation is finished.
1186  */
1187  if (args.GetBoolArg("-server", false)) {
1188  uiInterface.InitMessage_connect(SetRPCWarmupStatus);
1189  if (!AppInitServers(node))
1190  return InitError(_("Unable to start HTTP server. See debug log for details."));
1191  }
1192 
1193  // ********************************************************* Step 5: verify wallet database integrity
1194  for (const auto& client : node.chain_clients) {
1195  if (!client->verify()) {
1196  return false;
1197  }
1198  }
1199 
1200  // ********************************************************* Step 6: network initialization
1201  // Note that we absolutely cannot open any actual connections
1202  // until the very end ("start node") as the UTXO/block state
1203  // is not yet setup and may end up being set up twice if we
1204  // need to reindex later.
1205 
1206  fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
1207  fDiscover = args.GetBoolArg("-discover", true);
1208  const bool ignores_incoming_txs{args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)};
1209 
1210  {
1211 
1212  // Read asmap file if configured
1213  std::vector<bool> asmap;
1214  if (args.IsArgSet("-asmap")) {
1215  fs::path asmap_path = args.GetPathArg("-asmap", DEFAULT_ASMAP_FILENAME);
1216  if (!asmap_path.is_absolute()) {
1217  asmap_path = gArgs.GetDataDirNet() / asmap_path;
1218  }
1219  if (!fs::exists(asmap_path)) {
1220  InitError(strprintf(_("Could not find asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1221  return false;
1222  }
1223  asmap = DecodeAsmap(asmap_path);
1224  if (asmap.size() == 0) {
1225  InitError(strprintf(_("Could not parse asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1226  return false;
1227  }
1228  const uint256 asmap_version = SerializeHash(asmap);
1229  LogPrintf("Using asmap version %s for IP bucketing\n", asmap_version.ToString());
1230  } else {
1231  LogPrintf("Using /16 prefix for IP bucketing\n");
1232  }
1233 
1234  // Initialize netgroup manager
1235  assert(!node.netgroupman);
1236  node.netgroupman = std::make_unique<NetGroupManager>(std::move(asmap));
1237 
1238  // Initialize addrman
1239  assert(!node.addrman);
1240  uiInterface.InitMessage(_("Loading P2P addresses…").translated);
1241  if (const auto error{LoadAddrman(*node.netgroupman, args, node.addrman)}) {
1242  return InitError(*error);
1243  }
1244  }
1245 
1246  assert(!node.banman);
1247  node.banman = std::make_unique<BanMan>(gArgs.GetDataDirNet() / "banlist", &uiInterface, args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
1248  assert(!node.connman);
1249  node.connman = std::make_unique<CConnman>(GetRand<uint64_t>(),
1250  GetRand<uint64_t>(),
1251  *node.addrman, *node.netgroupman, args.GetBoolArg("-networkactive", true));
1252 
1253  assert(!node.fee_estimator);
1254  // Don't initialize fee estimation with old data if we don't relay transactions,
1255  // as they would never get updated.
1256  if (!ignores_incoming_txs) node.fee_estimator = std::make_unique<CBlockPolicyEstimator>(FeeestPath(args));
1257 
1258  // sanitize comments per BIP-0014, format user agent and check total size
1259  std::vector<std::string> uacomments;
1260  for (const std::string& cmt : args.GetArgs("-uacomment")) {
1261  if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1262  return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1263  uacomments.push_back(cmt);
1264  }
1266  if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1267  return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1269  }
1270 
1271  if (args.IsArgSet("-onlynet")) {
1272  std::set<enum Network> nets;
1273  for (const std::string& snet : args.GetArgs("-onlynet")) {
1274  enum Network net = ParseNetwork(snet);
1275  if (net == NET_UNROUTABLE)
1276  return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1277  nets.insert(net);
1278  }
1279  for (int n = 0; n < NET_MAX; n++) {
1280  enum Network net = (enum Network)n;
1281  assert(IsReachable(net));
1282  if (!nets.count(net))
1283  SetReachable(net, false);
1284  }
1285  }
1286 
1287  if (!args.IsArgSet("-cjdnsreachable")) {
1288  if (args.IsArgSet("-onlynet") && IsReachable(NET_CJDNS)) {
1289  return InitError(
1290  _("Outbound connections restricted to CJDNS (-onlynet=cjdns) but "
1291  "-cjdnsreachable is not provided"));
1292  }
1293  SetReachable(NET_CJDNS, false);
1294  }
1295  // Now IsReachable(NET_CJDNS) is true if:
1296  // 1. -cjdnsreachable is given and
1297  // 2.1. -onlynet is not given or
1298  // 2.2. -onlynet=cjdns is given
1299 
1300  // Requesting DNS seeds entails connecting to IPv4/IPv6, which -onlynet options may prohibit:
1301  // If -dnsseed=1 is explicitly specified, abort. If it's left unspecified by the user, we skip
1302  // the DNS seeds by adjusting -dnsseed in InitParameterInteraction.
1303  if (args.GetBoolArg("-dnsseed") == true && !IsReachable(NET_IPV4) && !IsReachable(NET_IPV6)) {
1304  return InitError(strprintf(_("Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")));
1305  };
1306 
1307  // Check for host lookup allowed before parsing any network related parameters
1309 
1310  Proxy onion_proxy;
1311 
1312  bool proxyRandomize = args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1313  // -proxy sets a proxy for all outgoing network traffic
1314  // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1315  std::string proxyArg = args.GetArg("-proxy", "");
1316  if (proxyArg != "" && proxyArg != "0") {
1317  CService proxyAddr;
1318  if (!Lookup(proxyArg, proxyAddr, 9050, fNameLookup)) {
1319  return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1320  }
1321 
1322  Proxy addrProxy = Proxy(proxyAddr, proxyRandomize);
1323  if (!addrProxy.IsValid())
1324  return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1325 
1326  SetProxy(NET_IPV4, addrProxy);
1327  SetProxy(NET_IPV6, addrProxy);
1328  SetProxy(NET_CJDNS, addrProxy);
1329  SetNameProxy(addrProxy);
1330  onion_proxy = addrProxy;
1331  }
1332 
1333  const bool onlynet_used_with_onion{args.IsArgSet("-onlynet") && IsReachable(NET_ONION)};
1334 
1335  // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1336  // -noonion (or -onion=0) disables connecting to .onion entirely
1337  // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1338  std::string onionArg = args.GetArg("-onion", "");
1339  if (onionArg != "") {
1340  if (onionArg == "0") { // Handle -noonion/-onion=0
1341  onion_proxy = Proxy{};
1342  if (onlynet_used_with_onion) {
1343  return InitError(
1344  _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1345  "reaching the Tor network is explicitly forbidden: -onion=0"));
1346  }
1347  } else {
1348  CService addr;
1349  if (!Lookup(onionArg, addr, 9050, fNameLookup) || !addr.IsValid()) {
1350  return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1351  }
1352  onion_proxy = Proxy{addr, proxyRandomize};
1353  }
1354  }
1355 
1356  if (onion_proxy.IsValid()) {
1357  SetProxy(NET_ONION, onion_proxy);
1358  } else {
1359  // If -listenonion is set, then we will (try to) connect to the Tor control port
1360  // later from the torcontrol thread and may retrieve the onion proxy from there.
1361  const bool listenonion_disabled{!args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
1362  if (onlynet_used_with_onion && listenonion_disabled) {
1363  return InitError(
1364  _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1365  "reaching the Tor network is not provided: none of -proxy, -onion or "
1366  "-listenonion is given"));
1367  }
1368  SetReachable(NET_ONION, false);
1369  }
1370 
1371  for (const std::string& strAddr : args.GetArgs("-externalip")) {
1372  CService addrLocal;
1373  if (Lookup(strAddr, addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1374  AddLocal(addrLocal, LOCAL_MANUAL);
1375  else
1376  return InitError(ResolveErrMsg("externalip", strAddr));
1377  }
1378 
1379 #if ENABLE_ZMQ
1381 
1384  }
1385 #endif
1386 
1387  // ********************************************************* Step 7: load block chain
1388 
1389  fReindex = args.GetBoolArg("-reindex", false);
1390  bool fReindexChainState = args.GetBoolArg("-reindex-chainstate", false);
1391 
1392  // cache size calculations
1393  CacheSizes cache_sizes = CalculateCacheSizes(args, g_enabled_filter_types.size());
1394 
1395  LogPrintf("Cache configuration:\n");
1396  LogPrintf("* Using %.1f MiB for block index database\n", cache_sizes.block_tree_db * (1.0 / 1024 / 1024));
1397  if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1398  LogPrintf("* Using %.1f MiB for transaction index database\n", cache_sizes.tx_index * (1.0 / 1024 / 1024));
1399  }
1400  for (BlockFilterType filter_type : g_enabled_filter_types) {
1401  LogPrintf("* Using %.1f MiB for %s block filter index database\n",
1402  cache_sizes.filter_index * (1.0 / 1024 / 1024), BlockFilterTypeName(filter_type));
1403  }
1404  LogPrintf("* Using %.1f MiB for chain state database\n", cache_sizes.coins_db * (1.0 / 1024 / 1024));
1405 
1406  assert(!node.mempool);
1407  assert(!node.chainman);
1408 
1409  CTxMemPool::Options mempool_opts{
1410  .estimator = node.fee_estimator.get(),
1411  .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
1412  };
1413  if (const auto err{ApplyArgsManOptions(args, chainparams, mempool_opts)}) {
1414  return InitError(*err);
1415  }
1416  mempool_opts.check_ratio = std::clamp<int>(mempool_opts.check_ratio, 0, 1'000'000);
1417 
1418  int64_t descendant_limit_bytes = mempool_opts.limits.descendant_size_vbytes * 40;
1419  if (mempool_opts.max_size_bytes < 0 || mempool_opts.max_size_bytes < descendant_limit_bytes) {
1420  return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(descendant_limit_bytes / 1'000'000.0)));
1421  }
1422  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));
1423 
1424  for (bool fLoaded = false; !fLoaded && !ShutdownRequested();) {
1425  node.mempool = std::make_unique<CTxMemPool>(mempool_opts);
1426 
1427  const ChainstateManager::Options chainman_opts{
1428  .chainparams = chainparams,
1429  .adjusted_time_callback = GetAdjustedTime,
1430  };
1431  node.chainman = std::make_unique<ChainstateManager>(chainman_opts);
1432  ChainstateManager& chainman = *node.chainman;
1433 
1435  options.mempool = Assert(node.mempool.get());
1436  options.reindex = node::fReindex;
1437  options.reindex_chainstate = fReindexChainState;
1438  options.prune = node::fPruneMode;
1439  options.check_blocks = args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
1440  options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
1442  options.coins_error_cb = [] {
1443  uiInterface.ThreadSafeMessageBox(
1444  _("Error reading from database, shutting down."),
1446  };
1447 
1448  uiInterface.InitMessage(_("Loading block index…").translated);
1449  const auto load_block_index_start_time{SteadyClock::now()};
1450  auto catch_exceptions = [](auto&& f) {
1451  try {
1452  return f();
1453  } catch (const std::exception& e) {
1454  LogPrintf("%s\n", e.what());
1455  return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error opening block database"));
1456  }
1457  };
1458  auto [status, error] = catch_exceptions([&]{ return LoadChainstate(chainman, cache_sizes, options); });
1459  if (status == node::ChainstateLoadStatus::SUCCESS) {
1460  uiInterface.InitMessage(_("Verifying blocks…").translated);
1461  if (chainman.m_blockman.m_have_pruned && options.check_blocks > MIN_BLOCKS_TO_KEEP) {
1462  LogPrintfCategory(BCLog::PRUNE, "pruned datadir may not have more than %d blocks; only checking available blocks\n",
1464  }
1465  std::tie(status, error) = catch_exceptions([&]{ return VerifyLoadedChainstate(chainman, options);});
1466  if (status == node::ChainstateLoadStatus::SUCCESS) {
1467  fLoaded = true;
1468  LogPrintf(" block index %15dms\n", Ticks<std::chrono::milliseconds>(SteadyClock::now() - load_block_index_start_time));
1469  }
1470  }
1471 
1473  return InitError(error);
1474  }
1475 
1476  if (!fLoaded && !ShutdownRequested()) {
1477  // first suggest a reindex
1478  if (!options.reindex) {
1479  bool fRet = uiInterface.ThreadSafeQuestion(
1480  error + Untranslated(".\n\n") + _("Do you want to rebuild the block database now?"),
1481  error.original + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1483  if (fRet) {
1484  fReindex = true;
1485  AbortShutdown();
1486  } else {
1487  LogPrintf("Aborted block database rebuild. Exiting.\n");
1488  return false;
1489  }
1490  } else {
1491  return InitError(error);
1492  }
1493  }
1494  }
1495 
1496  // As LoadBlockIndex can take several minutes, it's possible the user
1497  // requested to kill the GUI during the last operation. If so, exit.
1498  // As the program has not fully started yet, Shutdown() is possibly overkill.
1499  if (ShutdownRequested()) {
1500  LogPrintf("Shutdown requested. Exiting.\n");
1501  return false;
1502  }
1503 
1504  ChainstateManager& chainman = *Assert(node.chainman);
1505 
1506  assert(!node.peerman);
1507  node.peerman = PeerManager::make(*node.connman, *node.addrman, node.banman.get(),
1508  chainman, *node.mempool, ignores_incoming_txs);
1509  RegisterValidationInterface(node.peerman.get());
1510 
1511  // ********************************************************* Step 8: start indexers
1512  if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1513  if (const auto error{WITH_LOCK(cs_main, return CheckLegacyTxindex(*Assert(chainman.m_blockman.m_block_tree_db)))}) {
1514  return InitError(*error);
1515  }
1516 
1517  g_txindex = std::make_unique<TxIndex>(interfaces::MakeChain(node), cache_sizes.tx_index, false, fReindex);
1518  if (!g_txindex->Start()) {
1519  return false;
1520  }
1521  }
1522 
1523  for (const auto& filter_type : g_enabled_filter_types) {
1524  InitBlockFilterIndex([&]{ return interfaces::MakeChain(node); }, filter_type, cache_sizes.filter_index, false, fReindex);
1525  if (!GetBlockFilterIndex(filter_type)->Start()) {
1526  return false;
1527  }
1528  }
1529 
1530  if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
1531  g_coin_stats_index = std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /* cache size */ 0, false, fReindex);
1532  if (!g_coin_stats_index->Start()) {
1533  return false;
1534  }
1535  }
1536 
1537  // ********************************************************* Step 9: load wallet
1538  for (const auto& client : node.chain_clients) {
1539  if (!client->load()) {
1540  return false;
1541  }
1542  }
1543 
1544  // ********************************************************* Step 10: data directory maintenance
1545 
1546  // if pruning, perform the initial blockstore prune
1547  // after any wallet rescanning has taken place.
1548  if (fPruneMode) {
1549  if (!fReindex) {
1550  LOCK(cs_main);
1551  for (Chainstate* chainstate : chainman.GetAll()) {
1552  uiInterface.InitMessage(_("Pruning blockstore…").translated);
1553  chainstate->PruneAndFlush();
1554  }
1555  }
1556  } else {
1557  LogPrintf("Setting NODE_NETWORK on non-prune mode\n");
1558  nLocalServices = ServiceFlags(nLocalServices | NODE_NETWORK);
1559  }
1560 
1561  // ********************************************************* Step 11: import blocks
1562 
1564  InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(gArgs.GetDataDirNet()))));
1565  return false;
1566  }
1568  InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(gArgs.GetBlocksDirPath()))));
1569  return false;
1570  }
1571 
1572  // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1573  // No locking, as this happens before any background thread is started.
1574  boost::signals2::connection block_notify_genesis_wait_connection;
1575  if (WITH_LOCK(chainman.GetMutex(), return chainman.ActiveChain().Tip() == nullptr)) {
1576  block_notify_genesis_wait_connection = uiInterface.NotifyBlockTip_connect(std::bind(BlockNotifyGenesisWait, std::placeholders::_2));
1577  } else {
1578  fHaveGenesis = true;
1579  }
1580 
1581 #if HAVE_SYSTEM
1582  const std::string block_notify = args.GetArg("-blocknotify", "");
1583  if (!block_notify.empty()) {
1584  uiInterface.NotifyBlockTip_connect([block_notify](SynchronizationState sync_state, const CBlockIndex* pBlockIndex) {
1585  if (sync_state != SynchronizationState::POST_INIT || !pBlockIndex) return;
1586  std::string command = block_notify;
1587  ReplaceAll(command, "%s", pBlockIndex->GetBlockHash().GetHex());
1588  std::thread t(runCommand, command);
1589  t.detach(); // thread runs free
1590  });
1591  }
1592 #endif
1593 
1594  std::vector<fs::path> vImportFiles;
1595  for (const std::string& strFile : args.GetArgs("-loadblock")) {
1596  vImportFiles.push_back(fs::PathFromString(strFile));
1597  }
1598 
1599  chainman.m_load_block = std::thread(&util::TraceThread, "loadblk", [=, &chainman, &args] {
1600  ThreadImport(chainman, vImportFiles, args, ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{});
1601  });
1602 
1603  // Wait for genesis block to be processed
1604  {
1606  // We previously could hang here if StartShutdown() is called prior to
1607  // ThreadImport getting started, so instead we just wait on a timer to
1608  // check ShutdownRequested() regularly.
1609  while (!fHaveGenesis && !ShutdownRequested()) {
1610  g_genesis_wait_cv.wait_for(lock, std::chrono::milliseconds(500));
1611  }
1612  block_notify_genesis_wait_connection.disconnect();
1613  }
1614 
1615  if (ShutdownRequested()) {
1616  return false;
1617  }
1618 
1619  // ********************************************************* Step 12: start node
1620 
1621  int chain_active_height;
1622 
1624  {
1625  LOCK(cs_main);
1626  LogPrintf("block tree size = %u\n", chainman.BlockIndex().size());
1627  chain_active_height = chainman.ActiveChain().Height();
1628  if (tip_info) {
1629  tip_info->block_height = chain_active_height;
1630  tip_info->block_time = chainman.ActiveChain().Tip() ? chainman.ActiveChain().Tip()->GetBlockTime() : chainman.GetParams().GenesisBlock().GetBlockTime();
1631  tip_info->verification_progress = GuessVerificationProgress(chainman.GetParams().TxData(), chainman.ActiveChain().Tip());
1632  }
1633  if (tip_info && chainman.m_best_header) {
1634  tip_info->header_height = chainman.m_best_header->nHeight;
1635  tip_info->header_time = chainman.m_best_header->GetBlockTime();
1636  }
1637  }
1638  LogPrintf("nBestHeight = %d\n", chain_active_height);
1639  if (node.peerman) node.peerman->SetBestHeight(chain_active_height);
1640 
1641  // Map ports with UPnP or NAT-PMP.
1643 
1644  CConnman::Options connOptions;
1645  connOptions.nLocalServices = nLocalServices;
1646  connOptions.nMaxConnections = nMaxConnections;
1647  connOptions.m_max_outbound_full_relay = std::min(MAX_OUTBOUND_FULL_RELAY_CONNECTIONS, connOptions.nMaxConnections);
1648  connOptions.m_max_outbound_block_relay = std::min(MAX_BLOCK_RELAY_ONLY_CONNECTIONS, connOptions.nMaxConnections-connOptions.m_max_outbound_full_relay);
1649  connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1650  connOptions.nMaxFeeler = MAX_FEELER_CONNECTIONS;
1651  connOptions.uiInterface = &uiInterface;
1652  connOptions.m_banman = node.banman.get();
1653  connOptions.m_msgproc = node.peerman.get();
1654  connOptions.nSendBufferMaxSize = 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1655  connOptions.nReceiveFloodSize = 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1656  connOptions.m_added_nodes = args.GetArgs("-addnode");
1657  connOptions.nMaxOutboundLimit = *opt_max_upload;
1658  connOptions.m_peer_connect_timeout = peer_connect_timeout;
1659 
1660  // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
1661  const uint16_t default_bind_port =
1662  static_cast<uint16_t>(args.GetIntArg("-port", Params().GetDefaultPort()));
1663 
1664  const auto BadPortWarning = [](const char* prefix, uint16_t port) {
1665  return strprintf(_("%s request to listen on port %u. This port is considered \"bad\" and "
1666  "thus it is unlikely that any Bitcoin Core peers connect to it. See "
1667  "doc/p2p-bad-ports.md for details and a full list."),
1668  prefix,
1669  port);
1670  };
1671 
1672  for (const std::string& bind_arg : args.GetArgs("-bind")) {
1673  CService bind_addr;
1674  const size_t index = bind_arg.rfind('=');
1675  if (index == std::string::npos) {
1676  if (Lookup(bind_arg, bind_addr, default_bind_port, /*fAllowLookup=*/false)) {
1677  connOptions.vBinds.push_back(bind_addr);
1678  if (IsBadPort(bind_addr.GetPort())) {
1679  InitWarning(BadPortWarning("-bind", bind_addr.GetPort()));
1680  }
1681  continue;
1682  }
1683  } else {
1684  const std::string network_type = bind_arg.substr(index + 1);
1685  if (network_type == "onion") {
1686  const std::string truncated_bind_arg = bind_arg.substr(0, index);
1687  if (Lookup(truncated_bind_arg, bind_addr, BaseParams().OnionServiceTargetPort(), false)) {
1688  connOptions.onion_binds.push_back(bind_addr);
1689  continue;
1690  }
1691  }
1692  }
1693  return InitError(ResolveErrMsg("bind", bind_arg));
1694  }
1695 
1696  for (const std::string& strBind : args.GetArgs("-whitebind")) {
1697  NetWhitebindPermissions whitebind;
1699  if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) return InitError(error);
1700  connOptions.vWhiteBinds.push_back(whitebind);
1701  }
1702 
1703  // If the user did not specify -bind= or -whitebind= then we bind
1704  // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
1705  connOptions.bind_on_any = args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
1706 
1707  // Emit a warning if a bad port is given to -port= but only if -bind and -whitebind are not
1708  // given, because if they are, then -port= is ignored.
1709  if (connOptions.bind_on_any && args.IsArgSet("-port")) {
1710  const uint16_t port_arg = args.GetIntArg("-port", 0);
1711  if (IsBadPort(port_arg)) {
1712  InitWarning(BadPortWarning("-port", port_arg));
1713  }
1714  }
1715 
1716  CService onion_service_target;
1717  if (!connOptions.onion_binds.empty()) {
1718  onion_service_target = connOptions.onion_binds.front();
1719  } else {
1720  onion_service_target = DefaultOnionServiceTarget();
1721  connOptions.onion_binds.push_back(onion_service_target);
1722  }
1723 
1724  if (args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
1725  if (connOptions.onion_binds.size() > 1) {
1726  InitWarning(strprintf(_("More than one onion bind address is provided. Using %s "
1727  "for the automatically created Tor onion service."),
1728  onion_service_target.ToStringIPPort()));
1729  }
1730  StartTorControl(onion_service_target);
1731  }
1732 
1733  if (connOptions.bind_on_any) {
1734  // Only add all IP addresses of the machine if we would be listening on
1735  // any address - 0.0.0.0 (IPv4) and :: (IPv6).
1736  Discover();
1737  }
1738 
1739  for (const auto& net : args.GetArgs("-whitelist")) {
1740  NetWhitelistPermissions subnet;
1742  if (!NetWhitelistPermissions::TryParse(net, subnet, error)) return InitError(error);
1743  connOptions.vWhitelistedRange.push_back(subnet);
1744  }
1745 
1746  connOptions.vSeedNodes = args.GetArgs("-seednode");
1747 
1748  // Initiate outbound connections unless connect=0
1749  connOptions.m_use_addrman_outgoing = !args.IsArgSet("-connect");
1750  if (!connOptions.m_use_addrman_outgoing) {
1751  const auto connect = args.GetArgs("-connect");
1752  if (connect.size() != 1 || connect[0] != "0") {
1753  connOptions.m_specified_outgoing = connect;
1754  }
1755  }
1756 
1757  const std::string& i2psam_arg = args.GetArg("-i2psam", "");
1758  if (!i2psam_arg.empty()) {
1759  CService addr;
1760  if (!Lookup(i2psam_arg, addr, 7656, fNameLookup) || !addr.IsValid()) {
1761  return InitError(strprintf(_("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
1762  }
1763  SetProxy(NET_I2P, Proxy{addr});
1764  } else {
1765  if (args.IsArgSet("-onlynet") && IsReachable(NET_I2P)) {
1766  return InitError(
1767  _("Outbound connections restricted to i2p (-onlynet=i2p) but "
1768  "-i2psam is not provided"));
1769  }
1770  SetReachable(NET_I2P, false);
1771  }
1772 
1773  connOptions.m_i2p_accept_incoming = args.GetBoolArg("-i2pacceptincoming", true);
1774 
1775  if (!node.connman->Start(*node.scheduler, connOptions)) {
1776  return false;
1777  }
1778 
1779  // ********************************************************* Step 13: finished
1780 
1781  // At this point, the RPC is "started", but still in warmup, which means it
1782  // cannot yet be called. Before we make it callable, we need to make sure
1783  // that the RPC's view of the best block is valid and consistent with
1784  // ChainstateManager's active tip.
1785  //
1786  // If we do not do this, RPC's view of the best block will be height=0 and
1787  // hash=0x0. This will lead to erroroneous responses for things like
1788  // waitforblockheight.
1789  RPCNotifyBlockChange(WITH_LOCK(chainman.GetMutex(), return chainman.ActiveTip()));
1791 
1792  uiInterface.InitMessage(_("Done loading").translated);
1793 
1794  for (const auto& client : node.chain_clients) {
1795  client->start(*node.scheduler);
1796  }
1797 
1798  BanMan* banman = node.banman.get();
1799  node.scheduler->scheduleEvery([banman]{
1800  banman->DumpBanlist();
1801  }, DUMP_BANS_INTERVAL);
1802 
1803  if (node.peerman) node.peerman->StartScheduledTasks(*node.scheduler);
1804 
1805 #if HAVE_SYSTEM
1806  StartupNotify(args);
1807 #endif
1808 
1809  return true;
1810 }
static const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS
Maximum number of block-relay-only outgoing connections.
Definition: net.h:71
static void BlockNotifyGenesisWait(const CBlockIndex *pBlockIndex)
Definition: init.cpp:617
bool Start()
Start initializes the sync state and registers the instance as a ValidationInterface so that it stays...
Definition: base.cpp:381
static const int DEFAULT_SCRIPTCHECK_THREADS
-par default (number of script-checking threads, 0 = auto)
Definition: validation.h:65
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:898
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:173
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const std::string &chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 18445) have been chosen arbitrarily to...
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: system.cpp:393
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument &#39;checklevel&#39;.
Definition: validation.cpp:96
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: system.cpp:500
fs::path FeeestPath(const ArgsManager &argsman)
Definition: fees_args.cpp:9
bool ShutdownRequested()
Returns true if a shutdown is requested, false otherwise.
Definition: shutdown.cpp:89
bool ShouldPersistMempool(const ArgsManager &argsman)
bilingual_str ResolveErrMsg(const std::string &optname, const std::string &strBind)
Definition: error.cpp:47
ArgsManager gArgs
Definition: system.cpp:86
fs::path AbsPathForConfigVal(const fs::path &path, bool net_specific)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
Definition: system.cpp:1424
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
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:124
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:745
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:88
BCLog::Logger & LogInstance()
Definition: logging.cpp:20
Definition: banman.h:58
ServiceFlags
nServices flags
Definition: protocol.h:267
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:57
uint16_t GetPort() const
Definition: netaddress.cpp:851
CClientUIInterface uiInterface
CBlockIndex * m_best_header
Best header we&#39;ve seen so far (used for getheaders queries&#39; starting points).
Definition: validation.h:922
#define LogPrint(category,...)
Definition: logging.h:243
int64_t GetBlockTime() const
Definition: chain.h:284
assert(!tx.IsCoinBase())
static const int DEFAULT_HTTP_SERVER_TIMEOUT
Definition: httpserver.h:14
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:265
void SetupServerArgs(ArgsManager &argsman)
Register all arguments with the ArgsManager.
Definition: init.cpp:385
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:68
static const unsigned int MAX_OP_RETURN_RELAY
Default setting for -datacarriersize.
Definition: standard.h: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: system.cpp:685
void Shutdown(NodeContext &node)
Definition: init.cpp:211
static const std::string REGTEST
int64_t block_tree_db
Definition: caches.h:15
Bilingual messages:
Definition: translation.h:18
bool IsHexNumber(std::string_view str)
Return true if the string is a hex number, optionally prefixed with "0x".
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
Definition: server.cpp:328
static const unsigned int DEFAULT_RPC_SERIALIZE_VERSION
Definition: server.h:19
ChainstateLoadResult VerifyLoadedChainstate(ChainstateManager &chainman, const ChainstateLoadOptions &options)
Definition: chainstate.cpp:152
bool BlockFilterTypeByName(const std::string &name, BlockFilterType &filter_type)
Find a filter type by its human-readable name.
static boost::signals2::connection rpc_notify_block_change_connection
Definition: init.cpp:371
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:799
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT
Definition: blockstorage.h:38
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:1164
static const int DEFAULT_HTTP_WORKQUEUE
Definition: httpserver.h:13
static void RegisterAllCoreRPCCommands(CRPCTable &t)
Definition: register.h:24
IPv4.
Definition: netaddress.h:49
std::vector< bool > DecodeAsmap(fs::path path)
Read asmap from provided binary file.
Definition: asmap.cpp:197
static void OnRPCStarted()
Definition: init.cpp:372
static const int64_t DEFAULT_MAX_TIP_AGE
Definition: validation.h:66
static void HandleSIGTERM(int)
Signal handlers are very limited in what they are allowed to do.
Definition: init.cpp:342
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
static const bool DEFAULT_ACCEPT_DATACARRIER
Definition: standard.h:19
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:48
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:74
void StartREST(const std::any &context)
Start HTTP REST subsystem.
Definition: rest.cpp:953
static constexpr bool DEFAULT_RPC_DOC_CHECK
Definition: util.h:24
const char * prefix
Definition: rest.cpp:938
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:965
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: system.cpp:732
static constexpr int DEFAULT_CHECKLEVEL
Definition: validation.h:76
int Height() const
Return the maximal height in the chain.
Definition: chain.h:468
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:690
void StopREST()
Stop HTTP REST subsystem.
Definition: rest.cpp:965
void OnStopped(std::function< void()> slot)
Definition: server.cpp:75
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:75
std::atomic< bool > m_reopen_file
Definition: logging.h:122
std::optional< bilingual_str > ApplyArgsManOptions(const ArgsManager &argsman, const CChainParams &chainparams, MemPoolOptions &mempool_opts)
Overlay the options set in argsman on top of corresponding members in mempool_opts.
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:69
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:377
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
arith_uint256 nMinimumChainWork
Minimum work we will assume exists on some valid chain.
Definition: validation.cpp:132
const auto cmd
#define PACKAGE_NAME
void InterruptRPC()
Definition: server.cpp:294
const std::set< BlockFilterType > & AllBlockFilterTypes()
Get a list of known filter types.
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:97
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:2164
const CBlock & GenesisBlock() const
Definition: chainparams.h:95
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system...
Definition: chainparams.h:69
void UnregisterAllValidationInterfaces()
Unregister all subscribers.
bool InitShutdownState()
Initialize shutdown state.
Definition: shutdown.cpp:47
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: system.cpp:654
std::function< bool()> check_interrupt
Definition: chainstate.h:30
void StartMapPort(bool use_upnp, bool use_natpmp)
Definition: mapport.cpp:327
const char *const BITCOIN_SETTINGS_FILENAME
Definition: system.cpp:84
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:614
static const int64_t nMinDbCache
min. -dbcache (MiB)
Definition: txdb.h:34
std::optional< bilingual_str > SanityChecks(const Context &)
Ensure a usable environment with all necessary library support.
Definition: checks.cpp:16
bool StartHTTPRPC(const std::any &context)
Start HTTP RPC subsystem.
Definition: httprpc.cpp:294
static constexpr bool DEFAULT_PERMIT_BAREMULTISIG
Default for -permitbaremultisig.
Definition: policy.h:39
void RandAddPeriodic() noexcept
Gather entropy from various expensive sources, and feed them to the PRNG state.
Definition: random.cpp:582
void InterruptHTTPRPC()
Interrupt HTTP RPC subsystem.
Definition: httprpc.cpp:312
static constexpr unsigned int DEFAULT_BYTES_PER_SIGOP
Default for -bytespersigop.
Definition: policy.h:37
static void HandleSIGHUP(int)
Definition: init.cpp:347
void InitWarning(const bilingual_str &str)
Show warning message.
void SetLoggingCategories(const ArgsManager &args)
Definition: common.cpp:80
void StartTorControl(CService onion_service_target)
Definition: torcontrol.cpp:661
void InterruptHTTPServer()
Interrupt HTTP server threads.
Definition: httpserver.cpp:437
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:939
bool Lookup(const std::string &name, std::vector< CService > &vAddr, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:198
virtual void Construct(node::NodeContext &node) const =0
Add wallets that should be opened to list of chain clients.
static constexpr bool DEFAULT_DAEMON
Default value for -daemon option.
Definition: init.h:14
void SetReachable(enum Network net, bool reachable)
Mark a network as reachable or unreachable (no automatic connects to it)
Definition: net.cpp:325
I2P.
Definition: netaddress.h:58
ArgsManager args
void RPCNotifyBlockChange(const CBlockIndex *pindex)
Callback for when block tip changed.
Definition: blockchain.cpp:243
void Stop()
Stops the instance from staying in sync with blockchain updates.
Definition: base.cpp:400
disable validation
Definition: system.h:180
static const int MAX_FEELER_CONNECTIONS
Maximum number of feeler connections.
Definition: net.h:73
void StartScriptCheckWorkerThreads(int threads_num)
Run instances of script checking worker threads.
arith_uint256 UintToArith256(const uint256 &a)
bool AppInitBasicSetup(const ArgsManager &args)
Initialize bitcoin core: Basic context setup.
Definition: init.cpp:775
NodeClock::time_point GetAdjustedTime()
Definition: timedata.cpp:35
static constexpr unsigned int DEFAULT_ANCESTOR_SIZE_LIMIT_KVB
Default for -limitancestorsize, maximum kilobytes of tx + all in-mempool ancestors.
Definition: policy.h:61
static const std::string MAIN
Chain name strings.
static const bool DEFAULT_PEERBLOCKFILTERS
bool IsValid() const
Definition: netaddress.cpp:445
std::string SysErrorString(int err)
Return system error string from errno value.
Definition: syserror.cpp:15
static constexpr bool DEFAULT_UPNP
Definition: mapport.h:11
Common init functions shared by bitcoin-node, bitcoin-wallet, etc.
uint256 GetBlockHash() const
Definition: chain.h:264
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:91
bool InitSignatureCache(size_t max_size_bytes)
Definition: sigcache.cpp:96
void SetRPCWarmupFinished()
Definition: server.cpp:334
uint256 SerializeHash(const T &obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
Compute the 256-bit hash of an object&#39;s serialization.
Definition: hash.h:229
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
static const size_t DEFAULT_MAXRECEIVEBUFFER
Definition: net.h:90
BlockFilterType
Definition: blockfilter.h:89
NodeContext struct containing references to chain state and connection state.
Definition: context.h:43
disallow -foo syntax that doesn&#39;t assign any value
Definition: system.h:186
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:740
CRPCTable tableRPC
Definition: server.cpp:544
void SetLoggingLevel(const ArgsManager &args)
Definition: common.cpp:60
bool InitHTTPServer()
Initialize HTTP server.
Definition: httpserver.cpp:367
bool fCheckpointsEnabled
Definition: validation.cpp:128
static std::unique_ptr< PeerManager > make(CConnman &connman, AddrMan &addrman, BanMan *banman, ChainstateManager &chainman, CTxMemPool &pool, bool ignore_incoming_txs)
uint16_t GetListenPort()
Definition: net.cpp:128
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
Definition: system.cpp:599
const std::string & ListBlockFilterTypes()
Get a comma-separated list of known filter type names.
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: system.cpp:813
static CZMQNotificationInterface * Create()
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:150
uint64_t nPruneTarget
Number of bytes of block files that we&#39;re trying to stay below.
const std::string DEFAULT_TOR_CONTROL
Default control port.
Definition: torcontrol.cpp:34
Chainstate stores and provides an API to update our local knowledge of the current best chain...
Definition: validation.h:437
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:449
static std::condition_variable g_genesis_wait_cv
Definition: init.cpp:615
std::optional< bilingual_str > CheckLegacyTxindex(CBlockTreeDB &block_tree_db)
Definition: txdb.cpp:34
void Interrupt(NodeContext &node)
Interrupt threads.
Definition: init.cpp:192
static constexpr unsigned int DEFAULT_MAX_MEMPOOL_SIZE_MB
Default for -maxmempool, maximum megabytes of mempool memory usage.
#define LOCK(cs)
Definition: sync.h:261
const char * name
Definition: rest.cpp:46
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:65
bool AddLocal(const CService &addr_, int nScore)
Definition: net.cpp:285
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:520
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:1062
bool SetNameProxy(const Proxy &addrProxy)
Set the name proxy to use for all connections to nodes specified by a hostname.
Definition: netbase.cpp:632
uint256 uint256S(const char *str)
Definition: uint256.h:132
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: system.cpp:711
bool StartLogging(const ArgsManager &args)
Definition: common.cpp:104
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:85
int GetNumCores()
Return the number of cores available on the current system.
Definition: system.cpp:1413
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:1093
static constexpr bool DEFAULT_COINSTATSINDEX
Definition: validation.h:69
static const int DEFAULT_STOPATHEIGHT
Default for -stopatheight.
Definition: validation.h:72
static constexpr std::chrono::minutes DUMP_BANS_INTERVAL
How often to dump banned addresses/subnets to disk.
Definition: banman.h:22
bool DirIsWritable(const fs::path &directory)
Definition: system.cpp:133
const std::string CURRENCY_UNIT
Definition: feerate.h:17
static constexpr bool DEFAULT_FIXEDSEEDS
Definition: net.h:89
CMainSignals & GetMainSignals()
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:967
static const int64_t nDefaultDbCache
-dbcache default (MiB)
Definition: txdb.h:28
Network
A network type.
Definition: netaddress.h:44
bool InitScriptExecutionCache(size_t max_size_bytes)
Initializes the script-execution cache.
#define LogPrintfCategory(category,...)
Definition: logging.h:237
Block and header tip information.
Definition: node.h:49
const CMessageHeader::MessageStartChars & MessageStart() const
Definition: chainparams.h:83
static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS
The maximum number of peer connections to maintain.
Definition: net.h:77
#define WAIT_LOCK(cs, name)
Definition: sync.h:266
static constexpr bool DEFAULT_DNSSEED
Definition: net.h:88
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:30
std::string ToString() const
Definition: uint256.cpp:64
void StartRPC()
Definition: server.cpp:287
void SetSyscallSandboxPolicy(SyscallSandboxPolicy syscall_policy)
Force the current thread (and threads created from the current thread) into a restricted-service oper...
static fs::path GetPidFile(const ArgsManager &args)
Definition: init.cpp:147
static GlobalMutex g_genesis_wait_mutex
Definition: init.cpp:614
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:892
void StopScriptCheckWorkerThreads()
Stop all of the script checking worker threads.
bool IsValid() const
Definition: netbase.h:54
void ApplyArgsManOptions(const ArgsManager &argsman, ValidationCacheSizes &cache_sizes)
int64_t GetBlockTime() const
Definition: block.h:61
const std::string CLIENT_NAME
std::string strSubVersion
Subversion as sent to the P2P network in version messages.
Definition: net.cpp:120
static const int DEFAULT_NAME_LOOKUP
-dns default
Definition: netbase.h:30
bool LockDirectory(const fs::path &directory, const fs::path &lockfile_name, bool probe_only)
Definition: system.cpp:97
int RaiseFileDescriptorLimit(int nMinFD)
this function tries to raise the file descriptor limit to the requested number.
Definition: system.cpp:1227
void SetLoggingOptions(const ArgsManager &args)
Definition: common.cpp:45
static const char *const DEFAULT_BLOCKFILTERINDEX
Definition: validation.h:70
int nConnectTimeout
Definition: netbase.cpp:36
static const int DEFAULT_ZMQ_SNDHWM
Chainstate &InitializeChainstate(CTxMemPool *mempool, const std::optional< uint256 > &snapshot_blockhash=std::nullopt) LIFETIMEBOUND EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate and assign it based upon whether it is from a snapshot.
Definition: validation.h:945
static const bool DEFAULT_PROXYRANDOMIZE
Definition: init.cpp:128
void AddLoggingArgs(ArgsManager &argsman)
Definition: common.cpp:24
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:305
int64_t nMaxTipAge
If the tip is older than this (in seconds), the node is considered to be in initial block download...
Definition: validation.cpp:129
int64_t coins
Definition: caches.h:17
void DumpBanlist()
Definition: banman.cpp:47
std::thread m_load_block
Definition: validation.h:895
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:121
uint256 hashAssumeValid
Block hash whose ancestors we will assume to have valid scripts without checking them.
Definition: validation.cpp:131
node::BlockMap & BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:969
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: system.cpp:146
Definition: init.h:25
void StopHTTPRPC()
Stop HTTP RPC subsystem.
Definition: httprpc.cpp:317
std::function< void()> coins_error_cb
Definition: chainstate.h:31
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:87
Definition: netbase.h:48
bool fPruneMode
Pruning-related variables and constants.
const char *const BITCOIN_CONF_FILENAME
Definition: system.cpp:83
static constexpr unsigned int DUST_RELAY_TX_FEE
Min feerate for defining dust.
Definition: policy.h:55
CBlockPolicyEstimator * estimator
const CChainParams & GetParams() const
Definition: validation.h:878
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:16
void LogPackageVersion()
Definition: common.cpp:141
void RegisterBackgroundSignalScheduler(CScheduler &scheduler)
Register a CScheduler to give callbacks which should run in the background (may only be called once) ...
std::string get_filesystem_error_message(const fs::filesystem_error &e)
Definition: fs.cpp:138
void UnregisterValidationInterface(CValidationInterface *callbacks)
Unregister subscriber.
256-bit opaque blob.
Definition: uint256.h:119
bool fCheckBlockIndex
Definition: validation.cpp:127
static constexpr bool DEFAULT_NATPMP
Definition: mapport.h:17
bool IsReachable(enum Network net)
Definition: net.cpp:333
static const bool DEFAULT_PEERBLOOMFILTERS
void RegisterZMQRPCCommands(CRPCTable &t)
Definition: zmqrpc.cpp:60
uint256 nMinimumChainWork
The best chain should have at least this much work.
Definition: params.h:119
bool g_parallel_script_checks
Whether there are dedicated script-checking threads running.
Definition: validation.cpp:126
static const bool DEFAULT_CHECKPOINTS_ENABLED
Definition: validation.h:67
const WalletInitInterface & g_wallet_init_interface
Definition: init.cpp:144
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
Definition: interfaces.cpp:783
static constexpr unsigned int DEFAULT_MISBEHAVING_BANTIME
Definition: banman.h:19
static const bool DEFAULT_WHITELISTFORCERELAY
Default for -whitelistforcerelay.
Definition: net.h:54
const ChainTxData & TxData() const
Definition: chainparams.h:124
unsigned int nBytesPerSigOp
Definition: settings.cpp:10
void StopRPC()
Definition: server.cpp:305
const auto command
static const char * DEFAULT_ASMAP_FILENAME
Definition: init.cpp:140
uint256 defaultAssumeValid
By default assume that the signatures in ancestors of this block are valid.
Definition: params.h:121
static const size_t DEFAULT_MAXSENDBUFFER
Definition: net.h:91
virtual bool ParameterInteraction() const =0
Check wallet parameter interaction.
static void new_handler_terminate()
Definition: init.cpp:762
The block chain is a tree shaped structure starting with the genesis block at the root...
Definition: chain.h:151
const CChainParams & Params()
Return the currently selected parameters.
void FlushBackgroundCallbacks()
Call any remaining callbacks on the calling thread.
static const signed int DEFAULT_CHECKBLOCKS
Definition: validation.h:75
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:323
fs::path MempoolPath(const ArgsManager &argsman)
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: system.cpp:629
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...
static const unsigned int DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN
Default number of orphan+recently-replaced txn to keep around for block reconstruction.
std::optional< bilingual_str > LoadAddrman(const NetGroupManager &netgroupman, const ArgsManager &args, std::unique_ptr< AddrMan > &addrman)
Returns an error string on failure.
Definition: addrdb.cpp:184
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: system.cpp:604
ServiceFlags nLocalServices
Definition: net.h:672
void InterruptREST()
Interrupt RPC REST subsystem.
Definition: rest.cpp:961
int64_t tx_index
Definition: caches.h:18
std::string ToStringIPPort() const
Definition: netaddress.cpp:924
static const int DEFAULT_CONNECT_TIMEOUT
-timeout default
Definition: netbase.h:28
Context struct holding the kernel library&#39;s logically global state, and passed to external libbitcoin...
Definition: context.h:20
static constexpr int32_t DEFAULT_ADDRMAN_CONSISTENCY_CHECKS
Default for -checkaddrman.
Definition: addrman.h:30
static const int64_t nMaxDbCache
max. -dbcache (MiB)
Definition: txdb.h:32
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate...
Definition: validation.cpp:121
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:439
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...
IPv6.
Definition: netaddress.h:52
std::string GetHex() const
Definition: uint256.cpp:20
bool AppInitParameterInteraction(const ArgsManager &args, bool use_syscall_sandbox)
Initialization: parameter interaction.
Definition: init.cpp:820
TOR (v2 or v3)
Definition: netaddress.h:55
void AbortShutdown()
Clear shutdown flag.
Definition: shutdown.cpp:79
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:1061
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
void ThreadImport(ChainstateManager &chainman, std::vector< fs::path > vImportFiles, const ArgsManager &args, const fs::path &mempool_path)
static constexpr bool DEFAULT_FORCEDNSSEED
Definition: net.h:87
CService DefaultOnionServiceTarget()
Definition: torcontrol.cpp:699
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:65
static const int64_t DEFAULT_PEER_CONNECT_TIMEOUT
-peertimeout default
Definition: net.h:83
void StartShutdown()
Request shutdown of the application.
Definition: shutdown.cpp:58
static const bool DEFAULT_BLOCKSONLY
Default for blocks only.
Definition: net.h:81
static const std::string TESTNET
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:425
std::string GetChainName() const
Returns the appropriate chain name from the program arguments.
Definition: system.cpp:1058
std::unique_ptr< CoinStatsIndex > g_coin_stats_index
The global UTXO set hash object.
const std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
Definition: system.cpp:278
const fs::path & GetBlocksDirPath() const
Get blocks directory path.
Definition: system.cpp:403
static constexpr size_t DEFAULT_MAX_SIG_CACHE_BYTES
Definition: sigcache.h:19
static auto quoted(const std::string &s)
Definition: fs.h:94
void InterruptTorControl()
Definition: torcontrol.cpp:680
void OnStarted(std::function< void()> slot)
Definition: server.cpp:70
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:1087
void InterruptMapPort()
Definition: mapport.cpp:331
static const bool DEFAULT_WHITELISTRELAY
Default for -whitelistrelay.
Definition: net.h:52
bool AppInitLockDataDirectory()
Lock bitcoin core data directory.
Definition: init.cpp:1075
static const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS
Maximum number of automatic outgoing nodes over which we&#39;ll relay everything (blocks, tx, addrs, etc)
Definition: net.h:67
Options struct containing options for constructing a CTxMemPool.
static bool TryParse(const std::string &str, NetWhitebindPermissions &output, bilingual_str &error)
Different type to mark Mutex at global scope.
Definition: sync.h:141
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:164
static const char * BITCOIN_PID_FILENAME
The PID file facilities.
Definition: init.cpp:145
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:82
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman, const CacheSizes &cache_sizes, const ChainstateLoadOptions &options)
This sequence can have 4 types of outcomes:
Definition: chainstate.cpp:28
static void registerSignalHandler(int signal, void(*handler)(int))
Definition: init.cpp:361
static const uint64_t MIN_DISK_SPACE_FOR_BLOCK_FILES
Definition: validation.h:85
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: system.cpp:491
int64_t coins_db
Definition: caches.h:16
static bool exists(const path &p)
Definition: fs.h:88
#define MIN_CORE_FILEDESCRIPTORS
Definition: init.cpp:137
#define LogPrintf(...)
Definition: logging.h:234
bool SetupNetworking()
Definition: system.cpp:1401
static const unsigned int DEFAULT_MAX_ORPHAN_TRANSACTIONS
Default for -maxorphantx, maximum number of orphan transactions kept in memory.
static const bool DEFAULT_PRINTPRIORITY
Definition: miner.h:27
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:30
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:28
CJDNS.
Definition: netaddress.h:61
const 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: system.cpp:258
bool error(const char *fmt, const Args &... args)
Definition: system.h:48
void StopMapPort()
Definition: mapport.cpp:335
BIP-0014 subset.
Definition: strencodings.h:30
static bool CreatePidFile(const ArgsManager &args)
Definition: init.cpp:152
static const std::string SIGNET
static const bool DEFAULT_TXINDEX
Definition: validation.h:68
static const int DEFAULT_HTTP_THREADS
Definition: httpserver.h:12
static const bool DEFAULT_REST_ENABLE
Definition: init.cpp:129
static bool AppInitServers(NodeContext &node)
Definition: init.cpp:639
bool fNameLookup
Definition: netbase.cpp:37
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:656
static const int64_t DEFAULT_MAX_TIME_ADJUSTMENT
Definition: timedata.h:16
static const int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
Definition: validation.h:63
#define Assert(val)
Identity function.
Definition: check.h:74
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:20
const fs::path & GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: system.h:303
CZMQNotificationInterface * g_zmq_notification_interface
static bool LockDataDirectory(bool probeOnly)
Definition: init.cpp:1048
const std::string & BlockFilterTypeName(BlockFilterType filter_type)
Get the human-readable name for a filter type.
static bool fHaveGenesis
Definition: init.cpp:613
void TraceThread(std::string_view thread_name, std::function< void()> thread_func)
A wrapper for do-something-once thread functions.
Definition: thread.cpp:16
static const std::string DEFAULT_MAX_UPLOAD_TARGET
The default for -maxuploadtarget.
Definition: net.h:79
std::unique_ptr< const CChainParams > CreateChainParams(const ArgsManager &args, const std::string &chain)
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain.
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:46