Coverage Report

Created: 2026-10-07 13:27

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/init.cpp
Line
Count
Source
1
// Copyright (c) 2009-2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present 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 <addrdb.h>
11
#include <addrman.h>
12
#include <banman.h>
13
#include <blockfilter.h>
14
#include <chain.h>
15
#include <chainparams.h>
16
#include <chainparamsbase.h>
17
#include <clientversion.h>
18
#include <common/args.h>
19
#include <common/messages.h>
20
#include <common/system.h>
21
#include <compat/compat.h>
22
#include <consensus/params.h>
23
#include <crypto/hex_base.h>
24
#include <dbwrapper.h>
25
#include <httprpc.h>
26
#include <httpserver.h>
27
#include <index/base.h>
28
#include <index/blockfilterindex.h>
29
#include <index/coinstatsindex.h>
30
#include <index/txindex.h>
31
#include <index/txospenderindex.h>
32
#include <init/common.h>
33
#include <interfaces/chain.h>
34
#include <interfaces/init.h>
35
#include <interfaces/ipc.h>
36
#include <interfaces/node.h>
37
#include <ipc/exception.h>
38
#include <kernel/blockmanager_opts.h>
39
#include <kernel/caches.h>
40
#include <kernel/chainstatemanager_opts.h>
41
#include <kernel/checks.h>
42
#include <kernel/context.h>
43
#include <kernel/notifications_interface.h>
44
#include <key.h>
45
#include <logging.h>
46
#include <mapport.h>
47
#include <net.h>
48
#include <net_permissions.h>
49
#include <net_processing.h>
50
#include <netaddress.h>
51
#include <netbase.h>
52
#include <netgroup.h>
53
#include <node/block_template_manager.h>
54
#include <node/blockmanager_args.h>
55
#include <node/blockstorage.h>
56
#include <node/caches.h>
57
#include <node/chainstate.h>
58
#include <node/chainstatemanager_args.h>
59
#include <node/context.h>
60
#include <node/interface_ui.h>
61
#include <node/kernel_notifications.h>
62
#include <node/mempool_args.h>
63
#include <node/mempool_persist.h>
64
#include <node/mempool_persist_args.h>
65
#include <node/mining_args.h>
66
#include <node/peerman_args.h>
67
#include <policy/feerate.h>
68
#include <policy/fees/block_policy_estimator.h>
69
#include <policy/fees/estimator_args.h>
70
#include <policy/fees/estimator_man.h>
71
#include <policy/policy.h>
72
#include <policy/settings.h>
73
#include <protocol.h>
74
#include <random.h>
75
#include <rpc/register.h>
76
#include <rpc/server.h>
77
#include <rpc/util.h>
78
#include <scheduler.h>
79
#include <script/sigcache.h>
80
#include <sync.h>
81
#include <tinyformat.h>
82
#include <torcontrol.h>
83
#include <txgraph.h>
84
#include <txmempool.h>
85
#include <uint256.h>
86
#include <util/asmap.h>
87
#include <util/batchpriority.h>
88
#include <util/btcsignals.h>
89
#include <util/byte_units.h>
90
#include <util/chaintype.h>
91
#include <util/check.h>
92
#include <util/fs.h>
93
#include <util/fs_helpers.h>
94
#include <util/moneystr.h>
95
#include <util/overflow.h>
96
#include <util/result.h>
97
#include <util/signalinterrupt.h>
98
#include <util/strencodings.h>
99
#include <util/string.h>
100
#include <util/syserror.h>
101
#include <util/thread.h>
102
#include <util/threadnames.h>
103
#include <util/time.h>
104
#include <util/translation.h>
105
#include <validation.h>
106
#include <validationinterface.h>
107
#include <walletinitinterface.h>
108
109
#include <algorithm>
110
#include <any>
111
#include <cerrno>
112
#include <condition_variable>
113
#include <cstddef>
114
#include <cstdint>
115
#include <exception>
116
#include <fstream>
117
#include <functional>
118
#include <limits>
119
#include <list>
120
#include <memory>
121
#include <new>
122
#include <optional>
123
#include <set>
124
#include <span>
125
#include <string>
126
#include <system_error>
127
#include <thread>
128
#include <tuple>
129
#include <utility>
130
#include <vector>
131
132
#ifndef WIN32
133
#include <csignal>
134
#endif
135
136
#ifdef ENABLE_ZMQ
137
#include <zmq/zmqabstractnotifier.h>
138
#include <zmq/zmqnotificationinterface.h>
139
#include <zmq/zmqrpc.h>
140
#endif
141
142
#ifdef ENABLE_EMBEDDED_ASMAP
143
#include <node/data/ip_asn.dat.h>
144
#endif
145
146
using common::InvalidPortErrMsg;
147
using common::ResolveErrMsg;
148
149
using node::ApplyArgsManOptions;
150
using node::BlockManager;
151
using node::CalculateCacheSizes;
152
using node::ChainstateLoadResult;
153
using node::ChainstateLoadStatus;
154
using node::DEFAULT_PERSIST_MEMPOOL;
155
using node::DEFAULT_PRINT_MODIFIED_FEE;
156
using node::DEFAULT_STOPATHEIGHT;
157
using node::DumpMempool;
158
using node::ImportBlocks;
159
using node::KernelNotifications;
160
using node::LoadChainstate;
161
using node::LoadMempool;
162
using node::MempoolPath;
163
using node::NodeContext;
164
using node::ShouldPersistMempool;
165
using node::VerifyLoadedChainstate;
166
using util::Join;
167
using util::ReplaceAll;
168
using util::ToString;
169
using util::TrimStringView;
170
171
static constexpr bool DEFAULT_PROXYRANDOMIZE{true};
172
static constexpr bool DEFAULT_REST_ENABLE{false};
173
static constexpr bool DEFAULT_I2P_ACCEPT_INCOMING{true};
174
static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
175
176
#ifdef WIN32
177
// Win32 LevelDB doesn't use filedescriptors, and the ones used for
178
// accessing block files don't count towards the fd_set size limit
179
// anyway.
180
#define MIN_LEVELDB_FDS 0
181
#else
182
#define MIN_LEVELDB_FDS 150
183
#endif
184
185
static constexpr int MIN_CORE_FDS = MIN_LEVELDB_FDS + NUM_FDS_MESSAGE_CAPTURE;
186
187
/**
188
 * The PID file facilities.
189
 */
190
static const char* BITCOIN_PID_FILENAME = "bitcoind.pid";
191
/**
192
 * True if this process has created a PID file.
193
 * Used to determine whether we should remove the PID file on shutdown.
194
 */
195
static bool g_generated_pid{false};
196
197
static fs::path GetPidFile(const ArgsManager& args)
198
2.44k
{
199
2.44k
    return AbsPathForConfigVal(args, args.GetPathArg("-pid", BITCOIN_PID_FILENAME));
200
2.44k
}
201
202
[[nodiscard]] static bool CreatePidFile(const ArgsManager& args)
203
1.22k
{
204
1.22k
    if (args.IsArgNegated("-pid")) return true;
205
206
1.22k
    std::ofstream file{GetPidFile(args).std_path()};
207
1.22k
    if (file) {
208
#ifdef WIN32
209
        tfm::format(file, "%d\n", GetCurrentProcessId());
210
#else
211
1.22k
        tfm::format(file, "%d\n", getpid());
212
1.22k
#endif
213
1.22k
        g_generated_pid = true;
214
1.22k
        return true;
215
1.22k
    } else {
216
0
        return InitError(strprintf(_("Unable to create the PID file '%s': %s"), fs::PathToString(GetPidFile(args)), SysErrorString(errno)));
217
0
    }
218
1.22k
}
219
220
static void RemovePidFile(const ArgsManager& args)
221
1.24k
{
222
1.24k
    if (!g_generated_pid) return;
223
1.22k
    const auto pid_path{GetPidFile(args)};
224
1.22k
    if (std::error_code error; !fs::remove(pid_path, error)) {
225
0
        std::string msg{error ? error.message() : "File does not exist"};
226
0
        LogWarning("Unable to remove PID file (%s): %s", fs::PathToString(pid_path), msg);
227
0
    }
228
1.22k
}
229
230
static std::optional<util::SignalInterrupt> g_shutdown;
231
232
void InitContext(NodeContext& node)
233
1.28k
{
234
1.28k
    assert(!g_shutdown);
235
1.28k
    g_shutdown.emplace();
236
237
1.28k
    node.args = &gArgs;
238
1.28k
    node.shutdown_signal = &*g_shutdown;
239
1.28k
    node.shutdown_request = [&node] {
240
1.06k
        assert(node.shutdown_signal);
241
1.06k
        if (!(*node.shutdown_signal)()) return false;
242
1.06k
        return true;
243
1.06k
    };
244
1.28k
}
245
246
//////////////////////////////////////////////////////////////////////////////
247
//
248
// Shutdown
249
//
250
251
//
252
// Thread management and startup/shutdown:
253
//
254
// The network-processing threads are all part of a thread group
255
// created by AppInit() or the Qt main() function.
256
//
257
// A clean exit happens when the SignalInterrupt object is triggered, which
258
// makes the main thread's SignalInterrupt::wait() call return, and join all
259
// other ongoing threads in the thread group to the main thread.
260
// Shutdown() is then called to clean up database connections, and stop other
261
// threads that should only be stopped after the main network-processing
262
// threads have exited.
263
//
264
// Shutdown for Qt is very similar, only it uses a QTimer to detect
265
// ShutdownRequested() getting set, and then does the normal Qt
266
// shutdown thing.
267
//
268
269
bool ShutdownRequested(node::NodeContext& node)
270
85.4k
{
271
85.4k
    return bool{*Assert(node.shutdown_signal)};
272
85.4k
}
273
274
#if HAVE_SYSTEM
275
static void ShutdownNotify(const ArgsManager& args)
276
1.24k
{
277
1.24k
    std::vector<std::thread> threads;
278
1.24k
    for (const auto& cmd : args.GetArgs("-shutdownnotify")) {
279
1
        threads.emplace_back(runCommand, cmd);
280
1
    }
281
1.24k
    for (auto& t : threads) {
282
1
        t.join();
283
1
    }
284
1.24k
}
285
#endif
286
287
void Interrupt(NodeContext& node)
288
1.24k
{
289
1.24k
#if HAVE_SYSTEM
290
1.24k
    ShutdownNotify(*node.args);
291
1.24k
#endif
292
    // Wake any threads that may be waiting for the tip to change.
293
1.24k
    if (node.notifications) WITH_LOCK(node.notifications->m_tip_block_mutex, node.notifications->m_tip_block_cv.notify_all());
294
1.24k
    InterruptHTTPServer();
295
1.24k
    InterruptHTTPRPC();
296
1.24k
    InterruptRPC();
297
1.24k
    InterruptREST();
298
1.24k
    if (node.tor_controller) {
299
9
        node.tor_controller->Interrupt();
300
9
    }
301
1.24k
    InterruptMapPort();
302
1.24k
    if (node.connman)
303
1.15k
        node.connman->Interrupt();
304
1.24k
    for (auto* index : node.indexes) {
305
137
        index->Interrupt();
306
137
    }
307
1.24k
}
308
309
void Shutdown(NodeContext& node)
310
1.24k
{
311
1.24k
    static Mutex g_shutdown_mutex;
312
1.24k
    TRY_LOCK(g_shutdown_mutex, lock_shutdown);
313
1.24k
    if (!lock_shutdown) return;
314
1.24k
    LogInfo("Shutdown in progress...");
315
1.24k
    Assert(node.args);
316
317
    /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
318
    /// for example if the data directory was found to be locked.
319
    /// Be sure that anything that writes files or flushes caches only does this if the respective
320
    /// module was initialized.
321
1.24k
    util::ThreadRename("shutoff");
322
1.24k
    if (node.mempool) node.mempool->AddTransactionsUpdated(1);
323
324
1.24k
    StopHTTPRPC();
325
1.24k
    StopREST();
326
1.24k
    StopRPC();
327
1.24k
    StopHTTPServer();
328
1.24k
    for (auto& client : node.chain_clients) {
329
428
        try {
330
428
            client->stop();
331
428
        } catch (const ipc::Exception& e) {
332
0
            LogDebug(BCLog::IPC, "Chain client did not disconnect cleanly: %s", e.what());
333
0
            client.reset();
334
0
        }
335
428
    }
336
1.24k
    StopMapPort();
337
338
    // Because these depend on each-other, we make sure that neither can be
339
    // using the other before destroying them.
340
1.24k
    if (node.peerman && node.validation_signals) node.validation_signals->UnregisterValidationInterface(node.peerman.get());
341
1.24k
    if (node.connman) node.connman->Stop();
342
343
1.24k
    if (node.tor_controller) {
344
9
        node.tor_controller->Join();
345
9
        node.tor_controller.reset();
346
9
    }
347
348
1.24k
    if (node.background_init_thread.joinable()) node.background_init_thread.join();
349
    // After everything has been shut down, but before things get flushed, stop the
350
    // the scheduler. After this point, SyncWithValidationInterfaceQueue() should not be called anymore
351
    // as this would prevent the shutdown from completing.
352
1.24k
    if (node.scheduler) node.scheduler->stop();
353
354
    // After the threads that potentially access these pointers have been stopped,
355
    // destruct and reset all to nullptr.
356
1.24k
    node.peerman.reset();
357
1.24k
    node.connman.reset();
358
1.24k
    node.banman.reset();
359
1.24k
    node.addrman.reset();
360
1.24k
    node.netgroupman.reset();
361
362
1.24k
    if (node.mempool && node.mempool->GetLoadTried() && ShouldPersistMempool(*node.args)) {
363
1.01k
        DumpMempool(*node.mempool, MempoolPath(*node.args));
364
1.01k
    }
365
366
    // FlushStateToDisk generates a ChainStateFlushed callback, which we should avoid missing
367
1.24k
    if (node.chainman) {
368
1.13k
        LOCK(cs_main);
369
1.14k
        for (const auto& chainstate : node.chainman->m_chainstates) {
370
1.14k
            if (chainstate->CanFlushToDisk()) {
371
1.13k
                chainstate->ForceFlushStateToDisk();
372
1.13k
            }
373
1.14k
        }
374
1.13k
    }
375
376
    // After there are no more peers/RPC left to give us new data which may generate
377
    // CValidationInterface callbacks, flush them...
378
1.24k
    if (node.validation_signals) node.validation_signals->FlushBackgroundCallbacks();
379
380
    // Once callbacks drain, drop tracked transactions, save estimates, and unregister the estimator
381
1.24k
    if (node.fee_estimator_man) {
382
1.10k
        node.fee_estimator_man->ShutdownFlush();
383
1.10k
        if (node.validation_signals) {
384
1.10k
            node.validation_signals->UnregisterValidationInterface(node.fee_estimator_man.get());
385
1.10k
        }
386
1.10k
    }
387
388
    // Stop and delete all indexes only after flushing background callbacks.
389
1.24k
    for (auto* index : node.indexes) index->Stop();
390
1.24k
    if (g_txindex) g_txindex.reset();
391
1.24k
    if (g_txospenderindex) g_txospenderindex.reset();
392
1.24k
    if (g_coin_stats_index) g_coin_stats_index.reset();
393
1.24k
    DestroyAllBlockFilterIndexes();
394
1.24k
    node.indexes.clear(); // all instances are nullptr now
395
396
    // Callbacks queued by this final chainstate flush will not run during shutdown
397
1.24k
    if (node.chainman) {
398
1.13k
        LOCK(cs_main);
399
1.14k
        for (const auto& chainstate : node.chainman->m_chainstates) {
400
1.14k
            if (chainstate->CanFlushToDisk()) {
401
1.13k
                chainstate->ForceFlushStateToDisk();
402
1.13k
                chainstate->ResetCoinsViews();
403
1.13k
            }
404
1.14k
        }
405
1.13k
    }
406
407
    // If any -ipcbind clients are still connected, disconnect them now so they
408
    // do not block shutdown.
409
1.24k
    if (interfaces::Ipc* ipc = node.init->ipc()) {
410
10
        ipc->disconnectIncoming();
411
10
    }
412
413
#ifdef ENABLE_ZMQ
414
    if (g_zmq_notification_interface) {
415
        if (node.validation_signals) node.validation_signals->UnregisterValidationInterface(g_zmq_notification_interface.get());
416
        g_zmq_notification_interface.reset();
417
    }
418
#endif
419
420
1.24k
    node.chain_clients.clear();
421
1.24k
    if (node.validation_signals) {
422
1.21k
        node.validation_signals->UnregisterAllValidationInterfaces();
423
1.21k
    }
424
1.24k
    node.fee_estimator_man.reset();
425
1.24k
    node.block_template_manager.reset();
426
1.24k
    node.mempool.reset();
427
1.24k
    node.chainman.reset();
428
1.24k
    node.validation_signals.reset();
429
1.24k
    node.scheduler.reset();
430
1.24k
    node.ecc_context.reset();
431
1.24k
    node.kernel.reset();
432
433
1.24k
    RemovePidFile(*node.args);
434
435
1.24k
    LogInfo("Shutdown done");
436
1.24k
}
437
438
/**
439
 * Signal handlers are very limited in what they are allowed to do.
440
 * The execution context the handler is invoked in is not guaranteed,
441
 * so we restrict handler operations to just touching variables:
442
 */
