rust-bitcoin-unsafe-fast/hashes
Andrew Poelstra 343c770ee7
Merge rust-bitcoin/rust-bitcoin#2662: hashes: Do not import str
71bb86232b hashes: Do not import str (Tobin C. Harding)

Pull request description:

  Depending on things being in scope for macros to use is bad form, using the fully qualified path is the correct way.

  Do not import `str` instead use the fully qualified path to the `core` re-export.

  Use fully qualified path instead.

ACKs for top commit:
  apoelstra:
    ACK 71bb86232b trivial rebase
  sanket1729:
    ACK 71bb86232b

Tree-SHA512: 401520a5876b83ad4053bbe9b1e8cd9ff2e723cf86f95e47891a6411ad5e9af4f904e19ccaaab80d342dfe4745753c24af168dcbc8170fb6b39da08e577d30ae
2024-05-04 11:54:24 +00:00
..
contrib CI: Re-write run_task.sh 2024-04-26 09:41:51 +10:00
embedded CI: Epic overhaul 2024-02-02 05:57:23 +11:00
extended_tests/schemars chore: format and standardize all markdowns files 2024-04-27 06:29:23 -03:00
src Merge rust-bitcoin/rust-bitcoin#2662: hashes: Do not import str 2024-05-04 11:54:24 +00:00
CHANGELOG.md hashes: Bump version to v0.14.0 2024-03-22 06:04:40 +11:00
Cargo.toml hashes: Bump version to v0.14.0 2024-03-22 06:04:40 +11:00
README.md chore: format and standardize all markdowns files 2024-04-27 06:29:23 -03: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.56.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.