Bitcoin Core Fuzz Coverage Report

Coverage Report

Created: 2026-06-01 16:00

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