From 1c04a99ec39945ca1d55bbec3537495c579ebebd Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Wed, 3 Aug 2022 12:22:31 +1000 Subject: [PATCH] Use sighash::SighashCache for bip143 unit tests We have a bunch of unit tests that verify the BIP 143 test vectors. Three of these use the deprecated `SighashComponents` struct. We should implement these tests using the new `SighashCache`. In order to do so we have to move the tests to the `sighash` module so they can get access to the private `segwit_cache()` function, and verify the cache internal state against the test vectors. Re-write the BIP 143 test vector code using `SighashCache` and remove the versions using `SighashComponents`. Done in preparation for removing the deprecated `SighashComponents`. --- src/util/bip143.rs | 127 -------------------------------------------- src/util/sighash.rs | 110 +++++++++++++++++++++++++++++++++++++- 2 files changed, 109 insertions(+), 128 deletions(-) diff --git a/src/util/bip143.rs b/src/util/bip143.rs index f20a67ea..0bed0daf 100644 --- a/src/util/bip143.rs +++ b/src/util/bip143.rs @@ -178,25 +178,14 @@ impl> SigHashCache { #[cfg(test)] #[allow(deprecated)] mod tests { - use std::str::FromStr; use crate::hash_types::Sighash; use crate::blockdata::script::Script; use crate::blockdata::transaction::Transaction; - use crate::blockdata::locktime::LockTime; use crate::consensus::encode::deserialize; - use crate::network::constants::Network; - use crate::util::address::Address; - use crate::util::key::PublicKey; use crate::hashes::hex::FromHex; - use crate::internal_macros::{hex_hash, hex_script}; use super::*; - fn p2pkh_hex(pk: &str) -> Script { - let pk: PublicKey = PublicKey::from_str(pk).unwrap(); - Address::p2pkh(&pk, Network::Bitcoin).script_pubkey() - } - fn run_test_sighash_bip143(tx: &str, script: &str, input_index: usize, value: u64, hash_type: u32, expected_result: &str) { let tx: Transaction = deserialize(&Vec::::from_hex(tx).unwrap()[..]).unwrap(); let script = Script::from(Vec::::from_hex(script).unwrap()); @@ -208,122 +197,6 @@ mod tests { assert_eq!(actual_result, expected_result); } - #[test] - fn bip143_p2wpkh() { - let tx = deserialize::( - &Vec::from_hex( - "0100000002fff7f7881a8099afa6940d42d1e7f6362bec38171ea3edf433541db4e4ad969f000000\ - 0000eeffffffef51e1b804cc89d182d279655c3aa89e815b1b309fe287d9b2b55d57b90ec68a01000000\ - 00ffffffff02202cb206000000001976a9148280b37df378db99f66f85c95a783a76ac7a6d5988ac9093\ - 510d000000001976a9143bde42dbee7e4dbe6a21b2d50ce2f0167faa815988ac11000000", - ).unwrap()[..], - ).unwrap(); - - let witness_script = p2pkh_hex("025476c2e83188368da1ff3e292e7acafcdb3566bb0ad253f62fc70f07aeee6357"); - let value = 600_000_000; - - let comp = SighashComponents::new(&tx); - assert_eq!( - comp, - SighashComponents { - tx_version: 1, - tx_locktime: LockTime::from_consensus(17), - hash_prevouts: hex_hash!( - Sighash, "96b827c8483d4e9b96712b6713a7b68d6e8003a781feba36c31143470b4efd37" - ), - hash_sequence: hex_hash!( - Sighash, "52b0a642eea2fb7ae638c36f6252b6750293dbe574a806984b8e4d8548339a3b" - ), - hash_outputs: hex_hash!( - Sighash, "863ef3e1a92afbfdb97f31ad0fc7683ee943e9abcf2501590ff8f6551f47e5e5" - ), - } - ); - - assert_eq!( - comp.sighash_all(&tx.input[1], &witness_script, value), - hex_hash!(Sighash, "c37af31116d1b27caf68aae9e3ac82f1477929014d5b917657d0eb49478cb670") - ); - } - - #[test] - fn bip143_p2wpkh_nested_in_p2sh() { - let tx = deserialize::( - &Vec::from_hex( - "0100000001db6b1b20aa0fd7b23880be2ecbd4a98130974cf4748fb66092ac4d3ceb1a5477010000\ - 0000feffffff02b8b4eb0b000000001976a914a457b684d7f0d539a46a45bbc043f35b59d0d96388ac00\ - 08af2f000000001976a914fd270b1ee6abcaea97fea7ad0402e8bd8ad6d77c88ac92040000", - ).unwrap()[..], - ).unwrap(); - - let witness_script = p2pkh_hex("03ad1d8e89212f0b92c74d23bb710c00662ad1470198ac48c43f7d6f93a2a26873"); - let value = 1_000_000_000; - let comp = SighashComponents::new(&tx); - assert_eq!( - comp, - SighashComponents { - tx_version: 1, - tx_locktime: LockTime::from_consensus(1170), - hash_prevouts: hex_hash!( - Sighash, "b0287b4a252ac05af83d2dcef00ba313af78a3e9c329afa216eb3aa2a7b4613a" - ), - hash_sequence: hex_hash!( - Sighash, "18606b350cd8bf565266bc352f0caddcf01e8fa789dd8a15386327cf8cabe198" - ), - hash_outputs: hex_hash!( - Sighash, "de984f44532e2173ca0d64314fcefe6d30da6f8cf27bafa706da61df8a226c83" - ), - } - ); - - assert_eq!( - comp.sighash_all(&tx.input[0], &witness_script, value), - hex_hash!(Sighash, "64f3b0f4dd2bb3aa1ce8566d220cc74dda9df97d8490cc81d89d735c92e59fb6") - ); - } - - #[test] - fn bip143_p2wsh_nested_in_p2sh() { - let tx = deserialize::( - &Vec::from_hex( - "010000000136641869ca081e70f394c6948e8af409e18b619df2ed74aa106c1ca29787b96e0100000000\ - ffffffff0200e9a435000000001976a914389ffce9cd9ae88dcc0631e88a821ffdbe9bfe2688acc0832f\ - 05000000001976a9147480a33f950689af511e6e84c138dbbd3c3ee41588ac00000000").unwrap()[..], - ).unwrap(); - - let witness_script = hex_script!( - "56210307b8ae49ac90a048e9b53357a2354b3334e9c8bee813ecb98e99a7e07e8c3ba32103b28f0c28\ - bfab54554ae8c658ac5c3e0ce6e79ad336331f78c428dd43eea8449b21034b8113d703413d57761b8b\ - 9781957b8c0ac1dfe69f492580ca4195f50376ba4a21033400f6afecb833092a9a21cfdf1ed1376e58\ - c5d1f47de74683123987e967a8f42103a6d48b1131e94ba04d9737d61acdaa1322008af9602b3b1486\ - 2c07a1789aac162102d8b661b0b3302ee2f162b09e07a55ad5dfbe673a9f01d9f0c19617681024306b\ - 56ae" - ); - let value = 987654321; - - let comp = SighashComponents::new(&tx); - assert_eq!( - comp, - SighashComponents { - tx_version: 1, - tx_locktime: LockTime::ZERO, - hash_prevouts: hex_hash!( - Sighash, "74afdc312af5183c4198a40ca3c1a275b485496dd3929bca388c4b5e31f7aaa0" - ), - hash_sequence: hex_hash!( - Sighash, "3bb13029ce7b1f559ef5e747fcac439f1455a2ec7c5f09b72290795e70665044" - ), - hash_outputs: hex_hash!( - Sighash, "bc4d309071414bed932f98832b27b4d76dad7e6c1346f487a8fdbb8eb90307cc" - ), - } - ); - - assert_eq!( - comp.sighash_all(&tx.input[0], &witness_script, value), - hex_hash!(Sighash, "185c0be5263dce5b4bb50a047973c1b6272bfbd0103a89444597dc40b248ee7c") - ); - } #[test] fn bip143_sighash_flags() { // All examples generated via Bitcoin Core RPC using signrawtransactionwithwallet diff --git a/src/util/sighash.rs b/src/util/sighash.rs index c12812cb..a7bfe1d3 100644 --- a/src/util/sighash.rs +++ b/src/util/sighash.rs @@ -817,12 +817,15 @@ mod tests { use secp256k1::{self, SecretKey, XOnlyPublicKey}; - use crate::{Script, Transaction, TxIn, TxOut}; + use crate::{Script, Transaction, TxIn, TxOut, EcdsaSighashType, Address}; use crate::blockdata::locktime::PackedLockTime; use crate::consensus::deserialize; use crate::hashes::hex::{FromHex, ToHex}; use crate::hashes::{Hash, HashEngine}; + use crate::hash_types::Sighash; use crate::internal_macros::{hex_hash, hex_script, hex_decode}; + use crate::network::constants::Network; + use crate::util::key::PublicKey; use crate::util::sighash::{Annex, Error, Prevouts, ScriptPath, SighashCache}; use crate::util::taproot::{TapTweakHash, TapSighashHash, TapBranchHash, TapLeafHash}; @@ -1204,4 +1207,109 @@ mod tests { assert_eq!(SchnorrSighashType::from_str(s).unwrap_err().to_string(), format!("Unrecognized SIGHASH string '{}'", s)); } } + + fn p2pkh_hex(pk: &str) -> Script { + let pk: PublicKey = PublicKey::from_str(pk).unwrap(); + Address::p2pkh(&pk, Network::Bitcoin).script_pubkey() + } + + #[test] + fn bip143_p2wpkh() { + let tx = deserialize::( + &Vec::from_hex( + "0100000002fff7f7881a8099afa6940d42d1e7f6362bec38171ea3edf433541db4e4ad969f000000\ + 0000eeffffffef51e1b804cc89d182d279655c3aa89e815b1b309fe287d9b2b55d57b90ec68a01000000\ + 00ffffffff02202cb206000000001976a9148280b37df378db99f66f85c95a783a76ac7a6d5988ac9093\ + 510d000000001976a9143bde42dbee7e4dbe6a21b2d50ce2f0167faa815988ac11000000", + ).unwrap()[..], + ).unwrap(); + + let witness_script = p2pkh_hex("025476c2e83188368da1ff3e292e7acafcdb3566bb0ad253f62fc70f07aeee6357"); + let value = 600_000_000; + + let mut cache = SighashCache::new(&tx); + assert_eq!( + cache.segwit_signature_hash(1, &witness_script, value, EcdsaSighashType::All).unwrap(), + hex_hash!(Sighash, "c37af31116d1b27caf68aae9e3ac82f1477929014d5b917657d0eb49478cb670") + ); + + let cache = cache.segwit_cache(); + assert_eq!(cache.prevouts, hex_hash!( + Hash, "96b827c8483d4e9b96712b6713a7b68d6e8003a781feba36c31143470b4efd37" + )); + assert_eq!(cache.sequences, hex_hash!( + Hash, "52b0a642eea2fb7ae638c36f6252b6750293dbe574a806984b8e4d8548339a3b" + )); + assert_eq!(cache.outputs, hex_hash!( + Hash, "863ef3e1a92afbfdb97f31ad0fc7683ee943e9abcf2501590ff8f6551f47e5e5" + )); + } + + #[test] + fn bip143_p2wpkh_nested_in_p2sh() { + let tx = deserialize::( + &Vec::from_hex( + "0100000001db6b1b20aa0fd7b23880be2ecbd4a98130974cf4748fb66092ac4d3ceb1a5477010000\ + 0000feffffff02b8b4eb0b000000001976a914a457b684d7f0d539a46a45bbc043f35b59d0d96388ac00\ + 08af2f000000001976a914fd270b1ee6abcaea97fea7ad0402e8bd8ad6d77c88ac92040000", + ).unwrap()[..], + ).unwrap(); + + let witness_script = p2pkh_hex("03ad1d8e89212f0b92c74d23bb710c00662ad1470198ac48c43f7d6f93a2a26873"); + let value = 1_000_000_000; + + let mut cache = SighashCache::new(&tx); + assert_eq!( + cache.segwit_signature_hash(0, &witness_script, value, EcdsaSighashType::All).unwrap(), + hex_hash!(Sighash, "64f3b0f4dd2bb3aa1ce8566d220cc74dda9df97d8490cc81d89d735c92e59fb6") + ); + + let cache = cache.segwit_cache(); + assert_eq!(cache.prevouts, hex_hash!( + Hash, "b0287b4a252ac05af83d2dcef00ba313af78a3e9c329afa216eb3aa2a7b4613a" + )); + assert_eq!(cache.sequences, hex_hash!( + Hash, "18606b350cd8bf565266bc352f0caddcf01e8fa789dd8a15386327cf8cabe198" + )); + assert_eq!(cache.outputs, hex_hash!( + Hash, "de984f44532e2173ca0d64314fcefe6d30da6f8cf27bafa706da61df8a226c83" + )); + } + + #[test] + fn bip143_p2wsh_nested_in_p2sh() { + let tx = deserialize::( + &Vec::from_hex( + "010000000136641869ca081e70f394c6948e8af409e18b619df2ed74aa106c1ca29787b96e0100000000\ + ffffffff0200e9a435000000001976a914389ffce9cd9ae88dcc0631e88a821ffdbe9bfe2688acc0832f\ + 05000000001976a9147480a33f950689af511e6e84c138dbbd3c3ee41588ac00000000").unwrap()[..], + ).unwrap(); + + let witness_script = hex_script!( + "56210307b8ae49ac90a048e9b53357a2354b3334e9c8bee813ecb98e99a7e07e8c3ba32103b28f0c28\ + bfab54554ae8c658ac5c3e0ce6e79ad336331f78c428dd43eea8449b21034b8113d703413d57761b8b\ + 9781957b8c0ac1dfe69f492580ca4195f50376ba4a21033400f6afecb833092a9a21cfdf1ed1376e58\ + c5d1f47de74683123987e967a8f42103a6d48b1131e94ba04d9737d61acdaa1322008af9602b3b1486\ + 2c07a1789aac162102d8b661b0b3302ee2f162b09e07a55ad5dfbe673a9f01d9f0c19617681024306b\ + 56ae" + ); + let value = 987654321; + + let mut cache = SighashCache::new(&tx); + assert_eq!( + cache.segwit_signature_hash(0, &witness_script, value, EcdsaSighashType::All).unwrap(), + hex_hash!(Sighash, "185c0be5263dce5b4bb50a047973c1b6272bfbd0103a89444597dc40b248ee7c") + ); + + let cache = cache.segwit_cache(); + assert_eq!(cache.prevouts, hex_hash!( + Hash, "74afdc312af5183c4198a40ca3c1a275b485496dd3929bca388c4b5e31f7aaa0" + )); + assert_eq!(cache.sequences, hex_hash!( + Hash, "3bb13029ce7b1f559ef5e747fcac439f1455a2ec7c5f09b72290795e70665044" + )); + assert_eq!(cache.outputs, hex_hash!( + Hash, "bc4d309071414bed932f98832b27b4d76dad7e6c1346f487a8fdbb8eb90307cc" + )); + } }