Remove the SliceIndex implementation from hash types

If folk really want to index into a hash they can us `as_byte_array` then index that. Includes a bump to the version number of `hashes` to `v0.15.0` - this is because otherwise `secp` won't build since we are breaking an API that is used in the current release of secp. Fix: rust-bitcoin#3115
yancyribbens · Oct 2, 2024 · 3b7ba4f · 3b7ba4f
1 parent e8a3c1f
commit 3b7ba4f
Show file tree

Hide file tree

Showing 31 changed files with 78 additions and 94 deletions.
diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -25,7 +25,7 @@ name = "base58ck"
 version = "0.1.0"
 dependencies = [
  "bitcoin-internals",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "hex-conservative",
 ]
 
@@ -64,7 +64,7 @@ dependencies = [
  "bitcoin-io",
  "bitcoin-primitives",
  "bitcoin-units",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "bitcoinconsensus",
  "hex-conservative",
  "hex_lit",
@@ -114,7 +114,7 @@ dependencies = [
  "bitcoin-internals",
  "bitcoin-io",
  "bitcoin-units",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "hex-conservative",
  "mutagen",
  "ordered",
@@ -135,6 +135,15 @@ dependencies = [
 [[package]]
 name = "bitcoin_hashes"
 version = "0.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bb18c03d0db0247e147a21a6faafd5a7eb851c743db062de72018b6b7e8e4d16"
+dependencies = [
+ "hex-conservative",
+]
+
+[[package]]
+name = "bitcoin_hashes"
+version = "0.15.0"
 dependencies = [
  "bitcoin-io",
  "hex-conservative",
@@ -365,7 +374,7 @@ version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0e0cc0f1cf93f4969faf3ea1c7d8a9faed25918d96affa959720823dfe86d4f3"
 dependencies = [
- "bitcoin_hashes",
+ "bitcoin_hashes 0.14.0",
  "rand",
  "secp256k1-sys",
  "serde",

diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -25,7 +25,7 @@ name = "base58ck"
 version = "0.1.0"
 dependencies = [
  "bitcoin-internals",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "hex-conservative",
 ]
 
@@ -63,7 +63,7 @@ dependencies = [
  "bitcoin-io",
  "bitcoin-primitives",
  "bitcoin-units",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "bitcoinconsensus",
  "hex-conservative",
  "hex_lit",
@@ -113,7 +113,7 @@ dependencies = [
  "bitcoin-internals",
  "bitcoin-io",
  "bitcoin-units",
- "bitcoin_hashes",
+ "bitcoin_hashes 0.15.0",
  "hex-conservative",
  "mutagen",
  "ordered",
@@ -134,6 +134,15 @@ dependencies = [
 [[package]]
 name = "bitcoin_hashes"
 version = "0.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bb18c03d0db0247e147a21a6faafd5a7eb851c743db062de72018b6b7e8e4d16"
+dependencies = [
+ "hex-conservative",
+]
+
+[[package]]
+name = "bitcoin_hashes"
+version = "0.15.0"
 dependencies = [
  "bitcoin-io",
  "hex-conservative",
@@ -348,7 +357,7 @@ version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0e0cc0f1cf93f4969faf3ea1c7d8a9faed25918d96affa959720823dfe86d4f3"
 dependencies = [
- "bitcoin_hashes",
+ "bitcoin_hashes 0.14.0",
  "rand",
  "secp256k1-sys",
  "serde",

diff --git a/base58/Cargo.toml b/base58/Cargo.toml
@@ -18,7 +18,7 @@ std = ["alloc", "hashes/std", "internals/std"]
 alloc = ["hashes/alloc", "internals/alloc"]
 
 [dependencies]
-hashes = { package = "bitcoin_hashes", version = "0.14.0", default-features = false }
+hashes = { package = "bitcoin_hashes", version = "0.15.0", default-features = false }
 internals = { package = "bitcoin-internals", version = "0.4.0" }
 
 [dev-dependencies]

diff --git a/base58/src/lib.rs b/base58/src/lib.rs
@@ -114,7 +114,7 @@ pub fn decode_check(data: &str) -> Result<Vec<u8>, Error> {
     let check_start = ret.len() - 4;
 
     let hash_check =
-        sha256d::Hash::hash(&ret[..check_start])[..4].try_into().expect("4 byte slice");
+        sha256d::Hash::hash(&ret[..check_start]).as_byte_array()[..4].try_into().expect("4 byte slice");
     let data_check = ret[check_start..].try_into().expect("4 byte slice");
 
     let expected = u32::from_le_bytes(hash_check);
@@ -165,7 +165,7 @@ pub fn encode_check_to_fmt(fmt: &mut fmt::Formatter, data: &[u8]) -> fmt::Result
 
 fn encode_check_to_writer(fmt: &mut impl fmt::Write, data: &[u8]) -> fmt::Result {
     let checksum = sha256d::Hash::hash(data);
-    let iter = data.iter().cloned().chain(checksum[0..4].iter().cloned());
+    let iter = data.iter().cloned().chain(checksum.as_byte_array()[0..4].iter().cloned());
     let reserve_len = encoded_check_reserve_len(data.len());
     if reserve_len <= SHORT_OPT_BUFFER_LEN {
         format_iter(fmt, iter, &mut ArrayVec::<u8, SHORT_OPT_BUFFER_LEN>::new())

diff --git a/bitcoin/Cargo.toml b/bitcoin/Cargo.toml
@@ -27,7 +27,7 @@ arbitrary = ["dep:arbitrary", "units/arbitrary", "primitives/arbitrary"]
 [dependencies]
 base58 = { package = "base58ck", version = "0.1.0", default-features = false, features = ["alloc"] }
 bech32 = { version = "0.11.0", default-features = false, features = ["alloc"] }
-hashes = { package = "bitcoin_hashes", version = "0.14.0", default-features = false, features = ["alloc", "bitcoin-io"] }
+hashes = { package = "bitcoin_hashes", version = "0.15.0", default-features = false, features = ["alloc", "bitcoin-io"] }
 hex = { package = "hex-conservative", version = "0.2.0", default-features = false, features = ["alloc"] }
 internals = { package = "bitcoin-internals", version = "0.4.0", features = ["alloc"] }
 io = { package = "bitcoin-io", version = "0.1.1", default-features = false, features = ["alloc"] }

diff --git a/bitcoin/contrib/whitelist_deps.sh b/bitcoin/contrib/whitelist_deps.sh
@@ -0,0 +1,7 @@
+# No shebang, this file should not be executed.
+# shellcheck disable=SC2148
+#
+# disable verify unused vars, despite the fact that they are used when sourced
+# shellcheck disable=SC2034
+
+DUPLICATE_DEPS=("hashes")
diff --git a/bitcoin/src/bip152.rs b/bitcoin/src/bip152.rs
@@ -111,8 +111,8 @@ impl ShortId {
         // 2. Running SipHash-2-4 with the input being the transaction ID and the keys (k0/k1)
         // set to the first two little-endian 64-bit integers from the above hash, respectively.
         (
-            u64::from_le_bytes(h[0..8].try_into().expect("8 byte slice")),
-            u64::from_le_bytes(h[8..16].try_into().expect("8 byte slice")),
+            u64::from_le_bytes(h.as_byte_array()[0..8].try_into().expect("8 byte slice")),
+            u64::from_le_bytes(h.as_byte_array()[8..16].try_into().expect("8 byte slice")),
         )
     }
 
@@ -124,7 +124,7 @@ impl ShortId {
 
         // 3. Dropping the 2 most significant bytes from the SipHash output to make it 6 bytes.
         let mut id = ShortId([0; 6]);
-        id.0.copy_from_slice(&hash[0..6]);
+        id.0.copy_from_slice(&hash.as_byte_array()[0..6]);
         id
     }
 }

diff --git a/bitcoin/src/bip32.rs b/bitcoin/src/bip32.rs
@@ -727,7 +727,7 @@ impl Xpriv {
 
     /// Returns the first four bytes of the identifier
     pub fn fingerprint<C: secp256k1::Signing>(&self, secp: &Secp256k1<C>) -> Fingerprint {
-        self.identifier(secp)[0..4].try_into().expect("4 is the fingerprint length")
+        self.identifier(secp).as_byte_array()[0..4].try_into().expect("4 is the fingerprint length")
     }
 }
 
@@ -886,7 +886,7 @@ impl Xpub {
 
     /// Returns the first four bytes of the identifier
     pub fn fingerprint(&self) -> Fingerprint {
-        self.identifier()[0..4].try_into().expect("4 is the fingerprint length")
+        self.identifier().as_byte_array()[0..4].try_into().expect("4 is the fingerprint length")
     }
 }
 

diff --git a/bitcoin/src/consensus/encode.rs b/bitcoin/src/consensus/encode.rs
@@ -730,6 +730,7 @@ impl Decodable for Box<[u8]> {
 /// Does a double-SHA256 on `data` and returns the first 4 bytes.
 fn sha2_checksum(data: &[u8]) -> [u8; 4] {
     let checksum = <sha256d::Hash as GeneralHash>::hash(data);
+    let checksum = checksum.to_byte_array();
     [checksum[0], checksum[1], checksum[2], checksum[3]]
 }
 

diff --git a/bitcoin/src/p2p/message.rs b/bitcoin/src/p2p/message.rs
@@ -307,6 +307,7 @@ impl RawNetworkMessage {
         let payload_len = payload.consensus_encode(&mut engine).expect("engine doesn't error");
         let payload_len = u32::try_from(payload_len).expect("network message use u32 as length");
         let checksum = sha256d::Hash::from_engine(engine);
+        let checksum = checksum.to_byte_array();
         let checksum = [checksum[0], checksum[1], checksum[2], checksum[3]];
         Self { magic, payload, payload_len, checksum }
     }

diff --git a/fuzz/fuzz_targets/hashes/ripemd160.rs b/fuzz/fuzz_targets/hashes/ripemd160.rs
@@ -7,7 +7,7 @@ fn do_test(data: &[u8]) {
     let eng_hash = ripemd160::Hash::from_engine(engine);
 
     let hash = ripemd160::Hash::hash(data);
-    assert_eq!(&hash[..], &eng_hash[..]);
+    assert_eq!(hash.as_byte_array(), eng_hash.as_byte_array());
 }
 
 fn main() {

diff --git a/fuzz/fuzz_targets/hashes/sha1.rs b/fuzz/fuzz_targets/hashes/sha1.rs
@@ -7,7 +7,7 @@ fn do_test(data: &[u8]) {
     let eng_hash = sha1::Hash::from_engine(engine);
 
     let hash = sha1::Hash::hash(data);
-    assert_eq!(&hash[..], &eng_hash[..]);
+    assert_eq!(hash.as_byte_array(), eng_hash.as_byte_array());
 }
 
 fn main() {

diff --git a/fuzz/fuzz_targets/hashes/sha256.rs b/fuzz/fuzz_targets/hashes/sha256.rs
@@ -7,7 +7,7 @@ fn do_test(data: &[u8]) {
     let eng_hash = sha256::Hash::from_engine(engine);
 
     let hash = sha256::Hash::hash(data);
-    assert_eq!(&hash[..], &eng_hash[..]);
+    assert_eq!(hash.as_byte_array(), eng_hash.as_byte_array());
 }
 
 fn main() {

diff --git a/fuzz/fuzz_targets/hashes/sha512.rs b/fuzz/fuzz_targets/hashes/sha512.rs
@@ -7,7 +7,7 @@ fn do_test(data: &[u8]) {
     let eng_hash = sha512::Hash::from_engine(engine);
 
     let hash = sha512::Hash::hash(data);
-    assert_eq!(&hash[..], &eng_hash[..]);
+    assert_eq!(hash.as_byte_array(), eng_hash.as_byte_array());
 }
 
 fn main() {

diff --git a/fuzz/fuzz_targets/hashes/sha512_256.rs b/fuzz/fuzz_targets/hashes/sha512_256.rs
@@ -7,7 +7,7 @@ fn do_test(data: &[u8]) {
     let eng_hash = sha512_256::Hash::from_engine(engine);
 
     let hash = sha512_256::Hash::hash(data);
-    assert_eq!(&hash[..], &eng_hash[..]);
+    assert_eq!(hash.as_byte_array(), eng_hash.as_byte_array());
 }
 
 fn main() {

diff --git a/hashes/Cargo.toml b/hashes/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bitcoin_hashes"
-version = "0.14.0"
+version = "0.15.0"
 authors = ["Andrew Poelstra <[email protected]>"]
 license = "CC0-1.0"
 repository = "https://github.com/rust-bitcoin/rust-bitcoin"

diff --git a/hashes/src/cmp.rs b/hashes/src/cmp.rs
@@ -105,55 +105,55 @@ mod benches {
     fn bench_32b_constant_time_cmp_ne(bh: &mut Bencher) {
         let hash_a = sha256::Hash::hash(&[0; 1]);
         let hash_b = sha256::Hash::hash(&[1; 1]);
-        bh.iter(|| fixed_time_eq(&hash_a[..], &hash_b[..]))
+        bh.iter(|| fixed_time_eq(hash_a.as_byte_array(), hash_b.as_byte_array()))
     }
 
     #[bench]
     fn bench_32b_slice_cmp_ne(bh: &mut Bencher) {
         let hash_a = sha256::Hash::hash(&[0; 1]);
         let hash_b = sha256::Hash::hash(&[1; 1]);
-        bh.iter(|| &hash_a[..] == &hash_b[..])
+        bh.iter(|| hash_a.as_byte_array() == hash_b.as_byte_array())
     }
 
     #[bench]
     fn bench_32b_constant_time_cmp_eq(bh: &mut Bencher) {
         let hash_a = sha256::Hash::hash(&[0; 1]);
         let hash_b = sha256::Hash::hash(&[0; 1]);
-        bh.iter(|| fixed_time_eq(&hash_a[..], &hash_b[..]))
+        bh.iter(|| fixed_time_eq(hash_a.as_byte_array(), hash_b.as_byte_array()))
     }
 
     #[bench]
     fn bench_32b_slice_cmp_eq(bh: &mut Bencher) {
         let hash_a = sha256::Hash::hash(&[0; 1]);
         let hash_b = sha256::Hash::hash(&[0; 1]);
-        bh.iter(|| &hash_a[..] == &hash_b[..])
+        bh.iter(|| hash_a.as_byte_array() == hash_b.as_byte_array())
     }
 
     #[bench]
     fn bench_64b_constant_time_cmp_ne(bh: &mut Bencher) {
         let hash_a = sha512::Hash::hash(&[0; 1]);
         let hash_b = sha512::Hash::hash(&[1; 1]);
-        bh.iter(|| fixed_time_eq(&hash_a[..], &hash_b[..]))
+        bh.iter(|| fixed_time_eq(hash_a.as_byte_array(), hash_b.as_byte_array()))
     }
 
     #[bench]
     fn bench_64b_slice_cmp_ne(bh: &mut Bencher) {
         let hash_a = sha512::Hash::hash(&[0; 1]);
         let hash_b = sha512::Hash::hash(&[1; 1]);
-        bh.iter(|| &hash_a[..] == &hash_b[..])
+        bh.iter(|| hash_a.as_byte_array() == hash_b.as_byte_array())
     }
 
     #[bench]
     fn bench_64b_constant_time_cmp_eq(bh: &mut Bencher) {
         let hash_a = sha512::Hash::hash(&[0; 1]);
         let hash_b = sha512::Hash::hash(&[0; 1]);
-        bh.iter(|| fixed_time_eq(&hash_a[..], &hash_b[..]))
+        bh.iter(|| fixed_time_eq(hash_a.as_byte_array(), hash_b.as_byte_array()))
     }
 
     #[bench]
     fn bench_64b_slice_cmp_eq(bh: &mut Bencher) {
         let hash_a = sha512::Hash::hash(&[0; 1]);
         let hash_b = sha512::Hash::hash(&[0; 1]);
-        bh.iter(|| &hash_a[..] == &hash_b[..])
+        bh.iter(|| hash_a.as_byte_array() == hash_b.as_byte_array())
     }
 }
diff --git a/hashes/src/hash160.rs b/hashes/src/hash160.rs
@@ -7,9 +7,6 @@
 
 //! HASH160 (SHA256 then RIPEMD160) implementation.
 
-use core::ops::Index;
-use core::slice::SliceIndex;
-
 use crate::{ripemd160, sha256};
 
 crate::internal_macros::hash_type! {
@@ -39,10 +36,10 @@ impl crate::HashEngine for HashEngine {
 
 fn from_engine(e: HashEngine) -> Hash {
     let sha2 = sha256::Hash::from_engine(e.0);
-    let rmd = ripemd160::Hash::hash(&sha2[..]);
+    let rmd = ripemd160::Hash::hash(sha2.as_byte_array());
 
     let mut ret = [0; 20];
-    ret.copy_from_slice(&rmd[..]);
+    ret.copy_from_slice(rmd.as_byte_array());
     Hash(ret)
 }
 
@@ -90,7 +87,7 @@ mod tests {
             // Hash through high-level API, check hex encoding/decoding
             let hash = hash160::Hash::hash(&test.input[..]);
             assert_eq!(hash, test.output_str.parse::<hash160::Hash>().expect("parse hex"));
-            assert_eq!(hash[..], test.output);
+            assert_eq!(hash.as_byte_array(), &test.output);
             assert_eq!(hash.to_string(), test.output_str);
 
             // Hash through engine, checking that we can input byte by byte

diff --git a/hashes/src/internal_macros.rs b/hashes/src/internal_macros.rs
@@ -86,15 +86,6 @@ macro_rules! hash_trait_impls {
             }
         }
 
-        impl<I: SliceIndex<[u8]> $(, $gen: $gent)*> Index<I> for Hash<$($gen),*> {
-            type Output = I::Output;
-
-            #[inline]
-            fn index(&self, index: I) -> &Self::Output {
-                &self.0[index]
-            }
-        }
-
         impl<$($gen: $gent),*> $crate::GeneralHash for Hash<$($gen),*> {
             type Engine = HashEngine;
 

diff --git a/hashes/src/ripemd160.rs b/hashes/src/ripemd160.rs
@@ -3,8 +3,6 @@
 //! RIPEMD160 implementation.
 
 use core::cmp;
-use core::ops::Index;
-use core::slice::SliceIndex;
 
 use crate::{incomplete_block_len, HashEngine as _};
 
@@ -479,7 +477,7 @@ mod tests {
             // Hash through high-level API, check hex encoding/decoding
             let hash = ripemd160::Hash::hash(test.input.as_bytes());
             assert_eq!(hash, test.output_str.parse::<ripemd160::Hash>().expect("parse hex"));
-            assert_eq!(hash[..], test.output);
+            assert_eq!(hash.as_byte_array(), &test.output);
             assert_eq!(hash.to_string(), test.output_str);
             assert_eq!(ripemd160::Hash::from_bytes_ref(&test.output), &hash);
             assert_eq!(ripemd160::Hash::from_bytes_mut(&mut test.output), &hash);