milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Document the *_encode_signing_data_to functions 

If one writes signing data using one of the two
`*_encode_signing_data_to` functions then creating the message to sign
is slightly nuanced and different for each of the functions. For Taproot
one must use a specific tagged hash and for ECDSA one must use a sha256d
hash.

Add documentation that explains the hashing requirements for each
function.
This commit is contained in:
Tobin C. Harding 2024-04-23 18:01:01 +10:00
parent 4a4e07d66a
commit dc8b900dec
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bitcoin/src/crypto/sighash.rs
View File

@ -575,6 +575,10 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
/// Encodes the BIP341 signing data for any flag type into a given object implementing the /// Encodes the BIP341 signing data for any flag type into a given object implementing the
/// [`io::Write`] trait. /// [`io::Write`] trait.
///
/// In order to sign, the data written by this function must be hashed using a tagged hash. This
/// can be achieved by using the [`TapSighash::engine()`] function, writing to the engine, then
/// finalizing the hash with [`TapSighash::from_engine()`].
pub fn taproot_encode_signing_data_to<W: Write + ?Sized, T: Borrow<TxOut>>( pub fn taproot_encode_signing_data_to<W: Write + ?Sized, T: Borrow<TxOut>>(
&mut self, &mut self,
writer: &mut W, writer: &mut W,
@ -766,6 +770,10 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
/// `script_code` is dependent on the type of the spend transaction. For p2wpkh use /// `script_code` is dependent on the type of the spend transaction. For p2wpkh use
/// [`Script::p2wpkh_script_code`], for p2wsh just pass in the witness script. (Also see /// [`Script::p2wpkh_script_code`], for p2wsh just pass in the witness script. (Also see
/// [`Self::p2wpkh_signature_hash`] and [`SighashCache::p2wsh_signature_hash`].) /// [`Self::p2wpkh_signature_hash`] and [`SighashCache::p2wsh_signature_hash`].)
///
/// In order to sign, the data written by this function must be hashed using a double SHA256
/// hash. This can be achieved either by using the [`hashes::sha256d::Hash`] type or one of the
/// custom sighash types in this module ([`SegwitV0Sighash`] and [`LegacySighash`]).
pub fn segwit_v0_encode_signing_data_to<W: Write + ?Sized>( pub fn segwit_v0_encode_signing_data_to<W: Write + ?Sized>(
&mut self, &mut self,
writer: &mut W, writer: &mut W,