docs: adds documentation to proofs package #3245
Conversation
rach-id
requested review from
evan-forbes,
rootulp,
cmwaters,
staheri14 and
ninabarbakadze
as code owners
|
Warning Rate Limit Exceeded@rach-id has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 54 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThis update provides documentation for the Celestia app's proof package, explaining proof queries for transactions and blobs in the Celestia network. It covers share commitment generation, inclusion proofs, Celestia square layout, and data root computation, ensuring data integrity through proof generation and verification. Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
pkg/proof/README.md
Outdated
| when constructing the square. | ||
| This means | ||
| that it is possible to prove the inclusion of a blob to a set of row roots using the generated *share commitment*. |
There was a problem hiding this comment.
what is structural wrapping?
Co-authored-by: Rootul P <[email protected]>
There was a problem hiding this comment.
This still results in markdownlint errors for me:
$ make lint
--> Running golangci-lint
--> Running markdownlint
pkg/proof/README.md:5 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
pkg/proof/README.md:20:32 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:82:161 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:89:62 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:135:56 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
pkg/proof/README.md:138:109 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:149:102 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:198:194 MD047/single-trailing-newline Files should end with a single newline character
make: *** [lint] Error 1
[blocking] fix markdowlint issues
[not blocking but nice] remove all the random unnecessary new lines
pkg/proof/README.md
Outdated
| when constructing the square. | ||
| This means | ||
| that it is possible to prove the inclusion of a blob to a set of row roots using the generated *share commitment*. |
There was a problem hiding this comment.
Can we disable that feature, it makes this content difficult to read. Also why did it add a newline after "means" here:
This means
that it is possible to prove the inclusion of a blob to a set of row roots using the generated *share commitment*.
Co-authored-by: Rootul P <[email protected]>
|
@rootulp Removed new lines. Now each sentence is in a new line. Re-review please when you have time |
There was a problem hiding this comment.
Thanks for persisting through several rounds of feedback. TBH this still results in markdownlint issues for me:
$ make lint
--> Running golangci-lint
--> Running markdownlint
pkg/proof/README.md:11:256 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:14:32 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:21:190 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:63:239 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:69:127 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:78:126 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:88:224 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:106:56 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
pkg/proof/README.md:109:109 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
pkg/proof/README.md:119:102 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
make: *** [lint] Error 1
but given CI isn't complaining, maybe it's unique to me? I have the same version of markdownlint installed locally as the one in CI. Ref: https://github.com/rach-id/celestia-app/blob/9b5880517a00316cc52874d0e500205257ee1acc/.github/workflows/markdown-linter.yml#L18
$ markdownlint --version
0.39.0
|
@rootulp Let's create an issue for that |
Overview
Adds documentation to the proofs package.
Closes #3120 and #1313