Coverage Report

Created: 2026-04-29 19:21

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