milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
Andrew Poelstra 05293c1ab5
Merge rust-bitcoin/rust-bitcoin#2762: ci: shellcheck checks 
021bea89bb ci: shellcheck checks (Jose Storopoli)

Pull request description:

  Closes #2739.

  I am proposing that we use this GitHub Shellcheck action:
  [`ludeeus/action-shellcheck`](https://github.com/ludeeus/action-shellcheck)
  since it has most stars (and eyes on it).

  I also did all fixes that I could find with

  ```bash
  shellcheck **/*.sh
  ```

  If I've missed any please let me know.

ACKs for top commit:
  apoelstra:
    ACK 021bea89bb
  tcharding:
    ACK 021bea89bb

Tree-SHA512: 67e37da9ae3ea0c5551af57b928016a2d9e76761af5558b3057ac47e773189629dd20eea9e659b4323c8568fb48dcdbe9ebd5c730f2c6266fb0db52886c9835f
 		2024-05-13 13:10:44 +00:00
..
contrib ci: shellcheck checks 2024-05-11 18:08:53 +00:00
embedded ci: shellcheck checks 2024-05-11 18:08:53 +00:00
extended_tests/schemars chore: format and standardize all markdowns files 2024-04-27 06:29:23 -03:00
src 2024-05-12 automated rustfmt nightly 2024-05-12 01:05:51 +00:00
CHANGELOG.md Document the sha256t_hash_newtype direction 2024-05-07 12:48:07 +10: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.