Skip to content

Commit 6afa250

Browse files
committed
docs: tx: fix a documentation warning/improve docs
1 parent 8c8faed commit 6afa250

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

include/wally_transaction.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -895,8 +895,9 @@ WALLY_CORE_API int wally_tx_get_signature_hash(
895895
*| for. For taproot, the leaf script to sign with if any. Ignored for
896896
*| pre-segwit signing.
897897
* :param script_len: Length of ``script`` in bytes.
898-
* :param key_version: Version of pubkey in tapscript. Must be set
899-
*| to `0x00` or `0x01` for taproot script-path signing.
898+
* :param key_version: For taproot signing, the version of the pubkey
899+
*| in ``script`` when signing with a script path. Currently must be ``1``
900+
*| for this case. For non-taproot or keypath signing, it must be ``0``.
900901
* :param codesep_position: BIP342 codeseparator position
901902
*| or ``WALLY_NO_CODESEPARATOR`` if none. Only used for taproot signing.
902903
* :param annex: BIP341 annex, or NULL if none.

0 commit comments

Comments
 (0)