Squashed 'depend/bitcoin/' changes from 0fc068b735d..2ac9d60c54a

2ac9d60c54a kernel: Fix bitcoin-chainstate for windows
08e2a7ebbb9 kernel: Add Purpose section to header documentation
9d95715fe46 kernel: Allowing reducing exports
241f306df61 kernel: Add pure kernel bitcoin-chainstate
3ed3d6b9c25 kernel: Add functions to get the block hash from a block
3fe143dc6c3 kernel: Add block index utility functions to C header
224dbec1ce5 kernel: Add function to read block undo data from disk to C header
4e5b9c66d36 kernel: Add functions to read block from disk to C header
e4ef0011f7e kernel: Add function for copying block data to C header
3e7711d271d kernel: Add functions for the block validation state to C header
984305a1afb kernel: Add validation interface to C header
ff1fe96997b kernel: Add interrupt function to C header
b45d0abbea2 kernel: Add import blocks function to C header
dc939ae9471 kernel: Add chainstate load options for in-memory dbs in C header
0ea93d86242 kernel: Add options for reindexing in C header
5817e2e79bd kernel: Add block validation to C header
32d9e4a547b kernel: Add chainstate loading when instantiating a ChainstateManager
e3c03bae40b kernel: Add chainstate manager option for setting worker threads
f6978da0f73 kernel: Add chainstate manager object to C header
63d6e4fade2 kernel: Add notifications context option to C header
ee9c2c7ceac kernel: Add chain params context option to C header
2919e083e1b kernel: Add kernel library context object
7967ffa7476 kernel: Add logging to kernel library C header
c76dcaafbc7 kernel: Introduce initial kernel C header API
REVERT: 0fc068b735d kernel: Fix bitcoin-chainstate for windows
REVERT: f6715d22de1 kernel: Add Purpose section to header documentation
REVERT: 73730490630 kernel: Allowing reducing exports
REVERT: 9ce6ef9e2ae kernel: Add pure kernel bitcoin-chainstate
REVERT: 27df296c3c5 kernel: Add functions to get the block hash from a block
REVERT: f013c296304 kernel: Add block index utility functions to C header
REVERT: 91d571ab3aa kernel: Add function to read block undo data from disk to C header
REVERT: c4b6912a4bf kernel: Add functions to read block from disk to C header
REVERT: ef25a7cfff1 kernel: Add function for copying block data to C header
REVERT: 79499fc875b kernel: Add functions for the block validation state to C header
REVERT: aace9f3da57 kernel: Add validation interface to C header
REVERT: 2a6652522d1 kernel: Add interrupt function to C header
REVERT: c29e530dd30 kernel: Add import blocks function to C header
REVERT: b06a333711e kernel: Add chainstate load options for in-memory dbs in C header
REVERT: 3fc6a85f30d kernel: Add options for reindexing in C header
REVERT: 6e86239dee9 kernel: Add block validation to C header
REVERT: d05b0756567 kernel: Add chainstate loading when instantiating a ChainstateManager
REVERT: 2508d94192f kernel: Add chainstate manager option for setting worker threads
REVERT: 514bbe5ad80 kernel: Add chainstate manager object to C header
REVERT: 341b00345ce kernel: Add notifications context option to C header
REVERT: 3cde1d242b8 kernel: Add chain params context option to C header
REVERT: 51f3d54d0d4 kernel: Add kernel library context object
REVERT: c3424d8750e kernel: Add logging to kernel library C header
REVERT: 7d4163c0afa kernel: Introduce initial kernel C header API

git-subtree-dir: depend/bitcoin
git-subtree-split: 2ac9d60c54a777978101c369f5895a933208a44c

Author: stringintech

src/kernel/bitcoinkernel.cpp

