docs: reflect the deprecated endpoint in docs#1571
Conversation
WalkthroughCelestia-app v1.10.0 bids farewell to the old Changes
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}
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/blobstream-proof-queries.md (3 hunks)
Additional Context Used
LanguageTool (15)
developers/blobstream-proof-queries.md (15)
Near line 53: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...wo are split into shares, which are the low level constructs of a Celestia block, and sav...
Near line 62: In American English, abbreviations like “etc.” require a period.
Context: ...are is highlighted in green.R0,R1etc, represent the respective row and colum...
Near line 86: Possible missing comma found.
Context: ...data root tuple root. Check the above diagram which shows: - 0: those are the shares...
Near line 99: Consider a shorter alternative to avoid wordiness.
Context: ...lished to the corresponding block. - 3: in order to batch multiple blocks into the same com...
Near line 161: Unpaired symbol: ‘]’ seems to be missing
Context: ...he data commitment defined by the range[10, 20). Example response: <div style...
Near line 581: The comma may be misplaced. Try moving it before ‘and’, or removing it altogether.
Context: ...tion hash of the PFB containing the blob and, the<blob_index>being the index of t...
Near line 610: Unpaired symbol: ‘]’ seems to be missing
Context: ...e=1Which queries the proof of shares[0,1)in block15`. Example response: ...
Near line 687: Possible missing comma found.
Context: ...L89). Please use the new method for the queries as the old one will be removed in upcom...
Near line 751: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...(...). ###shareProofs` This is the shares proof to the row roots. These can conta...
Near line 1015: Loose punctuation mark.
Context: ...leProof proof; } ``` -tupleRootNonce: the nonce at which Blobstream X committ...
Near line 1017: Loose punctuation mark.
Context: ...the block containing the data. -tuple: theDataRootTupleof the block: ```s...
Near line 1034: Possible typo: you repeated a word
Context: ..., i.e. the block containing the Rollup data data root, and theheightwhich is thehe...
Near line 1037: Loose punctuation mark.
Context: ...s theheightof that block. -proof: theBinaryMerkleProofof the data roo...
Near line 1089: Loose punctuation mark.
Context: ...n during the verification: -dataRoot: can be queried using the `/block?height...
Near line 1092: Loose punctuation mark.
Context: ...ld from the response. -tupleRootNonce: can be retried via querying the `Blob...
Additional comments not posted (3)
developers/blobstream-proof-queries.md (3)
663-669: Deprecation warning forprove_sharesendpoint is clear and informative.
682-688: Deprecation warning forProveSharesmethod is clear and informative.
1304-1305: Note about switching toProveSharesV2is clear and informative.
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (48)
developers/blobstream-proof-queries.md (48)
408-408: Remove trailing space.There is an unnecessary trailing space at the end of this line.
408-409: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
409-409: Remove trailing space.There is an unnecessary trailing space at the end of this line.
Line range hint
418-418: Remove trailing space.There is an unnecessary trailing space at the end of this line.
532-532: Remove trailing space.There is an unnecessary trailing space at the end of this line.
582-582: Fix misplaced comma.The comma may be misplaced. Try moving it before ‘and’, or removing it altogether.
582-582: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
584-584: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
Line range hint
589-589: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
604-605: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
666-666: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
670-670: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
684-684: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
685-685: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
689-689: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
1305-1306: Fix line length.The line length exceeds the recommended limit of 80 characters. Consider breaking it into multiple lines for better readability.
Line range hint
1492-1492: Remove trailing space.There is an unnecessary trailing space at the end of this line.
Line range hint
35-35: Remove trailing space.There is an unnecessary trailing space at the end of this line.
Line range hint
79-79: Remove trailing space.There is an unnecessary trailing space at the end of this line.
Line range hint
161-161: Fix missing closing bracket.Unpaired symbol: ‘]’ seems to be missing. Ensure the range is correctly closed.
Line range hint
612-612: Fix missing closing bracket.Unpaired symbol: ‘]’ seems to be missing. Ensure the range is correctly closed.
Line range hint
53-53: Add hyphen for compound adjective.If "low level" is a compound adjective modifying "constructs," use a hyphen: "low-level constructs."
Line range hint
62-62: Add period after abbreviation.In American English, abbreviations like “etc.” require a period.
Line range hint
86-86: Add missing comma.Possible missing comma found. Add a comma after "diagram."
Line range hint
99-99: Consider a shorter alternative.Consider a shorter alternative to avoid wordiness. For example, "To batch multiple blocks into the same commitment, we create..."
582-582: Fix misplaced comma.The comma may be misplaced. Try moving it before ‘and’, or removing it altogether.
689-689: Add missing comma.Possible missing comma found. Add a comma after "queries."
Line range hint
800-800: Add missing comma.Possible missing comma found. Add a comma after "type."
Line range hint
1016-1016: Fix loose punctuation.Loose punctuation mark. Consider revising for clarity.
Line range hint
1018-1018: Fix loose punctuation.Loose punctuation mark. Consider revising for clarity.
Line range hint
1035-1035: Fix repeated word.Possible typo: you repeated the word "data." Consider removing one instance.
Line range hint
1038-1038: Fix loose punctuation.Loose punctuation mark. Consider revising for clarity.
Line range hint
1090-1090: Fix loose punctuation.Loose punctuation mark. Consider revising for clarity.
Line range hint
1093-1093: Fix loose punctuation.Loose punctuation mark. Consider revising for clarity.
Line range hint
185-185: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
227-227: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
401-401: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
499-499: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
579-579: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
658-658: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
729-729: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
876-876: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
993-993: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
1078-1078: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
1161-1161: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
1208-1208: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
1245-1245: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Line range hint
1486-1486: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines for better readability.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- developers/blobstream-proof-queries.md (7 hunks)
Additional Context Used
LanguageTool (15)
developers/blobstream-proof-queries.md (15)
Near line 53: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...wo are split into shares, which are the low level constructs of a Celestia block, and sav...
Near line 62: In American English, abbreviations like “etc.” require a period.
Context: ...are is highlighted in green.R0,R1etc, represent the respective row and colum...
Near line 86: Possible missing comma found.
Context: ...data root tuple root. Check the above diagram which shows: - 0: those are the shares...
Near line 99: Consider a shorter alternative to avoid wordiness.
Context: ...lished to the corresponding block. - 3: in order to batch multiple blocks into the same com...
Near line 161: Unpaired symbol: ‘]’ seems to be missing
Context: ...he data commitment defined by the range[10, 20). Example response: <div style...
Near line 582: The comma may be misplaced. Try moving it before ‘and’, or removing it altogether.
Context: ...tion hash of the PFB containing the blob and, the<blob_index>being the index of t...
Near line 612: Unpaired symbol: ‘]’ seems to be missing
Context: ...e=1Which queries the proof of shares[0,1)in block15`. Example response: ...
Near line 689: Possible missing comma found.
Context: ...L89). Please use the new method for the queries as the old one will be removed in upcom...
Near line 800: Possible missing comma found.
Context: ...ue TheminandmaxareNamespacetype which is: ```solidity /// @notice A re...
Near line 1016: Loose punctuation mark.
Context: ...leProof proof; } ``` -tupleRootNonce: the nonce at which Blobstream X committ...
Near line 1018: Loose punctuation mark.
Context: ...the block containing the data. -tuple: theDataRootTupleof the block: ```s...
Near line 1035: Possible typo: you repeated a word
Context: ..., i.e. the block containing the Rollup data data root, and theheightwhich is thehe...
Near line 1038: Loose punctuation mark.
Context: ...s theheightof that block. -proof: theBinaryMerkleProofof the data roo...
Near line 1090: Loose punctuation mark.
Context: ...n during the verification: -dataRoot: can be queried using the `/block?height...
Near line 1093: Loose punctuation mark.
Context: ...ld from the response. -tupleRootNonce: can be retried via querying the `Blob...
2 participants
Overview
Summary by CodeRabbit
Deprecations
prove_sharesendpoint in favor ofprove_shares_v2.ProveSharesmethod in favor ofProveSharesV2.User Guidance
prove_shares_v2endpoint andProveSharesV2method starting from Celestia-app v1.10.0.