Squashed 'libbitcoinkernel-sys/bitcoin/' changes from a755e00a1354..edf99b88e644

edf99b88e644 kernel: Fix bitcoin-chainstate for windows
8fbe027a8a66 kernel: Add Purpose section to header documentation
75f44d950566 kernel: Allowing reducing exports
d3f5df4a38ce kernel: Add pure kernel bitcoin-chainstate
e5009f3707ee Kernel: Add functions for working with outpoints
c337b7e609d5 kernel: Add block hash type and block tree utility functions to C header
7d3f0ced45f0 kernel: Add function to read block undo data from disk to C header
83b7abc0537c kernel: Add functions to read block from disk to C header
4c765dddcbec kernel: Add function for copying block data to C header
ae6570017493 kernel: Add functions for the block validation state to C header
c2bb6b06af78 kernel: Add validation interface to C header
3efd276cedd9 kernel: Add interrupt function to C header
f0ffab556086 kernel: Add import blocks function to C header
bdcb7b8b05ab kernel: Add chainstate load options for in-memory dbs in C header
6dab7199fe78 kernel: Add options for reindexing in C header
bee1c1d7363d kernel: Add block validation to C header
7e2b237e67d1 kernel: Add chainstate loading when instantiating a ChainstateManager
e4f1e00203f2 kernel: Add chainstate manager option for setting worker threads
a7a3138fa2b4 kernel: Add chainstate manager object to C header
564e0cf1bf84 kernel: Add notifications context option to C header
2ce38f954b86 kernel: Add chain params context option to C header
58eae5695813 kernel: Add kernel library context object
c5f8bd0e0ea2 kernel: Add logging to kernel library C header
bff9b7f388c7 kernel: Introduce initial kernel C header API
REVERT: a755e00a1354 kernel: Fix bitcoin-chainstate for windows
REVERT: 670eb49289e3 kernel: Add Purpose section to header documentation
REVERT: 06ee1c7336be kernel: Allowing reducing exports
REVERT: 57b20b5a4d9c kernel: Add pure kernel bitcoin-chainstate
REVERT: 7cf58f8c4cba Kernel: Add functions for working with outpoints
REVERT: 64a4564ccb62 kernel: Add block hash type and block tree utility functions to C header
REVERT: 43855d656eb1 kernel: Add function to read block undo data from disk to C header
REVERT: e080e80da7db kernel: Add functions to read block from disk to C header
REVERT: 51634ca37ab6 kernel: Add function for copying block data to C header
REVERT: 5ed5a9724fdd kernel: Add functions for the block validation state to C header
REVERT: 38e5c526a861 kernel: Add validation interface to C header
REVERT: 38a990dd482e kernel: Add interrupt function to C header
REVERT: fee8f6ff38b1 kernel: Add import blocks function to C header
REVERT: c29a6b87ccdf kernel: Add chainstate load options for in-memory dbs in C header
REVERT: e788b3ba0658 kernel: Add options for reindexing in C header
REVERT: 2707fc515c52 kernel: Add block validation to C header
REVERT: 51a24c4004e8 kernel: Add chainstate loading when instantiating a ChainstateManager
REVERT: ea01a8caf354 kernel: Add chainstate manager option for setting worker threads
REVERT: add5904e0ac8 kernel: Add chainstate manager object to C header
REVERT: 37a3395d2718 kernel: Add notifications context option to C header
REVERT: d838a934be0f kernel: Add chain params context option to C header
REVERT: dc58ae9fc04e kernel: Add kernel library context object
REVERT: 774499759624 kernel: Add logging to kernel library C header
REVERT: dc504f57b3b5 kernel: Introduce initial kernel C header API

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

Author: alexanderwiederin

.github/workflows/ci.yml

@@ -202,7 +202,7 @@ jobs:
         job-type: [standard, fuzz]
         include:
           - job-type: standard
-            generate-options: '-DBUILD_GUI=ON -DWITH_ZMQ=ON -DBUILD_BENCH=ON -DBUILD_KERNEL_LIB=ON -DBUILD_UTIL_CHAINSTATE=ON -DBUILD_KERNEL_TEST=OFF -DWERROR=ON'
+            generate-options: '-DBUILD_GUI=ON -DWITH_ZMQ=ON -DBUILD_BENCH=ON -DBUILD_KERNEL_LIB=ON -DBUILD_UTIL_CHAINSTATE=ON -DWERROR=ON'
             job-name: 'Windows native, VS 2022'
           - job-type: fuzz
             generate-options: '-DVCPKG_MANIFEST_NO_DEFAULT_FEATURES=ON -DVCPKG_MANIFEST_FEATURES="wallet" -DBUILD_GUI=OFF -DBUILD_FOR_FUZZING=ON -DWERROR=ON'

