Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 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.
5 : :
6 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <init.h>
9 : :
10 : : #include <kernel/checks.h>
11 : :
12 : : #include <addrman.h>
13 : : #include <banman.h>
14 : : #include <blockfilter.h>
15 : : #include <chain.h>
16 : : #include <chainparams.h>
17 : : #include <chainparamsbase.h>
18 : : #include <clientversion.h>
19 : : #include <common/args.h>
20 : : #include <common/system.h>
21 : : #include <consensus/amount.h>
22 : : #include <deploymentstatus.h>
23 : : #include <hash.h>
24 : : #include <httprpc.h>
25 : : #include <httpserver.h>
26 : : #include <index/blockfilterindex.h>
27 : : #include <index/coinstatsindex.h>
28 : : #include <index/txindex.h>
29 : : #include <init/common.h>
30 : : #include <interfaces/chain.h>
31 : : #include <interfaces/init.h>
32 : : #include <interfaces/ipc.h>
33 : : #include <interfaces/mining.h>
34 : : #include <interfaces/node.h>
35 : : #include <kernel/context.h>
36 : : #include <key.h>
37 : : #include <logging.h>
38 : : #include <mapport.h>
39 : : #include <net.h>
40 : : #include <net_permissions.h>
41 : : #include <net_processing.h>
42 : : #include <netbase.h>
43 : : #include <netgroup.h>
44 : : #include <node/blockmanager_args.h>
45 : : #include <node/blockstorage.h>
46 : : #include <node/caches.h>
47 : : #include <node/chainstate.h>
48 : : #include <node/chainstatemanager_args.h>
49 : : #include <node/context.h>
50 : : #include <node/interface_ui.h>
51 : : #include <node/kernel_notifications.h>
52 : : #include <node/mempool_args.h>
53 : : #include <node/mempool_persist.h>
54 : : #include <node/mempool_persist_args.h>
55 : : #include <node/miner.h>
56 : : #include <node/peerman_args.h>
57 : : #include <policy/feerate.h>
58 : : #include <policy/fees.h>
59 : : #include <policy/fees_args.h>
60 : : #include <policy/policy.h>
61 : : #include <policy/settings.h>
62 : : #include <protocol.h>
63 : : #include <rpc/blockchain.h>
64 : : #include <rpc/register.h>
65 : : #include <rpc/server.h>
66 : : #include <rpc/util.h>
67 : : #include <scheduler.h>
68 : : #include <script/sigcache.h>
69 : : #include <sync.h>
70 : : #include <torcontrol.h>
71 : : #include <txdb.h>
72 : : #include <txmempool.h>
73 : : #include <util/asmap.h>
74 : : #include <util/batchpriority.h>
75 : : #include <util/chaintype.h>
76 : : #include <util/check.h>
77 : : #include <util/fs.h>
78 : : #include <util/fs_helpers.h>
79 : : #include <util/moneystr.h>
80 : : #include <util/result.h>
81 : : #include <util/signalinterrupt.h>
82 : : #include <util/strencodings.h>
83 : : #include <util/string.h>
84 : : #include <util/syserror.h>
85 : : #include <util/thread.h>
86 : : #include <util/threadnames.h>
87 : : #include <util/time.h>
88 : : #include <util/translation.h>
89 : : #include <validation.h>
90 : : #include <validationinterface.h>
91 : : #include <walletinitinterface.h>
92 : :
93 : : #include <algorithm>
94 : : #include <condition_variable>
95 : : #include <cstdint>
96 : : #include <cstdio>
97 : : #include <fstream>
98 : : #include <functional>
99 : : #include <set>
100 : : #include <string>
101 : : #include <thread>
102 : : #include <vector>
103 : :
104 : : #ifndef WIN32
105 : : #include <cerrno>
106 : : #include <signal.h>
107 : : #include <sys/stat.h>
108 : : #endif
109 : :
110 : : #include <boost/signals2/signal.hpp>
111 : :
112 : : #ifdef ENABLE_ZMQ
113 : : #include <zmq/zmqabstractnotifier.h>
114 : : #include <zmq/zmqnotificationinterface.h>
115 : : #include <zmq/zmqrpc.h>
116 : : #endif
117 : :
118 : : using common::AmountErrMsg;
119 : : using common::InvalidPortErrMsg;
120 : : using common::ResolveErrMsg;
121 : :
122 : : using node::ApplyArgsManOptions;
123 : : using node::BlockManager;
124 : : using node::CacheSizes;
125 : : using node::CalculateCacheSizes;
126 : : using node::ChainstateLoadResult;
127 : : using node::ChainstateLoadStatus;
128 : : using node::DEFAULT_PERSIST_MEMPOOL;
129 : : using node::DEFAULT_PRINT_MODIFIED_FEE;
130 : : using node::DEFAULT_STOPATHEIGHT;
131 : : using node::DumpMempool;
132 : : using node::ImportBlocks;
133 : : using node::KernelNotifications;
134 : : using node::LoadChainstate;
135 : : using node::LoadMempool;
136 : : using node::MempoolPath;
137 : : using node::NodeContext;
138 : : using node::ShouldPersistMempool;
139 : : using node::VerifyLoadedChainstate;
140 : : using util::Join;
141 : : using util::ReplaceAll;
142 : : using util::ToString;
143 : :
144 : : static constexpr bool DEFAULT_PROXYRANDOMIZE{true};
145 : : static constexpr bool DEFAULT_REST_ENABLE{false};
146 : : static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING{true};
147 : : static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
148 : :
149 : : #ifdef WIN32
150 : : // Win32 LevelDB doesn't use filedescriptors, and the ones used for
151 : : // accessing block files don't count towards the fd_set size limit
152 : : // anyway.
153 : : #define MIN_LEVELDB_FDS 0
154 : : #else
155 : : #define MIN_LEVELDB_FDS 150
156 : : #endif
157 : :
158 : : static constexpr int MIN_CORE_FDS = MIN_LEVELDB_FDS + NUM_FDS_MESSAGE_CAPTURE;
159 : : static const char* DEFAULT_ASMAP_FILENAME="ip_asn.map";
160 : :
161 : : /**
162 : : * The PID file facilities.
163 : : */
164 : : static const char* BITCOIN_PID_FILENAME = "bitcoind.pid";
165 : : /**
166 : : * True if this process has created a PID file.
167 : : * Used to determine whether we should remove the PID file on shutdown.
168 : : */
169 : : static bool g_generated_pid{false};
170 : :
171 : 0 : static fs::path GetPidFile(const ArgsManager& args)
172 : : {
173 [ # # # # : 0 : return AbsPathForConfigVal(args, args.GetPathArg("-pid", BITCOIN_PID_FILENAME));
# # ]
174 : : }
175 : :
176 : 0 : [[nodiscard]] static bool CreatePidFile(const ArgsManager& args)
177 : : {
178 [ # # ]: 0 : std::ofstream file{GetPidFile(args)};
179 [ # # ]: 0 : if (file) {
180 : : #ifdef WIN32
181 : : tfm::format(file, "%d\n", GetCurrentProcessId());
182 : : #else
183 [ # # ]: 0 : tfm::format(file, "%d\n", getpid());
184 : : #endif
185 : 0 : g_generated_pid = true;
186 : 0 : return true;
187 : : } else {
188 [ # # # # : 0 : return InitError(strprintf(_("Unable to create the PID file '%s': %s"), fs::PathToString(GetPidFile(args)), SysErrorString(errno)));
# # # # #
# ]
189 : : }
190 : 0 : }
191 : :
192 : 0 : static void RemovePidFile(const ArgsManager& args)
193 : : {
194 [ # # ]: 0 : if (!g_generated_pid) return;
195 : 0 : const auto pid_path{GetPidFile(args)};
196 [ # # ]: 0 : if (std::error_code error; !fs::remove(pid_path, error)) {
197 [ # # # # : 0 : std::string msg{error ? error.message() : "File does not exist"};
# # ]
198 [ # # # # ]: 0 : LogPrintf("Unable to remove PID file (%s): %s\n", fs::PathToString(pid_path), msg);
199 : 0 : }
200 : 0 : }
201 : :
202 : : static std::optional<util::SignalInterrupt> g_shutdown;
203 : :
204 : 0 : void InitContext(NodeContext& node)
205 : : {
206 [ # # ]: 0 : assert(!g_shutdown);
207 : 0 : g_shutdown.emplace();
208 : :
209 : 0 : node.args = &gArgs;
210 : 0 : node.shutdown_signal = &*g_shutdown;
211 : 0 : node.shutdown_request = [&node] {
212 [ # # ]: 0 : assert(node.shutdown_signal);
213 [ # # ]: 0 : if (!(*node.shutdown_signal)()) return false;
214 : : // Wake any threads that may be waiting for the tip to change.
215 [ # # # # ]: 0 : if (node.notifications) WITH_LOCK(node.notifications->m_tip_block_mutex, node.notifications->m_tip_block_cv.notify_all());
216 : : return true;
217 : 0 : };
218 : 0 : }
219 : :
220 : : //////////////////////////////////////////////////////////////////////////////
221 : : //
222 : : // Shutdown
223 : : //
224 : :
225 : : //
226 : : // Thread management and startup/shutdown:
227 : : //
228 : : // The network-processing threads are all part of a thread group
229 : : // created by AppInit() or the Qt main() function.
230 : : //
231 : : // A clean exit happens when the SignalInterrupt object is triggered, which
232 : : // makes the main thread's SignalInterrupt::wait() call return, and join all
233 : : // other ongoing threads in the thread group to the main thread.
234 : : // Shutdown() is then called to clean up database connections, and stop other
235 : : // threads that should only be stopped after the main network-processing
236 : : // threads have exited.
237 : : //
238 : : // Shutdown for Qt is very similar, only it uses a QTimer to detect
239 : : // ShutdownRequested() getting set, and then does the normal Qt
240 : : // shutdown thing.
241 : : //
242 : :
243 : 0 : bool ShutdownRequested(node::NodeContext& node)
244 : : {
245 : 0 : return bool{*Assert(node.shutdown_signal)};
246 : : }
247 : :
248 : : #if HAVE_SYSTEM
249 : 0 : static void ShutdownNotify(const ArgsManager& args)
250 : : {
251 : 0 : std::vector<std::thread> threads;
252 [ # # # # : 0 : for (const auto& cmd : args.GetArgs("-shutdownnotify")) {
# # ]
253 [ # # ]: 0 : threads.emplace_back(runCommand, cmd);
254 : 0 : }
255 [ # # ]: 0 : for (auto& t : threads) {
256 [ # # ]: 0 : t.join();
257 : : }
258 : 0 : }
259 : : #endif
260 : :
261 : 0 : void Interrupt(NodeContext& node)
262 : : {
263 : : #if HAVE_SYSTEM
264 : 0 : ShutdownNotify(*node.args);
265 : : #endif
266 : 0 : InterruptHTTPServer();
267 : 0 : InterruptHTTPRPC();
268 : 0 : InterruptRPC();
269 : 0 : InterruptREST();
270 : 0 : InterruptTorControl();
271 : 0 : InterruptMapPort();
272 [ # # ]: 0 : if (node.connman)
273 : 0 : node.connman->Interrupt();
274 [ # # ]: 0 : for (auto* index : node.indexes) {
275 : 0 : index->Interrupt();
276 : : }
277 : 0 : }
278 : :
279 : 0 : void Shutdown(NodeContext& node)
280 : : {
281 [ # # # # ]: 0 : static Mutex g_shutdown_mutex;
282 : 0 : TRY_LOCK(g_shutdown_mutex, lock_shutdown);
283 [ # # ]: 0 : if (!lock_shutdown) return;
284 [ # # ]: 0 : LogPrintf("%s: In progress...\n", __func__);
285 [ # # ]: 0 : Assert(node.args);
286 : :
287 : : /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
288 : : /// for example if the data directory was found to be locked.
289 : : /// Be sure that anything that writes files or flushes caches only does this if the respective
290 : : /// module was initialized.
291 [ # # # # ]: 0 : util::ThreadRename("shutoff");
292 [ # # # # ]: 0 : if (node.mempool) node.mempool->AddTransactionsUpdated(1);
293 : :
294 [ # # ]: 0 : StopHTTPRPC();
295 [ # # ]: 0 : StopREST();
296 [ # # ]: 0 : StopRPC();
297 [ # # ]: 0 : StopHTTPServer();
298 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
299 [ # # ]: 0 : client->flush();
300 : : }
301 [ # # ]: 0 : StopMapPort();
302 : :
303 : : // Because these depend on each-other, we make sure that neither can be
304 : : // using the other before destroying them.
305 [ # # # # : 0 : if (node.peerman && node.validation_signals) node.validation_signals->UnregisterValidationInterface(node.peerman.get());
# # ]
306 [ # # # # ]: 0 : if (node.connman) node.connman->Stop();
307 : :
308 [ # # ]: 0 : StopTorControl();
309 : :
310 [ # # # # ]: 0 : if (node.background_init_thread.joinable()) node.background_init_thread.join();
311 : : // After everything has been shut down, but before things get flushed, stop the
312 : : // the scheduler. After this point, SyncWithValidationInterfaceQueue() should not be called anymore
313 : : // as this would prevent the shutdown from completing.
314 [ # # # # ]: 0 : if (node.scheduler) node.scheduler->stop();
315 : :
316 : : // After the threads that potentially access these pointers have been stopped,
317 : : // destruct and reset all to nullptr.
318 [ # # ]: 0 : node.peerman.reset();
319 [ # # ]: 0 : node.connman.reset();
320 [ # # ]: 0 : node.banman.reset();
321 [ # # ]: 0 : node.addrman.reset();
322 [ # # ]: 0 : node.netgroupman.reset();
323 : :
324 [ # # # # : 0 : if (node.mempool && node.mempool->GetLoadTried() && ShouldPersistMempool(*node.args)) {
# # # # #
# ]
325 [ # # # # ]: 0 : DumpMempool(*node.mempool, MempoolPath(*node.args));
326 : : }
327 : :
328 : : // Drop transactions we were still watching, record fee estimations and unregister
329 : : // fee estimator from validation interface.
330 [ # # ]: 0 : if (node.fee_estimator) {
331 [ # # ]: 0 : node.fee_estimator->Flush();
332 [ # # ]: 0 : if (node.validation_signals) {
333 [ # # ]: 0 : node.validation_signals->UnregisterValidationInterface(node.fee_estimator.get());
334 : : }
335 : : }
336 : :
337 : : // FlushStateToDisk generates a ChainStateFlushed callback, which we should avoid missing
338 [ # # ]: 0 : if (node.chainman) {
339 [ # # ]: 0 : LOCK(cs_main);
340 [ # # # # ]: 0 : for (Chainstate* chainstate : node.chainman->GetAll()) {
341 [ # # ]: 0 : if (chainstate->CanFlushToDisk()) {
342 [ # # ]: 0 : chainstate->ForceFlushStateToDisk();
343 : : }
344 [ # # ]: 0 : }
345 : 0 : }
346 : :
347 : : // After there are no more peers/RPC left to give us new data which may generate
348 : : // CValidationInterface callbacks, flush them...
349 [ # # # # ]: 0 : if (node.validation_signals) node.validation_signals->FlushBackgroundCallbacks();
350 : :
351 : : // Stop and delete all indexes only after flushing background callbacks.
352 [ # # # # ]: 0 : for (auto* index : node.indexes) index->Stop();
353 [ # # ]: 0 : if (g_txindex) g_txindex.reset();
354 [ # # ]: 0 : if (g_coin_stats_index) g_coin_stats_index.reset();
355 [ # # ]: 0 : DestroyAllBlockFilterIndexes();
356 [ # # ]: 0 : node.indexes.clear(); // all instances are nullptr now
357 : :
358 : : // Any future callbacks will be dropped. This should absolutely be safe - if
359 : : // missing a callback results in an unrecoverable situation, unclean shutdown
360 : : // would too. The only reason to do the above flushes is to let the wallet catch
361 : : // up with our current chain to avoid any strange pruning edge cases and make
362 : : // next startup faster by avoiding rescan.
363 : :
364 [ # # ]: 0 : if (node.chainman) {
365 [ # # ]: 0 : LOCK(cs_main);
366 [ # # # # ]: 0 : for (Chainstate* chainstate : node.chainman->GetAll()) {
367 [ # # ]: 0 : if (chainstate->CanFlushToDisk()) {
368 [ # # ]: 0 : chainstate->ForceFlushStateToDisk();
369 : 0 : chainstate->ResetCoinsViews();
370 : : }
371 [ # # ]: 0 : }
372 : 0 : }
373 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
374 [ # # ]: 0 : client->stop();
375 : : }
376 : :
377 : : #ifdef ENABLE_ZMQ
378 : : if (g_zmq_notification_interface) {
379 : : if (node.validation_signals) node.validation_signals->UnregisterValidationInterface(g_zmq_notification_interface.get());
380 : : g_zmq_notification_interface.reset();
381 : : }
382 : : #endif
383 : :
384 : 0 : node.chain_clients.clear();
385 [ # # ]: 0 : if (node.validation_signals) {
386 [ # # ]: 0 : node.validation_signals->UnregisterAllValidationInterfaces();
387 : : }
388 [ # # ]: 0 : node.mempool.reset();
389 [ # # ]: 0 : node.fee_estimator.reset();
390 [ # # ]: 0 : node.chainman.reset();
391 [ # # ]: 0 : node.validation_signals.reset();
392 [ # # ]: 0 : node.scheduler.reset();
393 [ # # ]: 0 : node.ecc_context.reset();
394 [ # # ]: 0 : node.kernel.reset();
395 : :
396 [ # # ]: 0 : RemovePidFile(*node.args);
397 : :
398 [ # # ]: 0 : LogPrintf("%s: done\n", __func__);
399 : 0 : }
400 : :
401 : : /**
402 : : * Signal handlers are very limited in what they are allowed to do.
403 : : * The execution context the handler is invoked in is not guaranteed,
404 : : * so we restrict handler operations to just touching variables:
405 : : */
406 : : #ifndef WIN32
407 : 0 : static void HandleSIGTERM(int)
408 : : {
409 : : // Return value is intentionally ignored because there is not a better way
410 : : // of handling this failure in a signal handler.
411 : 0 : (void)(*Assert(g_shutdown))();
412 : 0 : }
413 : :
414 : 0 : static void HandleSIGHUP(int)
415 : : {
416 : 0 : LogInstance().m_reopen_file = true;
417 : 0 : }
418 : : #else
419 : : static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType)
420 : : {
421 : : if (!(*Assert(g_shutdown))()) {
422 : : LogError("Failed to send shutdown signal on Ctrl-C\n");
423 : : return false;
424 : : }
425 : : Sleep(INFINITE);
426 : : return true;
427 : : }
428 : : #endif
429 : :
430 : : #ifndef WIN32
431 : 0 : static void registerSignalHandler(int signal, void(*handler)(int))
432 : : {
433 : 0 : struct sigaction sa;
434 : 0 : sa.sa_handler = handler;
435 : 0 : sigemptyset(&sa.sa_mask);
436 : 0 : sa.sa_flags = 0;
437 : 0 : sigaction(signal, &sa, nullptr);
438 : 0 : }
439 : : #endif
440 : :
441 : 0 : void SetupServerArgs(ArgsManager& argsman, bool can_listen_ipc)
442 : : {
443 : 0 : SetupHelpOptions(argsman);
444 [ # # # # ]: 0 : argsman.AddArg("-help-debug", "Print help message with debugging options and exit", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); // server-only for now
445 : :
446 : 0 : init::AddLoggingArgs(argsman);
447 : :
448 : 0 : const auto defaultBaseParams = CreateBaseChainParams(ChainType::MAIN);
449 [ # # ]: 0 : const auto testnetBaseParams = CreateBaseChainParams(ChainType::TESTNET);
450 [ # # ]: 0 : const auto testnet4BaseParams = CreateBaseChainParams(ChainType::TESTNET4);
451 [ # # ]: 0 : const auto signetBaseParams = CreateBaseChainParams(ChainType::SIGNET);
452 [ # # ]: 0 : const auto regtestBaseParams = CreateBaseChainParams(ChainType::REGTEST);
453 [ # # ]: 0 : const auto defaultChainParams = CreateChainParams(argsman, ChainType::MAIN);
454 [ # # ]: 0 : const auto testnetChainParams = CreateChainParams(argsman, ChainType::TESTNET);
455 [ # # ]: 0 : const auto testnet4ChainParams = CreateChainParams(argsman, ChainType::TESTNET4);
456 [ # # ]: 0 : const auto signetChainParams = CreateChainParams(argsman, ChainType::SIGNET);
457 [ # # ]: 0 : const auto regtestChainParams = CreateChainParams(argsman, ChainType::REGTEST);
458 : :
459 : : // Hidden Options
460 : 0 : std::vector<std::string> hidden_args = {
461 : : "-dbcrashratio", "-forcecompactdb",
462 : : // GUI args. These will be overwritten by SetupUIArgs for the GUI
463 [ # # ]: 0 : "-choosedatadir", "-lang=<lang>", "-min", "-resetguisettings", "-splash", "-uiplatform"};
464 : :
465 [ # # # # : 0 : argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
466 : : #if HAVE_SYSTEM
467 [ # # # # : 0 : argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
468 : : #endif
469 [ # # # # : 0 : argsman.AddArg("-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, testnet3: %s, testnet4: %s, signet: %s)", defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnetChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnet4ChainParams->GetConsensus().defaultAssumeValid.GetHex(), signetChainParams->GetConsensus().defaultAssumeValid.GetHex()), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # # # #
# # # #
# ]
470 [ # # # # : 0 : argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
471 [ # # # # ]: 0 : argsman.AddArg("-blocksxor",
472 : 0 : strprintf("Whether an XOR-key applies to blocksdir *.dat files. "
473 : : "The created XOR-key will be zeros for an existing blocksdir or when `-blocksxor=0` is "
474 : : "set, and random for a freshly initialized blocksdir. "
475 : : "(default: %u)",
476 : : kernel::DEFAULT_XOR_BLOCKSDIR),
477 [ # # ]: 0 : ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
478 [ # # # # : 0 : argsman.AddArg("-fastprune", "Use smaller block files and lower minimum prune height for testing purposes", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
479 : : #if HAVE_SYSTEM
480 [ # # # # : 0 : argsman.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
481 : : #endif
482 [ # # # # : 0 : argsman.AddArg("-blockreconstructionextratxn=<n>", strprintf("Extra transactions to keep in memory for compact block reconstructions (default: %u)", DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
483 [ # # # # : 0 : argsman.AddArg("-blocksonly", strprintf("Whether to reject transactions from network peers. Disables automatic broadcast and rebroadcast of transactions, unless the source peer has the 'forcerelay' permission. RPC transactions are not affected. (default: %u)", DEFAULT_BLOCKSONLY), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
484 [ # # # # : 0 : argsman.AddArg("-coinstatsindex", strprintf("Maintain coinstats index used by the gettxoutsetinfo RPC (default: %u)", DEFAULT_COINSTATSINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
485 [ # # # # : 0 : argsman.AddArg("-conf=<file>", strprintf("Specify path to read-only configuration file. Relative paths will be prefixed by datadir location (only useable from command line, not configuration file) (default: %s)", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
486 [ # # # # : 0 : argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
487 [ # # # # : 0 : argsman.AddArg("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", nDefaultDbBatchSize), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
# # ]
488 [ # # # # : 0 : argsman.AddArg("-dbcache=<n>", strprintf("Maximum database cache size <n> MiB (minimum %d, default: %d). Make sure you have enough RAM. In addition, unused memory allocated to the mempool is shared with this cache (see -maxmempool).", nMinDbCache, nDefaultDbCache), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
489 [ # # # # : 0 : argsman.AddArg("-includeconf=<file>", "Specify additional configuration file, relative to the -datadir path (only useable from configuration file, not command line)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
490 [ # # # # : 0 : argsman.AddArg("-allowignoredconf", strprintf("For backwards compatibility, treat an unused %s file in the datadir as a warning, not an error.", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
491 [ # # # # : 0 : argsman.AddArg("-loadblock=<file>", "Imports blocks from external file on startup", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
492 [ # # # # : 0 : argsman.AddArg("-maxmempool=<n>", strprintf("Keep the transaction memory pool below <n> megabytes (default: %u)", DEFAULT_MAX_MEMPOOL_SIZE_MB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
493 [ # # # # : 0 : argsman.AddArg("-maxorphantx=<n>", strprintf("Keep at most <n> unconnectable transactions in memory (default: %u)", DEFAULT_MAX_ORPHAN_TRANSACTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
494 [ # # # # : 0 : argsman.AddArg("-mempoolexpiry=<n>", strprintf("Do not keep transactions in the mempool longer than <n> hours (default: %u)", DEFAULT_MEMPOOL_EXPIRY_HOURS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
495 [ # # # # : 0 : argsman.AddArg("-minimumchainwork=<hex>", strprintf("Minimum work assumed to exist on a valid chain in hex (default: %s, testnet3: %s, testnet4: %s, signet: %s)", defaultChainParams->GetConsensus().nMinimumChainWork.GetHex(), testnetChainParams->GetConsensus().nMinimumChainWork.GetHex(), testnet4ChainParams->GetConsensus().nMinimumChainWork.GetHex(), signetChainParams->GetConsensus().nMinimumChainWork.GetHex()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
# # # # #
# # # #
# ]
496 [ # # # # ]: 0 : argsman.AddArg("-par=<n>", strprintf("Set the number of script verification threads (0 = auto, up to %d, <0 = leave that many cores free, default: %d)",
497 [ # # ]: 0 : MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
498 [ # # # # : 0 : argsman.AddArg("-persistmempool", strprintf("Whether to save the mempool on shutdown and load on restart (default: %u)", DEFAULT_PERSIST_MEMPOOL), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
499 [ # # # # ]: 0 : argsman.AddArg("-persistmempoolv1",
500 : 0 : strprintf("Whether a mempool.dat file created by -persistmempool or the savemempool RPC will be written in the legacy format "
501 : : "(version 1) or the current format (version 2). This temporary option will be removed in the future. (default: %u)",
502 : : DEFAULT_PERSIST_V1_DAT),
503 [ # # ]: 0 : ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
504 [ # # # # : 0 : argsman.AddArg("-pid=<file>", strprintf("Specify pid file. Relative paths will be prefixed by a net-specific datadir location. (default: %s)", BITCOIN_PID_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
505 [ # # # # ]: 0 : argsman.AddArg("-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. "
506 : : "Warning: Reverting this setting requires re-downloading the entire blockchain. "
507 [ # # ]: 0 : "(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), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
508 [ # # # # : 0 : argsman.AddArg("-reindex", "If enabled, wipe chain state and block index, and rebuild them from blk*.dat files on disk. Also wipe and rebuild other optional indexes that are active. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be reloaded via RPC.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
509 [ # # # # : 0 : argsman.AddArg("-reindex-chainstate", "If enabled, wipe chain state, and rebuild it from blk*.dat files on disk. If an assumeutxo snapshot was loaded, its chainstate will be wiped as well. The snapshot can then be reloaded via RPC.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
510 [ # # # # : 0 : argsman.AddArg("-settings=<file>", strprintf("Specify path to dynamic settings data file. Can be disabled with -nosettings. File is written at runtime and not meant to be edited by users (use %s instead for custom settings). Relative paths will be prefixed by datadir location. (default: %s)", BITCOIN_CONF_FILENAME, BITCOIN_SETTINGS_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
511 : : #if HAVE_SYSTEM
512 [ # # # # : 0 : argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
513 [ # # # # : 0 : argsman.AddArg("-shutdownnotify=<cmd>", "Execute command immediately before beginning shutdown. The need for shutdown may be urgent, so be careful not to delay it long (if the command doesn't require interaction with the server, consider having it fork into the background).", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
514 : : #endif
515 [ # # # # : 0 : argsman.AddArg("-txindex", strprintf("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)", DEFAULT_TXINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
516 [ # # # # ]: 0 : argsman.AddArg("-blockfilterindex=<type>",
517 [ # # ]: 0 : strprintf("Maintain an index of compact filters by block (default: %s, values: %s).", DEFAULT_BLOCKFILTERINDEX, ListBlockFilterTypes()) +
518 [ # # ]: 0 : " If <type> is not supplied or if <type> = 1, indexes for all known types are enabled.",
519 [ # # ]: 0 : ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
520 : :
521 [ # # # # : 0 : argsman.AddArg("-addnode=<ip>", strprintf("Add a node to connect to and attempt to keep the connection open (see the addnode RPC help for more info). This option can be specified multiple times to add multiple nodes; connections are limited to %u at a time and are counted separately from the -maxconnections limit.", MAX_ADDNODE_CONNECTIONS), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
# # ]
522 [ # # # # : 0 : argsman.AddArg("-asmap=<file>", strprintf("Specify asn mapping used for bucketing of the peers (default: %s). Relative paths will be prefixed by the net-specific datadir location.", DEFAULT_ASMAP_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
523 [ # # # # : 0 : argsman.AddArg("-bantime=<n>", strprintf("Default duration (in seconds) of manually configured bans (default: %u)", DEFAULT_MISBEHAVING_BANTIME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
524 [ # # # # : 0 : argsman.AddArg("-bind=<addr>[:<port>][=onion]", strprintf("Bind to given address and always listen on it (default: 0.0.0.0). Use [host]:port notation for IPv6. Append =onion to tag any incoming connections to that address and port as incoming Tor connections (default: 127.0.0.1:%u=onion, testnet3: 127.0.0.1:%u=onion, testnet4: 127.0.0.1:%u=onion, signet: 127.0.0.1:%u=onion, regtest: 127.0.0.1:%u=onion)", defaultBaseParams->OnionServiceTargetPort(), testnetBaseParams->OnionServiceTargetPort(), testnet4BaseParams->OnionServiceTargetPort(), signetBaseParams->OnionServiceTargetPort(), regtestBaseParams->OnionServiceTargetPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
# # ]
525 [ # # # # : 0 : argsman.AddArg("-cjdnsreachable", "If set, then this host is configured for CJDNS (connecting to fc00::/8 addresses would lead us to the CJDNS network, see doc/cjdns.md) (default: 0)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
526 [ # # # # : 0 : argsman.AddArg("-connect=<ip>", "Connect only to the specified node; -noconnect disables automatic connections (the rules for this peer are the same as for -addnode). This option can be specified multiple times to connect to multiple nodes.", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
# # ]
527 [ # # # # : 0 : argsman.AddArg("-discover", "Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
528 [ # # # # : 0 : argsman.AddArg("-dns", strprintf("Allow DNS lookups for -addnode, -seednode and -connect (default: %u)", DEFAULT_NAME_LOOKUP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
529 [ # # # # : 0 : argsman.AddArg("-dnsseed", strprintf("Query for peer addresses via DNS lookup, if low on addresses (default: %u unless -connect used or -maxconnections=0)", DEFAULT_DNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
530 [ # # # # : 0 : argsman.AddArg("-externalip=<ip>", "Specify your own public address", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
531 [ # # # # : 0 : argsman.AddArg("-fixedseeds", strprintf("Allow fixed seeds if DNS seeds don't provide peers (default: %u)", DEFAULT_FIXEDSEEDS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
532 [ # # # # : 0 : argsman.AddArg("-forcednsseed", strprintf("Always query for peer addresses via DNS lookup (default: %u)", DEFAULT_FORCEDNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
533 [ # # # # : 0 : argsman.AddArg("-listen", strprintf("Accept connections from outside (default: %u if no -proxy, -connect or -maxconnections=0)", DEFAULT_LISTEN), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
534 [ # # # # : 0 : argsman.AddArg("-listenonion", strprintf("Automatically create Tor onion service (default: %d)", DEFAULT_LISTEN_ONION), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
535 [ # # # # : 0 : argsman.AddArg("-maxconnections=<n>", strprintf("Maintain at most <n> automatic connections to peers (default: %u). This limit does not apply to connections manually added via -addnode or the addnode RPC, which have a separate limit of %u.", DEFAULT_MAX_PEER_CONNECTIONS, MAX_ADDNODE_CONNECTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
536 [ # # # # : 0 : argsman.AddArg("-maxreceivebuffer=<n>", strprintf("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXRECEIVEBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
537 [ # # # # : 0 : argsman.AddArg("-maxsendbuffer=<n>", strprintf("Maximum per-connection memory usage for the send buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXSENDBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
538 [ # # # # : 0 : argsman.AddArg("-maxuploadtarget=<n>", strprintf("Tries to keep outbound traffic under the given target per 24h. Limit does not apply to peers with 'download' permission or blocks created within past week. 0 = no limit (default: %s). Optional suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000 base while uppercase is 1024 base", DEFAULT_MAX_UPLOAD_TARGET), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
539 : : #ifdef HAVE_SOCKADDR_UN
540 [ # # # # : 0 : argsman.AddArg("-onion=<ip:port|path>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy). May be a local file path prefixed with 'unix:'.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
541 : : #else
542 : : argsman.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
543 : : #endif
544 [ # # # # : 0 : argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections (default: none)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
545 [ # # # # : 0 : argsman.AddArg("-i2pacceptincoming", strprintf("Whether to accept inbound I2P connections (default: %i). Ignored if -i2psam is not set. Listening for inbound I2P connections is done through the SAM proxy, not by binding to a local address and port.", DEFAULT_I2P_ACCEPT_INCOMING), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
546 [ # # # # : 0 : argsman.AddArg("-onlynet=<net>", "Make automatic outbound connections only to network <net> (" + Join(GetNetworkNames(), ", ") + "). Inbound and manual connections are not affected by this option. It can be specified multiple times to allow multiple networks.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # # # #
# ]
547 [ # # # # : 0 : argsman.AddArg("-v2transport", strprintf("Support v2 transport (default: %u)", DEFAULT_V2_TRANSPORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
548 [ # # # # : 0 : argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
549 [ # # # # : 0 : argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
550 [ # # # # : 0 : argsman.AddArg("-txreconciliation", strprintf("Enable transaction reconciliations per BIP 330 (default: %d)", DEFAULT_TXRECONCILIATION_ENABLE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
# # ]
551 [ # # # # : 0 : argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port> (default: %u, testnet3: %u, testnet4: %u, signet: %u, regtest: %u). Not relevant for I2P (see doc/i2p.md).", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), testnet4ChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
# # ]
552 : : #ifdef HAVE_SOCKADDR_UN
553 [ # # # # : 0 : argsman.AddArg("-proxy=<ip:port|path>", "Connect through SOCKS5 proxy, set -noproxy to disable (default: disabled). May be a local file path prefixed with 'unix:' if the proxy supports it.", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_ELISION, OptionsCategory::CONNECTION);
# # ]
554 : : #else
555 : : argsman.AddArg("-proxy=<ip:port>", "Connect through SOCKS5 proxy, set -noproxy to disable (default: disabled)", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_ELISION, OptionsCategory::CONNECTION);
556 : : #endif
557 [ # # # # : 0 : argsman.AddArg("-proxyrandomize", strprintf("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)", DEFAULT_PROXYRANDOMIZE), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
558 [ # # # # : 0 : argsman.AddArg("-seednode=<ip>", "Connect to a node to retrieve peer addresses, and disconnect. This option can be specified multiple times to connect to multiple nodes. During startup, seednodes will be tried before dnsseeds.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
559 [ # # # # : 0 : argsman.AddArg("-networkactive", "Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
560 [ # # # # : 0 : argsman.AddArg("-timeout=<n>", strprintf("Specify socket connection timeout in milliseconds. If an initial attempt to connect is unsuccessful after this amount of time, drop it (minimum: 1, default: %d)", DEFAULT_CONNECT_TIMEOUT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
561 [ # # # # : 0 : argsman.AddArg("-peertimeout=<n>", strprintf("Specify a p2p connection timeout delay in seconds. After connecting to a peer, wait this amount of time before considering disconnection based on inactivity (minimum: 1, default: %d)", DEFAULT_PEER_CONNECT_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
# # ]
562 [ # # # # : 0 : argsman.AddArg("-torcontrol=<ip>:<port>", strprintf("Tor control host and port to use if onion listening enabled (default: %s). If no port is specified, the default port of %i will be used.", DEFAULT_TOR_CONTROL, DEFAULT_TOR_CONTROL_PORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
563 [ # # # # : 0 : argsman.AddArg("-torpassword=<pass>", "Tor control port password (default: empty)", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::CONNECTION);
# # ]
564 : : // UPnP support was dropped. We keep `-upnp` as a hidden arg to display a more user friendly error when set. TODO: remove (here and below) for 30.0. NOTE: removing this option may prevent the GUI from starting, see https://github.com/bitcoin-core/gui/issues/843.
565 [ # # # # : 0 : argsman.AddArg("-upnp", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
# # ]
566 [ # # # # : 0 : argsman.AddArg("-natpmp", strprintf("Use PCP or NAT-PMP to map the listening port (default: %u)", DEFAULT_NATPMP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
# # ]
567 [ # # # # ]: 0 : argsman.AddArg("-whitebind=<[permissions@]addr>", "Bind to the given address and add permission flags to the peers connecting to it. "
568 [ # # ]: 0 : "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
569 [ # # # # ]: 0 : "Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
570 : :
571 [ # # # # ]: 0 : argsman.AddArg("-whitelist=<[permissions@]IP address or network>", "Add permission flags to the peers using the given IP address (e.g. 1.2.3.4) or "
572 : : "CIDR-notated network (e.g. 1.2.3.0/24). Uses the same permissions as "
573 : : "-whitebind. "
574 : : "Additional flags \"in\" and \"out\" control whether permissions apply to incoming connections and/or manual (default: incoming only). "
575 [ # # ]: 0 : "Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
576 : :
577 [ # # ]: 0 : g_wallet_init_interface.AddWalletOptions(argsman);
578 : :
579 : : #ifdef ENABLE_ZMQ
580 : : argsman.AddArg("-zmqpubhashblock=<address>", "Enable publish hash block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
581 : : argsman.AddArg("-zmqpubhashtx=<address>", "Enable publish hash transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
582 : : argsman.AddArg("-zmqpubrawblock=<address>", "Enable publish raw block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
583 : : argsman.AddArg("-zmqpubrawtx=<address>", "Enable publish raw transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
584 : : argsman.AddArg("-zmqpubsequence=<address>", "Enable publish hash block and tx sequence in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
585 : : argsman.AddArg("-zmqpubhashblockhwm=<n>", strprintf("Set publish hash block outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
586 : : argsman.AddArg("-zmqpubhashtxhwm=<n>", strprintf("Set publish hash transaction outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
587 : : argsman.AddArg("-zmqpubrawblockhwm=<n>", strprintf("Set publish raw block outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
588 : : argsman.AddArg("-zmqpubrawtxhwm=<n>", strprintf("Set publish raw transaction outbound message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
589 : : argsman.AddArg("-zmqpubsequencehwm=<n>", strprintf("Set publish hash sequence message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
590 : : #else
591 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubhashblock=<address>");
592 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubhashtx=<address>");
593 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubrawblock=<address>");
594 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubrawtx=<address>");
595 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubsequence=<n>");
596 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
597 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
598 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
599 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
600 [ # # ]: 0 : hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
601 : : #endif
602 : :
603 [ # # # # : 0 : argsman.AddArg("-checkblocks=<n>", strprintf("How many blocks to check at startup (default: %u, 0 = all)", DEFAULT_CHECKBLOCKS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
604 [ # # # # : 0 : argsman.AddArg("-checklevel=<n>", strprintf("How thorough the block verification of -checkblocks is: %s (0-4, default: %u)", Join(CHECKLEVEL_DOC, ", "), DEFAULT_CHECKLEVEL), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # # # ]
605 [ # # # # : 0 : argsman.AddArg("-checkblockindex", strprintf("Do a consistency check for the block tree, chainstate, and other validation data structures every <n> operations. Use 0 to disable. (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
606 [ # # # # : 0 : argsman.AddArg("-checkaddrman=<n>", strprintf("Run addrman consistency checks every <n> operations. Use 0 to disable. (default: %u)", DEFAULT_ADDRMAN_CONSISTENCY_CHECKS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
607 [ # # # # : 0 : argsman.AddArg("-checkmempool=<n>", strprintf("Run mempool consistency checks every <n> transactions. Use 0 to disable. (default: %u, regtest: %u)", defaultChainParams->DefaultConsistencyChecks(), regtestChainParams->DefaultConsistencyChecks()), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
608 [ # # # # : 0 : argsman.AddArg("-checkpoints", strprintf("Enable rejection of any forks from the known historical chain until block %s (default: %u)", defaultChainParams->Checkpoints().GetHeight(), DEFAULT_CHECKPOINTS_ENABLED), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
609 [ # # # # : 0 : argsman.AddArg("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
610 [ # # # # : 0 : argsman.AddArg("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
611 [ # # # # : 0 : argsman.AddArg("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
612 [ # # # # : 0 : argsman.AddArg("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
613 [ # # # # : 0 : argsman.AddArg("-limitancestorsize=<n>", strprintf("Do not accept transactions whose size with all in-mempool ancestors exceeds <n> kilobytes (default: %u)", DEFAULT_ANCESTOR_SIZE_LIMIT_KVB), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
614 [ # # # # : 0 : argsman.AddArg("-limitdescendantcount=<n>", strprintf("Do not accept transactions if any ancestor would have <n> or more in-mempool descendants (default: %u)", DEFAULT_DESCENDANT_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
615 [ # # # # : 0 : argsman.AddArg("-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_KVB), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
616 [ # # # # : 0 : argsman.AddArg("-test=<option>", "Pass a test-only option. Options include : " + Join(TEST_OPTIONS_DOC, ", ") + ".", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # # # ]
617 [ # # # # : 0 : argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
618 [ # # # # : 0 : argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
619 [ # # # # : 0 : argsman.AddArg("-maxsigcachesize=<n>", strprintf("Limit sum of signature cache and script execution cache sizes to <n> MiB (default: %u)", DEFAULT_VALIDATION_CACHE_BYTES >> 20), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
620 [ # # # # ]: 0 : argsman.AddArg("-maxtipage=<n>",
621 : 0 : strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)",
622 : 0 : Ticks<std::chrono::seconds>(DEFAULT_MAX_TIP_AGE)),
623 [ # # ]: 0 : ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
624 [ # # # # : 0 : argsman.AddArg("-printpriority", strprintf("Log transaction fee rate in " + CURRENCY_UNIT + "/kvB when mining blocks (default: %u)", DEFAULT_PRINT_MODIFIED_FEE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # # # ]
625 [ # # # # : 0 : argsman.AddArg("-uacomment=<cmt>", "Append comment to the user agent string", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
# # ]
626 : :
627 [ # # ]: 0 : SetupChainParamsBaseOptions(argsman);
628 : :
629 [ # # # # : 0 : argsman.AddArg("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (test networks only; default: %u)", DEFAULT_ACCEPT_NON_STD_TXN), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
# # ]
630 [ # # # # : 0 : argsman.AddArg("-incrementalrelayfee=<amt>", strprintf("Fee rate (in %s/kvB) used to define cost of relay, used for mempool limiting and replacement policy. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_INCREMENTAL_RELAY_FEE)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
# # # # ]
631 [ # # # # : 0 : argsman.AddArg("-dustrelayfee=<amt>", strprintf("Fee rate (in %s/kvB) used to define 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)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
# # # # ]
632 [ # # # # : 0 : argsman.AddArg("-acceptstalefeeestimates", strprintf("Read fee estimates even if they are stale (%sdefault: %u) fee estimates are considered stale if they are %s hours old", "regtest only; ", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES, Ticks<std::chrono::hours>(MAX_FILE_AGE)), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
# # ]
633 [ # # # # : 0 : argsman.AddArg("-bytespersigop", strprintf("Equivalent bytes per sigop in transactions for relay and mining (default: %u)", DEFAULT_BYTES_PER_SIGOP), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
# # ]
634 [ # # # # : 0 : argsman.AddArg("-datacarrier", strprintf("Relay and mine data carrier transactions (default: %u)", DEFAULT_ACCEPT_DATACARRIER), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
# # ]
635 [ # # # # ]: 0 : argsman.AddArg("-datacarriersize",
636 : 0 : strprintf("Relay and mine transactions whose data-carrying raw scriptPubKey "
637 : : "is of this size or less (default: %u)",
638 : : MAX_OP_RETURN_RELAY),
639 [ # # ]: 0 : ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
640 [ # # # # : 0 : argsman.AddArg("-mempoolfullrbf", strprintf("(DEPRECATED) Accept transaction replace-by-fee without requiring replaceability signaling (default: %u)", DEFAULT_MEMPOOL_FULL_RBF), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
# # ]
641 [ # # # # ]: 0 : argsman.AddArg("-permitbaremultisig", strprintf("Relay transactions creating non-P2SH multisig outputs (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY,
642 [ # # ]: 0 : OptionsCategory::NODE_RELAY);
643 [ # # # # : 0 : argsman.AddArg("-minrelaytxfee=<amt>", strprintf("Fees (in %s/kvB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)",
# # ]
644 [ # # ]: 0 : CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
645 [ # # # # : 0 : argsman.AddArg("-whitelistforcerelay", strprintf("Add 'forcerelay' permission to whitelisted peers with default permissions. This will relay transactions even if the transactions were already in the mempool. (default: %d)", DEFAULT_WHITELISTFORCERELAY), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
# # ]
646 [ # # # # : 0 : argsman.AddArg("-whitelistrelay", strprintf("Add 'relay' permission to whitelisted peers with default permissions. This will accept relayed transactions even when not relaying transactions (default: %d)", DEFAULT_WHITELISTRELAY), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
# # ]
647 : :
648 : :
649 [ # # # # : 0 : argsman.AddArg("-blockmaxweight=<n>", strprintf("Set maximum BIP141 block weight (default: %d)", DEFAULT_BLOCK_MAX_WEIGHT), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
# # ]
650 [ # # # # : 0 : argsman.AddArg("-blockmintxfee=<amt>", strprintf("Set lowest fee rate (in %s/kvB) for transactions to be included in block creation. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_BLOCK_MIN_TX_FEE)), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
# # # # ]
651 [ # # # # : 0 : argsman.AddArg("-blockversion=<n>", "Override block version to test forking scenarios", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
# # ]
652 : :
653 [ # # # # : 0 : argsman.AddArg("-rest", strprintf("Accept public REST requests (default: %u)", DEFAULT_REST_ENABLE), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
654 [ # # # # : 0 : argsman.AddArg("-rpcallowip=<ip>", "Allow JSON-RPC connections from specified source. Valid values 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), a network/CIDR (e.g. 1.2.3.4/24), all ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be specified multiple times", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
655 [ # # # # : 0 : argsman.AddArg("-rpcauth=<userpw>", "Username and HMAC-SHA-256 hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcauth. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
# # ]
656 [ # # # # : 0 : argsman.AddArg("-rpcbind=<addr>[:port]", "Bind to given address to listen for JSON-RPC connections. Do not expose the RPC server to untrusted networks such as the public internet! 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)", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::RPC);
# # ]
657 [ # # # # : 0 : argsman.AddArg("-rpcdoccheck", strprintf("Throw a non-fatal error at runtime if the documentation for an RPC is incorrect (default: %u)", DEFAULT_RPC_DOC_CHECK), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
# # ]
658 [ # # # # : 0 : argsman.AddArg("-rpccookiefile=<loc>", "Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir)", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
659 [ # # # # : 0 : argsman.AddArg("-rpccookieperms=<readable-by>", strprintf("Set permissions on the RPC auth cookie file so that it is readable by [owner|group|all] (default: owner [via umask 0077])"), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
660 [ # # # # : 0 : argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
# # ]
661 [ # # # # : 0 : argsman.AddArg("-rpcport=<port>", strprintf("Listen for JSON-RPC connections on <port> (default: %u, testnet3: %u, testnet4: %u, signet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), testnet4BaseParams->RPCPort(), signetBaseParams->RPCPort(), regtestBaseParams->RPCPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::RPC);
# # ]
662 [ # # # # : 0 : argsman.AddArg("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
# # ]
663 [ # # # # : 0 : argsman.AddArg("-rpcthreads=<n>", strprintf("Set the number of threads to service RPC calls (default: %d)", DEFAULT_HTTP_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
664 [ # # # # : 0 : argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
# # ]
665 [ # # # # : 0 : argsman.AddArg("-rpcwhitelist=<whitelist>", "Set a whitelist to filter incoming RPC calls for a specific user. The field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc 2>,...,<rpc n>. If multiple whitelists are set for a given user, they are set-intersected. See -rpcwhitelistdefault documentation for information on default whitelist behavior.", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
666 [ # # # # : 0 : argsman.AddArg("-rpcwhitelistdefault", "Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault is set to 0, if any -rpcwhitelist is set, the rpc server acts as if all rpc users are subject to empty-unless-otherwise-specified whitelists. If rpcwhitelistdefault is set to 1 and no -rpcwhitelist is set, rpc server acts as if all rpc users are subject to empty whitelists.", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
667 [ # # # # : 0 : argsman.AddArg("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
# # ]
668 [ # # # # : 0 : argsman.AddArg("-server", "Accept command line and JSON-RPC commands", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
# # ]
669 [ # # ]: 0 : if (can_listen_ipc) {
670 [ # # # # : 0 : argsman.AddArg("-ipcbind=<address>", "Bind to Unix socket address and listen for incoming connections. Valid address values are \"unix\" to listen on the default path, <datadir>/node.sock, or \"unix:/custom/path\" to specify a custom path. Can be specified multiple times to listen on multiple paths. Default behavior is not to listen on any path. If relative paths are specified, they are interpreted relative to the network data directory. If paths include any parent directory components and the parent directories do not exist, they will be created.", ArgsManager::ALLOW_ANY, OptionsCategory::IPC);
# # ]
671 : : }
672 : :
673 : : #if HAVE_DECL_FORK
674 [ # # # # : 0 : argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
675 [ # # # # : 0 : argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
# # ]
676 : : #else
677 : : hidden_args.emplace_back("-daemon");
678 : : hidden_args.emplace_back("-daemonwait");
679 : : #endif
680 : :
681 : : // Add the hidden options
682 [ # # ]: 0 : argsman.AddHiddenArgs(hidden_args);
683 : 0 : }
684 : :
685 : : #if HAVE_SYSTEM
686 : 0 : static void StartupNotify(const ArgsManager& args)
687 : : {
688 [ # # # # ]: 0 : std::string cmd = args.GetArg("-startupnotify", "");
689 [ # # ]: 0 : if (!cmd.empty()) {
690 [ # # ]: 0 : std::thread t(runCommand, cmd);
691 [ # # ]: 0 : t.detach(); // thread runs free
692 : 0 : }
693 : 0 : }
694 : : #endif
695 : :
696 : 0 : static bool AppInitServers(NodeContext& node)
697 : : {
698 : 0 : const ArgsManager& args = *Assert(node.args);
699 [ # # ]: 0 : if (!InitHTTPServer(*Assert(node.shutdown_signal))) {
700 : : return false;
701 : : }
702 : 0 : StartRPC();
703 : 0 : node.rpc_interruption_point = RpcInterruptionPoint;
704 [ # # # # ]: 0 : if (!StartHTTPRPC(&node))
705 : : return false;
706 [ # # # # : 0 : if (args.GetBoolArg("-rest", DEFAULT_REST_ENABLE)) StartREST(&node);
# # ]
707 : 0 : StartHTTPServer();
708 : 0 : return true;
709 : : }
710 : :
711 : : // Parameter interaction based on rules
712 : 0 : void InitParameterInteraction(ArgsManager& args)
713 : : {
714 : : // when specifying an explicit binding address, you want to listen on it
715 : : // even when -connect or -proxy is specified
716 [ # # # # ]: 0 : if (args.IsArgSet("-bind")) {
717 [ # # # # ]: 0 : if (args.SoftSetBoolArg("-listen", true))
718 : 0 : LogInfo("parameter interaction: -bind set -> setting -listen=1\n");
719 : : }
720 [ # # # # ]: 0 : if (args.IsArgSet("-whitebind")) {
721 [ # # # # ]: 0 : if (args.SoftSetBoolArg("-listen", true))
722 : 0 : LogInfo("parameter interaction: -whitebind set -> setting -listen=1\n");
723 : : }
724 : :
725 [ # # # # : 0 : if (args.IsArgSet("-connect") || args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS) <= 0) {
# # # # #
# # # # #
# # ]
726 : : // when only connecting to trusted nodes, do not seed via DNS, or listen by default
727 [ # # # # ]: 0 : if (args.SoftSetBoolArg("-dnsseed", false))
728 : 0 : LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0\n");
729 [ # # # # ]: 0 : if (args.SoftSetBoolArg("-listen", false))
730 : 0 : LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0\n");
731 : : }
732 : :
733 [ # # # # ]: 0 : std::string proxy_arg = args.GetArg("-proxy", "");
734 [ # # # # ]: 0 : if (proxy_arg != "" && proxy_arg != "0") {
735 : : // to protect privacy, do not listen by default if a default proxy server is specified
736 [ # # # # : 0 : if (args.SoftSetBoolArg("-listen", false))
# # ]
737 [ # # ]: 0 : LogInfo("parameter interaction: -proxy set -> setting -listen=0\n");
738 : : // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
739 : : // to listen locally, so don't rely on this happening through -listen below.
740 [ # # # # : 0 : if (args.SoftSetBoolArg("-natpmp", false)) {
# # ]
741 [ # # ]: 0 : LogInfo("parameter interaction: -proxy set -> setting -natpmp=0\n");
742 : : }
743 : : // to protect privacy, do not discover addresses by default
744 [ # # # # : 0 : if (args.SoftSetBoolArg("-discover", false))
# # ]
745 [ # # ]: 0 : LogInfo("parameter interaction: -proxy set -> setting -discover=0\n");
746 : : }
747 : :
748 [ # # # # : 0 : if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
# # ]
749 : : // do not map ports or try to retrieve public IP when not listening (pointless)
750 [ # # # # : 0 : if (args.SoftSetBoolArg("-natpmp", false)) {
# # ]
751 [ # # ]: 0 : LogInfo("parameter interaction: -listen=0 -> setting -natpmp=0\n");
752 : : }
753 [ # # # # : 0 : if (args.SoftSetBoolArg("-discover", false))
# # ]
754 [ # # ]: 0 : LogInfo("parameter interaction: -listen=0 -> setting -discover=0\n");
755 [ # # # # : 0 : if (args.SoftSetBoolArg("-listenonion", false))
# # ]
756 [ # # ]: 0 : LogInfo("parameter interaction: -listen=0 -> setting -listenonion=0\n");
757 [ # # # # : 0 : if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
# # ]
758 [ # # ]: 0 : LogInfo("parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n");
759 : : }
760 : : }
761 : :
762 [ # # # # : 0 : if (args.IsArgSet("-externalip")) {
# # ]
763 : : // if an explicit public IP is specified, do not try to find others
764 [ # # # # : 0 : if (args.SoftSetBoolArg("-discover", false))
# # ]
765 [ # # ]: 0 : LogInfo("parameter interaction: -externalip set -> setting -discover=0\n");
766 : : }
767 : :
768 [ # # # # : 0 : if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
# # ]
769 : : // disable whitelistrelay in blocksonly mode
770 [ # # # # : 0 : if (args.SoftSetBoolArg("-whitelistrelay", false))
# # ]
771 [ # # ]: 0 : LogInfo("parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n");
772 : : // Reduce default mempool size in blocksonly mode to avoid unexpected resource usage
773 [ # # # # : 0 : if (args.SoftSetArg("-maxmempool", ToString(DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB)))
# # # # ]
774 [ # # ]: 0 : LogInfo("parameter interaction: -blocksonly=1 -> setting -maxmempool=%d\n", DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB);
775 : : }
776 : :
777 : : // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
778 [ # # # # : 0 : if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
# # ]
779 [ # # # # : 0 : if (args.SoftSetBoolArg("-whitelistrelay", true))
# # ]
780 [ # # ]: 0 : LogInfo("parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n");
781 : : }
782 [ # # # # : 0 : if (args.IsArgSet("-onlynet")) {
# # ]
783 [ # # # # ]: 0 : const auto onlynets = args.GetArgs("-onlynet");
784 [ # # ]: 0 : bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
785 : 0 : const auto n = ParseNetwork(net);
786 [ # # # # : 0 : return n == NET_IPV4 || n == NET_IPV6;
# # # # #
# # # #
# ]
787 : : });
788 [ # # # # : 0 : if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
# # # # #
# ]
789 [ # # ]: 0 : LogInfo("parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n");
790 : : }
791 : 0 : }
792 : 0 : }
793 : :
794 : : /**
795 : : * Initialize global loggers.
796 : : *
797 : : * Note that this is called very early in the process lifetime, so you should be
798 : : * careful about what global state you rely on here.
799 : : */
800 : 0 : void InitLogging(const ArgsManager& args)
801 : : {
802 : 0 : init::SetLoggingOptions(args);
803 : 0 : init::LogPackageVersion();
804 : 0 : }
805 : :
806 : : namespace { // Variables internal to initialization process only
807 : :
808 : : int nMaxConnections;
809 : : int available_fds;
810 : : ServiceFlags g_local_services = ServiceFlags(NODE_NETWORK_LIMITED | NODE_WITNESS);
811 : : int64_t peer_connect_timeout;
812 : : std::set<BlockFilterType> g_enabled_filter_types;
813 : :
814 : : } // namespace
815 : :
816 : 0 : [[noreturn]] static void new_handler_terminate()
817 : : {
818 : : // Rather than throwing std::bad-alloc if allocation fails, terminate
819 : : // immediately to (try to) avoid chain corruption.
820 : : // Since logging may itself allocate memory, set the handler directly
821 : : // to terminate first.
822 : 0 : std::set_new_handler(std::terminate);
823 : 0 : LogError("Out of memory. Terminating.\n");
824 : :
825 : : // The log was successful, terminate now.
826 : 0 : std::terminate();
827 : : };
828 : :
829 : 0 : bool AppInitBasicSetup(const ArgsManager& args, std::atomic<int>& exit_status)
830 : : {
831 : : // ********************************************************* Step 1: setup
832 : : #ifdef _MSC_VER
833 : : // Turn off Microsoft heap dump noise
834 : : _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
835 : : _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
836 : : // Disable confusing "helpful" text message on abort, Ctrl-C
837 : : _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
838 : : #endif
839 : : #ifdef WIN32
840 : : // Enable heap terminate-on-corruption
841 : : HeapSetInformation(nullptr, HeapEnableTerminationOnCorruption, nullptr, 0);
842 : : #endif
843 [ # # ]: 0 : if (!SetupNetworking()) {
844 [ # # # # ]: 0 : return InitError(Untranslated("Initializing networking failed."));
845 : : }
846 : :
847 : : #ifndef WIN32
848 : : // Clean shutdown on SIGTERM
849 : 0 : registerSignalHandler(SIGTERM, HandleSIGTERM);
850 : 0 : registerSignalHandler(SIGINT, HandleSIGTERM);
851 : :
852 : : // Reopen debug.log on SIGHUP
853 : 0 : registerSignalHandler(SIGHUP, HandleSIGHUP);
854 : :
855 : : // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
856 : 0 : signal(SIGPIPE, SIG_IGN);
857 : : #else
858 : : SetConsoleCtrlHandler(consoleCtrlHandler, true);
859 : : #endif
860 : :
861 : 0 : std::set_new_handler(new_handler_terminate);
862 : :
863 : 0 : return true;
864 : : }
865 : :
866 : 0 : bool AppInitParameterInteraction(const ArgsManager& args)
867 : : {
868 : 0 : const CChainParams& chainparams = Params();
869 : : // ********************************************************* Step 2: parameter interactions
870 : :
871 : : // also see: InitParameterInteraction()
872 : :
873 : : // We drop UPnP support but kept the arg as hidden for now to display a friendlier error to user who have the
874 : : // option in their config. TODO: remove (here and above) for version 30.0.
875 [ # # # # ]: 0 : if (args.IsArgSet("-upnp")) {
876 [ # # ]: 0 : InitWarning(_("Option '-upnp' is set but UPnP support was dropped in version 29.0. Consider using '-natpmp' instead."));
877 : : }
878 : :
879 : : // Error if network-specific options (-addnode, -connect, etc) are
880 : : // specified in default section of config file, but not overridden
881 : : // on the command line or in this chain's section of the config file.
882 : 0 : ChainType chain = args.GetChainType();
883 [ # # ]: 0 : if (chain == ChainType::SIGNET) {
884 [ # # ]: 0 : LogPrintf("Signet derived magic (message start): %s\n", HexStr(chainparams.MessageStart()));
885 : : }
886 [ # # ]: 0 : bilingual_str errors;
887 [ # # # # ]: 0 : for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
888 [ # # # # : 0 : errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section.") + Untranslated("\n"), arg, ChainTypeToString(chain), ChainTypeToString(chain));
# # # # #
# # # #
# ]
889 : 0 : }
890 : :
891 [ # # ]: 0 : if (!errors.empty()) {
892 [ # # ]: 0 : return InitError(errors);
893 : : }
894 : :
895 : : // Testnet3 deprecation warning
896 [ # # ]: 0 : if (chain == ChainType::TESTNET) {
897 [ # # ]: 0 : LogInfo("Warning: Support for testnet3 is deprecated and will be removed in an upcoming release. Consider switching to testnet4.\n");
898 : : }
899 : :
900 : : // Warn if unrecognized section name are present in the config file.
901 [ # # ]: 0 : bilingual_str warnings;
902 [ # # # # ]: 0 : for (const auto& section : args.GetUnrecognizedSections()) {
903 [ # # # # : 0 : warnings += strprintf(Untranslated("%s:%i ") + _("Section [%s] is not recognized.") + Untranslated("\n"), section.m_file, section.m_line, section.m_name);
# # # # #
# # # # #
# # ]
904 : 0 : }
905 : :
906 [ # # ]: 0 : if (!warnings.empty()) {
907 [ # # ]: 0 : InitWarning(warnings);
908 : : }
909 : :
910 [ # # # # : 0 : if (!fs::is_directory(args.GetBlocksDirPath())) {
# # ]
911 [ # # # # : 0 : return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
# # # # #
# # # ]
912 : : }
913 : :
914 : : // parse and validate enabled filter types
915 [ # # # # : 0 : std::string blockfilterindex_value = args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
# # ]
916 [ # # # # ]: 0 : if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
917 [ # # # # ]: 0 : g_enabled_filter_types = AllBlockFilterTypes();
918 [ # # ]: 0 : } else if (blockfilterindex_value != "0") {
919 [ # # # # ]: 0 : const std::vector<std::string> names = args.GetArgs("-blockfilterindex");
920 [ # # ]: 0 : for (const auto& name : names) {
921 : 0 : BlockFilterType filter_type;
922 [ # # # # ]: 0 : if (!BlockFilterTypeByName(name, filter_type)) {
923 [ # # # # : 0 : return InitError(strprintf(_("Unknown -blockfilterindex value %s."), name));
# # ]
924 : : }
925 [ # # ]: 0 : g_enabled_filter_types.insert(filter_type);
926 : : }
927 : 0 : }
928 : :
929 : : // Signal NODE_P2P_V2 if BIP324 v2 transport is enabled.
930 [ # # # # : 0 : if (args.GetBoolArg("-v2transport", DEFAULT_V2_TRANSPORT)) {
# # ]
931 : 0 : g_local_services = ServiceFlags(g_local_services | NODE_P2P_V2);
932 : : }
933 : :
934 : : // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index are both enabled.
935 [ # # # # : 0 : if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
# # ]
936 [ # # ]: 0 : if (g_enabled_filter_types.count(BlockFilterType::BASIC) != 1) {
937 [ # # # # ]: 0 : return InitError(_("Cannot set -peerblockfilters without -blockfilterindex."));
938 : : }
939 : :
940 : 0 : g_local_services = ServiceFlags(g_local_services | NODE_COMPACT_FILTERS);
941 : : }
942 : :
943 [ # # # # : 0 : if (args.GetIntArg("-prune", 0)) {
# # ]
944 [ # # # # : 0 : if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX))
# # ]
945 [ # # # # ]: 0 : return InitError(_("Prune mode is incompatible with -txindex."));
946 [ # # # # : 0 : if (args.GetBoolArg("-reindex-chainstate", false)) {
# # ]
947 [ # # # # ]: 0 : return InitError(_("Prune mode is incompatible with -reindex-chainstate. Use full -reindex instead."));
948 : : }
949 : : }
950 : :
951 : : // If -forcednsseed is set to true, ensure -dnsseed has not been set to false
952 [ # # # # : 0 : if (args.GetBoolArg("-forcednsseed", DEFAULT_FORCEDNSSEED) && !args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED)){
# # # # #
# # # # #
# # ]
953 [ # # # # ]: 0 : return InitError(_("Cannot set -forcednsseed to true when setting -dnsseed to false."));
954 : : }
955 : :
956 : : // -bind and -whitebind can't be set when not listening
957 [ # # # # : 0 : size_t nUserBind = args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
# # # # ]
958 [ # # # # : 0 : if (nUserBind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
# # # # #
# ]
959 [ # # # # : 0 : return InitError(Untranslated("Cannot set -bind or -whitebind together with -listen=0"));
# # ]
960 : : }
961 : :
962 : : // if listen=0, then disallow listenonion=1
963 [ # # # # : 0 : if (!args.GetBoolArg("-listen", DEFAULT_LISTEN) && args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
# # # # #
# # # # #
# # ]
964 [ # # # # : 0 : return InitError(Untranslated("Cannot set -listen=0 together with -listenonion=1"));
# # ]
965 : : }
966 : :
967 : : // Make sure enough file descriptors are available. We need to reserve enough FDs to account for the bare minimum,
968 : : // plus all manual connections and all bound interfaces. Any remainder will be available for connection sockets
969 : :
970 : : // Number of bound interfaces (we have at least one)
971 [ # # ]: 0 : int nBind = std::max(nUserBind, size_t(1));
972 : : // Maximum number of connections with other nodes, this accounts for all types of outbounds and inbounds except for manual
973 [ # # # # ]: 0 : int user_max_connection = args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
974 [ # # ]: 0 : if (user_max_connection < 0) {
975 [ # # # # : 0 : return InitError(Untranslated("-maxconnections must be greater or equal than zero"));
# # ]
976 : : }
977 : : // Reserve enough FDs to account for the bare minimum, plus any manual connections, plus the bound interfaces
978 : 0 : int min_required_fds = MIN_CORE_FDS + MAX_ADDNODE_CONNECTIONS + nBind;
979 : :
980 : : // Try raising the FD limit to what we need (available_fds may be smaller than the requested amount if this fails)
981 [ # # ]: 0 : available_fds = RaiseFileDescriptorLimit(user_max_connection + min_required_fds);
982 : : // If we are using select instead of poll, our actual limit may be even smaller
983 : : #ifndef USE_POLL
984 : : available_fds = std::min(FD_SETSIZE, available_fds);
985 : : #endif
986 [ # # ]: 0 : if (available_fds < min_required_fds)
987 [ # # # # : 0 : return InitError(strprintf(_("Not enough file descriptors available. %d available, %d required."), available_fds, min_required_fds));
# # ]
988 : :
989 : : // Trim requested connection counts, to fit into system limitations
990 [ # # ]: 0 : nMaxConnections = std::min(available_fds - min_required_fds, user_max_connection);
991 : :
992 [ # # ]: 0 : if (nMaxConnections < user_max_connection)
993 [ # # # # : 0 : InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), user_max_connection, nMaxConnections));
# # ]
994 : :
995 : : // ********************************************************* Step 3: parameter-to-internal-flags
996 [ # # # # : 0 : if (auto result{init::SetLoggingCategories(args)}; !result) return InitError(util::ErrorString(result));
# # # # ]
997 [ # # # # : 0 : if (auto result{init::SetLoggingLevel(args)}; !result) return InitError(util::ErrorString(result));
# # # # ]
998 : :
999 [ # # # # ]: 0 : nConnectTimeout = args.GetIntArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1000 [ # # ]: 0 : if (nConnectTimeout <= 0) {
1001 : 0 : nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1002 : : }
1003 : :
1004 [ # # # # ]: 0 : peer_connect_timeout = args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
1005 [ # # ]: 0 : if (peer_connect_timeout <= 0) {
1006 [ # # # # : 0 : return InitError(Untranslated("peertimeout must be a positive integer."));
# # ]
1007 : : }
1008 : :
1009 : : // Sanity check argument for min fee for including tx in block
1010 : : // TODO: Harmonize which arguments need sanity checking and where that happens
1011 [ # # # # : 0 : if (args.IsArgSet("-blockmintxfee")) {
# # ]
1012 [ # # # # : 0 : if (!ParseMoney(args.GetArg("-blockmintxfee", ""))) {
# # # # #
# ]
1013 [ # # # # : 0 : return InitError(AmountErrMsg("blockmintxfee", args.GetArg("-blockmintxfee", "")));
# # # # #
# # # ]
1014 : : }
1015 : : }
1016 : :
1017 [ # # # # ]: 0 : nBytesPerSigOp = args.GetIntArg("-bytespersigop", nBytesPerSigOp);
1018 : :
1019 [ # # # # ]: 0 : if (!g_wallet_init_interface.ParameterInteraction()) return false;
1020 : :
1021 : : // Option to startup with mocktime set (used for regression testing):
1022 [ # # # # : 0 : SetMockTime(args.GetIntArg("-mocktime", 0)); // SetMockTime(0) is a no-op
# # ]
1023 : :
1024 [ # # # # : 0 : if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
# # ]
1025 : 0 : g_local_services = ServiceFlags(g_local_services | NODE_BLOOM);
1026 : :
1027 [ # # # # : 0 : if (args.IsArgSet("-test")) {
# # ]
1028 [ # # ]: 0 : if (chainparams.GetChainType() != ChainType::REGTEST) {
1029 [ # # # # : 0 : return InitError(Untranslated("-test=<option> can only be used with regtest"));
# # ]
1030 : : }
1031 [ # # # # ]: 0 : const std::vector<std::string> options = args.GetArgs("-test");
1032 [ # # ]: 0 : for (const std::string& option : options) {
1033 [ # # ]: 0 : auto it = std::find_if(TEST_OPTIONS_DOC.begin(), TEST_OPTIONS_DOC.end(), [&option](const std::string& doc_option) {
1034 : 0 : size_t pos = doc_option.find(" (");
1035 [ # # # # ]: 0 : return (pos != std::string::npos) && (doc_option.substr(0, pos) == option);
1036 : : });
1037 [ # # ]: 0 : if (it == TEST_OPTIONS_DOC.end()) {
1038 [ # # # # : 0 : InitWarning(strprintf(_("Unrecognised option \"%s\" provided in -test=<option>."), option));
# # ]
1039 : : }
1040 : : }
1041 : 0 : }
1042 : :
1043 : : // Also report errors from parsing before daemonization
1044 : 0 : {
1045 : 0 : kernel::Notifications notifications{};
1046 : 0 : ChainstateManager::Options chainman_opts_dummy{
1047 : : .chainparams = chainparams,
1048 : : .datadir = args.GetDataDirNet(),
1049 : : .notifications = notifications,
1050 [ # # ]: 0 : };
1051 [ # # ]: 0 : auto chainman_result{ApplyArgsManOptions(args, chainman_opts_dummy)};
1052 [ # # ]: 0 : if (!chainman_result) {
1053 [ # # # # ]: 0 : return InitError(util::ErrorString(chainman_result));
1054 : : }
1055 : 0 : BlockManager::Options blockman_opts_dummy{
1056 : 0 : .chainparams = chainman_opts_dummy.chainparams,
1057 : : .blocks_dir = args.GetBlocksDirPath(),
1058 : 0 : .notifications = chainman_opts_dummy.notifications,
1059 [ # # ]: 0 : };
1060 [ # # ]: 0 : auto blockman_result{ApplyArgsManOptions(args, blockman_opts_dummy)};
1061 [ # # ]: 0 : if (!blockman_result) {
1062 [ # # # # ]: 0 : return InitError(util::ErrorString(blockman_result));
1063 : : }
1064 [ # # ]: 0 : CTxMemPool::Options mempool_opts{};
1065 [ # # ]: 0 : auto mempool_result{ApplyArgsManOptions(args, chainparams, mempool_opts)};
1066 [ # # ]: 0 : if (!mempool_result) {
1067 [ # # # # ]: 0 : return InitError(util::ErrorString(mempool_result));
1068 : : }
1069 : 0 : }
1070 : :
1071 : 0 : return true;
1072 : 0 : }
1073 : :
1074 : 0 : static bool LockDataDirectory(bool probeOnly)
1075 : : {
1076 : : // Make sure only a single Bitcoin process is using the data directory.
1077 : 0 : const fs::path& datadir = gArgs.GetDataDirNet();
1078 [ # # # # : 0 : switch (util::LockDirectory(datadir, ".lock", probeOnly)) {
# # # # ]
1079 : 0 : case util::LockResult::ErrorWrite:
1080 [ # # # # : 0 : return InitError(strprintf(_("Cannot write to data directory '%s'; check permissions."), fs::PathToString(datadir)));
# # # # ]
1081 : 0 : case util::LockResult::ErrorLock:
1082 [ # # # # : 0 : return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), fs::PathToString(datadir), CLIENT_NAME));
# # # # ]
1083 : : case util::LockResult::Success: return true;
1084 : : } // no default case, so the compiler can warn about missing cases
1085 : 0 : assert(false);
1086 : 0 : }
1087 : :
1088 : 0 : bool AppInitSanityChecks(const kernel::Context& kernel)
1089 : : {
1090 : : // ********************************************************* Step 4: sanity checks
1091 : 0 : auto result{kernel::SanityChecks(kernel)};
1092 [ # # ]: 0 : if (!result) {
1093 [ # # # # ]: 0 : InitError(util::ErrorString(result));
1094 [ # # # # : 0 : return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), CLIENT_NAME));
# # ]
1095 : : }
1096 : :
1097 [ # # # # ]: 0 : if (!ECC_InitSanityCheck()) {
1098 [ # # # # : 0 : return InitError(strprintf(_("Elliptic curve cryptography sanity check failure. %s is shutting down."), CLIENT_NAME));
# # ]
1099 : : }
1100 : :
1101 : : // Probe the data directory lock to give an early error message, if possible
1102 : : // We cannot hold the data directory lock here, as the forking for daemon() hasn't yet happened,
1103 : : // and a fork will cause weird behavior to it.
1104 [ # # ]: 0 : return LockDataDirectory(true);
1105 : 0 : }
1106 : :
1107 : 0 : bool AppInitLockDataDirectory()
1108 : : {
1109 : : // After daemonization get the data directory lock again and hold on to it until exit
1110 : : // This creates a slight window for a race condition to happen, however this condition is harmless: it
1111 : : // will at most make us exit without printing a message to console.
1112 [ # # ]: 0 : if (!LockDataDirectory(false)) {
1113 : : // Detailed error printed inside LockDataDirectory
1114 : 0 : return false;
1115 : : }
1116 : : return true;
1117 : : }
1118 : :
1119 : 0 : bool AppInitInterfaces(NodeContext& node)
1120 : : {
1121 : 0 : node.chain = node.init->makeChain();
1122 : 0 : node.mining = node.init->makeMining();
1123 : 0 : return true;
1124 : : }
1125 : :
1126 : 0 : bool CheckHostPortOptions(const ArgsManager& args) {
1127 : 0 : for (const std::string port_option : {
1128 : : "-port",
1129 : : "-rpcport",
1130 [ # # ]: 0 : }) {
1131 [ # # # # ]: 0 : if (args.IsArgSet(port_option)) {
1132 [ # # # # ]: 0 : const std::string port = args.GetArg(port_option, "");
1133 : 0 : uint16_t n;
1134 [ # # # # : 0 : if (!ParseUInt16(port, &n) || n == 0) {
# # ]
1135 [ # # # # ]: 0 : return InitError(InvalidPortErrMsg(port_option, port));
1136 : : }
1137 : 0 : }
1138 : 0 : }
1139 : :
1140 : 0 : for ([[maybe_unused]] const auto& [arg, unix] : std::vector<std::pair<std::string, bool>>{
1141 : : // arg name UNIX socket support
1142 : : {"-i2psam", false},
1143 : : {"-onion", true},
1144 : : {"-proxy", true},
1145 : : {"-rpcbind", false},
1146 : : {"-torcontrol", false},
1147 : : {"-whitebind", false},
1148 : : {"-zmqpubhashblock", true},
1149 : : {"-zmqpubhashtx", true},
1150 : : {"-zmqpubrawblock", true},
1151 : : {"-zmqpubrawtx", true},
1152 : : {"-zmqpubsequence", true},
1153 [ # # # # : 0 : }) {
# # # # ]
1154 [ # # # # ]: 0 : for (const std::string& socket_addr : args.GetArgs(arg)) {
1155 [ # # ]: 0 : std::string host_out;
1156 : 0 : uint16_t port_out{0};
1157 [ # # # # ]: 0 : if (!SplitHostPort(socket_addr, port_out, host_out)) {
1158 : : #ifdef HAVE_SOCKADDR_UN
1159 : : // Allow unix domain sockets for some options e.g. unix:/some/file/path
1160 [ # # # # ]: 0 : if (!unix || !socket_addr.starts_with(ADDR_PREFIX_UNIX)) {
1161 [ # # # # ]: 0 : return InitError(InvalidPortErrMsg(arg, socket_addr));
1162 : : }
1163 : : #else
1164 : : return InitError(InvalidPortErrMsg(arg, socket_addr));
1165 : : #endif
1166 : : }
1167 : 0 : }
1168 : 0 : }
1169 : :
1170 : 0 : return true;
1171 [ # # # # : 0 : }
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1172 : :
1173 : : // A GUI user may opt to retry once with do_reindex set if there is a failure during chainstate initialization.
1174 : : // The function therefore has to support re-entry.
1175 : 0 : static ChainstateLoadResult InitAndLoadChainstate(
1176 : : NodeContext& node,
1177 : : bool do_reindex,
1178 : : const bool do_reindex_chainstate,
1179 : : CacheSizes& cache_sizes,
1180 : : const ArgsManager& args)
1181 : : {
1182 : 0 : const CChainParams& chainparams = Params();
1183 [ # # ]: 0 : CTxMemPool::Options mempool_opts{
1184 [ # # ]: 0 : .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
1185 : 0 : .signals = node.validation_signals.get(),
1186 : 0 : };
1187 [ # # ]: 0 : Assert(ApplyArgsManOptions(args, chainparams, mempool_opts)); // no error can happen, already checked in AppInitParameterInteraction
1188 [ # # ]: 0 : bilingual_str mempool_error;
1189 [ # # ]: 0 : node.mempool = std::make_unique<CTxMemPool>(mempool_opts, mempool_error);
1190 [ # # ]: 0 : if (!mempool_error.empty()) {
1191 [ # # ]: 0 : return {ChainstateLoadStatus::FAILURE_FATAL, mempool_error};
1192 : : }
1193 [ # # ]: 0 : LogPrintf("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of unused mempool space)\n", cache_sizes.coins * (1.0 / 1024 / 1024), mempool_opts.max_size_bytes * (1.0 / 1024 / 1024));
1194 : 0 : ChainstateManager::Options chainman_opts{
1195 : : .chainparams = chainparams,
1196 : : .datadir = args.GetDataDirNet(),
1197 [ # # ]: 0 : .notifications = *node.notifications,
1198 : 0 : .signals = node.validation_signals.get(),
1199 [ # # ]: 0 : };
1200 [ # # # # ]: 0 : Assert(ApplyArgsManOptions(args, chainman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1201 : 0 : BlockManager::Options blockman_opts{
1202 : 0 : .chainparams = chainman_opts.chainparams,
1203 : : .blocks_dir = args.GetBlocksDirPath(),
1204 : 0 : .notifications = chainman_opts.notifications,
1205 [ # # ]: 0 : };
1206 [ # # # # ]: 0 : Assert(ApplyArgsManOptions(args, blockman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1207 : 0 : try {
1208 [ # # # # ]: 0 : node.chainman = std::make_unique<ChainstateManager>(*Assert(node.shutdown_signal), chainman_opts, blockman_opts);
1209 [ - - ]: 0 : } catch (std::exception& e) {
1210 [ - - - - : 0 : return {ChainstateLoadStatus::FAILURE_FATAL, strprintf(Untranslated("Failed to initialize ChainstateManager: %s"), e.what())};
- - ]
1211 : 0 : }
1212 : 0 : ChainstateManager& chainman = *node.chainman;
1213 : : // This is defined and set here instead of inline in validation.h to avoid a hard
1214 : : // dependency between validation and index/base, since the latter is not in
1215 : : // libbitcoinkernel.
1216 : 0 : chainman.snapshot_download_completed = [&node]() {
1217 [ # # ]: 0 : if (!node.chainman->m_blockman.IsPruneMode()) {
1218 : 0 : LogPrintf("[snapshot] re-enabling NODE_NETWORK services\n");
1219 : 0 : node.connman->AddLocalServices(NODE_NETWORK);
1220 : : }
1221 : 0 : LogPrintf("[snapshot] restarting indexes\n");
1222 : : // Drain the validation interface queue to ensure that the old indexes
1223 : : // don't have any pending work.
1224 : 0 : Assert(node.validation_signals)->SyncWithValidationInterfaceQueue();
1225 [ # # ]: 0 : for (auto* index : node.indexes) {
1226 : 0 : index->Interrupt();
1227 : 0 : index->Stop();
1228 [ # # # # ]: 0 : if (!(index->Init() && index->StartBackgroundSync())) {
1229 : 0 : LogPrintf("[snapshot] WARNING failed to restart index %s on snapshot chain\n", index->GetName());
1230 : : }
1231 : : }
1232 : 0 : };
1233 [ # # ]: 0 : node::ChainstateLoadOptions options;
1234 [ # # ]: 0 : options.mempool = Assert(node.mempool.get());
1235 : 0 : options.wipe_block_tree_db = do_reindex;
1236 : 0 : options.wipe_chainstate_db = do_reindex || do_reindex_chainstate;
1237 [ # # ]: 0 : options.prune = chainman.m_blockman.IsPruneMode();
1238 [ # # # # ]: 0 : options.check_blocks = args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
1239 [ # # # # ]: 0 : options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
1240 [ # # # # : 0 : options.require_full_verification = args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
# # # # #
# # # #
# ]
1241 : 0 : options.coins_error_cb = [] {
1242 [ # # ]: 0 : uiInterface.ThreadSafeMessageBox(
1243 [ # # ]: 0 : _("Error reading from database, shutting down."),
1244 : : "", CClientUIInterface::MSG_ERROR);
1245 : 0 : };
1246 [ # # # # ]: 0 : uiInterface.InitMessage(_("Loading block index…").translated);
1247 : 0 : const auto load_block_index_start_time{SteadyClock::now()};
1248 : 0 : auto catch_exceptions = [](auto&& f) {
1249 : : try {
1250 [ # # ]: 0 : return f();
1251 [ - - ]: 0 : } catch (const std::exception& e) {
1252 [ - - ]: 0 : LogError("%s\n", e.what());
1253 [ - - ]: 0 : return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1254 : : }
1255 : : };
1256 [ # # # # ]: 0 : auto [status, error] = catch_exceptions([&] { return LoadChainstate(chainman, cache_sizes, options); });
1257 [ # # ]: 0 : if (status == node::ChainstateLoadStatus::SUCCESS) {
1258 [ # # # # ]: 0 : uiInterface.InitMessage(_("Verifying blocks…").translated);
1259 [ # # # # ]: 0 : if (chainman.m_blockman.m_have_pruned && options.check_blocks > MIN_BLOCKS_TO_KEEP) {
1260 [ # # ]: 0 : LogWarning("pruned datadir may not have more than %d blocks; only checking available blocks\n",
1261 : : MIN_BLOCKS_TO_KEEP);
1262 : : }
1263 [ # # # # ]: 0 : std::tie(status, error) = catch_exceptions([&] { return VerifyLoadedChainstate(chainman, options); });
1264 [ # # ]: 0 : if (status == node::ChainstateLoadStatus::SUCCESS) {
1265 [ # # ]: 0 : LogPrintf(" block index %15dms\n", Ticks<std::chrono::milliseconds>(SteadyClock::now() - load_block_index_start_time));
1266 : : }
1267 : : }
1268 [ # # ]: 0 : return {status, error};
1269 : 0 : };
1270 : :
1271 : 0 : bool AppInitMain(NodeContext& node, interfaces::BlockAndHeaderTipInfo* tip_info)
1272 : : {
1273 : 0 : const ArgsManager& args = *Assert(node.args);
1274 : 0 : const CChainParams& chainparams = Params();
1275 : :
1276 [ # # # # ]: 0 : auto opt_max_upload = ParseByteUnits(args.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET), ByteUnit::M);
1277 [ # # ]: 0 : if (!opt_max_upload) {
1278 [ # # # # : 0 : return InitError(strprintf(_("Unable to parse -maxuploadtarget: '%s'"), args.GetArg("-maxuploadtarget", "")));
# # # # #
# ]
1279 : : }
1280 : :
1281 : : // ********************************************************* Step 4a: application initialization
1282 [ # # ]: 0 : if (!CreatePidFile(args)) {
1283 : : // Detailed error printed inside CreatePidFile().
1284 : : return false;
1285 : : }
1286 [ # # ]: 0 : if (!init::StartLogging(args)) {
1287 : : // Detailed error printed inside StartLogging().
1288 : : return false;
1289 : : }
1290 : :
1291 : 0 : LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, available_fds);
1292 : :
1293 : : // Warn about relative -datadir path.
1294 [ # # # # : 0 : if (args.IsArgSet("-datadir") && !args.GetPathArg("-datadir").is_absolute()) {
# # # # #
# # # # #
# # # # #
# # # #
# ]
1295 [ # # # # : 0 : LogPrintf("Warning: relative datadir option '%s' specified, which will be interpreted relative to the "
# # # # #
# ]
1296 : : "current working directory '%s'. This is fragile, because if bitcoin is started in the future "
1297 : : "from a different location, it will be unable to locate the current data files. There could "
1298 : : "also be data loss if bitcoin is started while in a temporary directory.\n",
1299 : : args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1300 : : }
1301 : :
1302 [ # # ]: 0 : assert(!node.scheduler);
1303 : 0 : node.scheduler = std::make_unique<CScheduler>();
1304 : 0 : auto& scheduler = *node.scheduler;
1305 : :
1306 : : // Start the lightweight task scheduler thread
1307 : 0 : scheduler.m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { scheduler.serviceQueue(); });
1308 : :
1309 : : // Gather some entropy once per minute.
1310 [ # # ]: 0 : scheduler.scheduleEvery([]{
1311 : 0 : RandAddPeriodic();
1312 : 0 : }, std::chrono::minutes{1});
1313 : :
1314 : : // Check disk space every 5 minutes to avoid db corruption.
1315 [ # # ]: 0 : scheduler.scheduleEvery([&args, &node]{
1316 : 0 : constexpr uint64_t min_disk_space = 50 << 20; // 50 MB
1317 [ # # # # ]: 0 : if (!CheckDiskSpace(args.GetBlocksDirPath(), min_disk_space)) {
1318 : 0 : LogError("Shutting down due to lack of disk space!\n");
1319 [ # # ]: 0 : if (!(Assert(node.shutdown_request))()) {
1320 : 0 : LogError("Failed to send shutdown signal after disk space check\n");
1321 : : }
1322 : : }
1323 : 0 : }, std::chrono::minutes{5});
1324 : :
1325 [ # # ]: 0 : assert(!node.validation_signals);
1326 [ # # ]: 0 : node.validation_signals = std::make_unique<ValidationSignals>(std::make_unique<SerialTaskRunner>(scheduler));
1327 : 0 : auto& validation_signals = *node.validation_signals;
1328 : :
1329 : : // Create client interfaces for wallets that are supposed to be loaded
1330 : : // according to -wallet and -disablewallet options. This only constructs
1331 : : // the interfaces, it doesn't load wallet data. Wallets actually get loaded
1332 : : // when load() and start() interface methods are called below.
1333 : 0 : g_wallet_init_interface.Construct(node);
1334 : 0 : uiInterface.InitWallet();
1335 : :
1336 [ # # ]: 0 : if (interfaces::Ipc* ipc = node.init->ipc()) {
1337 [ # # # # : 0 : for (std::string address : gArgs.GetArgs("-ipcbind")) {
# # ]
1338 : 0 : try {
1339 [ # # ]: 0 : ipc->listenAddress(address);
1340 [ - - ]: 0 : } catch (const std::exception& e) {
1341 [ - - - - : 0 : return InitError(strprintf(Untranslated("Unable to bind to IPC address '%s'. %s"), address, e.what()));
- - - - ]
1342 : 0 : }
1343 [ # # ]: 0 : LogPrintf("Listening for IPC requests on address %s\n", address);
1344 : 0 : }
1345 : : }
1346 : :
1347 : : /* Register RPC commands regardless of -server setting so they will be
1348 : : * available in the GUI RPC console even if external calls are disabled.
1349 : : */
1350 : 0 : RegisterAllCoreRPCCommands(tableRPC);
1351 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
1352 : 0 : client->registerRpcs();
1353 : : }
1354 : : #ifdef ENABLE_ZMQ
1355 : : RegisterZMQRPCCommands(tableRPC);
1356 : : #endif
1357 : :
1358 : : // Check port numbers
1359 [ # # ]: 0 : if (!CheckHostPortOptions(args)) return false;
1360 : :
1361 : : /* Start the RPC server already. It will be started in "warmup" mode
1362 : : * and not really process calls already (but it will signify connections
1363 : : * that the server is there and will be ready later). Warmup mode will
1364 : : * be disabled when initialisation is finished.
1365 : : */
1366 [ # # # # ]: 0 : if (args.GetBoolArg("-server", false)) {
1367 [ # # ]: 0 : uiInterface.InitMessage_connect(SetRPCWarmupStatus);
1368 [ # # ]: 0 : if (!AppInitServers(node))
1369 [ # # ]: 0 : return InitError(_("Unable to start HTTP server. See debug log for details."));
1370 : : }
1371 : :
1372 : : // ********************************************************* Step 5: verify wallet database integrity
1373 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
1374 [ # # ]: 0 : if (!client->verify()) {
1375 : : return false;
1376 : : }
1377 : : }
1378 : :
1379 : : // ********************************************************* Step 6: network initialization
1380 : : // Note that we absolutely cannot open any actual connections
1381 : : // until the very end ("start node") as the UTXO/block state
1382 : : // is not yet setup and may end up being set up twice if we
1383 : : // need to reindex later.
1384 : :
1385 [ # # ]: 0 : fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
1386 [ # # ]: 0 : fDiscover = args.GetBoolArg("-discover", true);
1387 : :
1388 : 0 : PeerManager::Options peerman_opts{};
1389 : 0 : ApplyArgsManOptions(args, peerman_opts);
1390 : :
1391 : 0 : {
1392 : :
1393 : : // Read asmap file if configured
1394 : 0 : std::vector<bool> asmap;
1395 [ # # # # : 0 : if (args.IsArgSet("-asmap")) {
# # ]
1396 [ # # # # : 0 : fs::path asmap_path = args.GetPathArg("-asmap", DEFAULT_ASMAP_FILENAME);
# # ]
1397 [ # # ]: 0 : if (!asmap_path.is_absolute()) {
1398 [ # # # # ]: 0 : asmap_path = args.GetDataDirNet() / asmap_path;
1399 : : }
1400 [ # # # # ]: 0 : if (!fs::exists(asmap_path)) {
1401 [ # # # # : 0 : InitError(strprintf(_("Could not find asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
# # # # ]
1402 : 0 : return false;
1403 : : }
1404 [ # # # # ]: 0 : asmap = DecodeAsmap(asmap_path);
1405 [ # # ]: 0 : if (asmap.size() == 0) {
1406 [ # # # # : 0 : InitError(strprintf(_("Could not parse asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
# # # # ]
1407 : 0 : return false;
1408 : : }
1409 [ # # # # : 0 : const uint256 asmap_version = (HashWriter{} << asmap).GetHash();
# # ]
1410 [ # # # # ]: 0 : LogPrintf("Using asmap version %s for IP bucketing\n", asmap_version.ToString());
1411 : 0 : } else {
1412 [ # # ]: 0 : LogPrintf("Using /16 prefix for IP bucketing\n");
1413 : : }
1414 : :
1415 : : // Initialize netgroup manager
1416 [ # # ]: 0 : assert(!node.netgroupman);
1417 [ # # ]: 0 : node.netgroupman = std::make_unique<NetGroupManager>(std::move(asmap));
1418 : :
1419 : : // Initialize addrman
1420 [ # # ]: 0 : assert(!node.addrman);
1421 [ # # # # ]: 0 : uiInterface.InitMessage(_("Loading P2P addresses…").translated);
1422 [ # # ]: 0 : auto addrman{LoadAddrman(*node.netgroupman, args)};
1423 [ # # # # : 0 : if (!addrman) return InitError(util::ErrorString(addrman));
# # ]
1424 : 0 : node.addrman = std::move(*addrman);
1425 : 0 : }
1426 : :
1427 : 0 : FastRandomContext rng;
1428 [ # # ]: 0 : assert(!node.banman);
1429 [ # # # # : 0 : node.banman = std::make_unique<BanMan>(args.GetDataDirNet() / "banlist", &uiInterface, args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
# # # # #
# ]
1430 [ # # ]: 0 : assert(!node.connman);
1431 [ # # # # ]: 0 : node.connman = std::make_unique<CConnman>(rng.rand64(),
1432 : 0 : rng.rand64(),
1433 [ # # # # ]: 0 : *node.addrman, *node.netgroupman, chainparams, args.GetBoolArg("-networkactive", true));
1434 : :
1435 [ # # ]: 0 : assert(!node.fee_estimator);
1436 : : // Don't initialize fee estimation with old data if we don't relay transactions,
1437 : : // as they would never get updated.
1438 [ # # ]: 0 : if (!peerman_opts.ignore_incoming_txs) {
1439 [ # # # # ]: 0 : bool read_stale_estimates = args.GetBoolArg("-acceptstalefeeestimates", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES);
1440 [ # # # # ]: 0 : if (read_stale_estimates && (chainparams.GetChainType() != ChainType::REGTEST)) {
1441 [ # # # # : 0 : return InitError(strprintf(_("acceptstalefeeestimates is not supported on %s chain."), chainparams.GetChainTypeString()));
# # # # ]
1442 : : }
1443 [ # # # # ]: 0 : node.fee_estimator = std::make_unique<CBlockPolicyEstimator>(FeeestPath(args), read_stale_estimates);
1444 : :
1445 : : // Flush estimates to disk periodically
1446 : 0 : CBlockPolicyEstimator* fee_estimator = node.fee_estimator.get();
1447 [ # # ]: 0 : scheduler.scheduleEvery([fee_estimator] { fee_estimator->FlushFeeEstimates(); }, FEE_FLUSH_INTERVAL);
1448 [ # # ]: 0 : validation_signals.RegisterValidationInterface(fee_estimator);
1449 : : }
1450 : :
1451 [ # # # # : 0 : for (const std::string& socket_addr : args.GetArgs("-bind")) {
# # ]
1452 [ # # ]: 0 : std::string host_out;
1453 : 0 : uint16_t port_out{0};
1454 [ # # ]: 0 : std::string bind_socket_addr = socket_addr.substr(0, socket_addr.rfind('='));
1455 [ # # # # ]: 0 : if (!SplitHostPort(bind_socket_addr, port_out, host_out)) {
1456 [ # # # # : 0 : return InitError(InvalidPortErrMsg("-bind", socket_addr));
# # ]
1457 : : }
1458 : 0 : }
1459 : :
1460 : : // sanitize comments per BIP-0014, format user agent and check total size
1461 : 0 : std::vector<std::string> uacomments;
1462 [ # # # # : 0 : for (const std::string& cmt : args.GetArgs("-uacomment")) {
# # ]
1463 [ # # # # ]: 0 : if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1464 [ # # # # : 0 : return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
# # ]
1465 [ # # ]: 0 : uacomments.push_back(cmt);
1466 : 0 : }
1467 [ # # ]: 0 : strSubVersion = FormatSubVersion(UA_NAME, CLIENT_VERSION, uacomments);
1468 [ # # ]: 0 : if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1469 [ # # # # ]: 0 : return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1470 [ # # ]: 0 : strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1471 : : }
1472 : :
1473 [ # # # # : 0 : if (args.IsArgSet("-onlynet")) {
# # ]
1474 [ # # ]: 0 : g_reachable_nets.RemoveAll();
1475 [ # # # # : 0 : for (const std::string& snet : args.GetArgs("-onlynet")) {
# # ]
1476 [ # # ]: 0 : enum Network net = ParseNetwork(snet);
1477 [ # # ]: 0 : if (net == NET_UNROUTABLE)
1478 [ # # # # : 0 : return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
# # ]
1479 [ # # ]: 0 : g_reachable_nets.Add(net);
1480 : 0 : }
1481 : : }
1482 : :
1483 [ # # # # : 0 : if (!args.IsArgSet("-cjdnsreachable")) {
# # ]
1484 [ # # # # : 0 : if (args.IsArgSet("-onlynet") && g_reachable_nets.Contains(NET_CJDNS)) {
# # # # #
# # # ]
1485 [ # # ]: 0 : return InitError(
1486 [ # # ]: 0 : _("Outbound connections restricted to CJDNS (-onlynet=cjdns) but "
1487 : : "-cjdnsreachable is not provided"));
1488 : : }
1489 [ # # ]: 0 : g_reachable_nets.Remove(NET_CJDNS);
1490 : : }
1491 : : // Now g_reachable_nets.Contains(NET_CJDNS) is true if:
1492 : : // 1. -cjdnsreachable is given and
1493 : : // 2.1. -onlynet is not given or
1494 : : // 2.2. -onlynet=cjdns is given
1495 : :
1496 : : // Requesting DNS seeds entails connecting to IPv4/IPv6, which -onlynet options may prohibit:
1497 : : // If -dnsseed=1 is explicitly specified, abort. If it's left unspecified by the user, we skip
1498 : : // the DNS seeds by adjusting -dnsseed in InitParameterInteraction.
1499 [ # # # # : 0 : if (args.GetBoolArg("-dnsseed") == true && !g_reachable_nets.Contains(NET_IPV4) && !g_reachable_nets.Contains(NET_IPV6)) {
# # # # #
# # # #
# ]
1500 [ # # # # : 0 : return InitError(strprintf(_("Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")));
# # ]
1501 : 0 : };
1502 : :
1503 : : // Check for host lookup allowed before parsing any network related parameters
1504 [ # # # # ]: 0 : fNameLookup = args.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1505 : :
1506 [ # # ]: 0 : Proxy onion_proxy;
1507 : :
1508 [ # # # # ]: 0 : bool proxyRandomize = args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1509 : : // -proxy sets a proxy for all outgoing network traffic
1510 : : // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1511 [ # # # # : 0 : std::string proxyArg = args.GetArg("-proxy", "");
# # ]
1512 [ # # # # ]: 0 : if (proxyArg != "" && proxyArg != "0") {
1513 [ # # ]: 0 : Proxy addrProxy;
1514 [ # # # # ]: 0 : if (IsUnixSocketPath(proxyArg)) {
1515 [ # # # # ]: 0 : addrProxy = Proxy(proxyArg, proxyRandomize);
1516 : : } else {
1517 [ # # # # ]: 0 : const std::optional<CService> proxyAddr{Lookup(proxyArg, 9050, fNameLookup)};
1518 [ # # ]: 0 : if (!proxyAddr.has_value()) {
1519 [ # # # # : 0 : return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
# # ]
1520 : : }
1521 : :
1522 : 0 : addrProxy = Proxy(proxyAddr.value(), proxyRandomize);
1523 : 0 : }
1524 : :
1525 [ # # # # ]: 0 : if (!addrProxy.IsValid())
1526 [ # # # # : 0 : return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
# # ]
1527 : :
1528 [ # # ]: 0 : SetProxy(NET_IPV4, addrProxy);
1529 [ # # ]: 0 : SetProxy(NET_IPV6, addrProxy);
1530 [ # # ]: 0 : SetProxy(NET_CJDNS, addrProxy);
1531 [ # # ]: 0 : SetNameProxy(addrProxy);
1532 [ # # ]: 0 : onion_proxy = addrProxy;
1533 : 0 : }
1534 : :
1535 [ # # # # : 0 : const bool onlynet_used_with_onion{args.IsArgSet("-onlynet") && g_reachable_nets.Contains(NET_ONION)};
# # # # #
# ]
1536 : :
1537 : : // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1538 : : // -noonion (or -onion=0) disables connecting to .onion entirely
1539 : : // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1540 [ # # # # : 0 : std::string onionArg = args.GetArg("-onion", "");
# # ]
1541 [ # # ]: 0 : if (onionArg != "") {
1542 [ # # ]: 0 : if (onionArg == "0") { // Handle -noonion/-onion=0
1543 [ # # ]: 0 : onion_proxy = Proxy{};
1544 [ # # ]: 0 : if (onlynet_used_with_onion) {
1545 [ # # ]: 0 : return InitError(
1546 [ # # ]: 0 : _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1547 : : "reaching the Tor network is explicitly forbidden: -onion=0"));
1548 : : }
1549 : : } else {
1550 [ # # # # ]: 0 : if (IsUnixSocketPath(onionArg)) {
1551 [ # # # # ]: 0 : onion_proxy = Proxy(onionArg, proxyRandomize);
1552 : : } else {
1553 [ # # # # ]: 0 : const std::optional<CService> addr{Lookup(onionArg, 9050, fNameLookup)};
1554 [ # # # # : 0 : if (!addr.has_value() || !addr->IsValid()) {
# # ]
1555 [ # # # # : 0 : return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
# # ]
1556 : : }
1557 : :
1558 [ # # ]: 0 : onion_proxy = Proxy(addr.value(), proxyRandomize);
1559 : 0 : }
1560 : : }
1561 : : }
1562 : :
1563 [ # # # # ]: 0 : if (onion_proxy.IsValid()) {
1564 [ # # ]: 0 : SetProxy(NET_ONION, onion_proxy);
1565 : : } else {
1566 : : // If -listenonion is set, then we will (try to) connect to the Tor control port
1567 : : // later from the torcontrol thread and may retrieve the onion proxy from there.
1568 [ # # # # ]: 0 : const bool listenonion_disabled{!args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
1569 [ # # ]: 0 : if (onlynet_used_with_onion && listenonion_disabled) {
1570 [ # # ]: 0 : return InitError(
1571 [ # # ]: 0 : _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1572 : : "reaching the Tor network is not provided: none of -proxy, -onion or "
1573 : : "-listenonion is given"));
1574 : : }
1575 [ # # ]: 0 : g_reachable_nets.Remove(NET_ONION);
1576 : : }
1577 : :
1578 [ # # # # : 0 : for (const std::string& strAddr : args.GetArgs("-externalip")) {
# # ]
1579 [ # # # # : 0 : const std::optional<CService> addrLocal{Lookup(strAddr, GetListenPort(), fNameLookup)};
# # ]
1580 [ # # # # : 0 : if (addrLocal.has_value() && addrLocal->IsValid())
# # ]
1581 [ # # # # ]: 0 : AddLocal(addrLocal.value(), LOCAL_MANUAL);
1582 : : else
1583 [ # # # # : 0 : return InitError(ResolveErrMsg("externalip", strAddr));
# # ]
1584 : 0 : }
1585 : :
1586 : : #ifdef ENABLE_ZMQ
1587 : : g_zmq_notification_interface = CZMQNotificationInterface::Create(
1588 : : [&chainman = node.chainman](std::vector<uint8_t>& block, const CBlockIndex& index) {
1589 : : assert(chainman);
1590 : : return chainman->m_blockman.ReadRawBlockFromDisk(block, WITH_LOCK(cs_main, return index.GetBlockPos()));
1591 : : });
1592 : :
1593 : : if (g_zmq_notification_interface) {
1594 : : validation_signals.RegisterValidationInterface(g_zmq_notification_interface.get());
1595 : : }
1596 : : #endif
1597 : :
1598 : : // ********************************************************* Step 7: load block chain
1599 : :
1600 [ # # # # : 0 : node.notifications = std::make_unique<KernelNotifications>(Assert(node.shutdown_request), node.exit_status, *Assert(node.warnings));
# # ]
1601 [ # # ]: 0 : auto& kernel_notifications{*node.notifications};
1602 [ # # ]: 0 : ReadNotificationArgs(args, kernel_notifications);
1603 : :
1604 : : // cache size calculations
1605 [ # # ]: 0 : CacheSizes cache_sizes = CalculateCacheSizes(args, g_enabled_filter_types.size());
1606 : :
1607 [ # # ]: 0 : LogPrintf("Cache configuration:\n");
1608 [ # # ]: 0 : LogPrintf("* Using %.1f MiB for block index database\n", cache_sizes.block_tree_db * (1.0 / 1024 / 1024));
1609 [ # # # # : 0 : if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
# # ]
1610 [ # # ]: 0 : LogPrintf("* Using %.1f MiB for transaction index database\n", cache_sizes.tx_index * (1.0 / 1024 / 1024));
1611 : : }
1612 [ # # ]: 0 : for (BlockFilterType filter_type : g_enabled_filter_types) {
1613 [ # # # # ]: 0 : LogPrintf("* Using %.1f MiB for %s block filter index database\n",
1614 : : cache_sizes.filter_index * (1.0 / 1024 / 1024), BlockFilterTypeName(filter_type));
1615 : : }
1616 [ # # ]: 0 : LogPrintf("* Using %.1f MiB for chain state database\n", cache_sizes.coins_db * (1.0 / 1024 / 1024));
1617 : :
1618 [ # # ]: 0 : assert(!node.mempool);
1619 [ # # ]: 0 : assert(!node.chainman);
1620 : :
1621 [ # # # # ]: 0 : bool do_reindex{args.GetBoolArg("-reindex", false)};
1622 [ # # # # ]: 0 : const bool do_reindex_chainstate{args.GetBoolArg("-reindex-chainstate", false)};
1623 : :
1624 : : // Chainstate initialization and loading may be retried once with reindexing by GUI users
1625 [ # # ]: 0 : auto [status, error] = InitAndLoadChainstate(
1626 : : node,
1627 : : do_reindex,
1628 : : do_reindex_chainstate,
1629 : : cache_sizes,
1630 [ # # ]: 0 : args);
1631 [ # # # # : 0 : if (status == ChainstateLoadStatus::FAILURE && !do_reindex && !ShutdownRequested(node)) {
# # # # ]
1632 : : // suggest a reindex
1633 [ # # ]: 0 : bool do_retry = uiInterface.ThreadSafeQuestion(
1634 [ # # # # : 0 : error + Untranslated(".\n\n") + _("Do you want to rebuild the databases now?"),
# # # # #
# # # ]
1635 [ # # ]: 0 : error.original + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1636 : : "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1637 [ # # ]: 0 : if (!do_retry) {
1638 : : return false;
1639 : : }
1640 : 0 : do_reindex = true;
1641 [ # # # # : 0 : if (!Assert(node.shutdown_signal)->reset()) {
# # ]
1642 [ # # ]: 0 : LogError("Internal error: failed to reset shutdown signal.\n");
1643 : : }
1644 [ # # ]: 0 : std::tie(status, error) = InitAndLoadChainstate(
1645 : : node,
1646 : : do_reindex,
1647 : : do_reindex_chainstate,
1648 : : cache_sizes,
1649 : 0 : args);
1650 : : }
1651 [ # # # # ]: 0 : if (status != ChainstateLoadStatus::SUCCESS && status != ChainstateLoadStatus::INTERRUPTED) {
1652 [ # # ]: 0 : return InitError(error);
1653 : : }
1654 : :
1655 : : // As LoadBlockIndex can take several minutes, it's possible the user
1656 : : // requested to kill the GUI during the last operation. If so, exit.
1657 [ # # # # ]: 0 : if (ShutdownRequested(node)) {
1658 [ # # ]: 0 : LogPrintf("Shutdown requested. Exiting.\n");
1659 : : return false;
1660 : : }
1661 : :
1662 [ # # # # ]: 0 : ChainstateManager& chainman = *Assert(node.chainman);
1663 : :
1664 [ # # ]: 0 : assert(!node.peerman);
1665 : 0 : node.peerman = PeerManager::make(*node.connman, *node.addrman,
1666 : : node.banman.get(), chainman,
1667 [ # # ]: 0 : *node.mempool, *node.warnings,
1668 : 0 : peerman_opts);
1669 [ # # ]: 0 : validation_signals.RegisterValidationInterface(node.peerman.get());
1670 : :
1671 : : // ********************************************************* Step 8: start indexers
1672 : :
1673 [ # # # # : 0 : if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
# # ]
1674 [ # # # # : 0 : g_txindex = std::make_unique<TxIndex>(interfaces::MakeChain(node), cache_sizes.tx_index, false, do_reindex);
# # ]
1675 [ # # ]: 0 : node.indexes.emplace_back(g_txindex.get());
1676 : : }
1677 : :
1678 [ # # ]: 0 : for (const auto& filter_type : g_enabled_filter_types) {
1679 [ # # ]: 0 : InitBlockFilterIndex([&]{ return interfaces::MakeChain(node); }, filter_type, cache_sizes.filter_index, false, do_reindex);
1680 [ # # # # ]: 0 : node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
1681 : : }
1682 : :
1683 [ # # # # : 0 : if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
# # ]
1684 [ # # # # : 0 : g_coin_stats_index = std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /*cache_size=*/0, false, do_reindex);
# # ]
1685 [ # # ]: 0 : node.indexes.emplace_back(g_coin_stats_index.get());
1686 : : }
1687 : :
1688 : : // Init indexes
1689 [ # # # # : 0 : for (auto index : node.indexes) if (!index->Init()) return false;
# # ]
1690 : :
1691 : : // ********************************************************* Step 9: load wallet
1692 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
1693 [ # # # # ]: 0 : if (!client->load()) {
1694 : : return false;
1695 : : }
1696 : : }
1697 : :
1698 : : // ********************************************************* Step 10: data directory maintenance
1699 : :
1700 : : // if pruning, perform the initial blockstore prune
1701 : : // after any wallet rescanning has taken place.
1702 [ # # ]: 0 : if (chainman.m_blockman.IsPruneMode()) {
1703 [ # # ]: 0 : if (chainman.m_blockman.m_blockfiles_indexed) {
1704 [ # # ]: 0 : LOCK(cs_main);
1705 [ # # # # ]: 0 : for (Chainstate* chainstate : chainman.GetAll()) {
1706 [ # # # # ]: 0 : uiInterface.InitMessage(_("Pruning blockstore…").translated);
1707 [ # # ]: 0 : chainstate->PruneAndFlush();
1708 [ # # ]: 0 : }
1709 : 0 : }
1710 : : } else {
1711 : : // Prior to setting NODE_NETWORK, check if we can provide historical blocks.
1712 [ # # # # : 0 : if (!WITH_LOCK(chainman.GetMutex(), return chainman.BackgroundSyncInProgress())) {
# # ]
1713 [ # # ]: 0 : LogPrintf("Setting NODE_NETWORK on non-prune mode\n");
1714 : 0 : g_local_services = ServiceFlags(g_local_services | NODE_NETWORK);
1715 : : } else {
1716 [ # # ]: 0 : LogPrintf("Running node in NODE_NETWORK_LIMITED mode until snapshot background sync completes\n");
1717 : : }
1718 : : }
1719 : :
1720 : : // ********************************************************* Step 11: import blocks
1721 : :
1722 [ # # # # : 0 : if (!CheckDiskSpace(args.GetDataDirNet())) {
# # ]
1723 [ # # # # : 0 : InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetDataDirNet()))));
# # # # #
# ]
1724 : 0 : return false;
1725 : : }
1726 [ # # # # : 0 : if (!CheckDiskSpace(args.GetBlocksDirPath())) {
# # ]
1727 [ # # # # : 0 : InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetBlocksDirPath()))));
# # # # ]
1728 : 0 : return false;
1729 : : }
1730 : :
1731 [ # # # # : 0 : int chain_active_height = WITH_LOCK(cs_main, return chainman.ActiveChain().Height());
# # ]
1732 : :
1733 : : // On first startup, warn on low block storage space
1734 [ # # # # : 0 : if (!do_reindex && !do_reindex_chainstate && chain_active_height <= 1) {
# # ]
1735 [ # # ]: 0 : uint64_t assumed_chain_bytes{chainparams.AssumedBlockchainSize() * 1024 * 1024 * 1024};
1736 : 0 : uint64_t additional_bytes_needed{
1737 [ # # ]: 0 : chainman.m_blockman.IsPruneMode() ?
1738 [ # # ]: 0 : std::min(chainman.m_blockman.GetPruneTarget(), assumed_chain_bytes) :
1739 : 0 : assumed_chain_bytes};
1740 : :
1741 [ # # # # : 0 : if (!CheckDiskSpace(args.GetBlocksDirPath(), additional_bytes_needed)) {
# # ]
1742 [ # # # # : 0 : InitWarning(strprintf(_(
# # # # ]
1743 : : "Disk space for %s may not accommodate the block files. " \
1744 : : "Approximately %u GB of data will be stored in this directory."
1745 : : ),
1746 [ # # ]: 0 : fs::quoted(fs::PathToString(args.GetBlocksDirPath())),
1747 [ # # ]: 0 : chainparams.AssumedBlockchainSize()
1748 : : ));
1749 : : }
1750 : : }
1751 : :
1752 : : #if HAVE_SYSTEM
1753 [ # # # # : 0 : const std::string block_notify = args.GetArg("-blocknotify", "");
# # ]
1754 [ # # ]: 0 : if (!block_notify.empty()) {
1755 [ # # # # : 0 : uiInterface.NotifyBlockTip_connect([block_notify](SynchronizationState sync_state, const CBlockIndex* pBlockIndex) {
# # # # #
# ]
1756 [ # # ]: 0 : if (sync_state != SynchronizationState::POST_INIT || !pBlockIndex) return;
1757 : 0 : std::string command = block_notify;
1758 [ # # # # : 0 : ReplaceAll(command, "%s", pBlockIndex->GetBlockHash().GetHex());
# # ]
1759 [ # # ]: 0 : std::thread t(runCommand, command);
1760 [ # # ]: 0 : t.detach(); // thread runs free
1761 : 0 : });
1762 : : }
1763 : : #endif
1764 : :
1765 : 0 : std::vector<fs::path> vImportFiles;
1766 [ # # # # : 0 : for (const std::string& strFile : args.GetArgs("-loadblock")) {
# # ]
1767 [ # # ]: 0 : vImportFiles.push_back(fs::PathFromString(strFile));
1768 : 0 : }
1769 : :
1770 [ # # # # : 0 : node.background_init_thread = std::thread(&util::TraceThread, "initload", [=, &chainman, &args, &node] {
# # ]
1771 : 0 : ScheduleBatchPriority();
1772 : : // Import blocks
1773 : 0 : ImportBlocks(chainman, vImportFiles);
1774 [ # # # # ]: 0 : if (args.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
1775 : 0 : LogPrintf("Stopping after block import\n");
1776 [ # # ]: 0 : if (!(Assert(node.shutdown_request))()) {
1777 : 0 : LogError("Failed to send shutdown signal after finishing block import\n");
1778 : : }
1779 : 0 : return;
1780 : : }
1781 : :
1782 : : // Start indexes initial sync
1783 [ # # ]: 0 : if (!StartIndexBackgroundSync(node)) {
1784 : 0 : bilingual_str err_str = _("Failed to start indexes, shutting down..");
1785 [ # # ]: 0 : chainman.GetNotifications().fatalError(err_str);
1786 : 0 : return;
1787 : 0 : }
1788 : : // Load mempool from disk
1789 [ # # ]: 0 : if (auto* pool{chainman.ActiveChainstate().GetMempool()}) {
1790 [ # # # # : 0 : LoadMempool(*pool, ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{}, chainman.ActiveChainstate(), {});
# # # # ]
1791 : 0 : pool->SetLoadTried(!chainman.m_interrupt);
1792 : : }
1793 [ # # # # ]: 0 : });
1794 : :
1795 : : // Wait for genesis block to be processed
1796 [ # # # # : 0 : if (WITH_LOCK(chainman.GetMutex(), return chainman.ActiveTip() == nullptr)) {
# # # # ]
1797 [ # # ]: 0 : WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
1798 [ # # ]: 0 : kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
1799 [ # # # # ]: 0 : return !kernel_notifications.m_tip_block.IsNull() || ShutdownRequested(node);
1800 : : });
1801 : 0 : }
1802 : :
1803 [ # # # # ]: 0 : if (ShutdownRequested(node)) {
1804 : : return false;
1805 : : }
1806 : :
1807 : : // ********************************************************* Step 12: start node
1808 : :
1809 : 0 : int64_t best_block_time{};
1810 : 0 : {
1811 [ # # ]: 0 : LOCK(chainman.GetMutex());
1812 [ # # # # ]: 0 : const auto& tip{*Assert(chainman.ActiveTip())};
1813 [ # # ]: 0 : LogPrintf("block tree size = %u\n", chainman.BlockIndex().size());
1814 : 0 : chain_active_height = tip.nHeight;
1815 [ # # ]: 0 : best_block_time = tip.GetBlockTime();
1816 [ # # ]: 0 : if (tip_info) {
1817 : 0 : tip_info->block_height = chain_active_height;
1818 : 0 : tip_info->block_time = best_block_time;
1819 [ # # ]: 0 : tip_info->verification_progress = GuessVerificationProgress(chainman.GetParams().TxData(), &tip);
1820 : : }
1821 [ # # ]: 0 : if (tip_info && chainman.m_best_header) {
1822 : 0 : tip_info->header_height = chainman.m_best_header->nHeight;
1823 : 0 : tip_info->header_time = chainman.m_best_header->GetBlockTime();
1824 : : }
1825 : 0 : }
1826 [ # # ]: 0 : LogPrintf("nBestHeight = %d\n", chain_active_height);
1827 [ # # # # ]: 0 : if (node.peerman) node.peerman->SetBestBlock(chain_active_height, std::chrono::seconds{best_block_time});
1828 : :
1829 : : // Map ports with NAT-PMP
1830 [ # # # # : 0 : StartMapPort(args.GetBoolArg("-natpmp", DEFAULT_NATPMP));
# # ]
1831 : :
1832 : 0 : CConnman::Options connOptions;
1833 : 0 : connOptions.m_local_services = g_local_services;
1834 : 0 : connOptions.m_max_automatic_connections = nMaxConnections;
1835 : 0 : connOptions.uiInterface = &uiInterface;
1836 [ # # ]: 0 : connOptions.m_banman = node.banman.get();
1837 [ # # ]: 0 : connOptions.m_msgproc = node.peerman.get();
1838 [ # # # # ]: 0 : connOptions.nSendBufferMaxSize = 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1839 [ # # # # ]: 0 : connOptions.nReceiveFloodSize = 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1840 [ # # # # ]: 0 : connOptions.m_added_nodes = args.GetArgs("-addnode");
1841 [ # # ]: 0 : connOptions.nMaxOutboundLimit = *opt_max_upload;
1842 : 0 : connOptions.m_peer_connect_timeout = peer_connect_timeout;
1843 [ # # # # ]: 0 : connOptions.whitelist_forcerelay = args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
1844 [ # # # # ]: 0 : connOptions.whitelist_relay = args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
1845 : :
1846 : : // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
1847 : 0 : const uint16_t default_bind_port =
1848 [ # # # # : 0 : static_cast<uint16_t>(args.GetIntArg("-port", Params().GetDefaultPort()));
# # ]
1849 : :
1850 : 0 : const auto BadPortWarning = [](const char* prefix, uint16_t port) {
1851 : 0 : return strprintf(_("%s request to listen on port %u. This port is considered \"bad\" and "
1852 : : "thus it is unlikely that any peer will connect to it. See "
1853 : : "doc/p2p-bad-ports.md for details and a full list."),
1854 : : prefix,
1855 [ # # ]: 0 : port);
1856 : : };
1857 : :
1858 [ # # # # : 0 : for (const std::string& bind_arg : args.GetArgs("-bind")) {
# # ]
1859 : 0 : std::optional<CService> bind_addr;
1860 : 0 : const size_t index = bind_arg.rfind('=');
1861 [ # # ]: 0 : if (index == std::string::npos) {
1862 [ # # # # ]: 0 : bind_addr = Lookup(bind_arg, default_bind_port, /*fAllowLookup=*/false);
1863 [ # # ]: 0 : if (bind_addr.has_value()) {
1864 [ # # ]: 0 : connOptions.vBinds.push_back(bind_addr.value());
1865 [ # # # # : 0 : if (IsBadPort(bind_addr.value().GetPort())) {
# # # # ]
1866 [ # # # # : 0 : InitWarning(BadPortWarning("-bind", bind_addr.value().GetPort()));
# # # # ]
1867 : : }
1868 : 0 : continue;
1869 : : }
1870 : : } else {
1871 [ # # ]: 0 : const std::string network_type = bind_arg.substr(index + 1);
1872 [ # # ]: 0 : if (network_type == "onion") {
1873 [ # # ]: 0 : const std::string truncated_bind_arg = bind_arg.substr(0, index);
1874 [ # # # # : 0 : bind_addr = Lookup(truncated_bind_arg, BaseParams().OnionServiceTargetPort(), false);
# # ]
1875 [ # # ]: 0 : if (bind_addr.has_value()) {
1876 [ # # ]: 0 : connOptions.onion_binds.push_back(bind_addr.value());
1877 : 0 : continue;
1878 : : }
1879 : 0 : }
1880 : 0 : }
1881 [ # # # # : 0 : return InitError(ResolveErrMsg("bind", bind_arg));
# # ]
1882 : 0 : }
1883 : :
1884 [ # # # # : 0 : for (const std::string& strBind : args.GetArgs("-whitebind")) {
# # ]
1885 [ # # ]: 0 : NetWhitebindPermissions whitebind;
1886 [ # # ]: 0 : bilingual_str error;
1887 [ # # # # : 0 : if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) return InitError(error);
# # ]
1888 [ # # ]: 0 : connOptions.vWhiteBinds.push_back(whitebind);
1889 : 0 : }
1890 : :
1891 : : // If the user did not specify -bind= or -whitebind= then we bind
1892 : : // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
1893 [ # # # # : 0 : connOptions.bind_on_any = args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
# # # # #
# # # # #
# # # # #
# ]
1894 : :
1895 : : // Emit a warning if a bad port is given to -port= but only if -bind and -whitebind are not
1896 : : // given, because if they are, then -port= is ignored.
1897 [ # # # # : 0 : if (connOptions.bind_on_any && args.IsArgSet("-port")) {
# # # # #
# ]
1898 [ # # # # ]: 0 : const uint16_t port_arg = args.GetIntArg("-port", 0);
1899 [ # # # # ]: 0 : if (IsBadPort(port_arg)) {
1900 [ # # # # ]: 0 : InitWarning(BadPortWarning("-port", port_arg));
1901 : : }
1902 : : }
1903 : :
1904 [ # # ]: 0 : CService onion_service_target;
1905 [ # # ]: 0 : if (!connOptions.onion_binds.empty()) {
1906 : 0 : onion_service_target = connOptions.onion_binds.front();
1907 [ # # ]: 0 : } else if (!connOptions.vBinds.empty()) {
1908 : 0 : onion_service_target = connOptions.vBinds.front();
1909 : : } else {
1910 [ # # ]: 0 : onion_service_target = DefaultOnionServiceTarget();
1911 [ # # ]: 0 : connOptions.onion_binds.push_back(onion_service_target);
1912 : : }
1913 : :
1914 [ # # # # : 0 : if (args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
# # ]
1915 [ # # ]: 0 : if (connOptions.onion_binds.size() > 1) {
1916 [ # # # # : 0 : InitWarning(strprintf(_("More than one onion bind address is provided. Using %s "
# # ]
1917 : : "for the automatically created Tor onion service."),
1918 [ # # ]: 0 : onion_service_target.ToStringAddrPort()));
1919 : : }
1920 [ # # ]: 0 : StartTorControl(onion_service_target);
1921 : : }
1922 : :
1923 [ # # ]: 0 : if (connOptions.bind_on_any) {
1924 : : // Only add all IP addresses of the machine if we would be listening on
1925 : : // any address - 0.0.0.0 (IPv4) and :: (IPv6).
1926 [ # # ]: 0 : Discover();
1927 : : }
1928 : :
1929 [ # # # # : 0 : for (const auto& net : args.GetArgs("-whitelist")) {
# # ]
1930 [ # # ]: 0 : NetWhitelistPermissions subnet;
1931 : 0 : ConnectionDirection connection_direction;
1932 [ # # ]: 0 : bilingual_str error;
1933 [ # # # # : 0 : if (!NetWhitelistPermissions::TryParse(net, subnet, connection_direction, error)) return InitError(error);
# # ]
1934 [ # # ]: 0 : if (connection_direction & ConnectionDirection::In) {
1935 [ # # ]: 0 : connOptions.vWhitelistedRangeIncoming.push_back(subnet);
1936 : : }
1937 [ # # ]: 0 : if (connection_direction & ConnectionDirection::Out) {
1938 [ # # ]: 0 : connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
1939 : : }
1940 : 0 : }
1941 : :
1942 [ # # # # ]: 0 : connOptions.vSeedNodes = args.GetArgs("-seednode");
1943 : :
1944 : : // Initiate outbound connections unless connect=0
1945 [ # # # # ]: 0 : connOptions.m_use_addrman_outgoing = !args.IsArgSet("-connect");
1946 [ # # ]: 0 : if (!connOptions.m_use_addrman_outgoing) {
1947 [ # # # # ]: 0 : const auto connect = args.GetArgs("-connect");
1948 [ # # # # ]: 0 : if (connect.size() != 1 || connect[0] != "0") {
1949 [ # # ]: 0 : connOptions.m_specified_outgoing = connect;
1950 : : }
1951 [ # # # # ]: 0 : if (!connOptions.m_specified_outgoing.empty() && !connOptions.vSeedNodes.empty()) {
1952 [ # # ]: 0 : LogPrintf("-seednode is ignored when -connect is used\n");
1953 : : }
1954 : :
1955 [ # # # # : 0 : if (args.IsArgSet("-dnsseed") && args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED) && args.IsArgSet("-proxy")) {
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1956 [ # # ]: 0 : LogPrintf("-dnsseed is ignored when -connect is used and -proxy is specified\n");
1957 : : }
1958 : 0 : }
1959 : :
1960 [ # # # # : 0 : const std::string& i2psam_arg = args.GetArg("-i2psam", "");
# # ]
1961 [ # # ]: 0 : if (!i2psam_arg.empty()) {
1962 [ # # # # ]: 0 : const std::optional<CService> addr{Lookup(i2psam_arg, 7656, fNameLookup)};
1963 [ # # # # : 0 : if (!addr.has_value() || !addr->IsValid()) {
# # ]
1964 [ # # # # : 0 : return InitError(strprintf(_("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
# # ]
1965 : : }
1966 [ # # # # ]: 0 : SetProxy(NET_I2P, Proxy{addr.value()});
1967 : 0 : } else {
1968 [ # # # # : 0 : if (args.IsArgSet("-onlynet") && g_reachable_nets.Contains(NET_I2P)) {
# # # # #
# # # ]
1969 [ # # ]: 0 : return InitError(
1970 [ # # ]: 0 : _("Outbound connections restricted to i2p (-onlynet=i2p) but "
1971 : : "-i2psam is not provided"));
1972 : : }
1973 [ # # ]: 0 : g_reachable_nets.Remove(NET_I2P);
1974 : : }
1975 : :
1976 [ # # # # ]: 0 : connOptions.m_i2p_accept_incoming = args.GetBoolArg("-i2pacceptincoming", DEFAULT_I2P_ACCEPT_INCOMING);
1977 : :
1978 [ # # # # ]: 0 : if (!node.connman->Start(scheduler, connOptions)) {
1979 : : return false;
1980 : : }
1981 : :
1982 : : // ********************************************************* Step 13: finished
1983 : :
1984 : : // At this point, the RPC is "started", but still in warmup, which means it
1985 : : // cannot yet be called. Before we make it callable, we need to make sure
1986 : : // that the RPC's view of the best block is valid and consistent with
1987 : : // ChainstateManager's active tip.
1988 [ # # ]: 0 : SetRPCWarmupFinished();
1989 : :
1990 [ # # # # ]: 0 : uiInterface.InitMessage(_("Done loading").translated);
1991 : :
1992 [ # # ]: 0 : for (const auto& client : node.chain_clients) {
1993 [ # # ]: 0 : client->start(scheduler);
1994 : : }
1995 : :
1996 : 0 : BanMan* banman = node.banman.get();
1997 [ # # ]: 0 : scheduler.scheduleEvery([banman]{
1998 : 0 : banman->DumpBanlist();
1999 : : }, DUMP_BANS_INTERVAL);
2000 : :
2001 [ # # # # ]: 0 : if (node.peerman) node.peerman->StartScheduledTasks(scheduler);
2002 : :
2003 : : #if HAVE_SYSTEM
2004 [ # # ]: 0 : StartupNotify(args);
2005 : : #endif
2006 : :
2007 : : return true;
2008 : 0 : }
2009 : :
2010 : 0 : bool StartIndexBackgroundSync(NodeContext& node)
2011 : : {
2012 : : // Find the oldest block among all indexes.
2013 : : // This block is used to verify that we have the required blocks' data stored on disk,
2014 : : // starting from that point up to the current tip.
2015 : : // indexes_start_block='nullptr' means "start from height 0".
2016 : 0 : std::optional<const CBlockIndex*> indexes_start_block;
2017 [ # # ]: 0 : std::string older_index_name;
2018 [ # # # # ]: 0 : ChainstateManager& chainman = *Assert(node.chainman);
2019 [ # # # # : 0 : const Chainstate& chainstate = WITH_LOCK(::cs_main, return chainman.GetChainstateForIndexing());
# # ]
2020 : 0 : const CChain& index_chain = chainstate.m_chain;
2021 : :
2022 [ # # ]: 0 : for (auto index : node.indexes) {
2023 [ # # ]: 0 : const IndexSummary& summary = index->GetSummary();
2024 [ # # ]: 0 : if (summary.synced) continue;
2025 : :
2026 : : // Get the last common block between the index best block and the active chain
2027 [ # # ]: 0 : LOCK(::cs_main);
2028 [ # # ]: 0 : const CBlockIndex* pindex = chainman.m_blockman.LookupBlockIndex(summary.best_block_hash);
2029 [ # # ]: 0 : if (!index_chain.Contains(pindex)) {
2030 [ # # ]: 0 : pindex = index_chain.FindFork(pindex);
2031 : : }
2032 : :
2033 [ # # # # : 0 : if (!indexes_start_block || !pindex || pindex->nHeight < indexes_start_block.value()->nHeight) {
# # ]
2034 [ # # ]: 0 : indexes_start_block = pindex;
2035 [ # # ]: 0 : older_index_name = summary.name;
2036 [ # # ]: 0 : if (!pindex) break; // Starting from genesis so no need to look for earlier block.
2037 : : }
2038 : 0 : };
2039 : :
2040 : : // Verify all blocks needed to sync to current tip are present.
2041 [ # # ]: 0 : if (indexes_start_block) {
2042 [ # # ]: 0 : LOCK(::cs_main);
2043 [ # # ]: 0 : const CBlockIndex* start_block = *indexes_start_block;
2044 [ # # # # : 0 : if (!start_block) start_block = chainman.ActiveChain().Genesis();
# # ]
2045 [ # # # # : 0 : if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(start_block))) {
# # # # ]
2046 [ # # # # : 0 : return InitError(strprintf(Untranslated("%s best block of the index goes beyond pruned data. Please disable the index or reindex (which will download the whole blockchain again)"), older_index_name));
# # # # #
# ]
2047 : : }
2048 : 0 : }
2049 : :
2050 : : // Start threads
2051 [ # # # # : 0 : for (auto index : node.indexes) if (!index->StartBackgroundSync()) return false;
# # ]
2052 : : return true;
2053 : 0 : }
|
