milksad

History

Tobin C. Harding 3e8e2e46bf Use Self::Engine in GeneralHash impl Match the trait method signature. Internal change only.		2025-02-08 13:27:30 +11: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	Use Self::Engine in GeneralHash impl	2025-02-08 13:27:30 +11:00
tests	hashes: Use associated cost for pre-tagging	2025-02-08 13:27:30 +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.