docs: apply community feedback on Blobstream proof queries#1556
docs: apply community feedback on Blobstream proof queries#1556
Conversation
WalkthroughThis update enriches an HTTP query example for better understanding, incorporating details on querying data root inclusion proof alongside a JSON response example. It also introduces a Golang query illustration and a comprehensive method to validate a Celestia block commitment using the Blobstream X contract. Changes
Poem
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional Context UsedLanguageTool (144)
Additional comments not posted (2)
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: 1
Out of diff range and nitpick comments (3)
developers/blobstream-proof-queries.md (3)
Line range hint
5-5: Possible spelling mistake in the description.Consider revising "inclusion proofs used in Blobstream" to "inclusion proofs used with Blobstream" for better clarity.
Line range hint
22-22: Consider using a hyphen for compound adjectives.- low level constructs + low-level constructs
Line range hint
31-31: In American English, abbreviations like "etc." require a period.- R0, R1 etc + R0, R1 etc.
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (2)
developers/blobstream-proof-queries.md (2)
158-162: The HTTP query example is clear and demonstrates how to use the endpoint effectively. However, consider adding a note about potential errors or common issues that might arise when using this endpoint to better prepare developers.Consider adding error handling examples or common pitfalls in using the
data_root_inclusion_proofendpoint to enhance the documentation's utility.
Line range hint
234-402: The full example provided for proving a Celestia block commitment is comprehensive and includes good error handling and resource management practices. However, ensure that theethClient.Close()andeventsIterator.Close()calls are handled even if an error occurs earlier in the function.func verify() error { ctx := context.Background() ethClient, err := ethclient.Dial("evm_rpc_endpoint") if err != nil { return err } defer ethClient.Close() // Existing code... if event == nil { return fmt.Errorf("couldn't find range containing the transaction height") } // Existing code... }
2 participants
Overview
Apply some community feedback on the blobstream proof queries docs
Summary by CodeRabbit