milksad

History

Martin Habovstiak 5c15ed5441 CI: Epic overhaul Re-write the whole CI pipeline. Co-developed-by: Martin Habovstiak <martin.habovstiak@gmail.com>		2024-02-02 05:57:23 +11:00
..
contrib	CI: Epic overhaul	2024-02-02 05:57:23 +11:00
embedded	CI: Epic overhaul	2024-02-02 05:57:23 +11:00
extended_tests/schemars	Add bitcoin-units crate	2023-12-11 08:52:31 +11:00
src	Make crate level attributes uniform	2024-01-31 11:32:46 +11:00
CHANGELOG.md	hashes: Remove duplicate entry	2023-09-07 14:19:01 -04:00
Cargo.toml	hashes: Remove serde-std feature	2024-01-24 12:58:02 +11:00
README.md	docs: Remove pinning from hashes readme	2024-01-11 15:08:44 +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 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.56.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.