Fix constness of ArgsManager methods
[bitcoinplatinum.git] / src / init.cpp
blob0d32df4e26c806d87f28f58380df4f8bc851c8cc
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 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.
6 #if defined(HAVE_CONFIG_H)
7 #include "config/bitcoin-config.h"
8 #endif
10 #include "init.h"
12 #include "addrman.h"
13 #include "amount.h"
14 #include "chain.h"
15 #include "chainparams.h"
16 #include "checkpoints.h"
17 #include "compat/sanity.h"
18 #include "consensus/validation.h"
19 #include "fs.h"
20 #include "httpserver.h"
21 #include "httprpc.h"
22 #include "key.h"
23 #include "validation.h"
24 #include "miner.h"
25 #include "netbase.h"
26 #include "net.h"
27 #include "net_processing.h"
28 #include "policy/feerate.h"
29 #include "policy/fees.h"
30 #include "policy/policy.h"
31 #include "rpc/server.h"
32 #include "rpc/register.h"
33 #include "rpc/blockchain.h"
34 #include "script/standard.h"
35 #include "script/sigcache.h"
36 #include "scheduler.h"
37 #include "timedata.h"
38 #include "txdb.h"
39 #include "txmempool.h"
40 #include "torcontrol.h"
41 #include "ui_interface.h"
42 #include "util.h"
43 #include "utilmoneystr.h"
44 #include "validationinterface.h"
45 #ifdef ENABLE_WALLET
46 #include "wallet/wallet.h"
47 #endif
48 #include "warnings.h"
49 #include <stdint.h>
50 #include <stdio.h>
51 #include <memory>
53 #ifndef WIN32
54 #include <signal.h>
55 #endif
57 #include <boost/algorithm/string/classification.hpp>
58 #include <boost/algorithm/string/replace.hpp>
59 #include <boost/algorithm/string/split.hpp>
60 #include <boost/bind.hpp>
61 #include <boost/interprocess/sync/file_lock.hpp>
62 #include <boost/thread.hpp>
63 #include <openssl/crypto.h>
65 #if ENABLE_ZMQ
66 #include "zmq/zmqnotificationinterface.h"
67 #endif
69 bool fFeeEstimatesInitialized = false;
70 static const bool DEFAULT_PROXYRANDOMIZE = true;
71 static const bool DEFAULT_REST_ENABLE = false;
72 static const bool DEFAULT_DISABLE_SAFEMODE = false;
73 static const bool DEFAULT_STOPAFTERBLOCKIMPORT = false;
75 std::unique_ptr<CConnman> g_connman;
76 std::unique_ptr<PeerLogicValidation> peerLogic;
78 #if ENABLE_ZMQ
79 static CZMQNotificationInterface* pzmqNotificationInterface = NULL;
80 #endif
82 #ifdef WIN32
83 // Win32 LevelDB doesn't use filedescriptors, and the ones used for
84 // accessing block files don't count towards the fd_set size limit
85 // anyway.
86 #define MIN_CORE_FILEDESCRIPTORS 0
87 #else
88 #define MIN_CORE_FILEDESCRIPTORS 150
89 #endif
91 static const char* FEE_ESTIMATES_FILENAME="fee_estimates.dat";
93 //////////////////////////////////////////////////////////////////////////////
95 // Shutdown
99 // Thread management and startup/shutdown:
101 // The network-processing threads are all part of a thread group
102 // created by AppInit() or the Qt main() function.
104 // A clean exit happens when StartShutdown() or the SIGTERM
105 // signal handler sets fRequestShutdown, which triggers
106 // the DetectShutdownThread(), which interrupts the main thread group.
107 // DetectShutdownThread() then exits, which causes AppInit() to
108 // continue (it .joins the shutdown thread).
109 // Shutdown() is then
110 // called to clean up database connections, and stop other
111 // threads that should only be stopped after the main network-processing
112 // threads have exited.
114 // Shutdown for Qt is very similar, only it uses a QTimer to detect
115 // fRequestShutdown getting set, and then does the normal Qt
116 // shutdown thing.
119 std::atomic<bool> fRequestShutdown(false);
120 std::atomic<bool> fDumpMempoolLater(false);
122 void StartShutdown()
124 fRequestShutdown = true;
126 bool ShutdownRequested()
128 return fRequestShutdown;
132 * This is a minimally invasive approach to shutdown on LevelDB read errors from the
133 * chainstate, while keeping user interface out of the common library, which is shared
134 * between bitcoind, and bitcoin-qt and non-server tools.
136 class CCoinsViewErrorCatcher : public CCoinsViewBacked
138 public:
139 CCoinsViewErrorCatcher(CCoinsView* view) : CCoinsViewBacked(view) {}
140 bool GetCoin(const COutPoint &outpoint, Coin &coin) const override {
141 try {
142 return CCoinsViewBacked::GetCoin(outpoint, coin);
143 } catch(const std::runtime_error& e) {
144 uiInterface.ThreadSafeMessageBox(_("Error reading from database, shutting down."), "", CClientUIInterface::MSG_ERROR);
145 LogPrintf("Error reading from database: %s\n", e.what());
146 // Starting the shutdown sequence and returning false to the caller would be
147 // interpreted as 'entry not found' (as opposed to unable to read data), and
148 // could lead to invalid interpretation. Just exit immediately, as we can't
149 // continue anyway, and all writes should be atomic.
150 abort();
153 // Writes do not need similar protection, as failure to write is handled by the caller.
156 static CCoinsViewErrorCatcher *pcoinscatcher = NULL;
157 static std::unique_ptr<ECCVerifyHandle> globalVerifyHandle;
159 void Interrupt(boost::thread_group& threadGroup)
161 InterruptHTTPServer();
162 InterruptHTTPRPC();
163 InterruptRPC();
164 InterruptREST();
165 InterruptTorControl();
166 if (g_connman)
167 g_connman->Interrupt();
168 threadGroup.interrupt_all();
171 void Shutdown()
173 LogPrintf("%s: In progress...\n", __func__);
174 static CCriticalSection cs_Shutdown;
175 TRY_LOCK(cs_Shutdown, lockShutdown);
176 if (!lockShutdown)
177 return;
179 /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
180 /// for example if the data directory was found to be locked.
181 /// Be sure that anything that writes files or flushes caches only does this if the respective
182 /// module was initialized.
183 RenameThread("bitcoin-shutoff");
184 mempool.AddTransactionsUpdated(1);
186 StopHTTPRPC();
187 StopREST();
188 StopRPC();
189 StopHTTPServer();
190 #ifdef ENABLE_WALLET
191 for (CWalletRef pwallet : vpwallets) {
192 pwallet->Flush(false);
194 #endif
195 MapPort(false);
196 UnregisterValidationInterface(peerLogic.get());
197 peerLogic.reset();
198 g_connman.reset();
200 StopTorControl();
201 UnregisterNodeSignals(GetNodeSignals());
202 if (fDumpMempoolLater && GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
203 DumpMempool();
206 if (fFeeEstimatesInitialized)
208 ::feeEstimator.FlushUnconfirmed(::mempool);
209 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
210 CAutoFile est_fileout(fsbridge::fopen(est_path, "wb"), SER_DISK, CLIENT_VERSION);
211 if (!est_fileout.IsNull())
212 ::feeEstimator.Write(est_fileout);
213 else
214 LogPrintf("%s: Failed to write fee estimates to %s\n", __func__, est_path.string());
215 fFeeEstimatesInitialized = false;
218 // FlushStateToDisk generates a SetBestChain callback, which we should avoid missing
219 FlushStateToDisk();
221 // After there are no more peers/RPC left to give us new data which may generate
222 // CValidationInterface callbacks, flush them...
223 GetMainSignals().FlushBackgroundCallbacks();
225 // Any future callbacks will be dropped. This should absolutely be safe - if
226 // missing a callback results in an unrecoverable situation, unclean shutdown
227 // would too. The only reason to do the above flushes is to let the wallet catch
228 // up with our current chain to avoid any strange pruning edge cases and make
229 // next startup faster by avoiding rescan.
232 LOCK(cs_main);
233 if (pcoinsTip != NULL) {
234 FlushStateToDisk();
236 delete pcoinsTip;
237 pcoinsTip = NULL;
238 delete pcoinscatcher;
239 pcoinscatcher = NULL;
240 delete pcoinsdbview;
241 pcoinsdbview = NULL;
242 delete pblocktree;
243 pblocktree = NULL;
245 #ifdef ENABLE_WALLET
246 for (CWalletRef pwallet : vpwallets) {
247 pwallet->Flush(true);
249 #endif
251 #if ENABLE_ZMQ
252 if (pzmqNotificationInterface) {
253 UnregisterValidationInterface(pzmqNotificationInterface);
254 delete pzmqNotificationInterface;
255 pzmqNotificationInterface = NULL;
257 #endif
259 #ifndef WIN32
260 try {
261 fs::remove(GetPidFile());
262 } catch (const fs::filesystem_error& e) {
263 LogPrintf("%s: Unable to remove pidfile: %s\n", __func__, e.what());
265 #endif
266 UnregisterAllValidationInterfaces();
267 GetMainSignals().UnregisterBackgroundSignalScheduler();
268 #ifdef ENABLE_WALLET
269 for (CWalletRef pwallet : vpwallets) {
270 delete pwallet;
272 vpwallets.clear();
273 #endif
274 globalVerifyHandle.reset();
275 ECC_Stop();
276 LogPrintf("%s: done\n", __func__);
280 * Signal handlers are very limited in what they are allowed to do.
281 * The execution context the handler is invoked in is not guaranteed,
282 * so we restrict handler operations to just touching variables:
284 static void HandleSIGTERM(int)
286 fRequestShutdown = true;
289 static void HandleSIGHUP(int)
291 fReopenDebugLog = true;
294 #ifndef WIN32
295 static void registerSignalHandler(int signal, void(*handler)(int))
297 struct sigaction sa;
298 sa.sa_handler = handler;
299 sigemptyset(&sa.sa_mask);
300 sa.sa_flags = 0;
301 sigaction(signal, &sa, NULL);
303 #endif
305 void OnRPCStarted()
307 uiInterface.NotifyBlockTip.connect(&RPCNotifyBlockChange);
310 void OnRPCStopped()
312 uiInterface.NotifyBlockTip.disconnect(&RPCNotifyBlockChange);
313 RPCNotifyBlockChange(false, nullptr);
314 cvBlockChange.notify_all();
315 LogPrint(BCLog::RPC, "RPC stopped.\n");
318 void OnRPCPreCommand(const CRPCCommand& cmd)
320 // Observe safe mode
321 std::string strWarning = GetWarnings("rpc");
322 if (strWarning != "" && !GetBoolArg("-disablesafemode", DEFAULT_DISABLE_SAFEMODE) &&
323 !cmd.okSafeMode)
324 throw JSONRPCError(RPC_FORBIDDEN_BY_SAFE_MODE, std::string("Safe mode: ") + strWarning);
327 std::string HelpMessage(HelpMessageMode mode)
329 const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
330 const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
331 const auto defaultChainParams = CreateChainParams(CBaseChainParams::MAIN);
332 const auto testnetChainParams = CreateChainParams(CBaseChainParams::TESTNET);
333 const bool showDebug = GetBoolArg("-help-debug", false);
335 // When adding new options to the categories, please keep and ensure alphabetical ordering.
336 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
337 std::string strUsage = HelpMessageGroup(_("Options:"));
338 strUsage += HelpMessageOpt("-?", _("Print this help message and exit"));
339 strUsage += HelpMessageOpt("-version", _("Print version and exit"));
340 strUsage += HelpMessageOpt("-alertnotify=<cmd>", _("Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message)"));
341 strUsage += HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
342 if (showDebug)
343 strUsage += HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY));
344 strUsage +=HelpMessageOpt("-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)"), defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnetChainParams->GetConsensus().defaultAssumeValid.GetHex()));
345 strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
346 if (mode == HMM_BITCOIND)
348 #if HAVE_DECL_DAEMON
349 strUsage += HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
350 #endif
352 strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
353 if (showDebug) {
354 strUsage += HelpMessageOpt("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize));
356 strUsage += HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache));
357 if (showDebug)
358 strUsage += HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER));
359 strUsage += HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
360 strUsage += HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS));
361 strUsage += HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE));
362 strUsage += HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY));
363 strUsage += HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL));
364 strUsage += HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN));
365 strUsage += HelpMessageOpt("-par=<n>", strprintf(_("Set the number of script verification threads (%u to %d, 0 = auto, <0 = leave that many cores free, default: %d)"),
366 -GetNumCores(), MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS));
367 #ifndef WIN32
368 strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
369 #endif
370 strUsage += HelpMessageOpt("-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 and -rescan. "
371 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
372 "(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));
373 strUsage += HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
374 strUsage += HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
375 #ifndef WIN32
376 strUsage += HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
377 #endif
378 strUsage += HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX));
380 strUsage += HelpMessageGroup(_("Connection options:"));
381 strUsage += HelpMessageOpt("-addnode=<ip>", _("Add a node to connect to and attempt to keep the connection open"));
382 strUsage += HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD));
383 strUsage += HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME));
384 strUsage += HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
385 strUsage += HelpMessageOpt("-connect=<ip>", _("Connect only to the specified node(s); -connect=0 disables automatic connections"));
386 strUsage += HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
387 strUsage += HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP));
388 strUsage += HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
389 strUsage += HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
390 strUsage += HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED));
391 strUsage += HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
392 strUsage += HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION));
393 strUsage += HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS));
394 strUsage += HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER));
395 strUsage += HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER));
396 strUsage += HelpMessageOpt("-maxtimeadjustment", strprintf(_("Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: %u seconds)"), DEFAULT_MAX_TIME_ADJUSTMENT));
397 strUsage += HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
398 strUsage += HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
399 strUsage += HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG));
400 strUsage += HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS));
401 strUsage += HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort()));
402 strUsage += HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
403 strUsage += HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE));
404 strUsage += HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
405 strUsage += HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT));
406 strUsage += HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL));
407 strUsage += HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
408 #ifdef USE_UPNP
409 #if USE_UPNP
410 strUsage += HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
411 #else
412 strUsage += HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
413 #endif
414 #endif
415 strUsage += HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
416 strUsage += HelpMessageOpt("-whitelist=<IP address or network>", _("Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple times.") +
417 " " + _("Whitelisted peers cannot be DoS banned and their transactions are always relayed, even if they are already in the mempool, useful e.g. for a gateway"));
418 strUsage += HelpMessageOpt("-maxuploadtarget=<n>", strprintf(_("Tries to keep outbound traffic under the given target (in MiB per 24h), 0 = no limit (default: %d)"), DEFAULT_MAX_UPLOAD_TARGET));
420 #ifdef ENABLE_WALLET
421 strUsage += CWallet::GetWalletHelpString(showDebug);
422 #endif
424 #if ENABLE_ZMQ
425 strUsage += HelpMessageGroup(_("ZeroMQ notification options:"));
426 strUsage += HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
427 strUsage += HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
428 strUsage += HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
429 strUsage += HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
430 #endif
432 strUsage += HelpMessageGroup(_("Debugging/Testing options:"));
433 strUsage += HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
434 if (showDebug)
436 strUsage += HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS));
437 strUsage += HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL));
438 strUsage += HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
439 strUsage += HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
440 strUsage += HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED));
441 strUsage += HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE));
442 strUsage += HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE));
443 strUsage += HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
444 strUsage += HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
445 strUsage += HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT));
446 strUsage += HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT));
448 strUsage += HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT));
449 strUsage += HelpMessageOpt("-limitancestorsize=<n>", strprintf("Do not accept transactions whose size with all in-mempool ancestors exceeds <n> kilobytes (default: %u)", DEFAULT_ANCESTOR_SIZE_LIMIT));
450 strUsage += HelpMessageOpt("-limitdescendantcount=<n>", strprintf("Do not accept transactions if any ancestor would have <n> or more in-mempool descendants (default: %u)", DEFAULT_DESCENDANT_LIMIT));
451 strUsage += HelpMessageOpt("-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));
452 strUsage += HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
454 strUsage += HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
455 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
456 strUsage += HelpMessageOpt("-debugexclude=<category>", strprintf(_("Exclude debugging information for a category. Can be used in conjunction with -debug=1 to output debug logs for all categories except one or more specified categories.")));
457 strUsage += HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
458 strUsage += HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS));
459 strUsage += HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS));
460 if (showDebug)
462 strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
463 strUsage += HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
464 strUsage += HelpMessageOpt("-maxsigcachesize=<n>", strprintf("Limit sum of signature cache and script execution cache sizes to <n> MiB (default: %u)", DEFAULT_MAX_SIG_CACHE_SIZE));
465 strUsage += HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE));
467 strUsage += HelpMessageOpt("-maxtxfee=<amt>", strprintf(_("Maximum total fees (in %s) to use in a single wallet transaction or raw transaction; setting this too low may abort large transactions (default: %s)"),
468 CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MAXFEE)));
469 strUsage += HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
470 if (showDebug)
472 strUsage += HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY));
474 strUsage += HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
476 AppendParamsHelpMessages(strUsage, showDebug);
478 strUsage += HelpMessageGroup(_("Node relay options:"));
479 if (showDebug) {
480 strUsage += HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", defaultChainParams->RequireStandard()));
481 strUsage += HelpMessageOpt("-incrementalrelayfee=<amt>", strprintf("Fee rate (in %s/kB) used to define cost of relay, used for mempool limiting and BIP 125 replacement. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_INCREMENTAL_RELAY_FEE)));
482 strUsage += HelpMessageOpt("-dustrelayfee=<amt>", strprintf("Fee rate (in %s/kB) used to defined 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)));
484 strUsage += HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP));
485 strUsage += HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER));
486 strUsage += HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY));
487 strUsage += HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT));
488 strUsage += HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
489 CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)));
490 strUsage += HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY));
491 strUsage += HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY));
493 strUsage += HelpMessageGroup(_("Block creation options:"));
494 strUsage += HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT));
495 strUsage += HelpMessageOpt("-blockmaxsize=<n>", strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE));
496 strUsage += HelpMessageOpt("-blockmintxfee=<amt>", strprintf(_("Set lowest fee rate (in %s/kB) for transactions to be included in block creation. (default: %s)"), CURRENCY_UNIT, FormatMoney(DEFAULT_BLOCK_MIN_TX_FEE)));
497 if (showDebug)
498 strUsage += HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
500 strUsage += HelpMessageGroup(_("RPC server options:"));
501 strUsage += HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
502 strUsage += HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE));
503 strUsage += HelpMessageOpt("-rpcbind=<addr>[:port]", _("Bind to given address to listen for JSON-RPC connections. 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, or if -rpcallowip has been specified, 0.0.0.0 and :: i.e., all addresses)"));
504 strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
505 strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
506 strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
507 strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times"));
508 strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
509 strUsage += HelpMessageOpt("-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"));
510 strUsage += HelpMessageOpt("-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));
511 strUsage += HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS));
512 if (showDebug) {
513 strUsage += HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE));
514 strUsage += HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT));
517 return strUsage;
520 std::string LicenseInfo()
522 const std::string URL_SOURCE_CODE = "<https://github.com/bitcoin/bitcoin>";
523 const std::string URL_WEBSITE = "<https://bitcoincore.org>";
525 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR) + " ") + "\n" +
526 "\n" +
527 strprintf(_("Please contribute if you find %s useful. "
528 "Visit %s for further information about the software."),
529 PACKAGE_NAME, URL_WEBSITE) +
530 "\n" +
531 strprintf(_("The source code is available from %s."),
532 URL_SOURCE_CODE) +
533 "\n" +
534 "\n" +
535 _("This is experimental software.") + "\n" +
536 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
537 "\n" +
538 strprintf(_("This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit %s and cryptographic software written by Eric Young and UPnP software written by Thomas Bernard."), "<https://www.openssl.org>") +
539 "\n";
542 static void BlockNotifyCallback(bool initialSync, const CBlockIndex *pBlockIndex)
544 if (initialSync || !pBlockIndex)
545 return;
547 std::string strCmd = GetArg("-blocknotify", "");
549 boost::replace_all(strCmd, "%s", pBlockIndex->GetBlockHash().GetHex());
550 boost::thread t(runCommand, strCmd); // thread runs free
553 static bool fHaveGenesis = false;
554 static boost::mutex cs_GenesisWait;
555 static CConditionVariable condvar_GenesisWait;
557 static void BlockNotifyGenesisWait(bool, const CBlockIndex *pBlockIndex)
559 if (pBlockIndex != NULL) {
561 boost::unique_lock<boost::mutex> lock_GenesisWait(cs_GenesisWait);
562 fHaveGenesis = true;
564 condvar_GenesisWait.notify_all();
568 struct CImportingNow
570 CImportingNow() {
571 assert(fImporting == false);
572 fImporting = true;
575 ~CImportingNow() {
576 assert(fImporting == true);
577 fImporting = false;
582 // If we're using -prune with -reindex, then delete block files that will be ignored by the
583 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
584 // is missing, do the same here to delete any later block files after a gap. Also delete all
585 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
586 // is in sync with what's actually on disk by the time we start downloading, so that pruning
587 // works correctly.
588 void CleanupBlockRevFiles()
590 std::map<std::string, fs::path> mapBlockFiles;
592 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
593 // Remove the rev files immediately and insert the blk file paths into an
594 // ordered map keyed by block file index.
595 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
596 fs::path blocksdir = GetDataDir() / "blocks";
597 for (fs::directory_iterator it(blocksdir); it != fs::directory_iterator(); it++) {
598 if (is_regular_file(*it) &&
599 it->path().filename().string().length() == 12 &&
600 it->path().filename().string().substr(8,4) == ".dat")
602 if (it->path().filename().string().substr(0,3) == "blk")
603 mapBlockFiles[it->path().filename().string().substr(3,5)] = it->path();
604 else if (it->path().filename().string().substr(0,3) == "rev")
605 remove(it->path());
609 // Remove all block files that aren't part of a contiguous set starting at
610 // zero by walking the ordered map (keys are block file indices) by
611 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
612 // start removing block files.
613 int nContigCounter = 0;
614 for (const std::pair<std::string, fs::path>& item : mapBlockFiles) {
615 if (atoi(item.first) == nContigCounter) {
616 nContigCounter++;
617 continue;
619 remove(item.second);
623 void ThreadImport(std::vector<fs::path> vImportFiles)
625 const CChainParams& chainparams = Params();
626 RenameThread("bitcoin-loadblk");
629 CImportingNow imp;
631 // -reindex
632 if (fReindex) {
633 int nFile = 0;
634 while (true) {
635 CDiskBlockPos pos(nFile, 0);
636 if (!fs::exists(GetBlockPosFilename(pos, "blk")))
637 break; // No block files left to reindex
638 FILE *file = OpenBlockFile(pos, true);
639 if (!file)
640 break; // This error is logged in OpenBlockFile
641 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile);
642 LoadExternalBlockFile(chainparams, file, &pos);
643 nFile++;
645 pblocktree->WriteReindexing(false);
646 fReindex = false;
647 LogPrintf("Reindexing finished\n");
648 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
649 InitBlockIndex(chainparams);
652 // hardcoded $DATADIR/bootstrap.dat
653 fs::path pathBootstrap = GetDataDir() / "bootstrap.dat";
654 if (fs::exists(pathBootstrap)) {
655 FILE *file = fsbridge::fopen(pathBootstrap, "rb");
656 if (file) {
657 fs::path pathBootstrapOld = GetDataDir() / "bootstrap.dat.old";
658 LogPrintf("Importing bootstrap.dat...\n");
659 LoadExternalBlockFile(chainparams, file);
660 RenameOver(pathBootstrap, pathBootstrapOld);
661 } else {
662 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap.string());
666 // -loadblock=
667 for (const fs::path& path : vImportFiles) {
668 FILE *file = fsbridge::fopen(path, "rb");
669 if (file) {
670 LogPrintf("Importing blocks file %s...\n", path.string());
671 LoadExternalBlockFile(chainparams, file);
672 } else {
673 LogPrintf("Warning: Could not open blocks file %s\n", path.string());
677 // scan for better chains in the block chain database, that are not yet connected in the active best chain
678 CValidationState state;
679 if (!ActivateBestChain(state, chainparams)) {
680 LogPrintf("Failed to connect best block");
681 StartShutdown();
684 if (GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
685 LogPrintf("Stopping after block import\n");
686 StartShutdown();
688 } // End scope of CImportingNow
689 if (GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
690 LoadMempool();
691 fDumpMempoolLater = !fRequestShutdown;
695 /** Sanity checks
696 * Ensure that Bitcoin is running in a usable environment with all
697 * necessary library support.
699 bool InitSanityCheck(void)
701 if(!ECC_InitSanityCheck()) {
702 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
703 return false;
706 if (!glibc_sanity_test() || !glibcxx_sanity_test())
707 return false;
709 if (!Random_SanityCheck()) {
710 InitError("OS cryptographic RNG sanity check failure. Aborting.");
711 return false;
714 return true;
717 bool AppInitServers(boost::thread_group& threadGroup)
719 RPCServer::OnStarted(&OnRPCStarted);
720 RPCServer::OnStopped(&OnRPCStopped);
721 RPCServer::OnPreCommand(&OnRPCPreCommand);
722 if (!InitHTTPServer())
723 return false;
724 if (!StartRPC())
725 return false;
726 if (!StartHTTPRPC())
727 return false;
728 if (GetBoolArg("-rest", DEFAULT_REST_ENABLE) && !StartREST())
729 return false;
730 if (!StartHTTPServer())
731 return false;
732 return true;
735 // Parameter interaction based on rules
736 void InitParameterInteraction()
738 // when specifying an explicit binding address, you want to listen on it
739 // even when -connect or -proxy is specified
740 if (IsArgSet("-bind")) {
741 if (SoftSetBoolArg("-listen", true))
742 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
744 if (IsArgSet("-whitebind")) {
745 if (SoftSetBoolArg("-listen", true))
746 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
749 if (gArgs.IsArgSet("-connect")) {
750 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
751 if (SoftSetBoolArg("-dnsseed", false))
752 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
753 if (SoftSetBoolArg("-listen", false))
754 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
757 if (IsArgSet("-proxy")) {
758 // to protect privacy, do not listen by default if a default proxy server is specified
759 if (SoftSetBoolArg("-listen", false))
760 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
761 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
762 // to listen locally, so don't rely on this happening through -listen below.
763 if (SoftSetBoolArg("-upnp", false))
764 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
765 // to protect privacy, do not discover addresses by default
766 if (SoftSetBoolArg("-discover", false))
767 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
770 if (!GetBoolArg("-listen", DEFAULT_LISTEN)) {
771 // do not map ports or try to retrieve public IP when not listening (pointless)
772 if (SoftSetBoolArg("-upnp", false))
773 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
774 if (SoftSetBoolArg("-discover", false))
775 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
776 if (SoftSetBoolArg("-listenonion", false))
777 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
780 if (IsArgSet("-externalip")) {
781 // if an explicit public IP is specified, do not try to find others
782 if (SoftSetBoolArg("-discover", false))
783 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
786 // disable whitelistrelay in blocksonly mode
787 if (GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
788 if (SoftSetBoolArg("-whitelistrelay", false))
789 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
792 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
793 if (GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
794 if (SoftSetBoolArg("-whitelistrelay", true))
795 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
799 static std::string ResolveErrMsg(const char * const optname, const std::string& strBind)
801 return strprintf(_("Cannot resolve -%s address: '%s'"), optname, strBind);
804 void InitLogging()
806 fPrintToConsole = GetBoolArg("-printtoconsole", false);
807 fLogTimestamps = GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
808 fLogTimeMicros = GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
809 fLogIPs = GetBoolArg("-logips", DEFAULT_LOGIPS);
811 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
812 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
815 namespace { // Variables internal to initialization process only
817 ServiceFlags nRelevantServices = NODE_NETWORK;
818 int nMaxConnections;
819 int nUserMaxConnections;
820 int nFD;
821 ServiceFlags nLocalServices = NODE_NETWORK;
823 } // namespace
825 [[noreturn]] static void new_handler_terminate()
827 // Rather than throwing std::bad-alloc if allocation fails, terminate
828 // immediately to (try to) avoid chain corruption.
829 // Since LogPrintf may itself allocate memory, set the handler directly
830 // to terminate first.
831 std::set_new_handler(std::terminate);
832 LogPrintf("Error: Out of memory. Terminating.\n");
834 // The log was successful, terminate now.
835 std::terminate();
838 bool AppInitBasicSetup()
840 // ********************************************************* Step 1: setup
841 #ifdef _MSC_VER
842 // Turn off Microsoft heap dump noise
843 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
844 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, 0));
845 // Disable confusing "helpful" text message on abort, Ctrl-C
846 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
847 #endif
848 #ifdef WIN32
849 // Enable Data Execution Prevention (DEP)
850 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
851 // A failure is non-critical and needs no further attention!
852 #ifndef PROCESS_DEP_ENABLE
853 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
854 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
855 #define PROCESS_DEP_ENABLE 0x00000001
856 #endif
857 typedef BOOL (WINAPI *PSETPROCDEPPOL)(DWORD);
858 PSETPROCDEPPOL setProcDEPPol = (PSETPROCDEPPOL)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
859 if (setProcDEPPol != NULL) setProcDEPPol(PROCESS_DEP_ENABLE);
860 #endif
862 if (!SetupNetworking())
863 return InitError("Initializing networking failed");
865 #ifndef WIN32
866 if (!GetBoolArg("-sysperms", false)) {
867 umask(077);
870 // Clean shutdown on SIGTERM
871 registerSignalHandler(SIGTERM, HandleSIGTERM);
872 registerSignalHandler(SIGINT, HandleSIGTERM);
874 // Reopen debug.log on SIGHUP
875 registerSignalHandler(SIGHUP, HandleSIGHUP);
877 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
878 signal(SIGPIPE, SIG_IGN);
879 #endif
881 std::set_new_handler(new_handler_terminate);
883 return true;
886 bool AppInitParameterInteraction()
888 const CChainParams& chainparams = Params();
889 // ********************************************************* Step 2: parameter interactions
891 // also see: InitParameterInteraction()
893 // if using block pruning, then disallow txindex
894 if (GetArg("-prune", 0)) {
895 if (GetBoolArg("-txindex", DEFAULT_TXINDEX))
896 return InitError(_("Prune mode is incompatible with -txindex."));
899 // -bind and -whitebind can't be set when not listening
900 size_t nUserBind = gArgs.GetArgs("-bind").size() + gArgs.GetArgs("-whitebind").size();
901 if (nUserBind != 0 && !gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
902 return InitError("Cannot set -bind or -whitebind together with -listen=0");
905 // Make sure enough file descriptors are available
906 int nBind = std::max(nUserBind, size_t(1));
907 nUserMaxConnections = GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
908 nMaxConnections = std::max(nUserMaxConnections, 0);
910 // Trim requested connection counts, to fit into system limitations
911 nMaxConnections = std::max(std::min(nMaxConnections, (int)(FD_SETSIZE - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS)), 0);
912 nFD = RaiseFileDescriptorLimit(nMaxConnections + MIN_CORE_FILEDESCRIPTORS + MAX_ADDNODE_CONNECTIONS);
913 if (nFD < MIN_CORE_FILEDESCRIPTORS)
914 return InitError(_("Not enough file descriptors available."));
915 nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS, nMaxConnections);
917 if (nMaxConnections < nUserMaxConnections)
918 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
920 // ********************************************************* Step 3: parameter-to-internal-flags
921 if (gArgs.IsArgSet("-debug")) {
922 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
923 const std::vector<std::string> categories = gArgs.GetArgs("-debug");
925 if (find(categories.begin(), categories.end(), std::string("0")) == categories.end()) {
926 for (const auto& cat : categories) {
927 uint32_t flag = 0;
928 if (!GetLogCategory(&flag, &cat)) {
929 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
930 continue;
932 logCategories |= flag;
937 // Now remove the logging categories which were explicitly excluded
938 for (const std::string& cat : gArgs.GetArgs("-debugexclude")) {
939 uint32_t flag = 0;
940 if (!GetLogCategory(&flag, &cat)) {
941 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
942 continue;
944 logCategories &= ~flag;
947 // Check for -debugnet
948 if (GetBoolArg("-debugnet", false))
949 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
950 // Check for -socks - as this is a privacy risk to continue, exit here
951 if (IsArgSet("-socks"))
952 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
953 // Check for -tor - as this is a privacy risk to continue, exit here
954 if (GetBoolArg("-tor", false))
955 return InitError(_("Unsupported argument -tor found, use -onion."));
957 if (GetBoolArg("-benchmark", false))
958 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
960 if (GetBoolArg("-whitelistalwaysrelay", false))
961 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
963 if (IsArgSet("-blockminsize"))
964 InitWarning("Unsupported argument -blockminsize ignored.");
966 // Checkmempool and checkblockindex default to true in regtest mode
967 int ratio = std::min<int>(std::max<int>(GetArg("-checkmempool", chainparams.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
968 if (ratio != 0) {
969 mempool.setSanityCheck(1.0 / ratio);
971 fCheckBlockIndex = GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
972 fCheckpointsEnabled = GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED);
974 hashAssumeValid = uint256S(GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
975 if (!hashAssumeValid.IsNull())
976 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid.GetHex());
977 else
978 LogPrintf("Validating signatures for all blocks.\n");
980 // mempool limits
981 int64_t nMempoolSizeMax = GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
982 int64_t nMempoolSizeMin = GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT) * 1000 * 40;
983 if (nMempoolSizeMax < 0 || nMempoolSizeMax < nMempoolSizeMin)
984 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin / 1000000.0)));
985 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
986 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
987 if (IsArgSet("-incrementalrelayfee"))
989 CAmount n = 0;
990 if (!ParseMoney(GetArg("-incrementalrelayfee", ""), n))
991 return InitError(AmountErrMsg("incrementalrelayfee", GetArg("-incrementalrelayfee", "")));
992 incrementalRelayFee = CFeeRate(n);
995 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
996 nScriptCheckThreads = GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
997 if (nScriptCheckThreads <= 0)
998 nScriptCheckThreads += GetNumCores();
999 if (nScriptCheckThreads <= 1)
1000 nScriptCheckThreads = 0;
1001 else if (nScriptCheckThreads > MAX_SCRIPTCHECK_THREADS)
1002 nScriptCheckThreads = MAX_SCRIPTCHECK_THREADS;
1004 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
1005 int64_t nPruneArg = GetArg("-prune", 0);
1006 if (nPruneArg < 0) {
1007 return InitError(_("Prune cannot be configured with a negative value."));
1009 nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
1010 if (nPruneArg == 1) { // manual pruning: -prune=1
1011 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1012 nPruneTarget = std::numeric_limits<uint64_t>::max();
1013 fPruneMode = true;
1014 } else if (nPruneTarget) {
1015 if (nPruneTarget < MIN_DISK_SPACE_FOR_BLOCK_FILES) {
1016 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
1018 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget / 1024 / 1024);
1019 fPruneMode = true;
1022 RegisterAllCoreRPCCommands(tableRPC);
1023 #ifdef ENABLE_WALLET
1024 RegisterWalletRPCCommands(tableRPC);
1025 #endif
1027 nConnectTimeout = GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1028 if (nConnectTimeout <= 0)
1029 nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1031 if (IsArgSet("-minrelaytxfee")) {
1032 CAmount n = 0;
1033 if (!ParseMoney(GetArg("-minrelaytxfee", ""), n)) {
1034 return InitError(AmountErrMsg("minrelaytxfee", GetArg("-minrelaytxfee", "")));
1036 // High fee check is done afterward in CWallet::ParameterInteraction()
1037 ::minRelayTxFee = CFeeRate(n);
1038 } else if (incrementalRelayFee > ::minRelayTxFee) {
1039 // Allow only setting incrementalRelayFee to control both
1040 ::minRelayTxFee = incrementalRelayFee;
1041 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee.ToString());
1044 // Sanity check argument for min fee for including tx in block
1045 // TODO: Harmonize which arguments need sanity checking and where that happens
1046 if (IsArgSet("-blockmintxfee"))
1048 CAmount n = 0;
1049 if (!ParseMoney(GetArg("-blockmintxfee", ""), n))
1050 return InitError(AmountErrMsg("blockmintxfee", GetArg("-blockmintxfee", "")));
1053 // Feerate used to define dust. Shouldn't be changed lightly as old
1054 // implementations may inadvertently create non-standard transactions
1055 if (IsArgSet("-dustrelayfee"))
1057 CAmount n = 0;
1058 if (!ParseMoney(GetArg("-dustrelayfee", ""), n) || 0 == n)
1059 return InitError(AmountErrMsg("dustrelayfee", GetArg("-dustrelayfee", "")));
1060 dustRelayFee = CFeeRate(n);
1063 fRequireStandard = !GetBoolArg("-acceptnonstdtxn", !chainparams.RequireStandard());
1064 if (chainparams.RequireStandard() && !fRequireStandard)
1065 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams.NetworkIDString()));
1066 nBytesPerSigOp = GetArg("-bytespersigop", nBytesPerSigOp);
1068 #ifdef ENABLE_WALLET
1069 if (!CWallet::ParameterInteraction())
1070 return false;
1071 #endif
1073 fIsBareMultisigStd = GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG);
1074 fAcceptDatacarrier = GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER);
1075 nMaxDatacarrierBytes = GetArg("-datacarriersize", nMaxDatacarrierBytes);
1077 // Option to startup with mocktime set (used for regression testing):
1078 SetMockTime(GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1080 if (GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1081 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
1083 if (GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
1084 return InitError("rpcserialversion must be non-negative.");
1086 if (GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
1087 return InitError("unknown rpcserialversion requested.");
1089 nMaxTipAge = GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
1091 fEnableReplacement = GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT);
1092 if ((!fEnableReplacement) && IsArgSet("-mempoolreplacement")) {
1093 // Minimal effort at forwards compatibility
1094 std::string strReplacementModeList = GetArg("-mempoolreplacement", ""); // default is impossible
1095 std::vector<std::string> vstrReplacementModes;
1096 boost::split(vstrReplacementModes, strReplacementModeList, boost::is_any_of(","));
1097 fEnableReplacement = (std::find(vstrReplacementModes.begin(), vstrReplacementModes.end(), "fee") != vstrReplacementModes.end());
1100 if (gArgs.IsArgSet("-vbparams")) {
1101 // Allow overriding version bits parameters for testing
1102 if (!chainparams.MineBlocksOnDemand()) {
1103 return InitError("Version bits parameters may only be overridden on regtest.");
1105 for (const std::string& strDeployment : gArgs.GetArgs("-vbparams")) {
1106 std::vector<std::string> vDeploymentParams;
1107 boost::split(vDeploymentParams, strDeployment, boost::is_any_of(":"));
1108 if (vDeploymentParams.size() != 3) {
1109 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1111 int64_t nStartTime, nTimeout;
1112 if (!ParseInt64(vDeploymentParams[1], &nStartTime)) {
1113 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
1115 if (!ParseInt64(vDeploymentParams[2], &nTimeout)) {
1116 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
1118 bool found = false;
1119 for (int j=0; j<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j)
1121 if (vDeploymentParams[0].compare(VersionBitsDeploymentInfo[j].name) == 0) {
1122 UpdateVersionBitsParameters(Consensus::DeploymentPos(j), nStartTime, nTimeout);
1123 found = true;
1124 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams[0], nStartTime, nTimeout);
1125 break;
1128 if (!found) {
1129 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
1133 return true;
1136 static bool LockDataDirectory(bool probeOnly)
1138 std::string strDataDir = GetDataDir().string();
1140 // Make sure only a single Bitcoin process is using the data directory.
1141 fs::path pathLockFile = GetDataDir() / ".lock";
1142 FILE* file = fsbridge::fopen(pathLockFile, "a"); // empty lock file; created if it doesn't exist.
1143 if (file) fclose(file);
1145 try {
1146 static boost::interprocess::file_lock lock(pathLockFile.string().c_str());
1147 if (!lock.try_lock()) {
1148 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir, _(PACKAGE_NAME)));
1150 if (probeOnly) {
1151 lock.unlock();
1153 } catch(const boost::interprocess::interprocess_exception& e) {
1154 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir, _(PACKAGE_NAME), e.what()));
1156 return true;
1159 bool AppInitSanityChecks()
1161 // ********************************************************* Step 4: sanity checks
1163 // Initialize elliptic curve code
1164 std::string sha256_algo = SHA256AutoDetect();
1165 LogPrintf("Using the '%s' SHA256 implementation\n", sha256_algo);
1166 RandomInit();
1167 ECC_Start();
1168 globalVerifyHandle.reset(new ECCVerifyHandle());
1170 // Sanity check
1171 if (!InitSanityCheck())
1172 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME)));
1174 // Probe the data directory lock to give an early error message, if possible
1175 // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1176 // and a fork will cause weird behavior to it.
1177 return LockDataDirectory(true);
1180 bool AppInitLockDataDirectory()
1182 // After daemonization get the data directory lock again and hold on to it until exit
1183 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1184 // will at most make us exit without printing a message to console.
1185 if (!LockDataDirectory(false)) {
1186 // Detailed error printed inside LockDataDirectory
1187 return false;
1189 return true;
1192 bool AppInitMain(boost::thread_group& threadGroup, CScheduler& scheduler)
1194 const CChainParams& chainparams = Params();
1195 // ********************************************************* Step 4a: application initialization
1196 #ifndef WIN32
1197 CreatePidFile(GetPidFile(), getpid());
1198 #endif
1199 if (GetBoolArg("-shrinkdebugfile", logCategories == BCLog::NONE)) {
1200 // Do this first since it both loads a bunch of debug.log into memory,
1201 // and because this needs to happen before any other debug.log printing
1202 ShrinkDebugFile();
1205 if (fPrintToDebugLog)
1206 OpenDebugLog();
1208 if (!fLogTimestamps)
1209 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1210 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1211 LogPrintf("Using data directory %s\n", GetDataDir().string());
1212 LogPrintf("Using config file %s\n", GetConfigFile(GetArg("-conf", BITCOIN_CONF_FILENAME)).string());
1213 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1215 InitSignatureCache();
1216 InitScriptExecutionCache();
1218 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads);
1219 if (nScriptCheckThreads) {
1220 for (int i=0; i<nScriptCheckThreads-1; i++)
1221 threadGroup.create_thread(&ThreadScriptCheck);
1224 // Start the lightweight task scheduler thread
1225 CScheduler::Function serviceLoop = boost::bind(&CScheduler::serviceQueue, &scheduler);
1226 threadGroup.create_thread(boost::bind(&TraceThread<CScheduler::Function>, "scheduler", serviceLoop));
1228 GetMainSignals().RegisterBackgroundSignalScheduler(scheduler);
1230 /* Start the RPC server already. It will be started in "warmup" mode
1231 * and not really process calls already (but it will signify connections
1232 * that the server is there and will be ready later). Warmup mode will
1233 * be disabled when initialisation is finished.
1235 if (GetBoolArg("-server", false))
1237 uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1238 if (!AppInitServers(threadGroup))
1239 return InitError(_("Unable to start HTTP server. See debug log for details."));
1242 int64_t nStart;
1244 // ********************************************************* Step 5: verify wallet database integrity
1245 #ifdef ENABLE_WALLET
1246 if (!CWallet::Verify())
1247 return false;
1248 #endif
1249 // ********************************************************* Step 6: network initialization
1250 // Note that we absolutely cannot open any actual connections
1251 // until the very end ("start node") as the UTXO/block state
1252 // is not yet setup and may end up being set up twice if we
1253 // need to reindex later.
1255 assert(!g_connman);
1256 g_connman = std::unique_ptr<CConnman>(new CConnman(GetRand(std::numeric_limits<uint64_t>::max()), GetRand(std::numeric_limits<uint64_t>::max())));
1257 CConnman& connman = *g_connman;
1259 peerLogic.reset(new PeerLogicValidation(&connman));
1260 RegisterValidationInterface(peerLogic.get());
1261 RegisterNodeSignals(GetNodeSignals());
1263 // sanitize comments per BIP-0014, format user agent and check total size
1264 std::vector<std::string> uacomments;
1265 for (const std::string& cmt : gArgs.GetArgs("-uacomment")) {
1266 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1267 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1268 uacomments.push_back(cmt);
1270 strSubVersion = FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, uacomments);
1271 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1272 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1273 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1276 if (gArgs.IsArgSet("-onlynet")) {
1277 std::set<enum Network> nets;
1278 for (const std::string& snet : gArgs.GetArgs("-onlynet")) {
1279 enum Network net = ParseNetwork(snet);
1280 if (net == NET_UNROUTABLE)
1281 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1282 nets.insert(net);
1284 for (int n = 0; n < NET_MAX; n++) {
1285 enum Network net = (enum Network)n;
1286 if (!nets.count(net))
1287 SetLimited(net);
1291 // Check for host lookup allowed before parsing any network related parameters
1292 fNameLookup = GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1294 bool proxyRandomize = GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1295 // -proxy sets a proxy for all outgoing network traffic
1296 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1297 std::string proxyArg = GetArg("-proxy", "");
1298 SetLimited(NET_TOR);
1299 if (proxyArg != "" && proxyArg != "0") {
1300 CService proxyAddr;
1301 if (!Lookup(proxyArg.c_str(), proxyAddr, 9050, fNameLookup)) {
1302 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1305 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
1306 if (!addrProxy.IsValid())
1307 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1309 SetProxy(NET_IPV4, addrProxy);
1310 SetProxy(NET_IPV6, addrProxy);
1311 SetProxy(NET_TOR, addrProxy);
1312 SetNameProxy(addrProxy);
1313 SetLimited(NET_TOR, false); // by default, -proxy sets onion as reachable, unless -noonion later
1316 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1317 // -noonion (or -onion=0) disables connecting to .onion entirely
1318 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1319 std::string onionArg = GetArg("-onion", "");
1320 if (onionArg != "") {
1321 if (onionArg == "0") { // Handle -noonion/-onion=0
1322 SetLimited(NET_TOR); // set onions as unreachable
1323 } else {
1324 CService onionProxy;
1325 if (!Lookup(onionArg.c_str(), onionProxy, 9050, fNameLookup)) {
1326 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1328 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
1329 if (!addrOnion.IsValid())
1330 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1331 SetProxy(NET_TOR, addrOnion);
1332 SetLimited(NET_TOR, false);
1336 // see Step 2: parameter interactions for more information about these
1337 fListen = GetBoolArg("-listen", DEFAULT_LISTEN);
1338 fDiscover = GetBoolArg("-discover", true);
1339 fRelayTxes = !GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY);
1341 for (const std::string& strAddr : gArgs.GetArgs("-externalip")) {
1342 CService addrLocal;
1343 if (Lookup(strAddr.c_str(), addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1344 AddLocal(addrLocal, LOCAL_MANUAL);
1345 else
1346 return InitError(ResolveErrMsg("externalip", strAddr));
1349 #if ENABLE_ZMQ
1350 pzmqNotificationInterface = CZMQNotificationInterface::Create();
1352 if (pzmqNotificationInterface) {
1353 RegisterValidationInterface(pzmqNotificationInterface);
1355 #endif
1356 uint64_t nMaxOutboundLimit = 0; //unlimited unless -maxuploadtarget is set
1357 uint64_t nMaxOutboundTimeframe = MAX_UPLOAD_TIMEFRAME;
1359 if (IsArgSet("-maxuploadtarget")) {
1360 nMaxOutboundLimit = GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET)*1024*1024;
1363 // ********************************************************* Step 7: load block chain
1365 fReindex = GetBoolArg("-reindex", false);
1366 bool fReindexChainState = GetBoolArg("-reindex-chainstate", false);
1368 // cache size calculations
1369 int64_t nTotalCache = (GetArg("-dbcache", nDefaultDbCache) << 20);
1370 nTotalCache = std::max(nTotalCache, nMinDbCache << 20); // total cache cannot be less than nMinDbCache
1371 nTotalCache = std::min(nTotalCache, nMaxDbCache << 20); // total cache cannot be greater than nMaxDbcache
1372 int64_t nBlockTreeDBCache = nTotalCache / 8;
1373 nBlockTreeDBCache = std::min(nBlockTreeDBCache, (GetBoolArg("-txindex", DEFAULT_TXINDEX) ? nMaxBlockDBAndTxIndexCache : nMaxBlockDBCache) << 20);
1374 nTotalCache -= nBlockTreeDBCache;
1375 int64_t nCoinDBCache = std::min(nTotalCache / 2, (nTotalCache / 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1376 nCoinDBCache = std::min(nCoinDBCache, nMaxCoinsDBCache << 20); // cap total coins db cache
1377 nTotalCache -= nCoinDBCache;
1378 nCoinCacheUsage = nTotalCache; // the rest goes to in-memory cache
1379 int64_t nMempoolSizeMax = GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
1380 LogPrintf("Cache configuration:\n");
1381 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache * (1.0 / 1024 / 1024));
1382 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache * (1.0 / 1024 / 1024));
1383 LogPrintf("* Using %.1fMiB for in-memory UTXO set (plus up to %.1fMiB of unused mempool space)\n", nCoinCacheUsage * (1.0 / 1024 / 1024), nMempoolSizeMax * (1.0 / 1024 / 1024));
1385 bool fLoaded = false;
1386 while (!fLoaded && !fRequestShutdown) {
1387 bool fReset = fReindex;
1388 std::string strLoadError;
1390 uiInterface.InitMessage(_("Loading block index..."));
1392 nStart = GetTimeMillis();
1393 do {
1394 try {
1395 UnloadBlockIndex();
1396 delete pcoinsTip;
1397 delete pcoinsdbview;
1398 delete pcoinscatcher;
1399 delete pblocktree;
1401 pblocktree = new CBlockTreeDB(nBlockTreeDBCache, false, fReindex);
1402 pcoinsdbview = new CCoinsViewDB(nCoinDBCache, false, fReindex || fReindexChainState);
1403 pcoinscatcher = new CCoinsViewErrorCatcher(pcoinsdbview);
1405 if (fReindex) {
1406 pblocktree->WriteReindexing(true);
1407 //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
1408 if (fPruneMode)
1409 CleanupBlockRevFiles();
1410 } else {
1411 // If necessary, upgrade from older database format.
1412 if (!pcoinsdbview->Upgrade()) {
1413 strLoadError = _("Error upgrading chainstate database");
1414 break;
1417 if (fRequestShutdown) break;
1419 if (!LoadBlockIndex(chainparams)) {
1420 strLoadError = _("Error loading block database");
1421 break;
1424 // If the loaded chain has a wrong genesis, bail out immediately
1425 // (we're likely using a testnet datadir, or the other way around).
1426 if (!mapBlockIndex.empty() && mapBlockIndex.count(chainparams.GetConsensus().hashGenesisBlock) == 0)
1427 return InitError(_("Incorrect or no genesis block found. Wrong datadir for network?"));
1429 // Initialize the block index (no-op if non-empty database was already loaded)
1430 if (!InitBlockIndex(chainparams)) {
1431 strLoadError = _("Error initializing block database");
1432 break;
1435 // Check for changed -txindex state
1436 if (fTxIndex != GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1437 strLoadError = _("You need to rebuild the database using -reindex-chainstate to change -txindex");
1438 break;
1441 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1442 // in the past, but is now trying to run unpruned.
1443 if (fHavePruned && !fPruneMode) {
1444 strLoadError = _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1445 break;
1448 if (!ReplayBlocks(chainparams, pcoinsdbview)) {
1449 strLoadError = _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.");
1450 break;
1452 pcoinsTip = new CCoinsViewCache(pcoinscatcher);
1453 LoadChainTip(chainparams);
1455 if (!fReindex && chainActive.Tip() != NULL) {
1456 uiInterface.InitMessage(_("Rewinding blocks..."));
1457 if (!RewindBlockIndex(chainparams)) {
1458 strLoadError = _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1459 break;
1463 uiInterface.InitMessage(_("Verifying blocks..."));
1464 if (fHavePruned && GetArg("-checkblocks", DEFAULT_CHECKBLOCKS) > MIN_BLOCKS_TO_KEEP) {
1465 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1466 MIN_BLOCKS_TO_KEEP);
1470 LOCK(cs_main);
1471 CBlockIndex* tip = chainActive.Tip();
1472 RPCNotifyBlockChange(true, tip);
1473 if (tip && tip->nTime > GetAdjustedTime() + 2 * 60 * 60) {
1474 strLoadError = _("The block database contains a block which appears to be from the future. "
1475 "This may be due to your computer's date and time being set incorrectly. "
1476 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1477 break;
1481 if (!CVerifyDB().VerifyDB(chainparams, pcoinsdbview, GetArg("-checklevel", DEFAULT_CHECKLEVEL),
1482 GetArg("-checkblocks", DEFAULT_CHECKBLOCKS))) {
1483 strLoadError = _("Corrupted block database detected");
1484 break;
1486 } catch (const std::exception& e) {
1487 LogPrintf("%s\n", e.what());
1488 strLoadError = _("Error opening block database");
1489 break;
1492 fLoaded = true;
1493 } while(false);
1495 if (!fLoaded && !fRequestShutdown) {
1496 // first suggest a reindex
1497 if (!fReset) {
1498 bool fRet = uiInterface.ThreadSafeQuestion(
1499 strLoadError + ".\n\n" + _("Do you want to rebuild the block database now?"),
1500 strLoadError + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1501 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1502 if (fRet) {
1503 fReindex = true;
1504 fRequestShutdown = false;
1505 } else {
1506 LogPrintf("Aborted block database rebuild. Exiting.\n");
1507 return false;
1509 } else {
1510 return InitError(strLoadError);
1515 // As LoadBlockIndex can take several minutes, it's possible the user
1516 // requested to kill the GUI during the last operation. If so, exit.
1517 // As the program has not fully started yet, Shutdown() is possibly overkill.
1518 if (fRequestShutdown)
1520 LogPrintf("Shutdown requested. Exiting.\n");
1521 return false;
1523 if (fLoaded) {
1524 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart);
1527 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
1528 CAutoFile est_filein(fsbridge::fopen(est_path, "rb"), SER_DISK, CLIENT_VERSION);
1529 // Allowed to fail as this file IS missing on first startup.
1530 if (!est_filein.IsNull())
1531 ::feeEstimator.Read(est_filein);
1532 fFeeEstimatesInitialized = true;
1534 // ********************************************************* Step 8: load wallet
1535 #ifdef ENABLE_WALLET
1536 if (!CWallet::InitLoadWallet())
1537 return false;
1538 #else
1539 LogPrintf("No wallet support compiled in!\n");
1540 #endif
1542 // ********************************************************* Step 9: data directory maintenance
1544 // if pruning, unset the service bit and perform the initial blockstore prune
1545 // after any wallet rescanning has taken place.
1546 if (fPruneMode) {
1547 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1548 nLocalServices = ServiceFlags(nLocalServices & ~NODE_NETWORK);
1549 if (!fReindex) {
1550 uiInterface.InitMessage(_("Pruning blockstore..."));
1551 PruneAndFlush();
1555 if (chainparams.GetConsensus().vDeployments[Consensus::DEPLOYMENT_SEGWIT].nTimeout != 0) {
1556 // Only advertise witness capabilities if they have a reasonable start time.
1557 // This allows us to have the code merged without a defined softfork, by setting its
1558 // end time to 0.
1559 // Note that setting NODE_WITNESS is never required: the only downside from not
1560 // doing so is that after activation, no upgraded nodes will fetch from you.
1561 nLocalServices = ServiceFlags(nLocalServices | NODE_WITNESS);
1562 // Only care about others providing witness capabilities if there is a softfork
1563 // defined.
1564 nRelevantServices = ServiceFlags(nRelevantServices | NODE_WITNESS);
1567 // ********************************************************* Step 10: import blocks
1569 if (!CheckDiskSpace())
1570 return false;
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 if (chainActive.Tip() == NULL) {
1575 uiInterface.NotifyBlockTip.connect(BlockNotifyGenesisWait);
1576 } else {
1577 fHaveGenesis = true;
1580 if (IsArgSet("-blocknotify"))
1581 uiInterface.NotifyBlockTip.connect(BlockNotifyCallback);
1583 std::vector<fs::path> vImportFiles;
1584 for (const std::string& strFile : gArgs.GetArgs("-loadblock")) {
1585 vImportFiles.push_back(strFile);
1588 threadGroup.create_thread(boost::bind(&ThreadImport, vImportFiles));
1590 // Wait for genesis block to be processed
1592 boost::unique_lock<boost::mutex> lock(cs_GenesisWait);
1593 while (!fHaveGenesis) {
1594 condvar_GenesisWait.wait(lock);
1596 uiInterface.NotifyBlockTip.disconnect(BlockNotifyGenesisWait);
1599 // ********************************************************* Step 11: start node
1601 //// debug print
1602 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex.size());
1603 LogPrintf("nBestHeight = %d\n", chainActive.Height());
1604 if (GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION))
1605 StartTorControl(threadGroup, scheduler);
1607 Discover(threadGroup);
1609 // Map ports with UPnP
1610 MapPort(GetBoolArg("-upnp", DEFAULT_UPNP));
1612 CConnman::Options connOptions;
1613 connOptions.nLocalServices = nLocalServices;
1614 connOptions.nRelevantServices = nRelevantServices;
1615 connOptions.nMaxConnections = nMaxConnections;
1616 connOptions.nMaxOutbound = std::min(MAX_OUTBOUND_CONNECTIONS, connOptions.nMaxConnections);
1617 connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1618 connOptions.nMaxFeeler = 1;
1619 connOptions.nBestHeight = chainActive.Height();
1620 connOptions.uiInterface = &uiInterface;
1621 connOptions.nSendBufferMaxSize = 1000*GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1622 connOptions.nReceiveFloodSize = 1000*GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1624 connOptions.nMaxOutboundTimeframe = nMaxOutboundTimeframe;
1625 connOptions.nMaxOutboundLimit = nMaxOutboundLimit;
1627 for (const std::string& strBind : gArgs.GetArgs("-bind")) {
1628 CService addrBind;
1629 if (!Lookup(strBind.c_str(), addrBind, GetListenPort(), false)) {
1630 return InitError(ResolveErrMsg("bind", strBind));
1632 connOptions.vBinds.push_back(addrBind);
1634 for (const std::string& strBind : gArgs.GetArgs("-whitebind")) {
1635 CService addrBind;
1636 if (!Lookup(strBind.c_str(), addrBind, 0, false)) {
1637 return InitError(ResolveErrMsg("whitebind", strBind));
1639 if (addrBind.GetPort() == 0) {
1640 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind));
1642 connOptions.vWhiteBinds.push_back(addrBind);
1645 for (const auto& net : gArgs.GetArgs("-whitelist")) {
1646 CSubNet subnet;
1647 LookupSubNet(net.c_str(), subnet);
1648 if (!subnet.IsValid())
1649 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net));
1650 connOptions.vWhitelistedRange.push_back(subnet);
1653 if (gArgs.IsArgSet("-seednode")) {
1654 connOptions.vSeedNodes = gArgs.GetArgs("-seednode");
1657 if (!connman.Start(scheduler, connOptions)) {
1658 return false;
1661 // ********************************************************* Step 12: finished
1663 SetRPCWarmupFinished();
1664 uiInterface.InitMessage(_("Done loading"));
1666 #ifdef ENABLE_WALLET
1667 for (CWalletRef pwallet : vpwallets) {
1668 pwallet->postInitProcess(scheduler);
1670 #endif
1672 return !fRequestShutdown;