ci/test/00_setup_env_mac_cross.sh

@@ -17,4 +17,4 @@ export XCODE_BUILD_ID=15A240d
 export RUN_UNIT_TESTS=false
 export RUN_FUNCTIONAL_TESTS=false
 export GOAL="deploy"
-export BITCOIN_CONFIG="-DBUILD_GUI=ON -DREDUCE_EXPORTS=ON"
+export BITCOIN_CONFIG="-DBUILD_GUI=ON -DBUILD_KERNEL_LIB=ON -DREDUCE_EXPORTS=ON"

ci/test/00_setup_env_mac_native.sh

@@ -12,7 +12,7 @@ export CONTAINER_NAME="ci_mac_native"  # macos does not use a container, but the
 export PIP_PACKAGES="--break-system-packages zmq"
 export GOAL="install deploy"
 export CMAKE_GENERATOR="Ninja"
-export BITCOIN_CONFIG="-DBUILD_GUI=ON -DWITH_ZMQ=ON -DBUILD_KERNEL_LIB=ON -DBUILD_KERNEL_TEST=ON -DREDUCE_EXPORTS=ON -DCMAKE_EXE_LINKER_FLAGS='-Wl,-stack_size -Wl,0x80000'"
+export BITCOIN_CONFIG="-DBUILD_GUI=ON -DWITH_ZMQ=ON -DBUILD_KERNEL_LIB=ON -DBUILD_UTIL_CHAINSTATE=ON -DBUILD_KERNEL_TEST=ON -DREDUCE_EXPORTS=ON -DCMAKE_EXE_LINKER_FLAGS='-Wl,-stack_size -Wl,0x80000'"
 export CI_OS_NAME="macos"
 export NO_DEPENDS=1
 export OSX_SDK=""

src/kernel/bitcoinkernel.cpp

@@ -629,6 +629,8 @@ int btck_script_pubkey_verify(const btck_ScriptPubkey* script_pubkey,
         return 0;
     }
 
