Coverage Report

Created: 2026-07-08 14:14

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