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

Documentation of KZGSettings (Branch das) #439

Closed
b-wagn opened this issue Jun 18, 2024 · 2 comments
Closed

Documentation of KZGSettings (Branch das) #439

b-wagn opened this issue Jun 18, 2024 · 2 comments

Comments

@b-wagn
Copy link
Contributor

b-wagn commented Jun 18, 2024

Note: this issue is about this branch.

When reading the code, I felt that the different fields related to roots of unity in KZGSettings (here) are a bit confusing.
This includes the fields roots_of_unity, expanded_roots_of_unity, and reverse_roots_of_unity.

As a result, it is a bit hard to understand code that uses these fields, or to modify code properly if needed.
For example, here are some questions that I can not immediately resolve from the documentation.
A better documentation and more consistent naming could help to identify what they are.
The main questions that the comments/naming should address for each field are the following:

  • Is the field related to a blob or to an extended blob?
  • How long is the field, i.e., how many elements does it contain?
  • Are these roots in reverse bit ordering or not?
@patniemeyer
Copy link

FYI on the documentation topic - I wrote a short, developer-level article that shows how to use the ckzg libs from Python and walks through the nature and the sizes of the datatypes (how to chunk the data) including how to use the roots of unity from KZGSettings to address your data elements. If it is useful it could be expanded upon and turned into documentation. Link: https://pat.net/ckzg/

@asn-d6
Copy link
Contributor

asn-d6 commented Aug 5, 2024

@b-wagn fixed the big issues with the roots of unity in #467.
There were a few additional concerns with the KZGSettings fields raised in the PR. Feel free to take a stab at them if you would like.

For now, I'm closing this issue. But feel free to open a new one with more specific tasks.

@asn-d6 asn-d6 closed this as completed Aug 5, 2024
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

No branches or pull requests

3 participants