milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Martin Habovstiak 8ccfb412c1 Improve documentation of `hash_newtype!` 
The macro is non-trivial, so documenting it well is very useful. This
change improves both user-facing and developer-facing code with
appropriate warnings about the limitations of the code and Rust macro
system.
 		2023-02-27 11:59:04 +01:00
..
contrib Merge rust-bitcoin/rust-bitcoin#1569: ci: Remove incorrect code comment and cargo clean 2023-02-18 01:28:46 +00:00
embedded Make `hash_newtype` evocative of the output 2023-02-22 14:35:50 +01:00
extended_tests/schemars Make `hash_newtype` evocative of the output 2023-02-22 14:35:50 +01:00
fuzz Add fuzz target for sha512_256 2022-12-21 16:36:35 +09:00
src Improve documentation of `hash_newtype!` 2023-02-27 11:59:04 +01:00
CHANGELOG.md Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
Cargo.toml hashes: Improve feature gating 2023-02-14 06:23:56 +11:00
README.md Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00

README.md

Status

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.41.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.