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

Doc comments for functions #242

Closed
IAvecilla opened this issue Apr 12, 2024 · 0 comments · Fixed by #254
Closed

Doc comments for functions #242

IAvecilla opened this issue Apr 12, 2024 · 0 comments · Fixed by #254
Assignees

Comments

@IAvecilla
Copy link
Contributor

Context: EcPairing.yul

Description: There are a couple of typos in the functions' doc comments. Some of the require additional information:

Recommendation:

  1. computeLine and mixedAdditionStep require that points in Jacobian coordinates are not equal. We recommend to mention and explain this why it's it's never a case in this implementation. We add and double point Q which is G2 group generator of an order of 21888242871839275222246405745257275088548364400416034343698204186575808495617. So will never reach Q``
  2. g2ProjectiveFromAffine doc comment is wrong. It should be If x or y differ from 0, just add z = (1,0).
  3. There is a mistake in MONTGOMERY_TWISTED_CURVE_COEFFS doc comment. Twisted curve equation is wrong. b coefficient should be 3/(9+u).
  4. Wrong curve equation in g2AffinePointIsOnCurve doc comment

zkSync:

Spearbit:

@IAvecilla IAvecilla self-assigned this Apr 12, 2024
@IAvecilla IAvecilla linked a pull request Apr 12, 2024 that will close this issue
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 a pull request may close this issue.

1 participant