milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Andrew Poelstra 895db71156
Merge rust-bitcoin/rust-bitcoin#1763: Use doc_auto_cfg 
a189942c64 Use doc_auto_cfg (Tobin C. Harding)

Pull request description:

  If we use `#![cfg_attr(docsrs, feature(doc_auto_cfg))]` instead of `#![cfg_attr(docsrs, feature(doc_cfg))]` we no longer need to manually mark types with `#[cfg_attr(docsrs, doc(cfg(feature = "std")))]`.

  Sweeeeeet.

  Props to pezcore for the lesson :)

ACKs for top commit:
  apoelstra:
    ACK a189942c64
  Kixunil:
    ACK a189942c64

Tree-SHA512: 1ced1e09f5d1733b362b83ca650d3f52c89eb57e78e8437f74c496d89776548f8c50feab6750352342e2abe680434681de2c126ce36a81dda21397b9695d4d4e
 		2023-03-30 16:56:49 +00:00
..
contrib Enable formatting in CI 2023-03-07 08:57:32 +11:00
embedded Make `hash_newtype` evocative of the output 2023-02-22 14:35:50 +01:00
extended_tests/schemars Re-name hash inner/byte methods 2023-02-27 14:23:58 +11:00
fuzz Add fuzz target for sha512_256 2022-12-21 16:36:35 +09:00
src Merge rust-bitcoin/rust-bitcoin#1763: Use doc_auto_cfg 2023-03-30 16:56:49 +00:00
CHANGELOG.md bitcoin_hashes: add CHANgELOG 2023-03-05 13:53:45 +00:00
Cargo.toml rename bitcoin-internals to bitcoin-private 2023-03-13 16:02:12 +00:00
README.md Bump MSRV to 1.48.1 2023-03-23 08:03:06 +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.48.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.