milksad

History

Tobin C. Harding 161273b209 Re-name hash inner/byte methods Currently we have an associated type on hash types `Inner` with accompanying methods `into_inner`, `from_inner`, `as_inner`. Also, we provide a way to create new wrapped hash types. The use of 'inner' becomes ambiguous with the addition of wrapped types because the inner could be the inner hash type or the `Inner` byte array of the inner wrapped hash type. In an effort to make the API more clear and uniform do the following: - Rename `Inner` -> `Bytes` - Rename `_inner` -> `_byte_array` - Rename the inner hash to/from methods to `*_raw_hash` Correct method prefix `into_` -> `to_` because theses methods convert owned `Copy` types. Add the trait Bound `Copy` to the `Bytes` type because we rely on this trait bound for the conversion methods to be correctly named according to convention. Because of the dependency hole created by `secp256k1` this patch changes the secp dependency to a git tag dependency that includes changes to the hashes calls required so that we can get green lights on CI in this repo.		2023-02-27 14:23:58 +11: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	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	Re-name hash inner/byte methods	2023-02-27 14:23:58 +11: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

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.