Merge rust-bitcoin/rust-bitcoin#1593: hashes: Implement AsRef for fixed size arrays

a121e19e94 hashes: Implement AsRef for fixed size arrays (Tobin C. Harding)

Pull request description:

  Implement `AsRef<[u8; X]>` for hash types including wrapped hash types. Doing so means at times the compiler can no longer infer the type because we have `AsRef<[u8]` implemented also but we can use `into_inner` and `as_inner` to get the inner array if needed.

  Fix: #1462

  ## Note

  This touches code that will likely be changed by #1577 and when we do #1491 but I believe its a step forward.

ACKs for top commit:
  arturomf94:
    ACK [`a121e19`](a121e19e94)
  apoelstra:
    ACK a121e19e94
  Kixunil:
    ACK a121e19e94

Tree-SHA512: 257c44826c7649db25bb3a6f023f68b2f17b70c546a056afad044bc8a16bf61f654c3846222505aaf5e6f9a0ad1d2113272d61317b407d0ac83702e41060a1ee
This commit is contained in:
Andrew Poelstra 2023-02-17 13:15:32 +00:00
commit 562400a7bc
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
5 changed files with 43 additions and 9 deletions

View File

@ -481,7 +481,7 @@ impl Payload {
pub fn p2wpkh(pk: &PublicKey) -> Result<Payload, Error> { pub fn p2wpkh(pk: &PublicKey) -> Result<Payload, Error> {
let prog = WitnessProgram::new( let prog = WitnessProgram::new(
WitnessVersion::V0, WitnessVersion::V0,
pk.wpubkey_hash().ok_or(Error::UncompressedPubkey)?.as_ref().to_vec() pk.wpubkey_hash().ok_or(Error::UncompressedPubkey)?.into_inner().to_vec()
)?; )?;
Ok(Payload::WitnessProgram(prog)) Ok(Payload::WitnessProgram(prog))
} }
@ -499,7 +499,7 @@ impl Payload {
pub fn p2wsh(script: &Script) -> Payload { pub fn p2wsh(script: &Script) -> Payload {
let prog = WitnessProgram::new( let prog = WitnessProgram::new(
WitnessVersion::V0, WitnessVersion::V0,
script.wscript_hash().as_ref().to_vec() script.wscript_hash().as_inner().to_vec()
).expect("wscript_hash has len 32 compatible with segwitv0"); ).expect("wscript_hash has len 32 compatible with segwitv0");
Payload::WitnessProgram(prog) Payload::WitnessProgram(prog)
} }
@ -937,9 +937,9 @@ impl Address {
let payload = self.payload.inner_prog_as_bytes(); let payload = self.payload.inner_prog_as_bytes();
let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner); let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner);
(*pubkey_hash.as_ref() == *payload) (*pubkey_hash.as_inner() == *payload)
|| (xonly_pubkey.serialize() == *payload) || (xonly_pubkey.serialize() == *payload)
|| (*segwit_redeem_hash(&pubkey_hash).as_ref() == *payload) || (*segwit_redeem_hash(&pubkey_hash).as_inner() == *payload)
} }
/// Returns true if the supplied xonly public key can be used to derive the address. /// Returns true if the supplied xonly public key can be used to derive the address.

View File

