milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/hashes
History
merge-script 6adf952b0b
Merge rust-bitcoin/rust-bitcoin#4409: Manual update to rustc (to nightly-2025-05-02) 
5ba763f1a2 Update Github CI to rustc nightly-2025-05-02 (Jamil Lambert, PhD)
09132b80e1 Fix rustdoc compile_fail example (Jamil Lambert, PhD)
282434d4bd Use variable directly in format! string (Jamil Lambert, PhD)
2fbbc825c9 Allow uninlined format args (Jamil Lambert, PhD)

Pull request description:

  There is a new lint error on nightly-2025-04-25 "variables can be used directly in the `format!` string".
  The existing syntax `format!("{}", x)` is more commonly used than `format!("{x}")` therefore allow it in existing code.

  Also the rustdoc example in #4259 now causes the new nightly to fail CI because of the unused variable.

  Patches in the PR:

  - Exclude the lint to allow the existing syntax in `format!` strings in all crate `lib.rs`, `build.rs.` and test files.

  - Use the variables in the `format!` string for all cases in `bitcoin/examples/` since there are no other allowed lints in examples.

  - Correct the function names in the rustdoc example and prefix the unused variable with an underscore.

  - Update rustc to nightly-2025-05-02 (2025-04-25 had a bug which is fixed in 2025-05-02).

ACKs for top commit:
  apoelstra:
    ACK 5ba763f1a2ebea2cb80ee50a80228e6bda11936f; successfully ran local tests
  Kixunil:
    ACK 5ba763f1a2

Tree-SHA512: 20b97d2bedc631715c2b541285559a6ab84bbdb8f2f11d7282bdfecadba0cc8781a1973f0c01c25432aaceaad09e3ddbf59afe54c0bba54768e93ed9d5e50d5a
 		2025-05-07 14:13:07 +00:00
..
contrib Invert dependency between io and hashes 2025-02-11 09:17:21 +11:00
embedded chore: remove unused cortex-m dependency from embedded Cargo.toml files in bitcoin and hashes modules. 2025-04-05 18:25:41 +08:00
src Merge rust-bitcoin/rust-bitcoin#4409: Manual update to rustc (to nightly-2025-05-02) 2025-05-07 14:13:07 +00:00
tests Allow uninlined format args 2025-05-06 09:49:02 +01:00
CHANGELOG.md hashes: fix typo 2024-12-23 20:44:18 +08:00
Cargo.toml chore(hashes): update serde dependency to workspace 2025-04-08 14:45:47 -07:00
README.md Typo fix in: README.md 2025-02-27 12:40:30 +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 anyway.

Documentation

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.63.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 benchmark code. To run the benchmarks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.