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