@@ -470,6 +470,7 @@ struct btck_Chain : Handle<btck_Chain, CChain> {};
 struct btck_BlockSpentOutputs : Handle<btck_BlockSpentOutputs, std::shared_ptr<CBlockUndo>> {};
 struct btck_TransactionSpentOutputs : Handle<btck_TransactionSpentOutputs, CTxUndo> {};
 struct btck_Coin : Handle<btck_Coin, Coin> {};
+struct btck_BlockHash : Handle<btck_BlockHash, uint256> {};
 
 btck_Transaction* btck_transaction_create(const void* raw_transaction, size_t raw_transaction_len)
 {
@@ -889,9 +890,8 @@ btck_ChainstateManager* btck_chainstate_manager_create(
 
 const btck_BlockTreeEntry* btck_chainstate_manager_get_block_tree_entry_by_hash(const btck_ChainstateManager* chainman, const btck_BlockHash* block_hash)
 {
-    auto hash = uint256{std::span<const unsigned char>{(*block_hash).hash, 32}};
     auto block_index = WITH_LOCK(btck_ChainstateManager::get(chainman).m_chainman->GetMutex(),
-                                 return btck_ChainstateManager::get(chainman).m_chainman->m_blockman.LookupBlockIndex(hash));
+                                 return btck_ChainstateManager::get(chainman).m_chainman->m_blockman.LookupBlockIndex(btck_BlockHash::get(block_hash)));
     if (!block_index) {
         LogDebug(BCLog::KERNEL, "A block with the given hash is not indexed.");
         return nullptr;
@@ -978,10 +978,7 @@ int btck_block_to_bytes(const btck_Block* block, btck_WriteBytes writer, void* u
 
 btck_BlockHash* btck_block_get_hash(const btck_Block* block)
 {
-    auto hash{btck_Block::get(block)->GetHash()};
-    auto block_hash = new btck_BlockHash{};
-    std::memcpy(block_hash->hash, hash.begin(), sizeof(hash));
-    return block_hash;
+    return btck_BlockHash::create(btck_Block::get(block)->GetHash());
 }
 
 void btck_block_destroy(btck_Block* block)
@@ -1009,9 +1006,22 @@ btck_BlockHash* btck_block_tree_entry_get_block_hash(const btck_BlockTreeEntry*
     if (btck_BlockTreeEntry::get(entry).phashBlock == nullptr) {
         return nullptr;
     }
-    auto block_hash = new btck_BlockHash{};
-    std::memcpy(block_hash->hash, btck_BlockTreeEntry::get(entry).phashBlock->begin(), sizeof(*btck_BlockTreeEntry::get(entry).phashBlock));
-    return block_hash;
+    return btck_BlockHash::create(btck_BlockTreeEntry::get(entry).GetBlockHash());
+}
+
+btck_BlockHash* btck_block_hash_create(const unsigned char block_hash[32])
+{
+    return btck_BlockHash::create(std::span<const unsigned char>{block_hash, 32});
+}
+
+btck_BlockHash* btck_block_hash_copy(const btck_BlockHash* block_hash)
+{
+    return btck_BlockHash::copy(block_hash);
+}
+
+void btck_block_hash_to_bytes(const btck_BlockHash* block_hash, unsigned char output[32])
+{
+    std::memcpy(output, btck_BlockHash::get(block_hash).begin(), 32);
 }
 
 void btck_block_hash_destroy(btck_BlockHash* hash)

src/kernel/bitcoinkernel.h

@@ -249,6 +249,13 @@ typedef struct btck_TransactionSpentOutputs btck_TransactionSpentOutputs;
  */
 typedef struct btck_Coin btck_Coin;
 
+/**
+ * Opaque data structure for holding a block hash.
+ *
+ * This is a type-safe identifier for a block.
+ */
+typedef struct btck_BlockHash btck_BlockHash;
+
 /** Current sync state passed to tip changed callbacks. */
 typedef uint8_t btck_SynchronizationState;
 #define btck_SynchronizationState_INIT_REINDEX ((btck_SynchronizationState)(0))
@@ -426,13 +433,6 @@ typedef uint8_t btck_ChainType;
 #define btck_ChainType_SIGNET ((btck_ChainType)(3))
 #define btck_ChainType_REGTEST ((btck_ChainType)(4))
 
-/**
- * A type-safe block identifier.
- */
-typedef struct {
-    unsigned char hash[32];
-} btck_BlockHash;
-
 /** @name Transaction
  * Functions for working with transactions.
  */
@@ -853,6 +853,15 @@ BITCOINKERNEL_API const btck_BlockTreeEntry* BITCOINKERNEL_WARN_UNUSED_RESULT bt
 BITCOINKERNEL_API int32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_height(
     const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
 
+/**
+ * @brief Return the block hash associated with a block tree entry.
+ *
+ * @param[in] block_tree_entry Non-null.
+ * @return                     The block hash.
+ */
+BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_hash(
+    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
+
 ///@}
 
 /** @name ChainstateManagerOptions
@@ -1087,7 +1096,7 @@ BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_ge
  * @param[in] writer    Non-null, callback to a write bytes function.
  * @param[in] user_data Holds a user-defined opaque structure that will be
  *                      passed back through the writer callback.
- * @return              True on success.
+ * @return              0 on success.
  */
 BITCOINKERNEL_API int btck_block_to_bytes(
     const btck_Block* block,
@@ -1336,13 +1345,28 @@ BITCOINKERNEL_API void btck_coin_destroy(btck_Coin* coin);
 ///@{
 
 /**
- * @brief Return the block hash associated with a block tree entry.
+ * @brief Create a block hash from its raw data.
+ */
+BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_create(
+    const unsigned char block_hash[32]) BITCOINKERNEL_ARG_NONNULL(1);
+
+/**
+ * @brief Copy a block hash.
  *
- * @param[in] block_tree_entry Non-null.
- * @return                     The block hash.
+ * @param[in] block_hash Non-null.
+ * @return               The copied block hash.
  */
-BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_hash(
-    const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
+BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_copy(
+    const btck_BlockHash* block_hash) BITCOINKERNEL_ARG_NONNULL(1);
+
+/**
+ * @brief Serializes the block hash to bytes.
+ *
+ * @param[in] block_hash     Non-null.
+ * @param[in] output         The serialized block hash.
+ */
+BITCOINKERNEL_API void btck_block_hash_to_bytes(
+    const btck_BlockHash* block_hash, unsigned char output[32]) BITCOINKERNEL_ARG_NONNULL(1, 2);
 
 /**
  * Destroy the block hash.

src/kernel/bitcoinkernel_wrapper.h

@@ -7,6 +7,7 @@
 
 #include <kernel/bitcoinkernel.h>
 
+#include <array>
 #include <functional>
 #include <memory>
 #include <optional>
@@ -473,7 +474,7 @@ class TransactionApi
 
     auto Outputs() const
     {
-        return Range<Transaction, &TransactionApi::CountOutputs, &TransactionApi::GetOutput>{*static_cast<const Derived*>(this)};
+        return Range<Derived, &TransactionApi<Derived>::CountOutputs, &TransactionApi<Derived>::GetOutput>{*static_cast<const Derived*>(this)};
     }
 
     std::vector<std::byte> ToBytes() const
@@ -527,10 +528,20 @@ bool ScriptPubkeyApi<Derived>::Verify(int64_t amount,
     return result == 1;
 }
 
-struct BlockHashDeleter {
-    void operator()(btck_BlockHash* ptr) const
+class BlockHash : public Handle<btck_BlockHash, btck_block_hash_copy, btck_block_hash_destroy>
+{
+public:
+    explicit BlockHash(const std::array<std::byte, 32>& hash)
+        : Handle{btck_block_hash_create(reinterpret_cast<const unsigned char*>(hash.data()))} {}
+
+    explicit BlockHash(btck_BlockHash* hash)
+        : Handle{hash} {}
+
+    std::array<std::byte, 32> Bytes() const
     {
-        btck_block_hash_destroy(ptr);
+        std::array<std::byte, 32> hash;
+        btck_block_hash_to_bytes(get(), reinterpret_cast<unsigned char*>(hash.data()));
+        return hash;
     }
 };
 
@@ -559,9 +570,9 @@ class Block : public Handle<btck_Block, btck_block_copy, btck_block_destroy>
         return Range<Block, &Block::CountTransactions, &Block::GetTransaction>{*this};
     }
 
-    std::unique_ptr<btck_BlockHash, BlockHashDeleter> GetHash() const
+    BlockHash GetHash() const
     {
-        return std::unique_ptr<btck_BlockHash, BlockHashDeleter>(btck_block_get_hash(get()));
+        return BlockHash{btck_block_get_hash(get())};
     }
 
     std::vector<std::byte> ToBytes() const
@@ -631,9 +642,9 @@ class BlockTreeEntry : public View<btck_BlockTreeEntry>
         return btck_block_tree_entry_get_height(get());
     }
 
-    std::unique_ptr<btck_BlockHash, BlockHashDeleter> GetHash() const
+    BlockHash GetHash() const
     {
-        return std::unique_ptr<btck_BlockHash, BlockHashDeleter>(btck_block_tree_entry_get_block_hash(get()));
+        return BlockHash{btck_block_tree_entry_get_block_hash(get())};
     }
 
     friend class ChainMan;
@@ -761,6 +772,10 @@ class Context : public Handle<btck_Context, btck_context_copy, btck_context_dest
     Context()
         : Handle{check(btck_context_create(ContextOptions{}.get()))} {}
 
+    bool interrupt() {
+        return btck_context_interrupt(get()) == 0;
+    }
+
     friend class ChainstateManagerOptions;
 };
 
@@ -848,7 +863,7 @@ class CoinApi
 public:
     uint32_t GetConfirmationHeight() const { return btck_coin_confirmation_height(impl()); }
 
-    bool IsCoinbase() const { return btck_coin_is_coinbase(impl()); }
+    bool IsCoinbase() const { return btck_coin_is_coinbase(impl()) == 1; }
 
     TransactionOutputView GetOutput() const
     {
@@ -866,6 +881,8 @@ class Coin : Handle<btck_Coin, btck_coin_copy, btck_coin_destroy>, public CoinAp
 {
 public:
     Coin(btck_Coin* coin) : Handle{check(coin)} {}
+
+    Coin(const CoinView& view) : Handle{view} {}
 };
 
 template <typename Derived>
@@ -908,6 +925,8 @@ class TransactionSpentOutputs : Handle<btck_TransactionSpentOutputs, btck_transa
 {
 public:
     TransactionSpentOutputs(btck_TransactionSpentOutputs* transaction_spent_outputs) : Handle{check(transaction_spent_outputs)} {}
+
+    TransactionSpentOutputs(const TransactionSpentOutputsView& view) : Handle{view} {}
 };
 
 class BlockSpentOutputs : Handle<btck_BlockSpentOutputs, btck_block_spent_outputs_copy, btck_block_spent_outputs_destroy>
@@ -969,12 +988,12 @@ class ChainMan : UniqueHandle<btck_ChainstateManager, btck_chainstate_manager_de
         return ChainView{btck_chainstate_manager_get_active_chain(get())};
     }
 
-    BlockTreeEntry GetBlockTreeEntry(btck_BlockHash* block_hash) const
+    BlockTreeEntry GetBlockTreeEntry(const btck_BlockHash* block_hash) const
     {
         return btck_chainstate_manager_get_block_tree_entry_by_hash(get(), block_hash);
     }
 
-    std::optional<Block> ReadBlock(BlockTreeEntry& entry) const
+    std::optional<Block> ReadBlock(const BlockTreeEntry& entry) const
     {
         auto block{btck_block_read(get(), entry.get())};
         if (!block) return std::nullopt;