62617cf9ac
The `from_engine` function is associated with a general hash type but we are defining it in the `hash_type` macro which holds nothing but functions associated with the `Hash` trait. By "associated" I mean methods on the type as opposed to trait methods. In preparation for re-naming the `hash_type` macro move the `from_engine` function there. Requires duplicating the code in the `siphash` impl block, this is as expected because the `siphash` requires a custom implementation of the general hashing functionality. Internal change only. |
||
|---|---|---|
| .. | ||
| contrib | ||
| embedded | ||
| src | ||
| tests | ||
| CHANGELOG.md | ||
| Cargo.toml | ||
| README.md | ||
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.
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.