Merge #11191: RPC: Improve help text and behavior of RPC-logging.
[bitcoinplatinum.git] / src / init.cpp
blobd12df147a1851fc1187bec9c76cedba4815c8dea
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/safemode.h>
34 #include <rpc/blockchain.h>
35 #include <script/standard.h>
36 #include <script/sigcache.h>
37 #include <scheduler.h>
38 #include <timedata.h>
39 #include <txdb.h>
40 #include <txmempool.h>
41 #include <torcontrol.h>
42 #include <ui_interface.h>
43 #include <util.h>
44 #include <utilmoneystr.h>
45 #include <validationinterface.h>
46 #ifdef ENABLE_WALLET
47 #include <wallet/init.h>
48 #endif
49 #include <warnings.h>
50 #include <stdint.h>
51 #include <stdio.h>
52 #include <memory>
54 #ifndef WIN32
55 #include <signal.h>
56 #endif
58 #include <boost/algorithm/string/classification.hpp>
59 #include <boost/algorithm/string/replace.hpp>
60 #include <boost/algorithm/string/split.hpp>
61 #include <boost/bind.hpp>
62 #include <boost/interprocess/sync/file_lock.hpp>
63 #include <boost/thread.hpp>
64 #include <openssl/crypto.h>
66 #if ENABLE_ZMQ
67 #include <zmq/zmqnotificationinterface.h>
68 #endif
70 bool fFeeEstimatesInitialized = false;
71 static const bool DEFAULT_PROXYRANDOMIZE = true;
72 static const bool DEFAULT_REST_ENABLE = 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 = 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 makes main thread's
106 // WaitForShutdown() interrupts the thread group.
107 // And then, WaitForShutdown() makes all other on-going threads
108 // in the thread group join the main thread.
109 // Shutdown() is then called to clean up database connections, and stop other
110 // threads that should only be stopped after the main network-processing
111 // threads have exited.
113 // Shutdown for Qt is very similar, only it uses a QTimer to detect
114 // fRequestShutdown getting set, and then does the normal Qt
115 // shutdown thing.
118 std::atomic<bool> fRequestShutdown(false);
119 std::atomic<bool> fDumpMempoolLater(false);
121 void StartShutdown()
123 fRequestShutdown = true;
125 bool ShutdownRequested()
127 return fRequestShutdown;
131 * This is a minimally invasive approach to shutdown on LevelDB read errors from the
132 * chainstate, while keeping user interface out of the common library, which is shared
133 * between bitcoind, and bitcoin-qt and non-server tools.
135 class CCoinsViewErrorCatcher final : public CCoinsViewBacked
137 public:
138 explicit CCoinsViewErrorCatcher(CCoinsView* view) : CCoinsViewBacked(view) {}
139 bool GetCoin(const COutPoint &outpoint, Coin &coin) const override {
140 try {
141 return CCoinsViewBacked::GetCoin(outpoint, coin);
142 } catch(const std::runtime_error& e) {
143 uiInterface.ThreadSafeMessageBox(_("Error reading from database, shutting down."), "", CClientUIInterface::MSG_ERROR);
144 LogPrintf("Error reading from database: %s\n", e.what());
145 // Starting the shutdown sequence and returning false to the caller would be
146 // interpreted as 'entry not found' (as opposed to unable to read data), and
147 // could lead to invalid interpretation. Just exit immediately, as we can't
148 // continue anyway, and all writes should be atomic.
149 abort();
152 // Writes do not need similar protection, as failure to write is handled by the caller.
155 static std::unique_ptr<CCoinsViewErrorCatcher> pcoinscatcher;
156 static std::unique_ptr<ECCVerifyHandle> globalVerifyHandle;
158 void Interrupt(boost::thread_group& threadGroup)
160 InterruptHTTPServer();
161 InterruptHTTPRPC();
162 InterruptRPC();
163 InterruptREST();
164 InterruptTorControl();
165 if (g_connman)
166 g_connman->Interrupt();
167 threadGroup.interrupt_all();
170 void Shutdown()
172 LogPrintf("%s: In progress...\n", __func__);
173 static CCriticalSection cs_Shutdown;
174 TRY_LOCK(cs_Shutdown, lockShutdown);
175 if (!lockShutdown)
176 return;
178 /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
179 /// for example if the data directory was found to be locked.
180 /// Be sure that anything that writes files or flushes caches only does this if the respective
181 /// module was initialized.
182 RenameThread("bitcoin-shutoff");
183 mempool.AddTransactionsUpdated(1);
185 StopHTTPRPC();
186 StopREST();
187 StopRPC();
188 StopHTTPServer();
189 #ifdef ENABLE_WALLET
190 FlushWallets();
191 #endif
192 MapPort(false);
194 // Because these depend on each-other, we make sure that neither can be
195 // using the other before destroying them.
196 UnregisterValidationInterface(peerLogic.get());
197 if(g_connman) g_connman->Stop();
198 peerLogic.reset();
199 g_connman.reset();
201 StopTorControl();
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 pcoinsTip.reset();
239 pcoinscatcher.reset();
240 pcoinsdbview.reset();
241 pblocktree.reset();
243 #ifdef ENABLE_WALLET
244 StopWallets();
245 #endif
247 #if ENABLE_ZMQ
248 if (pzmqNotificationInterface) {
249 UnregisterValidationInterface(pzmqNotificationInterface);
250 delete pzmqNotificationInterface;
251 pzmqNotificationInterface = nullptr;
253 #endif
255 #ifndef WIN32
256 try {
257 fs::remove(GetPidFile());
258 } catch (const fs::filesystem_error& e) {
259 LogPrintf("%s: Unable to remove pidfile: %s\n", __func__, e.what());
261 #endif
262 UnregisterAllValidationInterfaces();
263 GetMainSignals().UnregisterBackgroundSignalScheduler();
264 GetMainSignals().UnregisterWithMempoolSignals(mempool);
265 #ifdef ENABLE_WALLET
266 CloseWallets();
267 #endif
268 globalVerifyHandle.reset();
269 ECC_Stop();
270 LogPrintf("%s: done\n", __func__);
274 * Signal handlers are very limited in what they are allowed to do.
275 * The execution context the handler is invoked in is not guaranteed,
276 * so we restrict handler operations to just touching variables:
278 static void HandleSIGTERM(int)
280 fRequestShutdown = true;
283 static void HandleSIGHUP(int)
285 fReopenDebugLog = true;
288 #ifndef WIN32
289 static void registerSignalHandler(int signal, void(*handler)(int))
291 struct sigaction sa;
292 sa.sa_handler = handler;
293 sigemptyset(&sa.sa_mask);
294 sa.sa_flags = 0;
295 sigaction(signal, &sa, nullptr);
297 #endif
299 void OnRPCStarted()
301 uiInterface.NotifyBlockTip.connect(&RPCNotifyBlockChange);
304 void OnRPCStopped()
306 uiInterface.NotifyBlockTip.disconnect(&RPCNotifyBlockChange);
307 RPCNotifyBlockChange(false, nullptr);
308 cvBlockChange.notify_all();
309 LogPrint(BCLog::RPC, "RPC stopped.\n");
312 std::string HelpMessage(HelpMessageMode mode)
314 const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
315 const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
316 const auto defaultChainParams = CreateChainParams(CBaseChainParams::MAIN);
317 const auto testnetChainParams = CreateChainParams(CBaseChainParams::TESTNET);
318 const bool showDebug = gArgs.GetBoolArg("-help-debug", false);
320 // When adding new options to the categories, please keep and ensure alphabetical ordering.
321 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
322 std::string strUsage = HelpMessageGroup(_("Options:"));
323 strUsage += HelpMessageOpt("-?", _("Print this help message and exit"));
324 strUsage += HelpMessageOpt("-version", _("Print version and exit"));
325 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)"));
326 strUsage += HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
327 if (showDebug)
328 strUsage += HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY));
329 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()));
330 strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
331 if (mode == HMM_BITCOIND)
333 #if HAVE_DECL_DAEMON
334 strUsage += HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
335 #endif
337 strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
338 if (showDebug) {
339 strUsage += HelpMessageOpt("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize));
341 strUsage += HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache));
342 if (showDebug)
343 strUsage += HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER));
344 strUsage += HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
345 strUsage += HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS));
346 strUsage += HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE));
347 strUsage += HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY));
348 if (showDebug) {
349 strUsage += HelpMessageOpt("-minimumchainwork=<hex>", strprintf("Minimum work assumed to exist on a valid chain in hex (default: %s, testnet: %s)", defaultChainParams->GetConsensus().nMinimumChainWork.GetHex(), testnetChainParams->GetConsensus().nMinimumChainWork.GetHex()));
351 strUsage += HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL));
352 strUsage += HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN));
353 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)"),
354 -GetNumCores(), MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS));
355 #ifndef WIN32
356 strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
357 #endif
358 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. "
359 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
360 "(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));
361 strUsage += HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
362 strUsage += HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
363 #ifndef WIN32
364 strUsage += HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
365 #endif
366 strUsage += HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX));
368 strUsage += HelpMessageGroup(_("Connection options:"));
369 strUsage += HelpMessageOpt("-addnode=<ip>", _("Add a node to connect to and attempt to keep the connection open (see the `addnode` RPC command help for more info)"));
370 strUsage += HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD));
371 strUsage += HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME));
372 strUsage += HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
373 strUsage += HelpMessageOpt("-connect=<ip>", _("Connect only to the specified node(s); -connect=0 disables automatic connections (the rules for this peer are the same as for -addnode)"));
374 strUsage += HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
375 strUsage += HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP));
376 strUsage += HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
377 strUsage += HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
378 strUsage += HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED));
379 strUsage += HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
380 strUsage += HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION));
381 strUsage += HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS));
382 strUsage += HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER));
383 strUsage += HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER));
384 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));
385 strUsage += HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
386 strUsage += HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
387 strUsage += HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG));
388 strUsage += HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS));
389 strUsage += HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort()));
390 strUsage += HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
391 strUsage += HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE));
392 strUsage += HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
393 strUsage += HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT));
394 strUsage += HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL));
395 strUsage += HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
396 #ifdef USE_UPNP
397 #if USE_UPNP
398 strUsage += HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
399 #else
400 strUsage += HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
401 #endif
402 #endif
403 strUsage += HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
404 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.") +
405 " " + _("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"));
406 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));
408 #ifdef ENABLE_WALLET
409 strUsage += GetWalletHelpString(showDebug);
410 #endif
412 #if ENABLE_ZMQ
413 strUsage += HelpMessageGroup(_("ZeroMQ notification options:"));
414 strUsage += HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
415 strUsage += HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
416 strUsage += HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
417 strUsage += HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
418 #endif
420 strUsage += HelpMessageGroup(_("Debugging/Testing options:"));
421 strUsage += HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
422 if (showDebug)
424 strUsage += HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS));
425 strUsage += HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL));
426 strUsage += HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
427 strUsage += HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
428 strUsage += HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED));
429 strUsage += HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE));
430 strUsage += HelpMessageOpt("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used");
431 strUsage += HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE));
432 strUsage += HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
433 strUsage += HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
434 strUsage += HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT));
435 strUsage += HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT));
437 strUsage += HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT));
438 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));
439 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));
440 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));
441 strUsage += HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
443 strUsage += HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
444 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
445 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.")));
446 strUsage += HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
447 strUsage += HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS));
448 strUsage += HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS));
449 if (showDebug)
451 strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
452 strUsage += HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
453 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));
454 strUsage += HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE));
456 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)"),
457 CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MAXFEE)));
458 strUsage += HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
459 if (showDebug)
461 strUsage += HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY));
463 strUsage += HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
465 AppendParamsHelpMessages(strUsage, showDebug);
467 strUsage += HelpMessageGroup(_("Node relay options:"));
468 if (showDebug) {
469 strUsage += HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", !testnetChainParams->RequireStandard()));
470 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)));
471 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)));
473 strUsage += HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP));
474 strUsage += HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER));
475 strUsage += HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY));
476 strUsage += HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT));
477 strUsage += HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
478 CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)));
479 strUsage += HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY));
480 strUsage += HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY));
482 strUsage += HelpMessageGroup(_("Block creation options:"));
483 strUsage += HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT));
484 strUsage += HelpMessageOpt("-blockmaxsize=<n>", _("Set maximum BIP141 block weight to this * 4. Deprecated, use blockmaxweight"));
485 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)));
486 if (showDebug)
487 strUsage += HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
489 strUsage += HelpMessageGroup(_("RPC server options:"));
490 strUsage += HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
491 strUsage += HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE));
492 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)"));
493 strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
494 strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
495 strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
496 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"));
497 strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
498 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"));
499 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));
500 strUsage += HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS));
501 if (showDebug) {
502 strUsage += HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE));
503 strUsage += HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT));
506 return strUsage;
509 std::string LicenseInfo()
511 const std::string URL_SOURCE_CODE = "<https://github.com/bitcoin/bitcoin>";
512 const std::string URL_WEBSITE = "<https://bitcoincore.org>";
514 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR) + " ") + "\n" +
515 "\n" +
516 strprintf(_("Please contribute if you find %s useful. "
517 "Visit %s for further information about the software."),
518 PACKAGE_NAME, URL_WEBSITE) +
519 "\n" +
520 strprintf(_("The source code is available from %s."),
521 URL_SOURCE_CODE) +
522 "\n" +
523 "\n" +
524 _("This is experimental software.") + "\n" +
525 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
526 "\n" +
527 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>") +
528 "\n";
531 static void BlockNotifyCallback(bool initialSync, const CBlockIndex *pBlockIndex)
533 if (initialSync || !pBlockIndex)
534 return;
536 std::string strCmd = gArgs.GetArg("-blocknotify", "");
537 if (!strCmd.empty()) {
538 boost::replace_all(strCmd, "%s", pBlockIndex->GetBlockHash().GetHex());
539 boost::thread t(runCommand, strCmd); // thread runs free
543 static bool fHaveGenesis = false;
544 static CWaitableCriticalSection cs_GenesisWait;
545 static CConditionVariable condvar_GenesisWait;
547 static void BlockNotifyGenesisWait(bool, const CBlockIndex *pBlockIndex)
549 if (pBlockIndex != nullptr) {
551 WaitableLock lock_GenesisWait(cs_GenesisWait);
552 fHaveGenesis = true;
554 condvar_GenesisWait.notify_all();
558 struct CImportingNow
560 CImportingNow() {
561 assert(fImporting == false);
562 fImporting = true;
565 ~CImportingNow() {
566 assert(fImporting == true);
567 fImporting = false;
572 // If we're using -prune with -reindex, then delete block files that will be ignored by the
573 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
574 // is missing, do the same here to delete any later block files after a gap. Also delete all
575 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
576 // is in sync with what's actually on disk by the time we start downloading, so that pruning
577 // works correctly.
578 void CleanupBlockRevFiles()
580 std::map<std::string, fs::path> mapBlockFiles;
582 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
583 // Remove the rev files immediately and insert the blk file paths into an
584 // ordered map keyed by block file index.
585 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
586 fs::path blocksdir = GetDataDir() / "blocks";
587 for (fs::directory_iterator it(blocksdir); it != fs::directory_iterator(); it++) {
588 if (fs::is_regular_file(*it) &&
589 it->path().filename().string().length() == 12 &&
590 it->path().filename().string().substr(8,4) == ".dat")
592 if (it->path().filename().string().substr(0,3) == "blk")
593 mapBlockFiles[it->path().filename().string().substr(3,5)] = it->path();
594 else if (it->path().filename().string().substr(0,3) == "rev")
595 remove(it->path());
599 // Remove all block files that aren't part of a contiguous set starting at
600 // zero by walking the ordered map (keys are block file indices) by
601 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
602 // start removing block files.
603 int nContigCounter = 0;
604 for (const std::pair<std::string, fs::path>& item : mapBlockFiles) {
605 if (atoi(item.first) == nContigCounter) {
606 nContigCounter++;
607 continue;
609 remove(item.second);
613 void ThreadImport(std::vector<fs::path> vImportFiles)
615 const CChainParams& chainparams = Params();
616 RenameThread("bitcoin-loadblk");
619 CImportingNow imp;
621 // -reindex
622 if (fReindex) {
623 int nFile = 0;
624 while (true) {
625 CDiskBlockPos pos(nFile, 0);
626 if (!fs::exists(GetBlockPosFilename(pos, "blk")))
627 break; // No block files left to reindex
628 FILE *file = OpenBlockFile(pos, true);
629 if (!file)
630 break; // This error is logged in OpenBlockFile
631 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile);
632 LoadExternalBlockFile(chainparams, file, &pos);
633 nFile++;
635 pblocktree->WriteReindexing(false);
636 fReindex = false;
637 LogPrintf("Reindexing finished\n");
638 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
639 LoadGenesisBlock(chainparams);
642 // hardcoded $DATADIR/bootstrap.dat
643 fs::path pathBootstrap = GetDataDir() / "bootstrap.dat";
644 if (fs::exists(pathBootstrap)) {
645 FILE *file = fsbridge::fopen(pathBootstrap, "rb");
646 if (file) {
647 fs::path pathBootstrapOld = GetDataDir() / "bootstrap.dat.old";
648 LogPrintf("Importing bootstrap.dat...\n");
649 LoadExternalBlockFile(chainparams, file);
650 RenameOver(pathBootstrap, pathBootstrapOld);
651 } else {
652 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap.string());
656 // -loadblock=
657 for (const fs::path& path : vImportFiles) {
658 FILE *file = fsbridge::fopen(path, "rb");
659 if (file) {
660 LogPrintf("Importing blocks file %s...\n", path.string());
661 LoadExternalBlockFile(chainparams, file);
662 } else {
663 LogPrintf("Warning: Could not open blocks file %s\n", path.string());
667 // scan for better chains in the block chain database, that are not yet connected in the active best chain
668 CValidationState state;
669 if (!ActivateBestChain(state, chainparams)) {
670 LogPrintf("Failed to connect best block");
671 StartShutdown();
674 if (gArgs.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
675 LogPrintf("Stopping after block import\n");
676 StartShutdown();
678 } // End scope of CImportingNow
679 if (gArgs.GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
680 LoadMempool();
681 fDumpMempoolLater = !fRequestShutdown;
685 /** Sanity checks
686 * Ensure that Bitcoin is running in a usable environment with all
687 * necessary library support.
689 bool InitSanityCheck(void)
691 if(!ECC_InitSanityCheck()) {
692 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
693 return false;
696 if (!glibc_sanity_test() || !glibcxx_sanity_test())
697 return false;
699 if (!Random_SanityCheck()) {
700 InitError("OS cryptographic RNG sanity check failure. Aborting.");
701 return false;
704 return true;
707 bool AppInitServers(boost::thread_group& threadGroup)
709 RPCServer::OnStarted(&OnRPCStarted);
710 RPCServer::OnStopped(&OnRPCStopped);
711 if (!InitHTTPServer())
712 return false;
713 if (!StartRPC())
714 return false;
715 if (!StartHTTPRPC())
716 return false;
717 if (gArgs.GetBoolArg("-rest", DEFAULT_REST_ENABLE) && !StartREST())
718 return false;
719 if (!StartHTTPServer())
720 return false;
721 return true;
724 // Parameter interaction based on rules
725 void InitParameterInteraction()
727 // when specifying an explicit binding address, you want to listen on it
728 // even when -connect or -proxy is specified
729 if (gArgs.IsArgSet("-bind")) {
730 if (gArgs.SoftSetBoolArg("-listen", true))
731 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
733 if (gArgs.IsArgSet("-whitebind")) {
734 if (gArgs.SoftSetBoolArg("-listen", true))
735 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
738 if (gArgs.IsArgSet("-connect")) {
739 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
740 if (gArgs.SoftSetBoolArg("-dnsseed", false))
741 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
742 if (gArgs.SoftSetBoolArg("-listen", false))
743 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
746 if (gArgs.IsArgSet("-proxy")) {
747 // to protect privacy, do not listen by default if a default proxy server is specified
748 if (gArgs.SoftSetBoolArg("-listen", false))
749 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
750 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
751 // to listen locally, so don't rely on this happening through -listen below.
752 if (gArgs.SoftSetBoolArg("-upnp", false))
753 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
754 // to protect privacy, do not discover addresses by default
755 if (gArgs.SoftSetBoolArg("-discover", false))
756 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
759 if (!gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
760 // do not map ports or try to retrieve public IP when not listening (pointless)
761 if (gArgs.SoftSetBoolArg("-upnp", false))
762 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
763 if (gArgs.SoftSetBoolArg("-discover", false))
764 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
765 if (gArgs.SoftSetBoolArg("-listenonion", false))
766 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
769 if (gArgs.IsArgSet("-externalip")) {
770 // if an explicit public IP is specified, do not try to find others
771 if (gArgs.SoftSetBoolArg("-discover", false))
772 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
775 // disable whitelistrelay in blocksonly mode
776 if (gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
777 if (gArgs.SoftSetBoolArg("-whitelistrelay", false))
778 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
781 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
782 if (gArgs.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
783 if (gArgs.SoftSetBoolArg("-whitelistrelay", true))
784 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
787 if (gArgs.IsArgSet("-blockmaxsize")) {
788 unsigned int max_size = gArgs.GetArg("-blockmaxsize", 0);
789 if (gArgs.SoftSetArg("blockmaxweight", strprintf("%d", max_size * WITNESS_SCALE_FACTOR))) {
790 LogPrintf("%s: parameter interaction: -blockmaxsize=%d -> setting -blockmaxweight=%d (-blockmaxsize is deprecated!)\n", __func__, max_size, max_size * WITNESS_SCALE_FACTOR);
791 } else {
792 LogPrintf("%s: Ignoring blockmaxsize setting which is overridden by blockmaxweight", __func__);
797 static std::string ResolveErrMsg(const char * const optname, const std::string& strBind)
799 return strprintf(_("Cannot resolve -%s address: '%s'"), optname, strBind);
802 void InitLogging()
804 fPrintToConsole = gArgs.GetBoolArg("-printtoconsole", false);
805 fLogTimestamps = gArgs.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
806 fLogTimeMicros = gArgs.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
807 fLogIPs = gArgs.GetBoolArg("-logips", DEFAULT_LOGIPS);
809 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
810 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
813 namespace { // Variables internal to initialization process only
815 int nMaxConnections;
816 int nUserMaxConnections;
817 int nFD;
818 ServiceFlags nLocalServices = NODE_NETWORK;
820 } // namespace
822 [[noreturn]] static void new_handler_terminate()
824 // Rather than throwing std::bad-alloc if allocation fails, terminate
825 // immediately to (try to) avoid chain corruption.
826 // Since LogPrintf may itself allocate memory, set the handler directly
827 // to terminate first.
828 std::set_new_handler(std::terminate);
829 LogPrintf("Error: Out of memory. Terminating.\n");
831 // The log was successful, terminate now.
832 std::terminate();
835 bool AppInitBasicSetup()
837 // ********************************************************* Step 1: setup
838 #ifdef _MSC_VER
839 // Turn off Microsoft heap dump noise
840 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
841 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
842 // Disable confusing "helpful" text message on abort, Ctrl-C
843 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
844 #endif
845 #ifdef WIN32
846 // Enable Data Execution Prevention (DEP)
847 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
848 // A failure is non-critical and needs no further attention!
849 #ifndef PROCESS_DEP_ENABLE
850 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
851 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
852 #define PROCESS_DEP_ENABLE 0x00000001
853 #endif
854 typedef BOOL (WINAPI *PSETPROCDEPPOL)(DWORD);
855 PSETPROCDEPPOL setProcDEPPol = (PSETPROCDEPPOL)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
856 if (setProcDEPPol != nullptr) setProcDEPPol(PROCESS_DEP_ENABLE);
857 #endif
859 if (!SetupNetworking())
860 return InitError("Initializing networking failed");
862 #ifndef WIN32
863 if (!gArgs.GetBoolArg("-sysperms", false)) {
864 umask(077);
867 // Clean shutdown on SIGTERM
868 registerSignalHandler(SIGTERM, HandleSIGTERM);
869 registerSignalHandler(SIGINT, HandleSIGTERM);
871 // Reopen debug.log on SIGHUP
872 registerSignalHandler(SIGHUP, HandleSIGHUP);
874 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
875 signal(SIGPIPE, SIG_IGN);
876 #endif
878 std::set_new_handler(new_handler_terminate);
880 return true;
883 bool AppInitParameterInteraction()
885 const CChainParams& chainparams = Params();
886 // ********************************************************* Step 2: parameter interactions
888 // also see: InitParameterInteraction()
890 // if using block pruning, then disallow txindex
891 if (gArgs.GetArg("-prune", 0)) {
892 if (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX))
893 return InitError(_("Prune mode is incompatible with -txindex."));
896 // -bind and -whitebind can't be set when not listening
897 size_t nUserBind = gArgs.GetArgs("-bind").size() + gArgs.GetArgs("-whitebind").size();
898 if (nUserBind != 0 && !gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
899 return InitError("Cannot set -bind or -whitebind together with -listen=0");
902 // Make sure enough file descriptors are available
903 int nBind = std::max(nUserBind, size_t(1));
904 nUserMaxConnections = gArgs.GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
905 nMaxConnections = std::max(nUserMaxConnections, 0);
907 // Trim requested connection counts, to fit into system limitations
908 nMaxConnections = std::max(std::min(nMaxConnections, (int)(FD_SETSIZE - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS)), 0);
909 nFD = RaiseFileDescriptorLimit(nMaxConnections + MIN_CORE_FILEDESCRIPTORS + MAX_ADDNODE_CONNECTIONS);
910 if (nFD < MIN_CORE_FILEDESCRIPTORS)
911 return InitError(_("Not enough file descriptors available."));
912 nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS, nMaxConnections);
914 if (nMaxConnections < nUserMaxConnections)
915 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
917 // ********************************************************* Step 3: parameter-to-internal-flags
918 if (gArgs.IsArgSet("-debug")) {
919 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
920 const std::vector<std::string> categories = gArgs.GetArgs("-debug");
922 if (std::none_of(categories.begin(), categories.end(),
923 [](std::string cat){return cat == "0" || cat == "none";})) {
924 for (const auto& cat : categories) {
925 uint32_t flag = 0;
926 if (!GetLogCategory(&flag, &cat)) {
927 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
928 continue;
930 logCategories |= flag;
935 // Now remove the logging categories which were explicitly excluded
936 for (const std::string& cat : gArgs.GetArgs("-debugexclude")) {
937 uint32_t flag = 0;
938 if (!GetLogCategory(&flag, &cat)) {
939 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
940 continue;
942 logCategories &= ~flag;
945 // Check for -debugnet
946 if (gArgs.GetBoolArg("-debugnet", false))
947 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
948 // Check for -socks - as this is a privacy risk to continue, exit here
949 if (gArgs.IsArgSet("-socks"))
950 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
951 // Check for -tor - as this is a privacy risk to continue, exit here
952 if (gArgs.GetBoolArg("-tor", false))
953 return InitError(_("Unsupported argument -tor found, use -onion."));
955 if (gArgs.GetBoolArg("-benchmark", false))
956 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
958 if (gArgs.GetBoolArg("-whitelistalwaysrelay", false))
959 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
961 if (gArgs.IsArgSet("-blockminsize"))
962 InitWarning("Unsupported argument -blockminsize ignored.");
964 // Checkmempool and checkblockindex default to true in regtest mode
965 int ratio = std::min<int>(std::max<int>(gArgs.GetArg("-checkmempool", chainparams.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
966 if (ratio != 0) {
967 mempool.setSanityCheck(1.0 / ratio);
969 fCheckBlockIndex = gArgs.GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
970 fCheckpointsEnabled = gArgs.GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED);
972 hashAssumeValid = uint256S(gArgs.GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
973 if (!hashAssumeValid.IsNull())
974 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid.GetHex());
975 else
976 LogPrintf("Validating signatures for all blocks.\n");
978 if (gArgs.IsArgSet("-minimumchainwork")) {
979 const std::string minChainWorkStr = gArgs.GetArg("-minimumchainwork", "");
980 if (!IsHexNumber(minChainWorkStr)) {
981 return InitError(strprintf("Invalid non-hex (%s) minimum chain work value specified", minChainWorkStr));
983 nMinimumChainWork = UintToArith256(uint256S(minChainWorkStr));
984 } else {
985 nMinimumChainWork = UintToArith256(chainparams.GetConsensus().nMinimumChainWork);
987 LogPrintf("Setting nMinimumChainWork=%s\n", nMinimumChainWork.GetHex());
988 if (nMinimumChainWork < UintToArith256(chainparams.GetConsensus().nMinimumChainWork)) {
989 LogPrintf("Warning: nMinimumChainWork set below default value of %s\n", chainparams.GetConsensus().nMinimumChainWork.GetHex());
992 // mempool limits
993 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
994 int64_t nMempoolSizeMin = gArgs.GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT) * 1000 * 40;
995 if (nMempoolSizeMax < 0 || nMempoolSizeMax < nMempoolSizeMin)
996 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin / 1000000.0)));
997 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
998 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
999 if (gArgs.IsArgSet("-incrementalrelayfee"))
1001 CAmount n = 0;
1002 if (!ParseMoney(gArgs.GetArg("-incrementalrelayfee", ""), n))
1003 return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")));
1004 incrementalRelayFee = CFeeRate(n);
1007 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
1008 nScriptCheckThreads = gArgs.GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
1009 if (nScriptCheckThreads <= 0)
1010 nScriptCheckThreads += GetNumCores();
1011 if (nScriptCheckThreads <= 1)
1012 nScriptCheckThreads = 0;
1013 else if (nScriptCheckThreads > MAX_SCRIPTCHECK_THREADS)
1014 nScriptCheckThreads = MAX_SCRIPTCHECK_THREADS;
1016 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
1017 int64_t nPruneArg = gArgs.GetArg("-prune", 0);
1018 if (nPruneArg < 0) {
1019 return InitError(_("Prune cannot be configured with a negative value."));
1021 nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
1022 if (nPruneArg == 1) { // manual pruning: -prune=1
1023 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1024 nPruneTarget = std::numeric_limits<uint64_t>::max();
1025 fPruneMode = true;
1026 } else if (nPruneTarget) {
1027 if (nPruneTarget < MIN_DISK_SPACE_FOR_BLOCK_FILES) {
1028 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
1030 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget / 1024 / 1024);
1031 fPruneMode = true;
1034 nConnectTimeout = gArgs.GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1035 if (nConnectTimeout <= 0)
1036 nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1038 if (gArgs.IsArgSet("-minrelaytxfee")) {
1039 CAmount n = 0;
1040 if (!ParseMoney(gArgs.GetArg("-minrelaytxfee", ""), n)) {
1041 return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")));
1043 // High fee check is done afterward in WalletParameterInteraction()
1044 ::minRelayTxFee = CFeeRate(n);
1045 } else if (incrementalRelayFee > ::minRelayTxFee) {
1046 // Allow only setting incrementalRelayFee to control both
1047 ::minRelayTxFee = incrementalRelayFee;
1048 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee.ToString());
1051 // Sanity check argument for min fee for including tx in block
1052 // TODO: Harmonize which arguments need sanity checking and where that happens
1053 if (gArgs.IsArgSet("-blockmintxfee"))
1055 CAmount n = 0;
1056 if (!ParseMoney(gArgs.GetArg("-blockmintxfee", ""), n))
1057 return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")));
1060 // Feerate used to define dust. Shouldn't be changed lightly as old
1061 // implementations may inadvertently create non-standard transactions
1062 if (gArgs.IsArgSet("-dustrelayfee"))
1064 CAmount n = 0;
1065 if (!ParseMoney(gArgs.GetArg("-dustrelayfee", ""), n) || 0 == n)
1066 return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")));
1067 dustRelayFee = CFeeRate(n);
1070 fRequireStandard = !gArgs.GetBoolArg("-acceptnonstdtxn", !chainparams.RequireStandard());
1071 if (chainparams.RequireStandard() && !fRequireStandard)
1072 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams.NetworkIDString()));
1073 nBytesPerSigOp = gArgs.GetArg("-bytespersigop", nBytesPerSigOp);
1075 #ifdef ENABLE_WALLET
1076 if (!WalletParameterInteraction())
1077 return false;
1078 #endif
1080 fIsBareMultisigStd = gArgs.GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG);
1081 fAcceptDatacarrier = gArgs.GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER);
1082 nMaxDatacarrierBytes = gArgs.GetArg("-datacarriersize", nMaxDatacarrierBytes);
1084 // Option to startup with mocktime set (used for regression testing):
1085 SetMockTime(gArgs.GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1087 if (gArgs.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1088 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
1090 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
1091 return InitError("rpcserialversion must be non-negative.");
1093 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
1094 return InitError("unknown rpcserialversion requested.");
1096 nMaxTipAge = gArgs.GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
1098 fEnableReplacement = gArgs.GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT);
1099 if ((!fEnableReplacement) && gArgs.IsArgSet("-mempoolreplacement")) {
1100 // Minimal effort at forwards compatibility
1101 std::string strReplacementModeList = gArgs.GetArg("-mempoolreplacement", ""); // default is impossible
1102 std::vector<std::string> vstrReplacementModes;
1103 boost::split(vstrReplacementModes, strReplacementModeList, boost::is_any_of(","));
1104 fEnableReplacement = (std::find(vstrReplacementModes.begin(), vstrReplacementModes.end(), "fee") != vstrReplacementModes.end());
1107 if (gArgs.IsArgSet("-vbparams")) {
1108 // Allow overriding version bits parameters for testing
1109 if (!chainparams.MineBlocksOnDemand()) {
1110 return InitError("Version bits parameters may only be overridden on regtest.");
1112 for (const std::string& strDeployment : gArgs.GetArgs("-vbparams")) {
1113 std::vector<std::string> vDeploymentParams;
1114 boost::split(vDeploymentParams, strDeployment, boost::is_any_of(":"));
1115 if (vDeploymentParams.size() != 3) {
1116 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1118 int64_t nStartTime, nTimeout;
1119 if (!ParseInt64(vDeploymentParams[1], &nStartTime)) {
1120 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
1122 if (!ParseInt64(vDeploymentParams[2], &nTimeout)) {
1123 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
1125 bool found = false;
1126 for (int j=0; j<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j)
1128 if (vDeploymentParams[0].compare(VersionBitsDeploymentInfo[j].name) == 0) {
1129 UpdateVersionBitsParameters(Consensus::DeploymentPos(j), nStartTime, nTimeout);
1130 found = true;
1131 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams[0], nStartTime, nTimeout);
1132 break;
1135 if (!found) {
1136 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
1140 return true;
1143 static bool LockDataDirectory(bool probeOnly)
1145 std::string strDataDir = GetDataDir().string();
1147 // Make sure only a single Bitcoin process is using the data directory.
1148 fs::path pathLockFile = GetDataDir() / ".lock";
1149 FILE* file = fsbridge::fopen(pathLockFile, "a"); // empty lock file; created if it doesn't exist.
1150 if (file) fclose(file);
1152 try {
1153 static boost::interprocess::file_lock lock(pathLockFile.string().c_str());
1154 if (!lock.try_lock()) {
1155 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir, _(PACKAGE_NAME)));
1157 if (probeOnly) {
1158 lock.unlock();
1160 } catch(const boost::interprocess::interprocess_exception& e) {
1161 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir, _(PACKAGE_NAME), e.what()));
1163 return true;
1166 bool AppInitSanityChecks()
1168 // ********************************************************* Step 4: sanity checks
1170 // Initialize elliptic curve code
1171 std::string sha256_algo = SHA256AutoDetect();
1172 LogPrintf("Using the '%s' SHA256 implementation\n", sha256_algo);
1173 RandomInit();
1174 ECC_Start();
1175 globalVerifyHandle.reset(new ECCVerifyHandle());
1177 // Sanity check
1178 if (!InitSanityCheck())
1179 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME)));
1181 // Probe the data directory lock to give an early error message, if possible
1182 // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1183 // and a fork will cause weird behavior to it.
1184 return LockDataDirectory(true);
1187 bool AppInitLockDataDirectory()
1189 // After daemonization get the data directory lock again and hold on to it until exit
1190 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1191 // will at most make us exit without printing a message to console.
1192 if (!LockDataDirectory(false)) {
1193 // Detailed error printed inside LockDataDirectory
1194 return false;
1196 return true;
1199 bool AppInitMain(boost::thread_group& threadGroup, CScheduler& scheduler)
1201 const CChainParams& chainparams = Params();
1202 // ********************************************************* Step 4a: application initialization
1203 #ifndef WIN32
1204 CreatePidFile(GetPidFile(), getpid());
1205 #endif
1206 if (gArgs.GetBoolArg("-shrinkdebugfile", logCategories == BCLog::NONE)) {
1207 // Do this first since it both loads a bunch of debug.log into memory,
1208 // and because this needs to happen before any other debug.log printing
1209 ShrinkDebugFile();
1212 if (fPrintToDebugLog)
1213 OpenDebugLog();
1215 if (!fLogTimestamps)
1216 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1217 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1218 LogPrintf("Using data directory %s\n", GetDataDir().string());
1219 LogPrintf("Using config file %s\n", GetConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME)).string());
1220 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1222 InitSignatureCache();
1223 InitScriptExecutionCache();
1225 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads);
1226 if (nScriptCheckThreads) {
1227 for (int i=0; i<nScriptCheckThreads-1; i++)
1228 threadGroup.create_thread(&ThreadScriptCheck);
1231 // Start the lightweight task scheduler thread
1232 CScheduler::Function serviceLoop = boost::bind(&CScheduler::serviceQueue, &scheduler);
1233 threadGroup.create_thread(boost::bind(&TraceThread<CScheduler::Function>, "scheduler", serviceLoop));
1235 GetMainSignals().RegisterBackgroundSignalScheduler(scheduler);
1236 GetMainSignals().RegisterWithMempoolSignals(mempool);
1238 /* Register RPC commands regardless of -server setting so they will be
1239 * available in the GUI RPC console even if external calls are disabled.
1241 RegisterAllCoreRPCCommands(tableRPC);
1242 #ifdef ENABLE_WALLET
1243 RegisterWalletRPC(tableRPC);
1244 #endif
1246 /* Start the RPC server already. It will be started in "warmup" mode
1247 * and not really process calls already (but it will signify connections
1248 * that the server is there and will be ready later). Warmup mode will
1249 * be disabled when initialisation is finished.
1251 if (gArgs.GetBoolArg("-server", false))
1253 uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1254 if (!AppInitServers(threadGroup))
1255 return InitError(_("Unable to start HTTP server. See debug log for details."));
1258 int64_t nStart;
1260 // ********************************************************* Step 5: verify wallet database integrity
1261 #ifdef ENABLE_WALLET
1262 if (!VerifyWallets())
1263 return false;
1264 #endif
1265 // ********************************************************* Step 6: network initialization
1266 // Note that we absolutely cannot open any actual connections
1267 // until the very end ("start node") as the UTXO/block state
1268 // is not yet setup and may end up being set up twice if we
1269 // need to reindex later.
1271 assert(!g_connman);
1272 g_connman = std::unique_ptr<CConnman>(new CConnman(GetRand(std::numeric_limits<uint64_t>::max()), GetRand(std::numeric_limits<uint64_t>::max())));
1273 CConnman& connman = *g_connman;
1275 peerLogic.reset(new PeerLogicValidation(&connman, scheduler));
1276 RegisterValidationInterface(peerLogic.get());
1278 // sanitize comments per BIP-0014, format user agent and check total size
1279 std::vector<std::string> uacomments;
1280 for (const std::string& cmt : gArgs.GetArgs("-uacomment")) {
1281 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1282 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1283 uacomments.push_back(cmt);
1285 strSubVersion = FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, uacomments);
1286 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1287 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1288 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1291 if (gArgs.IsArgSet("-onlynet")) {
1292 std::set<enum Network> nets;
1293 for (const std::string& snet : gArgs.GetArgs("-onlynet")) {
1294 enum Network net = ParseNetwork(snet);
1295 if (net == NET_UNROUTABLE)
1296 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1297 nets.insert(net);
1299 for (int n = 0; n < NET_MAX; n++) {
1300 enum Network net = (enum Network)n;
1301 if (!nets.count(net))
1302 SetLimited(net);
1306 // Check for host lookup allowed before parsing any network related parameters
1307 fNameLookup = gArgs.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1309 bool proxyRandomize = gArgs.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1310 // -proxy sets a proxy for all outgoing network traffic
1311 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1312 std::string proxyArg = gArgs.GetArg("-proxy", "");
1313 SetLimited(NET_TOR);
1314 if (proxyArg != "" && proxyArg != "0") {
1315 CService proxyAddr;
1316 if (!Lookup(proxyArg.c_str(), proxyAddr, 9050, fNameLookup)) {
1317 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1320 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
1321 if (!addrProxy.IsValid())
1322 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1324 SetProxy(NET_IPV4, addrProxy);
1325 SetProxy(NET_IPV6, addrProxy);
1326 SetProxy(NET_TOR, addrProxy);
1327 SetNameProxy(addrProxy);
1328 SetLimited(NET_TOR, false); // by default, -proxy sets onion as reachable, unless -noonion later
1331 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1332 // -noonion (or -onion=0) disables connecting to .onion entirely
1333 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1334 std::string onionArg = gArgs.GetArg("-onion", "");
1335 if (onionArg != "") {
1336 if (onionArg == "0") { // Handle -noonion/-onion=0
1337 SetLimited(NET_TOR); // set onions as unreachable
1338 } else {
1339 CService onionProxy;
1340 if (!Lookup(onionArg.c_str(), onionProxy, 9050, fNameLookup)) {
1341 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1343 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
1344 if (!addrOnion.IsValid())
1345 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1346 SetProxy(NET_TOR, addrOnion);
1347 SetLimited(NET_TOR, false);
1351 // see Step 2: parameter interactions for more information about these
1352 fListen = gArgs.GetBoolArg("-listen", DEFAULT_LISTEN);
1353 fDiscover = gArgs.GetBoolArg("-discover", true);
1354 fRelayTxes = !gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY);
1356 for (const std::string& strAddr : gArgs.GetArgs("-externalip")) {
1357 CService addrLocal;
1358 if (Lookup(strAddr.c_str(), addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1359 AddLocal(addrLocal, LOCAL_MANUAL);
1360 else
1361 return InitError(ResolveErrMsg("externalip", strAddr));
1364 #if ENABLE_ZMQ
1365 pzmqNotificationInterface = CZMQNotificationInterface::Create();
1367 if (pzmqNotificationInterface) {
1368 RegisterValidationInterface(pzmqNotificationInterface);
1370 #endif
1371 uint64_t nMaxOutboundLimit = 0; //unlimited unless -maxuploadtarget is set
1372 uint64_t nMaxOutboundTimeframe = MAX_UPLOAD_TIMEFRAME;
1374 if (gArgs.IsArgSet("-maxuploadtarget")) {
1375 nMaxOutboundLimit = gArgs.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET)*1024*1024;
1378 // ********************************************************* Step 7: load block chain
1380 fReindex = gArgs.GetBoolArg("-reindex", false);
1381 bool fReindexChainState = gArgs.GetBoolArg("-reindex-chainstate", false);
1383 // cache size calculations
1384 int64_t nTotalCache = (gArgs.GetArg("-dbcache", nDefaultDbCache) << 20);
1385 nTotalCache = std::max(nTotalCache, nMinDbCache << 20); // total cache cannot be less than nMinDbCache
1386 nTotalCache = std::min(nTotalCache, nMaxDbCache << 20); // total cache cannot be greater than nMaxDbcache
1387 int64_t nBlockTreeDBCache = nTotalCache / 8;
1388 nBlockTreeDBCache = std::min(nBlockTreeDBCache, (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX) ? nMaxBlockDBAndTxIndexCache : nMaxBlockDBCache) << 20);
1389 nTotalCache -= nBlockTreeDBCache;
1390 int64_t nCoinDBCache = std::min(nTotalCache / 2, (nTotalCache / 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1391 nCoinDBCache = std::min(nCoinDBCache, nMaxCoinsDBCache << 20); // cap total coins db cache
1392 nTotalCache -= nCoinDBCache;
1393 nCoinCacheUsage = nTotalCache; // the rest goes to in-memory cache
1394 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
1395 LogPrintf("Cache configuration:\n");
1396 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache * (1.0 / 1024 / 1024));
1397 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache * (1.0 / 1024 / 1024));
1398 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));
1400 bool fLoaded = false;
1401 while (!fLoaded && !fRequestShutdown) {
1402 bool fReset = fReindex;
1403 std::string strLoadError;
1405 uiInterface.InitMessage(_("Loading block index..."));
1407 nStart = GetTimeMillis();
1408 do {
1409 try {
1410 UnloadBlockIndex();
1411 pcoinsTip.reset();
1412 pcoinsdbview.reset();
1413 pcoinscatcher.reset();
1414 pblocktree.reset(new CBlockTreeDB(nBlockTreeDBCache, false, fReset));
1416 if (fReset) {
1417 pblocktree->WriteReindexing(true);
1418 //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
1419 if (fPruneMode)
1420 CleanupBlockRevFiles();
1423 if (fRequestShutdown) break;
1425 // LoadBlockIndex will load fTxIndex from the db, or set it if
1426 // we're reindexing. It will also load fHavePruned if we've
1427 // ever removed a block file from disk.
1428 // Note that it also sets fReindex based on the disk flag!
1429 // From here on out fReindex and fReset mean something different!
1430 if (!LoadBlockIndex(chainparams)) {
1431 strLoadError = _("Error loading block database");
1432 break;
1435 // If the loaded chain has a wrong genesis, bail out immediately
1436 // (we're likely using a testnet datadir, or the other way around).
1437 if (!mapBlockIndex.empty() && mapBlockIndex.count(chainparams.GetConsensus().hashGenesisBlock) == 0)
1438 return InitError(_("Incorrect or no genesis block found. Wrong datadir for network?"));
1440 // Check for changed -txindex state
1441 if (fTxIndex != gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1442 strLoadError = _("You need to rebuild the database using -reindex to change -txindex");
1443 break;
1446 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1447 // in the past, but is now trying to run unpruned.
1448 if (fHavePruned && !fPruneMode) {
1449 strLoadError = _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1450 break;
1453 // At this point blocktree args are consistent with what's on disk.
1454 // If we're not mid-reindex (based on disk + args), add a genesis block on disk
1455 // (otherwise we use the one already on disk).
1456 // This is called again in ThreadImport after the reindex completes.
1457 if (!fReindex && !LoadGenesisBlock(chainparams)) {
1458 strLoadError = _("Error initializing block database");
1459 break;
1462 // At this point we're either in reindex or we've loaded a useful
1463 // block tree into mapBlockIndex!
1465 pcoinsdbview.reset(new CCoinsViewDB(nCoinDBCache, false, fReset || fReindexChainState));
1466 pcoinscatcher.reset(new CCoinsViewErrorCatcher(pcoinsdbview.get()));
1468 // If necessary, upgrade from older database format.
1469 // This is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1470 if (!pcoinsdbview->Upgrade()) {
1471 strLoadError = _("Error upgrading chainstate database");
1472 break;
1475 // ReplayBlocks is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1476 if (!ReplayBlocks(chainparams, pcoinsdbview.get())) {
1477 strLoadError = _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.");
1478 break;
1481 // The on-disk coinsdb is now in a good state, create the cache
1482 pcoinsTip.reset(new CCoinsViewCache(pcoinscatcher.get()));
1484 bool is_coinsview_empty = fReset || fReindexChainState || pcoinsTip->GetBestBlock().IsNull();
1485 if (!is_coinsview_empty) {
1486 // LoadChainTip sets chainActive based on pcoinsTip's best block
1487 if (!LoadChainTip(chainparams)) {
1488 strLoadError = _("Error initializing block database");
1489 break;
1491 assert(chainActive.Tip() != nullptr);
1494 if (!fReset) {
1495 // Note that RewindBlockIndex MUST run even if we're about to -reindex-chainstate.
1496 // It both disconnects blocks based on chainActive, and drops block data in
1497 // mapBlockIndex based on lack of available witness data.
1498 uiInterface.InitMessage(_("Rewinding blocks..."));
1499 if (!RewindBlockIndex(chainparams)) {
1500 strLoadError = _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1501 break;
1505 if (!is_coinsview_empty) {
1506 uiInterface.InitMessage(_("Verifying blocks..."));
1507 if (fHavePruned && gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS) > MIN_BLOCKS_TO_KEEP) {
1508 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1509 MIN_BLOCKS_TO_KEEP);
1513 LOCK(cs_main);
1514 CBlockIndex* tip = chainActive.Tip();
1515 RPCNotifyBlockChange(true, tip);
1516 if (tip && tip->nTime > GetAdjustedTime() + 2 * 60 * 60) {
1517 strLoadError = _("The block database contains a block which appears to be from the future. "
1518 "This may be due to your computer's date and time being set incorrectly. "
1519 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1520 break;
1524 if (!CVerifyDB().VerifyDB(chainparams, pcoinsdbview.get(), gArgs.GetArg("-checklevel", DEFAULT_CHECKLEVEL),
1525 gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS))) {
1526 strLoadError = _("Corrupted block database detected");
1527 break;
1530 } catch (const std::exception& e) {
1531 LogPrintf("%s\n", e.what());
1532 strLoadError = _("Error opening block database");
1533 break;
1536 fLoaded = true;
1537 } while(false);
1539 if (!fLoaded && !fRequestShutdown) {
1540 // first suggest a reindex
1541 if (!fReset) {
1542 bool fRet = uiInterface.ThreadSafeQuestion(
1543 strLoadError + ".\n\n" + _("Do you want to rebuild the block database now?"),
1544 strLoadError + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1545 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1546 if (fRet) {
1547 fReindex = true;
1548 fRequestShutdown = false;
1549 } else {
1550 LogPrintf("Aborted block database rebuild. Exiting.\n");
1551 return false;
1553 } else {
1554 return InitError(strLoadError);
1559 // As LoadBlockIndex can take several minutes, it's possible the user
1560 // requested to kill the GUI during the last operation. If so, exit.
1561 // As the program has not fully started yet, Shutdown() is possibly overkill.
1562 if (fRequestShutdown)
1564 LogPrintf("Shutdown requested. Exiting.\n");
1565 return false;
1567 if (fLoaded) {
1568 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart);
1571 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
1572 CAutoFile est_filein(fsbridge::fopen(est_path, "rb"), SER_DISK, CLIENT_VERSION);
1573 // Allowed to fail as this file IS missing on first startup.
1574 if (!est_filein.IsNull())
1575 ::feeEstimator.Read(est_filein);
1576 fFeeEstimatesInitialized = true;
1578 // ********************************************************* Step 8: load wallet
1579 #ifdef ENABLE_WALLET
1580 if (!OpenWallets())
1581 return false;
1582 #else
1583 LogPrintf("No wallet support compiled in!\n");
1584 #endif
1586 // ********************************************************* Step 9: data directory maintenance
1588 // if pruning, unset the service bit and perform the initial blockstore prune
1589 // after any wallet rescanning has taken place.
1590 if (fPruneMode) {
1591 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1592 nLocalServices = ServiceFlags(nLocalServices & ~NODE_NETWORK);
1593 if (!fReindex) {
1594 uiInterface.InitMessage(_("Pruning blockstore..."));
1595 PruneAndFlush();
1599 if (chainparams.GetConsensus().vDeployments[Consensus::DEPLOYMENT_SEGWIT].nTimeout != 0) {
1600 // Only advertise witness capabilities if they have a reasonable start time.
1601 // This allows us to have the code merged without a defined softfork, by setting its
1602 // end time to 0.
1603 // Note that setting NODE_WITNESS is never required: the only downside from not
1604 // doing so is that after activation, no upgraded nodes will fetch from you.
1605 nLocalServices = ServiceFlags(nLocalServices | NODE_WITNESS);
1608 // ********************************************************* Step 10: import blocks
1610 if (!CheckDiskSpace())
1611 return false;
1613 // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1614 // No locking, as this happens before any background thread is started.
1615 if (chainActive.Tip() == nullptr) {
1616 uiInterface.NotifyBlockTip.connect(BlockNotifyGenesisWait);
1617 } else {
1618 fHaveGenesis = true;
1621 if (gArgs.IsArgSet("-blocknotify"))
1622 uiInterface.NotifyBlockTip.connect(BlockNotifyCallback);
1624 std::vector<fs::path> vImportFiles;
1625 for (const std::string& strFile : gArgs.GetArgs("-loadblock")) {
1626 vImportFiles.push_back(strFile);
1629 threadGroup.create_thread(boost::bind(&ThreadImport, vImportFiles));
1631 // Wait for genesis block to be processed
1633 WaitableLock lock(cs_GenesisWait);
1634 while (!fHaveGenesis) {
1635 condvar_GenesisWait.wait(lock);
1637 uiInterface.NotifyBlockTip.disconnect(BlockNotifyGenesisWait);
1640 // ********************************************************* Step 11: start node
1642 int chain_active_height;
1644 //// debug print
1646 LOCK(cs_main);
1647 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex.size());
1648 chain_active_height = chainActive.Height();
1650 LogPrintf("nBestHeight = %d\n", chain_active_height);
1652 if (gArgs.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION))
1653 StartTorControl(threadGroup, scheduler);
1655 Discover(threadGroup);
1657 // Map ports with UPnP
1658 MapPort(gArgs.GetBoolArg("-upnp", DEFAULT_UPNP));
1660 CConnman::Options connOptions;
1661 connOptions.nLocalServices = nLocalServices;
1662 connOptions.nMaxConnections = nMaxConnections;
1663 connOptions.nMaxOutbound = std::min(MAX_OUTBOUND_CONNECTIONS, connOptions.nMaxConnections);
1664 connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1665 connOptions.nMaxFeeler = 1;
1666 connOptions.nBestHeight = chain_active_height;
1667 connOptions.uiInterface = &uiInterface;
1668 connOptions.m_msgproc = peerLogic.get();
1669 connOptions.nSendBufferMaxSize = 1000*gArgs.GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1670 connOptions.nReceiveFloodSize = 1000*gArgs.GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1671 connOptions.m_added_nodes = gArgs.GetArgs("-addnode");
1673 connOptions.nMaxOutboundTimeframe = nMaxOutboundTimeframe;
1674 connOptions.nMaxOutboundLimit = nMaxOutboundLimit;
1676 for (const std::string& strBind : gArgs.GetArgs("-bind")) {
1677 CService addrBind;
1678 if (!Lookup(strBind.c_str(), addrBind, GetListenPort(), false)) {
1679 return InitError(ResolveErrMsg("bind", strBind));
1681 connOptions.vBinds.push_back(addrBind);
1683 for (const std::string& strBind : gArgs.GetArgs("-whitebind")) {
1684 CService addrBind;
1685 if (!Lookup(strBind.c_str(), addrBind, 0, false)) {
1686 return InitError(ResolveErrMsg("whitebind", strBind));
1688 if (addrBind.GetPort() == 0) {
1689 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind));
1691 connOptions.vWhiteBinds.push_back(addrBind);
1694 for (const auto& net : gArgs.GetArgs("-whitelist")) {
1695 CSubNet subnet;
1696 LookupSubNet(net.c_str(), subnet);
1697 if (!subnet.IsValid())
1698 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net));
1699 connOptions.vWhitelistedRange.push_back(subnet);
1702 connOptions.vSeedNodes = gArgs.GetArgs("-seednode");
1704 // Initiate outbound connections unless connect=0
1705 connOptions.m_use_addrman_outgoing = !gArgs.IsArgSet("-connect");
1706 if (!connOptions.m_use_addrman_outgoing) {
1707 const auto connect = gArgs.GetArgs("-connect");
1708 if (connect.size() != 1 || connect[0] != "0") {
1709 connOptions.m_specified_outgoing = connect;
1712 if (!connman.Start(scheduler, connOptions)) {
1713 return false;
1716 // ********************************************************* Step 12: finished
1718 SetRPCWarmupFinished();
1719 uiInterface.InitMessage(_("Done loading"));
1721 #ifdef ENABLE_WALLET
1722 StartWallets(scheduler);
1723 #endif
1725 return !fRequestShutdown;