rust-bitcoin-unsafe-fast/hashes
Tobin C. Harding 3d01146374
Allow needless-borrows-for-generic-args
This lint triggers when parsing a reference to a large struct as a
generic argument, which is wrong.

Allow it crate wide because [subjectively] this lint never warns for
anything useful.
2024-04-02 11:40:41 +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 Allow needless-borrows-for-generic-args 2024-04-02 11:40:41 +11:00
CHANGELOG.md hashes: Bump version to v0.14.0 2024-03-22 06:04:40 +11:00
Cargo.toml hashes: Bump version to v0.14.0 2024-03-22 06:04:40 +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.