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

Fix typos on signature.go #2065

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Conversation

EvanTedesco
Copy link
Contributor

Fixes typos in the documentation.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 7024494115

  • 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • 9 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.003%) to 56.067%

Files with Coverage Reduction New Missed Lines %
peer/peer.go 9 73.94%
Totals Coverage Status
Change from base Build 6933383934: -0.003%
Covered Lines: 27951
Relevant Lines: 49853

💛 - Coveralls

Copy link
Member

@jcvernaleo jcvernaleo left a comment

Choose a reason for hiding this comment

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

Good catches.

OK

@jcvernaleo jcvernaleo merged commit 6ea604d into btcsuite:master Nov 28, 2023
3 checks passed
@@ -124,8 +124,7 @@ func schnorrVerify(sig *Signature, hash []byte, pubKeyBytes []byte) error {
// 7. Fail if is_infinite(R)
// 8. Fail if not hash_even_y(R)
// 9. Fail is x(R) != r.
// 10. Return success iff not failure occured before reachign this
// point.
// 10. Return success if failure did not occur before reaching this point.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The term iff is a scientific notation for "if and only if". So this is now wrong and not in line with the actual BIP: https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki#verification

Copy link
Member

Choose a reason for hiding this comment

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

Damn, I missed that because the original line was not at all correct English.

Copy link
Member

Choose a reason for hiding this comment

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

An iff mixed in with the rest of the typos was indistinguishable from another type :)

Anyway, if you PR putting the iff back I'll merge. If not, I'll PR tomorrow.

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

Successfully merging this pull request may close these issues.

4 participants