Squashed 'libbitcoinkernel-sys/bitcoin/' changes from e95efc00842..6c7a34f3b0b

TheCharlatan · TheCharlatan · commit 29c3b094fb53 · 2025-11-04T09:54:22.000+01:00
6c7a34f3b0b kernel: Add Purpose section to header documentation
7e9f00bcc17 kernel: Allowing reducing exports
7990463b105 kernel: Add pure kernel bitcoin-chainstate
36ec9a3ea23 Kernel: Add functions for working with outpoints
5eec7fa96aa kernel: Add block hash type and block tree utility functions to C header
f5d5d1213cc kernel: Add function to read block undo data from disk to C header
09d0f626388 kernel: Add functions to read block from disk to C header
a263a4caf23 kernel: Add function for copying block data to C header
b30e15f4329 kernel: Add functions for the block validation state to C header
aa262da7bcf kernel: Add validation interface to C header
d27e27758d5 kernel: Add interrupt function to C header
1976b13be9c kernel: Add import blocks function to C header
a747ca1f516 kernel: Add chainstate load options for in-memory dbs in C header
070e77732cd kernel: Add options for reindexing in C header
ad80abc73df kernel: Add block validation to C header
cb1590b05ef kernel: Add chainstate loading when instantiating a ChainstateManager
e2c1bd3d713 kernel: Add chainstate manager option for setting worker threads
65571c36a26 kernel: Add chainstate manager object to C header
c62f657ba33 kernel: Add notifications context option to C header
9e1bac45852 kernel: Add chain params context option to C header
337ea860dfd kernel: Add kernel library context object
28d679bad9f kernel: Add logging to kernel library C header
2cf136dec4c kernel: Introduce initial kernel C header API
REVERT: e95efc00842 kernel: Add Purpose section to header documentation
REVERT: 6b61ae6cbfb kernel: Allowing reducing exports
REVERT: d0f3c29c5a6 kernel: Add pure kernel bitcoin-chainstate
REVERT: 574ca377557 Kernel: Add functions for working with outpoints
REVERT: dc91006a7f5 kernel: Add block hash type and block tree utility functions to C header
REVERT: 06e8f52f589 kernel: Add function to read block undo data from disk to C header
REVERT: 5103abeb636 kernel: Add functions to read block from disk to C header
REVERT: 68b2a8d7b7c kernel: Add function for copying block data to C header
REVERT: 6970d6f7f63 kernel: Add functions for the block validation state to C header
REVERT: ccefe9f8f8c kernel: Add validation interface to C header
REVERT: 5c8c23b9fe1 kernel: Add interrupt function to C header
REVERT: eb029703f81 kernel: Add import blocks function to C header
REVERT: 3d969fae26f kernel: Add chainstate load options for in-memory dbs in C header
REVERT: 5215d05b4b6 kernel: Add options for reindexing in C header
REVERT: cd83907b1d9 kernel: Add block validation to C header
REVERT: 73b92d519db kernel: Add chainstate loading when instantiating a ChainstateManager
REVERT: c39464d1975 kernel: Add chainstate manager option for setting worker threads
REVERT: c1a6def012a kernel: Add chainstate manager object to C header
REVERT: 06cba4a4653 kernel: Add notifications context option to C header
REVERT: cd809dcae8f kernel: Add chain params context option to C header
REVERT: cf9f9b18474 kernel: Add kernel library context object
REVERT: 776c879eaf7 kernel: Add logging to kernel library C header
REVERT: e3b2e01811f kernel: Introduce initial kernel C header API

git-subtree-dir: libbitcoinkernel-sys/bitcoin
git-subtree-split: 6c7a34f3b0bd39ef7a1520aac56e12f78e5cc969
diff --git a/src/kernel/bitcoinkernel.cpp b/src/kernel/bitcoinkernel.cpp
@@ -84,7 +84,7 @@ class WriterStream
     void write(std::span<const std::byte> src)
     {
         if (m_writer(std::data(src), src.size(), m_user_data) != 0) {
-            throw std::runtime_error("Failed to write serilization data");
+            throw std::runtime_error("Failed to write serialization data");
         }
     }
 
