milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Jamil Lambert, PhD 27f94d5540
Replace `creates` with `constructs` 
In functions that act like constructors there is a mixture of the usage
of `creates` and `constructs`.

Replace all occurrences of `creates` with `constructs` in the first line
of docs of constructor like functions.
 		2024-11-05 12:47:28 +00:00
..
contrib CI: Hobble WASM job 2024-10-23 06:59:51 +11:00
embedded Remove hashes io feature 2024-09-09 06:37:49 +10:00
src Replace `creates` with `constructs` 2024-11-05 12:47:28 +00:00
tests 2024-09-15 automated rustfmt nightly 2024-09-15 01:19:55 +00:00
CHANGELOG.md hashes: Add changelog for release 0.15.0 2024-10-31 17:14:26 +11:00
Cargo.toml Bump hex-conservative to 0.3.0 2024-10-31 03:36:22 +00: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.