milksad

History

Tobin C. Harding fed94f8899 Bump version of bitcoin-io to 0.2.0 In preparation for releasing `io v0.2.0` bump the version number, add a changelog entry, update the lock files, and depend on the new version in all crates that depend on `io`.		2024-10-02 09:47:10 +10:00
..
contrib	Remove schemars all together	2024-09-23 06:57:00 +10:00
embedded	Remove hashes io feature	2024-09-09 06:37:49 +10:00
src	Merge rust-bitcoin/rust-bitcoin#3429 : Rename Midstate::into_parts to Midstate::to_parts since it derives Copy	2024-10-01 16:03:53 +00:00
tests	2024-09-15 automated rustfmt nightly	2024-09-15 01:19:55 +00:00
CHANGELOG.md	Document the sha256t_hash_newtype direction	2024-05-07 12:48:07 +10:00
Cargo.toml	Bump version of bitcoin-io to 0.2.0	2024-10-02 09:47:10 +10: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.