@ -582,7 +582,7 @@ mod test {
flags: BloomFlags::All, flags: BloomFlags::All,
}), }),
NetworkMessage::FilterAdd(FilterAdd { data: script.as_bytes().to_vec() }), NetworkMessage::FilterAdd(FilterAdd { data: script.as_bytes().to_vec() }),
NetworkMessage::FilterAdd(FilterAdd { data: hash([29u8; 32]).as_ref().to_vec() }), NetworkMessage::FilterAdd(FilterAdd { data: hash([29u8; 32]).into_inner().to_vec() }),
NetworkMessage::FilterClear, NetworkMessage::FilterClear,
NetworkMessage::GetCFilters(GetCFilters { NetworkMessage::GetCFilters(GetCFilters {
filter_type: 2, filter_type: 2,

View File

@ -309,9 +309,9 @@ impl Deserialize for schnorr::Signature {
impl Serialize for (XOnlyPublicKey, TapLeafHash) { impl Serialize for (XOnlyPublicKey, TapLeafHash) {
fn serialize(&self) -> Vec<u8> { fn serialize(&self) -> Vec<u8> {
let ser_pk = self.0.serialize(); let ser_pk = self.0.serialize();
let mut buf = Vec::with_capacity(ser_pk.len() + self.1.as_ref().len()); let mut buf = Vec::with_capacity(ser_pk.len() + self.1.as_inner().len());
buf.extend(&ser_pk); buf.extend(&ser_pk);
buf.extend(self.1.as_ref()); buf.extend(self.1.as_inner());
buf buf
} }
} }

View File

@ -105,6 +105,12 @@ macro_rules! hash_trait_impls {
serde_impl!(Hash, $bits / 8 $(, $gen: $gent)*); serde_impl!(Hash, $bits / 8 $(, $gen: $gent)*);
borrow_slice_impl!(Hash $(, $gen: $gent)*); borrow_slice_impl!(Hash $(, $gen: $gent)*);
impl<$($gen: $gent),*> $crate::_export::_core::convert::AsRef<[u8; $bits / 8]> for Hash<$($gen),*> {
fn as_ref(&self) -> &[u8; $bits / 8] {
&self.0
}
}
impl<I: SliceIndex<[u8]> $(, $gen: $gent)*> Index<I> for Hash<$($gen),*> { impl<I: SliceIndex<[u8]> $(, $gen: $gent)*> Index<I> for Hash<$($gen),*> {
type Output = I::Output; type Output = I::Output;

View File

@ -208,6 +208,12 @@ macro_rules! hash_newtype {
} }
} }
impl $crate::_export::_core::convert::AsRef<[u8; $len]> for $newtype {
fn as_ref(&self) -> &[u8; $len] {
AsRef::<[u8; $len]>::as_ref(&self.0)
}
}
impl<I: $crate::_export::_core::slice::SliceIndex<[u8]>> $crate::_export::_core::ops::Index<I> for $newtype { impl<I: $crate::_export::_core::slice::SliceIndex<[u8]>> $crate::_export::_core::ops::Index<I> for $newtype {
type Output = I::Output; type Output = I::Output;
@ -248,9 +254,17 @@ mod test {
use crate::{Hash, sha256}; use crate::{Hash, sha256};
#[test] #[test]
fn hash_as_ref() { fn hash_as_ref_array() {
let hash = sha256::Hash::hash(&[3, 50]); let hash = sha256::Hash::hash(&[3, 50]);
assert_eq!(hash.as_ref(), hash.as_inner()); let r = AsRef::<[u8; 32]>::as_ref(&hash);
assert_eq!(r, hash.as_inner());
}
#[test]
fn hash_as_ref_slice() {
let hash = sha256::Hash::hash(&[3, 50]);
let r = AsRef::<[u8]>::as_ref(&hash);
assert_eq!(r, hash.as_inner());
} }
#[test] #[test]
@ -291,4 +305,18 @@ mod test {
let got = format!("{:#x}", TestHash::all_zeros()); let got = format!("{:#x}", TestHash::all_zeros());
assert_eq!(got, want) assert_eq!(got, want)
} }
#[test]
fn inner_hash_as_ref_array() {
let hash = TestHash::all_zeros();
let r = AsRef::<[u8; 32]>::as_ref(&hash);
assert_eq!(r, hash.as_inner());
}
#[test]
fn inner_hash_as_ref_slice() {
let hash = TestHash::all_zeros();
let r = AsRef::<[u8]>::as_ref(&hash);
assert_eq!(r, hash.as_inner());
}
} }