Bitcoin Core 31.99.0
P2P Digital Currency
test_kernel.cpp
Go to the documentation of this file.
1// Copyright (c) 2024-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
7#include <util/fs.h>
8
9#define BOOST_TEST_MODULE Bitcoin Kernel Test Suite
10#include <boost/test/included/unit_test.hpp>
11
13
14#include <charconv>
15#include <cstdint>
16#include <cstdlib>
17#include <iostream>
18#include <memory>
19#include <optional>
20#include <random>
21#include <ranges>
22#include <span>
23#include <string>
24#include <string_view>
25#include <vector>
26
27using namespace btck;
28
29std::string random_string(uint32_t length)
30{
31 const std::string chars = "0123456789"
32 "abcdefghijklmnopqrstuvwxyz"
33 "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
34
35 static std::random_device rd;
36 static std::default_random_engine dre{rd()};
37 static std::uniform_int_distribution<> distribution(0, chars.size() - 1);
38
39 std::string random;
40 random.reserve(length);
41 for (uint32_t i = 0; i < length; i++) {
42 random += chars[distribution(dre)];
43 }
44 return random;
45}
46
47std::vector<std::byte> hex_string_to_byte_vec(std::string_view hex)
48{
49 std::vector<std::byte> bytes;
50 bytes.reserve(hex.length() / 2);
51
52 for (size_t i{0}; i < hex.length(); i += 2) {
53 uint8_t byte_value;
54 auto [ptr, ec] = std::from_chars(hex.data() + i, hex.data() + i + 2, byte_value, 16);
55
56 if (ec != std::errc{} || ptr != hex.data() + i + 2) {
57 throw std::invalid_argument("Invalid hex character");
58 }
59 bytes.push_back(static_cast<std::byte>(byte_value));
60 }
61 return bytes;
62}
63
64std::string byte_span_to_hex_string_reversed(std::span<const std::byte> bytes)
65{
66 std::ostringstream oss;
67
68 // Iterate in reverse order
69 for (auto it = bytes.rbegin(); it != bytes.rend(); ++it) {
70 oss << std::hex << std::setw(2) << std::setfill('0')
71 << static_cast<unsigned int>(static_cast<uint8_t>(*it));
72 }
73
74 return oss.str();
75}
76
77constexpr auto VERIFY_ALL_PRE_SEGWIT{ScriptVerificationFlags::P2SH | ScriptVerificationFlags::DERSIG |
78 ScriptVerificationFlags::NULLDUMMY | ScriptVerificationFlags::CHECKLOCKTIMEVERIFY |
79 ScriptVerificationFlags::CHECKSEQUENCEVERIFY};
80constexpr auto VERIFY_ALL_PRE_TAPROOT{VERIFY_ALL_PRE_SEGWIT | ScriptVerificationFlags::WITNESS};
81
82void check_equal(std::span<const std::byte> _actual, std::span<const std::byte> _expected, bool equal = true)
83{
84 std::span<const uint8_t> actual{reinterpret_cast<const unsigned char*>(_actual.data()), _actual.size()};
85 std::span<const uint8_t> expected{reinterpret_cast<const unsigned char*>(_expected.data()), _expected.size()};
86 BOOST_CHECK_EQUAL_COLLECTIONS(
87 actual.begin(), actual.end(),
88 expected.begin(), expected.end());
89}
90
92{
93public:
94 void LogMessage(std::string_view message)
95 {
96 std::cout << "kernel: " << message;
97 }
98};
99
101 fs::path m_directory;
102 TestDirectory(std::string directory_name)
103 : m_directory{fs::path{fs::temp_directory_path()} / fs::u8path(directory_name + "_🌽_" + random_string(16))}
104 {
105 fs::create_directories(m_directory);
106 }
107
109 {
110 fs::remove_all(m_directory);
111 }
112};
113
115{
116public:
117 void HeaderTipHandler(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
118 {
119 BOOST_CHECK_GT(timestamp, 0);
120 }
121
122 void WarningSetHandler(Warning warning, std::string_view message) override
123 {
124 std::cout << "Kernel warning is set: " << message << std::endl;
125 }
126
127 void WarningUnsetHandler(Warning warning) override
128 {
129 std::cout << "Kernel warning was unset." << std::endl;
130 }
131
132 void FlushErrorHandler(std::string_view error) override
133 {
134 std::cout << error << std::endl;
135 }
136
137 void FatalErrorHandler(std::string_view error) override
138 {
139 std::cout << error << std::endl;
140 }
141};
142
144{
145public:
146 std::optional<std::vector<std::byte>> m_expected_valid_block = std::nullopt;
147
148 void BlockChecked(Block block, BlockValidationStateView state) override
149 {
150 if (m_expected_valid_block.has_value()) {
151 auto ser_block{block.ToBytes()};
152 check_equal(m_expected_valid_block.value(), ser_block);
153 }
154
155 auto mode{state.GetValidationMode()};
156 switch (mode) {
157 case ValidationMode::VALID: {
158 std::cout << "Valid block" << std::endl;
159 return;
160 }
162 std::cout << "Invalid block: ";
163 auto result{state.GetBlockValidationResult()};
164 switch (result) {
165 case BlockValidationResult::UNSET:
166 std::cout << "initial value. Block has not yet been rejected" << std::endl;
167 break;
168 case BlockValidationResult::HEADER_LOW_WORK:
169 std::cout << "the block header may be on a too-little-work chain" << std::endl;
170 break;
171 case BlockValidationResult::CONSENSUS:
172 std::cout << "invalid by consensus rules (excluding any below reasons)" << std::endl;
173 break;
174 case BlockValidationResult::CACHED_INVALID:
175 std::cout << "this block was cached as being invalid and we didn't store the reason why" << std::endl;
176 break;
177 case BlockValidationResult::INVALID_HEADER:
178 std::cout << "invalid proof of work or time too old" << std::endl;
179 break;
180 case BlockValidationResult::MUTATED:
181 std::cout << "the block's data didn't match the data committed to by the PoW" << std::endl;
182 break;
183 case BlockValidationResult::MISSING_PREV:
184 std::cout << "We don't have the previous block the checked one is built on" << std::endl;
185 break;
186 case BlockValidationResult::INVALID_PREV:
187 std::cout << "A block this one builds on is invalid" << std::endl;
188 break;
189 case BlockValidationResult::TIME_FUTURE:
190 std::cout << "block timestamp was > 2 hours in the future (or our clock is bad)" << std::endl;
191 break;
192 }
193 return;
194 }
195 case ValidationMode::INTERNAL_ERROR: {
196 std::cout << "Internal error" << std::endl;
197 return;
198 }
199 }
200 }
201
202 void BlockConnected(Block block, BlockTreeEntry entry) override
203 {
204 std::cout << "Block connected." << std::endl;
205 }
206
207 void PowValidBlock(BlockTreeEntry entry, Block block) override
208 {
209 std::cout << "Block passed pow verification" << std::endl;
210 }
211
212 void BlockDisconnected(Block block, BlockTreeEntry entry) override
213 {
214 std::cout << "Block disconnected." << std::endl;
215 }
216};
217
219 const ScriptPubkey& spent_script_pubkey,
220 const Transaction& spending_tx,
221 const PrecomputedTransactionData* precomputed_txdata,
222 int64_t amount,
223 unsigned int input_index,
224 bool taproot)
225{
226 auto status = ScriptVerifyStatus::OK;
227
228 if (taproot) {
229 BOOST_CHECK(spent_script_pubkey.Verify(
230 amount,
231 spending_tx,
232 precomputed_txdata,
233 input_index,
235 status));
236 BOOST_CHECK(status == ScriptVerifyStatus::OK);
237 } else {
238 BOOST_CHECK(!spent_script_pubkey.Verify(
239 amount,
240 spending_tx,
241 precomputed_txdata,
242 input_index,
244 status));
245 BOOST_CHECK(status == ScriptVerifyStatus::ERROR_SPENT_OUTPUTS_REQUIRED);
246 }
247
248 BOOST_CHECK(spent_script_pubkey.Verify(
249 amount,
250 spending_tx,
251 precomputed_txdata,
252 input_index,
254 status));
255 BOOST_CHECK(status == ScriptVerifyStatus::OK);
256
257 BOOST_CHECK(spent_script_pubkey.Verify(
258 0,
259 spending_tx,
260 precomputed_txdata,
261 input_index,
263 status));
264 BOOST_CHECK(status == ScriptVerifyStatus::OK);
265}
266
267template <typename T>
268concept HasToBytes = requires(T t) { t.ToBytes(); };
269
270template <typename T>
271void CheckHandle(T object, T distinct_object)
272{
273 BOOST_CHECK(object.get() != nullptr);
274 BOOST_CHECK(distinct_object.get() != nullptr);
275 BOOST_CHECK(object.get() != distinct_object.get());
276
277 if constexpr (HasToBytes<T>) {
278 const auto object_bytes = object.ToBytes();
279 const auto distinct_bytes = distinct_object.ToBytes();
280 BOOST_CHECK(!std::ranges::equal(object_bytes, distinct_bytes));
281 }
282
283 // Copy constructor
284 T object2(distinct_object);
285 BOOST_CHECK_NE(distinct_object.get(), object2.get());
286 if constexpr (HasToBytes<T>) {
287 check_equal(distinct_object.ToBytes(), object2.ToBytes());
288 }
289
290 // Copy assignment
291 T object3{distinct_object};
292 object2 = object3;
293 BOOST_CHECK_NE(object3.get(), object2.get());
294 if constexpr (HasToBytes<T>) {
295 check_equal(object3.ToBytes(), object2.ToBytes());
296 }
297
298 // Move constructor
299 auto* original_ptr = object2.get();
300 T object4{std::move(object2)};
301 BOOST_CHECK_EQUAL(object4.get(), original_ptr);
302 BOOST_CHECK_EQUAL(object2.get(), nullptr); // NOLINT(bugprone-use-after-move)
303 if constexpr (HasToBytes<T>) {
304 check_equal(object4.ToBytes(), object3.ToBytes());
305 }
306
307 // Move assignment
308 original_ptr = object4.get();
309 object2 = std::move(object4);
310 BOOST_CHECK_EQUAL(object2.get(), original_ptr);
311 BOOST_CHECK_EQUAL(object4.get(), nullptr); // NOLINT(bugprone-use-after-move)
312 if constexpr (HasToBytes<T>) {
313 check_equal(object2.ToBytes(), object3.ToBytes());
314 }
315}
316
317template <typename RangeType>
318 requires std::ranges::random_access_range<RangeType>
319void CheckRange(const RangeType& range, size_t expected_size)
320{
321 using value_type = std::ranges::range_value_t<RangeType>;
322
323 BOOST_CHECK_EQUAL(range.size(), expected_size);
324 BOOST_REQUIRE(range.size() > 0); // Some checks below assume a non-empty range
325 BOOST_REQUIRE(!range.empty());
326
327 BOOST_CHECK(range.begin() != range.end());
328 BOOST_CHECK_EQUAL(std::distance(range.begin(), range.end()), static_cast<std::ptrdiff_t>(expected_size));
329 BOOST_CHECK(range.cbegin() == range.begin());
330 BOOST_CHECK(range.cend() == range.end());
331
332 for (size_t i = 0; i < range.size(); ++i) {
333 BOOST_CHECK_EQUAL(range[i].get(), (*(range.begin() + i)).get());
334 }
335
336 BOOST_CHECK_THROW(range.at(expected_size), std::out_of_range);
337
338 BOOST_CHECK_EQUAL(range.front().get(), range[0].get());
339 BOOST_CHECK_EQUAL(range.back().get(), range[expected_size - 1].get());
340
341 auto it = range.begin();
342 auto it_copy = it;
343 ++it;
344 BOOST_CHECK(it != it_copy);
345 --it;
346 BOOST_CHECK(it == it_copy);
347 it = range.begin();
348 auto old_it = it++;
349 BOOST_CHECK(old_it == range.begin());
350 BOOST_CHECK(it == range.begin() + 1);
351 old_it = it--;
352 BOOST_CHECK(old_it == range.begin() + 1);
353 BOOST_CHECK(it == range.begin());
354
355 it = range.begin();
356 it += 2;
357 BOOST_CHECK(it == range.begin() + 2);
358 it -= 2;
359 BOOST_CHECK(it == range.begin());
360
361 BOOST_CHECK(range.begin() < range.end());
362 BOOST_CHECK(range.begin() <= range.end());
363 BOOST_CHECK(range.end() > range.begin());
364 BOOST_CHECK(range.end() >= range.begin());
365 BOOST_CHECK(range.begin() == range.begin());
366
367 BOOST_CHECK_EQUAL(range.begin()[0].get(), range[0].get());
368
369 size_t count = 0;
370 for (auto rit = range.end(); rit != range.begin();) {
371 --rit;
372 ++count;
373 }
374 BOOST_CHECK_EQUAL(count, expected_size);
375
376 std::vector<value_type> collected;
377 for (const auto& elem : range) {
378 collected.push_back(elem);
379 }
380 BOOST_CHECK_EQUAL(collected.size(), expected_size);
381
382 BOOST_CHECK_EQUAL(std::ranges::size(range), expected_size);
383
384 it = range.begin();
385 auto it2 = 1 + it;
386 BOOST_CHECK(it2 == it + 1);
387}
388
389BOOST_AUTO_TEST_CASE(btck_transaction_tests)
390{
391 auto tx_data{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")};
392 auto tx{Transaction{tx_data}};
393 auto tx_data_2{hex_string_to_byte_vec("02000000000101904f4ee5c87d20090b642f116e458cd6693292ad9ece23e72f15fb6c05b956210500000000fdffffff02e2010000000000002251200839a723933b56560487ec4d67dda58f09bae518ffa7e148313c5696ac837d9f10060000000000002251205826bcdae7abfb1c468204170eab00d887b61ab143464a4a09e1450bdc59a3340140f26e7af574e647355830772946356c27e7bbc773c5293688890f58983499581be84de40be7311a14e6d6422605df086620e75adae84ff06b75ce5894de5e994a00000000")};
394 auto tx2{Transaction{tx_data_2}};
395 CheckHandle(tx, tx2);
396
397 auto invalid_data = hex_string_to_byte_vec("012300");
398 BOOST_CHECK_THROW(Transaction{invalid_data}, std::runtime_error);
399 auto empty_data = hex_string_to_byte_vec("");
400 BOOST_CHECK_THROW(Transaction{empty_data}, std::runtime_error);
401
402 BOOST_CHECK_EQUAL(tx.CountOutputs(), 2);
403 BOOST_CHECK_EQUAL(tx.CountInputs(), 1);
404 BOOST_CHECK_EQUAL(tx.GetLocktime(), 510826);
405 auto broken_tx_data{std::span<std::byte>{tx_data.begin(), tx_data.begin() + 10}};
406 BOOST_CHECK_THROW(Transaction{broken_tx_data}, std::runtime_error);
407 auto input{tx.GetInput(0)};
408 BOOST_CHECK_EQUAL(input.GetSequence(), 0xfffffffe);
409 auto output{tx.GetOutput(tx.CountOutputs() - 1)};
410 BOOST_CHECK_EQUAL(output.Amount(), 42130042);
411 auto script_pubkey{output.GetScriptPubkey()};
412 {
413 auto tx_new{Transaction{tx_data}};
414 // This is safe, because we now use copy assignment
415 TransactionOutput output = tx_new.GetOutput(tx_new.CountOutputs() - 1);
417
418 TransactionOutputView output2 = tx_new.GetOutput(tx_new.CountOutputs() - 1);
419 BOOST_CHECK_NE(output.get(), output2.get());
420 BOOST_CHECK_EQUAL(output.Amount(), output2.Amount());
421 TransactionOutput output3 = output2;
422 BOOST_CHECK_NE(output3.get(), output2.get());
423 BOOST_CHECK_EQUAL(output3.Amount(), output2.Amount());
424
425 // Non-owned view
426 ScriptPubkeyView script2 = output.GetScriptPubkey();
427 BOOST_CHECK_NE(script.get(), script2.get());
428 check_equal(script.ToBytes(), script2.ToBytes());
429
430 // Non-owned to owned
431 ScriptPubkey script3 = script2;
432 BOOST_CHECK_NE(script3.get(), script2.get());
433 check_equal(script3.ToBytes(), script2.ToBytes());
434 }
435 BOOST_CHECK_EQUAL(output.Amount(), 42130042);
436
437 auto tx_roundtrip{Transaction{tx.ToBytes()}};
438 check_equal(tx_roundtrip.ToBytes(), tx_data);
439
440 // The following code is unsafe, but left here to show limitations of the
441 // API, because we preserve the output view beyond the lifetime of the
442 // transaction. The view type wrapper should make this clear to the user.
443 // auto get_output = [&]() -> TransactionOutputView {
444 // auto tx{Transaction{tx_data}};
445 // return tx.GetOutput(0);
446 // };
447 // auto output_new = get_output();
448 // BOOST_CHECK_EQUAL(output_new.Amount(), 20737411);
449
450 int64_t total_amount{0};
451 for (const auto output : tx.Outputs()) {
452 total_amount += output.Amount();
453 }
454 BOOST_CHECK_EQUAL(total_amount, 62867453);
455
456 auto amount = *(tx.Outputs() | std::ranges::views::filter([](const auto& output) {
457 return output.Amount() == 42130042;
458 }) |
459 std::views::transform([](const auto& output) {
460 return output.Amount();
461 })).begin();
462 BOOST_REQUIRE(amount);
463 BOOST_CHECK_EQUAL(amount, 42130042);
464
465 CheckRange(tx.Outputs(), tx.CountOutputs());
466
467 ScriptPubkey script_pubkey_roundtrip{script_pubkey.ToBytes()};
468 check_equal(script_pubkey_roundtrip.ToBytes(), script_pubkey.ToBytes());
469}
470
471BOOST_AUTO_TEST_CASE(btck_script_pubkey)
472{
473 auto script_data{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")};
474 std::vector<std::byte> script_data_2 = script_data;
475 script_data_2.push_back(std::byte{0x51});
476 ScriptPubkey script{script_data};
477 ScriptPubkey script2{script_data_2};
478 CheckHandle(script, script2);
479
480 std::span<std::byte> empty_data{};
481 ScriptPubkey empty_script{empty_data};
482 CheckHandle(script, empty_script);
483}
484
485BOOST_AUTO_TEST_CASE(btck_transaction_output)
486{
487 ScriptPubkey script{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")};
488 TransactionOutput output{script, 1};
489 TransactionOutput output2{script, 2};
490 CheckHandle(output, output2);
491}
492
493BOOST_AUTO_TEST_CASE(btck_transaction_input)
494{
495 Transaction tx{hex_string_to_byte_vec("020000000248c03e66fd371c7033196ce24298628e59ebefa00363026044e0f35e0325a65d000000006a473044022004893432347f39beaa280e99da595681ddb20fc45010176897e6e055d716dbfa022040a9e46648a5d10c33ef7cee5e6cf4b56bd513eae3ae044f0039824b02d0f44c012102982331a52822fd9b62e9b5d120da1d248558fac3da3a3c51cd7d9c8ad3da760efeffffffb856678c6e4c3c84e39e2ca818807049d6fba274b42af3c6d3f9d4b6513212d2000000006a473044022068bcedc7fe39c9f21ad318df2c2da62c2dc9522a89c28c8420ff9d03d2e6bf7b0220132afd752754e5cb1ea2fd0ed6a38ec666781e34b0e93dc9a08f2457842cf5660121033aeb9c079ea3e08ea03556182ab520ce5c22e6b0cb95cee6435ee17144d860cdfeffffff0260d50b00000000001976a914363cc8d55ea8d0500de728ef6d63804ddddbdc9888ac67040f00000000001976a914c303bdc5064bf9c9a8b507b5496bd0987285707988ac6acb0700")};
496 TransactionInput input_0 = tx.GetInput(0);
497 TransactionInput input_1 = tx.GetInput(1);
498 CheckHandle(input_0, input_1);
499 CheckRange(tx.Inputs(), tx.CountInputs());
500 OutPoint point_0 = input_0.OutPoint();
501 OutPoint point_1 = input_1.OutPoint();
502 CheckHandle(point_0, point_1);
503}
504
505BOOST_AUTO_TEST_CASE(btck_precomputed_txdata) {
506 auto tx_data{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")};
507 auto tx{Transaction{tx_data}};
508 auto tx_data_2{hex_string_to_byte_vec("02000000000101904f4ee5c87d20090b642f116e458cd6693292ad9ece23e72f15fb6c05b956210500000000fdffffff02e2010000000000002251200839a723933b56560487ec4d67dda58f09bae518ffa7e148313c5696ac837d9f10060000000000002251205826bcdae7abfb1c468204170eab00d887b61ab143464a4a09e1450bdc59a3340140f26e7af574e647355830772946356c27e7bbc773c5293688890f58983499581be84de40be7311a14e6d6422605df086620e75adae84ff06b75ce5894de5e994a00000000")};
509 auto tx2{Transaction{tx_data_2}};
510 auto precomputed_txdata{PrecomputedTransactionData{
511 /*tx_to=*/tx,
512 /*spent_outputs=*/{},
513 }};
514 auto precomputed_txdata_2{PrecomputedTransactionData{
515 /*tx_to=*/tx2,
516 /*spent_outputs=*/{},
517 }};
518 CheckHandle(precomputed_txdata, precomputed_txdata_2);
519}
520
521BOOST_AUTO_TEST_CASE(btck_script_verify_tests)
522{
523 // Legacy transaction aca326a724eda9a461c10a876534ecd5ae7b27f10f26c3862fb996f80ea2d45d
524 auto legacy_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")}};
525 auto legacy_spending_tx{Transaction{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")}};
527 /*spent_script_pubkey=*/legacy_spent_script_pubkey,
528 /*spending_tx=*/legacy_spending_tx,
529 /*precomputed_txdata=*/nullptr,
530 /*amount=*/0,
531 /*input_index=*/0,
532 /*taproot=*/false);
533
534 // Legacy transaction aca326a724eda9a461c10a876534ecd5ae7b27f10f26c3862fb996f80ea2d45d with precomputed_txdata
535 auto legacy_precomputed_txdata{PrecomputedTransactionData{
536 /*tx_to=*/legacy_spending_tx,
537 /*spent_outputs=*/{},
538 }};
540 /*spent_script_pubkey=*/legacy_spent_script_pubkey,
541 /*spending_tx=*/legacy_spending_tx,
542 /*precomputed_txdata=*/&legacy_precomputed_txdata,
543 /*amount=*/0,
544 /*input_index=*/0,
545 /*taproot=*/false);
546
547 // Segwit transaction 1a3e89644985fbbb41e0dcfe176739813542b5937003c46a07de1e3ee7a4a7f3
548 auto segwit_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("0020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d")}};
549 auto segwit_spending_tx{Transaction{hex_string_to_byte_vec("010000000001011f97548fbbe7a0db7588a66e18d803d0089315aa7d4cc28360b6ec50ef36718a0100000000ffffffff02df1776000000000017a9146c002a686959067f4866b8fb493ad7970290ab728757d29f0000000000220020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d04004730440220565d170eed95ff95027a69b313758450ba84a01224e1f7f130dda46e94d13f8602207bdd20e307f062594022f12ed5017bbf4a055a06aea91c10110a0e3bb23117fc014730440220647d2dc5b15f60bc37dc42618a370b2a1490293f9e5c8464f53ec4fe1dfe067302203598773895b4b16d37485cbe21b337f4e4b650739880098c592553add7dd4355016952210375e00eb72e29da82b89367947f29ef34afb75e8654f6ea368e0acdfd92976b7c2103a1b26313f430c4b15bb1fdce663207659d8cac749a0e53d70eff01874496feff2103c96d495bfdd5ba4145e3e046fee45e84a8a48ad05bd8dbb395c011a32cf9f88053ae00000000")}};
551 /*spent_script_pubkey=*/segwit_spent_script_pubkey,
552 /*spending_tx=*/segwit_spending_tx,
553 /*precomputed_txdata=*/nullptr,
554 /*amount=*/18393430,
555 /*input_index=*/0,
556 /*taproot=*/false);
557
558 // Segwit transaction 1a3e89644985fbbb41e0dcfe176739813542b5937003c46a07de1e3ee7a4a7f3 with precomputed_txdata
559 auto segwit_precomputed_txdata{PrecomputedTransactionData{
560 /*tx_to=*/segwit_spending_tx,
561 /*spent_outputs=*/{},
562 }};
564 /*spent_script_pubkey=*/segwit_spent_script_pubkey,
565 /*spending_tx=*/segwit_spending_tx,
566 /*precomputed_txdata=*/&segwit_precomputed_txdata,
567 /*amount=*/18393430,
568 /*input_index=*/0,
569 /*taproot=*/false);
570
571 // Taproot transaction 33e794d097969002ee05d336686fc03c9e15a597c1b9827669460fac98799036
572 auto taproot_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("5120339ce7e165e67d93adb3fef88a6d4beed33f01fa876f05a225242b82a631abc0")}};
573 auto taproot_spending_tx{Transaction{hex_string_to_byte_vec("01000000000101d1f1c1f8cdf6759167b90f52c9ad358a369f95284e841d7a2536cef31c0549580100000000fdffffff020000000000000000316a2f49206c696b65205363686e6f7272207369677320616e6420492063616e6e6f74206c69652e204062697462756734329e06010000000000225120a37c3903c8d0db6512e2b40b0dffa05e5a3ab73603ce8c9c4b7771e5412328f90140a60c383f71bac0ec919b1d7dbc3eb72dd56e7aa99583615564f9f99b8ae4e837b758773a5b2e4c51348854c8389f008e05029db7f464a5ff2e01d5e6e626174affd30a00")}};
574 std::vector<TransactionOutput> taproot_spent_outputs;
575 taproot_spent_outputs.emplace_back(taproot_spent_script_pubkey, 88480);
576 auto taproot_precomputed_txdata{PrecomputedTransactionData{
577 /*tx_to=*/taproot_spending_tx,
578 /*spent_outputs=*/taproot_spent_outputs,
579 }};
581 /*spent_script_pubkey=*/taproot_spent_script_pubkey,
582 /*spending_tx=*/taproot_spending_tx,
583 /*precomputed_txdata=*/&taproot_precomputed_txdata,
584 /*amount=*/88480,
585 /*input_index=*/0,
586 /*taproot=*/true);
587
588 // Two-input taproot transaction e8e8320f40c31ed511570e9cdf1d241f8ec9a5cc392e6105240ac8dbea2098de
589 auto taproot2_spent_script_pubkey0{ScriptPubkey{hex_string_to_byte_vec("5120b7da80f57e36930b0515eb09293e25858d13e6b91fee6184943f5a584cb4248e")}};
590 auto taproot2_spent_script_pubkey1{ScriptPubkey{hex_string_to_byte_vec("5120ab78e077d062e7b8acd7063668b4db5355a1b5d5fd2a46a8e98e62e5e63fab77")}};
591 auto taproot2_spending_tx{Transaction{hex_string_to_byte_vec("02000000000102c0f01ead18750892c84b1d4f595149ad38f16847df1fbf490e235b3b78c1f98a0100000000ffffffff456764a19c2682bf5b1567119f06a421849ad1664cf42b5ef95b69d6e2159e9d0000000000ffffffff022202000000000000225120b6c0c2a8ee25a2ae0322ab7f1a06f01746f81f6b90d179c3c2a51a356e6188f1d70e020000000000225120b7da80f57e36930b0515eb09293e25858d13e6b91fee6184943f5a584cb4248e0141933fdc49eb1af1f08ed1e9cf5559259309a8acd25ff1e6999b6955124438aef4fceaa4e6a5f85286631e24837329563595bc3cf4b31e1c687442abb01c4206818101401c9620faf1e8c84187762ad14d04ae3857f59a2f03f1dcbb99290e16dfc572a63b4ea435780a5787af59beb5742fd71cda8a95381517a1ff14b4c67996c4bf8100000000")}};
592 std::vector<TransactionOutput> taproot2_spent_outputs;
593 taproot2_spent_outputs.emplace_back(taproot2_spent_script_pubkey0, 546);
594 taproot2_spent_outputs.emplace_back(taproot2_spent_script_pubkey1, 135125);
595 auto taproot2_precomputed_txdata{PrecomputedTransactionData{
596 /*tx_to=*/taproot2_spending_tx,
597 /*spent_outputs=*/taproot2_spent_outputs,
598 }};
600 /*spent_script_pubkey=*/taproot2_spent_script_pubkey0,
601 /*spending_tx=*/taproot2_spending_tx,
602 /*precomputed_txdata=*/&taproot2_precomputed_txdata,
603 /*amount=*/546,
604 /*input_index=*/0,
605 /*taproot=*/true);
607 /*spent_script_pubkey=*/taproot2_spent_script_pubkey1,
608 /*spending_tx=*/taproot2_spending_tx,
609 /*precomputed_txdata=*/&taproot2_precomputed_txdata,
610 /*amount=*/135125,
611 /*input_index=*/1,
612 /*taproot=*/true);
613}
614
616{
617 btck_LoggingOptions logging_options = {
618 .log_timestamps = true,
619 .log_time_micros = true,
620 .log_threadnames = false,
621 .log_sourcelocations = false,
622 .always_print_category_levels = true,
623 };
624
625 logging_set_options(logging_options);
626 logging_set_level_category(LogCategory::BENCH, LogLevel::TRACE_LEVEL);
630
631 // Check that connecting, connecting another, and then disconnecting and connecting a logger again works.
632 {
633 logging_set_level_category(LogCategory::KERNEL, LogLevel::TRACE_LEVEL);
635 Logger logger{std::make_unique<TestLog>()};
636 Logger logger_2{std::make_unique<TestLog>()};
637 }
638 Logger logger{std::make_unique<TestLog>()};
639}
640
641BOOST_AUTO_TEST_CASE(btck_context_tests)
642{
643 { // test default context
644 Context context{};
645 Context context2{};
646 CheckHandle(context, context2);
647 }
648
649 { // test with context options, but not options set
650 ContextOptions options{};
651 Context context{options};
652 }
653
654 { // test with context options
655 ContextOptions options{};
656 ChainParams params{ChainType::MAINNET};
657 ChainParams regtest_params{ChainType::REGTEST};
658 CheckHandle(params, regtest_params);
659 options.SetChainParams(params);
660 options.SetNotifications(std::make_shared<TestKernelNotifications>());
661 Context context{options};
662 }
663}
664
665BOOST_AUTO_TEST_CASE(btck_block_header_tests)
666{
667 // Block header format: version(4) + prev_hash(32) + merkle_root(32) + timestamp(4) + bits(4) + nonce(4) = 80 bytes
668 BlockHeader header_0{hex_string_to_byte_vec("00e07a26beaaeee2e71d7eb19279545edbaf15de0999983626ec00000000000000000000579cf78b65229bfb93f4a11463af2eaa5ad91780f27f5d147a423bea5f7e4cdf2a47e268b4dd01173a9662ee")};
669 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(header_0.Hash().ToBytes()), "00000000000000000000325c7e14a4ee3b4fcb2343089a839287308a0ddbee4f");
670 BlockHeader header_1{hex_string_to_byte_vec("00c00020e7cb7b4de21d26d55bd384017b8bb9333ac3b2b55bed00000000000000000000d91b4484f801b99f03d36b9d26cfa83420b67f81da12d7e6c1e7f364e743c5ba9946e268b4dd011799c8533d")};
671 CheckHandle(header_0, header_1);
672
673 // Test error handling for invalid data
674 BOOST_CHECK_THROW(BlockHeader{hex_string_to_byte_vec("00")}, std::runtime_error);
675 BOOST_CHECK_THROW(BlockHeader{hex_string_to_byte_vec("")}, std::runtime_error);
676
677 // Test all header field accessors using mainnet block 1
678 auto mainnet_block_1_header = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e36299");
679 BlockHeader header{mainnet_block_1_header};
680 BOOST_CHECK_EQUAL(header.Version(), 1);
681 BOOST_CHECK_EQUAL(header.Timestamp(), 1231469665);
682 BOOST_CHECK_EQUAL(header.Bits(), 0x1d00ffff);
683 BOOST_CHECK_EQUAL(header.Nonce(), 2573394689);
684 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(header.Hash().ToBytes()), "00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048");
685 auto prev_hash = header.PrevHash();
686 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(prev_hash.ToBytes()), "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f");
687
688 auto raw_block = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000");
689 Block block{raw_block};
690 BlockHeader block_header{block.GetHeader()};
691 BOOST_CHECK_EQUAL(block_header.Version(), 1);
692 BOOST_CHECK_EQUAL(block_header.Timestamp(), 1231469665);
693 BOOST_CHECK_EQUAL(block_header.Bits(), 0x1d00ffff);
694 BOOST_CHECK_EQUAL(block_header.Nonce(), 2573394689);
695 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(block_header.Hash().ToBytes()), "00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048");
696}
697
699{
702 CheckHandle(block, block_100);
704 CheckRange(block_tx.Transactions(), block_tx.CountTransactions());
705 auto invalid_data = hex_string_to_byte_vec("012300");
706 BOOST_CHECK_THROW(Block{invalid_data}, std::runtime_error);
707 auto empty_data = hex_string_to_byte_vec("");
708 BOOST_CHECK_THROW(Block{empty_data}, std::runtime_error);
709}
710
711Context create_context(std::shared_ptr<TestKernelNotifications> notifications, ChainType chain_type, std::shared_ptr<TestValidationInterface> validation_interface = nullptr)
712{
713 ContextOptions options{};
714 ChainParams params{chain_type};
715 options.SetChainParams(params);
716 options.SetNotifications(notifications);
717 if (validation_interface) {
718 options.SetValidationInterface(validation_interface);
719 }
720 auto context{Context{options}};
721 return context;
722}
723
724BOOST_AUTO_TEST_CASE(btck_chainman_tests)
725{
726 Logger logger{std::make_unique<TestLog>()};
727 auto test_directory{TestDirectory{"chainman_test_bitcoin_kernel"}};
728
729 { // test with default context
730 Context context{};
731 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
732 ChainMan chainman{context, chainman_opts};
733 }
734
735 { // test with default context options
736 ContextOptions options{};
737 Context context{options};
738 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
739 ChainMan chainman{context, chainman_opts};
740 }
741 { // null or empty data_directory or blocks_directory are not allowed
742 Context context{};
743 auto valid_dir{PathToString(test_directory.m_directory)};
744 std::vector<std::pair<std::string_view, std::string_view>> illegal_cases{
745 {"", valid_dir},
746 {valid_dir, {nullptr, 0}},
747 {"", ""},
748 {{nullptr, 0}, {nullptr, 0}},
749 };
750 for (auto& [data_dir, blocks_dir] : illegal_cases) {
751 BOOST_CHECK_THROW(ChainstateManagerOptions(context, data_dir, blocks_dir),
752 std::runtime_error);
753 };
754 }
755
756 auto notifications{std::make_shared<TestKernelNotifications>()};
757 auto context{create_context(notifications, ChainType::MAINNET)};
758
759 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
760 chainman_opts.SetWorkerThreads(4);
761 BOOST_CHECK(!chainman_opts.SetWipeDbs(/*wipe_block_tree=*/true, /*wipe_chainstate=*/false));
762 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/true, /*wipe_chainstate=*/true));
763 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/true));
764 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/false));
765 ChainMan chainman{context, chainman_opts};
766}
767
768std::unique_ptr<ChainMan> create_chainman(TestDirectory& test_directory,
769 bool reindex,
770 bool wipe_chainstate,
771 bool block_tree_db_in_memory,
772 bool chainstate_db_in_memory,
773 Context& context)
774{
775 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
776
777 if (reindex) {
778 chainman_opts.SetWipeDbs(/*wipe_block_tree=*/reindex, /*wipe_chainstate=*/reindex);
779 }
780 if (wipe_chainstate) {
781 chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/wipe_chainstate);
782 }
783 if (block_tree_db_in_memory) {
784 chainman_opts.UpdateBlockTreeDbInMemory(block_tree_db_in_memory);
785 }
786 if (chainstate_db_in_memory) {
787 chainman_opts.UpdateChainstateDbInMemory(chainstate_db_in_memory);
788 }
789
790 auto chainman{std::make_unique<ChainMan>(context, chainman_opts)};
791 return chainman;
792}
793
795{
796 auto notifications{std::make_shared<TestKernelNotifications>()};
797 auto context{create_context(notifications, ChainType::MAINNET)};
798 auto chainman{create_chainman(
799 test_directory, /*reindex=*/true, /*wipe_chainstate=*/false,
800 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
801
802 std::vector<std::string> import_files;
803 BOOST_CHECK(chainman->ImportBlocks(import_files));
804
805 // Sanity check some block retrievals
806 auto chain{chainman->GetChain()};
807 BOOST_CHECK_THROW(chain.GetByHeight(1000), std::runtime_error);
808 auto genesis_index{chain.Entries().front()};
809 BOOST_CHECK(!genesis_index.GetPrevious());
810 auto genesis_block_raw{chainman->ReadBlock(genesis_index).value().ToBytes()};
811 auto first_index{chain.GetByHeight(0)};
812 auto first_block_raw{chainman->ReadBlock(genesis_index).value().ToBytes()};
813 check_equal(genesis_block_raw, first_block_raw);
814 auto height{first_index.GetHeight()};
815 BOOST_CHECK_EQUAL(height, 0);
816
817 auto next_index{chain.GetByHeight(first_index.GetHeight() + 1)};
818 BOOST_CHECK(chain.Contains(next_index));
819 auto next_block_data{chainman->ReadBlock(next_index).value().ToBytes()};
820 auto tip_index{chain.Entries().back()};
821 auto tip_block_data{chainman->ReadBlock(tip_index).value().ToBytes()};
822 auto second_index{chain.GetByHeight(1)};
823 auto second_block{chainman->ReadBlock(second_index).value()};
824 auto second_block_data{second_block.ToBytes()};
825 auto second_height{second_index.GetHeight()};
826 BOOST_CHECK_EQUAL(second_height, 1);
827 check_equal(next_block_data, tip_block_data);
828 check_equal(next_block_data, second_block_data);
829
830 auto second_hash{second_index.GetHash()};
831 auto another_second_index{chainman->GetBlockTreeEntry(second_hash)};
832 BOOST_CHECK(another_second_index);
833 auto another_second_height{another_second_index->GetHeight()};
834 auto second_block_hash{second_block.GetHash()};
835 check_equal(second_block_hash.ToBytes(), second_hash.ToBytes());
836 BOOST_CHECK_EQUAL(second_height, another_second_height);
837}
838
840{
841 auto notifications{std::make_shared<TestKernelNotifications>()};
842 auto context{create_context(notifications, ChainType::MAINNET)};
843 auto chainman{create_chainman(
844 test_directory, /*reindex=*/false, /*wipe_chainstate=*/true,
845 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
846
847 std::vector<std::string> import_files;
848 import_files.push_back(PathToString(test_directory.m_directory / "blocks" / "blk00000.dat"));
849 BOOST_CHECK(chainman->ImportBlocks(import_files));
850}
851
853{
854 auto notifications{std::make_shared<TestKernelNotifications>()};
855 auto validation_interface{std::make_shared<TestValidationInterface>()};
856 auto context{create_context(notifications, ChainType::MAINNET, validation_interface)};
857 auto chainman{create_chainman(
858 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
859 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
860
861 // mainnet block 1
862 auto raw_block = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000");
863 Block block{raw_block};
864 BlockHeader header{block.GetHeader()};
865 TransactionView tx{block.GetTransaction(block.CountTransactions() - 1)};
866 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(tx.Txid().ToBytes()), "0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
867 BOOST_CHECK_EQUAL(header.Version(), 1);
868 BOOST_CHECK_EQUAL(header.Timestamp(), 1231469665);
869 BOOST_CHECK_EQUAL(header.Bits(), 0x1d00ffff);
870 BOOST_CHECK_EQUAL(header.Nonce(), 2573394689);
871 BOOST_CHECK_EQUAL(tx.CountInputs(), 1);
872 Transaction tx2 = tx;
874 for (auto transaction : block.Transactions()) {
875 BOOST_CHECK_EQUAL(transaction.CountInputs(), 1);
876 }
877 auto output_counts = *(block.Transactions() | std::views::transform([](const auto& tx) {
878 return tx.CountOutputs();
879 })).begin();
880 BOOST_CHECK_EQUAL(output_counts, 1);
881
882 validation_interface->m_expected_valid_block.emplace(raw_block);
883 auto ser_block{block.ToBytes()};
884 check_equal(ser_block, raw_block);
885 bool new_block = false;
886 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
887 BOOST_CHECK(new_block);
888
889 validation_interface->m_expected_valid_block = std::nullopt;
890 new_block = false;
892 BOOST_CHECK(!chainman->ProcessBlock(invalid_block, &new_block));
893 BOOST_CHECK(!new_block);
894
895 auto chain{chainman->GetChain()};
896 BOOST_CHECK_EQUAL(chain.Height(), 1);
897 auto tip{chain.Entries().back()};
898 auto read_block{chainman->ReadBlock(tip)};
899 BOOST_REQUIRE(read_block);
900 check_equal(read_block.value().ToBytes(), raw_block);
901
902 // Check that we can read the previous block
903 BlockTreeEntry tip_2{*tip.GetPrevious()};
904 Block read_block_2{*chainman->ReadBlock(tip_2)};
905 BOOST_CHECK_EQUAL(chainman->ReadBlockSpentOutputs(tip_2).Count(), 0);
906 BOOST_CHECK_EQUAL(chainman->ReadBlockSpentOutputs(tip).Count(), 0);
907
908 // It should be an error if we go another block back, since the genesis has no ancestor
909 BOOST_CHECK(!tip_2.GetPrevious());
910
911 // If we try to validate it again, it should be a duplicate
912 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
913 BOOST_CHECK(!new_block);
914}
915
916BOOST_AUTO_TEST_CASE(btck_chainman_mainnet_tests)
917{
918 auto test_directory{TestDirectory{"mainnet_test_bitcoin_kernel"}};
919 chainman_mainnet_validation_test(test_directory);
920 chainman_reindex_test(test_directory);
921 chainman_reindex_chainstate_test(test_directory);
922}
923
924BOOST_AUTO_TEST_CASE(btck_block_hash_tests)
925{
926 std::array<std::byte, 32> test_hash;
927 std::array<std::byte, 32> test_hash_2;
928 for (int i = 0; i < 32; ++i) {
929 test_hash[i] = static_cast<std::byte>(i);
930 test_hash_2[i] = static_cast<std::byte>(i + 1);
931 }
932 BlockHash block_hash{test_hash};
933 BlockHash block_hash_2{test_hash_2};
934 BOOST_CHECK(block_hash != block_hash_2);
935 BOOST_CHECK(block_hash == block_hash);
936 CheckHandle(block_hash, block_hash_2);
937}
938
939BOOST_AUTO_TEST_CASE(btck_block_tree_entry_tests)
940{
941 auto test_directory{TestDirectory{"block_tree_entry_test_bitcoin_kernel"}};
942 auto notifications{std::make_shared<TestKernelNotifications>()};
943 auto context{create_context(notifications, ChainType::REGTEST)};
944 auto chainman{create_chainman(
945 test_directory,
946 /*reindex=*/false,
947 /*wipe_chainstate=*/false,
948 /*block_tree_db_in_memory=*/true,
949 /*chainstate_db_in_memory=*/true,
950 context)};
951
952 // Process a couple of blocks
953 for (size_t i{0}; i < 3; i++) {
955 bool new_block{false};
956 chainman->ProcessBlock(block, &new_block);
957 BOOST_CHECK(new_block);
958 }
959
960 auto chain{chainman->GetChain()};
961 auto entry_0{chain.GetByHeight(0)};
962 auto entry_1{chain.GetByHeight(1)};
963 auto entry_2{chain.GetByHeight(2)};
964
965 // Test inequality
966 BOOST_CHECK(entry_0 != entry_1);
967 BOOST_CHECK(entry_1 != entry_2);
968 BOOST_CHECK(entry_0 != entry_2);
969
970 // Test equality with same entry
971 BOOST_CHECK(entry_0 == chain.GetByHeight(0));
972 BOOST_CHECK(entry_0 == BlockTreeEntry{entry_0});
973 BOOST_CHECK(entry_1 == entry_1);
974
975 // Test GetPrevious
976 auto prev{entry_1.GetPrevious()};
977 BOOST_CHECK(prev.has_value());
978 BOOST_CHECK(prev.value() == entry_0);
979}
980
981BOOST_AUTO_TEST_CASE(btck_chainman_in_memory_tests)
982{
983 auto in_memory_test_directory{TestDirectory{"in-memory_test_bitcoin_kernel"}};
984
985 auto notifications{std::make_shared<TestKernelNotifications>()};
986 auto context{create_context(notifications, ChainType::REGTEST)};
987 auto chainman{create_chainman(
988 in_memory_test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
989 /*block_tree_db_in_memory=*/true, /*chainstate_db_in_memory=*/true, context)};
990
991 for (auto& raw_block : REGTEST_BLOCK_DATA) {
992 Block block{hex_string_to_byte_vec(raw_block)};
993 bool new_block{false};
994 chainman->ProcessBlock(block, &new_block);
995 BOOST_CHECK(new_block);
996 }
997
998 BOOST_CHECK(fs::exists(in_memory_test_directory.m_directory / "blocks"));
999 BOOST_CHECK(!fs::exists(in_memory_test_directory.m_directory / "blocks" / "index"));
1000 BOOST_CHECK(!fs::exists(in_memory_test_directory.m_directory / "chainstate"));
1001
1002 BOOST_CHECK(context.interrupt());
1003}
1004
1005BOOST_AUTO_TEST_CASE(btck_chainman_regtest_tests)
1006{
1007 auto test_directory{TestDirectory{"regtest_test_bitcoin_kernel"}};
1008
1009 auto notifications{std::make_shared<TestKernelNotifications>()};
1010 auto context{create_context(notifications, ChainType::REGTEST)};
1011
1012 {
1013 auto chainman{create_chainman(
1014 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1015 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1016 for (const auto& data : REGTEST_BLOCK_DATA) {
1018 BlockHeader header = block.GetHeader();
1019 BlockValidationState state{};
1020 BOOST_CHECK(state.GetBlockValidationResult() == BlockValidationResult::UNSET);
1021 BOOST_CHECK(chainman->ProcessBlockHeader(header, state));
1022 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1023 BlockTreeEntry entry{*chainman->GetBlockTreeEntry(header.Hash())};
1024 BOOST_CHECK(!chainman->GetChain().Contains(entry));
1025 BlockTreeEntry best_entry{chainman->GetBestEntry()};
1026 BlockHash hash{entry.GetHash()};
1027 BOOST_CHECK(hash == best_entry.GetHeader().Hash());
1028 }
1029 }
1030
1031 // Validate 206 regtest blocks in total.
1032 // Stop halfway to check that it is possible to continue validating starting
1033 // from prior state.
1034 const size_t mid{REGTEST_BLOCK_DATA.size() / 2};
1035
1036 {
1037 auto chainman{create_chainman(
1038 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1039 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1040 for (size_t i{0}; i < mid; i++) {
1042 bool new_block{false};
1043 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
1044 BOOST_CHECK(new_block);
1045 }
1046 }
1047
1048 auto chainman{create_chainman(
1049 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1050 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1051
1052 for (size_t i{mid}; i < REGTEST_BLOCK_DATA.size(); i++) {
1054 bool new_block{false};
1055 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
1056 BOOST_CHECK(new_block);
1057 }
1058
1059 auto chain = chainman->GetChain();
1060 auto tip = chain.Entries().back();
1061 auto read_block = chainman->ReadBlock(tip).value();
1062 check_equal(read_block.ToBytes(), hex_string_to_byte_vec(REGTEST_BLOCK_DATA[REGTEST_BLOCK_DATA.size() - 1]));
1063
1064 auto tip_2 = tip.GetPrevious().value();
1065 auto read_block_2 = chainman->ReadBlock(tip_2).value();
1066 check_equal(read_block_2.ToBytes(), hex_string_to_byte_vec(REGTEST_BLOCK_DATA[REGTEST_BLOCK_DATA.size() - 2]));
1067
1068 Txid txid = read_block.Transactions()[0].Txid();
1069 Txid txid_2 = read_block_2.Transactions()[0].Txid();
1070 BOOST_CHECK(txid != txid_2);
1071 BOOST_CHECK(txid == txid);
1072 CheckHandle(txid, txid_2);
1073
1074 auto find_transaction = [&chainman](const TxidView& target_txid) -> std::optional<Transaction> {
1075 auto chain = chainman->GetChain();
1076 for (const auto block_tree_entry : chain.Entries()) {
1077 auto block{chainman->ReadBlock(block_tree_entry)};
1078 for (const TransactionView transaction : block->Transactions()) {
1079 if (transaction.Txid() == target_txid) {
1080 return Transaction{transaction};
1081 }
1082 }
1083 }
1084 return std::nullopt;
1085 };
1086
1087 for (const auto block_tree_entry : chain.Entries()) {
1088 auto block{chainman->ReadBlock(block_tree_entry)};
1089 for (const auto transaction : block->Transactions()) {
1090 std::vector<TransactionInput> inputs;
1091 std::vector<TransactionOutput> spent_outputs;
1092 for (const auto input : transaction.Inputs()) {
1093 OutPointView point = input.OutPoint();
1094 if (point.index() == std::numeric_limits<uint32_t>::max()) {
1095 continue;
1096 }
1097 inputs.emplace_back(input);
1098 BOOST_CHECK(point.Txid() != transaction.Txid());
1099 std::optional<Transaction> tx = find_transaction(point.Txid());
1100 BOOST_CHECK(tx.has_value());
1101 BOOST_CHECK(point.Txid() == tx->Txid());
1102 spent_outputs.emplace_back(tx->GetOutput(point.index()));
1103 }
1104 BOOST_CHECK(inputs.size() == spent_outputs.size());
1105 ScriptVerifyStatus status = ScriptVerifyStatus::OK;
1106 const PrecomputedTransactionData precomputed_txdata{transaction, spent_outputs};
1107 for (size_t i{0}; i < inputs.size(); ++i) {
1108 BOOST_CHECK(spent_outputs[i].GetScriptPubkey().Verify(spent_outputs[i].Amount(), transaction, &precomputed_txdata, i, ScriptVerificationFlags::ALL, status));
1109 }
1110 }
1111 }
1112
1113 // Read spent outputs for current tip and its previous block
1114 BlockSpentOutputs block_spent_outputs{chainman->ReadBlockSpentOutputs(tip)};
1115 BlockSpentOutputs block_spent_outputs_prev{chainman->ReadBlockSpentOutputs(*tip.GetPrevious())};
1116 CheckHandle(block_spent_outputs, block_spent_outputs_prev);
1117 CheckRange(block_spent_outputs_prev.TxsSpentOutputs(), block_spent_outputs_prev.Count());
1118 BOOST_CHECK_EQUAL(block_spent_outputs.Count(), 1);
1119
1120 // Get transaction spent outputs from the last transaction in the two blocks
1121 TransactionSpentOutputsView transaction_spent_outputs{block_spent_outputs.GetTxSpentOutputs(block_spent_outputs.Count() - 1)};
1122 TransactionSpentOutputs owned_transaction_spent_outputs{transaction_spent_outputs};
1123 TransactionSpentOutputs owned_transaction_spent_outputs_prev{block_spent_outputs_prev.GetTxSpentOutputs(block_spent_outputs_prev.Count() - 1)};
1124 CheckHandle(owned_transaction_spent_outputs, owned_transaction_spent_outputs_prev);
1125 CheckRange(transaction_spent_outputs.Coins(), transaction_spent_outputs.Count());
1126
1127 // Get the last coin from the transaction spent outputs
1128 CoinView coin{transaction_spent_outputs.GetCoin(transaction_spent_outputs.Count() - 1)};
1129 BOOST_CHECK(!coin.IsCoinbase());
1130 Coin owned_coin{coin};
1131 Coin owned_coin_prev{owned_transaction_spent_outputs_prev.GetCoin(owned_transaction_spent_outputs_prev.Count() - 1)};
1132 CheckHandle(owned_coin, owned_coin_prev);
1133
1134 // Validate coin properties
1135 TransactionOutputView output = coin.GetOutput();
1136 uint32_t coin_height = coin.GetConfirmationHeight();
1137 BOOST_CHECK_EQUAL(coin_height, 205);
1138 BOOST_CHECK_EQUAL(output.Amount(), 100000000);
1139
1140 // Test script pubkey serialization
1141 auto script_pubkey = output.GetScriptPubkey();
1142 auto script_pubkey_bytes{script_pubkey.ToBytes()};
1143 BOOST_CHECK_EQUAL(script_pubkey_bytes.size(), 22);
1144 auto round_trip_script_pubkey{ScriptPubkey(script_pubkey_bytes)};
1145 BOOST_CHECK_EQUAL(round_trip_script_pubkey.ToBytes().size(), 22);
1146
1147 for (const auto tx_spent_outputs : block_spent_outputs.TxsSpentOutputs()) {
1148 for (const auto coins : tx_spent_outputs.Coins()) {
1149 BOOST_CHECK_GT(coins.GetOutput().Amount(), 1);
1150 }
1151 }
1152
1153 CheckRange(chain.Entries(), chain.CountEntries());
1154
1155 for (const BlockTreeEntry entry : chain.Entries()) {
1156 std::optional<Block> block{chainman->ReadBlock(entry)};
1157 if (block) {
1158 for (const TransactionView transaction : block->Transactions()) {
1159 for (const TransactionOutputView output : transaction.Outputs()) {
1160 // skip data carrier outputs
1161 if ((unsigned char)output.GetScriptPubkey().ToBytes()[0] == 0x6a) {
1162 continue;
1163 }
1164 BOOST_CHECK_GT(output.Amount(), 1);
1165 }
1166 }
1167 }
1168 }
1169
1170 int32_t count{0};
1171 for (const auto entry : chain.Entries()) {
1172 BOOST_CHECK_EQUAL(entry.GetHeight(), count);
1173 ++count;
1174 }
1175 BOOST_CHECK_EQUAL(count, chain.CountEntries());
1176
1177
1178 fs::remove(test_directory.m_directory / "blocks" / "blk00000.dat");
1179 BOOST_CHECK(!chainman->ReadBlock(tip_2).has_value());
1180 fs::remove(test_directory.m_directory / "blocks" / "rev00000.dat");
1181 BOOST_CHECK_THROW(chainman->ReadBlockSpentOutputs(tip), std::runtime_error);
1182}
constexpr std::array< std::string_view, 206 > REGTEST_BLOCK_DATA
Definition: block_data.h:9
void HeaderTipHandler(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
void FlushErrorHandler(std::string_view error) override
void FatalErrorHandler(std::string_view error) override
void WarningUnsetHandler(Warning warning) override
void WarningSetHandler(Warning warning, std::string_view message) override
void LogMessage(std::string_view message)
Definition: test_kernel.cpp:94
void PowValidBlock(BlockTreeEntry entry, Block block) override
void BlockDisconnected(Block block, BlockTreeEntry entry) override
std::optional< std::string > m_expected_valid_block
void BlockChecked(Block block, BlockValidationStateView state) override
void BlockConnected(Block block, BlockTreeEntry entry) override
std::vector< std::byte > ToBytes() const
std::optional< BlockTreeEntry > GetPrevious() const
ValidationMode GetValidationMode() const
BlockValidationResult GetBlockValidationResult() const
void SetWorkerThreads(int worker_threads)
uint32_t index() const
std::vector< std::byte > ToBytes() const
bool Verify(int64_t amount, const Transaction &tx_to, const PrecomputedTransactionData *precomputed_txdata, unsigned int input_index, ScriptVerificationFlags flags, ScriptVerifyStatus &status) const
std::vector< std::byte > ToBytes() const
ScriptPubkeyView GetScriptPubkey() const
Txid(const TxidView &view)
const CType * get() const
static bool exists(const path &p)
Definition: fs.h:95
#define T(expected, seed, data)
@ ALL
Definition: categories.h:49
@ VALIDATION
Definition: categories.h:37
@ BENCH
Definition: categories.h:20
@ KERNEL
Definition: categories.h:47
void logging_set_options(const btck_LoggingOptions &logging_options)
void logging_set_level_category(LogCategory category, LogLevel level)
void logging_enable_category(LogCategory category)
void logging_disable_category(LogCategory category)
static const auto INVALID
A stack representing the lack of any (dis)satisfactions.
Definition: miniscript.h:351
#define BOOST_CHECK_THROW(stmt, excMatch)
Definition: object.cpp:18
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:17
#define BOOST_CHECK(expr)
Definition: object.cpp:16
static bool Verify(const CScript &scriptSig, const CScript &scriptPubKey, bool fStrict, ScriptError &err)
fs::path m_directory
TestDirectory(std::string directory_name)
Options controlling the format of log messages.
int log_timestamps
Prepend a timestamp to log messages.
std::string byte_span_to_hex_string_reversed(std::span< const std::byte > bytes)
Definition: test_kernel.cpp:64
void chainman_reindex_chainstate_test(TestDirectory &test_directory)
Context create_context(std::shared_ptr< TestKernelNotifications > notifications, ChainType chain_type, std::shared_ptr< TestValidationInterface > validation_interface=nullptr)
void run_verify_test(const ScriptPubkey &spent_script_pubkey, const Transaction &spending_tx, const PrecomputedTransactionData *precomputed_txdata, int64_t amount, unsigned int input_index, bool taproot)
std::vector< std::byte > hex_string_to_byte_vec(std::string_view hex)
Definition: test_kernel.cpp:47
void chainman_reindex_test(TestDirectory &test_directory)
BOOST_AUTO_TEST_CASE(btck_transaction_tests)
void check_equal(std::span< const std::byte > _actual, std::span< const std::byte > _expected, bool equal=true)
Definition: test_kernel.cpp:82
void CheckHandle(T object, T distinct_object)
std::unique_ptr< ChainMan > create_chainman(TestDirectory &test_directory, bool reindex, bool wipe_chainstate, bool block_tree_db_in_memory, bool chainstate_db_in_memory, Context &context)
constexpr auto VERIFY_ALL_PRE_SEGWIT
Definition: test_kernel.cpp:77
void CheckRange(const RangeType &range, size_t expected_size)
void chainman_mainnet_validation_test(TestDirectory &test_directory)
std::string random_string(uint32_t length)
Definition: test_kernel.cpp:29
constexpr auto VERIFY_ALL_PRE_TAPROOT
Definition: test_kernel.cpp:80
static int count