milksad

History

Tobin C. Harding b78ba730f2 hashes: Run clippy in ci Currently we only run the linter in `bitcoin/contrib/test.sh`, we should do the same in the `hashes` ci script.		2022-11-30 14:43:56 +11:00
..
contrib	hashes: Run clippy in ci	2022-11-30 14:43:56 +11:00
embedded	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11:00
extended_tests/schemars	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11:00
fuzz	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11:00
src	Remove the unnecessary explicit reference	2022-11-30 14:41:14 +11:00
CHANGELOG.md	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11:00
Cargo.toml	Import bitcoin_hashes crate into hashes	2022-11-08 08:58:09 +11: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.