rust-bitcoin-unsafe-fast/hashes
merge-script 4700fe7fb2
Merge rust-bitcoin/rust-bitcoin#3982: hashes: Move from_engine functions
b98c489066 hashes: Move from_engine functions (Tobin C. Harding)

Pull request description:

  In order to use the `general_hash_type` macro the must exist a standalone `from_engine` function. Currently this function is in different places in different modules. In an effort to make the `hashes` code easier to reason about put the functions right below the macro.

  Code move only, no other changes.

ACKs for top commit:
  Kixunil:
    ACK b98c489066
  apoelstra:
    ACK b98c489066e8916a383099e5037e5a24832548ba; successfully ran local tests

Tree-SHA512: 8dfbf2b422d078d687708fa94a478ca597fae141f5c1f0a318a36152ca33f4760bb0545ab67523c558a8c3b8d258356975c5e357600d0ac980d473250a2af20e
2025-02-02 03:19:45 +00:00
..
contrib CI: Hobble WASM job 2024-10-23 06:59:51 +11:00
embedded hashes: Make hex dependency optional 2024-11-14 09:36:55 +11:00
src Merge rust-bitcoin/rust-bitcoin#3982: hashes: Move from_engine functions 2025-02-02 03:19:45 +00:00
tests Do not implement Default for HmacEngine 2025-01-31 09:58:06 +11:00
CHANGELOG.md hashes: fix typo 2024-12-23 20:44:18 +08:00
Cargo.toml hashes: Bump version to 0.16.0 2024-12-16 12:41:17 +11:00
README.md Bump MSRV to 1.63 2024-07-27 07:24:32 +02:00

README.md

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 ancillary 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.63.0.

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.