443
#ifndef WIN32
444
static void HandleSIGTERM(int)
445
24
{
446
    // Return value is intentionally ignored because there is not a better way
447
    // of handling this failure in a signal handler.
448
24
    (void)(*Assert(g_shutdown))();
449
24
}
450
451
static void HandleSIGHUP(int)
452
0
{
453
0
    LogInstance().m_reopen_file = true;
454
0
}
455
#else
456
static BOOL WINAPI consoleCtrlHandler(DWORD dwCtrlType)
457
{
458
    if (!(*Assert(g_shutdown))()) {
459
        LogError("Failed to send shutdown signal on Ctrl-C\n");
460
        return false;
461
    }
462
    Sleep(INFINITE);
463
    return true;
464
}
465
#endif
466
467
#ifndef WIN32
468
static void registerSignalHandler(int signal, void(*handler)(int))
469
3.73k
{
470
3.73k
    struct sigaction sa;
471
3.73k
    sa.sa_handler = handler;
472
3.73k
    sigemptyset(&sa.sa_mask);
473
3.73k
    sa.sa_flags = 0;
474
3.73k
    sigaction(signal, &sa, nullptr);
475
3.73k
}
476
#endif
477
478
void SetupServerArgs(ArgsManager& argsman, bool can_listen_ipc)
479
2.05k
{
480
2.05k
    SetupHelpOptions(argsman);
481
2.05k
    argsman.AddArg("-help-debug", "Print help message with debugging options and exit", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST); // server-only for now
482
483
2.05k
    init::AddLoggingArgs(argsman);
484
485
2.05k
    const auto defaultBaseParams = CreateBaseChainParams(argsman, ChainType::MAIN);
486
2.05k
    const auto testnetBaseParams = CreateBaseChainParams(argsman, ChainType::TESTNET);
487
2.05k
    const auto testnet4BaseParams = CreateBaseChainParams(argsman, ChainType::TESTNET4);
488
2.05k
    const auto signetBaseParams = CreateBaseChainParams(argsman, ChainType::SIGNET);
489
2.05k
    const auto regtestBaseParams = CreateBaseChainParams(argsman, ChainType::REGTEST);
490
2.05k
    const auto defaultChainParams = CreateChainParams(argsman, ChainType::MAIN);
491
2.05k
    const auto testnetChainParams = CreateChainParams(argsman, ChainType::TESTNET);
492
2.05k
    const auto testnet4ChainParams = CreateChainParams(argsman, ChainType::TESTNET4);
493
2.05k
    const auto signetChainParams = CreateChainParams(argsman, ChainType::SIGNET);
494
2.05k
    const auto regtestChainParams = CreateChainParams(argsman, ChainType::REGTEST);
495
496
    // Hidden Options
497
2.05k
    std::vector<std::string> hidden_args = {
498
2.05k
        "-dbcrashratio", "-forcecompactdb",
499
        // GUI args. These will be overwritten by SetupUIArgs for the GUI
500
2.05k
        "-choosedatadir", "-lang=<lang>", "-min", "-resetguisettings", "-splash", "-uiplatform"};
501
502
2.05k
    argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
503
2.05k
#if HAVE_SYSTEM
504
2.05k
    argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
505
2.05k
#endif
506
2.05k
    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);
507
2.05k
    argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
508
2.05k
    argsman.AddArg("-blocksxor",
509
2.05k
                   strprintf("Whether an XOR-key applies to blocksdir *.dat files. "
510
2.05k
                             "The created XOR-key will be zeros for an existing blocksdir or when `-blocksxor=0` is "
511
2.05k
                             "set, and random for a freshly initialized blocksdir. "
512
2.05k
                             "(default: %u)",
513
2.05k
                             kernel::DEFAULT_XOR_BLOCKSDIR),
514
2.05k
                   ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
515
2.05k
    argsman.AddArg("-fastprune", "Use smaller block files and lower minimum prune height for testing purposes", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
516
2.05k
#if HAVE_SYSTEM
517
2.05k
    argsman.AddArg("-blocknotify=<cmd>", "Execute command when the best block changes (%s in cmd is replaced by block hash). Not run for blocks connected during initial block download or reindexing.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
518
2.05k
#endif
519
2.05k
    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);
520
2.05k
    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);
521
2.05k
    argsman.AddArg("-coinstatsindex", strprintf("Maintain coinstats index used by the gettxoutsetinfo RPC (default: %u)", DEFAULT_COINSTATSINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
522
2.05k
    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);
523
2.05k
    argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
524
2.05k
    argsman.AddArg("-dbbatchsize", strprintf("Maximum database write batch size in bytes (default: %u)", DEFAULT_DB_CACHE_BATCH), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::OPTIONS);
525
2.05k
    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).", MIN_DBCACHE_BYTES / 1_MiB, node::GetDefaultDBCache() / 1_MiB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
526
2.05k
    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);
527
2.05k
    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);
528
2.05k
    argsman.AddArg("-loadblock=<file>", "Imports blocks from an external file on startup. Obfuscated blocks are not supported.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
529
2.05k
    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);
530
2.05k
    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);
531
2.05k
    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);
532
2.05k
    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)",
533
2.05k
        MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
534
2.05k
    argsman.AddArg("-prevoutfetchthreads=<n>", strprintf("Set the number of threads used to prefetch block input prevouts from the chainstate database (0 disables, up to %d, default: %d). Negative values are rejected.", MAX_PREVOUTFETCH_THREADS, DEFAULT_PREVOUTFETCH_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
535
2.05k
    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);
536
2.05k
    argsman.AddArg("-persistmempoolv1",
537
2.05k
                   strprintf("Whether a mempool.dat file created by -persistmempool or the savemempool RPC will be written in the legacy format "
538
2.05k
                             "(version 1) or the current format (version 2). This temporary option will be removed in the future. (default: %u)",
539
2.05k
                             DEFAULT_PERSIST_V1_DAT),
540
2.05k
                   ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
541
2.05k
    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);
542
2.05k
    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. "
543
2.05k
            "Warning: Reverting this setting requires re-downloading the entire blockchain. Wallets and indexes should be loaded at startup and kept active while pruning is enabled so they stay synchronized before old block data is deleted; wallets or indexes that fall behind pruned data may require a reindex. "
544
2.05k
            "(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 / 1_MiB), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
545
2.05k
    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);
546
2.05k
    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);
547
2.05k
    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);
548
2.05k
#if HAVE_SYSTEM
549
2.05k
    argsman.AddArg("-startupnotify=<cmd>", "Execute command on startup.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
550
2.05k
    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);
