Update blobstream-contracts.md

[S1nus]

fix typo in link

Overview

Link was broken. Here's a fix.

Summary by CodeRabbit

• Documentation
  • Corrected a hyperlink reference in the documentation for improved navigation and accuracy.

[coderabbitai]

Walkthrough

The update primarily addresses a correction in the documentation by fixing a hyperlink reference. This minor but crucial adjustment ensures that users are directed to the correct resource, enhancing the accuracy and usability of the documentation.

Changes

File Path	Change Summary
.../blobstream-contracts.md	Corrected a hyperlink reference in the documentation

🐇✨
In the docs of code, a link was astray,
A rabbit hopped by and found a better way.
With a twitch of the nose and a quick little fix,
The path was made right, no more tricks!
Hoppily ever after, the code flows today. 🌟
🐇✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[github-actions]

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-07 14:59 UTC

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (9)

developers/blobstream-contracts.md (9)

Line range hint 111-111: Consider adding a comma for clarity: "In other words, analogously, it verifies that a specific block header..."

---

Line range hint 129-129: Reword for clarity and grammatical correctness: "The library is stateless, and allows passing an IDAOracle interface as a parameter..."

---

Line range hint 138-138: Remove the extra space before "This function verifies that the shares..."

---

Line range hint 144-144: Remove the extra space before "This function verifies that a row/column..."

---

Line range hint 150-150: Remove the extra space before "This function verifies that a set of..."

---

Line range hint 156-156: Remove the extra space before "This function computes the Celestia..."

---

Line range hint 162-162: Remove the extra space before "This function computes the Celestia..."

---

Line range hint 164-164: Correct the grammatical error: "It is the user's responsibility to verify that the proof is valid and that the shares were successfully committed to using the verifySharesToDataRootTupleRoot() method."

- from a shares to row/column root proof.
+ from shares to a row/column root proof.

---

Line range hint 166-166: Consider adding a comma for clarity: "...committed to, using the verifySharesToDataRootTupleRoot() method."

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 60356e5 and 5d887c0.

Files selected for processing (1)

• developers/blobstream-contracts.md (1 hunks)

Additional Context Used

LanguageTool (9)

developers/blobstream-contracts.md (9)

Near line 111: Possible missing comma found.
Context: ...ndexed by batch nonce). In other words, analogously it verifies that a specific block heade...

---

Near line 129: Did you mean “passing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: .... The library is stateless, and allows to pass an IDAOracle` interface as a parameter...

---

Near line 138: Loose punctuation mark.
Context: ...rc/lib/verifier/DAVerifier.sol#L80-L124): This function verifies that the sha...

---

Near line 144: Loose punctuation mark.
Context: ...c/lib/verifier/DAVerifier.sol#L133-L155): This function verifies that a row/c...

---

Near line 150: Loose punctuation mark.
Context: ...c/lib/verifier/DAVerifier.sol#L164-L194): This function verifies that a set o...

---

Near line 156: Loose punctuation mark.
Context: ...c/lib/verifier/DAVerifier.sol#L204-L215): This function computes the Celestia ...

---

Near line 162: Loose punctuation mark.
Context: ...c/lib/verifier/DAVerifier.sol#L224-L229): This function computes the Celestia...

---

Near line 164: The plural noun “shares” cannot be used with the article “a”. Did you mean “a share” or “shares”?
Context: ...s the Celestia block square size from a shares to row/column root proof. It is the u...

---

Near line 166: Possible missing comma found.
Context: ... the shares were successfully committed to using the `verifySharesToDataRootTupl...

Additional comments not posted (1)

developers/blobstream-contracts.md (1)

170-170: Corrected hyperlink to point to the appropriate document.