Coverage Report

Created: 2026-05-30 09:47

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