rust-bitcoin-unsafe-fast/hashes
Andrew Poelstra 794ddde657
Merge rust-bitcoin/rust-bitcoin#1569: ci: Remove incorrect code comment and cargo clean
70bff0de8d ci: Remove incorrect code comment and cargo clean (Tobin C. Harding)

Pull request description:

  Recently while trying to fix CI I (Tobin) added a call to `cargo clean` and a code comment justifying it. This was merged because while not incorrect it is redundant since calling `cargo` with different `RUSTFLAGS` triggers a rebuild.

ACKs for top commit:
  apoelstra:
    ACK 70bff0de8d
  Kixunil:
    ACK 70bff0de8d

Tree-SHA512: 5bed107aedf9d6d240fa885335bfe04099436c0d30c045554644b43a06900c415708dfcedbd27037564d296c0ab12e4c4d4dc1e25ab64b4cc07ca7b46c46628a
2023-02-18 01:28:46 +00: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 Remove `ToHex` 2023-01-07 19:50:03 +01:00
extended_tests/schemars Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00
fuzz Add fuzz target for sha512_256 2022-12-21 16:36:35 +09:00
src Merge rust-bitcoin/rust-bitcoin#1593: hashes: Implement AsRef for fixed size arrays 2023-02-17 13:24:57 +00: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.