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