rust-bitcoin-unsafe-fast/hashes
Andrew Poelstra 283b7d6e51
hashes: rename fuzzing cfg parameter to bitcoin_hashes_fuzz
2023-05-01 21:16:12 +00:00
..
contrib Fix pinning (schemars and MSRV) 2023-04-19 10:17:18 +10:00
embedded embedded: Remove error handler 2023-04-26 14:29:39 +10:00
extended_tests/schemars extended_tests: Remove stale docs 2023-04-20 09:17:10 +10:00
src hashes: rename fuzzing cfg parameter to bitcoin_hashes_fuzz 2023-05-01 21:16:12 +00:00
CHANGELOG.md bitcoin_hashes: add CHANgELOG 2023-03-05 13:53:45 +00:00
Cargo.toml Fix pinning (schemars and MSRV) 2023-04-19 10:17:18 +10:00
README.md Fix pinning (schemars and MSRV) 2023-04-19 10:17:18 +10: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.48.0.

To build with the MSRV you will need to pin serde (if you have either the serde or the schemars feature enabled)

# serde 1.0.157 uses syn 2.0 which requires edition 2021
cargo update -p serde --precise 1.0.156

before building. (And if your code is a library, your downstream users will need to run these commands, and so on.)

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.