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

Consistent naming across different implementations #22

Closed
Tracked by #26
0xbok opened this issue May 9, 2023 · 5 comments · Fixed by #66
Closed
Tracked by #26

Consistent naming across different implementations #22

0xbok opened this issue May 9, 2023 · 5 comments · Fixed by #66
Assignees

Comments

@0xbok
Copy link

0xbok commented May 9, 2023

Same values are named differently across implementations. While it's not a big deal for small code size, it helps the reader if they can be named same throughout.

For example: h[m,pk]^r is called:

Differing upto casing is fine, but arkworks impl variable name deviates the most from others.

@vuvoth vuvoth mentioned this issue May 15, 2023
4 tasks
@skaunov skaunov self-assigned this Sep 24, 2023
@skaunov
Copy link
Collaborator

skaunov commented Sep 24, 2023

I'll groom things, though particular examples which absolutely require attention would be beneficial.

@skaunov
Copy link
Collaborator

skaunov commented Sep 24, 2023

I guess it's best to choose naming based on the blog post, paper, and then some best judgement / linting?

@Divide-By-0
Copy link
Member

I guess it's best to choose naming based on the blog post, paper, and then some best judgement / linting?

That seems great. Also we can make edits to the blog post to include that terminology :p

https://github.com/Divide-By-0/blog/blob/main/content/posts/nullifier.md

@skaunov
Copy link
Collaborator

skaunov commented Oct 16, 2023

That seems great. Also we can make edits to the blog post to include that terminology :p

https://github.com/Divide-By-0/blog/blob/main/content/posts/nullifier.md

I can share my own experience: when first exposed to the scheme/protocol this hash & hash2 thing isn't make it really easier to follow. Do you think they could be more semantic?

skaunov added a commit that referenced this issue Oct 19, 2023
I need to think a bit if this `fn` [can benefit]
from renaming at all currently.
My current best bet to deal with it in line with #22 is to add agreed
naming suffix with `_computed` to the non-excessive assignment.

[can benefit]: #61
@skaunov skaunov linked a pull request Oct 20, 2023 that will close this issue
@Divide-By-0
Copy link
Member

That seems great. Also we can make edits to the blog post to include that terminology :p
https://github.com/Divide-By-0/blog/blob/main/content/posts/nullifier.md

I can share my own experience: when first exposed to the scheme/protocol this hash & hash2 thing isn't make it really easier to follow. Do you think they could be more semantic?

perfect! you should be able to fork slides.plume.run and the md blog post to be consistent with the semantic changes you made here, if you think it would help. im also now wondering if docs would be helpful!

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.

3 participants