551
2.05k
#endif
552
2.05k
    argsman.AddArg("-txindex", strprintf("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)", DEFAULT_TXINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
553
2.05k
    argsman.AddArg("-txospenderindex", strprintf("Maintain a transaction output spender index, used by the gettxspendingprevout rpc call (default: %u)", DEFAULT_TXOSPENDERINDEX), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
554
2.05k
    argsman.AddArg("-blockfilterindex=<type>",
555
2.05k
                 strprintf("Maintain an index of compact filters by block (default: %s, values: %s).", DEFAULT_BLOCKFILTERINDEX, ListBlockFilterTypes()) +
556
2.05k
                 " If <type> is not supplied or if <type> = 1, indexes for all known types are enabled.",
557
2.05k
                 ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
558
559
2.05k
    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);
560
2.05k
    argsman.AddArg("-asmap=<file>", strprintf("Specify asn mapping used for bucketing of the peers. Relative paths will be prefixed by the net-specific datadir location.%s",
561
2.05k
                #ifdef ENABLE_EMBEDDED_ASMAP
562
2.05k
                    " If a bool arg is given (-asmap or -asmap=1), the embedded mapping data in the binary will be used."
563
                #else
564
                    ""
565
                #endif
566
2.05k
                ), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
567
2.05k
    argsman.AddArg("-bantime=<n>", strprintf("Default duration (in seconds) of manually configured bans (default: %u)", DEFAULT_MISBEHAVING_BANTIME), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
568
2.05k
    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)", defaultChainParams->GetDefaultPort() + 1, testnetChainParams->GetDefaultPort() + 1, testnet4ChainParams->GetDefaultPort() + 1, signetChainParams->GetDefaultPort() + 1, regtestChainParams->GetDefaultPort() + 1), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
569
2.05k
    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);
570
2.05k
    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);
571
2.05k
    argsman.AddArg("-discover", "Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
572
2.05k
    argsman.AddArg("-dns", strprintf("Allow DNS lookups for -addnode, -seednode and -connect (default: %u)", DEFAULT_NAME_LOOKUP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
573
2.05k
    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);
574
2.05k
    argsman.AddArg("-externalip=<ip>", "Specify your own public address", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
575
2.05k
    argsman.AddArg("-fixedseeds", strprintf("Allow fixed seeds if DNS seeds don't provide peers (default: %u)", DEFAULT_FIXEDSEEDS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
576
2.05k
    argsman.AddArg("-forcednsseed", strprintf("Always query for peer addresses via DNS lookup (default: %u)", DEFAULT_FORCEDNSSEED), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
577
2.05k
    argsman.AddArg("-listen", strprintf("Accept connections from outside (default: %u if no -proxy, -connect or -maxconnections=0)", DEFAULT_LISTEN), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
578
2.05k
    argsman.AddArg("-listenonion", strprintf("Automatically create Tor onion service (default: %d)", DEFAULT_LISTEN_ONION), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
579
2.05k
    argsman.AddArg("-maxconnections=<n>", strprintf("Maintain at most <n> automatic connections to peers (default: %u). %u slots of these are reserved for outgoing connections. See -inboundrelaypercent for more information about limits applied to transaction relay inbound peers. "
580
2.05k
                                                    "This limit does not apply to connections manually added via -addnode or the addnode RPC, which have a separate limit of %u. "
581
2.05k
                                                    "It does not apply to short-lived private broadcast connections either, which have a separate limit of %u.",
582
2.05k
                                                    DEFAULT_MAX_PEER_CONNECTIONS, MAX_OUTBOUND_FULL_RELAY_CONNECTIONS + MAX_BLOCK_RELAY_ONLY_CONNECTIONS + MAX_FEELER_CONNECTIONS, MAX_ADDNODE_CONNECTIONS, MAX_PRIVATE_BROADCAST_CONNECTIONS),
583
2.05k
                   ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
584
2.05k
    argsman.AddArg("-inboundrelaypercent=<n>", strprintf("Permit a maximum percent of inbound connections to relay transactions, to limit memory utilization (0 to 100, default: %u).", DEFAULT_FULL_RELAY_INBOUND_PCT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
585
2.05k
    argsman.AddArg("-maxreceivebuffer=<n>", strprintf("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXRECEIVEBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
586
2.05k
    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);
587
2.05k
    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);
588
2.05k
#ifdef HAVE_SOCKADDR_UN
589
2.05k
    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);
590
#else
591
    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);
592
#endif
593
2.05k
    argsman.AddArg("-i2psam=<ip:port>", "I2P SAM proxy to reach I2P peers and accept I2P connections", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
594
2.05k
    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);
595
2.05k
    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);
596
2.05k
    argsman.AddArg("-v2transport", strprintf("Support v2 transport (default: %u)", DEFAULT_V2_TRANSPORT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
597
2.05k
    argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
598
2.05k
    argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
599
2.05k
    argsman.AddArg("-txreconciliation", strprintf("Enable transaction reconciliations per BIP 330 (default: %d)", DEFAULT_TXRECONCILIATION_ENABLE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CONNECTION);
600
2.05k
    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). If set to a value x, the default onion listening port will be set to x+1.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), testnet4ChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
601
2.05k
    const std::string proxy_doc_for_value =
602
2.05k
#ifdef HAVE_SOCKADDR_UN
603
2.05k
        "<ip>[:<port>]|unix:<path>";
604
#else
605
        "<ip>[:<port>]";
606
#endif
607
2.05k
    const std::string proxy_doc_for_unix_socket =
608
2.05k
#ifdef HAVE_SOCKADDR_UN
609
2.05k
        "May be a local file path prefixed with 'unix:' if the proxy supports it. ";
610
#else
611
        "";
612
#endif
613
2.05k
    argsman.AddArg("-proxy=" + proxy_doc_for_value + "[=<network>]",
614
2.05k
                   "Connect through SOCKS5 proxy, set -noproxy to disable. " +
615
2.05k
                   proxy_doc_for_unix_socket +
616
2.05k
                   "Could end in =network to set the proxy only for that network. " +
617
2.05k
                   "The network can be any of ipv4, ipv6, tor or cjdns. " +
618
2.05k
                   "(default: disabled)",
619
2.05k
                   ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_ELISION,
620
2.05k
                   OptionsCategory::CONNECTION);
621
2.05k
    argsman.AddArg("-proxyrandomize", strprintf("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)", DEFAULT_PROXYRANDOMIZE), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
622
2.05k
    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);
623
2.05k
    argsman.AddArg("-networkactive", "Enable all P2P network activity (default: 1). Can be changed by the setnetworkactive RPC command", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
624
2.05k
    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);
625
2.05k
    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);
626
2.05k
    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);
627
2.05k
    argsman.AddArg("-torpassword=<pass>", "Tor control port password (default: empty)", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::CONNECTION);
628
2.05k
    argsman.AddArg("-natpmp", strprintf("Use PCP or NAT-PMP to map the listening port (default: %u)", DEFAULT_NATPMP), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
629
2.05k
    argsman.AddArg("-whitebind=<[permissions@]addr>", "Bind to the given address and add permission flags to the peers connecting to it. "
630
2.05k
        "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". "
631
2.05k
        "Specify multiple permissions separated by commas (default: download,noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
632
633
2.05k
    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 "
634
2.05k
        "CIDR-notated network (e.g. 1.2.3.0/24). Uses the same permissions as "
635
2.05k
        "-whitebind. "
636
2.05k
        "Additional flags \"in\" and \"out\" control whether permissions apply to incoming connections and/or manual (default: incoming only). "
637
2.05k
        "Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
638
639
2.05k
    g_wallet_init_interface.AddWalletOptions(argsman);
640
641
#ifdef ENABLE_ZMQ
642
    argsman.AddArg("-zmqpubhashblock=<address>", "Enable publish hash block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
643
    argsman.AddArg("-zmqpubhashtx=<address>", "Enable publish hash transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
644
    argsman.AddArg("-zmqpubrawblock=<address>", "Enable publish raw block in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
645
    argsman.AddArg("-zmqpubrawtx=<address>", "Enable publish raw transaction in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
646
    argsman.AddArg("-zmqpubsequence=<address>", "Enable publish hash block and tx sequence in <address>", ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
647
    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);
648
    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);
649
    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);
650
    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);
651
    argsman.AddArg("-zmqpubsequencehwm=<n>", strprintf("Set publish hash sequence message high water mark (default: %d)", CZMQAbstractNotifier::DEFAULT_ZMQ_SNDHWM), ArgsManager::ALLOW_ANY, OptionsCategory::ZMQ);
652
#else
653
2.05k
    hidden_args.emplace_back("-zmqpubhashblock=<address>");
654
2.05k
    hidden_args.emplace_back("-zmqpubhashtx=<address>");
655
2.05k
    hidden_args.emplace_back("-zmqpubrawblock=<address>");
656
2.05k
    hidden_args.emplace_back("-zmqpubrawtx=<address>");
657
2.05k
    hidden_args.emplace_back("-zmqpubsequence=<n>");
658
2.05k
    hidden_args.emplace_back("-zmqpubhashblockhwm=<n>");
659
2.05k
    hidden_args.emplace_back("-zmqpubhashtxhwm=<n>");
660
2.05k
    hidden_args.emplace_back("-zmqpubrawblockhwm=<n>");
661
2.05k
    hidden_args.emplace_back("-zmqpubrawtxhwm=<n>");
662
2.05k
    hidden_args.emplace_back("-zmqpubsequencehwm=<n>");
663
2.05k
#endif
664
665
2.05k
    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);
666
2.05k
    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);
667
2.05k
    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);
668
2.05k
    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);
669
2.05k
    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);
670
    // Checkpoints were removed. We keep `-checkpoints` as a hidden arg to display a more user friendly error when set.
671
2.05k
    argsman.AddArg("-checkpoints", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
672
2.05k
    argsman.AddArg("-deprecatedrpc=<method>", "Allows deprecated RPC method(s) to be used", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
673
2.05k
    argsman.AddArg("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
674
2.05k
    argsman.AddArg("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u). Blocks after target height may be processed during shutdown.", DEFAULT_STOPATHEIGHT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
675
2.05k
    argsman.AddArg("-limitancestorcount=<n>", strprintf("Deprecated setting to not accept transactions if number of in-mempool ancestors is <n> or more (default: %u); replaced by cluster limits (see -limitclustercount) and only used by wallet for coin selection", DEFAULT_ANCESTOR_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
676
    // Ancestor and descendant size limits were removed. We keep
677
    // -limitancestorsize/-limitdescendantsize as hidden args to display a more
678
    // user friendly error when set.
679
2.05k
    argsman.AddArg("-limitancestorsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
680
2.05k
    argsman.AddArg("-limitdescendantsize", "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
681
2.05k
    argsman.AddArg("-limitdescendantcount=<n>", strprintf("Deprecated setting to not accept transactions if any ancestor would have <n> or more in-mempool descendants (default: %u); replaced by cluster limits (see -limitclustercount) and only used by wallet for coin selection", DEFAULT_DESCENDANT_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
682
2.05k
    argsman.AddArg("-test=<option>", "Pass a test-only option. Options include : " + Join(TEST_OPTIONS_DOC, ", ") + ".", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
683
2.05k
    argsman.AddArg("-limitclustercount=<n>", strprintf("Do not accept transactions into mempool which are directly or indirectly connected to <n> or more other unconfirmed transactions (default: %u, maximum: %u)", DEFAULT_CLUSTER_LIMIT, MAX_CLUSTER_COUNT_LIMIT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
684
2.05k
    argsman.AddArg("-limitclustersize=<n>", strprintf("Do not accept transactions whose virtual size with all in-mempool connected transactions exceeds <n> kilobytes (default: %u)", DEFAULT_CLUSTER_SIZE_LIMIT_KVB), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
685
2.05k
    argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
686
2.05k
    argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
687
2.05k
    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);
688
2.05k
    argsman.AddArg("-maxtipage=<n>",
689
2.05k
                   strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)",
690
2.05k
                             Ticks<std::chrono::seconds>(DEFAULT_MAX_TIP_AGE)),
691
2.05k
                   ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
692
2.05k
    argsman.AddArg("-printpriority", strprintf("Log transaction fee rate in %s/kvB when mining blocks (default: %u)", CURRENCY_UNIT, DEFAULT_PRINT_MODIFIED_FEE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
693
2.05k
    argsman.AddArg("-uacomment=<cmt>", "Append comment to the user agent string", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
694
695
2.05k
    SetupChainParamsBaseOptions(argsman);
696
697
2.05k
    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);
698
2.05k
    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);
699
2.05k
    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);
700
2.05k
    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);
701
2.05k
    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);
702
2.05k
    argsman.AddArg("-datacarrier", strprintf("Relay and mine data carrier transactions (default: %u)", DEFAULT_ACCEPT_DATACARRIER), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
703
2.05k
    argsman.AddArg("-datacarriersize",
704
2.05k
                   strprintf("Relay and mine transactions whose data-carrying raw scriptPubKeys in aggregate "
705
2.05k
                             "are of this size or less, allowing multiple outputs (default: %u)",
706
2.05k
                             MAX_OP_RETURN_RELAY),
707
2.05k
                   ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
708
2.05k
    argsman.AddArg("-permitbaremultisig", strprintf("Relay transactions creating non-P2SH multisig outputs (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY,
709
2.05k
                   OptionsCategory::NODE_RELAY);
710
2.05k
    argsman.AddArg("-minrelaytxfee=<amt>", strprintf("Fees (in %s/kvB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)",
711
2.05k
        CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)), ArgsManager::ALLOW_ANY, OptionsCategory::NODE_RELAY);
712
2.05k
    argsman.AddArg("-txsendrate=<n>",
713
2.05k
                   strprintf("Set the maximum ongoing rate for sending transactions to (inbound) peers (default: %u tx/s)",
714
2.05k
                             DEFAULT_TX_SEND_RATE),
715
2.05k
                   ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::NODE_RELAY);
716
2.05k
    argsman.AddArg("-privatebroadcast",
717
2.05k
                   strprintf(
718
2.05k
                       "EXPERIMENTAL: Broadcast transactions submitted via sendrawtransaction RPC using short-lived "
719
2.05k
                       "connections through the Tor or I2P networks, without putting them in the mempool first. "
720
2.05k
                       "This provides best-effort concealment of the transaction's origin. "
721
2.05k
                       "Transactions submitted through the wallet are not affected by this option "
722
2.05k
                       "(default: %u)",
723
2.05k
                   DEFAULT_PRIVATE_BROADCAST),
724
2.05k
                   ArgsManager::ALLOW_ANY,
725
2.05k
                   OptionsCategory::NODE_RELAY);
726
2.05k
    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);
727
2.05k
    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);
728
729
730
2.05k
    argsman.AddArg("-blockmaxweight=<n>", strprintf("Set maximum BIP141 block weight (default: %d)", DEFAULT_BLOCK_MAX_WEIGHT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
731
2.05k
    argsman.AddArg("-blockreservedweight=<n>", strprintf("Reserve space for the fixed-size block header plus the largest coinbase transaction the mining software may add to the block. Only affects mining RPC clients, not IPC clients. (default: %d).", DEFAULT_BLOCK_RESERVED_WEIGHT), ArgsManager::ALLOW_ANY, OptionsCategory::BLOCK_CREATION);
732
2.05k
    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);
733
2.05k
    argsman.AddArg("-blockversion=<n>", "Override block version to test forking scenarios", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::BLOCK_CREATION);
734
735
2.05k
    argsman.AddArg("-rest", strprintf("Accept public REST requests (default: %u)", DEFAULT_REST_ENABLE), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
736
2.05k
    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). RFC4193 is allowed only if -cjdnsreachable=0. This option can be specified multiple times", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
737
2.05k
    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);
738
2.05k
    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);
739
2.05k
    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);
740
2.05k
    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);
741
2.05k
    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);
742
2.05k
    argsman.AddArg("-rpcmaxconnections=<n>", strprintf("The maximum number of connected HTTP clients (default: %d)", DEFAULT_MAX_HTTP_CONNECTIONS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
743
2.05k
    argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
744
2.05k
    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);
745
2.05k
    argsman.AddArg("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
746
2.05k
    argsman.AddArg("-rpcthreads=<n>", strprintf("Set the number of threads to service RPC calls (default: %d)", DEFAULT_HTTP_THREADS), ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
747
2.05k
    argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE, OptionsCategory::RPC);
748
2.05k
    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);
749
2.05k
    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);
750
2.05k
    argsman.AddArg("-rpcworkqueue=<n>", strprintf("Set the maximum depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::RPC);
751
2.05k
    argsman.AddArg("-server", "Accept command line and JSON-RPC commands", ArgsManager::ALLOW_ANY, OptionsCategory::RPC);
752
2.05k
    if (can_listen_ipc) {
753
14
        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. Enabling this gives local processes that can access the socket unauthenticated RPC access, so it's important to choose a path with secure permissions if customizing this.", ArgsManager::ALLOW_ANY, OptionsCategory::IPC);
754
14
    }
755
756
2.05k
#if HAVE_DECL_FORK
757
2.05k
    argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
758
2.05k
    argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
759
#else
760
    hidden_args.emplace_back("-daemon");
761
    hidden_args.emplace_back("-daemonwait");
762
#endif
763
764
    // Add the hidden options
765
2.05k
    argsman.AddHiddenArgs(hidden_args);
766
2.05k
}
767
768
#if HAVE_SYSTEM
769
static void StartupNotify(const ArgsManager& args)
770
1.07k
{
771
1.07k
    std::string cmd = args.GetArg("-startupnotify", "");
772
1.07k
    if (!cmd.empty()) {
773
1
        std::thread t(runCommand, cmd);
774
1
        t.detach(); // thread runs free
775
1
    }
776
1.07k
}
777
#endif
778
779
static bool AppInitServers(NodeContext& node)
780
1.20k
{
781
1.20k
    const ArgsManager& args = *Assert(node.args);
782
1.20k
    if (!InitHTTPServer()) {
783
1
        return false;
784
1
    }
785
1.20k
    StartRPC();
786
1.20k
    node.rpc_interruption_point = RpcInterruptionPoint;
787
1.20k
    if (!StartHTTPRPC(&node))
788
12
        return false;
789
1.18k
    if (args.GetBoolArg("-rest", DEFAULT_REST_ENABLE)) StartREST(&node);
790
1.18k
    StartHTTPServer();
791
1.18k
    return true;
792
1.20k
}
793
794
// Parameter interaction based on rules
795
void InitParameterInteraction(ArgsManager& args)
796
1.24k
{
797
    // when specifying an explicit binding address, you want to listen on it
798
    // even when -connect or -proxy is specified
799
1.24k
    if (!args.GetArgs("-bind").empty()) {
800
1.20k
        if (args.SoftSetBoolArg("-listen", true))
801
1.20k
            LogInfo("parameter interaction: -bind set -> setting -listen=1\n");
802
1.20k
    }
803
1.24k
    if (!args.GetArgs("-whitebind").empty()) {
804
9
        if (args.SoftSetBoolArg("-listen", true))
805
9
            LogInfo("parameter interaction: -whitebind set -> setting -listen=1\n");
806
9
    }
807
808
1.24k
    if (!args.GetArgs("-connect").empty() || args.IsArgNegated("-connect") || args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS) <= 0) {
809
        // when only connecting to trusted nodes, do not seed via DNS, or listen by default
810
        // do the same when connections are disabled
811
1.20k
        if (args.SoftSetBoolArg("-dnsseed", false))
812
1.20k
            LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0\n");
813
1.20k
        if (args.SoftSetBoolArg("-listen", false))
814
1.20k
            LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0\n");
815
1.20k
    }
816
817
1.24k
    std::string proxy_arg = args.GetArg("-proxy", "");
818
1.24k
    if (proxy_arg != "" && proxy_arg != "0") {
819
        // to protect privacy, do not listen by default if a default proxy server is specified
820
49
        if (args.SoftSetBoolArg("-listen", false))
821
49
            LogInfo("parameter interaction: -proxy set -> setting -listen=0\n");
822
        // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
823
        // to listen locally, so don't rely on this happening through -listen below.
824
49
        if (args.SoftSetBoolArg("-natpmp", false)) {
825
0
            LogInfo("parameter interaction: -proxy set -> setting -natpmp=0\n");
826
0
        }
827
        // to protect privacy, do not discover addresses by default
828
49
        if (args.SoftSetBoolArg("-discover", false))
829
49
            LogInfo("parameter interaction: -proxy set -> setting -discover=0\n");
830
49
    }
831
832
1.24k
    if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
833
        // do not map ports or try to retrieve public IP when not listening (pointless)
834
34
        if (args.SoftSetBoolArg("-natpmp", false)) {
835
0
            LogInfo("parameter interaction: -listen=0 -> setting -natpmp=0\n");
836
0
        }
837
34
        if (args.SoftSetBoolArg("-discover", false))
838
34
            LogInfo("parameter interaction: -listen=0 -> setting -discover=0\n");
839
34
        if (args.SoftSetBoolArg("-listenonion", false))
840
34
            LogInfo("parameter interaction: -listen=0 -> setting -listenonion=0\n");
841
34
        if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
842
34
            LogInfo("parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n");
843
34
        }
844
34
    }
845
846
1.24k
    if (!args.GetArgs("-externalip").empty()) {
847
        // if an explicit public IP is specified, do not try to find others
848
13
        if (args.SoftSetBoolArg("-discover", false))
849
13
            LogInfo("parameter interaction: -externalip set -> setting -discover=0\n");
850
13
    }
851
852
1.24k
    if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
853
        // disable whitelistrelay in blocksonly mode
854
7
        if (args.SoftSetBoolArg("-whitelistrelay", false))
855
7
            LogInfo("parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n");
856
        // Reduce default mempool size in blocksonly mode to avoid unexpected resource usage
857
7
        if (args.SoftSetArg("-maxmempool", ToString(DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB)))
858
7
            LogInfo("parameter interaction: -blocksonly=1 -> setting -maxmempool=%d\n", DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB);
859
7
    }
860
861
    // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
862
1.24k
    if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
863
3
        if (args.SoftSetBoolArg("-whitelistrelay", true))
864
3
            LogInfo("parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n");
865
3
    }
866
1.24k
    const auto onlynets = args.GetArgs("-onlynet");
867
1.24k
    if (!onlynets.empty()) {
868
9
        bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
869
9
            const auto n = ParseNetwork(net);
870
9
            return n == NET_IPV4 || n == NET_IPV6;
871
9
        });
872
9
        if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
873
0
            LogInfo("parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n");
874
0
        }
875
9
    }
876
1.24k
}
877
878
/**
879
 * Initialize global loggers.
880
 *
881
 * Note that this is called very early in the process lifetime, so you should be
882
 * careful about what global state you rely on here.
883
 */
884
void InitLogging(const ArgsManager& args)
885
2.01k
{
886
2.01k
    init::SetLoggingOptions(args);
887
2.01k
    init::LogPackageVersion();
888
2.01k
}
889
890
namespace { // Variables internal to initialization process only
891
892
int num_p2p_max_connections;
893
int available_fds;
894
ServiceFlags g_local_services = ServiceFlags(NODE_NETWORK_LIMITED | NODE_WITNESS);
895
int64_t peer_connect_timeout;
896
std::set<BlockFilterType> g_enabled_filter_types;
897
898
} // namespace
899
900
[[noreturn]] static void new_handler_terminate()
901
0
{
902
    // Rather than throwing std::bad-alloc if allocation fails, terminate
903
    // immediately to (try to) avoid chain corruption.
904
    // Since logging may itself allocate memory, set the handler directly
905
    // to terminate first.
906
0
    std::set_new_handler(std::terminate);
907
0
    LogError("Out of memory. Terminating.\n");
908
909
    // The log was successful, terminate now.
910
0
    std::terminate();
911
0
};
912
913
bool AppInitBasicSetup(const ArgsManager& args, std::atomic<int>& exit_status)
914
1.24k
{
915
    // ********************************************************* Step 1: setup
916
#ifdef _MSC_VER
917
    // Turn off Microsoft heap dump noise
918
    _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
919
    _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
920
    // Disable confusing "helpful" text message on abort, Ctrl-C
921
    _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
922
#endif
923
#ifdef WIN32
924
    // Enable heap terminate-on-corruption
925
    HeapSetInformation(nullptr, HeapEnableTerminationOnCorruption, nullptr, 0);
926
#endif
927
1.24k
    if (!SetupNetworking()) {
928
0
        return InitError(Untranslated("Initializing networking failed."));
929
0
    }
930
931
1.24k
#ifndef WIN32
932
    // Clean shutdown on SIGTERM
933
1.24k
    registerSignalHandler(SIGTERM, HandleSIGTERM);
934
1.24k
    registerSignalHandler(SIGINT, HandleSIGTERM);
935
936
    // Reopen debug.log on SIGHUP
937
1.24k
    registerSignalHandler(SIGHUP, HandleSIGHUP);
938
939
    // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
940
1.24k
    signal(SIGPIPE, SIG_IGN);
941
#else
942
    SetConsoleCtrlHandler(consoleCtrlHandler, true);
943
#endif
944
945
1.24k
    std::set_new_handler(new_handler_terminate);
946
947
1.24k
    return true;
948
1.24k
}
949
950
bool AppInitParameterInteraction(const ArgsManager& args)
951
4.00k
{
952
4.00k
    const CChainParams& chainparams = Params();
953
    // ********************************************************* Step 2: parameter interactions
954
955
    // also see: InitParameterInteraction()
956
957
    // We removed checkpoints but keep the option to warn users who still have it in their config.
958
4.00k
    if (args.IsArgSet("-checkpoints")) {
959
0
        InitWarning(_("Option '-checkpoints' is set but checkpoints were removed. This option has no effect."));
960
0
    }
961
4.00k
    if (args.IsArgSet("-limitancestorsize")) {
962
0
        InitWarning(_("Option '-limitancestorsize' is given but ancestor size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
963
0
    }
964
4.00k
    if (args.IsArgSet("-limitdescendantsize")) {
965
0
        InitWarning(_("Option '-limitdescendantsize' is given but descendant size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
966
0
    }
967
968
    // Error if network-specific options (-addnode, -connect, etc) are
969
    // specified in default section of config file, but not overridden
970
    // on the command line or in this chain's section of the config file.
971
4.00k
    ChainType chain = args.GetChainType();
972
4.00k
    if (chain == ChainType::SIGNET) {
973
15
        LogInfo("Signet derived magic (message start): %s", HexStr(chainparams.MessageStart()));
974
15
    }
975
4.00k
    bilingual_str errors;
976
4.00k
    for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
977
1
        errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section."), arg, ChainTypeToString(chain), ChainTypeToString(chain)) + Untranslated("\n");
978
1
    }
979
980
4.00k
    if (!errors.empty()) {
981
1
        return InitError(errors);
982
1
    }
983
984
    // Testnet3 deprecation warning
985
4.00k
    if (chain == ChainType::TESTNET) {
986
2
        LogInfo("Warning: Support for testnet3 is deprecated and will be removed in an upcoming release. Consider switching to testnet4.\n");
987
2
    }
988
989
    // Warn if unrecognized section name are present in the config file.
990
4.00k
    bilingual_str warnings;
991
4.00k
    for (const auto& section : args.GetUnrecognizedSections()) {
992
2
        warnings += Untranslated(strprintf("%s:%i ", section.m_file, section.m_line)) + strprintf(_("Section [%s] is not recognized."), section.m_name) + Untranslated("\n");
993
2
    }
994
995
4.00k
    if (!warnings.empty()) {
996
1
        InitWarning(warnings);
997
1
    }
998
999
4.00k
    if (!fs::is_directory(args.GetBlocksDirPath())) {
1000
1
        return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
1001
1
    }
1002
1003
    // parse and validate enabled filter types
1004
4.00k
    std::string blockfilterindex_value = args.GetArg("-blockfilterindex", DEFAULT_BLOCKFILTERINDEX);
1005
4.00k
    if (blockfilterindex_value == "" || blockfilterindex_value == "1") {
1006
50
        g_enabled_filter_types = AllBlockFilterTypes();
1007
3.95k
    } else if (blockfilterindex_value != "0") {
1008
1
        const std::vector<std::string> names = args.GetArgs("-blockfilterindex");
1009
1
        for (const auto& name : names) {
1010
1
            BlockFilterType filter_type;
1011
1
            if (!BlockFilterTypeByName(name, filter_type)) {
1012
1
                return InitError(strprintf(_("Unknown -blockfilterindex value %s."), name));
1013
1
            }
1014
0
            g_enabled_filter_types.insert(filter_type);
1015
0
        }
1016
1
    }
1017
1018
    // Signal NODE_P2P_V2 if BIP324 v2 transport is enabled.
1019
4.00k
    if (args.GetBoolArg("-v2transport", DEFAULT_V2_TRANSPORT)) {
1020
828
        g_local_services = ServiceFlags(g_local_services | NODE_P2P_V2);
1021
828
    }
1022
1023
    // Signal NODE_COMPACT_FILTERS if peerblockfilters and basic filters index are both enabled.
1024
4.00k
    if (args.GetBoolArg("-peerblockfilters", DEFAULT_PEERBLOCKFILTERS)) {
1025
2
        if (!g_enabled_filter_types.contains(BlockFilterType::BASIC)) {
1026
1
            return InitError(_("Cannot set -peerblockfilters without -blockfilterindex."));
1027
1
        }
1028
1029
1
        g_local_services = ServiceFlags(g_local_services | NODE_COMPACT_FILTERS);
1030
1
    }
1031
1032
4.00k
    if (args.GetIntArg("-prune", 0)) {
1033
45
        if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX))
1034
0
            return InitError(_("Prune mode is incompatible with -txindex."));
1035
45
        if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX))
1036
0
            return InitError(_("Prune mode is incompatible with -txospenderindex."));
1037
45
        if (args.GetBoolArg("-reindex-chainstate", false)) {
1038
0
            return InitError(_("Prune mode is incompatible with -reindex-chainstate. Use full -reindex instead."));
1039
0
        }
1040
45
    }
1041
1042
    // If -forcednsseed is set to true, ensure -dnsseed has not been set to false
1043
4.00k
    if (args.GetBoolArg("-forcednsseed", DEFAULT_FORCEDNSSEED) && !args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED)){
1044
2
        return InitError(_("Cannot set -forcednsseed to true when setting -dnsseed to false."));
1045
2
    }
1046
1047
    // -bind and -whitebind can't be set when not listening
1048
4.00k
    size_t num_user_p2p_bind = args.GetArgs("-bind").size() + args.GetArgs("-whitebind").size();
1049
4.00k
    if (num_user_p2p_bind != 0 && !args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
1050
1
        return InitError(Untranslated("Cannot set -bind or -whitebind together with -listen=0"));
1051
1
    }
1052
1053
    // if listen=0, then disallow listenonion=1
1054
4.00k
    if (!args.GetBoolArg("-listen", DEFAULT_LISTEN) && args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)) {
1055
0
        return InitError(Untranslated("Cannot set -listen=0 together with -listenonion=1"));
1056
0
    }
1057
1058
    // Make sure enough file descriptors are available. We need to reserve enough FDs to account for the bare minimum,
1059
    // plus all manual connections and all bound interfaces. Any remainder will be available for connection sockets
1060
1061
    // Number of bound interfaces (we have at least one)
1062
4.00k
    int num_p2p_bind = std::max(num_user_p2p_bind, size_t(1));
1063
    // Maximum number of connections with other nodes, this accounts for all types of outbounds and inbounds except for manual
1064
4.00k
    int user_p2p_max_connections = args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
1065
4.00k
    if (user_p2p_max_connections < 0) {
1066
0
        return InitError(Untranslated("-maxconnections must be greater or equal than zero"));
1067
0
    }
1068
4.00k
    const size_t max_private{args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)
1069
4.00k
                             ? MAX_PRIVATE_BROADCAST_CONNECTIONS
1070
4.00k
                             : 0};
1071
1072
    // HTTP server listen sockets: by default two (IPv4 and IPv6 loopback), or one per -rpcbind entry
1073
4.00k
    int num_rpc_bind = std::max(args.GetArgs("-rpcbind").size(), size_t(2));
1074
    // HTTP server connected client sockets
1075
4.00k
    int user_rpc_max_connections = args.GetArg<int>("-rpcmaxconnections", DEFAULT_MAX_HTTP_CONNECTIONS);
1076
4.00k
    if (user_rpc_max_connections < 1) {
1077
0
        return InitError(Untranslated("-rpcmaxconnections must be greater than zero. Use -server=0 to disable HTTP."));
1078
0
    }
1079
4.00k
    if (!args.GetBoolArg("-server", false)) {
1080
774
        num_rpc_bind = 0;
1081
774
        user_rpc_max_connections = 0;
1082
774
    }
1083
1084
    // Reserve enough FDs to account for the bare minimum, plus any manual connections, plus the bound interfaces.
1085
    // Every element is an int >= 0 so summing in int64_t cannot overflow.
1086
    // RaiseFileDescriptorLimit() accepts an int so we check that limit before casting.
1087
4.00k
    const int64_t total_fds = int64_t{MIN_CORE_FDS} +
1088
4.00k
                              MAX_ADDNODE_CONNECTIONS +
1089
4.00k
                              num_p2p_bind +
1090
4.00k
                              num_rpc_bind +
1091
4.00k
                              user_rpc_max_connections +
1092
4.00k
                              user_p2p_max_connections +
1093
4.00k
                              static_cast<int64_t>(max_private);
1094
4.00k
    if (total_fds > std::numeric_limits<int>::max()) {
1095
1
        return InitError(Untranslated("Too many file descriptors requested. Try lower values for -rpcmaxconnections "
1096
1
                                      "or -maxconnections, or fewer settings of "
1097
1
                                      "-rpcbind, -bind and -whitebind"));
1098
1
    }
1099
1100
    // Subset of total_fds must also be a safe int
1101
4.00k
    int min_required_fds = MIN_CORE_FDS +
1102
4.00k
                           MAX_ADDNODE_CONNECTIONS +
1103
4.00k
                           num_p2p_bind +
1104
4.00k
                           num_rpc_bind +
1105
4.00k
                           user_rpc_max_connections;
1106
1107
    // Try raising the FD limit to what the user wants (available_fds may be smaller than the requested amount if this fails)
1108
4.00k
    available_fds = RaiseFileDescriptorLimit(static_cast<int>(total_fds));
1109
    // If we are using select instead of poll, our actual limit may be even smaller
1110
#ifndef USE_POLL
1111
    available_fds = std::min(FD_SETSIZE, available_fds);
1112
#endif
1113
    // The system can't support our bare minimum
1114
4.00k
    if (available_fds < min_required_fds)
1115
0
        return InitError(strprintf(_("Not enough file descriptors available. %d available, %d required."), available_fds, min_required_fds));
1116
1117
    // The system can support our minimum but not the full amount the user requested.
1118
4.00k
    if (available_fds < total_fds) {
1119
        // If the user is requesting extra HTTP connections, abort. They need to change that.
1120
2
        if (user_rpc_max_connections > DEFAULT_MAX_HTTP_CONNECTIONS) {
1121
1
            return InitError(strprintf(_("Not enough file descriptors available. "
1122
1
                                         "Try reducing -rpcmaxconnections or using the default value of %d"),
1123
1
                                         DEFAULT_MAX_HTTP_CONNECTIONS));
1124
1
        }
1125
2
    }
1126
1127
    // Trim requested connection counts, to fit into system limitations
1128
4.00k
    num_p2p_max_connections = std::min(available_fds - min_required_fds, user_p2p_max_connections);
1129
1130
4.00k
    if (num_p2p_max_connections < user_p2p_max_connections)
1131
1
        InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), user_p2p_max_connections, num_p2p_max_connections));
