Improve readability of DecodeBase58Check(...)
[bitcoinplatinum.git] / src / init.cpp
blob3f68ea1021109e9c3ed13a9b41e6457e28e12a09
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 = true;
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 = nullptr;
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 final : public CCoinsViewBacked
138 public:
139 explicit 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 = nullptr;
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 && gArgs.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 if (pcoinsTip != nullptr) {
220 FlushStateToDisk();
223 // After there are no more peers/RPC left to give us new data which may generate
224 // CValidationInterface callbacks, flush them...
225 GetMainSignals().FlushBackgroundCallbacks();
227 // Any future callbacks will be dropped. This should absolutely be safe - if
228 // missing a callback results in an unrecoverable situation, unclean shutdown
229 // would too. The only reason to do the above flushes is to let the wallet catch
230 // up with our current chain to avoid any strange pruning edge cases and make
231 // next startup faster by avoiding rescan.
234 LOCK(cs_main);
235 if (pcoinsTip != nullptr) {
236 FlushStateToDisk();
238 delete pcoinsTip;
239 pcoinsTip = nullptr;
240 delete pcoinscatcher;
241 pcoinscatcher = nullptr;
242 delete pcoinsdbview;
243 pcoinsdbview = nullptr;
244 delete pblocktree;
245 pblocktree = nullptr;
247 #ifdef ENABLE_WALLET
248 for (CWalletRef pwallet : vpwallets) {
249 pwallet->Flush(true);
251 #endif
253 #if ENABLE_ZMQ
254 if (pzmqNotificationInterface) {
255 UnregisterValidationInterface(pzmqNotificationInterface);
256 delete pzmqNotificationInterface;
257 pzmqNotificationInterface = nullptr;
259 #endif
261 #ifndef WIN32
262 try {
263 fs::remove(GetPidFile());
264 } catch (const fs::filesystem_error& e) {
265 LogPrintf("%s: Unable to remove pidfile: %s\n", __func__, e.what());
267 #endif
268 UnregisterAllValidationInterfaces();
269 GetMainSignals().UnregisterBackgroundSignalScheduler();
270 #ifdef ENABLE_WALLET
271 for (CWalletRef pwallet : vpwallets) {
272 delete pwallet;
274 vpwallets.clear();
275 #endif
276 globalVerifyHandle.reset();
277 ECC_Stop();
278 LogPrintf("%s: done\n", __func__);
282 * Signal handlers are very limited in what they are allowed to do.
283 * The execution context the handler is invoked in is not guaranteed,
284 * so we restrict handler operations to just touching variables:
286 static void HandleSIGTERM(int)
288 fRequestShutdown = true;
291 static void HandleSIGHUP(int)
293 fReopenDebugLog = true;
296 #ifndef WIN32
297 static void registerSignalHandler(int signal, void(*handler)(int))
299 struct sigaction sa;
300 sa.sa_handler = handler;
301 sigemptyset(&sa.sa_mask);
302 sa.sa_flags = 0;
303 sigaction(signal, &sa, nullptr);
305 #endif
307 void OnRPCStarted()
309 uiInterface.NotifyBlockTip.connect(&RPCNotifyBlockChange);
312 void OnRPCStopped()
314 uiInterface.NotifyBlockTip.disconnect(&RPCNotifyBlockChange);
315 RPCNotifyBlockChange(false, nullptr);
316 cvBlockChange.notify_all();
317 LogPrint(BCLog::RPC, "RPC stopped.\n");
320 void OnRPCPreCommand(const CRPCCommand& cmd)
322 // Observe safe mode
323 std::string strWarning = GetWarnings("rpc");
324 if (strWarning != "" && !gArgs.GetBoolArg("-disablesafemode", DEFAULT_DISABLE_SAFEMODE) &&
325 !cmd.okSafeMode)
326 throw JSONRPCError(RPC_FORBIDDEN_BY_SAFE_MODE, std::string("Safe mode: ") + strWarning);
329 std::string HelpMessage(HelpMessageMode mode)
331 const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
332 const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
333 const auto defaultChainParams = CreateChainParams(CBaseChainParams::MAIN);
334 const auto testnetChainParams = CreateChainParams(CBaseChainParams::TESTNET);
335 const bool showDebug = gArgs.GetBoolArg("-help-debug", false);
337 // When adding new options to the categories, please keep and ensure alphabetical ordering.
338 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
339 std::string strUsage = HelpMessageGroup(_("Options:"));
340 strUsage += HelpMessageOpt("-?", _("Print this help message and exit"));
341 strUsage += HelpMessageOpt("-version", _("Print version and exit"));
342 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)"));
343 strUsage += HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
344 if (showDebug)
345 strUsage += HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY));
346 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()));
347 strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
348 if (mode == HMM_BITCOIND)
350 #if HAVE_DECL_DAEMON
351 strUsage += HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
352 #endif
354 strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
355 if (showDebug) {
356 strUsage += HelpMessageOpt("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize));
358 strUsage += HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache));
359 if (showDebug)
360 strUsage += HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER));
361 strUsage += HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
362 strUsage += HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS));
363 strUsage += HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE));
364 strUsage += HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY));
365 strUsage += HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL));
366 strUsage += HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN));
367 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)"),
368 -GetNumCores(), MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS));
369 #ifndef WIN32
370 strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
371 #endif
372 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. "
373 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
374 "(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));
375 strUsage += HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
376 strUsage += HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
377 #ifndef WIN32
378 strUsage += HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
379 #endif
380 strUsage += HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX));
382 strUsage += HelpMessageGroup(_("Connection options:"));
383 strUsage += HelpMessageOpt("-addnode=<ip>", _("Add a node to connect to and attempt to keep the connection open"));
384 strUsage += HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD));
385 strUsage += HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME));
386 strUsage += HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
387 strUsage += HelpMessageOpt("-connect=<ip>", _("Connect only to the specified node(s); -connect=0 disables automatic connections"));
388 strUsage += HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
389 strUsage += HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP));
390 strUsage += HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
391 strUsage += HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
392 strUsage += HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED));
393 strUsage += HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
394 strUsage += HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION));
395 strUsage += HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS));
396 strUsage += HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER));
397 strUsage += HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER));
398 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));
399 strUsage += HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
400 strUsage += HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
401 strUsage += HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG));
402 strUsage += HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS));
403 strUsage += HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort()));
404 strUsage += HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
405 strUsage += HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE));
406 strUsage += HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
407 strUsage += HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT));
408 strUsage += HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL));
409 strUsage += HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
410 #ifdef USE_UPNP
411 #if USE_UPNP
412 strUsage += HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
413 #else
414 strUsage += HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
415 #endif
416 #endif
417 strUsage += HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
418 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.") +
419 " " + _("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"));
420 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));
422 #ifdef ENABLE_WALLET
423 strUsage += CWallet::GetWalletHelpString(showDebug);
424 #endif
426 #if ENABLE_ZMQ
427 strUsage += HelpMessageGroup(_("ZeroMQ notification options:"));
428 strUsage += HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
429 strUsage += HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
430 strUsage += HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
431 strUsage += HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
432 #endif
434 strUsage += HelpMessageGroup(_("Debugging/Testing options:"));
435 strUsage += HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
436 if (showDebug)
438 strUsage += HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS));
439 strUsage += HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL));
440 strUsage += HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
441 strUsage += HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
442 strUsage += HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED));
443 strUsage += HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE));
444 strUsage += HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE));
445 strUsage += HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
446 strUsage += HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
447 strUsage += HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT));
448 strUsage += HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT));
450 strUsage += HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT));
451 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));
452 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));
453 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));
454 strUsage += HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
456 strUsage += HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
457 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
458 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.")));
459 strUsage += HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
460 strUsage += HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS));
461 strUsage += HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS));
462 if (showDebug)
464 strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
465 strUsage += HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
466 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));
467 strUsage += HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE));
469 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)"),
470 CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MAXFEE)));
471 strUsage += HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
472 if (showDebug)
474 strUsage += HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY));
476 strUsage += HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
478 AppendParamsHelpMessages(strUsage, showDebug);
480 strUsage += HelpMessageGroup(_("Node relay options:"));
481 if (showDebug) {
482 strUsage += HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", !testnetChainParams->RequireStandard()));
483 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)));
484 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)));
486 strUsage += HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP));
487 strUsage += HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER));
488 strUsage += HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY));
489 strUsage += HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT));
490 strUsage += HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
491 CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)));
492 strUsage += HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY));
493 strUsage += HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY));
495 strUsage += HelpMessageGroup(_("Block creation options:"));
496 strUsage += HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT));
497 strUsage += HelpMessageOpt("-blockmaxsize=<n>", strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE));
498 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)));
499 if (showDebug)
500 strUsage += HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
502 strUsage += HelpMessageGroup(_("RPC server options:"));
503 strUsage += HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
504 strUsage += HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE));
505 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)"));
506 strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
507 strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
508 strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
509 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"));
510 strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
511 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"));
512 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));
513 strUsage += HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS));
514 if (showDebug) {
515 strUsage += HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE));
516 strUsage += HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT));
519 return strUsage;
522 std::string LicenseInfo()
524 const std::string URL_SOURCE_CODE = "<https://github.com/bitcoin/bitcoin>";
525 const std::string URL_WEBSITE = "<https://bitcoincore.org>";
527 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR) + " ") + "\n" +
528 "\n" +
529 strprintf(_("Please contribute if you find %s useful. "
530 "Visit %s for further information about the software."),
531 PACKAGE_NAME, URL_WEBSITE) +
532 "\n" +
533 strprintf(_("The source code is available from %s."),
534 URL_SOURCE_CODE) +
535 "\n" +
536 "\n" +
537 _("This is experimental software.") + "\n" +
538 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
539 "\n" +
540 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>") +
541 "\n";
544 static void BlockNotifyCallback(bool initialSync, const CBlockIndex *pBlockIndex)
546 if (initialSync || !pBlockIndex)
547 return;
549 std::string strCmd = gArgs.GetArg("-blocknotify", "");
551 boost::replace_all(strCmd, "%s", pBlockIndex->GetBlockHash().GetHex());
552 boost::thread t(runCommand, strCmd); // thread runs free
555 static bool fHaveGenesis = false;
556 static boost::mutex cs_GenesisWait;
557 static CConditionVariable condvar_GenesisWait;
559 static void BlockNotifyGenesisWait(bool, const CBlockIndex *pBlockIndex)
561 if (pBlockIndex != nullptr) {
563 boost::unique_lock<boost::mutex> lock_GenesisWait(cs_GenesisWait);
564 fHaveGenesis = true;
566 condvar_GenesisWait.notify_all();
570 struct CImportingNow
572 CImportingNow() {
573 assert(fImporting == false);
574 fImporting = true;
577 ~CImportingNow() {
578 assert(fImporting == true);
579 fImporting = false;
584 // If we're using -prune with -reindex, then delete block files that will be ignored by the
585 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
586 // is missing, do the same here to delete any later block files after a gap. Also delete all
587 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
588 // is in sync with what's actually on disk by the time we start downloading, so that pruning
589 // works correctly.
590 void CleanupBlockRevFiles()
592 std::map<std::string, fs::path> mapBlockFiles;
594 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
595 // Remove the rev files immediately and insert the blk file paths into an
596 // ordered map keyed by block file index.
597 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
598 fs::path blocksdir = GetDataDir() / "blocks";
599 for (fs::directory_iterator it(blocksdir); it != fs::directory_iterator(); it++) {
600 if (is_regular_file(*it) &&
601 it->path().filename().string().length() == 12 &&
602 it->path().filename().string().substr(8,4) == ".dat")
604 if (it->path().filename().string().substr(0,3) == "blk")
605 mapBlockFiles[it->path().filename().string().substr(3,5)] = it->path();
606 else if (it->path().filename().string().substr(0,3) == "rev")
607 remove(it->path());
611 // Remove all block files that aren't part of a contiguous set starting at
612 // zero by walking the ordered map (keys are block file indices) by
613 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
614 // start removing block files.
615 int nContigCounter = 0;
616 for (const std::pair<std::string, fs::path>& item : mapBlockFiles) {
617 if (atoi(item.first) == nContigCounter) {
618 nContigCounter++;
619 continue;
621 remove(item.second);
625 void ThreadImport(std::vector<fs::path> vImportFiles)
627 const CChainParams& chainparams = Params();
628 RenameThread("bitcoin-loadblk");
631 CImportingNow imp;
633 // -reindex
634 if (fReindex) {
635 int nFile = 0;
636 while (true) {
637 CDiskBlockPos pos(nFile, 0);
638 if (!fs::exists(GetBlockPosFilename(pos, "blk")))
639 break; // No block files left to reindex
640 FILE *file = OpenBlockFile(pos, true);
641 if (!file)
642 break; // This error is logged in OpenBlockFile
643 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile);
644 LoadExternalBlockFile(chainparams, file, &pos);
645 nFile++;
647 pblocktree->WriteReindexing(false);
648 fReindex = false;
649 LogPrintf("Reindexing finished\n");
650 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
651 LoadGenesisBlock(chainparams);
654 // hardcoded $DATADIR/bootstrap.dat
655 fs::path pathBootstrap = GetDataDir() / "bootstrap.dat";
656 if (fs::exists(pathBootstrap)) {
657 FILE *file = fsbridge::fopen(pathBootstrap, "rb");
658 if (file) {
659 fs::path pathBootstrapOld = GetDataDir() / "bootstrap.dat.old";
660 LogPrintf("Importing bootstrap.dat...\n");
661 LoadExternalBlockFile(chainparams, file);
662 RenameOver(pathBootstrap, pathBootstrapOld);
663 } else {
664 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap.string());
668 // -loadblock=
669 for (const fs::path& path : vImportFiles) {
670 FILE *file = fsbridge::fopen(path, "rb");
671 if (file) {
672 LogPrintf("Importing blocks file %s...\n", path.string());
673 LoadExternalBlockFile(chainparams, file);
674 } else {
675 LogPrintf("Warning: Could not open blocks file %s\n", path.string());
679 // scan for better chains in the block chain database, that are not yet connected in the active best chain
680 CValidationState state;
681 if (!ActivateBestChain(state, chainparams)) {
682 LogPrintf("Failed to connect best block");
683 StartShutdown();
686 if (gArgs.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
687 LogPrintf("Stopping after block import\n");
688 StartShutdown();
690 } // End scope of CImportingNow
691 if (gArgs.GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
692 LoadMempool();
693 fDumpMempoolLater = !fRequestShutdown;
697 /** Sanity checks
698 * Ensure that Bitcoin is running in a usable environment with all
699 * necessary library support.
701 bool InitSanityCheck(void)
703 if(!ECC_InitSanityCheck()) {
704 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
705 return false;
708 if (!glibc_sanity_test() || !glibcxx_sanity_test())
709 return false;
711 if (!Random_SanityCheck()) {
712 InitError("OS cryptographic RNG sanity check failure. Aborting.");
713 return false;
716 return true;
719 bool AppInitServers(boost::thread_group& threadGroup)
721 RPCServer::OnStarted(&OnRPCStarted);
722 RPCServer::OnStopped(&OnRPCStopped);
723 RPCServer::OnPreCommand(&OnRPCPreCommand);
724 if (!InitHTTPServer())
725 return false;
726 if (!StartRPC())
727 return false;
728 if (!StartHTTPRPC())
729 return false;
730 if (gArgs.GetBoolArg("-rest", DEFAULT_REST_ENABLE) && !StartREST())
731 return false;
732 if (!StartHTTPServer())
733 return false;
734 return true;
737 // Parameter interaction based on rules
738 void InitParameterInteraction()
740 // when specifying an explicit binding address, you want to listen on it
741 // even when -connect or -proxy is specified
742 if (gArgs.IsArgSet("-bind")) {
743 if (gArgs.SoftSetBoolArg("-listen", true))
744 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
746 if (gArgs.IsArgSet("-whitebind")) {
747 if (gArgs.SoftSetBoolArg("-listen", true))
748 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
751 if (gArgs.IsArgSet("-connect")) {
752 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
753 if (gArgs.SoftSetBoolArg("-dnsseed", false))
754 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
755 if (gArgs.SoftSetBoolArg("-listen", false))
756 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
759 if (gArgs.IsArgSet("-proxy")) {
760 // to protect privacy, do not listen by default if a default proxy server is specified
761 if (gArgs.SoftSetBoolArg("-listen", false))
762 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
763 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
764 // to listen locally, so don't rely on this happening through -listen below.
765 if (gArgs.SoftSetBoolArg("-upnp", false))
766 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
767 // to protect privacy, do not discover addresses by default
768 if (gArgs.SoftSetBoolArg("-discover", false))
769 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
772 if (!gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
773 // do not map ports or try to retrieve public IP when not listening (pointless)
774 if (gArgs.SoftSetBoolArg("-upnp", false))
775 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
776 if (gArgs.SoftSetBoolArg("-discover", false))
777 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
778 if (gArgs.SoftSetBoolArg("-listenonion", false))
779 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
782 if (gArgs.IsArgSet("-externalip")) {
783 // if an explicit public IP is specified, do not try to find others
784 if (gArgs.SoftSetBoolArg("-discover", false))
785 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
788 // disable whitelistrelay in blocksonly mode
789 if (gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
790 if (gArgs.SoftSetBoolArg("-whitelistrelay", false))
791 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
794 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
795 if (gArgs.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
796 if (gArgs.SoftSetBoolArg("-whitelistrelay", true))
797 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
801 static std::string ResolveErrMsg(const char * const optname, const std::string& strBind)
803 return strprintf(_("Cannot resolve -%s address: '%s'"), optname, strBind);
806 void InitLogging()
808 fPrintToConsole = gArgs.GetBoolArg("-printtoconsole", false);
809 fLogTimestamps = gArgs.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
810 fLogTimeMicros = gArgs.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
811 fLogIPs = gArgs.GetBoolArg("-logips", DEFAULT_LOGIPS);
813 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
814 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
817 namespace { // Variables internal to initialization process only
819 ServiceFlags nRelevantServices = NODE_NETWORK;
820 int nMaxConnections;
821 int nUserMaxConnections;
822 int nFD;
823 ServiceFlags nLocalServices = NODE_NETWORK;
825 } // namespace
827 [[noreturn]] static void new_handler_terminate()
829 // Rather than throwing std::bad-alloc if allocation fails, terminate
830 // immediately to (try to) avoid chain corruption.
831 // Since LogPrintf may itself allocate memory, set the handler directly
832 // to terminate first.
833 std::set_new_handler(std::terminate);
834 LogPrintf("Error: Out of memory. Terminating.\n");
836 // The log was successful, terminate now.
837 std::terminate();
840 bool AppInitBasicSetup()
842 // ********************************************************* Step 1: setup
843 #ifdef _MSC_VER
844 // Turn off Microsoft heap dump noise
845 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
846 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
847 // Disable confusing "helpful" text message on abort, Ctrl-C
848 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
849 #endif
850 #ifdef WIN32
851 // Enable Data Execution Prevention (DEP)
852 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
853 // A failure is non-critical and needs no further attention!
854 #ifndef PROCESS_DEP_ENABLE
855 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
856 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
857 #define PROCESS_DEP_ENABLE 0x00000001
858 #endif
859 typedef BOOL (WINAPI *PSETPROCDEPPOL)(DWORD);
860 PSETPROCDEPPOL setProcDEPPol = (PSETPROCDEPPOL)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
861 if (setProcDEPPol != nullptr) setProcDEPPol(PROCESS_DEP_ENABLE);
862 #endif
864 if (!SetupNetworking())
865 return InitError("Initializing networking failed");
867 #ifndef WIN32
868 if (!gArgs.GetBoolArg("-sysperms", false)) {
869 umask(077);
872 // Clean shutdown on SIGTERM
873 registerSignalHandler(SIGTERM, HandleSIGTERM);
874 registerSignalHandler(SIGINT, HandleSIGTERM);
876 // Reopen debug.log on SIGHUP
877 registerSignalHandler(SIGHUP, HandleSIGHUP);
879 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
880 signal(SIGPIPE, SIG_IGN);
881 #endif
883 std::set_new_handler(new_handler_terminate);
885 return true;
888 bool AppInitParameterInteraction()
890 const CChainParams& chainparams = Params();
891 // ********************************************************* Step 2: parameter interactions
893 // also see: InitParameterInteraction()
895 // if using block pruning, then disallow txindex
896 if (gArgs.GetArg("-prune", 0)) {
897 if (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX))
898 return InitError(_("Prune mode is incompatible with -txindex."));
901 // -bind and -whitebind can't be set when not listening
902 size_t nUserBind = gArgs.GetArgs("-bind").size() + gArgs.GetArgs("-whitebind").size();
903 if (nUserBind != 0 && !gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
904 return InitError("Cannot set -bind or -whitebind together with -listen=0");
907 // Make sure enough file descriptors are available
908 int nBind = std::max(nUserBind, size_t(1));
909 nUserMaxConnections = gArgs.GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
910 nMaxConnections = std::max(nUserMaxConnections, 0);
912 // Trim requested connection counts, to fit into system limitations
913 nMaxConnections = std::max(std::min(nMaxConnections, (int)(FD_SETSIZE - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS)), 0);
914 nFD = RaiseFileDescriptorLimit(nMaxConnections + MIN_CORE_FILEDESCRIPTORS + MAX_ADDNODE_CONNECTIONS);
915 if (nFD < MIN_CORE_FILEDESCRIPTORS)
916 return InitError(_("Not enough file descriptors available."));
917 nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS, nMaxConnections);
919 if (nMaxConnections < nUserMaxConnections)
920 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
922 // ********************************************************* Step 3: parameter-to-internal-flags
923 if (gArgs.IsArgSet("-debug")) {
924 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
925 const std::vector<std::string> categories = gArgs.GetArgs("-debug");
927 if (find(categories.begin(), categories.end(), std::string("0")) == categories.end()) {
928 for (const auto& cat : categories) {
929 uint32_t flag = 0;
930 if (!GetLogCategory(&flag, &cat)) {
931 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
932 continue;
934 logCategories |= flag;
939 // Now remove the logging categories which were explicitly excluded
940 for (const std::string& cat : gArgs.GetArgs("-debugexclude")) {
941 uint32_t flag = 0;
942 if (!GetLogCategory(&flag, &cat)) {
943 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
944 continue;
946 logCategories &= ~flag;
949 // Check for -debugnet
950 if (gArgs.GetBoolArg("-debugnet", false))
951 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
952 // Check for -socks - as this is a privacy risk to continue, exit here
953 if (gArgs.IsArgSet("-socks"))
954 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
955 // Check for -tor - as this is a privacy risk to continue, exit here
956 if (gArgs.GetBoolArg("-tor", false))
957 return InitError(_("Unsupported argument -tor found, use -onion."));
959 if (gArgs.GetBoolArg("-benchmark", false))
960 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
962 if (gArgs.GetBoolArg("-whitelistalwaysrelay", false))
963 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
965 if (gArgs.IsArgSet("-blockminsize"))
966 InitWarning("Unsupported argument -blockminsize ignored.");
968 // Checkmempool and checkblockindex default to true in regtest mode
969 int ratio = std::min<int>(std::max<int>(gArgs.GetArg("-checkmempool", chainparams.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
970 if (ratio != 0) {
971 mempool.setSanityCheck(1.0 / ratio);
973 fCheckBlockIndex = gArgs.GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
974 fCheckpointsEnabled = gArgs.GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED);
976 hashAssumeValid = uint256S(gArgs.GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
977 if (!hashAssumeValid.IsNull())
978 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid.GetHex());
979 else
980 LogPrintf("Validating signatures for all blocks.\n");
982 // mempool limits
983 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
984 int64_t nMempoolSizeMin = gArgs.GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT) * 1000 * 40;
985 if (nMempoolSizeMax < 0 || nMempoolSizeMax < nMempoolSizeMin)
986 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin / 1000000.0)));
987 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
988 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
989 if (gArgs.IsArgSet("-incrementalrelayfee"))
991 CAmount n = 0;
992 if (!ParseMoney(gArgs.GetArg("-incrementalrelayfee", ""), n))
993 return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")));
994 incrementalRelayFee = CFeeRate(n);
997 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
998 nScriptCheckThreads = gArgs.GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
999 if (nScriptCheckThreads <= 0)
1000 nScriptCheckThreads += GetNumCores();
1001 if (nScriptCheckThreads <= 1)
1002 nScriptCheckThreads = 0;
1003 else if (nScriptCheckThreads > MAX_SCRIPTCHECK_THREADS)
1004 nScriptCheckThreads = MAX_SCRIPTCHECK_THREADS;
1006 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
1007 int64_t nPruneArg = gArgs.GetArg("-prune", 0);
1008 if (nPruneArg < 0) {
1009 return InitError(_("Prune cannot be configured with a negative value."));
1011 nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
1012 if (nPruneArg == 1) { // manual pruning: -prune=1
1013 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1014 nPruneTarget = std::numeric_limits<uint64_t>::max();
1015 fPruneMode = true;
1016 } else if (nPruneTarget) {
1017 if (nPruneTarget < MIN_DISK_SPACE_FOR_BLOCK_FILES) {
1018 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
1020 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget / 1024 / 1024);
1021 fPruneMode = true;
1024 RegisterAllCoreRPCCommands(tableRPC);
1025 #ifdef ENABLE_WALLET
1026 RegisterWalletRPCCommands(tableRPC);
1027 #endif
1029 nConnectTimeout = gArgs.GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1030 if (nConnectTimeout <= 0)
1031 nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1033 if (gArgs.IsArgSet("-minrelaytxfee")) {
1034 CAmount n = 0;
1035 if (!ParseMoney(gArgs.GetArg("-minrelaytxfee", ""), n)) {
1036 return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")));
1038 // High fee check is done afterward in CWallet::ParameterInteraction()
1039 ::minRelayTxFee = CFeeRate(n);
1040 } else if (incrementalRelayFee > ::minRelayTxFee) {
1041 // Allow only setting incrementalRelayFee to control both
1042 ::minRelayTxFee = incrementalRelayFee;
1043 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee.ToString());
1046 // Sanity check argument for min fee for including tx in block
1047 // TODO: Harmonize which arguments need sanity checking and where that happens
1048 if (gArgs.IsArgSet("-blockmintxfee"))
1050 CAmount n = 0;
1051 if (!ParseMoney(gArgs.GetArg("-blockmintxfee", ""), n))
1052 return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")));
1055 // Feerate used to define dust. Shouldn't be changed lightly as old
1056 // implementations may inadvertently create non-standard transactions
1057 if (gArgs.IsArgSet("-dustrelayfee"))
1059 CAmount n = 0;
1060 if (!ParseMoney(gArgs.GetArg("-dustrelayfee", ""), n) || 0 == n)
1061 return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")));
1062 dustRelayFee = CFeeRate(n);
1065 fRequireStandard = !gArgs.GetBoolArg("-acceptnonstdtxn", !chainparams.RequireStandard());
1066 if (chainparams.RequireStandard() && !fRequireStandard)
1067 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams.NetworkIDString()));
1068 nBytesPerSigOp = gArgs.GetArg("-bytespersigop", nBytesPerSigOp);
1070 #ifdef ENABLE_WALLET
1071 if (!CWallet::ParameterInteraction())
1072 return false;
1073 #endif
1075 fIsBareMultisigStd = gArgs.GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG);
1076 fAcceptDatacarrier = gArgs.GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER);
1077 nMaxDatacarrierBytes = gArgs.GetArg("-datacarriersize", nMaxDatacarrierBytes);
1079 // Option to startup with mocktime set (used for regression testing):
1080 SetMockTime(gArgs.GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1082 if (gArgs.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1083 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
1085 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
1086 return InitError("rpcserialversion must be non-negative.");
1088 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
1089 return InitError("unknown rpcserialversion requested.");
1091 nMaxTipAge = gArgs.GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
1093 fEnableReplacement = gArgs.GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT);
1094 if ((!fEnableReplacement) && gArgs.IsArgSet("-mempoolreplacement")) {
1095 // Minimal effort at forwards compatibility
1096 std::string strReplacementModeList = gArgs.GetArg("-mempoolreplacement", ""); // default is impossible
1097 std::vector<std::string> vstrReplacementModes;
1098 boost::split(vstrReplacementModes, strReplacementModeList, boost::is_any_of(","));
1099 fEnableReplacement = (std::find(vstrReplacementModes.begin(), vstrReplacementModes.end(), "fee") != vstrReplacementModes.end());
1102 if (gArgs.IsArgSet("-vbparams")) {
1103 // Allow overriding version bits parameters for testing
1104 if (!chainparams.MineBlocksOnDemand()) {
1105 return InitError("Version bits parameters may only be overridden on regtest.");
1107 for (const std::string& strDeployment : gArgs.GetArgs("-vbparams")) {
1108 std::vector<std::string> vDeploymentParams;
1109 boost::split(vDeploymentParams, strDeployment, boost::is_any_of(":"));
1110 if (vDeploymentParams.size() != 3) {
1111 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1113 int64_t nStartTime, nTimeout;
1114 if (!ParseInt64(vDeploymentParams[1], &nStartTime)) {
1115 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
1117 if (!ParseInt64(vDeploymentParams[2], &nTimeout)) {
1118 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
1120 bool found = false;
1121 for (int j=0; j<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j)
1123 if (vDeploymentParams[0].compare(VersionBitsDeploymentInfo[j].name) == 0) {
1124 UpdateVersionBitsParameters(Consensus::DeploymentPos(j), nStartTime, nTimeout);
1125 found = true;
1126 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams[0], nStartTime, nTimeout);
1127 break;
1130 if (!found) {
1131 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
1135 return true;
1138 static bool LockDataDirectory(bool probeOnly)
1140 std::string strDataDir = GetDataDir().string();
1142 // Make sure only a single Bitcoin process is using the data directory.
1143 fs::path pathLockFile = GetDataDir() / ".lock";
1144 FILE* file = fsbridge::fopen(pathLockFile, "a"); // empty lock file; created if it doesn't exist.
1145 if (file) fclose(file);
1147 try {
1148 static boost::interprocess::file_lock lock(pathLockFile.string().c_str());
1149 if (!lock.try_lock()) {
1150 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir, _(PACKAGE_NAME)));
1152 if (probeOnly) {
1153 lock.unlock();
1155 } catch(const boost::interprocess::interprocess_exception& e) {
1156 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir, _(PACKAGE_NAME), e.what()));
1158 return true;
1161 bool AppInitSanityChecks()
1163 // ********************************************************* Step 4: sanity checks
1165 // Initialize elliptic curve code
1166 std::string sha256_algo = SHA256AutoDetect();
1167 LogPrintf("Using the '%s' SHA256 implementation\n", sha256_algo);
1168 RandomInit();
1169 ECC_Start();
1170 globalVerifyHandle.reset(new ECCVerifyHandle());
1172 // Sanity check
1173 if (!InitSanityCheck())
1174 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME)));
1176 // Probe the data directory lock to give an early error message, if possible
1177 // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1178 // and a fork will cause weird behavior to it.
1179 return LockDataDirectory(true);
1182 bool AppInitLockDataDirectory()
1184 // After daemonization get the data directory lock again and hold on to it until exit
1185 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1186 // will at most make us exit without printing a message to console.
1187 if (!LockDataDirectory(false)) {
1188 // Detailed error printed inside LockDataDirectory
1189 return false;
1191 return true;
1194 bool AppInitMain(boost::thread_group& threadGroup, CScheduler& scheduler)
1196 const CChainParams& chainparams = Params();
1197 // ********************************************************* Step 4a: application initialization
1198 #ifndef WIN32
1199 CreatePidFile(GetPidFile(), getpid());
1200 #endif
1201 if (gArgs.GetBoolArg("-shrinkdebugfile", logCategories == BCLog::NONE)) {
1202 // Do this first since it both loads a bunch of debug.log into memory,
1203 // and because this needs to happen before any other debug.log printing
1204 ShrinkDebugFile();
1207 if (fPrintToDebugLog)
1208 OpenDebugLog();
1210 if (!fLogTimestamps)
1211 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1212 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1213 LogPrintf("Using data directory %s\n", GetDataDir().string());
1214 LogPrintf("Using config file %s\n", GetConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME)).string());
1215 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1217 InitSignatureCache();
1218 InitScriptExecutionCache();
1220 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads);
1221 if (nScriptCheckThreads) {
1222 for (int i=0; i<nScriptCheckThreads-1; i++)
1223 threadGroup.create_thread(&ThreadScriptCheck);
1226 // Start the lightweight task scheduler thread
1227 CScheduler::Function serviceLoop = boost::bind(&CScheduler::serviceQueue, &scheduler);
1228 threadGroup.create_thread(boost::bind(&TraceThread<CScheduler::Function>, "scheduler", serviceLoop));
1230 GetMainSignals().RegisterBackgroundSignalScheduler(scheduler);
1232 /* Start the RPC server already. It will be started in "warmup" mode
1233 * and not really process calls already (but it will signify connections
1234 * that the server is there and will be ready later). Warmup mode will
1235 * be disabled when initialisation is finished.
1237 if (gArgs.GetBoolArg("-server", false))
1239 uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1240 if (!AppInitServers(threadGroup))
1241 return InitError(_("Unable to start HTTP server. See debug log for details."));
1244 int64_t nStart;
1246 // ********************************************************* Step 5: verify wallet database integrity
1247 #ifdef ENABLE_WALLET
1248 if (!CWallet::Verify())
1249 return false;
1250 #endif
1251 // ********************************************************* Step 6: network initialization
1252 // Note that we absolutely cannot open any actual connections
1253 // until the very end ("start node") as the UTXO/block state
1254 // is not yet setup and may end up being set up twice if we
1255 // need to reindex later.
1257 assert(!g_connman);
1258 g_connman = std::unique_ptr<CConnman>(new CConnman(GetRand(std::numeric_limits<uint64_t>::max()), GetRand(std::numeric_limits<uint64_t>::max())));
1259 CConnman& connman = *g_connman;
1261 peerLogic.reset(new PeerLogicValidation(&connman));
1262 RegisterValidationInterface(peerLogic.get());
1263 RegisterNodeSignals(GetNodeSignals());
1265 // sanitize comments per BIP-0014, format user agent and check total size
1266 std::vector<std::string> uacomments;
1267 for (const std::string& cmt : gArgs.GetArgs("-uacomment")) {
1268 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1269 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1270 uacomments.push_back(cmt);
1272 strSubVersion = FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, uacomments);
1273 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1274 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1275 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1278 if (gArgs.IsArgSet("-onlynet")) {
1279 std::set<enum Network> nets;
1280 for (const std::string& snet : gArgs.GetArgs("-onlynet")) {
1281 enum Network net = ParseNetwork(snet);
1282 if (net == NET_UNROUTABLE)
1283 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1284 nets.insert(net);
1286 for (int n = 0; n < NET_MAX; n++) {
1287 enum Network net = (enum Network)n;
1288 if (!nets.count(net))
1289 SetLimited(net);
1293 // Check for host lookup allowed before parsing any network related parameters
1294 fNameLookup = gArgs.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1296 bool proxyRandomize = gArgs.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1297 // -proxy sets a proxy for all outgoing network traffic
1298 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1299 std::string proxyArg = gArgs.GetArg("-proxy", "");
1300 SetLimited(NET_TOR);
1301 if (proxyArg != "" && proxyArg != "0") {
1302 CService proxyAddr;
1303 if (!Lookup(proxyArg.c_str(), proxyAddr, 9050, fNameLookup)) {
1304 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1307 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
1308 if (!addrProxy.IsValid())
1309 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1311 SetProxy(NET_IPV4, addrProxy);
1312 SetProxy(NET_IPV6, addrProxy);
1313 SetProxy(NET_TOR, addrProxy);
1314 SetNameProxy(addrProxy);
1315 SetLimited(NET_TOR, false); // by default, -proxy sets onion as reachable, unless -noonion later
1318 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1319 // -noonion (or -onion=0) disables connecting to .onion entirely
1320 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1321 std::string onionArg = gArgs.GetArg("-onion", "");
1322 if (onionArg != "") {
1323 if (onionArg == "0") { // Handle -noonion/-onion=0
1324 SetLimited(NET_TOR); // set onions as unreachable
1325 } else {
1326 CService onionProxy;
1327 if (!Lookup(onionArg.c_str(), onionProxy, 9050, fNameLookup)) {
1328 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1330 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
1331 if (!addrOnion.IsValid())
1332 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1333 SetProxy(NET_TOR, addrOnion);
1334 SetLimited(NET_TOR, false);
1338 // see Step 2: parameter interactions for more information about these
1339 fListen = gArgs.GetBoolArg("-listen", DEFAULT_LISTEN);
1340 fDiscover = gArgs.GetBoolArg("-discover", true);
1341 fRelayTxes = !gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY);
1343 for (const std::string& strAddr : gArgs.GetArgs("-externalip")) {
1344 CService addrLocal;
1345 if (Lookup(strAddr.c_str(), addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1346 AddLocal(addrLocal, LOCAL_MANUAL);
1347 else
1348 return InitError(ResolveErrMsg("externalip", strAddr));
1351 #if ENABLE_ZMQ
1352 pzmqNotificationInterface = CZMQNotificationInterface::Create();
1354 if (pzmqNotificationInterface) {
1355 RegisterValidationInterface(pzmqNotificationInterface);
1357 #endif
1358 uint64_t nMaxOutboundLimit = 0; //unlimited unless -maxuploadtarget is set
1359 uint64_t nMaxOutboundTimeframe = MAX_UPLOAD_TIMEFRAME;
1361 if (gArgs.IsArgSet("-maxuploadtarget")) {
1362 nMaxOutboundLimit = gArgs.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET)*1024*1024;
1365 // ********************************************************* Step 7: load block chain
1367 fReindex = gArgs.GetBoolArg("-reindex", false);
1368 bool fReindexChainState = gArgs.GetBoolArg("-reindex-chainstate", false);
1370 // cache size calculations
1371 int64_t nTotalCache = (gArgs.GetArg("-dbcache", nDefaultDbCache) << 20);
1372 nTotalCache = std::max(nTotalCache, nMinDbCache << 20); // total cache cannot be less than nMinDbCache
1373 nTotalCache = std::min(nTotalCache, nMaxDbCache << 20); // total cache cannot be greater than nMaxDbcache
1374 int64_t nBlockTreeDBCache = nTotalCache / 8;
1375 nBlockTreeDBCache = std::min(nBlockTreeDBCache, (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX) ? nMaxBlockDBAndTxIndexCache : nMaxBlockDBCache) << 20);
1376 nTotalCache -= nBlockTreeDBCache;
1377 int64_t nCoinDBCache = std::min(nTotalCache / 2, (nTotalCache / 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1378 nCoinDBCache = std::min(nCoinDBCache, nMaxCoinsDBCache << 20); // cap total coins db cache
1379 nTotalCache -= nCoinDBCache;
1380 nCoinCacheUsage = nTotalCache; // the rest goes to in-memory cache
1381 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
1382 LogPrintf("Cache configuration:\n");
1383 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache * (1.0 / 1024 / 1024));
1384 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache * (1.0 / 1024 / 1024));
1385 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));
1387 bool fLoaded = false;
1388 while (!fLoaded && !fRequestShutdown) {
1389 bool fReset = fReindex;
1390 std::string strLoadError;
1392 uiInterface.InitMessage(_("Loading block index..."));
1394 nStart = GetTimeMillis();
1395 do {
1396 try {
1397 UnloadBlockIndex();
1398 delete pcoinsTip;
1399 delete pcoinsdbview;
1400 delete pcoinscatcher;
1401 delete pblocktree;
1403 pblocktree = new CBlockTreeDB(nBlockTreeDBCache, false, fReset);
1405 if (fReset) {
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();
1412 if (fRequestShutdown) break;
1414 // LoadBlockIndex will load fTxIndex from the db, or set it if
1415 // we're reindexing. It will also load fHavePruned if we've
1416 // ever removed a block file from disk.
1417 // Note that it also sets fReindex based on the disk flag!
1418 // From here on out fReindex and fReset mean something different!
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 // Check for changed -txindex state
1430 if (fTxIndex != gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1431 strLoadError = _("You need to rebuild the database using -reindex-chainstate to change -txindex");
1432 break;
1435 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1436 // in the past, but is now trying to run unpruned.
1437 if (fHavePruned && !fPruneMode) {
1438 strLoadError = _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1439 break;
1442 // At this point blocktree args are consistent with what's on disk.
1443 // If we're not mid-reindex (based on disk + args), add a genesis block on disk
1444 // (otherwise we use the one already on disk).
1445 // This is called again in ThreadImport after the reindex completes.
1446 if (!fReindex && !LoadGenesisBlock(chainparams)) {
1447 strLoadError = _("Error initializing block database");
1448 break;
1451 // At this point we're either in reindex or we've loaded a useful
1452 // block tree into mapBlockIndex!
1454 pcoinsdbview = new CCoinsViewDB(nCoinDBCache, false, fReset || fReindexChainState);
1455 pcoinscatcher = new CCoinsViewErrorCatcher(pcoinsdbview);
1457 // If necessary, upgrade from older database format.
1458 // This is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1459 if (!pcoinsdbview->Upgrade()) {
1460 strLoadError = _("Error upgrading chainstate database");
1461 break;
1464 // ReplayBlocks is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1465 if (!ReplayBlocks(chainparams, pcoinsdbview)) {
1466 strLoadError = _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.");
1467 break;
1470 // The on-disk coinsdb is now in a good state, create the cache
1471 pcoinsTip = new CCoinsViewCache(pcoinscatcher);
1473 bool is_coinsview_empty = fReset || fReindexChainState || pcoinsTip->GetBestBlock().IsNull();
1474 if (!is_coinsview_empty) {
1475 // LoadChainTip sets chainActive based on pcoinsTip's best block
1476 if (!LoadChainTip(chainparams)) {
1477 strLoadError = _("Error initializing block database");
1478 break;
1480 assert(chainActive.Tip() != nullptr);
1483 if (!fReset) {
1484 // Note that RewindBlockIndex MUST run even if we're about to -reindex-chainstate.
1485 // It both disconnects blocks based on chainActive, and drops block data in
1486 // mapBlockIndex based on lack of available witness data.
1487 uiInterface.InitMessage(_("Rewinding blocks..."));
1488 if (!RewindBlockIndex(chainparams)) {
1489 strLoadError = _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1490 break;
1494 if (!is_coinsview_empty) {
1495 uiInterface.InitMessage(_("Verifying blocks..."));
1496 if (fHavePruned && gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS) > MIN_BLOCKS_TO_KEEP) {
1497 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1498 MIN_BLOCKS_TO_KEEP);
1502 LOCK(cs_main);
1503 CBlockIndex* tip = chainActive.Tip();
1504 RPCNotifyBlockChange(true, tip);
1505 if (tip && tip->nTime > GetAdjustedTime() + 2 * 60 * 60) {
1506 strLoadError = _("The block database contains a block which appears to be from the future. "
1507 "This may be due to your computer's date and time being set incorrectly. "
1508 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1509 break;
1513 if (!CVerifyDB().VerifyDB(chainparams, pcoinsdbview, gArgs.GetArg("-checklevel", DEFAULT_CHECKLEVEL),
1514 gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS))) {
1515 strLoadError = _("Corrupted block database detected");
1516 break;
1519 } catch (const std::exception& e) {
1520 LogPrintf("%s\n", e.what());
1521 strLoadError = _("Error opening block database");
1522 break;
1525 fLoaded = true;
1526 } while(false);
1528 if (!fLoaded && !fRequestShutdown) {
1529 // first suggest a reindex
1530 if (!fReset) {
1531 bool fRet = uiInterface.ThreadSafeQuestion(
1532 strLoadError + ".\n\n" + _("Do you want to rebuild the block database now?"),
1533 strLoadError + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1534 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1535 if (fRet) {
1536 fReindex = true;
1537 fRequestShutdown = false;
1538 } else {
1539 LogPrintf("Aborted block database rebuild. Exiting.\n");
1540 return false;
1542 } else {
1543 return InitError(strLoadError);
1548 // As LoadBlockIndex can take several minutes, it's possible the user
1549 // requested to kill the GUI during the last operation. If so, exit.
1550 // As the program has not fully started yet, Shutdown() is possibly overkill.
1551 if (fRequestShutdown)
1553 LogPrintf("Shutdown requested. Exiting.\n");
1554 return false;
1556 if (fLoaded) {
1557 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart);
1560 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
1561 CAutoFile est_filein(fsbridge::fopen(est_path, "rb"), SER_DISK, CLIENT_VERSION);
1562 // Allowed to fail as this file IS missing on first startup.
1563 if (!est_filein.IsNull())
1564 ::feeEstimator.Read(est_filein);
1565 fFeeEstimatesInitialized = true;
1567 // ********************************************************* Step 8: load wallet
1568 #ifdef ENABLE_WALLET
1569 if (!CWallet::InitLoadWallet())
1570 return false;
1571 #else
1572 LogPrintf("No wallet support compiled in!\n");
1573 #endif
1575 // ********************************************************* Step 9: data directory maintenance
1577 // if pruning, unset the service bit and perform the initial blockstore prune
1578 // after any wallet rescanning has taken place.
1579 if (fPruneMode) {
1580 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1581 nLocalServices = ServiceFlags(nLocalServices & ~NODE_NETWORK);
1582 if (!fReindex) {
1583 uiInterface.InitMessage(_("Pruning blockstore..."));
1584 PruneAndFlush();
1588 if (chainparams.GetConsensus().vDeployments[Consensus::DEPLOYMENT_SEGWIT].nTimeout != 0) {
1589 // Only advertise witness capabilities if they have a reasonable start time.
1590 // This allows us to have the code merged without a defined softfork, by setting its
1591 // end time to 0.
1592 // Note that setting NODE_WITNESS is never required: the only downside from not
1593 // doing so is that after activation, no upgraded nodes will fetch from you.
1594 nLocalServices = ServiceFlags(nLocalServices | NODE_WITNESS);
1595 // Only care about others providing witness capabilities if there is a softfork
1596 // defined.
1597 nRelevantServices = ServiceFlags(nRelevantServices | NODE_WITNESS);
1600 // ********************************************************* Step 10: import blocks
1602 if (!CheckDiskSpace())
1603 return false;
1605 // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1606 // No locking, as this happens before any background thread is started.
1607 if (chainActive.Tip() == nullptr) {
1608 uiInterface.NotifyBlockTip.connect(BlockNotifyGenesisWait);
1609 } else {
1610 fHaveGenesis = true;
1613 if (gArgs.IsArgSet("-blocknotify"))
1614 uiInterface.NotifyBlockTip.connect(BlockNotifyCallback);
1616 std::vector<fs::path> vImportFiles;
1617 for (const std::string& strFile : gArgs.GetArgs("-loadblock")) {
1618 vImportFiles.push_back(strFile);
1621 threadGroup.create_thread(boost::bind(&ThreadImport, vImportFiles));
1623 // Wait for genesis block to be processed
1625 boost::unique_lock<boost::mutex> lock(cs_GenesisWait);
1626 while (!fHaveGenesis) {
1627 condvar_GenesisWait.wait(lock);
1629 uiInterface.NotifyBlockTip.disconnect(BlockNotifyGenesisWait);
1632 // ********************************************************* Step 11: start node
1634 //// debug print
1635 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex.size());
1636 LogPrintf("nBestHeight = %d\n", chainActive.Height());
1637 if (gArgs.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION))
1638 StartTorControl(threadGroup, scheduler);
1640 Discover(threadGroup);
1642 // Map ports with UPnP
1643 MapPort(gArgs.GetBoolArg("-upnp", DEFAULT_UPNP));
1645 CConnman::Options connOptions;
1646 connOptions.nLocalServices = nLocalServices;
1647 connOptions.nRelevantServices = nRelevantServices;
1648 connOptions.nMaxConnections = nMaxConnections;
1649 connOptions.nMaxOutbound = std::min(MAX_OUTBOUND_CONNECTIONS, connOptions.nMaxConnections);
1650 connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1651 connOptions.nMaxFeeler = 1;
1652 connOptions.nBestHeight = chainActive.Height();
1653 connOptions.uiInterface = &uiInterface;
1654 connOptions.nSendBufferMaxSize = 1000*gArgs.GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1655 connOptions.nReceiveFloodSize = 1000*gArgs.GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1657 connOptions.nMaxOutboundTimeframe = nMaxOutboundTimeframe;
1658 connOptions.nMaxOutboundLimit = nMaxOutboundLimit;
1660 for (const std::string& strBind : gArgs.GetArgs("-bind")) {
1661 CService addrBind;
1662 if (!Lookup(strBind.c_str(), addrBind, GetListenPort(), false)) {
1663 return InitError(ResolveErrMsg("bind", strBind));
1665 connOptions.vBinds.push_back(addrBind);
1667 for (const std::string& strBind : gArgs.GetArgs("-whitebind")) {
1668 CService addrBind;
1669 if (!Lookup(strBind.c_str(), addrBind, 0, false)) {
1670 return InitError(ResolveErrMsg("whitebind", strBind));
1672 if (addrBind.GetPort() == 0) {
1673 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind));
1675 connOptions.vWhiteBinds.push_back(addrBind);
1678 for (const auto& net : gArgs.GetArgs("-whitelist")) {
1679 CSubNet subnet;
1680 LookupSubNet(net.c_str(), subnet);
1681 if (!subnet.IsValid())
1682 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net));
1683 connOptions.vWhitelistedRange.push_back(subnet);
1686 if (gArgs.IsArgSet("-seednode")) {
1687 connOptions.vSeedNodes = gArgs.GetArgs("-seednode");
1690 if (!connman.Start(scheduler, connOptions)) {
1691 return false;
1694 // ********************************************************* Step 12: finished
1696 SetRPCWarmupFinished();
1697 uiInterface.InitMessage(_("Done loading"));
1699 #ifdef ENABLE_WALLET
1700 for (CWalletRef pwallet : vpwallets) {
1701 pwallet->postInitProcess(scheduler);
1703 #endif
1705 return !fRequestShutdown;