Coverage Report

Created: 2026-09-02 14:16

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