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