Coverage Report

Created: 2026-07-30 14:31

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/root/bitcoin/src/test/util/setup_common.cpp
Line
Count
Source
1
// Copyright (c) 2011-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5
#include <test/util/setup_common.h>
6
7
#include <addrman.h>
8
#include <banman.h>
9
#include <chain.h>
10
#include <chainparams.h>
11
#include <coins.h>
12
#include <common/system.h>
13
#include <consensus/amount.h>
14
#include <consensus/consensus.h>
15
#include <consensus/validation.h>
16
#include <crypto/hex_base.h>
17
#include <dbwrapper.h>
18
#include <init.h>
19
#include <interfaces/chain.h>
20
#include <interfaces/mining.h>
21
#include <kernel/caches.h>
22
#include <kernel/context.h>
23
#include <key.h>
24
#include <logging.h>
25
#include <net.h>
26
#include <net_processing.h>
27
#include <netbase.h>
28
#include <netgroup.h>
29
#include <node/blockstorage.h>
30
#include <node/chainstate.h>
31
#include <node/context.h>
32
#include <node/kernel_notifications.h>
33
#include <node/miner.h>
34
#include <node/mining_args.h>
35
#include <node/mining_types.h>
36
#include <node/peerman_args.h>
37
#include <node/warnings.h>
38
#include <noui.h>
39
#include <policy/feerate.h>
40
#include <policy/policy.h>
41
#include <pow.h>
42
#include <primitives/block.h>
43
#include <primitives/transaction.h>
44
#include <random.h>
45
#include <rpc/register.h>
46
#include <rpc/server.h>
47
#include <scheduler.h>
48
#include <script/interpreter.h>
49
#include <script/script.h>
50
#include <script/sign.h>
51
#include <script/signingprovider.h>
52
#include <serialize.h>
53
#include <span.h>
54
#include <streams.h>
55
#include <sync.h>
56
#include <test/util/coverage.h>
57
#include <test/util/net.h>
58
#include <test/util/random.h>
59
#include <test/util/txmempool.h>
60
#include <tinyformat.h>
61
#include <txmempool.h>
62
#include <uint256.h>
63
#include <util/chaintype.h>
64
#include <util/check.h>
65
#include <util/fs.h>
66
#include <util/fs_helpers.h>
67
#include <util/rbf.h>
68
#include <util/result.h>
69
#include <util/signalinterrupt.h>
70
#include <util/strencodings.h>
71
#include <util/task_runner.h>
72
#include <util/thread.h>
73
#include <util/threadnames.h>
74
#include <util/time.h>
75
#include <util/translation.h>
76
#include <util/vector.h>
77
#include <validation.h>
78
#include <validationinterface.h>
79
80
#include <algorithm>
81
#include <array>
82
#include <atomic>
83
#include <cstdlib>
84
#include <deque>
85
#include <functional>
86
#include <future>
87
#include <iostream>
88
#include <iterator>
89
#include <map>
90
#include <numeric>
91
#include <span>
92
#include <stdexcept>
93
#include <string_view>
94
#include <thread>
95
#include <tuple>
96
#include <utility>
97
98
using namespace util::hex_literals;
99
using node::ApplyArgsManOptions;
100
using node::BlockManager;
101
using node::KernelNotifications;
102
using node::LoadChainstate;
103
using node::RegenerateCommitments;
104
using node::VerifyLoadedChainstate;
105
106
const TranslateFn G_TRANSLATION_FUN{nullptr};
107
108
constexpr inline auto TEST_DIR_PATH_ELEMENT{"test_common bitcoin"}; // Includes a space to catch possible path escape issues.
109
/** Random context to get unique temp data dirs. Separate from m_rng, which can be seeded from a const env var */
110
static FastRandomContext g_rng_temp_path;
111
0
static const bool g_rng_temp_path_init{[] {
112
    // Must be initialized before any SeedRandomForTest
113
0
    Assert(!g_used_g_prng);
114
0
    (void)g_rng_temp_path.rand64();
115
0
    g_used_g_prng = false;
116
0
    ResetCoverageCounters(); // The seed strengthen in SeedStartup is not deterministic, so exclude it from coverage counts
117
0
    return true;
118
0
}()};
119
120
struct NetworkSetup
121
{
122
    NetworkSetup()
123
0
    {
124
0
        Assert(SetupNetworking());
125
0
    }
126
};
127
static NetworkSetup g_networksetup_instance;
128
129
void SetupCommonTestArgs(ArgsManager& argsman)
130
0
{
131
0
    argsman.AddArg("-testdatadir", strprintf("Custom data directory (default: %s<random_string>)", fs::PathToString(fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / "")),
132
0
                   ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
133
0
}
134
135
/** Test setup failure */
136
static void ExitFailure(std::string_view str_err)
137
0
{
138
0
    std::cerr << str_err << std::endl;
139
0
    exit(EXIT_FAILURE);
140
0
}
141
142
BasicTestingSetup::BasicTestingSetup(const ChainType chainType, TestOpts opts)
143
0
    : m_args{}
144
0
{
145
0
    if (!EnableFuzzDeterminism()) {
  Branch (145:9): [True: 0, False: 0]
146
0
        SeedRandomForTest(SeedRand::FIXED_SEED);
147
0
    }
148
149
    // Reset globals
150
0
    fDiscover = true;
151
0
    fListen = true;
152
0
    SetRPCWarmupStarting();
153
0
    g_reachable_nets.Reset();
154
0
    ClearLocal();
155
156
0
    m_node.shutdown_signal = &m_interrupt;
157
0
    m_node.shutdown_request = [this]{ return m_interrupt(); };
158
0
    m_node.args = &gArgs;
159
0
    std::vector<const char*> arguments = Cat(
160
0
        {
161
0
            "dummy",
162
0
            "-printtoconsole=0",
163
0
            "-logsourcelocations",
164
0
            "-logtimemicros",
165
0
            "-logthreadnames",
166
0
            "-loglevel=trace",
167
0
            "-debug",
168
0
            "-debugexclude=leveldb",
169
0
        },
170
0
        opts.extra_args);
171
0
    if (G_TEST_COMMAND_LINE_ARGUMENTS) {
  Branch (171:9): [True: 0, False: 0]
172
0
        arguments = Cat(arguments, G_TEST_COMMAND_LINE_ARGUMENTS());
173
0
    }
174
0
    util::ThreadRename("test");
175
0
    gArgs.ClearPathCache();
176
0
    {
177
0
        SetupServerArgs(*m_node.args);
178
0
        SetupCommonTestArgs(*m_node.args);
179
0
        std::string error;
180
0
        if (!m_node.args->ParseParameters(arguments.size(), arguments.data(), error)) {
  Branch (180:13): [True: 0, False: 0]
181
0
            m_node.args->ClearArgs();
182
0
            throw std::runtime_error{error};
183
0
        }
184
0
    }
185
186
0
    const std::string test_name{G_TEST_GET_FULL_NAME ? G_TEST_GET_FULL_NAME() : ""};
  Branch (186:33): [True: 0, False: 0]
187
0
    if (!m_node.args->IsArgSet("-testdatadir")) {
  Branch (187:9): [True: 0, False: 0]
188
        // To avoid colliding with a leftover prior datadir, and to allow
189
        // tests, such as the fuzz tests to run in several processes at the
190
        // same time, add a random element to the path. Keep it small enough to
191
        // avoid a MAX_PATH violation on Windows.
192
        //
193
        // When fuzzing with AFL++, use the shared memory ID for a deterministic
194
        // path. This allows for cleanup of leftover directories from timed-out
195
        // or crashed iterations, preventing accumulation of stale datadirs.
196
0
        if (const char* shm_id = std::getenv("__AFL_SHM_ID"); shm_id && *shm_id) {
  Branch (196:63): [True: 0, False: 0]
  Branch (196:73): [True: 0, False: 0]
197
0
            m_path_root = fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / test_name / shm_id;
198
0
            fs::remove_all(m_path_root);
199
0
        } else {
200
0
            const auto rand{HexStr(g_rng_temp_path.randbytes(10))};
201
0
            m_path_root = fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / test_name / rand;
202
0
        }
203
0
        TryCreateDirectories(m_path_root);
204
0
    } else {
205
        // Custom data directory
206
0
        m_has_custom_datadir = true;
207
0
        fs::path root_dir{m_node.args->GetPathArg("-testdatadir")};
208
0
        if (root_dir.empty()) ExitFailure("-testdatadir argument is empty, please specify a path");
  Branch (208:13): [True: 0, False: 0]
209
210
0
        root_dir = fs::absolute(root_dir);
211
0
        m_path_lock = root_dir / TEST_DIR_PATH_ELEMENT / fs::PathFromString(test_name);
212
0
        m_path_root = m_path_lock / "datadir";
213
214
        // Try to obtain the lock; if unsuccessful don't disturb the existing test.
215
0
        TryCreateDirectories(m_path_lock);
216
0
        if (util::LockDirectory(m_path_lock, ".lock", /*probe_only=*/false) != util::LockResult::Success) {
  Branch (216:13): [True: 0, False: 0]
217
0
            ExitFailure("Cannot obtain a lock on test data lock directory " + fs::PathToString(m_path_lock) + '\n' + "The test executable is probably already running.");
218
0
        }
219
220
        // Always start with a fresh data directory; this doesn't delete the .lock file located one level above.
221
0
        fs::remove_all(m_path_root);
222
0
        if (!TryCreateDirectories(m_path_root)) ExitFailure("Cannot create test data directory");
  Branch (222:13): [True: 0, False: 0]
223
224
        // Print the test directory name if custom.
225
0
        std::cout << "Test directory (will not be deleted): " << m_path_root << std::endl;
226
0
    }
227
0
    m_args.ForceSetArg("-datadir", fs::PathToString(m_path_root));
228
0
    gArgs.ForceSetArg("-datadir", fs::PathToString(m_path_root));
229
230
    // Avoid non-loopback network traffic during tests.
231
0
    gArgs.ForceSetArg("-dnsseed", "0"); // DNS queries are usually forwarded to upstream DNS servers.
232
0
    gArgs.ForceSetArg("-natpmp", "0"); // NATPMP sends packets to the router.
233
234
0
    SelectParams(chainType);
235
0
    InitLogging(*m_node.args);
236
0
    AppInitParameterInteraction(*m_node.args);
237
0
    LogInstance().StartLogging();
238
0
    m_node.warnings = std::make_unique<node::Warnings>();
239
0
    m_node.kernel = std::make_unique<kernel::Context>();
240
0
    m_node.ecc_context = std::make_unique<ECC_Context>();
241
0
    SetupEnvironment();
242
243
0
    m_node.chain = interfaces::MakeChain(m_node);
244
0
    static bool noui_connected = false;
245
0
    if (!noui_connected) {
  Branch (245:9): [True: 0, False: 0]
246
0
        noui_connect();
247
0
        noui_connected = true;
248
0
    }
249
0
}
250
251
BasicTestingSetup::~BasicTestingSetup()
252
1
{
253
1
    m_node.ecc_context.reset();
254
1
    m_node.kernel.reset();
255
1
    if (!EnableFuzzDeterminism()) {
  Branch (255:9): [True: 0, False: 1]
256
0
        SetMockTime(0s); // Reset mocktime for following tests
257
0
    }
258
1
    LogInstance().DisconnectTestLogger();
259
1
    if (m_has_custom_datadir) {
  Branch (259:9): [True: 0, False: 1]
260
        // Only remove the lock file, preserve the data directory.
261
0
        UnlockDirectory(m_path_lock, ".lock");
262
0
        fs::remove(m_path_lock / ".lock");
263
1
    } else {
264
1
        fs::remove_all(m_path_root);
265
1
    }
266
    // Clear all arguments except for -datadir, which GUI tests currently rely
267
    // on to be set even after the testing setup is destroyed.
268
1
    gArgs.ClearArgs();
269
1
    gArgs.ForceSetArg("-datadir", fs::PathToString(m_path_root));
270
1
}
271
272
ChainTestingSetup::ChainTestingSetup(const ChainType chainType, TestOpts opts)
273
0
    : BasicTestingSetup(chainType, opts)
274
0
{
275
0
    const CChainParams& chainparams = Params();
276
277
    // A task runner is required to prevent ActivateBestChain
278
    // from blocking due to queue overrun.
279
0
    if (opts.setup_validation_interface) {
  Branch (279:9): [True: 0, False: 0]
280
0
        m_node.scheduler = std::make_unique<CScheduler>();
281
0
        m_node.scheduler->m_service_thread = std::thread(util::TraceThread, "scheduler", [&] { m_node.scheduler->serviceQueue(); });
282
0
        m_node.validation_signals =
283
            // Use synchronous task runner while fuzzing to avoid non-determinism
284
0
            EnableFuzzDeterminism() ?
  Branch (284:13): [True: 0, False: 0]
285
0
                std::make_unique<ValidationSignals>(std::make_unique<util::ImmediateTaskRunner>()) :
286
0
                std::make_unique<ValidationSignals>(std::make_unique<SerialTaskRunner>(*m_node.scheduler));
287
0
        {
288
            // Ensure deterministic coverage by waiting for m_service_thread to be running
289
0
            std::promise<void> promise;
290
0
            m_node.scheduler->scheduleFromNow([&promise] { promise.set_value(); }, 0ms);
291
0
            promise.get_future().wait();
292
0
        }
293
0
    }
294
295
0
    bilingual_str error{};
296
0
    m_node.mempool = std::make_unique<CTxMemPool>(MemPoolOptionsForTest(m_node), error);
297
0
    Assert(error.empty());
298
0
    m_node.warnings = std::make_unique<node::Warnings>();
299
300
0
    m_node.notifications = std::make_unique<KernelNotifications>(Assert(m_node.shutdown_request), m_node.exit_status, *Assert(m_node.warnings));
301
302
0
    m_make_chainman = [this, &chainparams, opts] {
303
0
        Assert(!m_node.chainman);
304
0
        ChainstateManager::Options chainman_opts{
305
0
            .chainparams = chainparams,
306
0
            .datadir = m_args.GetDataDirNet(),
307
0
            .check_block_index = 1,
308
0
            .notifications = *m_node.notifications,
309
0
            .signals = m_node.validation_signals.get(),
310
            // Use no worker threads while fuzzing to avoid racy non-determinism
311
            // and dangling thread handles if AFL forks after initialization.
312
0
            .worker_threads_num = EnableFuzzDeterminism() ? 0 : 2,
  Branch (312:35): [True: 0, False: 0]
313
0
            .prevoutfetch_threads_num = EnableFuzzDeterminism() ? 0 : 2,
  Branch (313:41): [True: 0, False: 0]
314
0
        };
315
0
        if (opts.min_validation_cache) {
  Branch (315:13): [True: 0, False: 0]
316
0
            chainman_opts.script_execution_cache_bytes = 0;
317
0
            chainman_opts.signature_cache_bytes = 0;
318
0
        }
319
0
        const BlockManager::Options blockman_opts{
320
0
            .chainparams = chainman_opts.chainparams,
321
0
            .blocks_dir = m_args.GetBlocksDirPath(),
322
0
            .notifications = chainman_opts.notifications,
323
0
            .block_tree_db_params = DBParams{
324
0
                .path = m_args.GetDataDirNet() / "blocks" / "index",
325
0
                .cache_bytes = m_kernel_cache_sizes.block_tree_db,
326
0
                .memory_only = opts.block_tree_db_in_memory,
327
0
                .wipe_data = m_args.GetBoolArg("-reindex", false),
328
0
            },
329
0
        };
330
0
        m_node.chainman = std::make_unique<ChainstateManager>(*Assert(m_node.shutdown_signal), chainman_opts, blockman_opts);
331
0
    };
332
0
    m_make_chainman();
333
0
}
334
335
ChainTestingSetup::~ChainTestingSetup()
336
1
{
337
1
    if (m_node.scheduler) m_node.scheduler->stop();
  Branch (337:9): [True: 1, False: 0]
338
1
    if (m_node.validation_signals) m_node.validation_signals->FlushBackgroundCallbacks();
  Branch (338:9): [True: 1, False: 0]
339
1
    m_node.connman.reset();
340
1
    m_node.banman.reset();
341
1
    m_node.addrman.reset();
342
1
    m_node.netgroupman.reset();
343
1
    m_node.args = nullptr;
344
1
    m_node.mempool.reset();
345
1
    Assert(!m_node.fee_estimator); // Each test must create a local object, if they wish to use the fee_estimator
346
1
    m_node.chainman.reset();
347
1
    m_node.validation_signals.reset();
348
1
    m_node.scheduler.reset();
349
1
}
350
351
void ChainTestingSetup::LoadVerifyActivateChainstate()
352
0
{
353
0
    auto& chainman{*Assert(m_node.chainman)};
354
0
    node::ChainstateLoadOptions options;
355
0
    options.mempool = Assert(m_node.mempool.get());
356
0
    options.coins_db_in_memory = m_coins_db_in_memory;
357
0
    options.wipe_chainstate_db = m_args.GetBoolArg("-reindex", false) || m_args.GetBoolArg("-reindex-chainstate", false);
  Branch (357:34): [True: 0, False: 0]
  Branch (357:74): [True: 0, False: 0]
358
0
    options.prune = chainman.m_blockman.IsPruneMode();
359
0
    options.check_blocks = m_args.GetIntArg("-checkblocks", DEFAULT_CHECKBLOCKS);
360
0
    options.check_level = m_args.GetIntArg("-checklevel", DEFAULT_CHECKLEVEL);
361
0
    options.require_full_verification = m_args.IsArgSet("-checkblocks") || m_args.IsArgSet("-checklevel");
  Branch (361:41): [True: 0, False: 0]
  Branch (361:76): [True: 0, False: 0]
362
0
    auto [status, error] = LoadChainstate(chainman, m_kernel_cache_sizes, options);
363
0
    assert(status == node::ChainstateLoadStatus::SUCCESS);
  Branch (363:5): [True: 0, False: 0]
364
365
0
    std::tie(status, error) = VerifyLoadedChainstate(chainman, options);
366
0
    assert(status == node::ChainstateLoadStatus::SUCCESS);
  Branch (366:5): [True: 0, False: 0]
367
368
0
    m_node.notifications->setChainstateLoaded(true);
369
370
0
    BlockValidationState state;
371
0
    if (!chainman.ActiveChainstate().ActivateBestChain(state)) {
  Branch (371:9): [True: 0, False: 0]
372
0
        throw std::runtime_error(strprintf("ActivateBestChain failed. (%s)", state.ToString()));
373
0
    }
374
0
}
375
376
TestingSetup::TestingSetup(
377
    const ChainType chainType,
378
    TestOpts opts)
379
0
    : ChainTestingSetup(chainType, opts)
380
0
{
381
0
    m_coins_db_in_memory = opts.coins_db_in_memory;
382
0
    m_block_tree_db_in_memory = opts.block_tree_db_in_memory;
383
    // Ideally we'd move all the RPC tests to the functional testing framework
384
    // instead of unit tests, but for now we need these here.
385
0
    RegisterAllCoreRPCCommands(tableRPC);
386
387
0
    LoadVerifyActivateChainstate();
388
389
0
    if (!opts.setup_net) return;
  Branch (389:9): [True: 0, False: 0]
390
391
0
    m_node.netgroupman = std::make_unique<NetGroupManager>(NetGroupManager::NoAsmap());
392
0
    m_node.addrman = std::make_unique<AddrMan>(*m_node.netgroupman,
393
0
                                               /*deterministic=*/false,
394
0
                                               m_node.args->GetIntArg("-checkaddrman", 0));
395
0
    m_node.banman = std::make_unique<BanMan>(m_args.GetDataDirBase() / "banlist", nullptr, DEFAULT_MISBEHAVING_BANTIME);
396
0
    m_node.connman = std::make_unique<ConnmanTestMsg>(0x1337, 0x1337, *m_node.addrman, *m_node.netgroupman, Params()); // Deterministic randomness for tests.
397
0
    auto mining_args{node::ReadMiningArgs(*m_node.args)};
398
0
    Assert(mining_args);
399
0
    m_node.mining_args = std::move(*mining_args);
400
0
    PeerManager::Options peerman_opts;
401
0
    ApplyArgsManOptions(*m_node.args, peerman_opts);
402
0
    peerman_opts.deterministic_rng = true;
403
0
    m_node.peerman = PeerManager::make(*m_node.connman, *m_node.addrman,
404
0
                                       m_node.banman.get(), *m_node.chainman,
405
0
                                       *m_node.mempool, *m_node.warnings,
406
0
                                       peerman_opts);
407
408
0
    {
409
0
        CConnman::Options options;
410
0
        options.m_msgproc = m_node.peerman.get();
411
0
        m_node.connman->Init(options);
412
0
    }
413
0
}
414
415
TestChain100Setup::TestChain100Setup(
416
    const ChainType chain_type,
417
    TestOpts opts)
418
0
    : TestingSetup{ChainType::REGTEST, opts}
419
0
{
420
0
    constexpr std::array<unsigned char, 32> vchKey = {
421
0
        {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}};
422
0
    coinbaseKey.Set(vchKey.begin(), vchKey.end(), true);
423
424
    // Generate a 100-block chain:
425
0
    this->mineBlocks(COINBASE_MATURITY);
426
427
0
    {
428
0
        LOCK(::cs_main);
429
0
        assert(
  Branch (429:9): [True: 0, False: 0]
430
0
            m_node.chainman->ActiveChain().Tip()->GetBlockHash().ToString() ==
431
0
            "0ee6e270d6594249e548110619f7bd690695beb219b915da4a2e84e2b61ed60f");
432
0
    }
433
0
}
434
435
void TestChain100Setup::mineBlocks(int num_blocks)
436
0
{
437
0
    CScript scriptPubKey = CScript() << ToByteVector(coinbaseKey.GetPubKey()) << OP_CHECKSIG;
438
0
    for (int i = 0; i < num_blocks; i++) {
  Branch (438:21): [True: 0, False: 0]
439
0
        std::vector<CMutableTransaction> noTxns;
440
0
        CBlock b = CreateAndProcessBlock(noTxns, scriptPubKey);
441
0
        m_clock += 1s;
442
0
        m_coinbase_txns.push_back(b.vtx[0]);
443
0
    }
444
0
}
445
446
CBlock TestChain100Setup::CreateBlock(
447
    const std::vector<CMutableTransaction>& txns,
448
    const CScript& scriptPubKey)
449
0
{
450
0
    auto mining{interfaces::MakeMining(m_node)};
451
0
    auto block_template{mining->createNewBlock({
452
0
        .use_mempool = false,
453
0
        .coinbase_output_script = scriptPubKey,
454
0
    }, /*cooldown=*/false)};
455
0
    Assert(block_template);
456
0
    CBlock block{block_template->getBlock()};
457
458
0
    Assert(block.vtx.size() == 1);
459
0
    for (const CMutableTransaction& tx : txns) {
  Branch (459:40): [True: 0, False: 0]
460
0
        block.vtx.push_back(MakeTransactionRef(tx));
461
0
    }
462
0
    RegenerateCommitments(block, *Assert(m_node.chainman));
463
464
0
    while (!CheckProofOfWork(block.GetHash(), block.nBits, m_node.chainman->GetConsensus())) ++block.nNonce;
  Branch (464:12): [True: 0, False: 0]
465
466
0
    return block;
467
0
}
468
469
CBlock TestChain100Setup::CreateAndProcessBlock(
470
    const std::vector<CMutableTransaction>& txns,
471
    const CScript& scriptPubKey)
472
0
{
473
0
    CBlock block = this->CreateBlock(txns, scriptPubKey);
474
0
    std::shared_ptr<const CBlock> shared_pblock = std::make_shared<const CBlock>(block);
475
0
    Assert(m_node.chainman)->ProcessNewBlock(shared_pblock, true, true, nullptr);
476
477
0
    return block;
478
0
}
479
480
std::pair<CMutableTransaction, CAmount> TestChain100Setup::CreateValidTransaction(const std::vector<CTransactionRef>& input_transactions,
481
                                                                                  const std::vector<COutPoint>& inputs,
482
                                                                                  int input_height,
483
                                                                                  const std::vector<CKey>& input_signing_keys,
484
                                                                                  const std::vector<CTxOut>& outputs,
485
                                                                                  const std::optional<CFeeRate>& feerate,
486
                                                                                  const std::optional<uint32_t>& fee_output)
487
0
{
488
0
    CMutableTransaction mempool_txn;
489
0
    mempool_txn.vin.reserve(inputs.size());
490
0
    mempool_txn.vout.reserve(outputs.size());
491
492
0
    for (const auto& outpoint : inputs) {
  Branch (492:31): [True: 0, False: 0]
493
0
        mempool_txn.vin.emplace_back(outpoint, CScript(), MAX_BIP125_RBF_SEQUENCE);
494
0
    }
495
0
    mempool_txn.vout = outputs;
496
497
    // - Add the signing key to a keystore
498
0
    FillableSigningProvider keystore;
499
0
    for (const auto& input_signing_key : input_signing_keys) {
  Branch (499:40): [True: 0, False: 0]
500
0
        keystore.AddKey(input_signing_key);
501
0
    }
502
    // - Populate a CoinsViewCache with the unspent output
503
0
    CCoinsViewCache coins_cache{&CoinsViewEmpty::Get()};
504
0
    for (const auto& input_transaction : input_transactions) {
  Branch (504:40): [True: 0, False: 0]
505
0
        AddCoins(coins_cache, *input_transaction.get(), input_height);
506
0
    }
507
    // Build Outpoint to Coin map for SignTransaction
508
0
    std::map<COutPoint, Coin> input_coins;
509
0
    CAmount inputs_amount{0};
510
0
    for (const auto& outpoint_to_spend : inputs) {
  Branch (510:40): [True: 0, False: 0]
511
        // Use GetCoin to properly populate utxo_to_spend
512
0
        auto utxo_to_spend{coins_cache.GetCoin(outpoint_to_spend).value()};
513
0
        input_coins.insert({outpoint_to_spend, utxo_to_spend});
514
0
        inputs_amount += utxo_to_spend.out.nValue;
515
0
    }
516
    // - Default signature hashing type
517
0
    int nHashType = SIGHASH_ALL;
518
0
    std::map<int, bilingual_str> input_errors;
519
0
    assert(SignTransaction(mempool_txn, &keystore, input_coins, {.sighash_type = nHashType}, input_errors));
  Branch (519:5): [True: 0, False: 0]
520
0
    CAmount current_fee = inputs_amount - std::accumulate(outputs.begin(), outputs.end(), CAmount(0),
521
0
        [](const CAmount& acc, const CTxOut& out) {
522
0
        return acc + out.nValue;
523
0
    });
524
    // Deduct fees from fee_output to meet feerate if set
525
0
    if (feerate.has_value()) {
  Branch (525:9): [True: 0, False: 0]
526
0
        assert(fee_output.has_value());
  Branch (526:9): [True: 0, False: 0]
527
0
        assert(fee_output.value() < mempool_txn.vout.size());
  Branch (527:9): [True: 0, False: 0]
528
0
        CAmount target_fee = feerate.value().GetFee(GetVirtualTransactionSize(CTransaction{mempool_txn}));
529
0
        CAmount deduction = target_fee - current_fee;
530
0
        if (deduction > 0) {
  Branch (530:13): [True: 0, False: 0]
531
            // Only deduct fee if there's anything to deduct. If the caller has put more fees than
532
            // the target feerate, don't change the fee.
533
0
            mempool_txn.vout[fee_output.value()].nValue -= deduction;
534
            // Re-sign since an output has changed
535
0
            input_errors.clear();
536
0
            assert(SignTransaction(mempool_txn, &keystore, input_coins, {.sighash_type = nHashType}, input_errors));
  Branch (536:13): [True: 0, False: 0]
537
0
            current_fee = target_fee;
538
0
        }
539
0
    }
540
0
    return {mempool_txn, current_fee};
541
0
}
542
543
CMutableTransaction TestChain100Setup::CreateValidMempoolTransaction(const std::vector<CTransactionRef>& input_transactions,
544
                                                                     const std::vector<COutPoint>& inputs,
545
                                                                     int input_height,
546
                                                                     const std::vector<CKey>& input_signing_keys,
547
                                                                     const std::vector<CTxOut>& outputs,
548
                                                                     bool submit)
549
0
{
550
0
    CMutableTransaction mempool_txn = CreateValidTransaction(input_transactions, inputs, input_height, input_signing_keys, outputs, std::nullopt, std::nullopt).first;
551
    // If submit=true, add transaction to the mempool.
552
0
    if (submit) {
  Branch (552:9): [True: 0, False: 0]
553
0
        LOCK(cs_main);
554
0
        const MempoolAcceptResult result = m_node.chainman->ProcessTransaction(MakeTransactionRef(mempool_txn));
555
0
        assert(result.m_result_type == MempoolAcceptResult::ResultType::VALID);
  Branch (555:9): [True: 0, False: 0]
556
0
    }
557
0
    return mempool_txn;
558
0
}
559
560
CMutableTransaction TestChain100Setup::CreateValidMempoolTransaction(CTransactionRef input_transaction,
561
                                                                     uint32_t input_vout,
562
                                                                     int input_height,
563
                                                                     CKey input_signing_key,
564
                                                                     CScript output_destination,
565
                                                                     CAmount output_amount,
566
                                                                     bool submit)
567
0
{
568
0
    COutPoint input{input_transaction->GetHash(), input_vout};
569
0
    CTxOut output{output_amount, output_destination};
570
0
    return CreateValidMempoolTransaction(/*input_transactions=*/{input_transaction},
571
0
                                         /*inputs=*/{input},
572
0
                                         /*input_height=*/input_height,
573
0
                                         /*input_signing_keys=*/{input_signing_key},
574
0
                                         /*outputs=*/{output},
575
0
                                         /*submit=*/submit);
576
0
}
577
578
std::vector<CTransactionRef> TestChain100Setup::PopulateMempool(FastRandomContext& det_rand, size_t num_transactions, bool submit)
579
0
{
580
0
    std::vector<CTransactionRef> mempool_transactions;
581
0
    std::deque<std::pair<COutPoint, CAmount>> unspent_prevouts, undo_info;
582
0
    std::transform(m_coinbase_txns.begin(), m_coinbase_txns.end(), std::back_inserter(unspent_prevouts),
583
0
        [](const auto& tx){ return std::make_pair(COutPoint(tx->GetHash(), 0), tx->vout[0].nValue); });
584
0
    while (num_transactions > 0 && !unspent_prevouts.empty()) {
  Branch (584:12): [True: 0, False: 0]
  Branch (584:36): [True: 0, False: 0]
585
        // The number of inputs and outputs are randomly chosen, between 1-5
586
        // and 1-25 respectively.
587
0
        CMutableTransaction mtx = CMutableTransaction();
588
0
        const size_t num_inputs = det_rand.randrange(5) + 1;
589
0
        CAmount total_in{0};
590
0
        for (size_t n{0}; n < num_inputs; ++n) {
  Branch (590:27): [True: 0, False: 0]
591
0
            if (unspent_prevouts.empty()) break;
  Branch (591:17): [True: 0, False: 0]
592
0
            const auto& [prevout, amount] = unspent_prevouts.front();
593
0
            undo_info.emplace_back(prevout, amount);
594
0
            mtx.vin.emplace_back(prevout, CScript());
595
0
            total_in += amount;
596
0
            unspent_prevouts.pop_front();
597
0
        }
598
0
        const size_t num_outputs = det_rand.randrange(25) + 1;
599
0
        const CAmount fee = 100 * det_rand.randrange(30);
600
0
        const CAmount amount_per_output = (total_in - fee) / num_outputs;
601
0
        for (size_t n{0}; n < num_outputs; ++n) {
  Branch (601:27): [True: 0, False: 0]
602
0
            CScript spk = CScript() << CScriptNum(num_transactions + n);
603
0
            mtx.vout.emplace_back(amount_per_output, spk);
604
0
        }
605
0
        CTransactionRef ptx = MakeTransactionRef(mtx);
606
0
        bool success{true};
607
0
        if (submit) {
  Branch (607:13): [True: 0, False: 0]
608
0
            LOCK2(cs_main, m_node.mempool->cs);
609
0
            LockPoints lp;
610
0
            auto changeset = m_node.mempool->GetChangeSet();
611
0
            changeset->StageAddition(ptx, /*fee=*/(total_in - num_outputs * amount_per_output),
612
0
                    /*time=*/0, /*entry_height=*/1, /*entry_sequence=*/0,
613
0
                    /*spends_coinbase=*/false, /*sigops_cost=*/4, lp);
614
0
            if (changeset->CheckMemPoolPolicyLimits()) {
  Branch (614:17): [True: 0, False: 0]
615
0
                changeset->Apply();
616
0
                --num_transactions;
617
0
            } else {
618
0
                success = false;
619
                // Add the inputs back to unspent prevouts
620
0
                for (const auto& [prevout, amount] : undo_info) {
  Branch (620:52): [True: 0, False: 0]
621
0
                    unspent_prevouts.emplace_back(prevout, amount);
622
0
                    std::swap(unspent_prevouts.back(), unspent_prevouts[det_rand.randrange(unspent_prevouts.size())]);
623
0
                }
624
0
            }
625
0
        }
626
0
        if (success) {
  Branch (626:13): [True: 0, False: 0]
627
0
            mempool_transactions.push_back(ptx);
628
0
            if (amount_per_output > 3000) {
  Branch (628:17): [True: 0, False: 0]
629
                // If the value is high enough to fund another transaction + fees, keep track of it so
630
                // it can be used to build a more complex transaction graph. Insert randomly into
631
                // unspent_prevouts for extra randomness in the resulting structures.
632
0
                for (size_t n{0}; n < num_outputs; ++n) {
  Branch (632:35): [True: 0, False: 0]
633
0
                    unspent_prevouts.emplace_back(COutPoint(ptx->GetHash(), n), amount_per_output);
634
0
                    std::swap(unspent_prevouts.back(), unspent_prevouts[det_rand.randrange(unspent_prevouts.size())]);
635
0
                }
636
0
            }
637
0
        }
638
0
        undo_info.clear();
639
0
    }
640
0
    return mempool_transactions;
641
0
}
642
643
SocketTestingSetup::SocketTestingSetup()
644
0
{
645
    // "back up" the current CreateSock() so we can restore it after the test
646
0
    m_create_sock_orig = CreateSock;
647
648
0
    CreateSock = [this](int, int, int) {
649
        // This is a mock Listening Socket that a server can "bind" to and
650
        // listen to for incoming connections. We won't need to access its I/O
651
        // pipes because we don't read or write directly to it. It will return
652
        // Connected Sockets from the queue via its Accept() method.
653
0
        return std::make_unique<DynSock>(std::make_shared<DynSock::Pipes>(), &m_accepted_sockets);
654
0
    };
655
0
};
656
657
SocketTestingSetup::~SocketTestingSetup()
658
0
{
659
0
    CreateSock = m_create_sock_orig;
660
0
}
661
662
/**
663
 * @returns a real block (0000000000013b8ab2cd513b0261a14096412195a72a0c4827d229dcc7e0f7af)
664
 *      with 9 txs.
665
 */
666
CBlock getBlock13b8a()
667
0
{
668
0
    CBlock block;
669
0
    DataStream stream{
670
0
        "0100000090f0a9f110702f808219ebea1173056042a714bad51b916cb6800000000000005275289558f51c9966699404ae2294730c3c9f9bda53523ce50e9b95e558da2fdb261b4d4c86041b1ab1bf930901000000010000000000000000000000000000000000000000000000000000000000000000ffffffff07044c86041b0146ffffffff0100f2052a01000000434104e18f7afbe4721580e81e8414fc8c24d7cfacf254bb5c7b949450c3e997c2dc1242487a8169507b631eb3771f2b425483fb13102c4eb5d858eef260fe70fbfae0ac00000000010000000196608ccbafa16abada902780da4dc35dafd7af05fa0da08cf833575f8cf9e836000000004a493046022100dab24889213caf43ae6adc41cf1c9396c08240c199f5225acf45416330fd7dbd022100fe37900e0644bf574493a07fc5edba06dbc07c311b947520c2d514bc5725dcb401ffffffff0100f2052a010000001976a914f15d1921f52e4007b146dfa60f369ed2fc393ce288ac000000000100000001fb766c1288458c2bafcfec81e48b24d98ec706de6b8af7c4e3c29419bfacb56d000000008c493046022100f268ba165ce0ad2e6d93f089cfcd3785de5c963bb5ea6b8c1b23f1ce3e517b9f022100da7c0f21adc6c401887f2bfd1922f11d76159cbc597fbd756a23dcbb00f4d7290141042b4e8625a96127826915a5b109852636ad0da753c9e1d5606a50480cd0c40f1f8b8d898235e571fe9357d9ec842bc4bba1827daaf4de06d71844d0057707966affffffff0280969800000000001976a9146963907531db72d0ed1a0cfb471ccb63923446f388ac80d6e34c000000001976a914f0688ba1c0d1ce182c7af6741e02658c7d4dfcd388ac000000000100000002c40297f730dd7b5a99567eb8d27b78758f607507c52292d02d4031895b52f2ff010000008b483045022100f7edfd4b0aac404e5bab4fd3889e0c6c41aa8d0e6fa122316f68eddd0a65013902205b09cc8b2d56e1cd1f7f2fafd60a129ed94504c4ac7bdc67b56fe67512658b3e014104732012cb962afa90d31b25d8fb0e32c94e513ab7a17805c14ca4c3423e18b4fb5d0e676841733cb83abaf975845c9f6f2a8097b7d04f4908b18368d6fc2d68ecffffffffca5065ff9617cbcba45eb23726df6498a9b9cafed4f54cbab9d227b0035ddefb000000008a473044022068010362a13c7f9919fa832b2dee4e788f61f6f5d344a7c2a0da6ae740605658022006d1af525b9a14a35c003b78b72bd59738cd676f845d1ff3fc25049e01003614014104732012cb962afa90d31b25d8fb0e32c94e513ab7a17805c14ca4c3423e18b4fb5d0e676841733cb83abaf975845c9f6f2a8097b7d04f4908b18368d6fc2d68ecffffffff01001ec4110200000043410469ab4181eceb28985b9b4e895c13fa5e68d85761b7eee311db5addef76fa8621865134a221bd01f28ec9999ee3e021e60766e9d1f3458c115fb28650605f11c9ac000000000100000001cdaf2f758e91c514655e2dc50633d1e4c84989f8aa90a0dbc883f0d23ed5c2fa010000008b48304502207ab51be6f12a1962ba0aaaf24a20e0b69b27a94fac5adf45aa7d2d18ffd9236102210086ae728b370e5329eead9accd880d0cb070aea0c96255fae6c4f1ddcce1fd56e014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffff02404b4c00000000001976a9142b6ba7c9d796b75eef7942fc9288edd37c32f5c388ac002d3101000000001976a9141befba0cdc1ad56529371864d9f6cb042faa06b588ac000000000100000001b4a47603e71b61bc3326efd90111bf02d2f549b067f4c4a8fa183b57a0f800cb010000008a4730440220177c37f9a505c3f1a1f0ce2da777c339bd8339ffa02c7cb41f0a5804f473c9230220585b25a2ee80eb59292e52b987dad92acb0c64eced92ed9ee105ad153cdb12d001410443bd44f683467e549dae7d20d1d79cbdb6df985c6e9c029c8d0c6cb46cc1a4d3cf7923c5021b27f7a0b562ada113bc85d5fda5a1b41e87fe6e8802817cf69996ffffffff0280651406000000001976a9145505614859643ab7b547cd7f1f5e7e2a12322d3788ac00aa0271000000001976a914ea4720a7a52fc166c55ff2298e07baf70ae67e1b88ac00000000010000000586c62cd602d219bb60edb14a3e204de0705176f9022fe49a538054fb14abb49e010000008c493046022100f2bc2aba2534becbdf062eb993853a42bbbc282083d0daf9b4b585bd401aa8c9022100b1d7fd7ee0b95600db8535bbf331b19eed8d961f7a8e54159c53675d5f69df8c014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffff03ad0e58ccdac3df9dc28a218bcf6f1997b0a93306faaa4b3a28ae83447b2179010000008b483045022100be12b2937179da88599e27bb31c3525097a07cdb52422d165b3ca2f2020ffcf702200971b51f853a53d644ebae9ec8f3512e442b1bcb6c315a5b491d119d10624c83014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffff2acfcab629bbc8685792603762c921580030ba144af553d271716a95089e107b010000008b483045022100fa579a840ac258871365dd48cd7552f96c8eea69bd00d84f05b283a0dab311e102207e3c0ee9234814cfbb1b659b83671618f45abc1326b9edcc77d552a4f2a805c0014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffffdcdc6023bbc9944a658ddc588e61eacb737ddf0a3cd24f113b5a8634c517fcd2000000008b4830450221008d6df731df5d32267954bd7d2dda2302b74c6c2a6aa5c0ca64ecbabc1af03c75022010e55c571d65da7701ae2da1956c442df81bbf076cdbac25133f99d98a9ed34c014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffffe15557cd5ce258f479dfd6dc6514edf6d7ed5b21fcfa4a038fd69f06b83ac76e010000008b483045022023b3e0ab071eb11de2eb1cc3a67261b866f86bf6867d4558165f7c8c8aca2d86022100dc6e1f53a91de3efe8f63512850811f26284b62f850c70ca73ed5de8771fb451014104462e76fd4067b3a0aa42070082dcb0bf2f388b6495cf33d789904f07d0f55c40fbd4b82963c69b3dc31895d0c772c812b1d5fbcade15312ef1c0e8ebbb12dcd4ffffffff01404b4c00000000001976a9142b6ba7c9d796b75eef7942fc9288edd37c32f5c388ac00000000010000000166d7577163c932b4f9690ca6a80b6e4eb001f0a2fa9023df5595602aae96ed8d000000008a4730440220262b42546302dfb654a229cefc86432b89628ff259dc87edd1154535b16a67e102207b4634c020a97c3e7bbd0d4d19da6aa2269ad9dded4026e896b213d73ca4b63f014104979b82d02226b3a4597523845754d44f13639e3bf2df5e82c6aab2bdc79687368b01b1ab8b19875ae3c90d661a3d0a33161dab29934edeb36aa01976be3baf8affffffff02404b4c00000000001976a9144854e695a02af0aeacb823ccbc272134561e0a1688ac40420f00000000001976a914abee93376d6b37b5c2940655a6fcaf1c8e74237988ac0000000001000000014e3f8ef2e91349a9059cb4f01e54ab2597c1387161d3da89919f7ea6acdbb371010000008c49304602210081f3183471a5ca22307c0800226f3ef9c353069e0773ac76bb580654d56aa523022100d4c56465bdc069060846f4fbf2f6b20520b2a80b08b168b31e66ddb9c694e240014104976c79848e18251612f8940875b2b08d06e6dc73b9840e8860c066b7e87432c477e9a59a453e71e6d76d5fe34058b800a098fc1740ce3012e8fc8a00c96af966ffffffff02c0e1e400000000001976a9144134e75a6fcb6042034aab5e18570cf1f844f54788ac404b4c00000000001976a9142b6ba7c9d796b75eef7942fc9288edd37c32f5c388ac00000000"_hex,
671
0
    };
672
0
    stream >> TX_WITH_WITNESS(block);
673
0
    return block;
674
0
}