Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update hasher documentation #6392

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

AaronFeickert
Copy link
Collaborator

Description

Updates the documentation for DomainSeparatedBorshHasher.

Motivation and Context

Some hashing is handled by DomainSeparatedBorshHasher, which uses Borsh encoding under the hood instead of manually using length prepending and byte slices. This PR updates the corresponding documentation for clarity.

How Has This Been Tested?

No testing needed.

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

Confirm that the updated documentation is accurate.

Copy link

github-actions bot commented Jul 8, 2024

Test Results (CI)

    3 files    120 suites   36m 10s ⏱️
1 293 tests 1 293 ✅ 0 💤 0 ❌
3 871 runs  3 871 ✅ 0 💤 0 ❌

Results for commit c500490.

♻️ This comment has been updated with latest results.

@ghpbot-tari-project ghpbot-tari-project added P-acks_required Process - Requires more ACKs or utACKs P-reviews_required Process - Requires a review from a lead maintainer to be merged labels Jul 8, 2024
Copy link

github-actions bot commented Jul 8, 2024

Test Results (Integration tests)

 2 files  11 suites   42m 34s ⏱️
35 tests 33 ✅ 0 💤 2 ❌
39 runs  34 ✅ 0 💤 5 ❌

For more details on these failures, see this check.

Results for commit c500490.

♻️ This comment has been updated with latest results.

Copy link
Member

@sdbondi sdbondi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@ghpbot-tari-project ghpbot-tari-project removed the P-reviews_required Process - Requires a review from a lead maintainer to be merged label Jul 9, 2024
@SWvheerden SWvheerden merged commit 50925b4 into tari-project:development Jul 10, 2024
14 of 16 checks passed
@AaronFeickert AaronFeickert deleted the hasher-docs branch July 10, 2024 14:39
sdbondi added a commit to sdbondi/tari that referenced this pull request Jul 22, 2024
* development: (93 commits)
  chore: fix build and osp (tari-project#6415)
  chore: refactor key manager names (tari-project#6411)
  fix: panic in from_base58 fn (tari-project#6414)
  fix: branch keys (tari-project#6413)
  chore: remove dependancy on ledger for common types (tari-project#6412)
  feat: count unique keys (tari-project#6401)
  feat!: fix key manager use of keys (tari-project#6407)
  refactor: remove metadata sig and use difference key branch for offset (tari-project#6400)
  feat: update ledger instructions (tari-project#6406)
  feat: add file-based input and output to faucet commands (tari-project#6405)
  chore: new release v1.0.0-pre.16 (tari-project#6404)
  feat: simplify leader sig generation (tari-project#6399)
  ci(fix): include macOS universal assets in release (tari-project#6402)
  fix: script dependance on party order (tari-project#6398)
  fix: claim n of m faucet (tari-project#6389)
  feat: add ffi features (tari-project#6390)
  chore: fix unwraps in memory key manager (tari-project#6396)
  docs: update hasher documentation (tari-project#6392)
  chore: fix ci (tari-project#6391)
  feat(miner): add SHA P2Pool mining related configuration and changes (tari-project#6370)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P-acks_required Process - Requires more ACKs or utACKs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants