Squashed 'libbitcoinkernel-sys/bitcoin/' changes from e9f14a07ed8..e95efc00842

e95efc00842 kernel: Add Purpose section to header documentation
6b61ae6cbfb kernel: Allowing reducing exports
d0f3c29c5a6 kernel: Add pure kernel bitcoin-chainstate
574ca377557 Kernel: Add functions for working with outpoints
dc91006a7f5 kernel: Add block hash type and block tree utility functions to C header
06e8f52f589 kernel: Add function to read block undo data from disk to C header
5103abeb636 kernel: Add functions to read block from disk to C header
68b2a8d7b7c kernel: Add function for copying block data to C header
6970d6f7f63 kernel: Add functions for the block validation state to C header
ccefe9f8f8c kernel: Add validation interface to C header
5c8c23b9fe1 kernel: Add interrupt function to C header
eb029703f81 kernel: Add import blocks function to C header
3d969fae26f kernel: Add chainstate load options for in-memory dbs in C header
5215d05b4b6 kernel: Add options for reindexing in C header
cd83907b1d9 kernel: Add block validation to C header
73b92d519db kernel: Add chainstate loading when instantiating a ChainstateManager
c39464d1975 kernel: Add chainstate manager option for setting worker threads
c1a6def012a kernel: Add chainstate manager object to C header
REVERT: e9f14a07ed8 kernel: Add Purpose section to header documentation
REVERT: 8d1a7e84cfb kernel: Allowing reducing exports
REVERT: 9da2c0abcee kernel: Add pure kernel bitcoin-chainstate
REVERT: 33325ffbbe9 Kernel: Add functions for working with outpoints
REVERT: 9fd8f6576fb kernel: Add block hash type and block tree utility functions to C header
REVERT: 07428ce9f46 kernel: Add function to read block undo data from disk to C header
REVERT: 99ee229fda4 kernel: Add functions to read block from disk to C header
REVERT: dcb8d495f2a kernel: Add function for copying block data to C header
REVERT: d42211bd8a4 kernel: Add functions for the block validation state to C header
REVERT: da8db18599c kernel: Add validation interface to C header
REVERT: d5dcd00fa80 kernel: Add interrupt function to C header
REVERT: 523a29fc73f kernel: Add import blocks function to C header
REVERT: e49b9881d90 kernel: Add chainstate load options for in-memory dbs in C header
REVERT: d21cdb3b23d kernel: Add options for reindexing in C header
REVERT: 09afc607fa0 kernel: Add block validation to C header
REVERT: 7333864cb04 kernel: Add chainstate loading when instantiating a ChainstateManager
REVERT: 71509f3856d kernel: Add chainstate manager option for setting worker threads
REVERT: 69f4e9f05aa kernel: Add chainstate manager object to C header

git-subtree-dir: libbitcoinkernel-sys/bitcoin
git-subtree-split: e95efc00842d5d0df96ee9294cdf818741be539e

Author: TheCharlatan

src/bitcoin-chainstate.cpp

@@ -153,7 +153,7 @@ int main(int argc, char* argv[])
 
     logging_set_options(logging_options);
 
-    Logger logger{std::make_unique<KernelLog>(KernelLog{})};
+    Logger logger{std::make_unique<KernelLog>()};
 
     ContextOptions options{};
     ChainParams params{ChainType::MAINNET};

src/kernel/bitcoinkernel.cpp

@@ -1232,16 +1232,19 @@ const btck_Chain* btck_chainstate_manager_get_active_chain(const btck_Chainstate
 
 const btck_BlockTreeEntry* btck_chain_get_tip(const btck_Chain* chain)
 {
+    LOCK(::cs_main);
     return btck_BlockTreeEntry::ref(btck_Chain::get(chain).Tip());
 }
 
 int btck_chain_get_height(const btck_Chain* chain)
 {
+    LOCK(::cs_main);
     return btck_Chain::get(chain).Height();
 }
 
 const btck_BlockTreeEntry* btck_chain_get_genesis(const btck_Chain* chain)
 {
+    LOCK(::cs_main);
     return btck_BlockTreeEntry::ref(btck_Chain::get(chain).Genesis());
 }
 

src/kernel/bitcoinkernel.h

@@ -1018,8 +1018,8 @@ BITCOINKERNEL_API btck_ChainstateManager* BITCOINKERNEL_WARN_UNUSED_RESULT btck_
     const btck_ChainstateManagerOptions* chainstate_manager_options) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
- * @brief Triggers the start of a reindex if the wipe options were previously set for
- * the chainstate and block manager. Can also import an array of existing block
+ * @brief Triggers the start of a reindex if the wipe options were previously
+ * set for the chainstate manager. Can also import an array of existing block
  * files selected by the user.
  *
  * @param[in] chainstate_manager        Non-null.
@@ -1058,11 +1058,13 @@ BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_p
 /**
  * @brief Returns the best known currently active chain. Its lifetime is
  * dependent on the chainstate manager. It can be thought of as a view on a
- * vector of block tree entries that form the best chain. This means state
- * transitions within the chainstate manager, e.g. processing blocks, will
- * change the chain. Data retrieved from this chain is only consistent up to
- * the point when new data is processed in the chainstate manager. It is the
- * user's responsibility to guard against these inconsistencies.
+ * vector of block tree entries that form the best chain. The returned chain
+ * reference always points to the currently active best chain. However, state
+ * transitions within the chainstate manager (e.g., processing blocks) will
+ * update the chain's contents. Data retrieved from this chain is only
+ * consistent up to the point when new data is processed in the chainstate
+ * manager. It is the user's responsibility to guard against these
+ * inconsistencies.
  *
  * @param[in] chainstate_manager Non-null.
  * @return                       The chain.

src/kernel/bitcoinkernel_wrapper.h

@@ -1136,9 +1136,11 @@ class ChainMan : UniqueHandle<btck_ChainstateManager, btck_chainstate_manager_de
         return ChainView{btck_chainstate_manager_get_active_chain(get())};
     }
 
-    BlockTreeEntry GetBlockTreeEntry(const BlockHash& block_hash) const
+    std::optional<BlockTreeEntry> GetBlockTreeEntry(const BlockHash& block_hash) const
     {
-        return btck_chainstate_manager_get_block_tree_entry_by_hash(get(), block_hash.get());
+        auto entry{btck_chainstate_manager_get_block_tree_entry_by_hash(get(), block_hash.get())};
+        if (!entry) return std::nullopt;
+        return entry;
     }
 
     std::optional<Block> ReadBlock(const BlockTreeEntry& entry) const

src/test/kernel/test_kernel.cpp

@@ -148,11 +148,9 @@ class TestValidationInterface : public ValidationInterface
 
     void BlockChecked(Block block, const BlockValidationState state) override
     {
-        {
+        if (m_expected_valid_block.has_value()) {
             auto ser_block{block.ToBytes()};
-            if (m_expected_valid_block.has_value()) {
-                check_equal(m_expected_valid_block.value(), ser_block);
-            }
+            check_equal(m_expected_valid_block.value(), ser_block);
         }
 
         auto mode{state.GetValidationMode()};
@@ -600,7 +598,7 @@ Context create_context(std::shared_ptr<TestKernelNotifications> notifications, C
 
 BOOST_AUTO_TEST_CASE(btck_chainman_tests)
 {
-    Logger logger{std::make_unique<TestLog>(TestLog{})};
+    Logger logger{std::make_unique<TestLog>()};
     auto test_directory{TestDirectory{"chainman_test_bitcoin_kernel"}};
 
     { // test with default context
@@ -690,7 +688,8 @@ void chainman_reindex_test(TestDirectory& test_directory)
 
     auto second_hash{second_index.GetHash()};
     auto another_second_index{chainman->GetBlockTreeEntry(second_hash)};
-    auto another_second_height{another_second_index.GetHeight()};
+    BOOST_CHECK(another_second_index);
+    auto another_second_height{another_second_index->GetHeight()};
     auto second_block_hash{second_block.GetHash()};
     check_equal(second_block_hash.ToBytes(), second_hash.ToBytes());
     BOOST_CHECK_EQUAL(second_height, another_second_height);
@@ -904,25 +903,34 @@ BOOST_AUTO_TEST_CASE(btck_chainman_regtest_tests)
         }
     }
 
+    // Read spent outputs for current tip and its previous block
     BlockSpentOutputs block_spent_outputs{chainman->ReadBlockSpentOutputs(tip)};
     BlockSpentOutputs block_spent_outputs_prev{chainman->ReadBlockSpentOutputs(*tip.GetPrevious())};
     CheckHandle(block_spent_outputs, block_spent_outputs_prev);
     CheckRange(block_spent_outputs_prev.TxsSpentOutputs(), block_spent_outputs_prev.Count());
     BOOST_CHECK_EQUAL(block_spent_outputs.Count(), 1);
+
+    // Get transaction spent outputs from the last transaction in the two blocks
     TransactionSpentOutputsView transaction_spent_outputs{block_spent_outputs.GetTxSpentOutputs(block_spent_outputs.Count() - 1)};
     TransactionSpentOutputs owned_transaction_spent_outputs{transaction_spent_outputs};
     TransactionSpentOutputs owned_transaction_spent_outputs_prev{block_spent_outputs_prev.GetTxSpentOutputs(block_spent_outputs_prev.Count() - 1)};
     CheckHandle(owned_transaction_spent_outputs, owned_transaction_spent_outputs_prev);
     CheckRange(transaction_spent_outputs.Coins(), transaction_spent_outputs.Count());
+
+    // Get the last coin from the transaction spent outputs
     CoinView coin{transaction_spent_outputs.GetCoin(transaction_spent_outputs.Count() - 1)};
     BOOST_CHECK(!coin.IsCoinbase());
     Coin owned_coin{coin};
     Coin owned_coin_prev{owned_transaction_spent_outputs_prev.GetCoin(owned_transaction_spent_outputs_prev.Count() - 1)};
     CheckHandle(owned_coin, owned_coin_prev);
+
+    // Validate coin properties
     TransactionOutputView output = coin.GetOutput();
     uint32_t coin_height = coin.GetConfirmationHeight();
     BOOST_CHECK_EQUAL(coin_height, 205);
     BOOST_CHECK_EQUAL(output.Amount(), 100000000);
+
+    // Test script pubkey serialization
     auto script_pubkey = output.GetScriptPubkey();
     auto script_pubkey_bytes{script_pubkey.ToBytes()};
     BOOST_CHECK_EQUAL(script_pubkey_bytes.size(), 22);