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

chore: fixes the description of the index of leafHash in the absence proof #114

Merged
merged 1 commit into from
Feb 28, 2023

Conversation

staheri14
Copy link
Contributor

@staheri14 staheri14 commented Feb 28, 2023

Overview

This PR intends to bring the description of the leafHash field in the Proof data structure in line with the specification. Additionally, among the three criteria enumerated for the leafHash the third criterion is redundant since it is already covered by the first two. Although this has already been addressed in the specification, the code description needs to be updated, and this PR accomplishes that (this comment was originally raised in #110 (comment)).

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@staheri14 staheri14 added the documentation Improvements or additions to documentation label Feb 28, 2023
@staheri14 staheri14 self-assigned this Feb 28, 2023
@staheri14 staheri14 marked this pull request as ready for review February 28, 2023 21:19
@codecov
Copy link

codecov bot commented Feb 28, 2023

Codecov Report

Merging #114 (39cdb65) into master (6e4a5c3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #114   +/-   ##
=======================================
  Coverage   96.31%   96.31%           
=======================================
  Files           6        6           
  Lines         461      461           
=======================================
  Hits          444      444           
  Misses         11       11           
  Partials        6        6           
Impacted Files Coverage Δ
nmt.go 98.82% <ø> (ø)
proof.go 96.73% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants