milksad

History

Tobin C. Harding c466554948 hashes: Improve crate docs heading Use same for as the other crates and emphasise that this is a Bitcoin hashes crate.		2025-03-03 13:30:40 +11:00
..
contrib	Invert dependency between io and hashes	2025-02-11 09:17:21 +11:00
embedded	Invert dependency between io and hashes	2025-02-11 09:17:21 +11:00
src	hashes: Improve crate docs heading	2025-03-03 13:30:40 +11:00
tests	Invert dependency between io and hashes	2025-02-11 09:17:21 +11:00
CHANGELOG.md	hashes: fix typo	2024-12-23 20:44:18 +08:00
Cargo.toml	Only enable hex/std, alloc when hex is	2025-02-14 15:22:13 +00: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.