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