Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update DA.GetProofs doc #45

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Conversation

pepyakin
Copy link
Contributor

@pepyakin pepyakin commented Feb 20, 2024

Summary by CodeRabbit

  • Refactor
    • Updated the GetProofs method to return inclusion proofs for specific Blob IDs, enhancing the precision of proof retrieval.

Copy link

coderabbitai bot commented Feb 20, 2024

Walkthrough

The update refines the GetProofs method within the DA interface to return inclusion proofs specifically for Blobs identified by their IDs, rather than providing proofs for all Blobs at a certain blockchain height. This modification narrows down the focus of proof retrieval to targeted Blob IDs, enhancing precision in the process.

Changes

File(s) Summary of Changes
da.go Modified GetProofs method in DA interface to return inclusion proofs for specific Blob IDs.

🐇✨
In the land of code and byte,
A rabbit hopped with sheer delight.
For GetProofs had found its way,
To fetch by ID, not height, hooray!
No more the all, but just the one,
Precision now, our victory won.
🌟📜

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

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 011ba69 and b3838c3.
Files selected for processing (1)
  • da.go (1 hunks)
Additional comments: 1
da.go (1)
  • 19-19: The updated documentation for the GetProofs method clearly specifies that it returns inclusion proofs for Blobs based on their IDs. This change aligns with the PR objectives and provides clarity on the method's functionality. It's important to ensure that all references to this method in the codebase, documentation, and examples are updated to reflect this change in functionality. Additionally, consider adding examples or further clarification if the method's behavior under certain conditions (e.g., non-existent IDs) is not obvious.

@nashqueue nashqueue added the documentation Improvements or additions to documentation label Feb 20, 2024
Copy link

codecov bot commented Feb 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (011ba69) 78.01% compared to head (b3838c3) 78.01%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #45   +/-   ##
=======================================
  Coverage   78.01%   78.01%           
=======================================
  Files           3        3           
  Lines         191      191           
=======================================
  Hits          149      149           
  Misses         32       32           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nashqueue nashqueue merged commit 4538294 into rollkit:main Feb 20, 2024
19 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants