milksad

History

Andrew Poelstra bfd401c96e bitcoin_hashes: add CHANgELOG		2023-03-05 13:53:45 +00:00
..
contrib	Merge rust-bitcoin/rust-bitcoin#1569 : ci: Remove incorrect code comment and cargo clean	2023-02-18 01:28:46 +00:00
embedded	Make `hash_newtype` evocative of the output	2023-02-22 14:35:50 +01:00
extended_tests/schemars	Re-name hash inner/byte methods	2023-02-27 14:23:58 +11:00
fuzz	Add fuzz target for sha512_256	2022-12-21 16:36:35 +09:00
src	Merge rust-bitcoin/rust-bitcoin#1670 : `hash_newtype` cleanup	2023-02-28 01:34:38 +00:00
CHANGELOG.md	bitcoin_hashes: add CHANgELOG	2023-03-05 13:53:45 +00:00
Cargo.toml	bump bitcoin-hashes version to 0.12	2023-03-05 13:40:20 +00:00
README.md	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11: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 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.41.1.

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.