milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Tobin C. Harding b9643bf3e9 Import bitcoin_hashes crate into hashes 
We would like to bring the `bitcoin_hashes` crate into the
`rust-bitcoin` repository.

Import `bitcoin_hashes` into `rust-bitocin/hashes`, doing so looses all
the commit history from the original crate but if we archive the
original repository then the history will be preserved. We maintain the
same version number obviously and in the changelog we note the change of
repository.

Commit hash that was tip of `bitcoin_hashes` at time of import:

 commit 54c16249e06cc6b7870c7fc07d90f489d82647c7

Includes making `embedded` and `fuzzing` per-crate i.e., move them into
`bitcoin` as hashes includes these also.

NOTE: Does _not_ enable fuzzing for `hashes` in CI.

Notes on CI:

Attempts to merge in the github actions from the hashes crate however reduces
coverage by not running hashes tests for beta toolchain. Some additional
work could be done to improve the CI to increase efficiency without
reducing coverage. Leaving for another day.
 		2022-11-08 08:58:09 +11:00
..
contrib Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
embedded Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
extended_tests/schemars Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
fuzz Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
src Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
CHANGELOG.md Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
Cargo.toml Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +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.