You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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/
@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.
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
, andreverse_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:
The text was updated successfully, but these errors were encountered: