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

Functions naming and doc comments improvements #191

Closed
ilitteri opened this issue Nov 7, 2023 · 1 comment · Fixed by #196
Closed

Functions naming and doc comments improvements #191

ilitteri opened this issue Nov 7, 2023 · 1 comment · Fixed by #196
Assignees
Labels
auditory documentation Improvements or additions to documentation

Comments

@ilitteri
Copy link
Collaborator

ilitteri commented Nov 7, 2023

Context: P256VERIFY.yul

Description:

Descriptions of the functions returning constants defining the curve and the field are unclear.

Recommendation:

We recommend updating the wording of the description of a couple of functions. We suggest to use Recommended Elliptic Curve Domain Parameters as a reference.

  1. P256VERIFY.yul#L12 P() is a prime number which defines the field which is a domain of the curve parameters.
  2. P256VERIFY.yul#L19. N() is the order of generator G.
@ilitteri ilitteri added auditory documentation Improvements or additions to documentation labels Nov 7, 2023
@ilitteri ilitteri self-assigned this Nov 7, 2023
@ilitteri ilitteri linked a pull request Nov 7, 2023 that will close this issue
@ilitteri
Copy link
Collaborator Author

Resolved in #200

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

Successfully merging a pull request may close this issue.

1 participant