chore: fix some typos in comment

[HongKuang]

Overview

fix some typos in comment

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and detail in the blobstream-proof-queries.md guide for querying inclusion proofs in Blobstream.
  • Updated blobstream-x-deploy.md with comprehensive deployment instructions for BlobstreamX, including environment variable setup and contract deployment steps.
  • Added examples and expanded sections on proof queries and deployment processes for better usability.

[coderabbitai]

Walkthrough

The pull request includes significant updates to two documentation files: blobstream-proof-queries.md and blobstream-x-deploy.md. The revisions enhance clarity and detail regarding querying inclusion proofs in Blobstream and provide comprehensive instructions for deploying BlobstreamX to a new chain. Key changes involve updated method signatures, expanded sections on proof queries and deployment processes, and the inclusion of detailed examples and prerequisites for developers.

Changes

File Path	Change Summary
how-to-guides/blobstream-proof-queries.md	Revised to clarify prerequisites for accessing Celestia, expanded proof query explanations, added examples, and updated warnings.
rpc/client/http/http.go	Updated method signature from ProveShares to ProveSharesV2.
rpc/client/interface.go	Updated method signature from ProveShares to ProveSharesV2.
how-to-guides/blobstream-x-deploy.md	Added detailed instructions for deploying SuccinctGateway, function verifiers, and BlobstreamX contract.

Possibly related PRs

• Update blobstream-proof-queries.md #1757: Updates to blobstream-proof-queries.md related to querying processes and method signatures for ProveShares.
• docs: add a blobstream X deployment section #1567: Adds a section about deploying Blobstream X, relevant to the main PR's focus on Blobstream and Celestia integration.
• docs: explain why using tx-hash to build a blobstream rollup is not good #1644: Discusses transaction hashes in blobstream-rollups.md, connecting to proof queries and data handling in Blobstream.
• Updated outdated link in blobstream-rollups.md #1761: Updates in blobstream-rollups.md regarding Blobstream rollups implementation related to proof generation clarity.
• docs: change build-whatever page to rollup-stacks #1801: Reorganization of documentation from "Build whatever" to "Rollup stacks," improving usability related to Blobstream functionalities.

Suggested reviewers

• jcstein
• Ferret-san

🐇 "In the land of blobs where data flows,
With proofs and gateways, knowledge grows.
Deploy with care, let clarity shine,
In the world of code, all will be fine!" 🌟

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

how-to-guides/blobstream-x-deploy.md (1)

Line range hint 746-746: Fix typo in comment

Add a space after "tuple" in the comment.

-/// was committed to, by the Blobstream smart contract, at some specific nonce.
+/// was committed to by the Blobstream smart contract at some specific nonce.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9b2f86f and ad61e36.

📒 Files selected for processing (2)

• how-to-guides/blobstream-proof-queries.md (2 hunks)
• how-to-guides/blobstream-x-deploy.md (1 hunks)

🔇 Additional comments (2)

how-to-guides/blobstream-x-deploy.md (1)

Line range hint 1031-1031: Same typo as before

how-to-guides/blobstream-proof-queries.md (1)

Line range hint 1-1200: Documentation is comprehensive and technically accurate

The documentation provides:

• Clear explanations of proof structures and their relationships
• Well-structured code examples with proper error handling
• Important deprecation notices for ProveShares → ProveSharesV2
• Detailed instructions for converting between different data formats

[gitpoap-bot]

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Celestia Contributor:

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.