1132
1133
    // ********************************************************* Step 3: parameter-to-internal-flags
1134
4.00k
    if (auto result{init::SetLoggingCategories(args)}; !result) return InitError(util::ErrorString(result));
1135
3.99k
    if (auto result{init::SetLoggingLevel(args)}; !result) return InitError(util::ErrorString(result));
1136
1137
3.99k
    nConnectTimeout = args.GetIntArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1138
3.99k
    if (nConnectTimeout <= 0) {
1139
0
        nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1140
0
    }
1141
1142
3.99k
    peer_connect_timeout = args.GetIntArg("-peertimeout", DEFAULT_PEER_CONNECT_TIMEOUT);
1143
3.99k
    if (peer_connect_timeout <= 0) {
1144
2
        return InitError(Untranslated("peertimeout must be a positive integer."));
1145
2
    }
1146
1147
3.99k
    auto mining_result{node::ReadMiningArgs(args)};
1148
3.99k
    if (!mining_result) {
1149
4
        return InitError(util::ErrorString(mining_result));
1150
4
    }
1151
1152
3.98k
    nBytesPerSigOp = args.GetIntArg("-bytespersigop", nBytesPerSigOp);
1153
1154
3.98k
    if (!g_wallet_init_interface.ParameterInteraction()) return false;
1155
1156
    // Option to startup with mocktime set (used for regression testing):
1157
3.98k
    if (const auto mocktime{args.GetIntArg("-mocktime")}) {
1158
11
        SetMockTime(std::chrono::seconds{*mocktime});
1159
11
    }
1160
1161
3.98k
    if (args.GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1162
4
        g_local_services = ServiceFlags(g_local_services | NODE_BLOOM);
1163
1164
3.98k
    const std::vector<std::string> test_options = args.GetArgs("-test");
1165
3.98k
    if (!test_options.empty()) {
1166
16
        if (chainparams.GetChainType() != ChainType::REGTEST) {
1167
0
            return InitError(Untranslated("-test=<option> can only be used with regtest"));
1168
0
        }
1169
16
        for (const std::string& option : test_options) {
1170
19
            auto it = std::find_if(TEST_OPTIONS_DOC.begin(), TEST_OPTIONS_DOC.end(), [&option](const std::string& doc_option) {
1171
19
                size_t pos = doc_option.find(" (");
1172
19
                return (pos != std::string::npos) && (doc_option.substr(0, pos) == option);
1173
19
            });
1174
16
            if (it == TEST_OPTIONS_DOC.end()) {
1175
0
                InitWarning(strprintf(_("Unrecognised option \"%s\" provided in -test=<option>."), option));
1176
0
            }
1177
16
        }
1178
16
    }
1179
1180
    // Prevent setting deployment parameters on mainnet.
1181
3.98k
    if (chainparams.GetChainType() == ChainType::MAIN) {
1182
657
        if (args.IsArgSet("-testactivationheight")) {
1183
0
            return InitError(_("The -testactivationheight option may not be used on mainnet."));
1184
0
        }
1185
657
        if (args.IsArgSet("-vbparams")) {
1186
0
            return InitError(_("The -vbparams option may not be used on mainnet."));
1187
0
        }
1188
657
    }
1189
1190
    // Also report errors from parsing before daemonization
1191
3.98k
    {
1192
3.98k
        kernel::Notifications notifications{};
1193
3.98k
        ChainstateManager::Options chainman_opts_dummy{
1194
3.98k
            .chainparams = chainparams,
1195
3.98k
            .datadir = args.GetDataDirNet(),
1196
3.98k
            .notifications = notifications,
1197
3.98k
        };
1198
3.98k
        auto chainman_result{ApplyArgsManOptions(args, chainman_opts_dummy)};
1199
3.98k
        if (!chainman_result) {
1200
1
            return InitError(util::ErrorString(chainman_result));
1201
1
        }
1202
3.98k
        BlockManager::Options blockman_opts_dummy{
1203
3.98k
            .chainparams = chainman_opts_dummy.chainparams,
1204
3.98k
            .blocks_dir = args.GetBlocksDirPath(),
1205
3.98k
            .notifications = chainman_opts_dummy.notifications,
1206
3.98k
            .block_tree_db_params = DBParams{
1207
3.98k
                .path = args.GetDataDirNet() / "blocks" / "index",
1208
3.98k
                .cache_bytes = 0,
1209
3.98k
            },
1210
3.98k
        };
1211
3.98k
        auto blockman_result{ApplyArgsManOptions(args, blockman_opts_dummy)};
1212
3.98k
        if (!blockman_result) {
1213
0
            return InitError(util::ErrorString(blockman_result));
1214
0
        }
1215
3.98k
        CTxMemPool::Options mempool_opts{};
1216
3.98k
        auto mempool_result{ApplyArgsManOptions(args, chainparams, mempool_opts)};
1217
3.98k
        if (!mempool_result) {
1218
1
            return InitError(util::ErrorString(mempool_result));
1219
1
        }
1220
3.98k
    }
1221
1222
3.98k
    return true;
1223
3.98k
}
1224
1225
static bool LockDirectory(const fs::path& dir, bool probeOnly)
1226
4.88k
{
1227
    // Make sure only a single process is using the directory.
1228
4.88k
    switch (util::LockDirectory(dir, ".lock", probeOnly)) {
1229
0
    case util::LockResult::ErrorWrite:
1230
0
        return InitError(strprintf(_("Cannot write to directory '%s'; check permissions."), fs::PathToString(dir)));
1231
2
    case util::LockResult::ErrorLock:
1232
2
        return InitError(strprintf(_("Cannot obtain a lock on directory %s. %s is probably already running."), fs::PathToString(dir), CLIENT_NAME));
1233
4.88k
    case util::LockResult::Success: return true;
1234
4.88k
    } // no default case, so the compiler can warn about missing cases
1235
4.88k
    assert(false);
1236
0
}
1237
static bool LockDirectories(bool probeOnly)
1238
2.44k
{
1239
2.44k
    return LockDirectory(gArgs.GetDataDirNet(), probeOnly) && \
1240
2.44k
           LockDirectory(gArgs.GetBlocksDirPath(), probeOnly);
1241
2.44k
}
1242
1243
bool AppInitSanityChecks(const kernel::Context& kernel)
1244
1.22k
{
1245
    // ********************************************************* Step 4: sanity checks
1246
1.22k
    auto result{kernel::SanityChecks(kernel)};
1247
1.22k
    if (!result) {
1248
0
        InitError(util::ErrorString(result));
1249
0
        return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), CLIENT_NAME));
1250
0
    }
1251
1252
1.22k
    if (!ECC_InitSanityCheck()) {
1253
0
        return InitError(strprintf(_("Elliptic curve cryptography sanity check failure. %s is shutting down."), CLIENT_NAME));
1254
0
    }
1255
1256
    // Probe the directory locks to give an early error message, if possible
1257
    // We cannot hold the directory locks here, as the forking for daemon() hasn't yet happened,
1258
    // and a fork will cause weird behavior to them.
1259
1.22k
    return LockDirectories(true);
