doc: Add getreceivedbyaddress release notes
[bitcoinplatinum.git] / src / init.cpp
blob7ac2cf2d32a6ce63a49b2c0919623dce4295f378
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 #ifdef ENABLE_WALLET
265 CloseWallets();
266 #endif
267 globalVerifyHandle.reset();
268 ECC_Stop();
269 LogPrintf("%s: done\n", __func__);
273 * Signal handlers are very limited in what they are allowed to do.
274 * The execution context the handler is invoked in is not guaranteed,
275 * so we restrict handler operations to just touching variables:
277 static void HandleSIGTERM(int)
279 fRequestShutdown = true;
282 static void HandleSIGHUP(int)
284 fReopenDebugLog = true;
287 #ifndef WIN32
288 static void registerSignalHandler(int signal, void(*handler)(int))
290 struct sigaction sa;
291 sa.sa_handler = handler;
292 sigemptyset(&sa.sa_mask);
293 sa.sa_flags = 0;
294 sigaction(signal, &sa, nullptr);
296 #endif
298 void OnRPCStarted()
300 uiInterface.NotifyBlockTip.connect(&RPCNotifyBlockChange);
303 void OnRPCStopped()
305 uiInterface.NotifyBlockTip.disconnect(&RPCNotifyBlockChange);
306 RPCNotifyBlockChange(false, nullptr);
307 cvBlockChange.notify_all();
308 LogPrint(BCLog::RPC, "RPC stopped.\n");
311 std::string HelpMessage(HelpMessageMode mode)
313 const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
314 const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
315 const auto defaultChainParams = CreateChainParams(CBaseChainParams::MAIN);
316 const auto testnetChainParams = CreateChainParams(CBaseChainParams::TESTNET);
317 const bool showDebug = gArgs.GetBoolArg("-help-debug", false);
319 // When adding new options to the categories, please keep and ensure alphabetical ordering.
320 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
321 std::string strUsage = HelpMessageGroup(_("Options:"));
322 strUsage += HelpMessageOpt("-?", _("Print this help message and exit"));
323 strUsage += HelpMessageOpt("-version", _("Print version and exit"));
324 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)"));
325 strUsage += HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
326 if (showDebug)
327 strUsage += HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY));
328 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()));
329 strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
330 if (mode == HMM_BITCOIND)
332 #if HAVE_DECL_DAEMON
333 strUsage += HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
334 #endif
336 strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
337 if (showDebug) {
338 strUsage += HelpMessageOpt("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize));
340 strUsage += HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache));
341 if (showDebug)
342 strUsage += HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER));
343 strUsage += HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
344 strUsage += HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS));
345 strUsage += HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE));
346 strUsage += HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY));
347 if (showDebug) {
348 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()));
350 strUsage += HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL));
351 strUsage += HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN));
352 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)"),
353 -GetNumCores(), MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS));
354 #ifndef WIN32
355 strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
356 #endif
357 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. "
358 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
359 "(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));
360 strUsage += HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
361 strUsage += HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
362 #ifndef WIN32
363 strUsage += HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
364 #endif
365 strUsage += HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX));
367 strUsage += HelpMessageGroup(_("Connection options:"));
368 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)"));
369 strUsage += HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD));
370 strUsage += HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME));
371 strUsage += HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
372 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)"));
373 strUsage += HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
374 strUsage += HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP));
375 strUsage += HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
376 strUsage += HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
377 strUsage += HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED));
378 strUsage += HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
379 strUsage += HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION));
380 strUsage += HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS));
381 strUsage += HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER));
382 strUsage += HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER));
383 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));
384 strUsage += HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
385 strUsage += HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
386 strUsage += HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG));
387 strUsage += HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS));
388 strUsage += HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort()));
389 strUsage += HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
390 strUsage += HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE));
391 strUsage += HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
392 strUsage += HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT));
393 strUsage += HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL));
394 strUsage += HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
395 #ifdef USE_UPNP
396 #if USE_UPNP
397 strUsage += HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
398 #else
399 strUsage += HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
400 #endif
401 #endif
402 strUsage += HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
403 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.") +
404 " " + _("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"));
405 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));
407 #ifdef ENABLE_WALLET
408 strUsage += GetWalletHelpString(showDebug);
409 #endif
411 #if ENABLE_ZMQ
412 strUsage += HelpMessageGroup(_("ZeroMQ notification options:"));
413 strUsage += HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
414 strUsage += HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
415 strUsage += HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
416 strUsage += HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
417 #endif
419 strUsage += HelpMessageGroup(_("Debugging/Testing options:"));
420 strUsage += HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
421 if (showDebug)
423 strUsage += HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS));
424 strUsage += HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL));
425 strUsage += HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
426 strUsage += HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
427 strUsage += HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED));
428 strUsage += HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE));
429 strUsage += HelpMessageOpt("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used");
430 strUsage += HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE));
431 strUsage += HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
432 strUsage += HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
433 strUsage += HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT));
434 strUsage += HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT));
436 strUsage += HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT));
437 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));
438 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));
439 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));
440 strUsage += HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
442 strUsage += HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
443 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
444 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.")));
445 strUsage += HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
446 strUsage += HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS));
447 strUsage += HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS));
448 if (showDebug)
450 strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
451 strUsage += HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
452 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));
453 strUsage += HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE));
455 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)"),
456 CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MAXFEE)));
457 strUsage += HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
458 if (showDebug)
460 strUsage += HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY));
462 strUsage += HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
464 AppendParamsHelpMessages(strUsage, showDebug);
466 strUsage += HelpMessageGroup(_("Node relay options:"));
467 if (showDebug) {
468 strUsage += HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", !testnetChainParams->RequireStandard()));
469 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)));
470 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)));
472 strUsage += HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP));
473 strUsage += HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER));
474 strUsage += HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY));
475 strUsage += HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT));
476 strUsage += HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
477 CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)));
478 strUsage += HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY));
479 strUsage += HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY));
481 strUsage += HelpMessageGroup(_("Block creation options:"));
482 strUsage += HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT));
483 strUsage += HelpMessageOpt("-blockmaxsize=<n>", _("Set maximum BIP141 block weight to this * 4. Deprecated, use blockmaxweight"));
484 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)));
485 if (showDebug)
486 strUsage += HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
488 strUsage += HelpMessageGroup(_("RPC server options:"));
489 strUsage += HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
490 strUsage += HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE));
491 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)"));
492 strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
493 strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
494 strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
495 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"));
496 strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
497 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"));
498 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));
499 strUsage += HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS));
500 if (showDebug) {
501 strUsage += HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE));
502 strUsage += HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT));
505 return strUsage;
508 std::string LicenseInfo()
510 const std::string URL_SOURCE_CODE = "<https://github.com/bitcoin/bitcoin>";
511 const std::string URL_WEBSITE = "<https://bitcoincore.org>";
513 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR) + " ") + "\n" +
514 "\n" +
515 strprintf(_("Please contribute if you find %s useful. "
516 "Visit %s for further information about the software."),
517 PACKAGE_NAME, URL_WEBSITE) +
518 "\n" +
519 strprintf(_("The source code is available from %s."),
520 URL_SOURCE_CODE) +
521 "\n" +
522 "\n" +
523 _("This is experimental software.") + "\n" +
524 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
525 "\n" +
526 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>") +
527 "\n";
530 static void BlockNotifyCallback(bool initialSync, const CBlockIndex *pBlockIndex)
532 if (initialSync || !pBlockIndex)
533 return;
535 std::string strCmd = gArgs.GetArg("-blocknotify", "");
536 if (!strCmd.empty()) {
537 boost::replace_all(strCmd, "%s", pBlockIndex->GetBlockHash().GetHex());
538 boost::thread t(runCommand, strCmd); // thread runs free
542 static bool fHaveGenesis = false;
543 static CWaitableCriticalSection cs_GenesisWait;
544 static CConditionVariable condvar_GenesisWait;
546 static void BlockNotifyGenesisWait(bool, const CBlockIndex *pBlockIndex)
548 if (pBlockIndex != nullptr) {
550 WaitableLock lock_GenesisWait(cs_GenesisWait);
551 fHaveGenesis = true;
553 condvar_GenesisWait.notify_all();
557 struct CImportingNow
559 CImportingNow() {
560 assert(fImporting == false);
561 fImporting = true;
564 ~CImportingNow() {
565 assert(fImporting == true);
566 fImporting = false;
571 // If we're using -prune with -reindex, then delete block files that will be ignored by the
572 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
573 // is missing, do the same here to delete any later block files after a gap. Also delete all
574 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
575 // is in sync with what's actually on disk by the time we start downloading, so that pruning
576 // works correctly.
577 void CleanupBlockRevFiles()
579 std::map<std::string, fs::path> mapBlockFiles;
581 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
582 // Remove the rev files immediately and insert the blk file paths into an
583 // ordered map keyed by block file index.
584 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
585 fs::path blocksdir = GetDataDir() / "blocks";
586 for (fs::directory_iterator it(blocksdir); it != fs::directory_iterator(); it++) {
587 if (fs::is_regular_file(*it) &&
588 it->path().filename().string().length() == 12 &&
589 it->path().filename().string().substr(8,4) == ".dat")
591 if (it->path().filename().string().substr(0,3) == "blk")
592 mapBlockFiles[it->path().filename().string().substr(3,5)] = it->path();
593 else if (it->path().filename().string().substr(0,3) == "rev")
594 remove(it->path());
598 // Remove all block files that aren't part of a contiguous set starting at
599 // zero by walking the ordered map (keys are block file indices) by
600 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
601 // start removing block files.
602 int nContigCounter = 0;
603 for (const std::pair<std::string, fs::path>& item : mapBlockFiles) {
604 if (atoi(item.first) == nContigCounter) {
605 nContigCounter++;
606 continue;
608 remove(item.second);
612 void ThreadImport(std::vector<fs::path> vImportFiles)
614 const CChainParams& chainparams = Params();
615 RenameThread("bitcoin-loadblk");
618 CImportingNow imp;
620 // -reindex
621 if (fReindex) {
622 int nFile = 0;
623 while (true) {
624 CDiskBlockPos pos(nFile, 0);
625 if (!fs::exists(GetBlockPosFilename(pos, "blk")))
626 break; // No block files left to reindex
627 FILE *file = OpenBlockFile(pos, true);
628 if (!file)
629 break; // This error is logged in OpenBlockFile
630 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile);
631 LoadExternalBlockFile(chainparams, file, &pos);
632 nFile++;
634 pblocktree->WriteReindexing(false);
635 fReindex = false;
636 LogPrintf("Reindexing finished\n");
637 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
638 LoadGenesisBlock(chainparams);
641 // hardcoded $DATADIR/bootstrap.dat
642 fs::path pathBootstrap = GetDataDir() / "bootstrap.dat";
643 if (fs::exists(pathBootstrap)) {
644 FILE *file = fsbridge::fopen(pathBootstrap, "rb");
645 if (file) {
646 fs::path pathBootstrapOld = GetDataDir() / "bootstrap.dat.old";
647 LogPrintf("Importing bootstrap.dat...\n");
648 LoadExternalBlockFile(chainparams, file);
649 RenameOver(pathBootstrap, pathBootstrapOld);
650 } else {
651 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap.string());
655 // -loadblock=
656 for (const fs::path& path : vImportFiles) {
657 FILE *file = fsbridge::fopen(path, "rb");
658 if (file) {
659 LogPrintf("Importing blocks file %s...\n", path.string());
660 LoadExternalBlockFile(chainparams, file);
661 } else {
662 LogPrintf("Warning: Could not open blocks file %s\n", path.string());
666 // scan for better chains in the block chain database, that are not yet connected in the active best chain
667 CValidationState state;
668 if (!ActivateBestChain(state, chainparams)) {
669 LogPrintf("Failed to connect best block");
670 StartShutdown();
673 if (gArgs.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
674 LogPrintf("Stopping after block import\n");
675 StartShutdown();
677 } // End scope of CImportingNow
678 if (gArgs.GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
679 LoadMempool();
680 fDumpMempoolLater = !fRequestShutdown;
684 /** Sanity checks
685 * Ensure that Bitcoin is running in a usable environment with all
686 * necessary library support.
688 bool InitSanityCheck(void)
690 if(!ECC_InitSanityCheck()) {
691 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
692 return false;
695 if (!glibc_sanity_test() || !glibcxx_sanity_test())
696 return false;
698 if (!Random_SanityCheck()) {
699 InitError("OS cryptographic RNG sanity check failure. Aborting.");
700 return false;
703 return true;
706 bool AppInitServers(boost::thread_group& threadGroup)
708 RPCServer::OnStarted(&OnRPCStarted);
709 RPCServer::OnStopped(&OnRPCStopped);
710 if (!InitHTTPServer())
711 return false;
712 if (!StartRPC())
713 return false;
714 if (!StartHTTPRPC())
715 return false;
716 if (gArgs.GetBoolArg("-rest", DEFAULT_REST_ENABLE) && !StartREST())
717 return false;
718 if (!StartHTTPServer())
719 return false;
720 return true;
723 // Parameter interaction based on rules
724 void InitParameterInteraction()
726 // when specifying an explicit binding address, you want to listen on it
727 // even when -connect or -proxy is specified
728 if (gArgs.IsArgSet("-bind")) {
729 if (gArgs.SoftSetBoolArg("-listen", true))
730 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
732 if (gArgs.IsArgSet("-whitebind")) {
733 if (gArgs.SoftSetBoolArg("-listen", true))
734 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
737 if (gArgs.IsArgSet("-connect")) {
738 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
739 if (gArgs.SoftSetBoolArg("-dnsseed", false))
740 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
741 if (gArgs.SoftSetBoolArg("-listen", false))
742 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
745 if (gArgs.IsArgSet("-proxy")) {
746 // to protect privacy, do not listen by default if a default proxy server is specified
747 if (gArgs.SoftSetBoolArg("-listen", false))
748 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
749 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
750 // to listen locally, so don't rely on this happening through -listen below.
751 if (gArgs.SoftSetBoolArg("-upnp", false))
752 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
753 // to protect privacy, do not discover addresses by default
754 if (gArgs.SoftSetBoolArg("-discover", false))
755 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
758 if (!gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
759 // do not map ports or try to retrieve public IP when not listening (pointless)
760 if (gArgs.SoftSetBoolArg("-upnp", false))
761 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
762 if (gArgs.SoftSetBoolArg("-discover", false))
763 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
764 if (gArgs.SoftSetBoolArg("-listenonion", false))
765 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
768 if (gArgs.IsArgSet("-externalip")) {
769 // if an explicit public IP is specified, do not try to find others
770 if (gArgs.SoftSetBoolArg("-discover", false))
771 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
774 // disable whitelistrelay in blocksonly mode
775 if (gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
776 if (gArgs.SoftSetBoolArg("-whitelistrelay", false))
777 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
780 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
781 if (gArgs.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
782 if (gArgs.SoftSetBoolArg("-whitelistrelay", true))
783 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
786 if (gArgs.IsArgSet("-blockmaxsize")) {
787 unsigned int max_size = gArgs.GetArg("-blockmaxsize", 0);
788 if (gArgs.SoftSetArg("blockmaxweight", strprintf("%d", max_size * WITNESS_SCALE_FACTOR))) {
789 LogPrintf("%s: parameter interaction: -blockmaxsize=%d -> setting -blockmaxweight=%d (-blockmaxsize is deprecated!)\n", __func__, max_size, max_size * WITNESS_SCALE_FACTOR);
790 } else {
791 LogPrintf("%s: Ignoring blockmaxsize setting which is overridden by blockmaxweight", __func__);
796 static std::string ResolveErrMsg(const char * const optname, const std::string& strBind)
798 return strprintf(_("Cannot resolve -%s address: '%s'"), optname, strBind);
801 void InitLogging()
803 fPrintToConsole = gArgs.GetBoolArg("-printtoconsole", false);
804 fLogTimestamps = gArgs.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
805 fLogTimeMicros = gArgs.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
806 fLogIPs = gArgs.GetBoolArg("-logips", DEFAULT_LOGIPS);
808 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
809 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
812 namespace { // Variables internal to initialization process only
814 int nMaxConnections;
815 int nUserMaxConnections;
816 int nFD;
817 ServiceFlags nLocalServices = NODE_NETWORK;
819 } // namespace
821 [[noreturn]] static void new_handler_terminate()
823 // Rather than throwing std::bad-alloc if allocation fails, terminate
824 // immediately to (try to) avoid chain corruption.
825 // Since LogPrintf may itself allocate memory, set the handler directly
826 // to terminate first.
827 std::set_new_handler(std::terminate);
828 LogPrintf("Error: Out of memory. Terminating.\n");
830 // The log was successful, terminate now.
831 std::terminate();
834 bool AppInitBasicSetup()
836 // ********************************************************* Step 1: setup
837 #ifdef _MSC_VER
838 // Turn off Microsoft heap dump noise
839 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
840 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
841 // Disable confusing "helpful" text message on abort, Ctrl-C
842 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
843 #endif
844 #ifdef WIN32
845 // Enable Data Execution Prevention (DEP)
846 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
847 // A failure is non-critical and needs no further attention!
848 #ifndef PROCESS_DEP_ENABLE
849 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
850 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
851 #define PROCESS_DEP_ENABLE 0x00000001
852 #endif
853 typedef BOOL (WINAPI *PSETPROCDEPPOL)(DWORD);
854 PSETPROCDEPPOL setProcDEPPol = (PSETPROCDEPPOL)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
855 if (setProcDEPPol != nullptr) setProcDEPPol(PROCESS_DEP_ENABLE);
856 #endif
858 if (!SetupNetworking())
859 return InitError("Initializing networking failed");
861 #ifndef WIN32
862 if (!gArgs.GetBoolArg("-sysperms", false)) {
863 umask(077);
866 // Clean shutdown on SIGTERM
867 registerSignalHandler(SIGTERM, HandleSIGTERM);
868 registerSignalHandler(SIGINT, HandleSIGTERM);
870 // Reopen debug.log on SIGHUP
871 registerSignalHandler(SIGHUP, HandleSIGHUP);
873 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
874 signal(SIGPIPE, SIG_IGN);
875 #endif
877 std::set_new_handler(new_handler_terminate);
879 return true;
882 bool AppInitParameterInteraction()
884 const CChainParams& chainparams = Params();
885 // ********************************************************* Step 2: parameter interactions
887 // also see: InitParameterInteraction()
889 // if using block pruning, then disallow txindex
890 if (gArgs.GetArg("-prune", 0)) {
891 if (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX))
892 return InitError(_("Prune mode is incompatible with -txindex."));
895 // -bind and -whitebind can't be set when not listening
896 size_t nUserBind = gArgs.GetArgs("-bind").size() + gArgs.GetArgs("-whitebind").size();
897 if (nUserBind != 0 && !gArgs.GetBoolArg("-listen", DEFAULT_LISTEN)) {
898 return InitError("Cannot set -bind or -whitebind together with -listen=0");
901 // Make sure enough file descriptors are available
902 int nBind = std::max(nUserBind, size_t(1));
903 nUserMaxConnections = gArgs.GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
904 nMaxConnections = std::max(nUserMaxConnections, 0);
906 // Trim requested connection counts, to fit into system limitations
907 nMaxConnections = std::max(std::min(nMaxConnections, (int)(FD_SETSIZE - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS)), 0);
908 nFD = RaiseFileDescriptorLimit(nMaxConnections + MIN_CORE_FILEDESCRIPTORS + MAX_ADDNODE_CONNECTIONS);
909 if (nFD < MIN_CORE_FILEDESCRIPTORS)
910 return InitError(_("Not enough file descriptors available."));
911 nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS, nMaxConnections);
913 if (nMaxConnections < nUserMaxConnections)
914 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
916 // ********************************************************* Step 3: parameter-to-internal-flags
917 if (gArgs.IsArgSet("-debug")) {
918 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
919 const std::vector<std::string> categories = gArgs.GetArgs("-debug");
921 if (find(categories.begin(), categories.end(), std::string("0")) == categories.end()) {
922 for (const auto& cat : categories) {
923 uint32_t flag = 0;
924 if (!GetLogCategory(&flag, &cat)) {
925 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
926 continue;
928 logCategories |= flag;
933 // Now remove the logging categories which were explicitly excluded
934 for (const std::string& cat : gArgs.GetArgs("-debugexclude")) {
935 uint32_t flag = 0;
936 if (!GetLogCategory(&flag, &cat)) {
937 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
938 continue;
940 logCategories &= ~flag;
943 // Check for -debugnet
944 if (gArgs.GetBoolArg("-debugnet", false))
945 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
946 // Check for -socks - as this is a privacy risk to continue, exit here
947 if (gArgs.IsArgSet("-socks"))
948 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
949 // Check for -tor - as this is a privacy risk to continue, exit here
950 if (gArgs.GetBoolArg("-tor", false))
951 return InitError(_("Unsupported argument -tor found, use -onion."));
953 if (gArgs.GetBoolArg("-benchmark", false))
954 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
956 if (gArgs.GetBoolArg("-whitelistalwaysrelay", false))
957 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
959 if (gArgs.IsArgSet("-blockminsize"))
960 InitWarning("Unsupported argument -blockminsize ignored.");
962 // Checkmempool and checkblockindex default to true in regtest mode
963 int ratio = std::min<int>(std::max<int>(gArgs.GetArg("-checkmempool", chainparams.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
964 if (ratio != 0) {
965 mempool.setSanityCheck(1.0 / ratio);
967 fCheckBlockIndex = gArgs.GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
968 fCheckpointsEnabled = gArgs.GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED);
970 hashAssumeValid = uint256S(gArgs.GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
971 if (!hashAssumeValid.IsNull())
972 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid.GetHex());
973 else
974 LogPrintf("Validating signatures for all blocks.\n");
976 if (gArgs.IsArgSet("-minimumchainwork")) {
977 const std::string minChainWorkStr = gArgs.GetArg("-minimumchainwork", "");
978 if (!IsHexNumber(minChainWorkStr)) {
979 return InitError(strprintf("Invalid non-hex (%s) minimum chain work value specified", minChainWorkStr));
981 nMinimumChainWork = UintToArith256(uint256S(minChainWorkStr));
982 } else {
983 nMinimumChainWork = UintToArith256(chainparams.GetConsensus().nMinimumChainWork);
985 LogPrintf("Setting nMinimumChainWork=%s\n", nMinimumChainWork.GetHex());
986 if (nMinimumChainWork < UintToArith256(chainparams.GetConsensus().nMinimumChainWork)) {
987 LogPrintf("Warning: nMinimumChainWork set below default value of %s\n", chainparams.GetConsensus().nMinimumChainWork.GetHex());
990 // mempool limits
991 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
992 int64_t nMempoolSizeMin = gArgs.GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT) * 1000 * 40;
993 if (nMempoolSizeMax < 0 || nMempoolSizeMax < nMempoolSizeMin)
994 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin / 1000000.0)));
995 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
996 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
997 if (gArgs.IsArgSet("-incrementalrelayfee"))
999 CAmount n = 0;
1000 if (!ParseMoney(gArgs.GetArg("-incrementalrelayfee", ""), n))
1001 return InitError(AmountErrMsg("incrementalrelayfee", gArgs.GetArg("-incrementalrelayfee", "")));
1002 incrementalRelayFee = CFeeRate(n);
1005 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
1006 nScriptCheckThreads = gArgs.GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
1007 if (nScriptCheckThreads <= 0)
1008 nScriptCheckThreads += GetNumCores();
1009 if (nScriptCheckThreads <= 1)
1010 nScriptCheckThreads = 0;
1011 else if (nScriptCheckThreads > MAX_SCRIPTCHECK_THREADS)
1012 nScriptCheckThreads = MAX_SCRIPTCHECK_THREADS;
1014 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
1015 int64_t nPruneArg = gArgs.GetArg("-prune", 0);
1016 if (nPruneArg < 0) {
1017 return InitError(_("Prune cannot be configured with a negative value."));
1019 nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
1020 if (nPruneArg == 1) { // manual pruning: -prune=1
1021 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1022 nPruneTarget = std::numeric_limits<uint64_t>::max();
1023 fPruneMode = true;
1024 } else if (nPruneTarget) {
1025 if (nPruneTarget < MIN_DISK_SPACE_FOR_BLOCK_FILES) {
1026 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
1028 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget / 1024 / 1024);
1029 fPruneMode = true;
1032 RegisterAllCoreRPCCommands(tableRPC);
1033 #ifdef ENABLE_WALLET
1034 RegisterWalletRPC(tableRPC);
1035 #endif
1037 nConnectTimeout = gArgs.GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1038 if (nConnectTimeout <= 0)
1039 nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1041 if (gArgs.IsArgSet("-minrelaytxfee")) {
1042 CAmount n = 0;
1043 if (!ParseMoney(gArgs.GetArg("-minrelaytxfee", ""), n)) {
1044 return InitError(AmountErrMsg("minrelaytxfee", gArgs.GetArg("-minrelaytxfee", "")));
1046 // High fee check is done afterward in WalletParameterInteraction()
1047 ::minRelayTxFee = CFeeRate(n);
1048 } else if (incrementalRelayFee > ::minRelayTxFee) {
1049 // Allow only setting incrementalRelayFee to control both
1050 ::minRelayTxFee = incrementalRelayFee;
1051 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee.ToString());
1054 // Sanity check argument for min fee for including tx in block
1055 // TODO: Harmonize which arguments need sanity checking and where that happens
1056 if (gArgs.IsArgSet("-blockmintxfee"))
1058 CAmount n = 0;
1059 if (!ParseMoney(gArgs.GetArg("-blockmintxfee", ""), n))
1060 return InitError(AmountErrMsg("blockmintxfee", gArgs.GetArg("-blockmintxfee", "")));
1063 // Feerate used to define dust. Shouldn't be changed lightly as old
1064 // implementations may inadvertently create non-standard transactions
1065 if (gArgs.IsArgSet("-dustrelayfee"))
1067 CAmount n = 0;
1068 if (!ParseMoney(gArgs.GetArg("-dustrelayfee", ""), n) || 0 == n)
1069 return InitError(AmountErrMsg("dustrelayfee", gArgs.GetArg("-dustrelayfee", "")));
1070 dustRelayFee = CFeeRate(n);
1073 fRequireStandard = !gArgs.GetBoolArg("-acceptnonstdtxn", !chainparams.RequireStandard());
1074 if (chainparams.RequireStandard() && !fRequireStandard)
1075 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams.NetworkIDString()));
1076 nBytesPerSigOp = gArgs.GetArg("-bytespersigop", nBytesPerSigOp);
1078 #ifdef ENABLE_WALLET
1079 if (!WalletParameterInteraction())
1080 return false;
1081 #endif
1083 fIsBareMultisigStd = gArgs.GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG);
1084 fAcceptDatacarrier = gArgs.GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER);
1085 nMaxDatacarrierBytes = gArgs.GetArg("-datacarriersize", nMaxDatacarrierBytes);
1087 // Option to startup with mocktime set (used for regression testing):
1088 SetMockTime(gArgs.GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1090 if (gArgs.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1091 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
1093 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
1094 return InitError("rpcserialversion must be non-negative.");
1096 if (gArgs.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
1097 return InitError("unknown rpcserialversion requested.");
1099 nMaxTipAge = gArgs.GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
1101 fEnableReplacement = gArgs.GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT);
1102 if ((!fEnableReplacement) && gArgs.IsArgSet("-mempoolreplacement")) {
1103 // Minimal effort at forwards compatibility
1104 std::string strReplacementModeList = gArgs.GetArg("-mempoolreplacement", ""); // default is impossible
1105 std::vector<std::string> vstrReplacementModes;
1106 boost::split(vstrReplacementModes, strReplacementModeList, boost::is_any_of(","));
1107 fEnableReplacement = (std::find(vstrReplacementModes.begin(), vstrReplacementModes.end(), "fee") != vstrReplacementModes.end());
1110 if (gArgs.IsArgSet("-vbparams")) {
1111 // Allow overriding version bits parameters for testing
1112 if (!chainparams.MineBlocksOnDemand()) {
1113 return InitError("Version bits parameters may only be overridden on regtest.");
1115 for (const std::string& strDeployment : gArgs.GetArgs("-vbparams")) {
1116 std::vector<std::string> vDeploymentParams;
1117 boost::split(vDeploymentParams, strDeployment, boost::is_any_of(":"));
1118 if (vDeploymentParams.size() != 3) {
1119 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1121 int64_t nStartTime, nTimeout;
1122 if (!ParseInt64(vDeploymentParams[1], &nStartTime)) {
1123 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
1125 if (!ParseInt64(vDeploymentParams[2], &nTimeout)) {
1126 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
1128 bool found = false;
1129 for (int j=0; j<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j)
1131 if (vDeploymentParams[0].compare(VersionBitsDeploymentInfo[j].name) == 0) {
1132 UpdateVersionBitsParameters(Consensus::DeploymentPos(j), nStartTime, nTimeout);
1133 found = true;
1134 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams[0], nStartTime, nTimeout);
1135 break;
1138 if (!found) {
1139 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
1143 return true;
1146 static bool LockDataDirectory(bool probeOnly)
1148 std::string strDataDir = GetDataDir().string();
1150 // Make sure only a single Bitcoin process is using the data directory.
1151 fs::path pathLockFile = GetDataDir() / ".lock";
1152 FILE* file = fsbridge::fopen(pathLockFile, "a"); // empty lock file; created if it doesn't exist.
1153 if (file) fclose(file);
1155 try {
1156 static boost::interprocess::file_lock lock(pathLockFile.string().c_str());
1157 if (!lock.try_lock()) {
1158 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir, _(PACKAGE_NAME)));
1160 if (probeOnly) {
1161 lock.unlock();
1163 } catch(const boost::interprocess::interprocess_exception& e) {
1164 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir, _(PACKAGE_NAME), e.what()));
1166 return true;
1169 bool AppInitSanityChecks()
1171 // ********************************************************* Step 4: sanity checks
1173 // Initialize elliptic curve code
1174 std::string sha256_algo = SHA256AutoDetect();
1175 LogPrintf("Using the '%s' SHA256 implementation\n", sha256_algo);
1176 RandomInit();
1177 ECC_Start();
1178 globalVerifyHandle.reset(new ECCVerifyHandle());
1180 // Sanity check
1181 if (!InitSanityCheck())
1182 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME)));
1184 // Probe the data directory lock to give an early error message, if possible
1185 // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1186 // and a fork will cause weird behavior to it.
1187 return LockDataDirectory(true);
1190 bool AppInitLockDataDirectory()
1192 // After daemonization get the data directory lock again and hold on to it until exit
1193 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1194 // will at most make us exit without printing a message to console.
1195 if (!LockDataDirectory(false)) {
1196 // Detailed error printed inside LockDataDirectory
1197 return false;
1199 return true;
1202 bool AppInitMain(boost::thread_group& threadGroup, CScheduler& scheduler)
1204 const CChainParams& chainparams = Params();
1205 // ********************************************************* Step 4a: application initialization
1206 #ifndef WIN32
1207 CreatePidFile(GetPidFile(), getpid());
1208 #endif
1209 if (gArgs.GetBoolArg("-shrinkdebugfile", logCategories == BCLog::NONE)) {
1210 // Do this first since it both loads a bunch of debug.log into memory,
1211 // and because this needs to happen before any other debug.log printing
1212 ShrinkDebugFile();
1215 if (fPrintToDebugLog)
1216 OpenDebugLog();
1218 if (!fLogTimestamps)
1219 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1220 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1221 LogPrintf("Using data directory %s\n", GetDataDir().string());
1222 LogPrintf("Using config file %s\n", GetConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME)).string());
1223 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1225 InitSignatureCache();
1226 InitScriptExecutionCache();
1228 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads);
1229 if (nScriptCheckThreads) {
1230 for (int i=0; i<nScriptCheckThreads-1; i++)
1231 threadGroup.create_thread(&ThreadScriptCheck);
1234 // Start the lightweight task scheduler thread
1235 CScheduler::Function serviceLoop = boost::bind(&CScheduler::serviceQueue, &scheduler);
1236 threadGroup.create_thread(boost::bind(&TraceThread<CScheduler::Function>, "scheduler", serviceLoop));
1238 GetMainSignals().RegisterBackgroundSignalScheduler(scheduler);
1240 /* Start the RPC server already. It will be started in "warmup" mode
1241 * and not really process calls already (but it will signify connections
1242 * that the server is there and will be ready later). Warmup mode will
1243 * be disabled when initialisation is finished.
1245 if (gArgs.GetBoolArg("-server", false))
1247 uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1248 if (!AppInitServers(threadGroup))
1249 return InitError(_("Unable to start HTTP server. See debug log for details."));
1252 int64_t nStart;
1254 // ********************************************************* Step 5: verify wallet database integrity
1255 #ifdef ENABLE_WALLET
1256 if (!VerifyWallets())
1257 return false;
1258 #endif
1259 // ********************************************************* Step 6: network initialization
1260 // Note that we absolutely cannot open any actual connections
1261 // until the very end ("start node") as the UTXO/block state
1262 // is not yet setup and may end up being set up twice if we
1263 // need to reindex later.
1265 assert(!g_connman);
1266 g_connman = std::unique_ptr<CConnman>(new CConnman(GetRand(std::numeric_limits<uint64_t>::max()), GetRand(std::numeric_limits<uint64_t>::max())));
1267 CConnman& connman = *g_connman;
1269 peerLogic.reset(new PeerLogicValidation(&connman, scheduler));
1270 RegisterValidationInterface(peerLogic.get());
1272 // sanitize comments per BIP-0014, format user agent and check total size
1273 std::vector<std::string> uacomments;
1274 for (const std::string& cmt : gArgs.GetArgs("-uacomment")) {
1275 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1276 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1277 uacomments.push_back(cmt);
1279 strSubVersion = FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, uacomments);
1280 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1281 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1282 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1285 if (gArgs.IsArgSet("-onlynet")) {
1286 std::set<enum Network> nets;
1287 for (const std::string& snet : gArgs.GetArgs("-onlynet")) {
1288 enum Network net = ParseNetwork(snet);
1289 if (net == NET_UNROUTABLE)
1290 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1291 nets.insert(net);
1293 for (int n = 0; n < NET_MAX; n++) {
1294 enum Network net = (enum Network)n;
1295 if (!nets.count(net))
1296 SetLimited(net);
1300 // Check for host lookup allowed before parsing any network related parameters
1301 fNameLookup = gArgs.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1303 bool proxyRandomize = gArgs.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1304 // -proxy sets a proxy for all outgoing network traffic
1305 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1306 std::string proxyArg = gArgs.GetArg("-proxy", "");
1307 SetLimited(NET_TOR);
1308 if (proxyArg != "" && proxyArg != "0") {
1309 CService proxyAddr;
1310 if (!Lookup(proxyArg.c_str(), proxyAddr, 9050, fNameLookup)) {
1311 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1314 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
1315 if (!addrProxy.IsValid())
1316 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1318 SetProxy(NET_IPV4, addrProxy);
1319 SetProxy(NET_IPV6, addrProxy);
1320 SetProxy(NET_TOR, addrProxy);
1321 SetNameProxy(addrProxy);
1322 SetLimited(NET_TOR, false); // by default, -proxy sets onion as reachable, unless -noonion later
1325 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1326 // -noonion (or -onion=0) disables connecting to .onion entirely
1327 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1328 std::string onionArg = gArgs.GetArg("-onion", "");
1329 if (onionArg != "") {
1330 if (onionArg == "0") { // Handle -noonion/-onion=0
1331 SetLimited(NET_TOR); // set onions as unreachable
1332 } else {
1333 CService onionProxy;
1334 if (!Lookup(onionArg.c_str(), onionProxy, 9050, fNameLookup)) {
1335 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1337 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
1338 if (!addrOnion.IsValid())
1339 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1340 SetProxy(NET_TOR, addrOnion);
1341 SetLimited(NET_TOR, false);
1345 // see Step 2: parameter interactions for more information about these
1346 fListen = gArgs.GetBoolArg("-listen", DEFAULT_LISTEN);
1347 fDiscover = gArgs.GetBoolArg("-discover", true);
1348 fRelayTxes = !gArgs.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY);
1350 for (const std::string& strAddr : gArgs.GetArgs("-externalip")) {
1351 CService addrLocal;
1352 if (Lookup(strAddr.c_str(), addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1353 AddLocal(addrLocal, LOCAL_MANUAL);
1354 else
1355 return InitError(ResolveErrMsg("externalip", strAddr));
1358 #if ENABLE_ZMQ
1359 pzmqNotificationInterface = CZMQNotificationInterface::Create();
1361 if (pzmqNotificationInterface) {
1362 RegisterValidationInterface(pzmqNotificationInterface);
1364 #endif
1365 uint64_t nMaxOutboundLimit = 0; //unlimited unless -maxuploadtarget is set
1366 uint64_t nMaxOutboundTimeframe = MAX_UPLOAD_TIMEFRAME;
1368 if (gArgs.IsArgSet("-maxuploadtarget")) {
1369 nMaxOutboundLimit = gArgs.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET)*1024*1024;
1372 // ********************************************************* Step 7: load block chain
1374 fReindex = gArgs.GetBoolArg("-reindex", false);
1375 bool fReindexChainState = gArgs.GetBoolArg("-reindex-chainstate", false);
1377 // cache size calculations
1378 int64_t nTotalCache = (gArgs.GetArg("-dbcache", nDefaultDbCache) << 20);
1379 nTotalCache = std::max(nTotalCache, nMinDbCache << 20); // total cache cannot be less than nMinDbCache
1380 nTotalCache = std::min(nTotalCache, nMaxDbCache << 20); // total cache cannot be greater than nMaxDbcache
1381 int64_t nBlockTreeDBCache = nTotalCache / 8;
1382 nBlockTreeDBCache = std::min(nBlockTreeDBCache, (gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX) ? nMaxBlockDBAndTxIndexCache : nMaxBlockDBCache) << 20);
1383 nTotalCache -= nBlockTreeDBCache;
1384 int64_t nCoinDBCache = std::min(nTotalCache / 2, (nTotalCache / 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1385 nCoinDBCache = std::min(nCoinDBCache, nMaxCoinsDBCache << 20); // cap total coins db cache
1386 nTotalCache -= nCoinDBCache;
1387 nCoinCacheUsage = nTotalCache; // the rest goes to in-memory cache
1388 int64_t nMempoolSizeMax = gArgs.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
1389 LogPrintf("Cache configuration:\n");
1390 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache * (1.0 / 1024 / 1024));
1391 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache * (1.0 / 1024 / 1024));
1392 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));
1394 bool fLoaded = false;
1395 while (!fLoaded && !fRequestShutdown) {
1396 bool fReset = fReindex;
1397 std::string strLoadError;
1399 uiInterface.InitMessage(_("Loading block index..."));
1401 nStart = GetTimeMillis();
1402 do {
1403 try {
1404 UnloadBlockIndex();
1405 pcoinsTip.reset();
1406 pcoinsdbview.reset();
1407 pcoinscatcher.reset();
1408 pblocktree.reset(new CBlockTreeDB(nBlockTreeDBCache, false, fReset));
1410 if (fReset) {
1411 pblocktree->WriteReindexing(true);
1412 //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
1413 if (fPruneMode)
1414 CleanupBlockRevFiles();
1417 if (fRequestShutdown) break;
1419 // LoadBlockIndex will load fTxIndex from the db, or set it if
1420 // we're reindexing. It will also load fHavePruned if we've
1421 // ever removed a block file from disk.
1422 // Note that it also sets fReindex based on the disk flag!
1423 // From here on out fReindex and fReset mean something different!
1424 if (!LoadBlockIndex(chainparams)) {
1425 strLoadError = _("Error loading block database");
1426 break;
1429 // If the loaded chain has a wrong genesis, bail out immediately
1430 // (we're likely using a testnet datadir, or the other way around).
1431 if (!mapBlockIndex.empty() && mapBlockIndex.count(chainparams.GetConsensus().hashGenesisBlock) == 0)
1432 return InitError(_("Incorrect or no genesis block found. Wrong datadir for network?"));
1434 // Check for changed -txindex state
1435 if (fTxIndex != gArgs.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1436 strLoadError = _("You need to rebuild the database using -reindex to change -txindex");
1437 break;
1440 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1441 // in the past, but is now trying to run unpruned.
1442 if (fHavePruned && !fPruneMode) {
1443 strLoadError = _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1444 break;
1447 // At this point blocktree args are consistent with what's on disk.
1448 // If we're not mid-reindex (based on disk + args), add a genesis block on disk
1449 // (otherwise we use the one already on disk).
1450 // This is called again in ThreadImport after the reindex completes.
1451 if (!fReindex && !LoadGenesisBlock(chainparams)) {
1452 strLoadError = _("Error initializing block database");
1453 break;
1456 // At this point we're either in reindex or we've loaded a useful
1457 // block tree into mapBlockIndex!
1459 pcoinsdbview.reset(new CCoinsViewDB(nCoinDBCache, false, fReset || fReindexChainState));
1460 pcoinscatcher.reset(new CCoinsViewErrorCatcher(pcoinsdbview.get()));
1462 // If necessary, upgrade from older database format.
1463 // This is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1464 if (!pcoinsdbview->Upgrade()) {
1465 strLoadError = _("Error upgrading chainstate database");
1466 break;
1469 // ReplayBlocks is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1470 if (!ReplayBlocks(chainparams, pcoinsdbview.get())) {
1471 strLoadError = _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.");
1472 break;
1475 // The on-disk coinsdb is now in a good state, create the cache
1476 pcoinsTip.reset(new CCoinsViewCache(pcoinscatcher.get()));
1478 bool is_coinsview_empty = fReset || fReindexChainState || pcoinsTip->GetBestBlock().IsNull();
1479 if (!is_coinsview_empty) {
1480 // LoadChainTip sets chainActive based on pcoinsTip's best block
1481 if (!LoadChainTip(chainparams)) {
1482 strLoadError = _("Error initializing block database");
1483 break;
1485 assert(chainActive.Tip() != nullptr);
1488 if (!fReset) {
1489 // Note that RewindBlockIndex MUST run even if we're about to -reindex-chainstate.
1490 // It both disconnects blocks based on chainActive, and drops block data in
1491 // mapBlockIndex based on lack of available witness data.
1492 uiInterface.InitMessage(_("Rewinding blocks..."));
1493 if (!RewindBlockIndex(chainparams)) {
1494 strLoadError = _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1495 break;
1499 if (!is_coinsview_empty) {
1500 uiInterface.InitMessage(_("Verifying blocks..."));
1501 if (fHavePruned && gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS) > MIN_BLOCKS_TO_KEEP) {
1502 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1503 MIN_BLOCKS_TO_KEEP);
1507 LOCK(cs_main);
1508 CBlockIndex* tip = chainActive.Tip();
1509 RPCNotifyBlockChange(true, tip);
1510 if (tip && tip->nTime > GetAdjustedTime() + 2 * 60 * 60) {
1511 strLoadError = _("The block database contains a block which appears to be from the future. "
1512 "This may be due to your computer's date and time being set incorrectly. "
1513 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1514 break;
1518 if (!CVerifyDB().VerifyDB(chainparams, pcoinsdbview.get(), gArgs.GetArg("-checklevel", DEFAULT_CHECKLEVEL),
1519 gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS))) {
1520 strLoadError = _("Corrupted block database detected");
1521 break;
1524 } catch (const std::exception& e) {
1525 LogPrintf("%s\n", e.what());
1526 strLoadError = _("Error opening block database");
1527 break;
1530 fLoaded = true;
1531 } while(false);
1533 if (!fLoaded && !fRequestShutdown) {
1534 // first suggest a reindex
1535 if (!fReset) {
1536 bool fRet = uiInterface.ThreadSafeQuestion(
1537 strLoadError + ".\n\n" + _("Do you want to rebuild the block database now?"),
1538 strLoadError + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1539 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1540 if (fRet) {
1541 fReindex = true;
1542 fRequestShutdown = false;
1543 } else {
1544 LogPrintf("Aborted block database rebuild. Exiting.\n");
1545 return false;
1547 } else {
1548 return InitError(strLoadError);
1553 // As LoadBlockIndex can take several minutes, it's possible the user
1554 // requested to kill the GUI during the last operation. If so, exit.
1555 // As the program has not fully started yet, Shutdown() is possibly overkill.
1556 if (fRequestShutdown)
1558 LogPrintf("Shutdown requested. Exiting.\n");
1559 return false;
1561 if (fLoaded) {
1562 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart);
1565 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
1566 CAutoFile est_filein(fsbridge::fopen(est_path, "rb"), SER_DISK, CLIENT_VERSION);
1567 // Allowed to fail as this file IS missing on first startup.
1568 if (!est_filein.IsNull())
1569 ::feeEstimator.Read(est_filein);
1570 fFeeEstimatesInitialized = true;
1572 // ********************************************************* Step 8: load wallet
1573 #ifdef ENABLE_WALLET
1574 if (!OpenWallets())
1575 return false;
1576 #else
1577 LogPrintf("No wallet support compiled in!\n");
1578 #endif
1580 // ********************************************************* Step 9: data directory maintenance
1582 // if pruning, unset the service bit and perform the initial blockstore prune
1583 // after any wallet rescanning has taken place.
1584 if (fPruneMode) {
1585 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1586 nLocalServices = ServiceFlags(nLocalServices & ~NODE_NETWORK);
1587 if (!fReindex) {
1588 uiInterface.InitMessage(_("Pruning blockstore..."));
1589 PruneAndFlush();
1593 if (chainparams.GetConsensus().vDeployments[Consensus::DEPLOYMENT_SEGWIT].nTimeout != 0) {
1594 // Only advertise witness capabilities if they have a reasonable start time.
1595 // This allows us to have the code merged without a defined softfork, by setting its
1596 // end time to 0.
1597 // Note that setting NODE_WITNESS is never required: the only downside from not
1598 // doing so is that after activation, no upgraded nodes will fetch from you.
1599 nLocalServices = ServiceFlags(nLocalServices | NODE_WITNESS);
1602 // ********************************************************* Step 10: import blocks
1604 if (!CheckDiskSpace())
1605 return false;
1607 // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1608 // No locking, as this happens before any background thread is started.
1609 if (chainActive.Tip() == nullptr) {
1610 uiInterface.NotifyBlockTip.connect(BlockNotifyGenesisWait);
1611 } else {
1612 fHaveGenesis = true;
1615 if (gArgs.IsArgSet("-blocknotify"))
1616 uiInterface.NotifyBlockTip.connect(BlockNotifyCallback);
1618 std::vector<fs::path> vImportFiles;
1619 for (const std::string& strFile : gArgs.GetArgs("-loadblock")) {
1620 vImportFiles.push_back(strFile);
1623 threadGroup.create_thread(boost::bind(&ThreadImport, vImportFiles));
1625 // Wait for genesis block to be processed
1627 WaitableLock lock(cs_GenesisWait);
1628 while (!fHaveGenesis) {
1629 condvar_GenesisWait.wait(lock);
1631 uiInterface.NotifyBlockTip.disconnect(BlockNotifyGenesisWait);
1634 // ********************************************************* Step 11: start node
1636 int chain_active_height;
1638 //// debug print
1640 LOCK(cs_main);
1641 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex.size());
1642 chain_active_height = chainActive.Height();
1644 LogPrintf("nBestHeight = %d\n", chain_active_height);
1646 if (gArgs.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION))
1647 StartTorControl(threadGroup, scheduler);
1649 Discover(threadGroup);
1651 // Map ports with UPnP
1652 MapPort(gArgs.GetBoolArg("-upnp", DEFAULT_UPNP));
1654 CConnman::Options connOptions;
1655 connOptions.nLocalServices = nLocalServices;
1656 connOptions.nMaxConnections = nMaxConnections;
1657 connOptions.nMaxOutbound = std::min(MAX_OUTBOUND_CONNECTIONS, connOptions.nMaxConnections);
1658 connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1659 connOptions.nMaxFeeler = 1;
1660 connOptions.nBestHeight = chain_active_height;
1661 connOptions.uiInterface = &uiInterface;
1662 connOptions.m_msgproc = peerLogic.get();
1663 connOptions.nSendBufferMaxSize = 1000*gArgs.GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1664 connOptions.nReceiveFloodSize = 1000*gArgs.GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1665 connOptions.m_added_nodes = gArgs.GetArgs("-addnode");
1667 connOptions.nMaxOutboundTimeframe = nMaxOutboundTimeframe;
1668 connOptions.nMaxOutboundLimit = nMaxOutboundLimit;
1670 for (const std::string& strBind : gArgs.GetArgs("-bind")) {
1671 CService addrBind;
1672 if (!Lookup(strBind.c_str(), addrBind, GetListenPort(), false)) {
1673 return InitError(ResolveErrMsg("bind", strBind));
1675 connOptions.vBinds.push_back(addrBind);
1677 for (const std::string& strBind : gArgs.GetArgs("-whitebind")) {
1678 CService addrBind;
1679 if (!Lookup(strBind.c_str(), addrBind, 0, false)) {
1680 return InitError(ResolveErrMsg("whitebind", strBind));
1682 if (addrBind.GetPort() == 0) {
1683 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind));
1685 connOptions.vWhiteBinds.push_back(addrBind);
1688 for (const auto& net : gArgs.GetArgs("-whitelist")) {
1689 CSubNet subnet;
1690 LookupSubNet(net.c_str(), subnet);
1691 if (!subnet.IsValid())
1692 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net));
1693 connOptions.vWhitelistedRange.push_back(subnet);
1696 connOptions.vSeedNodes = gArgs.GetArgs("-seednode");
1698 // Initiate outbound connections unless connect=0
1699 connOptions.m_use_addrman_outgoing = !gArgs.IsArgSet("-connect");
1700 if (!connOptions.m_use_addrman_outgoing) {
1701 const auto connect = gArgs.GetArgs("-connect");
1702 if (connect.size() != 1 || connect[0] != "0") {
1703 connOptions.m_specified_outgoing = connect;
1706 if (!connman.Start(scheduler, connOptions)) {
1707 return false;
1710 // ********************************************************* Step 12: finished
1712 SetRPCWarmupFinished();
1713 uiInterface.InitMessage(_("Done loading"));
1715 #ifdef ENABLE_WALLET
1716 StartWallets(scheduler);
1717 #endif
1719 return !fRequestShutdown;