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"
15 #include "chainparams.h"
16 #include "checkpoints.h"
17 #include "compat/sanity.h"
18 #include "consensus/validation.h"
20 #include "httpserver.h"
23 #include "validation.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"
40 #include "txmempool.h"
41 #include "torcontrol.h"
42 #include "ui_interface.h"
44 #include "utilmoneystr.h"
45 #include "validationinterface.h"
47 #include "wallet/init.h"
48 #include "wallet/wallet.h"
59 #include <boost/algorithm/string/classification.hpp>
60 #include <boost/algorithm/string/replace.hpp>
61 #include <boost/algorithm/string/split.hpp>
62 #include <boost/bind.hpp>
63 #include <boost/interprocess/sync/file_lock.hpp>
64 #include <boost/thread.hpp>
65 #include <openssl/crypto.h>
68 #include "zmq/zmqnotificationinterface.h"
71 bool fFeeEstimatesInitialized
= false;
72 static const bool DEFAULT_PROXYRANDOMIZE
= true;
73 static const bool DEFAULT_REST_ENABLE
= false;
74 static const bool DEFAULT_STOPAFTERBLOCKIMPORT
= false;
76 std::unique_ptr
<CConnman
> g_connman
;
77 std::unique_ptr
<PeerLogicValidation
> peerLogic
;
80 static CZMQNotificationInterface
* pzmqNotificationInterface
= nullptr;
84 // Win32 LevelDB doesn't use filedescriptors, and the ones used for
85 // accessing block files don't count towards the fd_set size limit
87 #define MIN_CORE_FILEDESCRIPTORS 0
89 #define MIN_CORE_FILEDESCRIPTORS 150
92 static const char* FEE_ESTIMATES_FILENAME
="fee_estimates.dat";
94 //////////////////////////////////////////////////////////////////////////////
100 // Thread management and startup/shutdown:
102 // The network-processing threads are all part of a thread group
103 // created by AppInit() or the Qt main() function.
105 // A clean exit happens when StartShutdown() or the SIGTERM
106 // signal handler sets fRequestShutdown, which triggers
107 // the DetectShutdownThread(), which interrupts the main thread group.
108 // DetectShutdownThread() then exits, which causes AppInit() to
109 // continue (it .joins the shutdown thread).
110 // Shutdown() is then
111 // called to clean up database connections, and stop other
112 // threads that should only be stopped after the main network-processing
113 // threads have exited.
115 // Shutdown for Qt is very similar, only it uses a QTimer to detect
116 // fRequestShutdown getting set, and then does the normal Qt
120 std::atomic
<bool> fRequestShutdown(false);
121 std::atomic
<bool> fDumpMempoolLater(false);
125 fRequestShutdown
= true;
127 bool ShutdownRequested()
129 return fRequestShutdown
;
133 * This is a minimally invasive approach to shutdown on LevelDB read errors from the
134 * chainstate, while keeping user interface out of the common library, which is shared
135 * between bitcoind, and bitcoin-qt and non-server tools.
137 class CCoinsViewErrorCatcher final
: public CCoinsViewBacked
140 explicit CCoinsViewErrorCatcher(CCoinsView
* view
) : CCoinsViewBacked(view
) {}
141 bool GetCoin(const COutPoint
&outpoint
, Coin
&coin
) const override
{
143 return CCoinsViewBacked::GetCoin(outpoint
, coin
);
144 } catch(const std::runtime_error
& e
) {
145 uiInterface
.ThreadSafeMessageBox(_("Error reading from database, shutting down."), "", CClientUIInterface::MSG_ERROR
);
146 LogPrintf("Error reading from database: %s\n", e
.what());
147 // Starting the shutdown sequence and returning false to the caller would be
148 // interpreted as 'entry not found' (as opposed to unable to read data), and
149 // could lead to invalid interpretation. Just exit immediately, as we can't
150 // continue anyway, and all writes should be atomic.
154 // Writes do not need similar protection, as failure to write is handled by the caller.
157 static CCoinsViewErrorCatcher
*pcoinscatcher
= nullptr;
158 static std::unique_ptr
<ECCVerifyHandle
> globalVerifyHandle
;
160 void Interrupt(boost::thread_group
& threadGroup
)
162 InterruptHTTPServer();
166 InterruptTorControl();
168 g_connman
->Interrupt();
169 threadGroup
.interrupt_all();
174 LogPrintf("%s: In progress...\n", __func__
);
175 static CCriticalSection cs_Shutdown
;
176 TRY_LOCK(cs_Shutdown
, lockShutdown
);
180 /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
181 /// for example if the data directory was found to be locked.
182 /// Be sure that anything that writes files or flushes caches only does this if the respective
183 /// module was initialized.
184 RenameThread("bitcoin-shutoff");
185 mempool
.AddTransactionsUpdated(1);
192 for (CWalletRef pwallet
: vpwallets
) {
193 pwallet
->Flush(false);
197 UnregisterValidationInterface(peerLogic
.get());
202 UnregisterNodeSignals(GetNodeSignals());
203 if (fDumpMempoolLater
&& gArgs
.GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL
)) {
207 if (fFeeEstimatesInitialized
)
209 ::feeEstimator
.FlushUnconfirmed(::mempool
);
210 fs::path est_path
= GetDataDir() / FEE_ESTIMATES_FILENAME
;
211 CAutoFile
est_fileout(fsbridge::fopen(est_path
, "wb"), SER_DISK
, CLIENT_VERSION
);
212 if (!est_fileout
.IsNull())
213 ::feeEstimator
.Write(est_fileout
);
215 LogPrintf("%s: Failed to write fee estimates to %s\n", __func__
, est_path
.string());
216 fFeeEstimatesInitialized
= false;
219 // FlushStateToDisk generates a SetBestChain callback, which we should avoid missing
220 if (pcoinsTip
!= nullptr) {
224 // After there are no more peers/RPC left to give us new data which may generate
225 // CValidationInterface callbacks, flush them...
226 GetMainSignals().FlushBackgroundCallbacks();
228 // Any future callbacks will be dropped. This should absolutely be safe - if
229 // missing a callback results in an unrecoverable situation, unclean shutdown
230 // would too. The only reason to do the above flushes is to let the wallet catch
231 // up with our current chain to avoid any strange pruning edge cases and make
232 // next startup faster by avoiding rescan.
236 if (pcoinsTip
!= nullptr) {
241 delete pcoinscatcher
;
242 pcoinscatcher
= nullptr;
244 pcoinsdbview
= nullptr;
246 pblocktree
= nullptr;
249 for (CWalletRef pwallet
: vpwallets
) {
250 pwallet
->Flush(true);
255 if (pzmqNotificationInterface
) {
256 UnregisterValidationInterface(pzmqNotificationInterface
);
257 delete pzmqNotificationInterface
;
258 pzmqNotificationInterface
= nullptr;
264 fs::remove(GetPidFile());
265 } catch (const fs::filesystem_error
& e
) {
266 LogPrintf("%s: Unable to remove pidfile: %s\n", __func__
, e
.what());
269 UnregisterAllValidationInterfaces();
270 GetMainSignals().UnregisterBackgroundSignalScheduler();
272 for (CWalletRef pwallet
: vpwallets
) {
277 globalVerifyHandle
.reset();
279 LogPrintf("%s: done\n", __func__
);
283 * Signal handlers are very limited in what they are allowed to do.
284 * The execution context the handler is invoked in is not guaranteed,
285 * so we restrict handler operations to just touching variables:
287 static void HandleSIGTERM(int)
289 fRequestShutdown
= true;
292 static void HandleSIGHUP(int)
294 fReopenDebugLog
= true;
298 static void registerSignalHandler(int signal
, void(*handler
)(int))
301 sa
.sa_handler
= handler
;
302 sigemptyset(&sa
.sa_mask
);
304 sigaction(signal
, &sa
, nullptr);
310 uiInterface
.NotifyBlockTip
.connect(&RPCNotifyBlockChange
);
315 uiInterface
.NotifyBlockTip
.disconnect(&RPCNotifyBlockChange
);
316 RPCNotifyBlockChange(false, nullptr);
317 cvBlockChange
.notify_all();
318 LogPrint(BCLog::RPC
, "RPC stopped.\n");
321 std::string
HelpMessage(HelpMessageMode mode
)
323 const auto defaultBaseParams
= CreateBaseChainParams(CBaseChainParams::MAIN
);
324 const auto testnetBaseParams
= CreateBaseChainParams(CBaseChainParams::TESTNET
);
325 const auto defaultChainParams
= CreateChainParams(CBaseChainParams::MAIN
);
326 const auto testnetChainParams
= CreateChainParams(CBaseChainParams::TESTNET
);
327 const bool showDebug
= gArgs
.GetBoolArg("-help-debug", false);
329 // When adding new options to the categories, please keep and ensure alphabetical ordering.
330 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
331 std::string strUsage
= HelpMessageGroup(_("Options:"));
332 strUsage
+= HelpMessageOpt("-?", _("Print this help message and exit"));
333 strUsage
+= HelpMessageOpt("-version", _("Print version and exit"));
334 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)"));
335 strUsage
+= HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
337 strUsage
+= HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY
));
338 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()));
339 strUsage
+= HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME
));
340 if (mode
== HMM_BITCOIND
)
343 strUsage
+= HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
346 strUsage
+= HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
348 strUsage
+= HelpMessageOpt("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize
));
350 strUsage
+= HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache
, nMaxDbCache
, nDefaultDbCache
));
352 strUsage
+= HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER
));
353 strUsage
+= HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
354 strUsage
+= HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS
));
355 strUsage
+= HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE
));
356 strUsage
+= HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY
));
357 strUsage
+= HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL
));
358 strUsage
+= HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN
));
359 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)"),
360 -GetNumCores(), MAX_SCRIPTCHECK_THREADS
, DEFAULT_SCRIPTCHECK_THREADS
));
362 strUsage
+= HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME
));
364 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. "
365 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
366 "(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));
367 strUsage
+= HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
368 strUsage
+= HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
370 strUsage
+= HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
372 strUsage
+= HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX
));
374 strUsage
+= HelpMessageGroup(_("Connection options:"));
375 strUsage
+= HelpMessageOpt("-addnode=<ip>", _("Add a node to connect to and attempt to keep the connection open"));
376 strUsage
+= HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD
));
377 strUsage
+= HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME
));
378 strUsage
+= HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
379 strUsage
+= HelpMessageOpt("-connect=<ip>", _("Connect only to the specified node(s); -connect=0 disables automatic connections"));
380 strUsage
+= HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
381 strUsage
+= HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP
));
382 strUsage
+= HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
383 strUsage
+= HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
384 strUsage
+= HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED
));
385 strUsage
+= HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
386 strUsage
+= HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION
));
387 strUsage
+= HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS
));
388 strUsage
+= HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER
));
389 strUsage
+= HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER
));
390 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
));
391 strUsage
+= HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
392 strUsage
+= HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
393 strUsage
+= HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG
));
394 strUsage
+= HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS
));
395 strUsage
+= HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams
->GetDefaultPort(), testnetChainParams
->GetDefaultPort()));
396 strUsage
+= HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
397 strUsage
+= HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE
));
398 strUsage
+= HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
399 strUsage
+= HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT
));
400 strUsage
+= HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL
));
401 strUsage
+= HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
404 strUsage
+= HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
406 strUsage
+= HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
409 strUsage
+= HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
410 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.") +
411 " " + _("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"));
412 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
));
415 strUsage
+= GetWalletHelpString(showDebug
);
419 strUsage
+= HelpMessageGroup(_("ZeroMQ notification options:"));
420 strUsage
+= HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
421 strUsage
+= HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
422 strUsage
+= HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
423 strUsage
+= HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
426 strUsage
+= HelpMessageGroup(_("Debugging/Testing options:"));
427 strUsage
+= HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
430 strUsage
+= HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS
));
431 strUsage
+= HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL
));
432 strUsage
+= HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams
->DefaultConsistencyChecks()));
433 strUsage
+= HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams
->DefaultConsistencyChecks()));
434 strUsage
+= HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED
));
435 strUsage
+= HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE
));
436 strUsage
+= HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE
));
437 strUsage
+= HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
438 strUsage
+= HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
439 strUsage
+= HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT
));
440 strUsage
+= HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT
));
442 strUsage
+= HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT
));
443 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
));
444 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
));
445 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
));
446 strUsage
+= HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
448 strUsage
+= HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
449 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
450 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.")));
451 strUsage
+= HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
452 strUsage
+= HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS
));
453 strUsage
+= HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS
));
456 strUsage
+= HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS
));
457 strUsage
+= HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
458 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
));
459 strUsage
+= HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE
));
461 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)"),
462 CURRENCY_UNIT
, FormatMoney(DEFAULT_TRANSACTION_MAXFEE
)));
463 strUsage
+= HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
466 strUsage
+= HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY
));
468 strUsage
+= HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
470 AppendParamsHelpMessages(strUsage
, showDebug
);
472 strUsage
+= HelpMessageGroup(_("Node relay options:"));
474 strUsage
+= HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", !testnetChainParams
->RequireStandard()));
475 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
)));
476 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
)));
478 strUsage
+= HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP
));
479 strUsage
+= HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER
));
480 strUsage
+= HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY
));
481 strUsage
+= HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT
));
482 strUsage
+= HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
483 CURRENCY_UNIT
, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE
)));
484 strUsage
+= HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY
));
485 strUsage
+= HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY
));
487 strUsage
+= HelpMessageGroup(_("Block creation options:"));
488 strUsage
+= HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT
));
489 strUsage
+= HelpMessageOpt("-blockmaxsize=<n>", strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE
));
490 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
)));
492 strUsage
+= HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
494 strUsage
+= HelpMessageGroup(_("RPC server options:"));
495 strUsage
+= HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
496 strUsage
+= HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE
));
497 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)"));
498 strUsage
+= HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
499 strUsage
+= HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
500 strUsage
+= HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
501 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"));
502 strUsage
+= HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams
->RPCPort(), testnetBaseParams
->RPCPort()));
503 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"));
504 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
));
505 strUsage
+= HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS
));
507 strUsage
+= HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE
));
508 strUsage
+= HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT
));
514 std::string
LicenseInfo()
516 const std::string URL_SOURCE_CODE
= "<https://github.com/bitcoin/bitcoin>";
517 const std::string URL_WEBSITE
= "<https://bitcoincore.org>";
519 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR
) + " ") + "\n" +
521 strprintf(_("Please contribute if you find %s useful. "
522 "Visit %s for further information about the software."),
523 PACKAGE_NAME
, URL_WEBSITE
) +
525 strprintf(_("The source code is available from %s."),
529 _("This is experimental software.") + "\n" +
530 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
532 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>") +
536 static void BlockNotifyCallback(bool initialSync
, const CBlockIndex
*pBlockIndex
)
538 if (initialSync
|| !pBlockIndex
)
541 std::string strCmd
= gArgs
.GetArg("-blocknotify", "");
543 boost::replace_all(strCmd
, "%s", pBlockIndex
->GetBlockHash().GetHex());
544 boost::thread
t(runCommand
, strCmd
); // thread runs free
547 static bool fHaveGenesis
= false;
548 static boost::mutex cs_GenesisWait
;
549 static CConditionVariable condvar_GenesisWait
;
551 static void BlockNotifyGenesisWait(bool, const CBlockIndex
*pBlockIndex
)
553 if (pBlockIndex
!= nullptr) {
555 boost::unique_lock
<boost::mutex
> lock_GenesisWait(cs_GenesisWait
);
558 condvar_GenesisWait
.notify_all();
565 assert(fImporting
== false);
570 assert(fImporting
== true);
576 // If we're using -prune with -reindex, then delete block files that will be ignored by the
577 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
578 // is missing, do the same here to delete any later block files after a gap. Also delete all
579 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
580 // is in sync with what's actually on disk by the time we start downloading, so that pruning
582 void CleanupBlockRevFiles()
584 std::map
<std::string
, fs::path
> mapBlockFiles
;
586 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
587 // Remove the rev files immediately and insert the blk file paths into an
588 // ordered map keyed by block file index.
589 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
590 fs::path blocksdir
= GetDataDir() / "blocks";
591 for (fs::directory_iterator
it(blocksdir
); it
!= fs::directory_iterator(); it
++) {
592 if (is_regular_file(*it
) &&
593 it
->path().filename().string().length() == 12 &&
594 it
->path().filename().string().substr(8,4) == ".dat")
596 if (it
->path().filename().string().substr(0,3) == "blk")
597 mapBlockFiles
[it
->path().filename().string().substr(3,5)] = it
->path();
598 else if (it
->path().filename().string().substr(0,3) == "rev")
603 // Remove all block files that aren't part of a contiguous set starting at
604 // zero by walking the ordered map (keys are block file indices) by
605 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
606 // start removing block files.
607 int nContigCounter
= 0;
608 for (const std::pair
<std::string
, fs::path
>& item
: mapBlockFiles
) {
609 if (atoi(item
.first
) == nContigCounter
) {
617 void ThreadImport(std::vector
<fs::path
> vImportFiles
)
619 const CChainParams
& chainparams
= Params();
620 RenameThread("bitcoin-loadblk");
629 CDiskBlockPos
pos(nFile
, 0);
630 if (!fs::exists(GetBlockPosFilename(pos
, "blk")))
631 break; // No block files left to reindex
632 FILE *file
= OpenBlockFile(pos
, true);
634 break; // This error is logged in OpenBlockFile
635 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile
);
636 LoadExternalBlockFile(chainparams
, file
, &pos
);
639 pblocktree
->WriteReindexing(false);
641 LogPrintf("Reindexing finished\n");
642 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
643 LoadGenesisBlock(chainparams
);
646 // hardcoded $DATADIR/bootstrap.dat
647 fs::path pathBootstrap
= GetDataDir() / "bootstrap.dat";
648 if (fs::exists(pathBootstrap
)) {
649 FILE *file
= fsbridge::fopen(pathBootstrap
, "rb");
651 fs::path pathBootstrapOld
= GetDataDir() / "bootstrap.dat.old";
652 LogPrintf("Importing bootstrap.dat...\n");
653 LoadExternalBlockFile(chainparams
, file
);
654 RenameOver(pathBootstrap
, pathBootstrapOld
);
656 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap
.string());
661 for (const fs::path
& path
: vImportFiles
) {
662 FILE *file
= fsbridge::fopen(path
, "rb");
664 LogPrintf("Importing blocks file %s...\n", path
.string());
665 LoadExternalBlockFile(chainparams
, file
);
667 LogPrintf("Warning: Could not open blocks file %s\n", path
.string());
671 // scan for better chains in the block chain database, that are not yet connected in the active best chain
672 CValidationState state
;
673 if (!ActivateBestChain(state
, chainparams
)) {
674 LogPrintf("Failed to connect best block");
678 if (gArgs
.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT
)) {
679 LogPrintf("Stopping after block import\n");
682 } // End scope of CImportingNow
683 if (gArgs
.GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL
)) {
685 fDumpMempoolLater
= !fRequestShutdown
;
690 * Ensure that Bitcoin is running in a usable environment with all
691 * necessary library support.
693 bool InitSanityCheck(void)
695 if(!ECC_InitSanityCheck()) {
696 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
700 if (!glibc_sanity_test() || !glibcxx_sanity_test())
703 if (!Random_SanityCheck()) {
704 InitError("OS cryptographic RNG sanity check failure. Aborting.");
711 bool AppInitServers(boost::thread_group
& threadGroup
)
713 RPCServer::OnStarted(&OnRPCStarted
);
714 RPCServer::OnStopped(&OnRPCStopped
);
715 if (!InitHTTPServer())
721 if (gArgs
.GetBoolArg("-rest", DEFAULT_REST_ENABLE
) && !StartREST())
723 if (!StartHTTPServer())
728 // Parameter interaction based on rules
729 void InitParameterInteraction()
731 // when specifying an explicit binding address, you want to listen on it
732 // even when -connect or -proxy is specified
733 if (gArgs
.IsArgSet("-bind")) {
734 if (gArgs
.SoftSetBoolArg("-listen", true))
735 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__
);
737 if (gArgs
.IsArgSet("-whitebind")) {
738 if (gArgs
.SoftSetBoolArg("-listen", true))
739 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__
);
742 if (gArgs
.IsArgSet("-connect")) {
743 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
744 if (gArgs
.SoftSetBoolArg("-dnsseed", false))
745 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__
);
746 if (gArgs
.SoftSetBoolArg("-listen", false))
747 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__
);
750 if (gArgs
.IsArgSet("-proxy")) {
751 // to protect privacy, do not listen by default if a default proxy server is specified
752 if (gArgs
.SoftSetBoolArg("-listen", false))
753 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__
);
754 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
755 // to listen locally, so don't rely on this happening through -listen below.
756 if (gArgs
.SoftSetBoolArg("-upnp", false))
757 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__
);
758 // to protect privacy, do not discover addresses by default
759 if (gArgs
.SoftSetBoolArg("-discover", false))
760 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__
);
763 if (!gArgs
.GetBoolArg("-listen", DEFAULT_LISTEN
)) {
764 // do not map ports or try to retrieve public IP when not listening (pointless)
765 if (gArgs
.SoftSetBoolArg("-upnp", false))
766 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__
);
767 if (gArgs
.SoftSetBoolArg("-discover", false))
768 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__
);
769 if (gArgs
.SoftSetBoolArg("-listenonion", false))
770 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__
);
773 if (gArgs
.IsArgSet("-externalip")) {
774 // if an explicit public IP is specified, do not try to find others
775 if (gArgs
.SoftSetBoolArg("-discover", false))
776 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__
);
779 // disable whitelistrelay in blocksonly mode
780 if (gArgs
.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY
)) {
781 if (gArgs
.SoftSetBoolArg("-whitelistrelay", false))
782 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__
);
785 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
786 if (gArgs
.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY
)) {
787 if (gArgs
.SoftSetBoolArg("-whitelistrelay", true))
788 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__
);
792 static std::string
ResolveErrMsg(const char * const optname
, const std::string
& strBind
)
794 return strprintf(_("Cannot resolve -%s address: '%s'"), optname
, strBind
);
799 fPrintToConsole
= gArgs
.GetBoolArg("-printtoconsole", false);
800 fLogTimestamps
= gArgs
.GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS
);
801 fLogTimeMicros
= gArgs
.GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS
);
802 fLogIPs
= gArgs
.GetBoolArg("-logips", DEFAULT_LOGIPS
);
804 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
805 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
808 namespace { // Variables internal to initialization process only
810 ServiceFlags nRelevantServices
= NODE_NETWORK
;
812 int nUserMaxConnections
;
814 ServiceFlags nLocalServices
= NODE_NETWORK
;
818 [[noreturn
]] static void new_handler_terminate()
820 // Rather than throwing std::bad-alloc if allocation fails, terminate
821 // immediately to (try to) avoid chain corruption.
822 // Since LogPrintf may itself allocate memory, set the handler directly
823 // to terminate first.
824 std::set_new_handler(std::terminate
);
825 LogPrintf("Error: Out of memory. Terminating.\n");
827 // The log was successful, terminate now.
831 bool AppInitBasicSetup()
833 // ********************************************************* Step 1: setup
835 // Turn off Microsoft heap dump noise
836 _CrtSetReportMode(_CRT_WARN
, _CRTDBG_MODE_FILE
);
837 _CrtSetReportFile(_CRT_WARN
, CreateFileA("NUL", GENERIC_WRITE
, 0, nullptr, OPEN_EXISTING
, 0, 0));
838 // Disable confusing "helpful" text message on abort, Ctrl-C
839 _set_abort_behavior(0, _WRITE_ABORT_MSG
| _CALL_REPORTFAULT
);
842 // Enable Data Execution Prevention (DEP)
843 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
844 // A failure is non-critical and needs no further attention!
845 #ifndef PROCESS_DEP_ENABLE
846 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
847 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
848 #define PROCESS_DEP_ENABLE 0x00000001
850 typedef BOOL (WINAPI
*PSETPROCDEPPOL
)(DWORD
);
851 PSETPROCDEPPOL setProcDEPPol
= (PSETPROCDEPPOL
)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
852 if (setProcDEPPol
!= nullptr) setProcDEPPol(PROCESS_DEP_ENABLE
);
855 if (!SetupNetworking())
856 return InitError("Initializing networking failed");
859 if (!gArgs
.GetBoolArg("-sysperms", false)) {
863 // Clean shutdown on SIGTERM
864 registerSignalHandler(SIGTERM
, HandleSIGTERM
);
865 registerSignalHandler(SIGINT
, HandleSIGTERM
);
867 // Reopen debug.log on SIGHUP
868 registerSignalHandler(SIGHUP
, HandleSIGHUP
);
870 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
871 signal(SIGPIPE
, SIG_IGN
);
874 std::set_new_handler(new_handler_terminate
);
879 bool AppInitParameterInteraction()
881 const CChainParams
& chainparams
= Params();
882 // ********************************************************* Step 2: parameter interactions
884 // also see: InitParameterInteraction()
886 // if using block pruning, then disallow txindex
887 if (gArgs
.GetArg("-prune", 0)) {
888 if (gArgs
.GetBoolArg("-txindex", DEFAULT_TXINDEX
))
889 return InitError(_("Prune mode is incompatible with -txindex."));
892 // -bind and -whitebind can't be set when not listening
893 size_t nUserBind
= gArgs
.GetArgs("-bind").size() + gArgs
.GetArgs("-whitebind").size();
894 if (nUserBind
!= 0 && !gArgs
.GetBoolArg("-listen", DEFAULT_LISTEN
)) {
895 return InitError("Cannot set -bind or -whitebind together with -listen=0");
898 // Make sure enough file descriptors are available
899 int nBind
= std::max(nUserBind
, size_t(1));
900 nUserMaxConnections
= gArgs
.GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS
);
901 nMaxConnections
= std::max(nUserMaxConnections
, 0);
903 // Trim requested connection counts, to fit into system limitations
904 nMaxConnections
= std::max(std::min(nMaxConnections
, (int)(FD_SETSIZE
- nBind
- MIN_CORE_FILEDESCRIPTORS
- MAX_ADDNODE_CONNECTIONS
)), 0);
905 nFD
= RaiseFileDescriptorLimit(nMaxConnections
+ MIN_CORE_FILEDESCRIPTORS
+ MAX_ADDNODE_CONNECTIONS
);
906 if (nFD
< MIN_CORE_FILEDESCRIPTORS
)
907 return InitError(_("Not enough file descriptors available."));
908 nMaxConnections
= std::min(nFD
- MIN_CORE_FILEDESCRIPTORS
- MAX_ADDNODE_CONNECTIONS
, nMaxConnections
);
910 if (nMaxConnections
< nUserMaxConnections
)
911 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections
, nMaxConnections
));
913 // ********************************************************* Step 3: parameter-to-internal-flags
914 if (gArgs
.IsArgSet("-debug")) {
915 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
916 const std::vector
<std::string
> categories
= gArgs
.GetArgs("-debug");
918 if (find(categories
.begin(), categories
.end(), std::string("0")) == categories
.end()) {
919 for (const auto& cat
: categories
) {
921 if (!GetLogCategory(&flag
, &cat
)) {
922 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat
));
925 logCategories
|= flag
;
930 // Now remove the logging categories which were explicitly excluded
931 for (const std::string
& cat
: gArgs
.GetArgs("-debugexclude")) {
933 if (!GetLogCategory(&flag
, &cat
)) {
934 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat
));
937 logCategories
&= ~flag
;
940 // Check for -debugnet
941 if (gArgs
.GetBoolArg("-debugnet", false))
942 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
943 // Check for -socks - as this is a privacy risk to continue, exit here
944 if (gArgs
.IsArgSet("-socks"))
945 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
946 // Check for -tor - as this is a privacy risk to continue, exit here
947 if (gArgs
.GetBoolArg("-tor", false))
948 return InitError(_("Unsupported argument -tor found, use -onion."));
950 if (gArgs
.GetBoolArg("-benchmark", false))
951 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
953 if (gArgs
.GetBoolArg("-whitelistalwaysrelay", false))
954 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
956 if (gArgs
.IsArgSet("-blockminsize"))
957 InitWarning("Unsupported argument -blockminsize ignored.");
959 // Checkmempool and checkblockindex default to true in regtest mode
960 int ratio
= std::min
<int>(std::max
<int>(gArgs
.GetArg("-checkmempool", chainparams
.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
962 mempool
.setSanityCheck(1.0 / ratio
);
964 fCheckBlockIndex
= gArgs
.GetBoolArg("-checkblockindex", chainparams
.DefaultConsistencyChecks());
965 fCheckpointsEnabled
= gArgs
.GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED
);
967 hashAssumeValid
= uint256S(gArgs
.GetArg("-assumevalid", chainparams
.GetConsensus().defaultAssumeValid
.GetHex()));
968 if (!hashAssumeValid
.IsNull())
969 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid
.GetHex());
971 LogPrintf("Validating signatures for all blocks.\n");
974 int64_t nMempoolSizeMax
= gArgs
.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE
) * 1000000;
975 int64_t nMempoolSizeMin
= gArgs
.GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT
) * 1000 * 40;
976 if (nMempoolSizeMax
< 0 || nMempoolSizeMax
< nMempoolSizeMin
)
977 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin
/ 1000000.0)));
978 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
979 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
980 if (gArgs
.IsArgSet("-incrementalrelayfee"))
983 if (!ParseMoney(gArgs
.GetArg("-incrementalrelayfee", ""), n
))
984 return InitError(AmountErrMsg("incrementalrelayfee", gArgs
.GetArg("-incrementalrelayfee", "")));
985 incrementalRelayFee
= CFeeRate(n
);
988 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
989 nScriptCheckThreads
= gArgs
.GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS
);
990 if (nScriptCheckThreads
<= 0)
991 nScriptCheckThreads
+= GetNumCores();
992 if (nScriptCheckThreads
<= 1)
993 nScriptCheckThreads
= 0;
994 else if (nScriptCheckThreads
> MAX_SCRIPTCHECK_THREADS
)
995 nScriptCheckThreads
= MAX_SCRIPTCHECK_THREADS
;
997 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
998 int64_t nPruneArg
= gArgs
.GetArg("-prune", 0);
1000 return InitError(_("Prune cannot be configured with a negative value."));
1002 nPruneTarget
= (uint64_t) nPruneArg
* 1024 * 1024;
1003 if (nPruneArg
== 1) { // manual pruning: -prune=1
1004 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1005 nPruneTarget
= std::numeric_limits
<uint64_t>::max();
1007 } else if (nPruneTarget
) {
1008 if (nPruneTarget
< MIN_DISK_SPACE_FOR_BLOCK_FILES
) {
1009 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES
/ 1024 / 1024));
1011 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget
/ 1024 / 1024);
1015 RegisterAllCoreRPCCommands(tableRPC
);
1016 #ifdef ENABLE_WALLET
1017 RegisterWalletRPCCommands(tableRPC
);
1020 nConnectTimeout
= gArgs
.GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT
);
1021 if (nConnectTimeout
<= 0)
1022 nConnectTimeout
= DEFAULT_CONNECT_TIMEOUT
;
1024 if (gArgs
.IsArgSet("-minrelaytxfee")) {
1026 if (!ParseMoney(gArgs
.GetArg("-minrelaytxfee", ""), n
)) {
1027 return InitError(AmountErrMsg("minrelaytxfee", gArgs
.GetArg("-minrelaytxfee", "")));
1029 // High fee check is done afterward in WalletParameterInteraction()
1030 ::minRelayTxFee
= CFeeRate(n
);
1031 } else if (incrementalRelayFee
> ::minRelayTxFee
) {
1032 // Allow only setting incrementalRelayFee to control both
1033 ::minRelayTxFee
= incrementalRelayFee
;
1034 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee
.ToString());
1037 // Sanity check argument for min fee for including tx in block
1038 // TODO: Harmonize which arguments need sanity checking and where that happens
1039 if (gArgs
.IsArgSet("-blockmintxfee"))
1042 if (!ParseMoney(gArgs
.GetArg("-blockmintxfee", ""), n
))
1043 return InitError(AmountErrMsg("blockmintxfee", gArgs
.GetArg("-blockmintxfee", "")));
1046 // Feerate used to define dust. Shouldn't be changed lightly as old
1047 // implementations may inadvertently create non-standard transactions
1048 if (gArgs
.IsArgSet("-dustrelayfee"))
1051 if (!ParseMoney(gArgs
.GetArg("-dustrelayfee", ""), n
) || 0 == n
)
1052 return InitError(AmountErrMsg("dustrelayfee", gArgs
.GetArg("-dustrelayfee", "")));
1053 dustRelayFee
= CFeeRate(n
);
1056 fRequireStandard
= !gArgs
.GetBoolArg("-acceptnonstdtxn", !chainparams
.RequireStandard());
1057 if (chainparams
.RequireStandard() && !fRequireStandard
)
1058 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams
.NetworkIDString()));
1059 nBytesPerSigOp
= gArgs
.GetArg("-bytespersigop", nBytesPerSigOp
);
1061 #ifdef ENABLE_WALLET
1062 if (!WalletParameterInteraction())
1066 fIsBareMultisigStd
= gArgs
.GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG
);
1067 fAcceptDatacarrier
= gArgs
.GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER
);
1068 nMaxDatacarrierBytes
= gArgs
.GetArg("-datacarriersize", nMaxDatacarrierBytes
);
1070 // Option to startup with mocktime set (used for regression testing):
1071 SetMockTime(gArgs
.GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1073 if (gArgs
.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS
))
1074 nLocalServices
= ServiceFlags(nLocalServices
| NODE_BLOOM
);
1076 if (gArgs
.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION
) < 0)
1077 return InitError("rpcserialversion must be non-negative.");
1079 if (gArgs
.GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION
) > 1)
1080 return InitError("unknown rpcserialversion requested.");
1082 nMaxTipAge
= gArgs
.GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE
);
1084 fEnableReplacement
= gArgs
.GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT
);
1085 if ((!fEnableReplacement
) && gArgs
.IsArgSet("-mempoolreplacement")) {
1086 // Minimal effort at forwards compatibility
1087 std::string strReplacementModeList
= gArgs
.GetArg("-mempoolreplacement", ""); // default is impossible
1088 std::vector
<std::string
> vstrReplacementModes
;
1089 boost::split(vstrReplacementModes
, strReplacementModeList
, boost::is_any_of(","));
1090 fEnableReplacement
= (std::find(vstrReplacementModes
.begin(), vstrReplacementModes
.end(), "fee") != vstrReplacementModes
.end());
1093 if (gArgs
.IsArgSet("-vbparams")) {
1094 // Allow overriding version bits parameters for testing
1095 if (!chainparams
.MineBlocksOnDemand()) {
1096 return InitError("Version bits parameters may only be overridden on regtest.");
1098 for (const std::string
& strDeployment
: gArgs
.GetArgs("-vbparams")) {
1099 std::vector
<std::string
> vDeploymentParams
;
1100 boost::split(vDeploymentParams
, strDeployment
, boost::is_any_of(":"));
1101 if (vDeploymentParams
.size() != 3) {
1102 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1104 int64_t nStartTime
, nTimeout
;
1105 if (!ParseInt64(vDeploymentParams
[1], &nStartTime
)) {
1106 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams
[1]));
1108 if (!ParseInt64(vDeploymentParams
[2], &nTimeout
)) {
1109 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams
[2]));
1112 for (int j
=0; j
<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS
; ++j
)
1114 if (vDeploymentParams
[0].compare(VersionBitsDeploymentInfo
[j
].name
) == 0) {
1115 UpdateVersionBitsParameters(Consensus::DeploymentPos(j
), nStartTime
, nTimeout
);
1117 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams
[0], nStartTime
, nTimeout
);
1122 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams
[0]));
1129 static bool LockDataDirectory(bool probeOnly
)
1131 std::string strDataDir
= GetDataDir().string();
1133 // Make sure only a single Bitcoin process is using the data directory.
1134 fs::path pathLockFile
= GetDataDir() / ".lock";
1135 FILE* file
= fsbridge::fopen(pathLockFile
, "a"); // empty lock file; created if it doesn't exist.
1136 if (file
) fclose(file
);
1139 static boost::interprocess::file_lock
lock(pathLockFile
.string().c_str());
1140 if (!lock
.try_lock()) {
1141 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir
, _(PACKAGE_NAME
)));
1146 } catch(const boost::interprocess::interprocess_exception
& e
) {
1147 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir
, _(PACKAGE_NAME
), e
.what()));
1152 bool AppInitSanityChecks()
1154 // ********************************************************* Step 4: sanity checks
1156 // Initialize elliptic curve code
1157 std::string sha256_algo
= SHA256AutoDetect();
1158 LogPrintf("Using the '%s' SHA256 implementation\n", sha256_algo
);
1161 globalVerifyHandle
.reset(new ECCVerifyHandle());
1164 if (!InitSanityCheck())
1165 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME
)));
1167 // Probe the data directory lock to give an early error message, if possible
1168 // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1169 // and a fork will cause weird behavior to it.
1170 return LockDataDirectory(true);
1173 bool AppInitLockDataDirectory()
1175 // After daemonization get the data directory lock again and hold on to it until exit
1176 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1177 // will at most make us exit without printing a message to console.
1178 if (!LockDataDirectory(false)) {
1179 // Detailed error printed inside LockDataDirectory
1185 bool AppInitMain(boost::thread_group
& threadGroup
, CScheduler
& scheduler
)
1187 const CChainParams
& chainparams
= Params();
1188 // ********************************************************* Step 4a: application initialization
1190 CreatePidFile(GetPidFile(), getpid());
1192 if (gArgs
.GetBoolArg("-shrinkdebugfile", logCategories
== BCLog::NONE
)) {
1193 // Do this first since it both loads a bunch of debug.log into memory,
1194 // and because this needs to happen before any other debug.log printing
1198 if (fPrintToDebugLog
)
1201 if (!fLogTimestamps
)
1202 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1203 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1204 LogPrintf("Using data directory %s\n", GetDataDir().string());
1205 LogPrintf("Using config file %s\n", GetConfigFile(gArgs
.GetArg("-conf", BITCOIN_CONF_FILENAME
)).string());
1206 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections
, nFD
);
1208 InitSignatureCache();
1209 InitScriptExecutionCache();
1211 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads
);
1212 if (nScriptCheckThreads
) {
1213 for (int i
=0; i
<nScriptCheckThreads
-1; i
++)
1214 threadGroup
.create_thread(&ThreadScriptCheck
);
1217 // Start the lightweight task scheduler thread
1218 CScheduler::Function serviceLoop
= boost::bind(&CScheduler::serviceQueue
, &scheduler
);
1219 threadGroup
.create_thread(boost::bind(&TraceThread
<CScheduler::Function
>, "scheduler", serviceLoop
));
1221 GetMainSignals().RegisterBackgroundSignalScheduler(scheduler
);
1223 /* Start the RPC server already. It will be started in "warmup" mode
1224 * and not really process calls already (but it will signify connections
1225 * that the server is there and will be ready later). Warmup mode will
1226 * be disabled when initialisation is finished.
1228 if (gArgs
.GetBoolArg("-server", false))
1230 uiInterface
.InitMessage
.connect(SetRPCWarmupStatus
);
1231 if (!AppInitServers(threadGroup
))
1232 return InitError(_("Unable to start HTTP server. See debug log for details."));
1237 // ********************************************************* Step 5: verify wallet database integrity
1238 #ifdef ENABLE_WALLET
1239 if (!WalletVerify())
1242 // ********************************************************* Step 6: network initialization
1243 // Note that we absolutely cannot open any actual connections
1244 // until the very end ("start node") as the UTXO/block state
1245 // is not yet setup and may end up being set up twice if we
1246 // need to reindex later.
1249 g_connman
= std::unique_ptr
<CConnman
>(new CConnman(GetRand(std::numeric_limits
<uint64_t>::max()), GetRand(std::numeric_limits
<uint64_t>::max())));
1250 CConnman
& connman
= *g_connman
;
1252 peerLogic
.reset(new PeerLogicValidation(&connman
));
1253 RegisterValidationInterface(peerLogic
.get());
1254 RegisterNodeSignals(GetNodeSignals());
1256 // sanitize comments per BIP-0014, format user agent and check total size
1257 std::vector
<std::string
> uacomments
;
1258 for (const std::string
& cmt
: gArgs
.GetArgs("-uacomment")) {
1259 if (cmt
!= SanitizeString(cmt
, SAFE_CHARS_UA_COMMENT
))
1260 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt
));
1261 uacomments
.push_back(cmt
);
1263 strSubVersion
= FormatSubVersion(CLIENT_NAME
, CLIENT_VERSION
, uacomments
);
1264 if (strSubVersion
.size() > MAX_SUBVERSION_LENGTH
) {
1265 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1266 strSubVersion
.size(), MAX_SUBVERSION_LENGTH
));
1269 if (gArgs
.IsArgSet("-onlynet")) {
1270 std::set
<enum Network
> nets
;
1271 for (const std::string
& snet
: gArgs
.GetArgs("-onlynet")) {
1272 enum Network net
= ParseNetwork(snet
);
1273 if (net
== NET_UNROUTABLE
)
1274 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet
));
1277 for (int n
= 0; n
< NET_MAX
; n
++) {
1278 enum Network net
= (enum Network
)n
;
1279 if (!nets
.count(net
))
1284 // Check for host lookup allowed before parsing any network related parameters
1285 fNameLookup
= gArgs
.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP
);
1287 bool proxyRandomize
= gArgs
.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE
);
1288 // -proxy sets a proxy for all outgoing network traffic
1289 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1290 std::string proxyArg
= gArgs
.GetArg("-proxy", "");
1291 SetLimited(NET_TOR
);
1292 if (proxyArg
!= "" && proxyArg
!= "0") {
1294 if (!Lookup(proxyArg
.c_str(), proxyAddr
, 9050, fNameLookup
)) {
1295 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg
));
1298 proxyType addrProxy
= proxyType(proxyAddr
, proxyRandomize
);
1299 if (!addrProxy
.IsValid())
1300 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg
));
1302 SetProxy(NET_IPV4
, addrProxy
);
1303 SetProxy(NET_IPV6
, addrProxy
);
1304 SetProxy(NET_TOR
, addrProxy
);
1305 SetNameProxy(addrProxy
);
1306 SetLimited(NET_TOR
, false); // by default, -proxy sets onion as reachable, unless -noonion later
1309 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1310 // -noonion (or -onion=0) disables connecting to .onion entirely
1311 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1312 std::string onionArg
= gArgs
.GetArg("-onion", "");
1313 if (onionArg
!= "") {
1314 if (onionArg
== "0") { // Handle -noonion/-onion=0
1315 SetLimited(NET_TOR
); // set onions as unreachable
1317 CService onionProxy
;
1318 if (!Lookup(onionArg
.c_str(), onionProxy
, 9050, fNameLookup
)) {
1319 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg
));
1321 proxyType addrOnion
= proxyType(onionProxy
, proxyRandomize
);
1322 if (!addrOnion
.IsValid())
1323 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg
));
1324 SetProxy(NET_TOR
, addrOnion
);
1325 SetLimited(NET_TOR
, false);
1329 // see Step 2: parameter interactions for more information about these
1330 fListen
= gArgs
.GetBoolArg("-listen", DEFAULT_LISTEN
);
1331 fDiscover
= gArgs
.GetBoolArg("-discover", true);
1332 fRelayTxes
= !gArgs
.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY
);
1334 for (const std::string
& strAddr
: gArgs
.GetArgs("-externalip")) {
1336 if (Lookup(strAddr
.c_str(), addrLocal
, GetListenPort(), fNameLookup
) && addrLocal
.IsValid())
1337 AddLocal(addrLocal
, LOCAL_MANUAL
);
1339 return InitError(ResolveErrMsg("externalip", strAddr
));
1343 pzmqNotificationInterface
= CZMQNotificationInterface::Create();
1345 if (pzmqNotificationInterface
) {
1346 RegisterValidationInterface(pzmqNotificationInterface
);
1349 uint64_t nMaxOutboundLimit
= 0; //unlimited unless -maxuploadtarget is set
1350 uint64_t nMaxOutboundTimeframe
= MAX_UPLOAD_TIMEFRAME
;
1352 if (gArgs
.IsArgSet("-maxuploadtarget")) {
1353 nMaxOutboundLimit
= gArgs
.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET
)*1024*1024;
1356 // ********************************************************* Step 7: load block chain
1358 fReindex
= gArgs
.GetBoolArg("-reindex", false);
1359 bool fReindexChainState
= gArgs
.GetBoolArg("-reindex-chainstate", false);
1361 // cache size calculations
1362 int64_t nTotalCache
= (gArgs
.GetArg("-dbcache", nDefaultDbCache
) << 20);
1363 nTotalCache
= std::max(nTotalCache
, nMinDbCache
<< 20); // total cache cannot be less than nMinDbCache
1364 nTotalCache
= std::min(nTotalCache
, nMaxDbCache
<< 20); // total cache cannot be greater than nMaxDbcache
1365 int64_t nBlockTreeDBCache
= nTotalCache
/ 8;
1366 nBlockTreeDBCache
= std::min(nBlockTreeDBCache
, (gArgs
.GetBoolArg("-txindex", DEFAULT_TXINDEX
) ? nMaxBlockDBAndTxIndexCache
: nMaxBlockDBCache
) << 20);
1367 nTotalCache
-= nBlockTreeDBCache
;
1368 int64_t nCoinDBCache
= std::min(nTotalCache
/ 2, (nTotalCache
/ 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1369 nCoinDBCache
= std::min(nCoinDBCache
, nMaxCoinsDBCache
<< 20); // cap total coins db cache
1370 nTotalCache
-= nCoinDBCache
;
1371 nCoinCacheUsage
= nTotalCache
; // the rest goes to in-memory cache
1372 int64_t nMempoolSizeMax
= gArgs
.GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE
) * 1000000;
1373 LogPrintf("Cache configuration:\n");
1374 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache
* (1.0 / 1024 / 1024));
1375 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache
* (1.0 / 1024 / 1024));
1376 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));
1378 bool fLoaded
= false;
1379 while (!fLoaded
&& !fRequestShutdown
) {
1380 bool fReset
= fReindex
;
1381 std::string strLoadError
;
1383 uiInterface
.InitMessage(_("Loading block index..."));
1385 nStart
= GetTimeMillis();
1390 delete pcoinsdbview
;
1391 delete pcoinscatcher
;
1394 pblocktree
= new CBlockTreeDB(nBlockTreeDBCache
, false, fReset
);
1397 pblocktree
->WriteReindexing(true);
1398 //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
1400 CleanupBlockRevFiles();
1403 if (fRequestShutdown
) break;
1405 // LoadBlockIndex will load fTxIndex from the db, or set it if
1406 // we're reindexing. It will also load fHavePruned if we've
1407 // ever removed a block file from disk.
1408 // Note that it also sets fReindex based on the disk flag!
1409 // From here on out fReindex and fReset mean something different!
1410 if (!LoadBlockIndex(chainparams
)) {
1411 strLoadError
= _("Error loading block database");
1415 // If the loaded chain has a wrong genesis, bail out immediately
1416 // (we're likely using a testnet datadir, or the other way around).
1417 if (!mapBlockIndex
.empty() && mapBlockIndex
.count(chainparams
.GetConsensus().hashGenesisBlock
) == 0)
1418 return InitError(_("Incorrect or no genesis block found. Wrong datadir for network?"));
1420 // Check for changed -txindex state
1421 if (fTxIndex
!= gArgs
.GetBoolArg("-txindex", DEFAULT_TXINDEX
)) {
1422 strLoadError
= _("You need to rebuild the database using -reindex to change -txindex");
1426 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1427 // in the past, but is now trying to run unpruned.
1428 if (fHavePruned
&& !fPruneMode
) {
1429 strLoadError
= _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1433 // At this point blocktree args are consistent with what's on disk.
1434 // If we're not mid-reindex (based on disk + args), add a genesis block on disk
1435 // (otherwise we use the one already on disk).
1436 // This is called again in ThreadImport after the reindex completes.
1437 if (!fReindex
&& !LoadGenesisBlock(chainparams
)) {
1438 strLoadError
= _("Error initializing block database");
1442 // At this point we're either in reindex or we've loaded a useful
1443 // block tree into mapBlockIndex!
1445 pcoinsdbview
= new CCoinsViewDB(nCoinDBCache
, false, fReset
|| fReindexChainState
);
1446 pcoinscatcher
= new CCoinsViewErrorCatcher(pcoinsdbview
);
1448 // If necessary, upgrade from older database format.
1449 // This is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1450 if (!pcoinsdbview
->Upgrade()) {
1451 strLoadError
= _("Error upgrading chainstate database");
1455 // ReplayBlocks is a no-op if we cleared the coinsviewdb with -reindex or -reindex-chainstate
1456 if (!ReplayBlocks(chainparams
, pcoinsdbview
)) {
1457 strLoadError
= _("Unable to replay blocks. You will need to rebuild the database using -reindex-chainstate.");
1461 // The on-disk coinsdb is now in a good state, create the cache
1462 pcoinsTip
= new CCoinsViewCache(pcoinscatcher
);
1464 bool is_coinsview_empty
= fReset
|| fReindexChainState
|| pcoinsTip
->GetBestBlock().IsNull();
1465 if (!is_coinsview_empty
) {
1466 // LoadChainTip sets chainActive based on pcoinsTip's best block
1467 if (!LoadChainTip(chainparams
)) {
1468 strLoadError
= _("Error initializing block database");
1471 assert(chainActive
.Tip() != nullptr);
1475 // Note that RewindBlockIndex MUST run even if we're about to -reindex-chainstate.
1476 // It both disconnects blocks based on chainActive, and drops block data in
1477 // mapBlockIndex based on lack of available witness data.
1478 uiInterface
.InitMessage(_("Rewinding blocks..."));
1479 if (!RewindBlockIndex(chainparams
)) {
1480 strLoadError
= _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1485 if (!is_coinsview_empty
) {
1486 uiInterface
.InitMessage(_("Verifying blocks..."));
1487 if (fHavePruned
&& gArgs
.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS
) > MIN_BLOCKS_TO_KEEP
) {
1488 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1489 MIN_BLOCKS_TO_KEEP
);
1494 CBlockIndex
* tip
= chainActive
.Tip();
1495 RPCNotifyBlockChange(true, tip
);
1496 if (tip
&& tip
->nTime
> GetAdjustedTime() + 2 * 60 * 60) {
1497 strLoadError
= _("The block database contains a block which appears to be from the future. "
1498 "This may be due to your computer's date and time being set incorrectly. "
1499 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1504 if (!CVerifyDB().VerifyDB(chainparams
, pcoinsdbview
, gArgs
.GetArg("-checklevel", DEFAULT_CHECKLEVEL
),
1505 gArgs
.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS
))) {
1506 strLoadError
= _("Corrupted block database detected");
1510 } catch (const std::exception
& e
) {
1511 LogPrintf("%s\n", e
.what());
1512 strLoadError
= _("Error opening block database");
1519 if (!fLoaded
&& !fRequestShutdown
) {
1520 // first suggest a reindex
1522 bool fRet
= uiInterface
.ThreadSafeQuestion(
1523 strLoadError
+ ".\n\n" + _("Do you want to rebuild the block database now?"),
1524 strLoadError
+ ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1525 "", CClientUIInterface::MSG_ERROR
| CClientUIInterface::BTN_ABORT
);
1528 fRequestShutdown
= false;
1530 LogPrintf("Aborted block database rebuild. Exiting.\n");
1534 return InitError(strLoadError
);
1539 // As LoadBlockIndex can take several minutes, it's possible the user
1540 // requested to kill the GUI during the last operation. If so, exit.
1541 // As the program has not fully started yet, Shutdown() is possibly overkill.
1542 if (fRequestShutdown
)
1544 LogPrintf("Shutdown requested. Exiting.\n");
1548 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart
);
1551 fs::path est_path
= GetDataDir() / FEE_ESTIMATES_FILENAME
;
1552 CAutoFile
est_filein(fsbridge::fopen(est_path
, "rb"), SER_DISK
, CLIENT_VERSION
);
1553 // Allowed to fail as this file IS missing on first startup.
1554 if (!est_filein
.IsNull())
1555 ::feeEstimator
.Read(est_filein
);
1556 fFeeEstimatesInitialized
= true;
1558 // ********************************************************* Step 8: load wallet
1559 #ifdef ENABLE_WALLET
1560 if (!InitLoadWallet())
1563 LogPrintf("No wallet support compiled in!\n");
1566 // ********************************************************* Step 9: data directory maintenance
1568 // if pruning, unset the service bit and perform the initial blockstore prune
1569 // after any wallet rescanning has taken place.
1571 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1572 nLocalServices
= ServiceFlags(nLocalServices
& ~NODE_NETWORK
);
1574 uiInterface
.InitMessage(_("Pruning blockstore..."));
1579 if (chainparams
.GetConsensus().vDeployments
[Consensus::DEPLOYMENT_SEGWIT
].nTimeout
!= 0) {
1580 // Only advertise witness capabilities if they have a reasonable start time.
1581 // This allows us to have the code merged without a defined softfork, by setting its
1583 // Note that setting NODE_WITNESS is never required: the only downside from not
1584 // doing so is that after activation, no upgraded nodes will fetch from you.
1585 nLocalServices
= ServiceFlags(nLocalServices
| NODE_WITNESS
);
1586 // Only care about others providing witness capabilities if there is a softfork
1588 nRelevantServices
= ServiceFlags(nRelevantServices
| NODE_WITNESS
);
1591 // ********************************************************* Step 10: import blocks
1593 if (!CheckDiskSpace())
1596 // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1597 // No locking, as this happens before any background thread is started.
1598 if (chainActive
.Tip() == nullptr) {
1599 uiInterface
.NotifyBlockTip
.connect(BlockNotifyGenesisWait
);
1601 fHaveGenesis
= true;
1604 if (gArgs
.IsArgSet("-blocknotify"))
1605 uiInterface
.NotifyBlockTip
.connect(BlockNotifyCallback
);
1607 std::vector
<fs::path
> vImportFiles
;
1608 for (const std::string
& strFile
: gArgs
.GetArgs("-loadblock")) {
1609 vImportFiles
.push_back(strFile
);
1612 threadGroup
.create_thread(boost::bind(&ThreadImport
, vImportFiles
));
1614 // Wait for genesis block to be processed
1616 boost::unique_lock
<boost::mutex
> lock(cs_GenesisWait
);
1617 while (!fHaveGenesis
) {
1618 condvar_GenesisWait
.wait(lock
);
1620 uiInterface
.NotifyBlockTip
.disconnect(BlockNotifyGenesisWait
);
1623 // ********************************************************* Step 11: start node
1626 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex
.size());
1627 LogPrintf("nBestHeight = %d\n", chainActive
.Height());
1628 if (gArgs
.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION
))
1629 StartTorControl(threadGroup
, scheduler
);
1631 Discover(threadGroup
);
1633 // Map ports with UPnP
1634 MapPort(gArgs
.GetBoolArg("-upnp", DEFAULT_UPNP
));
1636 CConnman::Options connOptions
;
1637 connOptions
.nLocalServices
= nLocalServices
;
1638 connOptions
.nRelevantServices
= nRelevantServices
;
1639 connOptions
.nMaxConnections
= nMaxConnections
;
1640 connOptions
.nMaxOutbound
= std::min(MAX_OUTBOUND_CONNECTIONS
, connOptions
.nMaxConnections
);
1641 connOptions
.nMaxAddnode
= MAX_ADDNODE_CONNECTIONS
;
1642 connOptions
.nMaxFeeler
= 1;
1643 connOptions
.nBestHeight
= chainActive
.Height();
1644 connOptions
.uiInterface
= &uiInterface
;
1645 connOptions
.nSendBufferMaxSize
= 1000*gArgs
.GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER
);
1646 connOptions
.nReceiveFloodSize
= 1000*gArgs
.GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER
);
1648 connOptions
.nMaxOutboundTimeframe
= nMaxOutboundTimeframe
;
1649 connOptions
.nMaxOutboundLimit
= nMaxOutboundLimit
;
1651 for (const std::string
& strBind
: gArgs
.GetArgs("-bind")) {
1653 if (!Lookup(strBind
.c_str(), addrBind
, GetListenPort(), false)) {
1654 return InitError(ResolveErrMsg("bind", strBind
));
1656 connOptions
.vBinds
.push_back(addrBind
);
1658 for (const std::string
& strBind
: gArgs
.GetArgs("-whitebind")) {
1660 if (!Lookup(strBind
.c_str(), addrBind
, 0, false)) {
1661 return InitError(ResolveErrMsg("whitebind", strBind
));
1663 if (addrBind
.GetPort() == 0) {
1664 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind
));
1666 connOptions
.vWhiteBinds
.push_back(addrBind
);
1669 for (const auto& net
: gArgs
.GetArgs("-whitelist")) {
1671 LookupSubNet(net
.c_str(), subnet
);
1672 if (!subnet
.IsValid())
1673 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net
));
1674 connOptions
.vWhitelistedRange
.push_back(subnet
);
1677 if (gArgs
.IsArgSet("-seednode")) {
1678 connOptions
.vSeedNodes
= gArgs
.GetArgs("-seednode");
1680 // Initiate outbound connections unless connect=0
1681 connOptions
.m_use_addrman_outgoing
= !gArgs
.IsArgSet("-connect");
1682 if (!connOptions
.m_use_addrman_outgoing
) {
1683 const auto connect
= gArgs
.GetArgs("-connect");
1684 if (connect
.size() != 1 || connect
[0] != "0") {
1685 connOptions
.m_specified_outgoing
= connect
;
1688 if (!connman
.Start(scheduler
, connOptions
)) {
1692 // ********************************************************* Step 12: finished
1694 SetRPCWarmupFinished();
1695 uiInterface
.InitMessage(_("Done loading"));
1697 #ifdef ENABLE_WALLET
1698 for (CWalletRef pwallet
: vpwallets
) {
1699 pwallet
->postInitProcess(scheduler
);
1703 return !fRequestShutdown
;