Bitcoin Core 32.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/byte_units.h>
8#include <util/fs.h>
9
10// Boost.Test's SIGSTKSZ alternate stack can be smaller than Linux requires on musl.
11#define BOOST_TEST_DISABLE_ALT_STACK
12#define BOOST_TEST_MODULE Bitcoin Kernel Test Suite
13#include <boost/test/included/unit_test.hpp>
14
16#include <test/util/common.h>
17
18#include <algorithm>
19#include <charconv>
20#include <concepts>
21#include <cstdint>
22#include <cstdlib>
23#include <iostream>
24#include <memory>
25#include <optional>
26#include <random>
27#include <ranges>
28#include <span>
29#include <string>
30#include <string_view>
31#include <vector>
32
33using namespace btck;
34
35std::string random_string(uint32_t length)
36{
37 const std::string chars = "0123456789"
38 "abcdefghijklmnopqrstuvwxyz"
39 "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
40
41 static std::random_device rd;
42 static std::default_random_engine dre{rd()};
43 static std::uniform_int_distribution<> distribution(0, chars.size() - 1);
44
45 std::string random;
46 random.reserve(length);
47 for (uint32_t i = 0; i < length; i++) {
48 random += chars[distribution(dre)];
49 }
50 return random;
51}
52
53std::vector<std::byte> hex_string_to_byte_vec(std::string_view hex)
54{
55 std::vector<std::byte> bytes;
56 bytes.reserve(hex.length() / 2);
57
58 for (size_t i{0}; i < hex.length(); i += 2) {
59 uint8_t byte_value;
60 auto [ptr, ec] = std::from_chars(hex.data() + i, hex.data() + i + 2, byte_value, 16);
61
62 if (ec != std::errc{} || ptr != hex.data() + i + 2) {
63 throw std::invalid_argument("Invalid hex character");
64 }
65 bytes.push_back(static_cast<std::byte>(byte_value));
66 }
67 return bytes;
68}
69
70std::string byte_span_to_hex_string_reversed(std::span<const std::byte> bytes)
71{
72 std::ostringstream oss;
73
74 // Iterate in reverse order
75 for (auto it = bytes.rbegin(); it != bytes.rend(); ++it) {
76 oss << std::hex << std::setw(2) << std::setfill('0')
77 << static_cast<unsigned int>(static_cast<uint8_t>(*it));
78 }
79
80 return oss.str();
81}
82
83constexpr auto VERIFY_ALL_PRE_SEGWIT{ScriptVerificationFlags::P2SH | ScriptVerificationFlags::DERSIG |
84 ScriptVerificationFlags::NULLDUMMY | ScriptVerificationFlags::CHECKLOCKTIMEVERIFY |
85 ScriptVerificationFlags::CHECKSEQUENCEVERIFY};
86constexpr auto VERIFY_ALL_PRE_TAPROOT{VERIFY_ALL_PRE_SEGWIT | ScriptVerificationFlags::WITNESS};
87
88void check_equal(std::span<const std::byte> _actual, std::span<const std::byte> _expected, bool equal = true)
89{
90 std::span<const uint8_t> actual{reinterpret_cast<const unsigned char*>(_actual.data()), _actual.size()};
91 std::span<const uint8_t> expected{reinterpret_cast<const unsigned char*>(_expected.data()), _expected.size()};
92 BOOST_CHECK_EQUAL_COLLECTIONS(
93 actual.begin(), actual.end(),
94 expected.begin(), expected.end());
95}
96
98{
99public:
100 void LogMessage(std::string_view message)
101 {
102 std::cout << "kernel: " << message;
103 }
104};
105
107 fs::path m_directory;
108 TestDirectory(std::string directory_name)
109 : m_directory{fs::path{fs::temp_directory_path()} / fs::u8path(directory_name + "_🌽_" + random_string(16))}
110 {
111 fs::create_directories(m_directory);
112 }
113
115 {
116 fs::remove_all(m_directory);
117 }
118};
119
121{
122public:
123 void HeaderTipHandler(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) override
124 {
125 BOOST_CHECK_GT(timestamp, 0);
126 }
127
128 void FlushErrorHandler(std::string_view error) override
129 {
130 std::cout << error << std::endl;
131 }
132
133 void FatalErrorHandler(std::string_view error) override
134 {
135 std::cout << error << std::endl;
136 }
137};
138
140{
141public:
142 std::optional<std::vector<std::byte>> m_expected_valid_block = std::nullopt;
143
144 void BlockChecked(Block block, BlockValidationStateView state) override
145 {
146 if (m_expected_valid_block.has_value()) {
147 auto ser_block{block.ToBytes()};
148 check_equal(m_expected_valid_block.value(), ser_block);
149 }
150
151 auto mode{state.GetValidationMode()};
152 switch (mode) {
153 case ValidationMode::VALID: {
154 std::cout << "Valid block" << std::endl;
155 return;
156 }
158 std::cout << "Invalid block: ";
159 auto result{state.GetBlockValidationResult()};
160 switch (result) {
161 case BlockValidationResult::UNSET:
162 std::cout << "initial value. Block has not yet been rejected" << std::endl;
163 break;
164 case BlockValidationResult::HEADER_LOW_WORK:
165 std::cout << "the block header may be on a too-little-work chain" << std::endl;
166 break;
167 case BlockValidationResult::CONSENSUS:
168 std::cout << "invalid by consensus rules (excluding any below reasons)" << std::endl;
169 break;
170 case BlockValidationResult::CACHED_INVALID:
171 std::cout << "this block was cached as being invalid and we didn't store the reason why" << std::endl;
172 break;
173 case BlockValidationResult::INVALID_HEADER:
174 std::cout << "invalid proof of work or time too old" << std::endl;
175 break;
176 case BlockValidationResult::MUTATED:
177 std::cout << "the block's data didn't match the data committed to by the PoW" << std::endl;
178 break;
179 case BlockValidationResult::MISSING_PREV:
180 std::cout << "We don't have the previous block the checked one is built on" << std::endl;
181 break;
182 case BlockValidationResult::INVALID_PREV:
183 std::cout << "A block this one builds on is invalid" << std::endl;
184 break;
185 case BlockValidationResult::TIME_FUTURE:
186 std::cout << "block timestamp was > 2 hours in the future (or our clock is bad)" << std::endl;
187 break;
188 }
189 return;
190 }
191 case ValidationMode::INTERNAL_ERROR: {
192 std::cout << "Internal error" << std::endl;
193 return;
194 }
195 }
196 }
197
198 void BlockConnected(Block block, BlockTreeEntry entry) override
199 {
200 std::cout << "Block connected." << std::endl;
201 }
202
203 void PowValidBlock(BlockTreeEntry entry, Block block) override
204 {
205 std::cout << "Block passed pow verification" << std::endl;
206 }
207
208 void BlockDisconnected(Block block, BlockTreeEntry entry) override
209 {
210 std::cout << "Block disconnected." << std::endl;
211 }
212};
213
215 const ScriptPubkey& spent_script_pubkey,
216 const Transaction& spending_tx,
217 const PrecomputedTransactionData* precomputed_txdata,
218 int64_t amount,
219 unsigned int input_index,
220 bool taproot)
221{
222 auto status = ScriptVerifyStatus::OK;
223
224 if (taproot) {
225 BOOST_CHECK(spent_script_pubkey.Verify(
226 amount,
227 spending_tx,
228 precomputed_txdata,
229 input_index,
231 status));
232 BOOST_CHECK(status == ScriptVerifyStatus::OK);
233 } else {
234 BOOST_CHECK(!spent_script_pubkey.Verify(
235 amount,
236 spending_tx,
237 precomputed_txdata,
238 input_index,
240 status));
241 BOOST_CHECK(status == ScriptVerifyStatus::ERROR_SPENT_OUTPUTS_REQUIRED);
242 }
243
244 BOOST_CHECK(spent_script_pubkey.Verify(
245 amount,
246 spending_tx,
247 precomputed_txdata,
248 input_index,
250 status));
251 BOOST_CHECK(status == ScriptVerifyStatus::OK);
252
253 BOOST_CHECK(spent_script_pubkey.Verify(
254 0,
255 spending_tx,
256 precomputed_txdata,
257 input_index,
259 status));
260 BOOST_CHECK(status == ScriptVerifyStatus::OK);
261}
262
263template <typename T>
264concept HasToBytes = requires(T t) {
265 { t.ToBytes() } -> std::convertible_to<std::span<const std::byte>>;
266};
267
268template <typename T>
269void CheckHandle(T object, T distinct_object)
270{
271 BOOST_CHECK(object.get() != nullptr);
272 BOOST_CHECK(distinct_object.get() != nullptr);
273 BOOST_CHECK(object.get() != distinct_object.get());
274
275 if constexpr (HasToBytes<T>) {
276 const auto object_bytes = object.ToBytes();
277 const auto distinct_bytes = distinct_object.ToBytes();
278 BOOST_CHECK(!std::ranges::equal(object_bytes, distinct_bytes));
279 }
280
281 // Copy constructor
282 T object2(distinct_object);
283 BOOST_CHECK_NE(distinct_object.get(), object2.get());
284 if constexpr (HasToBytes<T>) {
285 check_equal(distinct_object.ToBytes(), object2.ToBytes());
286 }
287
288 // Copy assignment
289 T object3{distinct_object};
290 object2 = object3;
291 BOOST_CHECK_NE(object3.get(), object2.get());
292 if constexpr (HasToBytes<T>) {
293 check_equal(object3.ToBytes(), object2.ToBytes());
294 }
295
296 // Move constructor
297 auto* original_ptr = object2.get();
298 T object4{std::move(object2)};
299 BOOST_CHECK_EQUAL(object4.get(), original_ptr);
300 BOOST_CHECK_EQUAL(object2.get(), nullptr); // NOLINT(bugprone-use-after-move)
301 if constexpr (HasToBytes<T>) {
302 check_equal(object4.ToBytes(), object3.ToBytes());
303 }
304
305 // Move assignment
306 original_ptr = object4.get();
307 object2 = std::move(object4);
308 BOOST_CHECK_EQUAL(object2.get(), original_ptr);
309 BOOST_CHECK_EQUAL(object4.get(), nullptr); // NOLINT(bugprone-use-after-move)
310 if constexpr (HasToBytes<T>) {
311 check_equal(object2.ToBytes(), object3.ToBytes());
312 }
313
314 // Self move-assignment must not destroy the held resource.
315 // Use a reference to avoid -Wself-move warnings.
316 original_ptr = object2.get();
317 auto& object2_ref = object2;
318 object2 = std::move(object2_ref);
319 BOOST_CHECK_EQUAL(object2.get(), original_ptr);
320 if constexpr (HasToBytes<T>) {
321 check_equal(object2.ToBytes(), object3.ToBytes());
322 }
323}
324
325template <typename RangeType>
326 requires std::ranges::random_access_range<RangeType>
327void CheckRange(const RangeType& range, size_t expected_size)
328{
329 using value_type = std::ranges::range_value_t<RangeType>;
330
331 BOOST_CHECK_EQUAL(range.size(), expected_size);
332 BOOST_REQUIRE(range.size() > 0); // Some checks below assume a non-empty range
333 BOOST_REQUIRE(!range.empty());
334
335 BOOST_CHECK(range.begin() != range.end());
336 BOOST_CHECK_EQUAL(std::distance(range.begin(), range.end()), static_cast<std::ptrdiff_t>(expected_size));
337 BOOST_CHECK(range.cbegin() == range.begin());
338 BOOST_CHECK(range.cend() == range.end());
339
340 for (size_t i = 0; i < range.size(); ++i) {
341 BOOST_CHECK_EQUAL(range[i].get(), (*(range.begin() + i)).get());
342 }
343
344 BOOST_CHECK_THROW(range.at(expected_size), std::out_of_range);
345
346 BOOST_CHECK_EQUAL(range.front().get(), range[0].get());
347 BOOST_CHECK_EQUAL(range.back().get(), range[expected_size - 1].get());
348
349 auto it = range.begin();
350 auto it_copy = it;
351 ++it;
352 BOOST_CHECK(it != it_copy);
353 --it;
354 BOOST_CHECK(it == it_copy);
355 it = range.begin();
356 auto old_it = it++;
357 BOOST_CHECK(old_it == range.begin());
358 BOOST_CHECK(it == range.begin() + 1);
359 old_it = it--;
360 BOOST_CHECK(old_it == range.begin() + 1);
361 BOOST_CHECK(it == range.begin());
362
363 it = range.begin();
364 it += 2;
365 BOOST_CHECK(it == range.begin() + 2);
366 it -= 2;
367 BOOST_CHECK(it == range.begin());
368
369 BOOST_CHECK(range.begin() < range.end());
370 BOOST_CHECK(range.begin() <= range.end());
371 BOOST_CHECK(range.end() > range.begin());
372 BOOST_CHECK(range.end() >= range.begin());
373 BOOST_CHECK(range.begin() == range.begin());
374
375 BOOST_CHECK_EQUAL(range.begin()[0].get(), range[0].get());
376
377 size_t count = 0;
378 for (auto rit = range.end(); rit != range.begin();) {
379 --rit;
380 ++count;
381 }
382 BOOST_CHECK_EQUAL(count, expected_size);
383
384 std::vector<value_type> collected;
385 for (const auto& elem : range) {
386 collected.push_back(elem);
387 }
388 BOOST_CHECK_EQUAL(collected.size(), expected_size);
389
390 BOOST_CHECK_EQUAL(std::ranges::size(range), expected_size);
391
392 it = range.begin();
393 auto it2 = 1 + it;
394 BOOST_CHECK(it2 == it + 1);
395}
396
397BOOST_AUTO_TEST_CASE(btck_transaction_tests)
398{
399 auto tx_data{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")};
400 auto tx{Transaction{tx_data}};
401 auto tx_data_2{hex_string_to_byte_vec("02000000000101904f4ee5c87d20090b642f116e458cd6693292ad9ece23e72f15fb6c05b956210500000000fdffffff02e2010000000000002251200839a723933b56560487ec4d67dda58f09bae518ffa7e148313c5696ac837d9f10060000000000002251205826bcdae7abfb1c468204170eab00d887b61ab143464a4a09e1450bdc59a3340140f26e7af574e647355830772946356c27e7bbc773c5293688890f58983499581be84de40be7311a14e6d6422605df086620e75adae84ff06b75ce5894de5e994a00000000")};
402 auto tx2{Transaction{tx_data_2}};
403 CheckHandle(tx, tx2);
404
405 auto invalid_data = hex_string_to_byte_vec("012300");
406 BOOST_CHECK_THROW(Transaction{invalid_data}, std::runtime_error);
407 auto empty_data = hex_string_to_byte_vec("");
408 BOOST_CHECK_THROW(Transaction{empty_data}, std::runtime_error);
409
410 BOOST_CHECK_EQUAL(tx.CountOutputs(), 2);
411 BOOST_CHECK_EQUAL(tx.CountInputs(), 1);
412 BOOST_CHECK_EQUAL(tx.GetLocktime(), 510826);
413
414 BOOST_CHECK_EQUAL(tx.GetVersion(), 2);
415 for (const auto& [version_hex, version] : {std::pair{"00000000", 0u}, {"ffffffff", 0xffffffffu}}) {
416 auto versioned_tx_data{tx_data};
417 std::ranges::copy(hex_string_to_byte_vec(version_hex), versioned_tx_data.begin());
418 BOOST_CHECK_EQUAL(Transaction{versioned_tx_data}.GetVersion(), version);
419 }
420
421 auto broken_tx_data{std::span<std::byte>{tx_data.begin(), tx_data.begin() + 10}};
422 BOOST_CHECK_THROW(Transaction{broken_tx_data}, std::runtime_error);
423 auto input{tx.GetInput(0)};
424 BOOST_CHECK_EQUAL(input.GetSequence(), 0xfffffffe);
425 auto output{tx.GetOutput(tx.CountOutputs() - 1)};
426 BOOST_CHECK_EQUAL(output.Amount(), 42130042);
427 auto script_pubkey{output.GetScriptPubkey()};
428 {
429 auto tx_new{Transaction{tx_data}};
430 // This is safe, because we now use copy assignment
431 TransactionOutput output = tx_new.GetOutput(tx_new.CountOutputs() - 1);
433
434 TransactionOutputView output2 = tx_new.GetOutput(tx_new.CountOutputs() - 1);
435 BOOST_CHECK_NE(output.get(), output2.get());
436 BOOST_CHECK_EQUAL(output.Amount(), output2.Amount());
437 TransactionOutput output3 = output2;
438 BOOST_CHECK_NE(output3.get(), output2.get());
439 BOOST_CHECK_EQUAL(output3.Amount(), output2.Amount());
440
441 // Non-owned view
442 ScriptPubkeyView script2 = output.GetScriptPubkey();
443 BOOST_CHECK_NE(script.get(), script2.get());
444 check_equal(script.ToBytes(), script2.ToBytes());
445
446 // Non-owned to owned
447 ScriptPubkey script3 = script2;
448 BOOST_CHECK_NE(script3.get(), script2.get());
449 check_equal(script3.ToBytes(), script2.ToBytes());
450 }
451 BOOST_CHECK_EQUAL(output.Amount(), 42130042);
452
453 auto tx_roundtrip{Transaction{tx.ToBytes()}};
454 check_equal(tx_roundtrip.ToBytes(), tx_data);
455
456 // The following code is unsafe, but left here to show limitations of the
457 // API, because we preserve the output view beyond the lifetime of the
458 // transaction. The view type wrapper should make this clear to the user.
459 // auto get_output = [&]() -> TransactionOutputView {
460 // auto tx{Transaction{tx_data}};
461 // return tx.GetOutput(0);
462 // };
463 // auto output_new = get_output();
464 // BOOST_CHECK_EQUAL(output_new.Amount(), 20737411);
465
466 int64_t total_amount{0};
467 for (const auto output : tx.Outputs()) {
468 total_amount += output.Amount();
469 }
470 BOOST_CHECK_EQUAL(total_amount, 62867453);
471
472 auto amount = *(tx.Outputs() | std::ranges::views::filter([](const auto& output) {
473 return output.Amount() == 42130042;
474 }) |
475 std::views::transform([](const auto& output) {
476 return output.Amount();
477 })).begin();
478 BOOST_REQUIRE(amount);
479 BOOST_CHECK_EQUAL(amount, 42130042);
480
481 CheckRange(tx.Outputs(), tx.CountOutputs());
482
483 ScriptPubkey script_pubkey_roundtrip{script_pubkey.ToBytes()};
484 check_equal(script_pubkey_roundtrip.ToBytes(), script_pubkey.ToBytes());
485}
486
487BOOST_AUTO_TEST_CASE(btck_transaction_id_tests)
488{
489 auto legacy_tx{Transaction{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")}};
490 auto witness_tx{Transaction{hex_string_to_byte_vec("02000000000101904f4ee5c87d20090b642f116e458cd6693292ad9ece23e72f15fb6c05b956210500000000fdffffff02e2010000000000002251200839a723933b56560487ec4d67dda58f09bae518ffa7e148313c5696ac837d9f10060000000000002251205826bcdae7abfb1c468204170eab00d887b61ab143464a4a09e1450bdc59a3340140f26e7af574e647355830772946356c27e7bbc773c5293688890f58983499581be84de40be7311a14e6d6422605df086620e75adae84ff06b75ce5894de5e994a00000000")}};
491
492 BOOST_CHECK(!legacy_tx.HasWitness());
493 BOOST_CHECK(witness_tx.HasWitness());
494
495 // Txid and Wtxid are distinct types and cannot be compared with each other.
496 static_assert(!std::equality_comparable_with<TxidView, WtxidView>);
497 static_assert(!std::equality_comparable_with<Txid, Wtxid>);
498
499 // View equality on the same object and across objects.
500 BOOST_CHECK(legacy_tx.Txid() == legacy_tx.Txid());
501 BOOST_CHECK(legacy_tx.Wtxid() == legacy_tx.Wtxid());
502 BOOST_CHECK(legacy_tx.Txid() != witness_tx.Txid());
503 BOOST_CHECK(legacy_tx.Wtxid() != witness_tx.Wtxid());
504
505 // Owned handles created from views compare equal to their copies.
506 Txid owned_txid{legacy_tx.Txid()};
507 Txid owned_txid_copy{owned_txid}; // NOLINT(performance-unnecessary-copy-initialization)
508 BOOST_CHECK(owned_txid == owned_txid_copy);
509 BOOST_CHECK(owned_txid != Txid{witness_tx.Txid()});
510 CheckHandle(owned_txid, Txid{witness_tx.Txid()});
511
512 Wtxid owned_wtxid{legacy_tx.Wtxid()};
513 Wtxid owned_wtxid_copy{owned_wtxid}; // NOLINT(performance-unnecessary-copy-initialization)
514 BOOST_CHECK(owned_wtxid == owned_wtxid_copy);
515 BOOST_CHECK(owned_wtxid != Wtxid{witness_tx.Wtxid()});
516 CheckHandle(owned_wtxid, Wtxid{witness_tx.Wtxid()});
517
518 // Without witness data, the wtxid equals the txid; with witness data, it differs.
519 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(legacy_tx.Txid().ToBytes()), "aca326a724eda9a461c10a876534ecd5ae7b27f10f26c3862fb996f80ea2d45d");
520 check_equal(legacy_tx.Txid().ToBytes(), legacy_tx.Wtxid().ToBytes());
521
522 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(witness_tx.Txid().ToBytes()), "9d04c6435f39a114f26b5807e92117b388f15c54c2afe7e62c96757f18cec891");
523 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(witness_tx.Wtxid().ToBytes()), "c5cd58b8eb3dda755eb99c89c4bcb7409e4074c8942c263e3d6d09011984a210");
524 BOOST_CHECK(!std::ranges::equal(witness_tx.Txid().ToBytes(), witness_tx.Wtxid().ToBytes()));
525}
526
527BOOST_AUTO_TEST_CASE(btck_script_pubkey)
528{
529 auto script_data{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")};
530 std::vector<std::byte> script_data_2 = script_data;
531 script_data_2.push_back(std::byte{0x51});
532 ScriptPubkey script{script_data};
533 ScriptPubkey script2{script_data_2};
534 CheckHandle(script, script2);
535
536 std::span<std::byte> empty_data{};
537 ScriptPubkey empty_script{empty_data};
538 CheckHandle(script, empty_script);
539}
540
541BOOST_AUTO_TEST_CASE(btck_transaction_output)
542{
543 ScriptPubkey script{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")};
544 TransactionOutput output{script, 1};
545 TransactionOutput output2{script, 2};
546 CheckHandle(output, output2);
547}
548
549BOOST_AUTO_TEST_CASE(btck_transaction_input)
550{
551 Transaction tx{hex_string_to_byte_vec("020000000248c03e66fd371c7033196ce24298628e59ebefa00363026044e0f35e0325a65d000000006a473044022004893432347f39beaa280e99da595681ddb20fc45010176897e6e055d716dbfa022040a9e46648a5d10c33ef7cee5e6cf4b56bd513eae3ae044f0039824b02d0f44c012102982331a52822fd9b62e9b5d120da1d248558fac3da3a3c51cd7d9c8ad3da760efeffffffb856678c6e4c3c84e39e2ca818807049d6fba274b42af3c6d3f9d4b6513212d2000000006a473044022068bcedc7fe39c9f21ad318df2c2da62c2dc9522a89c28c8420ff9d03d2e6bf7b0220132afd752754e5cb1ea2fd0ed6a38ec666781e34b0e93dc9a08f2457842cf5660121033aeb9c079ea3e08ea03556182ab520ce5c22e6b0cb95cee6435ee17144d860cdfeffffff0260d50b00000000001976a914363cc8d55ea8d0500de728ef6d63804ddddbdc9888ac67040f00000000001976a914c303bdc5064bf9c9a8b507b5496bd0987285707988ac6acb0700")};
552 TransactionInput input_0 = tx.GetInput(0);
553 TransactionInput input_1 = tx.GetInput(1);
554 CheckHandle(input_0, input_1);
555 CheckRange(tx.Inputs(), tx.CountInputs());
556 OutPoint point_0 = input_0.OutPoint();
557 OutPoint point_1 = input_1.OutPoint();
558 CheckHandle(point_0, point_1);
559
560 WitnessStackView ws_0 = input_0.GetWitnessStack();
561 BOOST_CHECK_EQUAL(ws_0.CountItems(), 0);
562 BOOST_CHECK(ws_0.Items().empty());
563
564 // P2PKH: DER sig + compressed pubkey push.
565 BOOST_CHECK(input_0.GetScriptSig() == hex_string_to_byte_vec("473044022004893432347f39beaa280e99da595681ddb20fc45010176897e6e055d716dbfa022040a9e46648a5d10c33ef7cee5e6cf4b56bd513eae3ae044f0039824b02d0f44c012102982331a52822fd9b62e9b5d120da1d248558fac3da3a3c51cd7d9c8ad3da760e"));
566 BOOST_CHECK(input_1.GetScriptSig() == hex_string_to_byte_vec("473044022068bcedc7fe39c9f21ad318df2c2da62c2dc9522a89c28c8420ff9d03d2e6bf7b0220132afd752754e5cb1ea2fd0ed6a38ec666781e34b0e93dc9a08f2457842cf5660121033aeb9c079ea3e08ea03556182ab520ce5c22e6b0cb95cee6435ee17144d860cd"));
567
568 // P2WSH input: OP_0, sig, sig, redeem_script (0, 71, 71, 105 bytes); no scriptSig.
569 Transaction segwit_tx{hex_string_to_byte_vec("010000000001011f97548fbbe7a0db7588a66e18d803d0089315aa7d4cc28360b6ec50ef36718a0100000000ffffffff02df1776000000000017a9146c002a686959067f4866b8fb493ad7970290ab728757d29f0000000000220020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d04004730440220565d170eed95ff95027a69b313758450ba84a01224e1f7f130dda46e94d13f8602207bdd20e307f062594022f12ed5017bbf4a055a06aea91c10110a0e3bb23117fc014730440220647d2dc5b15f60bc37dc42618a370b2a1490293f9e5c8464f53ec4fe1dfe067302203598773895b4b16d37485cbe21b337f4e4b650739880098c592553add7dd4355016952210375e00eb72e29da82b89367947f29ef34afb75e8654f6ea368e0acdfd92976b7c2103a1b26313f430c4b15bb1fdce663207659d8cac749a0e53d70eff01874496feff2103c96d495bfdd5ba4145e3e046fee45e84a8a48ad05bd8dbb395c011a32cf9f88053ae00000000")};
570 TransactionInputView segwit_input = segwit_tx.GetInput(0);
571 WitnessStackView ws = segwit_input.GetWitnessStack();
573 BOOST_CHECK(ws.GetItem(0).empty());
574 BOOST_CHECK(ws.GetItem(1) == hex_string_to_byte_vec("30440220565d170eed95ff95027a69b313758450ba84a01224e1f7f130dda46e94d13f8602207bdd20e307f062594022f12ed5017bbf4a055a06aea91c10110a0e3bb23117fc01"));
575 BOOST_CHECK(ws.GetItem(2) == hex_string_to_byte_vec("30440220647d2dc5b15f60bc37dc42618a370b2a1490293f9e5c8464f53ec4fe1dfe067302203598773895b4b16d37485cbe21b337f4e4b650739880098c592553add7dd435501"));
576 BOOST_CHECK(ws.GetItem(3) == hex_string_to_byte_vec("52210375e00eb72e29da82b89367947f29ef34afb75e8654f6ea368e0acdfd92976b7c2103a1b26313f430c4b15bb1fdce663207659d8cac749a0e53d70eff01874496feff2103c96d495bfdd5ba4145e3e046fee45e84a8a48ad05bd8dbb395c011a32cf9f88053ae"));
577 auto items = ws.Items();
578 BOOST_CHECK_EQUAL(items.size(), 4);
579 for (size_t i = 0; i < items.size(); ++i) {
580 BOOST_CHECK(items[i] == ws.GetItem(i));
581 }
582 WitnessStack owned_ws_0{ws_0};
583 WitnessStack owned_ws{ws};
584 CheckHandle(owned_ws_0, owned_ws);
585 BOOST_CHECK(segwit_input.GetScriptSig().empty());
586}
587
588BOOST_AUTO_TEST_CASE(btck_precomputed_txdata) {
589 auto tx_data{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")};
590 auto tx{Transaction{tx_data}};
591 auto tx_data_2{hex_string_to_byte_vec("02000000000101904f4ee5c87d20090b642f116e458cd6693292ad9ece23e72f15fb6c05b956210500000000fdffffff02e2010000000000002251200839a723933b56560487ec4d67dda58f09bae518ffa7e148313c5696ac837d9f10060000000000002251205826bcdae7abfb1c468204170eab00d887b61ab143464a4a09e1450bdc59a3340140f26e7af574e647355830772946356c27e7bbc773c5293688890f58983499581be84de40be7311a14e6d6422605df086620e75adae84ff06b75ce5894de5e994a00000000")};
592 auto tx2{Transaction{tx_data_2}};
593 auto precomputed_txdata{PrecomputedTransactionData{
594 /*tx_to=*/tx,
595 /*spent_outputs=*/{},
596 }};
597 auto precomputed_txdata_2{PrecomputedTransactionData{
598 /*tx_to=*/tx2,
599 /*spent_outputs=*/{},
600 }};
601 CheckHandle(precomputed_txdata, precomputed_txdata_2);
602}
603
604BOOST_AUTO_TEST_CASE(btck_script_verify_tests)
605{
606 // Legacy transaction aca326a724eda9a461c10a876534ecd5ae7b27f10f26c3862fb996f80ea2d45d
607 auto legacy_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("76a9144bfbaf6afb76cc5771bc6404810d1cc041a6933988ac")}};
608 auto legacy_spending_tx{Transaction{hex_string_to_byte_vec("02000000013f7cebd65c27431a90bba7f796914fe8cc2ddfc3f2cbd6f7e5f2fc854534da95000000006b483045022100de1ac3bcdfb0332207c4a91f3832bd2c2915840165f876ab47c5f8996b971c3602201c6c053d750fadde599e6f5c4e1963df0f01fc0d97815e8157e3d59fe09ca30d012103699b464d1d8bc9e47d4fb1cdaa89a1c5783d68363c4dbc4b524ed3d857148617feffffff02836d3c01000000001976a914fc25d6d5c94003bf5b0c7b640a248e2c637fcfb088ac7ada8202000000001976a914fbed3d9b11183209a57999d54d59f67c019e756c88ac6acb0700")}};
610 /*spent_script_pubkey=*/legacy_spent_script_pubkey,
611 /*spending_tx=*/legacy_spending_tx,
612 /*precomputed_txdata=*/nullptr,
613 /*amount=*/0,
614 /*input_index=*/0,
615 /*taproot=*/false);
616
617 // Legacy transaction aca326a724eda9a461c10a876534ecd5ae7b27f10f26c3862fb996f80ea2d45d with precomputed_txdata
618 auto legacy_precomputed_txdata{PrecomputedTransactionData{
619 /*tx_to=*/legacy_spending_tx,
620 /*spent_outputs=*/{},
621 }};
623 /*spent_script_pubkey=*/legacy_spent_script_pubkey,
624 /*spending_tx=*/legacy_spending_tx,
625 /*precomputed_txdata=*/&legacy_precomputed_txdata,
626 /*amount=*/0,
627 /*input_index=*/0,
628 /*taproot=*/false);
629
630 // Segwit transaction 1a3e89644985fbbb41e0dcfe176739813542b5937003c46a07de1e3ee7a4a7f3
631 auto segwit_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("0020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d")}};
632 auto segwit_spending_tx{Transaction{hex_string_to_byte_vec("010000000001011f97548fbbe7a0db7588a66e18d803d0089315aa7d4cc28360b6ec50ef36718a0100000000ffffffff02df1776000000000017a9146c002a686959067f4866b8fb493ad7970290ab728757d29f0000000000220020701a8d401c84fb13e6baf169d59684e17abd9fa216c8cc5b9fc63d622ff8c58d04004730440220565d170eed95ff95027a69b313758450ba84a01224e1f7f130dda46e94d13f8602207bdd20e307f062594022f12ed5017bbf4a055a06aea91c10110a0e3bb23117fc014730440220647d2dc5b15f60bc37dc42618a370b2a1490293f9e5c8464f53ec4fe1dfe067302203598773895b4b16d37485cbe21b337f4e4b650739880098c592553add7dd4355016952210375e00eb72e29da82b89367947f29ef34afb75e8654f6ea368e0acdfd92976b7c2103a1b26313f430c4b15bb1fdce663207659d8cac749a0e53d70eff01874496feff2103c96d495bfdd5ba4145e3e046fee45e84a8a48ad05bd8dbb395c011a32cf9f88053ae00000000")}};
634 /*spent_script_pubkey=*/segwit_spent_script_pubkey,
635 /*spending_tx=*/segwit_spending_tx,
636 /*precomputed_txdata=*/nullptr,
637 /*amount=*/18393430,
638 /*input_index=*/0,
639 /*taproot=*/false);
640
641 // Segwit transaction 1a3e89644985fbbb41e0dcfe176739813542b5937003c46a07de1e3ee7a4a7f3 with precomputed_txdata
642 auto segwit_precomputed_txdata{PrecomputedTransactionData{
643 /*tx_to=*/segwit_spending_tx,
644 /*spent_outputs=*/{},
645 }};
647 /*spent_script_pubkey=*/segwit_spent_script_pubkey,
648 /*spending_tx=*/segwit_spending_tx,
649 /*precomputed_txdata=*/&segwit_precomputed_txdata,
650 /*amount=*/18393430,
651 /*input_index=*/0,
652 /*taproot=*/false);
653
654 // Taproot transaction 33e794d097969002ee05d336686fc03c9e15a597c1b9827669460fac98799036
655 auto taproot_spent_script_pubkey{ScriptPubkey{hex_string_to_byte_vec("5120339ce7e165e67d93adb3fef88a6d4beed33f01fa876f05a225242b82a631abc0")}};
656 auto taproot_spending_tx{Transaction{hex_string_to_byte_vec("01000000000101d1f1c1f8cdf6759167b90f52c9ad358a369f95284e841d7a2536cef31c0549580100000000fdffffff020000000000000000316a2f49206c696b65205363686e6f7272207369677320616e6420492063616e6e6f74206c69652e204062697462756734329e06010000000000225120a37c3903c8d0db6512e2b40b0dffa05e5a3ab73603ce8c9c4b7771e5412328f90140a60c383f71bac0ec919b1d7dbc3eb72dd56e7aa99583615564f9f99b8ae4e837b758773a5b2e4c51348854c8389f008e05029db7f464a5ff2e01d5e6e626174affd30a00")}};
657 std::vector<TransactionOutput> taproot_spent_outputs;
658 taproot_spent_outputs.emplace_back(taproot_spent_script_pubkey, 88480);
659 auto taproot_precomputed_txdata{PrecomputedTransactionData{
660 /*tx_to=*/taproot_spending_tx,
661 /*spent_outputs=*/taproot_spent_outputs,
662 }};
664 /*spent_script_pubkey=*/taproot_spent_script_pubkey,
665 /*spending_tx=*/taproot_spending_tx,
666 /*precomputed_txdata=*/&taproot_precomputed_txdata,
667 /*amount=*/88480,
668 /*input_index=*/0,
669 /*taproot=*/true);
670
671 // Two-input taproot transaction e8e8320f40c31ed511570e9cdf1d241f8ec9a5cc392e6105240ac8dbea2098de
672 auto taproot2_spent_script_pubkey0{ScriptPubkey{hex_string_to_byte_vec("5120b7da80f57e36930b0515eb09293e25858d13e6b91fee6184943f5a584cb4248e")}};
673 auto taproot2_spent_script_pubkey1{ScriptPubkey{hex_string_to_byte_vec("5120ab78e077d062e7b8acd7063668b4db5355a1b5d5fd2a46a8e98e62e5e63fab77")}};
674 auto taproot2_spending_tx{Transaction{hex_string_to_byte_vec("02000000000102c0f01ead18750892c84b1d4f595149ad38f16847df1fbf490e235b3b78c1f98a0100000000ffffffff456764a19c2682bf5b1567119f06a421849ad1664cf42b5ef95b69d6e2159e9d0000000000ffffffff022202000000000000225120b6c0c2a8ee25a2ae0322ab7f1a06f01746f81f6b90d179c3c2a51a356e6188f1d70e020000000000225120b7da80f57e36930b0515eb09293e25858d13e6b91fee6184943f5a584cb4248e0141933fdc49eb1af1f08ed1e9cf5559259309a8acd25ff1e6999b6955124438aef4fceaa4e6a5f85286631e24837329563595bc3cf4b31e1c687442abb01c4206818101401c9620faf1e8c84187762ad14d04ae3857f59a2f03f1dcbb99290e16dfc572a63b4ea435780a5787af59beb5742fd71cda8a95381517a1ff14b4c67996c4bf8100000000")}};
675 std::vector<TransactionOutput> taproot2_spent_outputs;
676 taproot2_spent_outputs.emplace_back(taproot2_spent_script_pubkey0, 546);
677 taproot2_spent_outputs.emplace_back(taproot2_spent_script_pubkey1, 135125);
678 auto taproot2_precomputed_txdata{PrecomputedTransactionData{
679 /*tx_to=*/taproot2_spending_tx,
680 /*spent_outputs=*/taproot2_spent_outputs,
681 }};
683 /*spent_script_pubkey=*/taproot2_spent_script_pubkey0,
684 /*spending_tx=*/taproot2_spending_tx,
685 /*precomputed_txdata=*/&taproot2_precomputed_txdata,
686 /*amount=*/546,
687 /*input_index=*/0,
688 /*taproot=*/true);
690 /*spent_script_pubkey=*/taproot2_spent_script_pubkey1,
691 /*spending_tx=*/taproot2_spending_tx,
692 /*precomputed_txdata=*/&taproot2_precomputed_txdata,
693 /*amount=*/135125,
694 /*input_index=*/1,
695 /*taproot=*/true);
696}
697
699{
700 btck_LoggingOptions logging_options = {
701 .log_timestamps = true,
702 .log_time_micros = true,
703 .log_threadnames = false,
704 .log_sourcelocations = false,
705 .always_print_category_levels = true,
706 };
707
708 logging_set_options(logging_options);
709 logging_set_level_category(LogCategory::BENCH, LogLevel::TRACE_LEVEL);
713
714 // Check that connecting, connecting another, and then disconnecting and connecting a logger again works.
715 {
716 logging_set_level_category(LogCategory::KERNEL, LogLevel::TRACE_LEVEL);
718 Logger logger{std::make_unique<TestLog>()};
719 Logger logger_2{std::make_unique<TestLog>()};
720 }
721 Logger logger{std::make_unique<TestLog>()};
722}
723
724BOOST_AUTO_TEST_CASE(btck_chainparams_tests)
725{
726 ChainParams params_signet{ChainType::SIGNET};
727 ChainParams params_signet_challenge{hex_string_to_byte_vec("51")};
728 CheckHandle(params_signet, params_signet_challenge);
729}
730
731BOOST_AUTO_TEST_CASE(btck_context_tests)
732{
733 { // test default context
735 Context context2{};
736 CheckHandle(context, context2);
737 }
738
739 { // test with context options, but not options set
740 ContextOptions options{};
741 Context context{options};
742 }
743
744 { // test with context options
745 ContextOptions options{};
746 ChainParams params{ChainType::MAINNET};
747 ChainParams regtest_params{ChainType::REGTEST};
748 CheckHandle(params, regtest_params);
749 options.SetChainParams(params);
750 options.SetNotifications(std::make_shared<TestKernelNotifications>());
751 Context context{options};
752 }
753}
754
755BOOST_AUTO_TEST_CASE(btck_block_header_tests)
756{
757 // Block header format: version(4) + prev_hash(32) + merkle_root(32) + timestamp(4) + bits(4) + nonce(4) = 80 bytes
758 BlockHeader header_0{hex_string_to_byte_vec("00e07a26beaaeee2e71d7eb19279545edbaf15de0999983626ec00000000000000000000579cf78b65229bfb93f4a11463af2eaa5ad91780f27f5d147a423bea5f7e4cdf2a47e268b4dd01173a9662ee")};
759 auto merkle_root_0{header_0.MerkleRoot()};
760 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(header_0.Hash().ToBytes()), "00000000000000000000325c7e14a4ee3b4fcb2343089a839287308a0ddbee4f");
761 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(merkle_root_0), "df4c7e5fea3b427a145d7ff28017d95aaa2eaf6314a1f493fb9b22658bf79c57");
762 BlockHeader header_1{hex_string_to_byte_vec("00c00020e7cb7b4de21d26d55bd384017b8bb9333ac3b2b55bed00000000000000000000d91b4484f801b99f03d36b9d26cfa83420b67f81da12d7e6c1e7f364e743c5ba9946e268b4dd011799c8533d")};
763 CheckHandle(header_0, header_1);
764
765 // Test all header field accessors using mainnet block 1
766 auto mainnet_block_1_header = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e36299");
767 BlockHeader header{mainnet_block_1_header};
768 BOOST_CHECK_EQUAL(header.Version(), 1);
769 BOOST_CHECK_EQUAL(header.Timestamp(), 1231469665);
770 BOOST_CHECK_EQUAL(header.Bits(), 0x1d00ffff);
771 BOOST_CHECK_EQUAL(header.Nonce(), 2573394689);
772 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(header.Hash().ToBytes()), "00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048");
773 auto prev_hash = header.PrevHash();
774 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(prev_hash.ToBytes()), "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f");
775 auto merkle_root = header.MerkleRoot();
776 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(merkle_root), "0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
777
778 // Test round-trip serialization of block header
779 auto header_roundtrip{BlockHeader{header.ToBytes()}};
780 check_equal(header_roundtrip.ToBytes(), mainnet_block_1_header);
781
782 auto raw_block = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000");
783 Block block{raw_block};
784 BlockHeader block_header{block.GetHeader()};
785 BOOST_CHECK_EQUAL(block_header.Version(), 1);
786 BOOST_CHECK_EQUAL(block_header.Timestamp(), 1231469665);
787 BOOST_CHECK_EQUAL(block_header.Bits(), 0x1d00ffff);
788 BOOST_CHECK_EQUAL(block_header.Nonce(), 2573394689);
789 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(block_header.Hash().ToBytes()), "00000000839a8e6886ab5951d76f411475428afc90947ee320161bbf18eb6048");
790
791 // Verify header from block serializes to first 80 bytes of raw block
792 auto block_header_bytes = block_header.ToBytes();
793 BOOST_CHECK_EQUAL(block_header_bytes.size(), 80);
794 check_equal(block_header_bytes, std::span<const std::byte>(raw_block.data(), 80));
795}
796
798{
801 CheckHandle(block, block_100);
803 CheckRange(block_tx.Transactions(), block_tx.CountTransactions());
804 auto transactions{block_tx.Transactions()};
805 auto transactions_copy{transactions};
806 BOOST_CHECK(transactions.begin() == transactions_copy.begin());
807 BOOST_CHECK(transactions.begin() == block_tx.Transactions().begin());
808 auto transaction_it{transactions.begin()};
809 BOOST_CHECK((*transaction_it).Txid() == block_tx.GetTransaction(0).Txid());
810 auto invalid_data = hex_string_to_byte_vec("012300");
811 BOOST_CHECK_THROW(Block{invalid_data}, std::runtime_error);
812 auto empty_data = hex_string_to_byte_vec("");
813 BOOST_CHECK_THROW(Block{empty_data}, std::runtime_error);
814}
815
816Context create_context(std::shared_ptr<TestKernelNotifications> notifications, ChainType chain_type, std::shared_ptr<TestValidationInterface> validation_interface = nullptr)
817{
818 ContextOptions options{};
819 ChainParams params{chain_type};
820 options.SetChainParams(params);
821 options.SetNotifications(notifications);
822 if (validation_interface) {
823 options.SetValidationInterface(validation_interface);
824 }
825 auto context{Context{options}};
826 return context;
827}
828
829BOOST_AUTO_TEST_CASE(btck_chainman_tests)
830{
831 Logger logger{std::make_unique<TestLog>()};
832 auto test_directory{TestDirectory{"chainman_test_bitcoin_kernel"}};
833
834 { // test with default context
836 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
837 ChainMan chainman{context, chainman_opts};
838 }
839
840 { // test with default context options
841 ContextOptions options{};
842 Context context{options};
843 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
844 ChainMan chainman{context, chainman_opts};
845 }
846 { // null or empty data_directory or blocks_directory are not allowed
848 auto valid_dir{PathToString(test_directory.m_directory)};
849 std::vector<std::pair<std::string_view, std::string_view>> illegal_cases{
850 {"", valid_dir},
851 {valid_dir, {nullptr, 0}},
852 {"", ""},
853 {{nullptr, 0}, {nullptr, 0}},
854 };
855 for (auto& [data_dir, blocks_dir] : illegal_cases) {
857 std::runtime_error);
858 };
859 }
860
861 auto notifications{std::make_shared<TestKernelNotifications>()};
862 auto context{create_context(notifications, ChainType::MAINNET)};
863
864 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
865 chainman_opts.SetWorkerThreads(4);
866 BOOST_CHECK(!chainman_opts.SetDatabaseCacheBytes(4_MiB - 1));
867 if constexpr (sizeof(void*) == 4) BOOST_CHECK(!chainman_opts.SetDatabaseCacheBytes(2_GiB));
868 BOOST_CHECK(chainman_opts.SetDatabaseCacheBytes(4_MiB));
869 BOOST_CHECK(!chainman_opts.SetWipeDbs(/*wipe_block_tree=*/true, /*wipe_chainstate=*/false));
870 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/true, /*wipe_chainstate=*/true));
871 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/true));
872 BOOST_CHECK(chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/false));
873 ChainMan chainman{context, chainman_opts};
874}
875
876std::unique_ptr<ChainMan> create_chainman(TestDirectory& test_directory,
877 bool reindex,
878 bool wipe_chainstate,
879 bool block_tree_db_in_memory,
880 bool chainstate_db_in_memory,
882{
883 ChainstateManagerOptions chainman_opts{context, PathToString(test_directory.m_directory), PathToString(test_directory.m_directory / "blocks")};
884
885 if (reindex) {
886 chainman_opts.SetWipeDbs(/*wipe_block_tree=*/reindex, /*wipe_chainstate=*/reindex);
887 }
888 if (wipe_chainstate) {
889 chainman_opts.SetWipeDbs(/*wipe_block_tree=*/false, /*wipe_chainstate=*/wipe_chainstate);
890 }
891 if (block_tree_db_in_memory) {
892 chainman_opts.UpdateBlockTreeDbInMemory(block_tree_db_in_memory);
893 }
894 if (chainstate_db_in_memory) {
895 chainman_opts.UpdateChainstateDbInMemory(chainstate_db_in_memory);
896 }
897
898 auto chainman{std::make_unique<ChainMan>(context, chainman_opts)};
899 return chainman;
900}
901
903{
904 auto notifications{std::make_shared<TestKernelNotifications>()};
905 auto context{create_context(notifications, ChainType::MAINNET)};
906 auto chainman{create_chainman(
907 test_directory, /*reindex=*/true, /*wipe_chainstate=*/false,
908 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
909
910 std::vector<std::string> import_files;
911 BOOST_CHECK(chainman->ImportBlocks(import_files));
912
913 // Sanity check some block retrievals
914 auto chain{chainman->GetChain()};
915 BOOST_CHECK_THROW(chain.GetByHeight(1000), std::runtime_error);
916 auto genesis_index{chain.Entries().front()};
917 BOOST_CHECK(!genesis_index.GetPrevious());
918 auto genesis_block_raw{chainman->ReadBlock(genesis_index).value().ToBytes()};
919 auto first_index{chain.GetByHeight(0)};
920 auto first_block_raw{chainman->ReadBlock(genesis_index).value().ToBytes()};
921 check_equal(genesis_block_raw, first_block_raw);
922 auto height{first_index.GetHeight()};
923 BOOST_CHECK_EQUAL(height, 0);
924
925 auto next_index{chain.GetByHeight(first_index.GetHeight() + 1)};
926 BOOST_CHECK(chain.Contains(next_index));
927 auto next_block_data{chainman->ReadBlock(next_index).value().ToBytes()};
928 auto tip_index{chain.Entries().back()};
929 auto tip_block_data{chainman->ReadBlock(tip_index).value().ToBytes()};
930 auto second_index{chain.GetByHeight(1)};
931 auto second_block{chainman->ReadBlock(second_index).value()};
932 auto second_block_data{second_block.ToBytes()};
933 auto second_height{second_index.GetHeight()};
934 BOOST_CHECK_EQUAL(second_height, 1);
935 check_equal(next_block_data, tip_block_data);
936 check_equal(next_block_data, second_block_data);
937
938 auto second_hash{second_index.GetHash()};
939 auto another_second_index{chainman->GetBlockTreeEntry(second_hash)};
940 BOOST_CHECK(another_second_index);
941 auto another_second_height{another_second_index->GetHeight()};
942 auto second_block_hash{second_block.GetHash()};
943 check_equal(second_block_hash.ToBytes(), second_hash.ToBytes());
944 BOOST_CHECK_EQUAL(second_height, another_second_height);
945}
946
948{
949 auto notifications{std::make_shared<TestKernelNotifications>()};
950 auto context{create_context(notifications, ChainType::MAINNET)};
951 auto chainman{create_chainman(
952 test_directory, /*reindex=*/false, /*wipe_chainstate=*/true,
953 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
954
955 std::vector<std::string> import_files;
956 import_files.push_back(PathToString(test_directory.m_directory / "blocks" / "blk00000.dat"));
957 BOOST_CHECK(chainman->ImportBlocks(import_files));
958}
959
961{
962 auto notifications{std::make_shared<TestKernelNotifications>()};
963 auto validation_interface{std::make_shared<TestValidationInterface>()};
964 auto context{create_context(notifications, ChainType::MAINNET, validation_interface)};
965 auto chainman{create_chainman(
966 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
967 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
968
969 // mainnet block 1
970 auto raw_block = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000");
971 Block block{raw_block};
972 BlockHeader header{block.GetHeader()};
973 TransactionView tx{block.GetTransaction(block.CountTransactions() - 1)};
974 BOOST_CHECK_EQUAL(byte_span_to_hex_string_reversed(tx.Txid().ToBytes()), "0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098");
975 BOOST_CHECK_EQUAL(header.Version(), 1);
976 BOOST_CHECK_EQUAL(header.Timestamp(), 1231469665);
977 BOOST_CHECK_EQUAL(header.Bits(), 0x1d00ffff);
978 BOOST_CHECK_EQUAL(header.Nonce(), 2573394689);
979 BOOST_CHECK_EQUAL(tx.CountInputs(), 1);
980 Transaction tx2 = tx;
982 for (auto transaction : block.Transactions()) {
983 BOOST_CHECK_EQUAL(transaction.CountInputs(), 1);
984 }
985 auto output_counts = *(block.Transactions() | std::views::transform([](const auto& tx) {
986 return tx.CountOutputs();
987 })).begin();
988 BOOST_CHECK_EQUAL(output_counts, 1);
989
990 validation_interface->m_expected_valid_block.emplace(raw_block);
991 auto ser_block{block.ToBytes()};
992 check_equal(ser_block, raw_block);
993 bool new_block = false;
994 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
995 BOOST_CHECK(new_block);
996
997 validation_interface->m_expected_valid_block = std::nullopt;
998 new_block = false;
1000 BOOST_CHECK(!chainman->ProcessBlock(invalid_block, &new_block));
1001 BOOST_CHECK(!new_block);
1002
1003 auto chain{chainman->GetChain()};
1004 BOOST_CHECK_EQUAL(chain.Height(), 1);
1005 auto tip{chain.Entries().back()};
1006 auto read_block{chainman->ReadBlock(tip)};
1007 BOOST_REQUIRE(read_block);
1008 check_equal(read_block.value().ToBytes(), raw_block);
1009
1010 // Check that we can read the previous block
1011 BlockTreeEntry tip_2{*tip.GetPrevious()};
1012 Block read_block_2{*chainman->ReadBlock(tip_2)};
1013 BOOST_CHECK_EQUAL(chainman->ReadBlockSpentOutputs(tip_2).Count(), 0);
1014 BOOST_CHECK_EQUAL(chainman->ReadBlockSpentOutputs(tip).Count(), 0);
1015
1016 // It should be an error if we go another block back, since the genesis has no ancestor
1017 BOOST_CHECK(!tip_2.GetPrevious());
1018
1019 // If we try to validate it again, it should be a duplicate
1020 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
1021 BOOST_CHECK(!new_block);
1022}
1023
1024BOOST_AUTO_TEST_CASE(btck_check_block_context_free)
1025{
1026 constexpr size_t MERKLE_ROOT_OFFSET{4 + 32};
1027 constexpr size_t NBITS_OFFSET{4 + 32 + 32 + 4};
1028 constexpr size_t COINBASE_PREVOUT_N_OFFSET{4 + 32 + 32 + 4 + 4 + 4 + 1 + 4 + 1 + 32};
1029
1030 // Mainnet block 1
1031 auto raw_block = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e362990101000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000");
1032
1033 // Context-free block checks still need consensus params for the optional
1034 // proof-of-work validation path.
1035 ChainParams mainnet_params{ChainType::MAINNET};
1036 auto consensus_params = mainnet_params.GetConsensusParams();
1037
1038 Block block{raw_block};
1040
1041 BOOST_CHECK(block.Check(consensus_params, BlockCheckFlags::BASE, state));
1042 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1043
1044 BOOST_CHECK(block.Check(consensus_params, BlockCheckFlags::ALL, state));
1045 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1046
1047 auto bad_merkle_block_data = raw_block;
1048 bad_merkle_block_data[MERKLE_ROOT_OFFSET] ^= std::byte{0x01};
1049 Block bad_merkle_block{bad_merkle_block_data};
1050
1051 BOOST_CHECK(!bad_merkle_block.Check(consensus_params, BlockCheckFlags::MERKLE, state));
1053 BOOST_CHECK(state.GetBlockValidationResult() == BlockValidationResult::MUTATED);
1054
1055 BOOST_CHECK(bad_merkle_block.Check(consensus_params, BlockCheckFlags::BASE, state));
1056 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1057
1058 auto bad_pow_block_data = raw_block;
1059 bad_pow_block_data[NBITS_OFFSET + 3] = std::byte{0x1c};
1060 Block bad_pow_block{bad_pow_block_data};
1061
1062 BOOST_CHECK(!bad_pow_block.Check(consensus_params, BlockCheckFlags::POW, state));
1064 BOOST_CHECK(state.GetBlockValidationResult() == BlockValidationResult::INVALID_HEADER);
1065
1066 BOOST_CHECK(bad_pow_block.Check(consensus_params, BlockCheckFlags::MERKLE, state));
1067 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1068
1069 auto bad_base_block_data = raw_block;
1070 bad_base_block_data[COINBASE_PREVOUT_N_OFFSET] = std::byte{0x00};
1071 Block bad_base_block{bad_base_block_data};
1072
1073 BOOST_CHECK(!bad_base_block.Check(consensus_params, BlockCheckFlags::BASE, state));
1075 BOOST_CHECK(state.GetBlockValidationResult() == BlockValidationResult::CONSENSUS);
1076
1077 // Test with invalid truncated block data.
1078 auto truncated_block_data = hex_string_to_byte_vec("010000006fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000982051fd1e4ba744bbbe680e1fee14677ba1a3c3540bf7b1cdb606e857233e0e61bc6649ffff001d01e36299");
1079 BOOST_CHECK_EXCEPTION(Block{truncated_block_data}, std::runtime_error,
1080 HasReason{"failed to instantiate btck object"});
1081}
1082
1083BOOST_AUTO_TEST_CASE(btck_chainman_mainnet_tests)
1084{
1085 auto test_directory{TestDirectory{"mainnet_test_bitcoin_kernel"}};
1086 chainman_mainnet_validation_test(test_directory);
1087 chainman_reindex_test(test_directory);
1088 chainman_reindex_chainstate_test(test_directory);
1089}
1090
1091BOOST_AUTO_TEST_CASE(btck_block_hash_tests)
1092{
1093 std::array<std::byte, 32> test_hash;
1094 std::array<std::byte, 32> test_hash_2;
1095 for (int i = 0; i < 32; ++i) {
1096 test_hash[i] = static_cast<std::byte>(i);
1097 test_hash_2[i] = static_cast<std::byte>(i + 1);
1098 }
1099 BlockHash block_hash{test_hash};
1100 BlockHash block_hash_2{test_hash_2};
1101 BOOST_CHECK(block_hash != block_hash_2);
1102 BOOST_CHECK(block_hash == block_hash);
1103 CheckHandle(block_hash, block_hash_2);
1104}
1105
1106BOOST_AUTO_TEST_CASE(btck_block_tree_entry_tests)
1107{
1108 auto test_directory{TestDirectory{"block_tree_entry_test_bitcoin_kernel"}};
1109 auto notifications{std::make_shared<TestKernelNotifications>()};
1110 auto context{create_context(notifications, ChainType::REGTEST)};
1111 auto chainman{create_chainman(
1112 test_directory,
1113 /*reindex=*/false,
1114 /*wipe_chainstate=*/false,
1115 /*block_tree_db_in_memory=*/true,
1116 /*chainstate_db_in_memory=*/true,
1117 context)};
1118
1119 // Process a couple of blocks
1120 for (size_t i{0}; i < 3; i++) {
1122 bool new_block{false};
1123 chainman->ProcessBlock(block, &new_block);
1124 BOOST_CHECK(new_block);
1125 }
1126
1127 auto chain{chainman->GetChain()};
1128 auto entry_0{chain.GetByHeight(0)};
1129 auto entry_1{chain.GetByHeight(1)};
1130 auto entry_2{chain.GetByHeight(2)};
1131
1132 // Test inequality
1133 BOOST_CHECK(entry_0 != entry_1);
1134 BOOST_CHECK(entry_1 != entry_2);
1135 BOOST_CHECK(entry_0 != entry_2);
1136
1137 // Test equality with same entry
1138 BOOST_CHECK(entry_0 == chain.GetByHeight(0));
1139 BOOST_CHECK(entry_0 == BlockTreeEntry{entry_0});
1140 BOOST_CHECK(entry_1 == entry_1);
1141
1142 // Test GetPrevious
1143 auto prev{entry_1.GetPrevious()};
1144 BOOST_CHECK(prev.has_value());
1145 BOOST_CHECK(prev.value() == entry_0);
1146
1147 // Test GetAncestor
1148 BOOST_CHECK(entry_2.GetAncestor(2) == entry_2);
1149 BOOST_CHECK(entry_2.GetAncestor(1) == entry_1);
1150 BOOST_CHECK(entry_2.GetAncestor(0) == entry_0);
1151}
1152
1153BOOST_AUTO_TEST_CASE(btck_chainman_in_memory_tests)
1154{
1155 auto in_memory_test_directory{TestDirectory{"in-memory_test_bitcoin_kernel"}};
1156
1157 auto notifications{std::make_shared<TestKernelNotifications>()};
1158 auto context{create_context(notifications, ChainType::REGTEST)};
1159 auto chainman{create_chainman(
1160 in_memory_test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1161 /*block_tree_db_in_memory=*/true, /*chainstate_db_in_memory=*/true, context)};
1162
1163 for (auto& raw_block : REGTEST_BLOCK_DATA) {
1164 Block block{hex_string_to_byte_vec(raw_block)};
1165 bool new_block{false};
1166 chainman->ProcessBlock(block, &new_block);
1167 BOOST_CHECK(new_block);
1168 }
1169
1170 BOOST_CHECK(fs::exists(in_memory_test_directory.m_directory / "blocks"));
1171 BOOST_CHECK(!fs::exists(in_memory_test_directory.m_directory / "blocks" / "index"));
1172 BOOST_CHECK(!fs::exists(in_memory_test_directory.m_directory / "chainstate"));
1173
1174 BOOST_CHECK(context.interrupt());
1175}
1176
1177BOOST_AUTO_TEST_CASE(btck_chainman_regtest_tests)
1178{
1179 auto test_directory{TestDirectory{"regtest_test_bitcoin_kernel"}};
1180
1181 auto notifications{std::make_shared<TestKernelNotifications>()};
1182 auto context{create_context(notifications, ChainType::REGTEST)};
1183
1184 {
1185 auto chainman{create_chainman(
1186 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1187 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1188 for (const auto& data : REGTEST_BLOCK_DATA) {
1190 BlockHeader header = block.GetHeader();
1191 BlockValidationState state = chainman->ProcessBlockHeader(header);
1192 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1193 BOOST_CHECK(state.GetBlockValidationResult() == BlockValidationResult::UNSET);
1194 BlockTreeEntry entry{*chainman->GetBlockTreeEntry(header.Hash())};
1195 BOOST_CHECK(!chainman->GetChain().Contains(entry));
1196 BlockTreeEntry best_entry{chainman->GetBestEntry()};
1197 BlockHash hash{entry.GetHash()};
1198 BOOST_CHECK(hash == best_entry.GetHeader().Hash());
1199 }
1200 }
1201
1202 // Validate 206 regtest blocks in total.
1203 // Stop halfway to check that it is possible to continue validating starting
1204 // from prior state.
1205 const size_t mid{REGTEST_BLOCK_DATA.size() / 2};
1206
1207 {
1208 auto chainman{create_chainman(
1209 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1210 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1211 for (size_t i{0}; i < mid; i++) {
1213 bool new_block{false};
1214 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
1215 BOOST_CHECK(new_block);
1216 }
1217 }
1218
1219 auto chainman{create_chainman(
1220 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1221 /*block_tree_db_in_memory=*/false, /*chainstate_db_in_memory=*/false, context)};
1222
1223 for (size_t i{mid}; i < REGTEST_BLOCK_DATA.size(); i++) {
1225 bool new_block{false};
1226 BOOST_CHECK(chainman->ProcessBlock(block, &new_block));
1227 BOOST_CHECK(new_block);
1228 }
1229
1230 auto chain = chainman->GetChain();
1231 auto tip = chain.Entries().back();
1232 auto read_block = chainman->ReadBlock(tip).value();
1233 check_equal(read_block.ToBytes(), hex_string_to_byte_vec(REGTEST_BLOCK_DATA[REGTEST_BLOCK_DATA.size() - 1]));
1234
1235 auto tip_2 = tip.GetPrevious().value();
1236 auto read_block_2 = chainman->ReadBlock(tip_2).value();
1237 check_equal(read_block_2.ToBytes(), hex_string_to_byte_vec(REGTEST_BLOCK_DATA[REGTEST_BLOCK_DATA.size() - 2]));
1238
1239 Txid txid = read_block.Transactions()[0].Txid();
1240 Txid txid_2 = read_block_2.Transactions()[0].Txid();
1241 BOOST_CHECK(txid != txid_2);
1242 BOOST_CHECK(txid == txid);
1243 CheckHandle(txid, txid_2);
1244
1245 auto find_transaction = [&chainman](const TxidView& target_txid) -> std::optional<Transaction> {
1246 auto chain = chainman->GetChain();
1247 for (const auto block_tree_entry : chain.Entries()) {
1248 auto block{chainman->ReadBlock(block_tree_entry)};
1249 for (const TransactionView transaction : block->Transactions()) {
1250 if (transaction.Txid() == target_txid) {
1251 return Transaction{transaction};
1252 }
1253 }
1254 }
1255 return std::nullopt;
1256 };
1257
1258 for (const auto block_tree_entry : chain.Entries()) {
1259 auto block{chainman->ReadBlock(block_tree_entry)};
1260 for (const auto transaction : block->Transactions()) {
1261 std::vector<TransactionInput> inputs;
1262 std::vector<TransactionOutput> spent_outputs;
1263 for (const auto input : transaction.Inputs()) {
1264 OutPointView point = input.OutPoint();
1265 if (point.index() == std::numeric_limits<uint32_t>::max()) {
1266 continue;
1267 }
1268 inputs.emplace_back(input);
1269 BOOST_CHECK(point.Txid() != transaction.Txid());
1270 std::optional<Transaction> tx = find_transaction(point.Txid());
1271 BOOST_CHECK(tx.has_value());
1272 BOOST_CHECK(point.Txid() == tx->Txid());
1273 spent_outputs.emplace_back(tx->GetOutput(point.index()));
1274 }
1275 BOOST_CHECK(inputs.size() == spent_outputs.size());
1276 ScriptVerifyStatus status = ScriptVerifyStatus::OK;
1277 const PrecomputedTransactionData precomputed_txdata{transaction, spent_outputs};
1278 for (size_t i{0}; i < inputs.size(); ++i) {
1279 BOOST_CHECK(spent_outputs[i].GetScriptPubkey().Verify(spent_outputs[i].Amount(), transaction, &precomputed_txdata, i, ScriptVerificationFlags::ALL, status));
1280 }
1281 }
1282 }
1283
1284 // Read spent outputs for current tip and its previous block
1285 BlockSpentOutputs block_spent_outputs{chainman->ReadBlockSpentOutputs(tip)};
1286 BlockSpentOutputs block_spent_outputs_prev{chainman->ReadBlockSpentOutputs(*tip.GetPrevious())};
1287 CheckHandle(block_spent_outputs, block_spent_outputs_prev);
1288 CheckRange(block_spent_outputs_prev.TxsSpentOutputs(), block_spent_outputs_prev.Count());
1289 BOOST_CHECK_EQUAL(block_spent_outputs.Count(), 1);
1290
1291 // Get transaction spent outputs from the last transaction in the two blocks
1292 TransactionSpentOutputsView transaction_spent_outputs{block_spent_outputs.GetTxSpentOutputs(block_spent_outputs.Count() - 1)};
1293 TransactionSpentOutputs owned_transaction_spent_outputs{transaction_spent_outputs};
1294 TransactionSpentOutputs owned_transaction_spent_outputs_prev{block_spent_outputs_prev.GetTxSpentOutputs(block_spent_outputs_prev.Count() - 1)};
1295 CheckHandle(owned_transaction_spent_outputs, owned_transaction_spent_outputs_prev);
1296 CheckRange(transaction_spent_outputs.Coins(), transaction_spent_outputs.Count());
1297
1298 // Get the last coin from the transaction spent outputs
1299 CoinView coin{transaction_spent_outputs.GetCoin(transaction_spent_outputs.Count() - 1)};
1300 BOOST_CHECK(!coin.IsCoinbase());
1301 Coin owned_coin{coin};
1302 Coin owned_coin_prev{owned_transaction_spent_outputs_prev.GetCoin(owned_transaction_spent_outputs_prev.Count() - 1)};
1303 CheckHandle(owned_coin, owned_coin_prev);
1304
1305 // Validate coin properties
1306 TransactionOutputView output = coin.GetOutput();
1307 uint32_t coin_height = coin.GetConfirmationHeight();
1308 BOOST_CHECK_EQUAL(coin_height, 143);
1309 BOOST_CHECK_EQUAL(output.Amount(), 3949990974);
1310
1311 // Test script pubkey serialization
1312 auto script_pubkey = output.GetScriptPubkey();
1313 auto script_pubkey_bytes{script_pubkey.ToBytes()};
1314 BOOST_CHECK_EQUAL(script_pubkey_bytes.size(), 34);
1315 auto round_trip_script_pubkey{ScriptPubkey(script_pubkey_bytes)};
1316 BOOST_CHECK_EQUAL(round_trip_script_pubkey.ToBytes().size(), 34);
1317
1318 for (const auto tx_spent_outputs : block_spent_outputs.TxsSpentOutputs()) {
1319 for (const auto coins : tx_spent_outputs.Coins()) {
1320 BOOST_CHECK_GT(coins.GetOutput().Amount(), 1);
1321 }
1322 }
1323
1324 CheckRange(chain.Entries(), chain.CountEntries());
1325
1326 for (const BlockTreeEntry entry : chain.Entries()) {
1327 std::optional<Block> block{chainman->ReadBlock(entry)};
1328 if (block) {
1329 for (const TransactionView transaction : block->Transactions()) {
1330 for (const TransactionOutputView output : transaction.Outputs()) {
1331 // skip data carrier outputs
1332 if ((unsigned char)output.GetScriptPubkey().ToBytes()[0] == 0x6a) {
1333 continue;
1334 }
1335 BOOST_CHECK_GT(output.Amount(), 1);
1336 }
1337 }
1338 }
1339 }
1340
1341 int32_t count{0};
1342 for (const auto entry : chain.Entries()) {
1343 BOOST_CHECK_EQUAL(entry.GetHeight(), count);
1344 ++count;
1345 }
1346 BOOST_CHECK_EQUAL(count, chain.CountEntries());
1347
1348
1349 fs::remove(test_directory.m_directory / "blocks" / "blk00000.dat");
1350 BOOST_CHECK(!chainman->ReadBlock(tip_2).has_value());
1351 fs::remove(test_directory.m_directory / "blocks" / "rev00000.dat");
1352 BOOST_CHECK_THROW(chainman->ReadBlockSpentOutputs(tip), std::runtime_error);
1353}
1354
1355// -----------------------------------------------------------------------------
1356// CheckTransaction tests
1357//
1358// Transaction hex below is copied from src/test/data/tx_invalid.json (entries
1359// marked "BADTX") and tx_valid.json. CheckTransaction performs only basic context-free
1360// consensus checks and can only produce two outcomes:
1361// - VALID (ValidationMode::VALID, TxValidationResult::UNSET)
1362// - INVALID (ValidationMode::INVALID, TxValidationResult::CONSENSUS)
1363// Other TxValidationResult values are set by higher-level validation and are
1364// not reachable through btck_transaction_check.
1365// -----------------------------------------------------------------------------
1366BOOST_AUTO_TEST_CASE(btck_transaction_check_tests)
1367{
1368 using namespace btck;
1369
1370 constexpr std::string_view valid_tx_hex{
1371 "01000000010001000000000000000000000000000000000000000000000000000000000000"
1372 "000000006a473044022067288ea50aa799543a536ff9306f8e1cba05b9c6b10951175b92"
1373 "4f96732555ed022026d7b5265f38d21541519e4a1e55044d5b9e17e15cdbaf29ae3792e9"
1374 "9e883e7a012103ba8c8b86dea131c22ab967e6dd99bdae8eff7a1f75a2c35f1f944109e3"
1375 "fe5e22ffffffff010000000000000000015100000000"};
1376 constexpr std::string_view no_outputs_tx_hex{
1377 "01000000010001000000000000000000000000000000000000000000000000000000000000"
1378 "000000006d483045022100f16703104aab4e4088317c862daec83440242411b039d14280e0"
1379 "3dd33b487ab802201318a7be236672c5c56083eb7a5a195bc57a40af7923ff8545016cd3b5"
1380 "71e2a601232103c40e5d339df3f30bf753e7e04450ae4ef76c9e45587d1d993bdc4cd06f06"
1381 "51c7acffffffff0000000000"};
1382
1383 auto expect_valid = [](std::string_view hex) {
1387 BOOST_CHECK(st.GetValidationMode() == ValidationMode::VALID);
1388 BOOST_CHECK(st.GetTxValidationResult() == TxValidationResult::UNSET);
1389 };
1390
1391 auto expect_invalid = [](std::string_view hex) {
1394 BOOST_CHECK(!CheckTransaction(tx, st));
1396 BOOST_CHECK(st.GetTxValidationResult() == TxValidationResult::CONSENSUS);
1397 };
1398
1399 // Valid: simple 1-in 1-out transaction (from tx_valid.json)
1400 expect_valid(valid_tx_hex);
1401
1402 // Valid coinbase with scriptSig size 2 (from tx_valid.json)
1403 expect_valid(
1404 "01000000010000000000000000000000000000000000000000000000000000000000000000"
1405 "ffffffff025151ffffffff010000000000000000015100000000");
1406
1407 // No outputs (BADTX from tx_invalid.json)
1408 expect_invalid(no_outputs_tx_hex);
1409
1410 {
1411 Transaction valid_tx{hex_string_to_byte_vec(valid_tx_hex)};
1412 Transaction invalid_tx{hex_string_to_byte_vec(no_outputs_tx_hex)};
1413 TxValidationState state;
1414
1415 BOOST_CHECK(btck_transaction_check(valid_tx.get(), state.get()) == 1);
1416 BOOST_CHECK(state.GetValidationMode() == ValidationMode::VALID);
1417 BOOST_CHECK(state.GetTxValidationResult() == TxValidationResult::UNSET);
1418
1419 BOOST_CHECK(btck_transaction_check(invalid_tx.get(), state.get()) == 0);
1421 BOOST_CHECK(state.GetTxValidationResult() == TxValidationResult::CONSENSUS);
1422 }
1423
1424 // Negative output (BADTX)
1425 expect_invalid(
1426 "01000000010001000000000000000000000000000000000000000000000000000000000000"
1427 "000000006d4830450220063222cbb128731fc09de0d7323746539166544d6c1df84d867cce"
1428 "a84bcc8903022100bf568e8552844de664cd41648a031554327aa8844af34b4f27397c65b9"
1429 "2c04de0123210243ec37dee0e2e053a9c976f43147e79bc7d9dc606ea51010af1ac80db6b0"
1430 "69e1acffffffff01ffffffffffffffff015100000000");
1431
1432 // MAX_MONEY + 1 output (BADTX)
1433 expect_invalid(
1434 "01000000010001000000000000000000000000000000000000000000000000000000000000"
1435 "000000006e493046022100e1eadba00d9296c743cb6ecc703fd9ddc9b3cd12906176a226ae"
1436 "4c18d6b00796022100a71aef7d2874deff681ba6080f1b278bac7bb99c61b08a85f4311970"
1437 "ffe7f63f012321030c0588dc44d92bdcbf8e72093466766fdc265ead8db64517b0c542275b"
1438 "70fffbacffffffff010140075af0750700015100000000");
1439
1440 // MAX_MONEY output + 1 output: sum exceeds MAX_MONEY (BADTX)
1441 expect_invalid(
1442 "01000000010001000000000000000000000000000000000000000000000000000000000000"
1443 "000000006d483045022027deccc14aa6668e78a8c9da3484fbcd4f9dcc9bb7d1b85146314b"
1444 "21b9ae4d86022100d0b43dece8cfb07348de0ca8bc5b86276fa88f7f2138381128b7c36ab2"
1445 "e42264012321029bb13463ddd5d2cc05da6e84e37536cb9525703cfd8f43afdb414988987a"
1446 "92f6acffffffff020040075af075070001510001000000000000015100000000");
1447
1448 // Duplicate inputs (BADTX)
1449 expect_invalid(
1450 "01000000020001000000000000000000000000000000000000000000000000000000000000"
1451 "000000006c47304402204bb1197053d0d7799bf1b30cd503c44b58d6240cccbdc85b6fe76d"
1452 "087980208f02204beeed78200178ffc6c74237bb74b3f276bbb4098b5605d814304fe128bf"
1453 "1431012321039e8815e15952a7c3fada1905f8cf55419837133bd7756c0ef14fc8dfe50c0d"
1454 "eaacffffffff0001000000000000000000000000000000000000000000000000000000000000"
1455 "000000006c47304402202306489afef52a6f62e90bf750bbcdf40c06f5c6b138286e6b6b8617"
1456 "6bb9341802200dba98486ea68380f47ebb19a7df173b99e6bc9c681d6ccf3bde31465d1f16"
1457 "b3012321039e8815e15952a7c3fada1905f8cf55419837133bd7756c0ef14fc8dfe50c0dea"
1458 "acffffffff010000000000000000015100000000");
1459
1460 // Coinbase with scriptSig size 1: too small (BADTX)
1461 expect_invalid(
1462 "01000000010000000000000000000000000000000000000000000000000000000000000000"
1463 "ffffffff0151ffffffff010000000000000000015100000000");
1464
1465 // Coinbase with scriptSig size 101: too large (BADTX)
1466 expect_invalid(
1467 "01000000010000000000000000000000000000000000000000000000000000000000000000"
1468 "ffffffff6551515151515151515151515151515151515151515151515151515151515151515151"
1469 "515151515151515151515151515151515151515151515151515151515151515151515151515151"
1470 "51515151515151515151515151515151515151515151515151515151ffffffff01000000000000"
1471 "0000015100000000");
1472
1473 // Null prevout in non-coinbase: two inputs, one is null (BADTX)
1474 expect_invalid(
1475 "01000000020000000000000000000000000000000000000000000000000000000000000000"
1476 "ffffffff00ffffffff000100000000000000000000000000000000000000000000000000000000"
1477 "00000000000000ffffffff010000000000000000015100000000");
1478}
1479
1481{
1482public:
1483 explicit KernelMockTime(std::chrono::seconds timestamp) { set(timestamp); }
1485 {
1486 set_mock_time(std::chrono::seconds{0});
1487 }
1488
1491
1492 void set(std::chrono::seconds timestamp) { set_mock_time(timestamp); }
1493};
1494
1495BOOST_AUTO_TEST_CASE(btck_set_mock_time_tests)
1496{
1497 // Out-of-range timestamps throw
1498 BOOST_CHECK_EXCEPTION(set_mock_time(std::chrono::seconds{-1}), std::runtime_error, HasReason("timestamp out of range"));
1499 constexpr std::chrono::seconds max_time{std::numeric_limits<uint32_t>::max()};
1500 BOOST_CHECK_EXCEPTION(set_mock_time(max_time + std::chrono::seconds{1}), std::runtime_error, HasReason("timestamp out of range"));
1501
1502 // Confirm the mock time actually takes effect by exercising the header future-time check
1503 auto test_directory{TestDirectory{"set_mock_time_test_bitcoin_kernel"}};
1504 auto notifications{std::make_shared<TestKernelNotifications>()};
1505 auto context{create_context(notifications, ChainType::REGTEST)};
1506 auto chainman{create_chainman(
1507 test_directory, /*reindex=*/false, /*wipe_chainstate=*/false,
1508 /*block_tree_db_in_memory=*/true, /*chainstate_db_in_memory=*/true, context)};
1509
1511 BlockHeader header{block.GetHeader()};
1512 const std::chrono::seconds block_time{header.Timestamp()};
1513
1514 // With the time set 3h before the header, the kernel must see the header as >2h in the future and reject it
1515 KernelMockTime mock_time{block_time - std::chrono::hours{3}};
1516 BlockValidationState future_state{chainman->ProcessBlockHeader(header)};
1517 BOOST_CHECK(future_state.GetValidationMode() == ValidationMode::INVALID);
1518 BOOST_CHECK(future_state.GetBlockValidationResult() == BlockValidationResult::TIME_FUTURE);
1519
1520 // At the upper bound the header is far in the past and must be accepted; this also
1521 // confirms the future-time check's "now + 2h" computation doesn't overflow when now is at its max.
1522 mock_time.set(max_time);
1523 BlockValidationState ok_state{chainman->ProcessBlockHeader(header)};
1524 BOOST_CHECK(ok_state.GetValidationMode() == ValidationMode::VALID);
1525 BOOST_CHECK(ok_state.GetBlockValidationResult() == BlockValidationResult::UNSET);
1526}
int btck_transaction_check(const btck_Transaction *tx, btck_TxValidationState *validation_state)
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
KernelMockTime(std::chrono::seconds timestamp)
void set(std::chrono::seconds timestamp)
KernelMockTime & operator=(const KernelMockTime &)=delete
KernelMockTime(const KernelMockTime &)=delete
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 LogMessage(std::string_view message)
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
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
WitnessStackView GetWitnessStack() const
std::vector< std::byte > GetScriptSig() const
ScriptPubkeyView GetScriptPubkey() const
TxValidationResult GetTxValidationResult() const
ValidationMode GetValidationMode() const
Txid(const TxidView &view)
const CType * get() const
std::vector< std::byte > GetItem(size_t index) const
Wtxid(const WtxidView &view)
static const PrecomputedData data
Precomputed COutPoint and CCoins values.
static bool exists(const path &p)
Definition: fs.h:94
#define T(expected, seed, data)
BOOST_CHECK_GT(excessive_headers.size(), MAX_HEADERS_SIZE)
BOOST_CHECK_EQUAL(headers.FindFirst("key"), "value")
BOOST_CHECK_EXCEPTION(HTTPHeaders{}.Read(reader), std::runtime_error, HasReason{"Empty HTTP header name"})
@ ALL
Definition: categories.h:49
@ VALIDATION
Definition: categories.h:36
@ BENCH
Definition: categories.h:20
@ KERNEL
Definition: categories.h:46
void set_mock_time(std::chrono::seconds timestamp)
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)
const auto INVALID
A stack representing the lack of any (dis)satisfactions.
Definition: miniscript.h:353
#define BOOST_CHECK_THROW(stmt, excMatch)
Definition: object.cpp:18
#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:70
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:53
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:88
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:83
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:35
constexpr auto VERIFY_ALL_PRE_TAPROOT
Definition: test_kernel.cpp:86
static int count
bool CheckTransaction(const CTransaction &tx, TxValidationState &state)
Definition: tx_check.cpp:19
WalletContext context