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