rust-bitcoin-unsafe-fast/hashes
Andrew Poelstra 562400a7bc
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
2023-02-17 13:24:57 +00:00
..
contrib Merge rust-bitcoin/rust-bitcoin#1505: Improve test coverage for docs build 2023-02-10 23:20:57 +00:00
embedded Remove `ToHex` 2023-01-07 19:50:03 +01:00
extended_tests/schemars Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
fuzz Add fuzz target for sha512_256 2022-12-21 16:36:35 +09:00
src Merge rust-bitcoin/rust-bitcoin#1593: hashes: Implement AsRef for fixed size arrays 2023-02-17 13:24:57 +00:00
CHANGELOG.md Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
Cargo.toml hashes: Improve feature gating 2023-02-14 06:23:56 +11:00
README.md Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00

README.md

Status

Bitcoin Hashes Library

This is a simple, no-dependency library which implements the hash functions needed by Bitcoin. These are SHA1, SHA256, SHA256d, SHA512, and RIPEMD160. As an ancilliary thing, it exposes hexadecimal serialization and deserialization, since these are needed to display hashes anway.

Documentation

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.41.1.

Contributions

Contributions are welcome, including additional hash function implementations.

Githooks

To assist devs in catching errors before running CI we provide some githooks. If you do not already have locally configured githooks you can use the ones in this repository by running, in the root directory of the repository:

git config --local core.hooksPath githooks/

Alternatively add symlinks in your .git/hooks directory to any of the githooks we provide.

Running Benchmarks

We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the bench marks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.