1260
1.22k
}
1261
1262
bool AppInitLockDirectories()
1263
1.22k
{
1264
    // After daemonization get the directory locks again and hold on to them until exit
1265
    // This creates a slight window for a race condition to happen, however this condition is harmless: it
1266
    // will at most make us exit without printing a message to console.
1267
1.22k
    if (!LockDirectories(false)) {
1268
        // Detailed error printed inside LockDirectory
1269
0
        return false;
1270
0
    }
1271
1.22k
    return true;
1272
1.22k
}
1273
1274
bool AppInitInterfaces(NodeContext& node)
1275
1.22k
{
1276
1.22k
    node.chain = interfaces::MakeChain(node);
1277
1.22k
    return true;
1278
1.22k
}
1279
1280
1.21k
bool CheckHostPortOptions(const ArgsManager& args) {
1281
1.21k
    for (const std::string port_option : {
1282
1.21k
        "-port",
1283
1.21k
        "-rpcport",
1284
2.43k
    }) {
1285
2.43k
        if (const auto port{args.GetArg(port_option)}) {
1286
2.43k
            const auto n{ToIntegral<uint16_t>(*port)};
1287
2.43k
            if (!n || *n == 0) {
1288
2
                return InitError(InvalidPortErrMsg(port_option, *port));
1289
2
            }
1290
2.43k
        }
1291
2.43k
    }
1292
1293
1.21k
    for ([[maybe_unused]] const auto& [param_name, unix, suffix_allowed] : std::vector<std::tuple<std::string, bool, bool>>{
1294
        // arg name          UNIX socket support  =suffix allowed
1295
1.21k
        {"-i2psam",          false,               false},
1296
1.21k
        {"-onion",           true,                false},
1297
1.21k
        {"-proxy",           true,                true},
1298
1.21k
        {"-bind",            false,               true},
1299
1.21k
        {"-rpcbind",         false,               false},
1300
1.21k
        {"-torcontrol",      false,               false},
1301
1.21k
        {"-whitebind",       false,               false},
1302
1.21k
        {"-zmqpubhashblock", true,                false},
1303
1.21k
        {"-zmqpubhashtx",    true,                false},
1304
1.21k
        {"-zmqpubrawblock",  true,                false},
1305
1.21k
        {"-zmqpubrawtx",     true,                false},
1306
1.21k
        {"-zmqpubsequence",  true,                false},
1307
14.5k
    }) {
1308
14.5k
        for (const std::string& param_value : args.GetArgs(param_name)) {
1309
1.30k
            const std::string param_value_hostport{
1310
1.30k
                suffix_allowed ? param_value.substr(0, param_value.rfind('=')) : param_value};
1311
1.30k
            std::string host_out;
1312
1.30k
            uint16_t port_out{0};
1313
1.30k
            if (!SplitHostPort(param_value_hostport, port_out, host_out)) {
1314
14
#ifdef HAVE_SOCKADDR_UN
1315
                // Allow unix domain sockets for some options e.g. unix:/some/file/path
1316
14
                if (!unix || !param_value.starts_with(ADDR_PREFIX_UNIX)) {
1317
11
                    return InitError(InvalidPortErrMsg(param_name, param_value));
1318
11
                }
1319
#else
1320
                return InitError(InvalidPortErrMsg(param_name, param_value));
1321
#endif
1322
14
            }
1323
1.30k
        }
1324
14.5k
    }
1325
1326
1.20k
    return true;
1327
1.21k
}
1328
1329
/**
1330
 * @brief Checks for duplicate bindings across all binding configurations.
1331
 *
1332
 * @param[in] conn_options Connection options containing the binding vectors to check
1333
 * @return std::optional<CService> containing the first duplicate found, or std::nullopt if no duplicates
1334
 */
1335
static std::optional<CService> CheckBindingConflicts(const CConnman::Options& conn_options)
1336
1.09k
{
1337
1.09k
    std::set<CService> seen;
1338
1339
    // Check all whitelisted bindings
1340
1.09k
    for (const auto& wb : conn_options.vWhiteBinds) {
1341
8
        if (!seen.insert(wb.m_service).second) {
1342
1
            return wb.m_service;
1343
1
        }
1344
8
    }
1345
1346
    // Check regular bindings
1347
1.09k
    for (const auto& bind : conn_options.vBinds) {
1348
1.06k
        if (!seen.insert(bind).second) {
1349
2
            return bind;
1350
2
        }
1351
1.06k
    }
1352
1353
    // Check onion bindings
1354
1.09k
    for (const auto& onion_bind : conn_options.onion_binds) {
1355
45
        if (!seen.insert(onion_bind).second) {
1356
3
            return onion_bind;
1357
3
        }
1358
45
    }
1359
1360
1.09k
    return std::nullopt;
1361
1.09k
}
1362
1363
// A GUI user may opt to retry once with do_reindex set if there is a failure during chainstate initialization.
1364
// The function therefore has to support re-entry.
1365
static ChainstateLoadResult InitAndLoadChainstate(
1366
    NodeContext& node,
1367
    bool do_reindex,
1368
    const bool do_reindex_chainstate,
1369
    const kernel::CacheSizes& cache_sizes,
1370
    const ArgsManager& args)