+    if (status) *status = btck_ScriptVerifyStatus_OK;
+
     const CTransaction& tx{*btck_Transaction::get(tx_to)};
     std::vector<CTxOut> spent_outputs;
     if (spent_outputs_ != nullptr) {

src/kernel/bitcoinkernel.h

@@ -425,9 +425,9 @@ typedef struct {
  * A collection of status codes that may be issued by the script verify function.
  */
 typedef uint8_t btck_ScriptVerifyStatus;
-#define btck_ScriptVerifyStatus_SCRIPT_VERIFY_OK ((btck_ScriptVerifyStatus)(0))
-#define btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION ((btck_ScriptVerifyStatus)(2)) //!< The flags were combined in an invalid way.
-#define btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED ((btck_ScriptVerifyStatus)(3))    //!< The taproot flag was set, so valid spent_outputs have to be provided.
+#define btck_ScriptVerifyStatus_OK ((btck_ScriptVerifyStatus)(0))
+#define btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION ((btck_ScriptVerifyStatus)(1)) //!< The flags were combined in an invalid way.
+#define btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED ((btck_ScriptVerifyStatus)(2))    //!< The taproot flag was set, so valid spent_outputs have to be provided.
 
 /**
  * Script verification flags that may be composed with each other.
@@ -594,8 +594,7 @@ BITCOINKERNEL_API btck_ScriptPubkey* BITCOINKERNEL_WARN_UNUSED_RESULT btck_scrip
  * @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[out] status           Nullable, will be set to an error code if the operation fails.
- *                              Should be set to btck_SCRIPT_VERIFY_OK.
+ * @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.
  */
 BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_script_pubkey_verify(
@@ -670,7 +669,7 @@ BITCOINKERNEL_API int64_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_outp
  *  @param[in] transaction_output Non-null.
  *  @return                       The copied transaction output.
  */
-BITCOINKERNEL_API btck_TransactionOutput* btck_transaction_output_copy(
+BITCOINKERNEL_API btck_TransactionOutput* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_output_copy(
     const btck_TransactionOutput* transaction_output) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
@@ -954,7 +953,7 @@ BITCOINKERNEL_API void btck_chainstate_manager_options_set_worker_threads_num(
  * @param[in] wipe_chainstate_db         Set wipe chainstate db.
  * @return                               0 if the set was successful, non-zero if the set failed.
  */
-BITCOINKERNEL_API int btck_chainstate_manager_options_set_wipe_dbs(
+BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_options_set_wipe_dbs(
     btck_ChainstateManagerOptions* chainstate_manager_options,
     int wipe_block_tree_db,
     int wipe_chainstate_db) BITCOINKERNEL_ARG_NONNULL(1);
@@ -1013,7 +1012,7 @@ BITCOINKERNEL_API btck_ChainstateManager* BITCOINKERNEL_WARN_UNUSED_RESULT btck_
  * @param[in] block_file_paths_data_len Length of the block_file_paths_data and block_file_paths_len arrays.
  * @return                              0 if the import blocks call was completed successfully, non-zero otherwise.
  */
-BITCOINKERNEL_API int btck_chainstate_manager_import_blocks(
+BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chainstate_manager_import_blocks(
     btck_ChainstateManager* chainstate_manager,
     const char** block_file_paths_data, size_t* block_file_paths_lens,
     size_t block_file_paths_data_len) BITCOINKERNEL_ARG_NONNULL(1, 2);
@@ -1235,7 +1234,7 @@ BITCOINKERNEL_API const btck_BlockTreeEntry* BITCOINKERNEL_WARN_UNUSED_RESULT bt
  * @return                     1 if the block_tree_entry is in the chain, 0 otherwise.
  *
  */
-BITCOINKERNEL_API int btck_chain_contains(
+BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_chain_contains(
     const btck_Chain* chain,
     const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1, 2);
 
@@ -1393,7 +1392,7 @@ BITCOINKERNEL_API btck_TransactionOutPoint* BITCOINKERNEL_WARN_UNUSED_RESULT btc
  * @param[in] transaction_out_point Non-null.
  * @return                          The output index.
  */
-BITCOINKERNEL_API uint32_t btck_transaction_out_point_get_index(
+BITCOINKERNEL_API uint32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_get_index(
     const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
@@ -1403,7 +1402,7 @@ BITCOINKERNEL_API uint32_t btck_transaction_out_point_get_index(
  * @param[in] transaction_out_point Non-null.
  * @return                          The txid.
  */
-BITCOINKERNEL_API const btck_Txid* btck_transaction_out_point_get_txid(
+BITCOINKERNEL_API const btck_Txid* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transaction_out_point_get_txid(
     const btck_TransactionOutPoint* transaction_out_point) BITCOINKERNEL_ARG_NONNULL(1);
 
 /**
@@ -1434,7 +1433,7 @@ BITCOINKERNEL_API btck_Txid* BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_copy(
  * @param[in] txid2 Non-null.
  * @return          0 if the txid is not equal.
  */
-BITCOINKERNEL_API int btck_txid_equals(
+BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_txid_equals(
     const btck_Txid* txid1, const btck_Txid* txid2) BITCOINKERNEL_ARG_NONNULL(1, 2);
 
 /**
@@ -1523,7 +1522,7 @@ BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_ha
  * @param[in] hash2 Non-null.
  * @return          0 if the block hashes are not equal.
  */
-BITCOINKERNEL_API int btck_block_hash_equals(
+BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_hash_equals(
     const btck_BlockHash* hash1, const btck_BlockHash* hash2) BITCOINKERNEL_ARG_NONNULL(1, 2);
 
 /**

src/kernel/bitcoinkernel_wrapper.h

@@ -21,9 +21,6 @@
 
 namespace btck {
 
-class Transaction;
-class TransactionOutput;
-
 enum class LogCategory : btck_LogCategory {
     ALL = btck_LogCategory_ALL,
     BENCH = btck_LogCategory_BENCH,
@@ -82,7 +79,7 @@ enum class BlockValidationResult : btck_BlockValidationResult {
 };
 
 enum class ScriptVerifyStatus : btck_ScriptVerifyStatus {
-    OK = btck_ScriptVerifyStatus_SCRIPT_VERIFY_OK,
+    OK = btck_ScriptVerifyStatus_OK,
     ERROR_INVALID_FLAGS_COMBINATION = btck_ScriptVerifyStatus_ERROR_INVALID_FLAGS_COMBINATION,
     ERROR_SPENT_OUTPUTS_REQUIRED = btck_ScriptVerifyStatus_ERROR_SPENT_OUTPUTS_REQUIRED,
 };
@@ -259,6 +256,12 @@ class Range
     value_type back() const { return (*this)[size() - 1]; }
 };
 
+#define MAKE_RANGE_METHOD(method_name, ContainerType, SizeFunc, GetFunc, container_expr) \
+    auto method_name() const & { \
+        return Range<ContainerType, SizeFunc, GetFunc>{container_expr}; \
+    } \
+    auto method_name() const && = delete;
+
 template <typename T>
 std::vector<std::byte> write_bytes(const T* object, int (*to_bytes)(const T*, btck_WriteBytes, void*))
 {
@@ -596,15 +599,9 @@ class TransactionApi
         return TxidView{btck_transaction_get_txid(impl())};
     }
 
-    auto Outputs() const
-    {
-        return Range<Derived, &TransactionApi<Derived>::CountOutputs, &TransactionApi<Derived>::GetOutput>{*static_cast<const Derived*>(this)};
-    }
+    MAKE_RANGE_METHOD(Outputs, Derived, &TransactionApi<Derived>::CountOutputs, &TransactionApi<Derived>::GetOutput, *static_cast<const Derived*>(this))
 
-    auto Inputs() const
-    {
-        return Range<Derived, &TransactionApi<Derived>::CountInputs, &TransactionApi<Derived>::GetInput>{*static_cast<const Derived*>(this)};
-    }
+    MAKE_RANGE_METHOD(Inputs, Derived, &TransactionApi<Derived>::CountInputs, &TransactionApi<Derived>::GetInput, *static_cast<const Derived*>(this))
 
     std::vector<std::byte> ToBytes() const
     {
@@ -724,10 +721,7 @@ class Block : public Handle<btck_Block, btck_block_copy, btck_block_destroy>
         return TransactionView{btck_block_get_transaction_at(get(), index)};
     }
 
-    auto Transactions() const
-    {
-        return Range<Block, &Block::CountTransactions, &Block::GetTransaction>{*this};
-    }
+    MAKE_RANGE_METHOD(Transactions, Block, &Block::CountTransactions, &Block::GetTransaction, *this)
 
     BlockHash GetHash() const
     {
@@ -994,6 +988,11 @@ class ChainView : public View<btck_Chain>
         return btck_chain_get_height(get());
     }
 
+    int CountEntries() const
+    {
+        return btck_chain_get_height(get()) + 1;
+    }
+
     BlockTreeEntry Genesis() const
     {
         return btck_chain_get_genesis(get());
@@ -1011,10 +1010,7 @@ class ChainView : public View<btck_Chain>
         return btck_chain_contains(get(), entry.get());
     }
 
-    auto Entries() const
-    {
-        return Range<ChainView, &ChainView::Height, &ChainView::GetByHeight>{*this};
-    }
+    MAKE_RANGE_METHOD(Entries, ChainView, &ChainView::CountEntries, &ChainView::GetByHeight, *this)
 };
 
 template <typename Derived>
@@ -1077,10 +1073,7 @@ class TransactionSpentOutputsApi
         return CoinView{btck_transaction_spent_outputs_get_coin_at(impl(), index)};
     }
 
-    auto Coins() const
-    {
-        return Range<Derived, &TransactionSpentOutputsApi<Derived>::Count, &TransactionSpentOutputsApi<Derived>::GetCoin>{*static_cast<const Derived*>(this)};
-    }
+    MAKE_RANGE_METHOD(Coins, Derived, &TransactionSpentOutputsApi<Derived>::Count, &TransactionSpentOutputsApi<Derived>::GetCoin, *static_cast<const Derived*>(this))
 };
 
 class TransactionSpentOutputsView : public View<btck_TransactionSpentOutputs>, public TransactionSpentOutputsApi<TransactionSpentOutputsView>
@@ -1116,10 +1109,7 @@ class BlockSpentOutputs : public Handle<btck_BlockSpentOutputs, btck_block_spent
         return TransactionSpentOutputsView{btck_block_spent_outputs_get_transaction_spent_outputs_at(get(), tx_undo_index)};
     }
 
-    auto TxsSpentOutputs() const
-    {
-        return Range<BlockSpentOutputs, &BlockSpentOutputs::Count, &BlockSpentOutputs::GetTxSpentOutputs>{*this};
-    }
+    MAKE_RANGE_METHOD(TxsSpentOutputs, BlockSpentOutputs, &BlockSpentOutputs::Count, &BlockSpentOutputs::GetTxSpentOutputs, *this)
 };
 
 class ChainMan : UniqueHandle<btck_ChainstateManager, btck_chainstate_manager_destroy>