kernel: add btck_block_tree_entry_equals

BlockTreeEntry objects are often compared. By exposing an equality
function, clients don't have to implement more expensive
comparisons based on height and block hash.
This commit is contained in:
stickies-v
2025-11-11 15:09:56 +00:00
parent 1c3d5c8ffd
commit 096924d39d
4 changed files with 63 additions and 0 deletions

View File

@@ -922,6 +922,17 @@ BITCOINKERNEL_API int32_t BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry
BITCOINKERNEL_API const btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_get_block_hash(
const btck_BlockTreeEntry* block_tree_entry) BITCOINKERNEL_ARG_NONNULL(1);
/**
* @brief Check if two block tree entries are equal. Two block tree entries are equal when they
* point to the same block.
*
* @param[in] entry1 Non-null.
* @param[in] entry2 Non-null.
* @return 1 if the block tree entries are equal, 0 otherwise.
*/
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_tree_entry_equals(
const btck_BlockTreeEntry* entry1, const btck_BlockTreeEntry* entry2) BITCOINKERNEL_ARG_NONNULL(1, 2);
///@}
/** @name ChainstateManagerOptions