1371
2.28k
{
1372
    // This function may be called twice, so any dirty state must be reset.
1373
2.28k
    node.notifications->setChainstateLoaded(false); // Drop state, such as a cached tip block
1374
2.28k
    node.block_template_manager.reset();
1375
2.28k
    node.mempool.reset();
1376
2.28k
    node.chainman.reset(); // Drop state, such as an initialized m_block_tree_db
1377
1378
2.28k
    const CChainParams& chainparams = Params();
1379
1380
2.28k
    CTxMemPool::Options mempool_opts{
1381
2.28k
        .check_ratio = chainparams.DefaultConsistencyChecks() ? 1 : 0,
1382
2.28k
        .signals = node.validation_signals.get(),
1383
2.28k
    };
1384
2.28k
    Assert(ApplyArgsManOptions(args, chainparams, mempool_opts)); // no error can happen, already checked in AppInitParameterInteraction
1385
2.28k
    bilingual_str mempool_error;
1386
2.28k
    Assert(!node.mempool); // Was reset above
1387
2.28k
    node.mempool = std::make_unique<CTxMemPool>(mempool_opts, mempool_error);
1388
2.28k
    if (!mempool_error.empty()) {
1389
1
        return {ChainstateLoadStatus::FAILURE_FATAL, mempool_error};
1390
1
    }
1391
2.28k
    LogInfo("* Using %.1f MiB for in-memory UTXO set (plus up to %.1f MiB of unused mempool space)",
1392
2.28k
            cache_sizes.coins / double(1_MiB),
1393
2.28k
            mempool_opts.max_size_bytes / double(1_MiB));
1394
2.28k
    ChainstateManager::Options chainman_opts{
1395
2.28k
        .chainparams = chainparams,
1396
2.28k
        .datadir = args.GetDataDirNet(),
1397
2.28k
        .notifications = *node.notifications,
1398
2.28k
        .signals = node.validation_signals.get(),
1399
2.28k
    };
1400
2.28k
    Assert(ApplyArgsManOptions(args, chainman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1401
1402
2.28k
    BlockManager::Options blockman_opts{
1403
2.28k
        .chainparams = chainman_opts.chainparams,
1404
2.28k
        .blocks_dir = args.GetBlocksDirPath(),
1405
2.28k
        .notifications = chainman_opts.notifications,
1406
2.28k
        .block_tree_db_params = DBParams{
1407
2.28k
            .path = args.GetDataDirNet() / "blocks" / "index",
1408
2.28k
            .cache_bytes = cache_sizes.block_tree_db,
1409
2.28k
            .wipe_data = do_reindex,
1410
2.28k
        },
1411
2.28k
    };
1412
2.28k
    Assert(ApplyArgsManOptions(args, blockman_opts)); // no error can happen, already checked in AppInitParameterInteraction
1413
1414
    // Creating the chainstate manager internally creates a BlockManager, opens
1415
    // the blocks tree db, and wipes existing block files in case of a reindex.
1416
    // The coinsdb is opened at a later point on LoadChainstate.
1417
2.28k
    Assert(!node.chainman); // Was reset above
1418
2.28k
    try {
1419
2.28k
        node.chainman = std::make_unique<ChainstateManager>(*Assert(node.shutdown_signal), chainman_opts, blockman_opts);
1420
2.28k
    } catch (dbwrapper_error& e) {
1421
1
        LogError("%s", e.what());
1422
1
        return {ChainstateLoadStatus::FAILURE, _("Error opening block database")};
1423
1
    } catch (std::exception& e) {
1424
1
        return {ChainstateLoadStatus::FAILURE_FATAL, Untranslated(strprintf("Failed to initialize ChainstateManager: %s", e.what()))};
1425
1
    }
1426
1.13k
    ChainstateManager& chainman = *node.chainman;
1427
1.13k
    if (chainman.m_interrupt) return {ChainstateLoadStatus::INTERRUPTED, {}};
1428
1429
    // This is defined and set here instead of inline in validation.h to avoid a hard
1430
    // dependency between validation and index/base, since the latter is not in
1431
    // libbitcoinkernel.
1432
1.13k
    chainman.snapshot_download_completed = [&node]() {
1433
7
        if (!node.chainman->m_blockman.IsPruneMode()) {
1434
5
            LogInfo("[snapshot] re-enabling NODE_NETWORK services");
1435
5
            node.connman->AddLocalServices(NODE_NETWORK);
1436
5
        }
1437
7
        LogInfo("[snapshot] restarting indexes");
1438
        // Drain the validation interface queue to ensure that the old indexes
1439
        // don't have any pending work.
1440
7
        Assert(node.validation_signals)->SyncWithValidationInterfaceQueue();
1441
8
        for (auto* index : node.indexes) {
1442
8
            index->Interrupt();
1443
8
            index->Stop();
1444
8
            if (!(index->Init() && index->StartBackgroundSync())) {
1445
0
                LogWarning("[snapshot] Failed to restart index %s on snapshot chain", index->GetName());
1446
0
            }
1447
8
        }
1448
7
    };
1449
1.13k
    node::ChainstateLoadOptions options;
1450
1.13k
    options.mempool = Assert(node.mempool.get());
1451
1.13k
    options.wipe_chainstate_db = do_reindex || do_reindex_chainstate;
1452
1.13k
    options.prune = chainman.m_blockman.IsPruneMode();
1453
1.13k
    options.check_blocks = args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
1454
1.13k
    options.check_level = args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
1455
1.13k
    options.require_full_verification = args.IsArgSet("-checkblocks") || args.IsArgSet("-checklevel");
1456
1.13k
    options.coins_error_cb = [] {
1457
0
        uiInterface.ThreadSafeMessageBox(
1458
0
            _("Error reading from database, shutting down."),
1459
0
            CClientUIInterface::MSG_ERROR);
1460
0
    };
1461
1.13k
    uiInterface.InitMessage(_("Loading block index…"));
1462
2.25k
    auto catch_exceptions = [](auto&& f) -> ChainstateLoadResult {
1463
2.25k
        try {
1464
2.25k
            return f();
1465
2.25k
        } catch (const std::exception& e) {
1466
0
            LogError("%s\n", e.what());
1467
0
            return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1468
0
        }
1469
2.25k
    };
init.cpp:_ZZL21InitAndLoadChainstateRN4node11NodeContextEbbRKN6kernel10CacheSizesERK11ArgsManagerENK3$_2clIZL21InitAndLoadChainstateS1_bbS5_S8_E3$_3EESt5tupleIJNS_20ChainstateLoadStatusE13bilingual_strEEOT_
Line
Count
Source
1462
1.13k
    auto catch_exceptions = [](auto&& f) -> ChainstateLoadResult {
1463
1.13k
        try {
1464
1.13k
            return f();
1465
1.13k
        } catch (const std::exception& e) {
1466
0
            LogError("%s\n", e.what());
1467
0
            return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1468
0
        }
1469
1.13k
    };
init.cpp:_ZZL21InitAndLoadChainstateRN4node11NodeContextEbbRKN6kernel10CacheSizesERK11ArgsManagerENK3$_2clIZL21InitAndLoadChainstateS1_bbS5_S8_E3$_4EESt5tupleIJNS_20ChainstateLoadStatusE13bilingual_strEEOT_
Line
Count
Source
1462
1.12k
    auto catch_exceptions = [](auto&& f) -> ChainstateLoadResult {
1463
1.12k
        try {
1464
1.12k
            return f();
1465
1.12k
        } catch (const std::exception& e) {
1466
0
            LogError("%s\n", e.what());
1467
0
            return std::make_tuple(node::ChainstateLoadStatus::FAILURE, _("Error loading databases"));
1468
0
        }
1469
1.12k
    };
1470
1.13k
    auto [status, error] = catch_exceptions([&] { return LoadChainstate(chainman, cache_sizes, options); });
1471
1.13k
    if (status == node::ChainstateLoadStatus::SUCCESS) {
1472
1.12k
        uiInterface.InitMessage(_("Verifying blocks…"));
1473
1.12k
        if (chainman.m_blockman.m_have_pruned && options.check_blocks > MIN_BLOCKS_TO_KEEP) {
1474
0
            LogWarning("pruned datadir may not have more than %d blocks; only checking available blocks\n",
1475
0
                       MIN_BLOCKS_TO_KEEP);
1476
0
        }
1477
1.12k
        std::tie(status, error) = catch_exceptions([&] { return VerifyLoadedChainstate(chainman, options); });
1478
1.12k
        if (status == node::ChainstateLoadStatus::SUCCESS) {
1479
1.11k
            LogInfo("Block index and chainstate loaded");
1480
1.11k
            auto mining_args{node::ReadMiningArgs(args)};
1481
1.11k
            Assert(mining_args); // no error can happen, already checked in AppInitParameterInteraction
1482
            // Must be set before setChainstateLoaded(true), which unblocks MakeMining waiters that assume it is non-null.
1483
1.11k
            node.block_template_manager = std::make_unique<node::BlockTemplateManager>(*node.mempool, chainman, *node.notifications, std::move(*mining_args));
1484
1.11k
            node.notifications->setChainstateLoaded(true);
1485
1.11k
        }
1486
1.12k
    }
1487
1.13k
    return {status, error};
1488
1.13k
};
1489
1490
bool AppInitMain(NodeContext& node, interfaces::BlockAndHeaderTipInfo* tip_info)
1491
1.22k
{
1492
1.22k
    const ArgsManager& args = *Assert(node.args);
1493
1.22k
    const CChainParams& chainparams = Params();
1494
1495
1.22k
    auto opt_max_upload = ParseByteUnits(args.GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET), ByteUnit::M);
1496
1.22k
    if (!opt_max_upload) {
1497
1
        return InitError(strprintf(_("Unable to parse -maxuploadtarget: '%s'"), args.GetArg("-maxuploadtarget", "")));
1498
1
    }
1499
1500
    // ********************************************************* Step 4a: application initialization
1501
1.22k
    if (!CreatePidFile(args)) {
1502
        // Detailed error printed inside CreatePidFile().
1503
0
        return false;
1504
0
    }
1505
1.22k
    if (!init::StartLogging(args)) {
1506
        // Detailed error printed inside StartLogging().
1507
2
        return false;
1508
2
    }
1509
1510
1.21k
    LogInfo("Using at most %i automatic connections (%i file descriptors available)", num_p2p_max_connections, available_fds);
1511
1512
    // Warn about relative -datadir path.
1513
1.21k
    if (args.IsArgSet("-datadir") && !args.GetPathArg("-datadir").is_absolute()) {
1514
0
        LogWarning("Relative datadir option '%s' specified, which will be interpreted relative to the "
1515
0
                   "current working directory '%s'. This is fragile, because if bitcoin is started in the future "
1516
0
                   "from a different location, it will be unable to locate the current data files. There could "
1517
0
                   "also be data loss if bitcoin is started while in a temporary directory.",
1518
0
                   args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1519
0
    }
1520
1521
1.21k
    assert(!node.scheduler);
1522
1.21k
    node.scheduler = std::make_unique<CScheduler>();
1523
1.21k
    auto& scheduler = *node.scheduler;
1524
1525
    // Start the lightweight task scheduler thread
1526
1.21k
    scheduler.m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { scheduler.serviceQueue(); });
1527
1528
    // Gather some entropy once per minute.
1529
1.21k
    scheduler.scheduleEvery([]{
1530
107
        RandAddPeriodic();
1531
107
    }, std::chrono::minutes{1});
1532
1533
    // Check disk space every 5 minutes to avoid db corruption.
1534
1.21k
    scheduler.scheduleEvery([&args, &node]{
1535
18
        constexpr uint64_t min_disk_space{50_MiB};
1536
18
        if (!CheckDiskSpace(args.GetBlocksDirPath(), min_disk_space)) {
1537
0
            LogError("Shutting down due to lack of disk space!\n");
1538
0
            if (!(Assert(node.shutdown_request))()) {
1539
0
                LogError("Failed to send shutdown signal after disk space check\n");
1540
0
            }
1541
0
        }
1542
18
    }, std::chrono::minutes{5});
1543
1544
1.21k
    if (args.GetBoolArg("-logratelimit", BCLog::DEFAULT_LOGRATELIMIT)) {
1545
1
        LogInstance().SetRateLimiting(BCLog::LogRateLimiter::Create(
1546
1
            [&scheduler](auto func, auto window) { scheduler.scheduleEvery(std::move(func), window); },
1547
1
            BCLog::RATELIMIT_MAX_BYTES,
1548
1
            BCLog::RATELIMIT_WINDOW));
1549
1.21k
    } else {
1550
1.21k
        LogInfo("Log rate limiting disabled");
1551
1.21k
    }
1552
1553
1.21k
    assert(!node.validation_signals);
1554
1.21k
    node.validation_signals = std::make_unique<ValidationSignals>(std::make_unique<SerialTaskRunner>(scheduler));
1555
1.21k
    auto& validation_signals = *node.validation_signals;
1556
1557
    // Create KernelNotifications object. Important to do this early before
1558
    // calling ipc->listenAddress() below so makeMining and other IPC methods
1559
    // can use this.
1560
1.21k
    assert(!node.notifications);
1561
1.21k
    node.notifications = std::make_unique<KernelNotifications>(Assert(node.shutdown_request), node.exit_status, *Assert(node.warnings));
1562
1.21k
    ReadNotificationArgs(args, *node.notifications);
1563
1564
    // Create client interfaces for wallets that are supposed to be loaded
1565
    // according to -wallet and -disablewallet options. This only constructs
1566
    // the interfaces, it doesn't load wallet data. Wallets actually get loaded
1567
    // when load() and start() interface methods are called below.
1568
1.21k
    g_wallet_init_interface.Construct(node);
1569
1.21k
    uiInterface.InitWallet();
1570
1571
1.21k
    if (interfaces::Ipc* ipc = node.init->ipc()) {
1572
10
        for (std::string address : gArgs.GetArgs("-ipcbind")) {
1573
10
            try {
1574
10
                ipc->listenAddress(address);
1575
10
            } catch (const std::exception& e) {
1576
0
                return InitError(Untranslated(strprintf("Unable to bind to IPC address '%s'. %s", address, e.what())));
1577
0
            }
1578
10
            LogInfo("Listening for IPC requests on address %s", address);
1579
10
        }
1580
10
    }
1581
1582
    /* Register RPC commands regardless of -server setting so they will be
1583
     * available in the GUI RPC console even if external calls are disabled.
1584
     */
1585
1.21k
    RegisterAllCoreRPCCommands(tableRPC);
1586
1.21k
    for (const auto& client : node.chain_clients) {
1587
428
        client->registerRpcs();
1588
428
    }
1589
#ifdef ENABLE_ZMQ
1590
    RegisterZMQRPCCommands(tableRPC);
1591
#endif
1592
1593
    // Check port numbers
1594
1.21k
    if (!CheckHostPortOptions(args)) return false;
1595
1596
    // Configure reachable networks before we start the RPC server.
1597
    // This is necessary for -rpcallowip to distinguish CJDNS from other RFC4193
1598
1.20k
    const auto onlynets = args.GetArgs("-onlynet");
1599
1.20k
    if (!onlynets.empty()) {
1600
9
        g_reachable_nets.RemoveAll();
1601
9
        for (const std::string& snet : onlynets) {
1602
9
            enum Network net = ParseNetwork(snet);
1603
9
            if (net == NET_UNROUTABLE)
1604
1
                return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1605
8
            g_reachable_nets.Add(net);
1606
8
        }
1607
9
    }
1608
1609
1.20k
    if (!args.IsArgSet("-cjdnsreachable")) {
1610
1.19k
        if (!onlynets.empty() && g_reachable_nets.Contains(NET_CJDNS)) {
1611
1
            return InitError(
1612
1
                _("Outbound connections restricted to CJDNS (-onlynet=cjdns) but "
1613
1
                  "-cjdnsreachable is not provided"));
1614
1
        }
1615
1.19k
        g_reachable_nets.Remove(NET_CJDNS);
1616
1.19k
    }
1617
    // Now g_reachable_nets.Contains(NET_CJDNS) is true if:
1618
    // 1. -cjdnsreachable is given and
1619
    // 2.1. -onlynet is not given or
1620
    // 2.2. -onlynet=cjdns is given
1621
1622
    /* Start the RPC server already.  It will be started in "warmup" mode
1623
     * and not really process calls already (but it will signify connections
1624
     * that the server is there and will be ready later).  Warmup mode will
1625
     * be disabled when initialisation is finished.
1626
     */
1627
1.20k
    if (args.GetBoolArg("-server", false)) {
1628
1.20k
        uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1629
1.20k
        if (!AppInitServers(node))
1630
13
            return InitError(_("Unable to start HTTP server. See debug log for details."));
1631
1.20k
    }
1632
1633
    // ********************************************************* Step 5: verify wallet database integrity
1634
1.19k
    for (const auto& client : node.chain_clients) {
1635
428
        if (!client->verify()) {
1636
23
            return false;
1637
23
        }
1638
428
    }
1639
1640
    // ********************************************************* Step 6: network initialization
1641
    // Note that we absolutely cannot open any actual connections
1642
    // until the very end ("start node") as the UTXO/block state
1643
    // is not yet setup and may end up being set up twice if we
1644
    // need to reindex later.
1645
1646
1.16k
    fListen = args.GetBoolArg("-listen", DEFAULT_LISTEN);
1647
1.16k
    fDiscover = args.GetBoolArg("-discover", true);
1648
1649
1.16k
    PeerManager::Options peerman_opts{};
1650
1.16k
    ApplyArgsManOptions(args, peerman_opts);
1651
1652
1.16k
    {
1653
        // Read asmap file if configured or embedded asmap data and initialize
1654
        // Netgroupman with or without it
1655
1.16k
        assert(!node.netgroupman);
1656
1.16k
        if (args.IsArgSet("-asmap") && !args.IsArgNegated("-asmap")) {
1657
9
            if (!args.GetBoolArg("-asmap", false)) {
1658
7
                fs::path asmap_path = args.GetPathArg("-asmap");
1659
7
                if (!asmap_path.is_absolute()) {
1660
2
                    asmap_path = args.GetDataDirNet() / asmap_path;
1661
2
                }
1662
1663
                // If a specific path was passed with the asmap argument check if
1664
                // the file actually exists in that location
1665
7
                if (!fs::exists(asmap_path)) {
1666
1
                    InitError(strprintf(_("Could not find asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1667
1
                    return false;
1668
1
                }
1669
1670
                // If a file exists at the path, try to read the file
1671
6
                std::vector<std::byte> asmap{DecodeAsmap(asmap_path)};
1672
6
                if (asmap.empty()) {
1673
1
                    InitError(strprintf(_("Could not parse asmap file %s"), fs::quoted(fs::PathToString(asmap_path))));
1674
1
                    return false;
1675
1
                }
1676
5
                node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithLoadedAsmap(std::move(asmap)));
1677
5
            } else {
1678
2
                #ifdef ENABLE_EMBEDDED_ASMAP
1679
                    // Use the embedded asmap data
1680
2
                    std::span<const std::byte> asmap{node::data::ip_asn};
1681
2
                    if (asmap.empty() || !CheckStandardAsmap(asmap)) {
1682
0
                        InitError(strprintf(_("Could not read embedded asmap data")));
1683
0
                        return false;
1684
0
                    }
1685
2
                    node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::WithEmbeddedAsmap(asmap));
1686
2
                    LogInfo("Opened asmap data (%zu bytes) from embedded byte array\n", asmap.size());
1687
                #else
1688
                    // If there is no embedded data, fail and report it since
1689
                    // the user tried to use it
1690
                    InitError(strprintf(_("Embedded asmap data not available")));
1691
                    return false;
1692
                #endif
1693
2
            }
1694
7
            LogInfo("Using asmap version %s for IP bucketing", HexStr(node.netgroupman->GetAsmapVersion()));
1695
1.15k
        } else {
1696
1.15k
            node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::NoAsmap());
1697
1.15k
            LogInfo("Using /16 prefix for IP bucketing");
1698
1.15k
        }
1699
1700
        // Initialize addrman
1701
1.16k
        assert(!node.addrman);
1702
1.16k
        uiInterface.InitMessage(_("Loading P2P addresses…"));
1703
1.16k
        auto addrman{LoadAddrman(*node.netgroupman, args)};
1704
1.16k
        if (!addrman) return InitError(util::ErrorString(addrman));
1705
1.15k
        node.addrman = std::move(*addrman);
1706
1.15k
    }
1707
1708
0
    FastRandomContext rng;
1709
1.15k
    assert(!node.banman);
1710
1.15k
    node.banman = std::make_unique<BanMan>(args.GetDataDirNet() / "banlist", &uiInterface, args.GetIntArg("-bantime", DEFAULT_MISBEHAVING_BANTIME));
1711
1.15k
    assert(!node.connman);
1712
1.15k
    node.connman = std::make_unique<CConnman>(rng.rand64(),
1713
1.15k
                                              rng.rand64(),
1714
1.15k
                                              *node.addrman, *node.netgroupman, chainparams, args.GetBoolArg("-networkactive", true));
1715
1716
1.15k
    for (const std::string& socket_addr : args.GetArgs("-bind")) {
1717
1.14k
        std::string host_out;
1718
1.14k
        uint16_t port_out{0};
1719
1.14k
        std::string bind_socket_addr = socket_addr.substr(0, socket_addr.rfind('='));
1720
1.14k
        if (!SplitHostPort(bind_socket_addr, port_out, host_out)) {
1721
0
            return InitError(InvalidPortErrMsg("-bind", socket_addr));
1722
0
        }
1723
1.14k
    }
1724
1725
    // sanitize comments per BIP-0014, format user agent and check total size
1726
1.15k
    std::vector<std::string> uacomments;
1727
1.17k
    for (const std::string& cmt : args.GetArgs("-uacomment")) {
1728
1.17k
        if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1729
6
            return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1730
1.16k
        uacomments.push_back(cmt);
1731
1.16k
    }
1732
1.15k
    strSubVersion = FormatSubVersion(UA_NAME, CLIENT_VERSION, uacomments);
1733
1.15k
    if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1734
1
        return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1735
1
            strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1736
1
    }
1737
1738
    // Requesting DNS seeds entails connecting to IPv4/IPv6, which -onlynet options may prohibit:
1739
    // If -dnsseed=1 is explicitly specified, abort. If it's left unspecified by the user, we skip
1740
    // the DNS seeds by adjusting -dnsseed in InitParameterInteraction.
1741
1.15k
    if (args.GetBoolArg("-dnsseed") == true && !g_reachable_nets.Contains(NET_IPV4) && !g_reachable_nets.Contains(NET_IPV6)) {
1742
1
        return InitError(strprintf(_("Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")));
1743
1.14k
    };
1744
1745
    // Check for host lookup allowed before parsing any network related parameters
1746
1.14k
    fNameLookup = args.GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1747
1748
1.14k
    bool proxyRandomize = args.GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1749
    // -proxy sets a proxy for outgoing network traffic, possibly per network.
1750
    // -noproxy, -proxy=0 or -proxy="" can be used to remove the proxy setting, this is the default
1751
1.14k
    Proxy ipv4_proxy;
1752
1.14k
    Proxy ipv6_proxy;
1753
1.14k
    Proxy onion_proxy;
1754
1.14k
    Proxy name_proxy;
1755
1.14k
    Proxy cjdns_proxy;
1756
1.14k
    for (const std::string& param_value : args.GetArgs("-proxy")) {
1757
51
        const auto eq_pos{param_value.rfind('=')};
1758
51
        const std::string proxy_str{param_value.substr(0, eq_pos)}; // e.g. 127.0.0.1:9050=ipv4 -> 127.0.0.1:9050
1759
51
        std::string net_str;
1760
51
        if (eq_pos != std::string::npos) {
1761
7
            if (eq_pos + 1 == param_value.length()) {
1762
1
                return InitError(strprintf(_("Invalid -proxy address or hostname, ends with '=': '%s'"), param_value));
1763
1
            }
1764
6
            net_str = ToLower(param_value.substr(eq_pos + 1)); // e.g. 127.0.0.1:9050=ipv4 -> ipv4
1765
6
        }
1766
1767
50
        Proxy proxy;
1768
50
        if (!proxy_str.empty() && proxy_str != "0") {
1769
49
            if (IsUnixSocketPath(proxy_str)) {
1770
1
                proxy = Proxy{proxy_str, /*tor_stream_isolation=*/proxyRandomize};
1771
48
            } else {
1772
48
                const std::optional<CService> addr{Lookup(proxy_str, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1773
48
                if (!addr.has_value()) {
1774
2
                    return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1775
2
                }
1776
46
                proxy = Proxy{addr.value(), /*tor_stream_isolation=*/proxyRandomize};
1777
46
            }
1778
47
            if (!proxy.IsValid()) {
1779
0
                return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxy_str));
1780
0
            }
1781
47
        }
1782
1783
48
        if (net_str.empty()) { // For all networks.
1784
42
            ipv4_proxy = ipv6_proxy = name_proxy = cjdns_proxy = onion_proxy = proxy;
1785
42
        } else if (net_str == "ipv4") {
1786
1
            ipv4_proxy = name_proxy = proxy;
1787
5
        } else if (net_str == "ipv6") {
1788
2
            ipv6_proxy = name_proxy = proxy;
1789
3
        } else if (net_str == "onion") {
1790
1
            onion_proxy = proxy;
1791
2
        } else if (net_str == "cjdns") {
1792
1
            cjdns_proxy = proxy;
1793
1
        } else {
1794
1
            return InitError(strprintf(_("Unrecognized network in -proxy='%s': '%s'"), param_value, net_str));
1795
1
        }
1796
48
    }
1797
1.14k
    if (ipv4_proxy.IsValid()) {
1798
43
        SetProxy(NET_IPV4, ipv4_proxy);
1799
43
    }
1800
1.14k
    if (ipv6_proxy.IsValid()) {
1801
44
        SetProxy(NET_IPV6, ipv6_proxy);
1802
44
    }
1803
1.14k
    if (name_proxy.IsValid()) {
1804
44
        SetNameProxy(name_proxy);
1805
44
    }
1806
1.14k
    if (cjdns_proxy.IsValid()) {
1807
41
        SetProxy(NET_CJDNS, cjdns_proxy);
1808
41
    }
1809
1810
1.14k
    const bool onlynet_used_with_onion{!onlynets.empty() && g_reachable_nets.Contains(NET_ONION)};
1811
1812
    // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1813
    // -noonion (or -onion=0) disables connecting to .onion entirely
1814
    // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1815
1.14k
    std::string onionArg = args.GetArg("-onion", "");
1816
1.14k
    if (onionArg != "") {
1817
13
        if (onionArg == "0") { // Handle -noonion/-onion=0
1818
3
            onion_proxy = Proxy{};
1819
3
            if (onlynet_used_with_onion) {
1820
2
                return InitError(
1821
2
                    _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1822
2
                      "reaching the Tor network is explicitly forbidden: -onion=0"));
1823
2
            }
1824
10
        } else {
1825
10
            if (IsUnixSocketPath(onionArg)) {
1826
1
                onion_proxy = Proxy(onionArg, /*tor_stream_isolation=*/proxyRandomize);
1827
9
            } else {
1828
9
                const std::optional<CService> addr{Lookup(onionArg, DEFAULT_TOR_SOCKS_PORT, fNameLookup)};
1829
9
                if (!addr.has_value() || !addr->IsValid()) {
1830
1
                    return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1831
1
                }
1832
1833
8
                onion_proxy = Proxy(addr.value(), /*tor_stream_isolation=*/proxyRandomize);
1834
8
            }
1835
10
        }
1836
13
    }
1837
1838
1.14k
    const bool listenonion{args.GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION)};
1839
1.14k
    if (onion_proxy.IsValid()) {
1840
47
        SetProxy(NET_ONION, onion_proxy);
1841
1.09k
    } else {
1842
        // If -listenonion is set, then we will (try to) connect to the Tor control port
1843
        // later from the torcontrol thread and may retrieve the onion proxy from there.
1844
1.09k
        if (onlynet_used_with_onion && !listenonion) {
1845
1
            return InitError(
1846
1
                _("Outbound connections restricted to Tor (-onlynet=onion) but the proxy for "
1847
1
                  "reaching the Tor network is not provided: none of -proxy, -onion or "
1848
1
                  "-listenonion is given"));
1849
1
        }
1850
1.09k
        g_reachable_nets.Remove(NET_ONION);
1851
1.09k
    }
1852
1853
1.14k
    for (const std::string& strAddr : args.GetArgs("-externalip")) {
1854
13
        const std::optional<CService> addrLocal{Lookup(strAddr, GetListenPort(), fNameLookup)};
1855
13
        if (addrLocal.has_value() && addrLocal->IsValid())
1856
13
            AddLocal(addrLocal.value(), LOCAL_MANUAL, /*add_even_if_unreachable=*/true);
1857
0
        else
1858
0
            return InitError(ResolveErrMsg("externalip", strAddr));
1859
13
    }
1860
1861
#ifdef ENABLE_ZMQ
1862
    g_zmq_notification_interface = CZMQNotificationInterface::Create(
1863
        [&chainman = node.chainman](std::vector<std::byte>& block, const CBlockIndex& index) {
1864
            assert(chainman);
1865
            if (auto ret{chainman->m_blockman.ReadRawBlock(WITH_LOCK(cs_main, return index.GetBlockPos()))}) {
1866
                block = std::move(*ret);
1867
                return true;
1868
            }
1869
            return false;
1870
        });
1871
1872
    if (g_zmq_notification_interface) {
1873
        validation_signals.RegisterValidationInterface(g_zmq_notification_interface.get());
1874
    }
1875
#endif
1876
1877
    // ********************************************************* Step 7: load block chain
1878
1879
    // cache size calculations
1880
1.14k
    node::LogOversizedDbCache(args);
1881
1.14k
    const auto [index_cache_sizes, kernel_cache_sizes] = CalculateCacheSizes(args, g_enabled_filter_types.size());
1882
1883
1.14k
    LogInfo("Cache configuration:");
1884
1.14k
    LogInfo("* Using %.1f MiB for block index database", kernel_cache_sizes.block_tree_db / double(1_MiB));
1885
1.14k
    if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1886
49
        LogInfo("* Using %.1f MiB for transaction index database", index_cache_sizes.tx_index / double(1_MiB));
