rust-bitcoin / rust-bitcoin / 10510337566

83%

Build Type

push

github

Committed by apoelstra

Commit Message

Merge rust-bitcoin/rust-bitcoin#3184: Reduce API surface of tagged wrapped hash types

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/c97389596b9a18d3a9dcfbce3ade7274268483d2">c97389596<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/8f851967a20aade8c2b5591385bd7c90ec8e9592"> Remove stale docs from sha256t_hash_newtype (Tobin C. Harding)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/39f7dcb816723071db248d2ddc4718213990cde1">39f7dcb81</a> Reduce API surface of tagged wrapped hash types (Tobin C. Harding)

Pull request description:

  Recently we made it so that wrapper types created with `hash_newtype` were not general purpose hash types i.e., one could not easily hash arbitrary data into them. We would like to do the same for tagged wrapped hash types.

  In `hashes` do:

  - Create a new macro `sha256_tag` that does just the tag/engine stuff out of the `sha256t_hash_newtype` macro.
  - Deprecate the `sha256t_hash_newtype` macro.

  In `bitcoin` do:

  - Use a combination of `sha256_tag` and `hash_newtype` to create tagged wrapped hash types.

  Note that we do not add private helper functions `engine` and `from_engine` to the tagged wrapper types as we do for legacy/segwit in `sighash`. Can be done later if wanted/needed.

  Fix: #3135

ACKs for top commit:
  Kixunil:
    ACK c97389596b9a18d3a9dcfbce3ade7274268483d2
  apoelstra:
    ACK c97389596b9a18d3a9dcfbce3ade7274268483d2 successfully ran local tests

Tree-SHA512: d937a8eac00f2075b076919305653b14bca

Coverage Stats

44 of 50 new or added lines in 3 files covered. (88.0%)

2 existing lines in 1 file now uncovered.

19653 of 23752 relevant lines covered (82.74%)

15564.35 hits per line