milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Martin Habovstiak 6e5bd473a6 Improve siphash's `as_u64` -> `to_u64` rename 
The previous change was just a dumb rename with no deprecation and it
also kept the `self` type which should be taken by value since the hash
is `Copy`. This improves on it by adding a deprecated method of the
original name and changing the type to be `self` instead of `&self`.
 		2024-08-23 05:54:41 +02:00
..
contrib hashes: Pin in extra_test 2024-08-21 15:31:28 +10:00
embedded hashes: remove engine/from_engine from embedded test 2024-06-24 13:51:23 +00:00
extended_tests/schemars hashes: Pin in extra_test 2024-08-21 15:31:28 +10:00
src Improve siphash's `as_u64` -> `to_u64` rename 2024-08-23 05:54:41 +02:00
tests Push up the Default bound on HashEngine 2024-07-31 13:13:51 -07:00
CHANGELOG.md Document the sha256t_hash_newtype direction 2024-05-07 12:48:07 +10:00
Cargo.toml Bump MSRV to 1.63 2024-07-27 07:24:32 +02:00
README.md Bump MSRV to 1.63 2024-07-27 07:24:32 +02: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.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.