highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-06-04 02:02:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

kernel: document overwritten validation state outputs

Browse Source 
Document btck_transaction_check and btck_block_check validation state output parameters as overwritten in-place. This matches their reset-on-entry behavior and avoids implying callers should preserve prior state.
This commit is contained in:
w0xlt
2026-04-30 17:50:02 -07:00
parent 489da5df60
commit 0358c26d42
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/kernel/bitcoinkernel.h
View File

@@ -675,10 +675,9 @@ BITCOINKERNEL_API const btck_Txid* BITCOINKERNEL_WARN_UNUSED_RESULT btck_transac
*
* @param[in] tx Non-null, the transaction to validate.
* @param[out] validation_state Non-null, previously created with
* btck_tx_validation_state_create. Reset on
* entry (any prior contents are overwritten)
* and updated in-place with the validation
* result before this function returns.
* btck_tx_validation_state_create.
* Overwritten in-place with the validation
* result.
* @return 1 if valid, 0 if invalid.
* @note Only btck_TxValidationResult_UNSET and
* btck_TxValidationResult_CONSENSUS are
@@ -1383,9 +1382,10 @@ typedef uint32_t btck_BlockCheckFlags;
* optional POW and merkle-root checks. Use
* btck_BlockCheckFlags_BASE to run only the base
* checks.
* @param[in,out] validation_state Non-null, previously created with
* btck_block_validation_state_create and updated
* in-place with the validation result.
* @param[out] validation_state Non-null, previously created with
* btck_block_validation_state_create.
* Overwritten in-place with the validation
* result.
* @return 1 if the btck_Block passed the checks, 0 otherwise.
*/
BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_check(