milksad

History

Matt Corallo 7eb5d65bda [IO] Provide a macro which implements `io::Write` for types With the new `bitcoin_io` library, implementing `io::Write` manually is somewhat tricky - for `std` users we really want to provide an `std::io::Write` implementation, however for `no-std` users we want to implement against our internal trait. Sadly we cannot provide a blanket implementation of `std::io::Write` for all types whcih implement our `io::Write` trait as its an out-of-crate impl. Instead, we provide a macro which will either implement `std::io::Write` or our `io::Write` depending on the feature flags set on `bitcoin_io`.		2023-11-07 05:51:34 +00:00
..
contrib	Add wasm dev-deps using CI script	2023-10-05 11:16:24 +11:00
embedded	Add a `bitcoin_io` crate	2023-11-07 05:50:42 +00:00
extended_tests/schemars	Add a `bitcoin_io` crate	2023-11-07 05:50:42 +00:00
src	[IO] Provide a macro which implements `io::Write` for types	2023-11-07 05:51:34 +00:00
CHANGELOG.md	hashes: Remove duplicate entry	2023-09-07 14:19:01 -04:00
Cargo.toml	Add a `bitcoin_io` crate	2023-11-07 05:50:42 +00:00
README.md	hashes: Remove stale status badge	2023-05-25 14:34:28 +10: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.48.0.

To build with the MSRV you will need to pin serde (if you have either the serde or the schemars feature enabled)

# serde 1.0.157 uses syn 2.0 which requires edition 2021
cargo update -p serde --precise 1.0.156

before building. (And if your code is a library, your downstream users will need to run these commands, and so on.)

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.