diff --git a/src/kernel/bitcoinkernel.h b/src/kernel/bitcoinkernel.h
@@ -52,7 +52,7 @@ extern "C" {
  *
  * This header currently exposes an API for interacting with parts of Bitcoin
  * Core's consensus code. Users can validate blocks, iterate the block index,
- * read block und undo data from disk, and validate scripts. The header is
+ * read block and undo data from disk, and validate scripts. The header is
  * unversioned and not stable yet. Users should expect breaking changes. It is
  * also not yet included in releases of Bitcoin Core.
  *
@@ -486,7 +486,7 @@ BITCOINKERNEL_API btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transa
 BITCOINKERNEL_API btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_copy(
     const btck_Transaction* transaction) BITCOINKERNEL_ARG_NONNULL(1);
 
-/*
+/**
  * @brief Serializes the transaction through the passed in callback to bytes.
  * This is consensus serialization that is also used for the P2P network.
  *
@@ -516,7 +516,7 @@ BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_count
  * transaction.
  *
  * @param[in] transaction  Non-null.
- * @param[in] output_index The index of the transaction to be retrieved.
+ * @param[in] output_index The index of the transaction output to be retrieved.
  * @return                 The transaction output
  */
 BITCOINKERNEL_API const btck_TransactionOutput* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_get_output_at(
@@ -586,7 +586,7 @@ BITCOINKERNEL_API btck_ScriptPubkey* BITCOINKERNEL_WARN_UNUSED_RESULT btck_scrip
 /**
  * @brief Verify if the input at input_index of tx_to spends the script pubkey
  * under the constraints specified by flags. If the
- * `btck_SCRIPT_FLAGS_VERIFY_WITNESS` flag is set in the flags bitfield, the
+ * `btck_ScriptVerificationFlags_WITNESS` flag is set in the flags bitfield, the
  * amount parameter is used. If the taproot flag is set, the spent outputs
  * parameter is used to validate taproot transactions.
  *
@@ -598,7 +598,7 @@ BITCOINKERNEL_API btck_ScriptPubkey* BITCOINKERNEL_WARN_UNUSED_RESULT btck_scrip
  *                              outputs spent by the transaction.
  * @param[in] spent_outputs_len Length of the spent_outputs array.
  * @param[in] input_index       Index of the input in tx_to spending the script_pubkey.
- * @param[in] flags             Bitfield of btck_ScriptFlags controlling validation constraints.
+ * @param[in] flags             Bitfield of btck_ScriptVerificationFlags controlling validation constraints.
  * @param[out] status           Nullable, will be set to an error code if the operation fails, or OK otherwise.
  * @return                      1 if the script is valid, 0 otherwise.
  */
@@ -611,7 +611,7 @@ BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_verify
     unsigned int flags,
     btck_ScriptVerifyStatus* status) BITCOINKERNEL_ARG_NONNULL(1, 3);
 
-/*
+/**
  * @brief Serializes the script pubkey through the passed in callback to bytes.
  *
  * @param[in] script_pubkey Non-null.
@@ -730,7 +730,7 @@ BITCOINKERNEL_API void btck_logging_set_level_category(btck_LogCategory category
  * changes a global setting and will override settings for all existing @ref
  * btck_LoggingConnection instances.
  *
- * @param[in] category If btck_LOG_ALL is chosen, all categories will be enabled.
+ * @param[in] category If btck_LogCategory_ALL is chosen, all categories will be enabled.
  */
 BITCOINKERNEL_API void btck_logging_enable_category(btck_LogCategory category);
 
@@ -739,7 +739,7 @@ BITCOINKERNEL_API void btck_logging_enable_category(btck_LogCategory category);
  * changes a global setting and will override settings for all existing @ref
  * btck_LoggingConnection instances.
  *
- * @param[in] category If btck_LOG_ALL is chosen, all categories will be disabled.
+ * @param[in] category If btck_LogCategory_ALL is chosen, all categories will be disabled.
  */
 BITCOINKERNEL_API void btck_logging_disable_category(btck_LogCategory category);
 
@@ -1148,7 +1148,7 @@ BITCOINKERNEL_API size_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_count_trans
 BITCOINKERNEL_API const btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_transaction_at(
     const btck_Block* block, size_t transaction_index) BITCOINKERNEL_ARG_NONNULL(1);
 
-/*
+/**
  * @brief Calculate and return the hash of a block.
  *
  * @param[in] block Non-null.
@@ -1157,7 +1157,7 @@ BITCOINKERNEL_API const btck_Transaction* BITCOINKERNEL_WARN_UNUSED_RESULT btck_
 BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_get_hash(
     const btck_Block* block) BITCOINKERNEL_ARG_NONNULL(1);
 
-/*
+/**
  * @brief Serializes the block through the passed in callback to bytes.
  * This is consensus serialization that is also used for the P2P network.
  *
@@ -1219,10 +1219,10 @@ BITCOINKERNEL_API const btck_BlockTreeEntry* BITCOINKERNEL_WARN_UNUSED_RESULT bt
  * @param[in] chain Non-null.
  * @return          The current height.
  */
-BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_height(
+BITCOINKERNEL_API int32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_get_height(
     const btck_Chain* chain) BITCOINKERNEL_ARG_NONNULL(1);
 
-/*
+/**
  * @brief Get the block tree entry of the genesis block.
  *
  * @param[in] chain Non-null.
diff --git a/src/kernel/bitcoinkernel_wrapper.h b/src/kernel/bitcoinkernel_wrapper.h
@@ -972,7 +972,7 @@ class ChainView : public View<btck_Chain>
         return btck_chain_get_tip(get());
     }
 
-    int Height() const
+    int32_t Height() const
     {
         return btck_chain_get_height(get());
     }

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ class WriterStream`
`84`	`84`	`void write(std::span<const std::byte> src)`
`85`	`85`	`{`
`86`	`86`	`if (m_writer(std::data(src), src.size(), m_user_data) != 0) {`
`87`		`- throw std::runtime_error("Failed to write serilization data");`
	`87`	`+ throw std::runtime_error("Failed to write serialization data");`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
Original file line number	Diff line number	Diff line change
`@@ -972,7 +972,7 @@ class ChainView : public View<btck_Chain>`
`972`	`972`	`return btck_chain_get_tip(get());`
`973`	`973`	`}`
`974`	`974`
`975`		`- int Height() const`
	`975`	`+ int32_t Height() const`
`976`	`976`	`{`
`977`	`977`	`return btck_chain_get_height(get());`
`978`	`978`	`}`