Coverage Report

Created: 2026-09-14 20:36

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