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

Merge bitcoin/bitcoin#35189: kernel: document validation state outputs as overwritten in-place

Browse Source 
0358c26d42 kernel: document overwritten validation state outputs (w0xlt)

Pull request description:

  This PR updates the public kernel API documentation for validation-state output parameters that are still caller-provided:

  - `btck_transaction_check`
  - `btck_block_check`

  Both wrappers reset the supplied validation state on entry before running validation, so callers should treat the state as overwritten in-place rather than preserving prior contents.

ACKs for top commit:
  yuvicc:
    re-ACK 0358c26d42
  sedited:
    ACK 0358c26d42

Tree-SHA512: f0097c38449c09c6c614a1fb6e5fe09bc84e5dae57c0cb57540419fd6c3f40c06ce8b41e12ab2eff27f4b18d053d32aba2c4a7551a037be93d618b1734922f37
This commit is contained in:
merge-script
2026-05-20 09:46:58 +02:00
parent 489da5df60 0358c26d42
commit 239424064b
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(