search

tari-project / tari-dan

BSD 3-Clause "New" or "Revised" License
5 stars 14 forks source link

chore!: renaming and hasher documentation #1069

Closed AaronFeickert closed 1 week ago

AaronFeickert commented 1 week ago

Description

Updates the documentation for TariHasher. Does some renaming relating to hasher outputs.

Motivation and Context

The TariHasher type has minimal documentation. Because it uses CBOR encoding under the hood to help ensure canonical hasher input, it may be useful to describe its design intent and requirements on input data. This PR adds such documentation.

Separately, one use of the hasher functionality is to produce vote signature messages. The naming used suggests this value is a signature challenge, which is not the case. This PR does some renaming to clarify this.

How Has This Been Tested?

Existing tests pass.

What process can a PR reviewer use to test or verify this change?

Confirm that the updated documentation is accurate, and that the renaming was done correctly.

BREAKING CHANGE: Changes the VoteSignatureService public trait API via a rename.

github-actions[bot] commented 1 week ago

Test Results (CI)

540 tests  ±0   540 :white_check_mark: ±0   1h 46m 56s :stopwatch: - 26m 12s  64 suites ±0     0 :zzz: ±0    2 files   ±0     0 :x: ±0 

Results for commit a682bb91. ± Comparison against base commit 9db28d44.