0aa539f836
This commit illustrates the transformation I intend to make everywhere we use newtyped hashes as "general hashes". *Within the module that the newtype is defined* I encapsulate engine calls, which I do by calling engine methods on the underlying general hash function. So within the module there is a slight reduction in type safety, in the sense that I need to make sure that I'm wrapping stuff properly. But outside of the module, there will be no difference except that I will no longer export engine/from_engine/hash/etc on newtyped hashes. Instead callers will need to compute the newtyped hash only in ways supported by the API. In theory we could have a macro to produce engine/from_engine/etc for newtypes that want to act as general hashes. But AFAICT there is no use case for this. Alternately, we could have a macro that produces *private* Engine types and private engine/from_engine/etc methods for the hashes, which could be used within the module and would provide stronger type safety within the module. But in practice, raw hashing is usually only used within a couple of methods, so all this infrastructure is way overkill and will just make maintenance harder for everybody. |
||
|---|---|---|
| .. | ||
| contrib | ||
| embedded | ||
| extended_tests/schemars | ||
| 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.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.