1887
49
    }
1888
1.14k
    if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
1889
34
        LogInfo("* Using %.1f MiB for transaction output spender index database", index_cache_sizes.txospender_index / double(1_MiB));
1890
34
    }
1891
1.14k
    for (BlockFilterType filter_type : g_enabled_filter_types) {
1892
50
        LogInfo("* Using %.1f MiB for %s block filter index database",
1893
50
                  index_cache_sizes.filter_index / double(1_MiB), BlockFilterTypeName(filter_type));
1894
50
    }
1895
1.14k
    LogInfo("* Using %.1f MiB for chain state database", kernel_cache_sizes.coins_db / double(1_MiB));
1896
1897
1.14k
    assert(!node.mempool);
1898
1.14k
    assert(!node.chainman);
1899
1.14k
    assert(!node.block_template_manager);
1900
1901
1.14k
    bool do_reindex{args.GetBoolArg("-reindex", false)};
1902
1.14k
    const bool do_reindex_chainstate{args.GetBoolArg("-reindex-chainstate", false)};
1903
1904
    // Chainstate initialization and loading may be retried once with reindexing by GUI users
1905
1.14k
    auto [status, error] = InitAndLoadChainstate(
1906
1.14k
        node,
1907
1.14k
        do_reindex,
1908
1.14k
        do_reindex_chainstate,
1909
1.14k
        kernel_cache_sizes,
1910
1.14k
        args);
1911
1.14k
    if (status == ChainstateLoadStatus::FAILURE && !do_reindex && !ShutdownRequested(node)) {
1912
        // suggest a reindex
1913
12
        bool do_retry{HasTestOption(args, "reindex_after_failure_noninteractive_yes") ||
1914
12
            uiInterface.ThreadSafeQuestion(
1915
11
            error + Untranslated(".\n\n") + _("Do you want to rebuild the databases now?"),
1916
11
            error.original + (args.GetIntArg("-prune", 0) ? ".\nPlease restart with -reindex to recover." : ".\nPlease restart with -reindex or -reindex-chainstate to recover."),
1917
11
            CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT)};
1918
12
        if (!do_retry) {
1919
11
            return false;
1920
11
        }
1921
1
        do_reindex = true;
1922
1
        if (!Assert(node.shutdown_signal)->reset()) {
1923
0
            LogError("Internal error: failed to reset shutdown signal.\n");
1924
0
        }
1925
1
        std::tie(status, error) = InitAndLoadChainstate(
1926
1
            node,
1927
1
            do_reindex,
1928
1
            do_reindex_chainstate,
1929
1
            kernel_cache_sizes,
1930
1
            args);
1931
1
    }
1932
1.13k
    if (status != ChainstateLoadStatus::SUCCESS && status != ChainstateLoadStatus::INTERRUPTED) {
1933
3
        return InitError(error);
1934
3
    }
1935
1936
    // As LoadBlockIndex can take several minutes, it's possible the user
1937
    // requested to kill the GUI during the last operation. If so, exit.
1938
1.12k
    if (ShutdownRequested(node)) {
1939
11
        LogInfo("Shutdown requested. Exiting.");
1940
11
        return true;
1941
11
    }
1942
1943
1.11k
    ChainstateManager& chainman = *Assert(node.chainman);
1944
1945
1.11k
    assert(!node.fee_estimator_man);
1946
    // Don't initialize fee estimation with old data if we don't relay transactions,
1947
    // as they would never get updated.
1948
1.11k
    if (!peerman_opts.ignore_incoming_txs) {
1949
1.10k
        bool read_stale_estimates = args.GetBoolArg("-acceptstalefeeestimates", DEFAULT_ACCEPT_STALE_FEE_ESTIMATES);
1950
1.10k
        if (read_stale_estimates && (chainparams.GetChainType() != ChainType::REGTEST)) {
1951
4
            return InitError(strprintf(_("acceptstalefeeestimates is not supported on %s chain."), chainparams.GetChainTypeString()));
1952
4
        }
1953
1.10k
        MaybeMigrateLegacyFeeEstimates(args);
1954
1.10k
        node.fee_estimator_man = std::make_unique<FeeRateEstimatorManager>(BlockPolicyFeeEstPath(args), read_stale_estimates, MempoolPolicyEstimatorPath(args), *Assert(node.mempool), chainman);
1955
1956
        // Flush estimates to disk periodically
1957
1.10k
        FeeRateEstimatorManager* fee_estimator_man = node.fee_estimator_man.get();
1958
1.10k
        scheduler.scheduleEvery([fee_estimator_man] { fee_estimator_man->IntervalFlush(); }, FEE_FLUSH_INTERVAL);
1959
1.10k
        validation_signals.RegisterValidationInterface(fee_estimator_man);
1960
1.10k
    }
1961
1962
1.11k
    auto& kernel_notifications{*Assert(node.notifications)};
1963
1964
1.11k
    assert(!node.peerman);
1965
1.11k
    node.peerman = PeerManager::make(*node.connman, *node.addrman,
1966
1.11k
                                     node.banman.get(), chainman,
1967
1.11k
                                     *node.mempool, *node.warnings,
1968
1.11k
                                     peerman_opts);
1969
1.11k
    validation_signals.RegisterValidationInterface(node.peerman.get());
1970
1971
    // ********************************************************* Step 8: start indexers
1972
1973
1.11k
    if (args.GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1974
39
        g_txindex = std::make_unique<TxIndex>(interfaces::MakeChain(node), index_cache_sizes.tx_index, false, do_reindex);
1975
39
        node.indexes.emplace_back(g_txindex.get());
1976
39
    }
1977
1978
1.11k
    if (args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX)) {
1979
24
        g_txospenderindex = std::make_unique<TxoSpenderIndex>(interfaces::MakeChain(node), index_cache_sizes.txospender_index, false, do_reindex);
1980
24
        node.indexes.emplace_back(g_txospenderindex.get());
1981
24
    }
1982
1983
1.11k
    for (const auto& filter_type : g_enabled_filter_types) {
1984
40
        InitBlockFilterIndex([&]{ return interfaces::MakeChain(node); }, filter_type, index_cache_sizes.filter_index, false, do_reindex);
1985
40
        node.indexes.emplace_back(GetBlockFilterIndex(filter_type));
1986
40
    }
1987
1988
1.11k
    if (args.GetBoolArg("-coinstatsindex", DEFAULT_COINSTATSINDEX)) {
1989
41
        g_coin_stats_index = std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /*cache_size=*/0, false, do_reindex);
1990
41
        node.indexes.emplace_back(g_coin_stats_index.get());
1991
41
    }
1992
1993
    // Init indexes
1994
1.11k
    for (auto index : node.indexes) if (!index->Init()) return false;
1995
1996
    // ********************************************************* Step 9: load wallet
1997
1.11k
    for (const auto& client : node.chain_clients) {
1998
377
        if (!client->load()) {
1999
0
            return false;
2000
0
        }
2001
377
    }
2002
2003
    // ********************************************************* Step 10: data directory maintenance
2004
2005
    // if pruning, perform the initial blockstore prune
2006
    // after any wallet rescanning has taken place.
2007
1.11k
    if (chainman.m_blockman.IsPruneMode()) {
2008
41
        if (chainman.m_blockman.m_blockfiles_indexed) {
2009
39
            LOCK(cs_main);
2010
39
            for (const auto& chainstate : chainman.m_chainstates) {
2011
39
                uiInterface.InitMessage(_("Pruning blockstore…"));
2012
39
                chainstate->PruneAndFlush();
2013
39
            }
2014
39
        }
2015
1.07k
    } else {
2016
        // Prior to setting NODE_NETWORK, check if we can provide historical blocks.
2017
1.07k
        if (!WITH_LOCK(chainman.GetMutex(), return chainman.HistoricalChainstate())) {
2018
1.06k
            LogInfo("Setting NODE_NETWORK in non-prune mode");
2019
1.06k
            g_local_services = ServiceFlags(g_local_services | NODE_NETWORK);
2020
1.06k
        } else {
2021
8
            LogInfo("Running node in NODE_NETWORK_LIMITED mode until snapshot background sync completes");
2022
8
        }
2023
1.07k
    }
2024
2025
    // ********************************************************* Step 11: import blocks
2026
2027
1.11k
    if (!CheckDiskSpace(args.GetDataDirNet())) {
2028
0
        InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetDataDirNet()))));
2029
0
        return false;
2030
0
    }
2031
1.11k
    if (!CheckDiskSpace(args.GetBlocksDirPath())) {
2032
0
        InitError(strprintf(_("Error: Disk space is low for %s"), fs::quoted(fs::PathToString(args.GetBlocksDirPath()))));
2033
0
        return false;
2034
0
    }
2035
2036
1.11k
    int chain_active_height = WITH_LOCK(cs_main, return chainman.ActiveChain().Height());
2037
2038
    // On first startup, warn on low block storage space
2039
1.11k
    if (!do_reindex && !do_reindex_chainstate && chain_active_height <= 1) {
2040
443
        uint64_t assumed_chain_bytes{chainparams.AssumedBlockchainSize() * 1_GiB};
2041
443
        uint64_t additional_bytes_needed{
2042
443
            chainman.m_blockman.IsPruneMode() ?
2043
23
                std::min(chainman.m_blockman.GetPruneTarget(), assumed_chain_bytes) :
2044
443
                assumed_chain_bytes};
2045
2046
443
        if (!CheckDiskSpace(args.GetBlocksDirPath(), additional_bytes_needed)) {
2047
1
            InitWarning(strprintf(_(
2048
1
                    "Disk space for %s may not accommodate the block files. " \
2049
1
                    "Approximately %u GiB of data will be stored in this directory."
2050
1
                ),
2051
1
                fs::quoted(fs::PathToString(args.GetBlocksDirPath())),
2052
1
                CeilDiv(additional_bytes_needed, 1_GiB)
2053
1
            ));
2054
1
        }
2055
443
    }
2056
2057
#ifdef __APPLE__
2058
    auto check_and_warn_fs{[&](const fs::path& path, std::string_view desc) {
2059
        const auto path_desc{strprintf("%s (\"%s\")", desc, fs::PathToString(path))};
2060
        switch (GetFilesystemType(path)) {
2061
        case FSType::EXFAT:
2062
            InitWarning(strprintf(_("The %s path uses exFAT, which is known to have intermittent corruption problems on macOS. "
2063
                "Move this directory to a different filesystem to avoid data loss."), path_desc));
2064
            break;
2065
        case FSType::ERROR:
2066
            LogInfo("Failed to detect filesystem type for %s", path_desc);
2067
            break;
2068
        case FSType::OTHER:
2069
            break;
2070
        }
2071
    }};
2072
2073
    check_and_warn_fs(args.GetDataDirNet(), "data directory");
2074
    check_and_warn_fs(args.GetBlocksDirPath(), "blocks directory");
2075
#endif
2076
2077
1.11k
#if HAVE_SYSTEM
2078
1.11k
    const std::string block_notify = args.GetArg("-blocknotify", "");
2079
1.11k
    if (!block_notify.empty()) {
2080
113
        uiInterface.NotifyBlockTip.connect([block_notify](SynchronizationState sync_state, const CBlockIndex& block, double /* verification_progress */) {
2081
113
            if (sync_state != SynchronizationState::POST_INIT) return;
2082
112
            std::string command = block_notify;
2083
112
            ReplaceAll(command, "%s", block.GetBlockHash().GetHex());
2084
112
            std::thread t(runCommand, command);
2085
112
            t.detach(); // thread runs free
2086
112
        });
2087
1
    }
2088
1.11k
#endif
2089
2090
1.11k
    std::vector<fs::path> vImportFiles;
2091
1.11k
    for (const std::string& strFile : args.GetArgs("-loadblock")) {
2092
1
        vImportFiles.push_back(fs::PathFromString(strFile));
2093
1
    }
2094
2095
    /// \anchor initload
2096
1.11k
    node.background_init_thread = std::thread(&util::TraceThread, "initload", [=, &chainman, &args, &kernel_notifications, &node] {
2097
1.10k
        ScheduleBatchPriority();
2098
        // Import blocks and ActivateBestChain()
2099
1.10k
        ImportBlocks(chainman, vImportFiles);
2100
        // An interrupted import may return without activating genesis. Wake
2101
        // the init thread's genesis wait, which is otherwise only notified
2102
        // on blockTip, and that never fires when the import was interrupted
2103
        // before activating genesis. This wakeup lets the wait observe the
2104
        // shutdown request.
2105
1.10k
        WITH_LOCK(kernel_notifications.m_tip_block_mutex, kernel_notifications.m_tip_block_cv.notify_all());
2106
1.10k
        WITH_LOCK(::cs_main, chainman.UpdateIBDStatus());
2107
1.10k
        if (args.GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
2108
0
            LogInfo("Stopping after block import");
2109
0
            if (!(Assert(node.shutdown_request))()) {
2110
0
                LogError("Failed to send shutdown signal after finishing block import\n");
2111
0
            }
2112
0
            return;
2113
0
        }
2114
2115
        // Start indexes initial sync
2116
1.10k
        if (!StartIndexBackgroundSync(node)) {
2117
0
            bilingual_str err_str = _("Failed to start indexes, shutting down…");
2118
0
            chainman.GetNotifications().fatalError(err_str);
2119
0
            return;
2120
0
        }
2121
        // Load mempool from disk
2122
1.10k
        if (auto* pool{chainman.ActiveChainstate().GetMempool()}) {
2123
1.10k
            const bool loaded{LoadMempool(*pool, ShouldPersistMempool(args) ? MempoolPath(args) : fs::path{}, chainman.ActiveChainstate(), {})};
2124
            // A shutdown request sets m_interrupt and aborts the mempool load, which is not a
2125
            // load failure, so only notify the fee estimator when the load actually failed.
2126
1.10k
            if (node.fee_estimator_man && !chainman.m_interrupt && !loaded) {
2127
600
                node.fee_estimator_man->MempoolLoadFailed();
2128
600
            }
2129
1.10k
            pool->SetLoadTried(!chainman.m_interrupt);
2130
1.10k
        }
2131
1.10k
    });
2132
2133
    /*
2134
     * Wait for genesis block to be processed. Typically kernel_notifications.m_tip_block
2135
     * has already been set by a call to LoadChainTip() in CompleteChainstateInitialization().
2136
     * But this is skipped if the chainstate doesn't exist yet or is being wiped:
2137
     *
2138
     * 1. first startup with an empty datadir
2139
     * 2. reindex
2140
     * 3. reindex-chainstate
2141
     *
2142
     * In these case it's connected by a call to ActivateBestChain() in the initload thread.
2143
     */
2144
1.11k
    {
2145
1.11k
        WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
2146
1.43k
        kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
2147
1.43k
            return kernel_notifications.TipBlock() || ShutdownRequested(node);
2148
1.43k
        });
2149
1.11k
    }
2150
2151
1.11k
    if (ShutdownRequested(node)) {
2152
1
        return true;
2153
1
    }
2154
2155
    // ********************************************************* Step 12: start node
2156
2157
1.11k
    int64_t best_block_time{};
2158
1.11k
    {
2159
1.11k
        LOCK(chainman.GetMutex());
2160
1.11k
        const auto& tip{*Assert(chainman.ActiveTip())};
2161
1.11k
        LogInfo("block tree size = %u", chainman.BlockIndex().size());
2162
1.11k
        chain_active_height = tip.nHeight;
2163
1.11k
        best_block_time = tip.GetBlockTime();
2164
1.11k
        if (tip_info) {
2165
0
            tip_info->block_height = chain_active_height;
2166
0
            tip_info->block_time = best_block_time;
2167
0
            tip_info->verification_progress = chainman.GuessVerificationProgress(&tip);
2168
0
        }
2169
1.11k
        if (tip_info && chainman.m_best_header) {
2170
0
            tip_info->header_height = chainman.m_best_header->nHeight;
2171
0
            tip_info->header_time = chainman.m_best_header->GetBlockTime();
2172
0
        }
2173
1.11k
    }
2174
1.11k
    LogInfo("nBestHeight = %d", chain_active_height);
2175
1.11k
    if (node.peerman) node.peerman->SetBestBlock(chain_active_height, std::chrono::seconds{best_block_time});
2176
2177
    // Map ports with NAT-PMP
2178
1.11k
    StartMapPort(args.GetBoolArg("-natpmp", DEFAULT_NATPMP));
2179
2180
1.11k
    CConnman::Options connOptions;
2181
1.11k
    connOptions.m_local_services = g_local_services;
2182
1.11k
    connOptions.m_max_automatic_connections = num_p2p_max_connections;
2183
1.11k
    connOptions.m_full_relay_inbound_percent = std::clamp<int>(args.GetIntArg("-inboundrelaypercent", DEFAULT_FULL_RELAY_INBOUND_PCT), 0, 100);
2184
1.11k
    connOptions.uiInterface = &uiInterface;
2185
1.11k
    connOptions.m_banman = node.banman.get();
2186
1.11k
    connOptions.m_msgproc = node.peerman.get();
