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

Update README.md #133

Merged
merged 1 commit into from
Dec 6, 2024
Merged

Update README.md #133

merged 1 commit into from
Dec 6, 2024

Conversation

serrrfirat
Copy link
Contributor

@serrrfirat serrrfirat commented Nov 9, 2024

Seems like people confuse the costs when we put the state costs instead of receipt costs, so I'm removing it.


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Improved clarity and conciseness of the README.md file.
    • Removed redundant information regarding NEAR blockchain state storage costs.
    • Enhanced readability while maintaining the overall structure and content.

Seems like people confuse the costs when we put the state costs instead of receipt costs, so I'm removing it.
@serrrfirat serrrfirat requested a review from dndll as a code owner November 9, 2024 01:10
Copy link

coderabbitai bot commented Nov 9, 2024

Walkthrough

The changes in the README.md file involve rephrasing and restructuring for improved clarity and conciseness. A redundant phrase about the cost of NEAR blockchain state storage was removed to streamline the explanation. The document maintains its overall structure, detailing various components such as the Blob store contract and integrations with other rollups, while enhancing readability without introducing new features or altering existing functionalities.

Changes

File Change Summary
README.md Rephrased and restructured sentences for clarity; removed redundant phrase about NEAR blockchain state storage costs. Overall structure retained, with no new features or alterations to existing functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant README
    User->>README: Request for information on NEAR blockchain state storage
    README-->>User: Provides clear and concise explanation
Loading

🪧 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.

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.

Actionable comments posted: 1

🧹 Outside diff range comments (1)
README.md (1)

Line range hint 82-82: Consider tracking the TODO item in GitHub Issues.

The TODO comment about writing and drawing up extensions to the light client and architecture diagram should be tracked in a GitHub issue for better visibility and follow-up.

Would you like me to create a GitHub issue to track this task?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 5026b81 and 41b705c.

📒 Files selected for processing (1)
  • README.md (1 hunks)

@@ -13,8 +13,7 @@ Herein outlines the components of the project and their purposes.

This contract provides the store for arbitrary DA blobs. In practice, these "blobs" are sequencing data from rollups, but they can be any data.

NEAR blockchain state storage is pretty cheap. At the time of writing, 100KiB is a flat fee of 1NEAR.
To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.
NEAR blockchain state storage is pretty cheap. To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

LGTM! Consider a minor enhancement for clarity.

The removal of specific state costs and focus on the cost-reduction strategy improves maintainability and prevents confusion. However, consider adding a link to NEAR's official documentation about storage costs for users who want current pricing information.

-NEAR blockchain state storage is pretty cheap. To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.
+NEAR blockchain state storage is pretty cheap (see [official pricing](https://docs.near.org/concepts/storage/storage-staking)). To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
NEAR blockchain state storage is pretty cheap. To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.
NEAR blockchain state storage is pretty cheap (see [official pricing](https://docs.near.org/concepts/storage/storage-staking)). To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.

@dndll dndll merged commit 28b6b80 into main Dec 6, 2024
4 of 5 checks passed
@dndll dndll deleted the firatsertgoz-patch-1 branch December 6, 2024 12:38
@Santalov
Copy link

To limit the costs of NEAR storage even more, we don't store the blob data in the blockchain state.

How much more the costs of NEAR storage are lowered by this approach?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants