milksad

History

David Klank e9f7ae4b74 Correct hash algorithm name in RIPEMD160 documentation		2025-06-05 12:09:34 +03:00
..
contrib	Invert dependency between io and hashes	2025-02-11 09:17:21 +11:00
embedded	chore: remove unused cortex-m dependency from embedded Cargo.toml files in bitcoin and hashes modules.	2025-04-05 18:25:41 +08:00
src	Correct hash algorithm name in RIPEMD160 documentation	2025-06-05 12:09:34 +03:00
tests	Allow uninlined format args	2025-05-06 09:49:02 +01:00
CHANGELOG.md	hashes: fix typo	2024-12-23 20:44:18 +08:00
Cargo.toml	chore(hashes): update serde dependency to workspace	2025-04-08 14:45:47 -07:00
README.md	Typo fix in: README.md	2025-02-27 12:40:30 +03: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 anyway.

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 benchmark code. To run the benchmarks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.