2187
1.11k
    connOptions.nSendBufferMaxSize = 1000 * args.GetIntArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
2188
1.11k
    connOptions.nReceiveFloodSize = 1000 * args.GetIntArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
2189
1.11k
    for (const std::string& added_node : args.GetArgs("-addnode")) {
2190
        // Such a value is not a valid connection target, but would otherwise be
2191
        // treated as one and retried indefinitely.
2192
6
        if (TrimStringView(added_node).empty()) {
2193
3
            LogWarning("Ignoring empty -addnode value");
2194
3
            continue;
2195
3
        }
2196
3
        connOptions.m_added_nodes.push_back(added_node);
2197
3
    }
2198
1.11k
    connOptions.nMaxOutboundLimit = *opt_max_upload;
2199
1.11k
    connOptions.m_peer_connect_timeout = peer_connect_timeout;
2200
1.11k
    connOptions.whitelist_forcerelay = args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY);
2201
1.11k
    connOptions.whitelist_relay = args.GetBoolArg("-whitelistrelay", DEFAULT_WHITELISTRELAY);
2202
1.11k
    connOptions.m_capture_messages = args.GetBoolArg("-capturemessages", false);
2203
2204
    // Port to bind to if `-bind=addr` is provided without a `:port` suffix.
2205
1.11k
    const uint16_t default_bind_port =
2206
1.11k
        static_cast<uint16_t>(args.GetIntArg("-port", Params().GetDefaultPort()));
2207
2208
1.11k
    const uint16_t default_bind_port_onion = default_bind_port + 1;
2209
2210
1.11k
    const auto BadPortWarning = [](const char* prefix, uint16_t port) {
2211
0
        return strprintf(_("%s request to listen on port %u. This port is considered \"bad\" and "
2212
0
                           "thus it is unlikely that any peer will connect to it. See "
2213
0
                           "doc/p2p-bad-ports.md for details and a full list."),
2214
0
                         prefix,
2215
0
                         port);
2216
0
    };
2217
2218
1.11k
    for (const std::string& bind_arg : args.GetArgs("-bind")) {
2219
1.09k
        std::optional<CService> bind_addr;
2220
1.09k
        const size_t index = bind_arg.rfind('=');
2221
1.09k
        if (index == std::string::npos) {
2222
1.07k
            bind_addr = Lookup(bind_arg, default_bind_port, /*fAllowLookup=*/false);
2223
1.07k
            if (bind_addr.has_value()) {
2224
1.07k
                connOptions.vBinds.push_back(bind_addr.value());
2225
1.07k
                if (IsBadPort(bind_addr.value().GetPort())) {
2226
0
                    InitWarning(BadPortWarning("-bind", bind_addr.value().GetPort()));
2227
0
                }
2228
1.07k
                continue;
2229
1.07k
            }
2230
1.07k
        } else {
2231
22
            const std::string network_type = bind_arg.substr(index + 1);
2232
22
            if (network_type == "onion") {
2233
22
                const std::string truncated_bind_arg = bind_arg.substr(0, index);
2234
22
                bind_addr = Lookup(truncated_bind_arg, default_bind_port_onion, false);
2235
22
                if (bind_addr.has_value()) {
2236
22
                    connOptions.onion_binds.push_back(bind_addr.value());
2237
22
                    continue;
2238
22
                }
2239
22
            }
2240
22
        }
2241
0
        return InitError(ResolveErrMsg("bind", bind_arg));
2242
1.09k
    }
2243
2244
1.11k
    for (const std::string& strBind : args.GetArgs("-whitebind")) {
2245
9
        NetWhitebindPermissions whitebind;
2246
9
        bilingual_str error;
2247
9
        if (!NetWhitebindPermissions::TryParse(strBind, whitebind, error)) return InitError(error);
2248
8
        connOptions.vWhiteBinds.push_back(whitebind);
2249
8
    }
2250
2251
    // If the user did not specify -bind= or -whitebind= then we bind
2252
    // on any address - 0.0.0.0 (IPv4) and :: (IPv6).
2253
1.11k
    connOptions.bind_on_any = args.GetArgs("-bind").empty() && args.GetArgs("-whitebind").empty();
2254
2255
    // Emit a warning if a bad port is given to -port= but only if -bind and -whitebind are not
2256
    // given, because if they are, then -port= is ignored.
2257
1.11k
    if (connOptions.bind_on_any && args.IsArgSet("-port")) {
2258
22
        const uint16_t port_arg = args.GetIntArg("-port", 0);
2259
22
        if (IsBadPort(port_arg)) {
2260
0
            InitWarning(BadPortWarning("-port", port_arg));
2261
0
        }
2262
22
    }
2263
2264
1.11k
    CService onion_service_target;
2265
1.11k
    if (!connOptions.onion_binds.empty()) {
2266
20
        onion_service_target = connOptions.onion_binds.front();
2267
1.09k
    } else if (!connOptions.vBinds.empty()) {
2268
1.05k
        onion_service_target = connOptions.vBinds.front();
2269
1.05k
    } else {
2270
31
        onion_service_target = DefaultOnionServiceTarget(default_bind_port_onion);
2271
31
        connOptions.onion_binds.push_back(onion_service_target);
2272
31
    }
2273
2274
1.11k
    if (listenonion) {
2275
9
        if (connOptions.onion_binds.size() > 1) {
2276
0
            InitWarning(strprintf(_("More than one onion bind address is provided. Using %s "
2277
0
                                    "for the automatically created Tor onion service."),
2278
0
                                  onion_service_target.ToStringAddrPort()));
2279
0
        }
2280
9
        node.tor_controller = std::make_unique<TorController>(gArgs.GetArg("-torcontrol", DEFAULT_TOR_CONTROL), onion_service_target);
2281
9
    }
2282
2283
1.11k
    bool should_discover = connOptions.bind_on_any;
2284
1.11k
    if (!should_discover) {
2285
1.08k
        for (const auto& bind : connOptions.vBinds) {
2286
1.07k
            if (bind.IsBindAny()) {
2287
13
                should_discover = true;
2288
13
                break;
2289
13
            }
2290
1.07k
        }
2291
1.08k
    }
2292
2293
1.11k
    if (!should_discover) {
2294
1.06k
        for (const auto& whitebind : connOptions.vWhiteBinds) {
2295
6
            if (whitebind.m_service.IsBindAny()) {
2296
1
                should_discover = true;
2297
1
                break;
2298
1
            }
2299
6
        }
2300
1.06k
    }
2301
2302
1.11k
    if (should_discover) {
2303
        // Only add all IP addresses of the machine if we would be listening on
2304
        // any address - 0.0.0.0 (IPv4) and :: (IPv6).
2305
37
        Discover();
2306
37
    }
2307
2308
1.11k
    for (const auto& net : args.GetArgs("-whitelist")) {
2309
164
        NetWhitelistPermissions subnet;
2310
164
        ConnectionDirection connection_direction;
2311
164
        bilingual_str error;
2312
164
        if (!NetWhitelistPermissions::TryParse(net, subnet, connection_direction, error)) return InitError(error);
2313
161
        if (connection_direction & ConnectionDirection::In) {
2314
160
            connOptions.vWhitelistedRangeIncoming.push_back(subnet);
2315
160
        }
2316
161
        if (connection_direction & ConnectionDirection::Out) {
2317
128
            connOptions.vWhitelistedRangeOutgoing.push_back(subnet);
2318
128
        }
2319
161
    }
2320
2321
1.10k
    connOptions.vSeedNodes = args.GetArgs("-seednode");
2322
2323
1.10k
    const auto connect = args.GetArgs("-connect");
2324
1.10k
    if (!connect.empty() || args.IsArgNegated("-connect")) {
2325
        // Do not initiate other outgoing connections when connecting to trusted
2326
        // nodes, or when -noconnect is specified.
2327
1.06k
        connOptions.m_use_addrman_outgoing = false;
2328
2329
1.06k
        if (connect.size() != 1 || connect[0] != "0") {
2330
9
            connOptions.m_specified_outgoing = connect;
2331
9
        }
2332
1.06k
        if (!connOptions.m_specified_outgoing.empty() && !connOptions.vSeedNodes.empty()) {
2333
1
            LogInfo("-seednode is ignored when -connect is used");
2334
1
        }
2335
2336
1.06k
        if (args.IsArgSet("-dnsseed") && args.GetBoolArg("-dnsseed", DEFAULT_DNSSEED) && args.IsArgSet("-proxy")) {
2337
12
            LogInfo("-dnsseed is ignored when -connect is used and -proxy is specified");
2338
12
        }
2339
1.06k
    }
2340
2341
1.10k
    const std::string& i2psam_arg = args.GetArg("-i2psam", "");
2342
1.10k
    if (!i2psam_arg.empty()) {
2343
8
        const std::optional<CService> addr{Lookup(i2psam_arg, 7656, fNameLookup)};
2344
8
        if (!addr.has_value() || !addr->IsValid()) {
2345
1
            return InitError(strprintf(_("Invalid -i2psam address or hostname: '%s'"), i2psam_arg));
2346
1
        }
2347
7
        SetProxy(NET_I2P, Proxy{addr.value()});
2348
1.09k
    } else {
2349
1.09k
        if (!onlynets.empty() && g_reachable_nets.Contains(NET_I2P)) {
2350
1
            return InitError(
2351
1
                _("Outbound connections restricted to i2p (-onlynet=i2p) but "
2352
1
                  "-i2psam is not provided"));
2353
1
        }
2354
1.09k
        g_reachable_nets.Remove(NET_I2P);
2355
1.09k
    }
2356
2357
1.10k
    connOptions.m_i2p_accept_incoming = args.GetBoolArg("-i2pacceptincoming", DEFAULT_I2P_ACCEPT_INCOMING);
2358
2359
1.10k
    if (auto conflict = CheckBindingConflicts(connOptions)) {
2360
6
        return InitError(strprintf(
2361
6
            _("Duplicate binding configuration for address %s. "
2362
6
                "Please check your -bind, -bind=...=onion and -whitebind settings."),
2363
6
                    conflict->ToStringAddrPort()));
2364
6
    }
2365
2366
1.09k
    if (args.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)) {
2367
        // If -listenonion is set, then NET_ONION may not be reachable now
2368
        // but may become reachable later, thus only error here if it is not
2369
        // reachable and will not become reachable for sure.
2370
9
        const bool onion_may_become_reachable{listenonion && (!args.IsArgSet("-onlynet") || onlynet_used_with_onion)};
2371
9
        if (!g_reachable_nets.Contains(NET_I2P) &&
2372
9
            !g_reachable_nets.Contains(NET_ONION) &&
2373
9
            !onion_may_become_reachable) {
2374
1
            return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2375
1
                               "but none of Tor or I2P networks is reachable"));
2376
1
        }
2377
8
        if (!connOptions.m_use_addrman_outgoing) {
2378
1
            return InitError(_("Private broadcast of own transactions requested (-privatebroadcast), "
2379
1
                               "but -connect is also configured. They are incompatible because the "
2380
1
                               "private broadcast needs to open new connections to randomly "
2381
1
                               "chosen Tor or I2P peers. Consider using -maxconnections=0 -addnode=... "
2382
1
                               "instead"));
2383
1
        }
2384
7
        if (!proxyRandomize && (g_reachable_nets.Contains(NET_ONION) || onion_may_become_reachable)) {
2385
1
            InitWarning(_("Private broadcast of own transactions requested (-privatebroadcast) and "
2386
1
                          "-proxyrandomize is disabled. Tor circuits for private broadcast connections "
2387
1
                          "may be correlated to other connections over Tor. To reduce this risk, set "
2388
1
                          "-proxyrandomize=1."));
2389
1
        }
2390
7
    }
2391
2392
1.09k
    if (!node.connman->Start(scheduler, connOptions)) {
2393
11
        return false;
2394
11
    }
2395
2396
    // ********************************************************* Step 13: finished
2397
2398
    // At this point, the RPC is "started", but still in warmup, which means it
2399
    // cannot yet be called. Before we make it callable, we need to make sure
2400
    // that the RPC's view of the best block is valid and consistent with
2401
    // ChainstateManager's active tip.
2402
1.08k
    SetRPCWarmupFinished();
2403
2404
1.08k
    uiInterface.InitMessage(_("Done loading"));
2405
2406
1.08k
    for (const auto& client : node.chain_clients) {
2407
374
        client->start(scheduler);
2408
374
    }
2409
2410
1.08k
    BanMan* banman = node.banman.get();
2411
1.08k
    scheduler.scheduleEvery([banman]{
2412
11
        banman->DumpBanlist();
2413
11
    }, DUMP_BANS_INTERVAL);
2414
2415
1.08k
    if (node.peerman) node.peerman->StartScheduledTasks(scheduler);
2416
2417
1.08k
#if HAVE_SYSTEM
2418
1.08k
    StartupNotify(args);
2419
1.08k
#endif
2420
2421
1.08k
    return true;
2422
1.09k
}
2423
2424
bool StartIndexBackgroundSync(NodeContext& node)
2425
1.10k
{
2426
1.10k
    ChainstateManager& chainman = *Assert(node.chainman);
2427
1.10k
    const Chainstate& chainstate = WITH_LOCK(::cs_main, return chainman.ValidatedChainstate());
2428
1.10k
    const CChain& index_chain = chainstate.m_chain;
2429
1.10k
    const int current_height = WITH_LOCK(::cs_main, return index_chain.Height());
2430
2431
    // Skip checking data availability if we have not synced any blocks yet
2432
1.10k
    if (current_height > 0) {
2433
        // Before starting index sync, verify that all required block data is available
2434
        // on disk from each index's current sync position up to the chain tip.
2435
        //
2436
        // This is done separately for undo and block data: First we verify block + undo
2437
        // data existence from tip down to the lowest height required by any index that
2438
        // needs undo data (e.g., coinstatsindex, blockfilterindex). Then, if any
2439
        // block-only index needs to sync from a lower height than previously covered,
2440
        // verify block data existence down to that lower height.
2441
        //
2442
        // This avoids checking undo data for blocks where no index requires it,
2443
        // though currently block and undo data availability are synchronized on disk
2444
        // under normal circumstances.
2445
670
        std::optional<const CBlockIndex*> block_start;
2446
670
        std::string block_start_name;
2447
670
        std::optional<const CBlockIndex*> undo_start;
2448
670
        std::string undo_start_name;
2449
2450
670
        for (const auto& index : node.indexes) {
2451
119
            const IndexSummary& summary = index->GetSummary();
2452
119
            if (summary.synced) continue;
2453
2454
            // Get the last common block between the index best block and the active chain
2455
71
            const CBlockIndex* pindex = nullptr;
2456
71
            {
2457
71
                LOCK(::cs_main);
2458
71
                pindex = chainman.m_blockman.LookupBlockIndex(summary.best_block_hash);
2459
71
                if (!pindex) {
2460
0
                    LogWarning("Failed to find block manager entry for best block %s from %s, falling back to genesis for index sync",
2461
0
                        summary.best_block_hash.ToString(), summary.name);
2462
71
                } else if (!index_chain.Contains(*pindex)) {
2463
1
                    pindex = index_chain.FindFork(*pindex);
2464
1
                }
2465
71
            }
2466
71
            if (!pindex) {
2467
0
                pindex = index_chain.Genesis();
2468
0
            }
2469
2470
71
            bool need_undo = index->CustomOptions().connect_undo_data;
2471
71
            auto& op_start_index = need_undo ? undo_start : block_start;
2472
71
            auto& name_index = need_undo ? undo_start_name : block_start_name;
2473
2474
71
            if (op_start_index && pindex->nHeight >= op_start_index.value()->nHeight) continue;
2475
56
            op_start_index = pindex;
2476
56
            name_index = summary.name;
2477
56
        }
2478
2479
        // Verify all blocks needed to sync to current tip are present including undo data.
2480
670
        if (undo_start) {
2481
24
            LOCK(::cs_main);
2482
24
            if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(undo_start.value()), BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO})) {
2483
0
                return InitError(Untranslated(strprintf("%s best block of the index goes beyond pruned data (including undo data). Please disable the index or reindex (which will download the whole blockchain again)", undo_start_name)));
2484
0
            }
2485
24
        }
2486
2487
        // Verify all blocks needed to sync to current tip are present unless we already checked all of them above.
2488
670
        if (block_start && !(undo_start && undo_start.value()->nHeight <= block_start.value()->nHeight)) {
2489
6
            LOCK(::cs_main);
2490
6
            if (!chainman.m_blockman.CheckBlockDataAvailability(*index_chain.Tip(), *Assert(block_start.value()), BlockStatus{BLOCK_HAVE_DATA})) {
2491
0
                return InitError(Untranslated(strprintf("%s best block of the index goes beyond pruned data. Please disable the index or reindex (which will download the whole blockchain again)", block_start_name)));
2492
0
            }
2493
6
        }
2494
670
    }
2495
2496
    // Start threads
2497
1.10k
    for (auto index : node.indexes) if (!index->StartBackgroundSync()) return false;
2498
1.10k
    return true;
2499
1.10k
}