Skip to content

feat: add section on maxblob size#1608

Merged
jcstein merged 4 commits intomainfrom
jcs/max-blob-size
Jul 19, 2024
Merged

feat: add section on maxblob size#1608
jcstein merged 4 commits intomainfrom
jcs/max-blob-size

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Jun 14, 2024

Overview

PREVIEW
Screenshot 2024-06-14 at 3 51 26 PM

  • Adds a section on max blob size to mainnet beta page 4f4a3cf
  • a link to the long description from the short description 4f4a3cf
  • adds link on node-tutorial in callout to the new, shorter description 5f8768b
  • adds a link to code in the long description 5044134

Summary by CodeRabbit

  • Documentation
    • Introduced a new section on maximum blob size in transaction guidelines, detailing limits and share distribution.
    • Added a tip regarding blob size in the Node tutorial for enhanced clarity.
    • Enhanced mainnet documentation with references to relevant code snippets for blob size calculations.

@jcstein jcstein marked this pull request as draft June 14, 2024 19:42
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 14, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The change enhances documentation on maximum blob size in Celestia transactions, detailing the share grid breakdown and the influence of governance parameters. It includes guidance in the Node tutorial for users to understand blob sizes and references to specific code repositories for further clarity on calculations.

Changes

Files Change Summary
developers/submit-data.md Introduced details about the maximum blob size in transactions, including share grid breakdown and potential governance changes.
developers/node-tutorial.md Added a tip to learn more about the maximum blob size when submitting data in the Node tutorial document.
nodes/mainnet.md Referenced specific code snippets in the celestia-app and celestia-node repositories related to blob size calculation factors.

Sequence Diagram(s)

No diagrams are needed for these changes.

Poem

In the world of data bytes and shares,
Celestia knows the size it dares.
For blobs, a max they now define,
With governance tweak, it may align.
A note in tutorials, hints in the guide,
This knowledge now forever resides. 🐇🌟


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 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.
    • @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 as 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.

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

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 14, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1608/
on branch main at 2024-07-19 21:56 UTC

Copy link
Copy Markdown
Contributor

@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: 0

Outside diff range and nitpick comments (4)
developers/submit-data.md (4)

Line range hint 45-45: Consider adding a comma after "However" for better readability.

- However gas price is often specified by users
+ However, gas price is often specified by users

Line range hint 58-58: A comma may be missing after "Cosmos-SDK". Enhancing readability could be beneficial here.

- ...in the Cosmos-SDK this is not always the case.
+ ...in the Cosmos-SDK, this is not always the case.

Line range hint 167-167: Consider using "resolve" instead of "fix" for a more formal tone.

- ...and a willingness to accept changes to fix this issue.
+ ...and a willingness to accept changes to resolve this issue.

Line range hint 195-238: Replace hard tabs with spaces to adhere to Markdownlint recommendations.

- <code with hard tabs>
+ <equivalent code with spaces>
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3eafe8e and 4f4a3cf.

Files selected for processing (1)
  • developers/submit-data.md (1 hunks)
Additional context used
LanguageTool
developers/submit-data.md

[uncategorized] ~45-~45: A comma may be missing after the conjunctive/linking adverb ‘However’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...by specifying and deducting a flat fee. However gas price is often specified by users i...


[uncategorized] ~58-~58: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...on above of how gas works in the Cosmos-SDK this is not always the case. Notably, i...


[style] ~167-~167: Consider using a different verb for a more formal wording. (FIX_RESOLVE)
Context: ... and a willingness to accept changes to fix this issue. ## API Users can currentl...

Markdownlint
developers/submit-data.md

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs


196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs


197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs


199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs


200-200: Column: 1 (MD010, no-hard-tabs)
Hard tabs


201-201: Column: 1 (MD010, no-hard-tabs)
Hard tabs


206-206: Column: 1 (MD010, no-hard-tabs)
Hard tabs


207-207: Column: 1 (MD010, no-hard-tabs)
Hard tabs


208-208: Column: 1 (MD010, no-hard-tabs)
Hard tabs


209-209: Column: 1 (MD010, no-hard-tabs)
Hard tabs


211-211: Column: 1 (MD010, no-hard-tabs)
Hard tabs


212-212: Column: 1 (MD010, no-hard-tabs)
Hard tabs


213-213: Column: 1 (MD010, no-hard-tabs)
Hard tabs


214-214: Column: 1 (MD010, no-hard-tabs)
Hard tabs


215-215: Column: 1 (MD010, no-hard-tabs)
Hard tabs


217-217: Column: 1 (MD010, no-hard-tabs)
Hard tabs


218-218: Column: 1 (MD010, no-hard-tabs)
Hard tabs


219-219: Column: 1 (MD010, no-hard-tabs)
Hard tabs


220-220: Column: 1 (MD010, no-hard-tabs)
Hard tabs


221-221: Column: 1 (MD010, no-hard-tabs)
Hard tabs


223-223: Column: 1 (MD010, no-hard-tabs)
Hard tabs


224-224: Column: 1 (MD010, no-hard-tabs)
Hard tabs


225-225: Column: 1 (MD010, no-hard-tabs)
Hard tabs


226-226: Column: 1 (MD010, no-hard-tabs)
Hard tabs


227-227: Column: 1 (MD010, no-hard-tabs)
Hard tabs


229-229: Column: 1 (MD010, no-hard-tabs)
Hard tabs


231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs


232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs


233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs


234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs


235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs


237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs


238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

Additional comments not posted (1)
developers/submit-data.md (1)

15-24: The new section on maximum blob size is clear and informative. The explanation of how the maximum size is determined and its potential variability based on governance decisions is well articulated. However, consider adding a reference or link to where users can participate or view these governance decisions to make this section more actionable.

@jcstein jcstein self-assigned this Jun 14, 2024
@jcstein jcstein added P0 Top priority documentation Improvements or additions to documentation labels Jun 14, 2024
@jcstein jcstein marked this pull request as ready for review June 14, 2024 19:51
Copy link
Copy Markdown
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f4a3cf and 5044134.

Files selected for processing (2)
  • developers/node-tutorial.md (1 hunks)
  • nodes/mainnet.md (1 hunks)
Additional context used
LanguageTool
nodes/mainnet.md

[style] ~94-~94: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...guide will link to the relevant network in order to show you how to connect to them. Learn ...


[style] ~98-~98: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...tions of the types of nodes you can run in order to participate in Mainnet Beta: ### Conse...


[uncategorized] ~261-~261: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...istory of the chain without pruning any data so all data available data is retrievab...

developers/node-tutorial.md

[uncategorized] ~102-~102: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...all Golang celestia-node is written in Golang so we must install Golang to build and ...


[uncategorized] ~178-~178: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...the correct version of Go was installed correctly run: bash go version ...


[uncategorized] ~486-~486: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... - --node.store string - the path to root/home directory of your celestia-node st...


[uncategorized] ~497-~497: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...se flags in the following order: 1. If user passes auth token, auth token is used. ...


[uncategorized] ~498-~498: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... If user doesn't pass auth token, check node store flag, create token from node s...


[style] ~502-~502: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ore. #### Auth token 🔐 {#auth-token} In order to interact with the API using RPC CLI, yo...


[style] ~526-~526: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ....network arabica) ``` #### Node store In order to interact with the API using RPC CLI, yo...


[uncategorized] ~595-~595: The preposition “into” seems more likely in this position than the preposition “to”. (AI_EN_LECTOR_REPLACEMENT_PREPOSITION_TO_INTO)
Context: ... plaintext string which will be encoded to base64 ('Hello There!') - Optionally,...


[style] ~860-~860: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...# Get your node ID This is an RPC call in order to get your node's peerId information: ``...


[style] ~888-~888: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ur account address This is an RPC call in order to get your node's account address: ```ba...


[uncategorized] ~1032-~1032: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ...c02gxspa29wmh0d ``` Then, transfer the amount of tokens that you would like, while se...


[grammar] ~1064-~1064: The word ‘help’ is a conjunction. In formal texts, use “to”. (HELP_AND_VB)
Context: ...$NODE_STORE ``` #### Help To get help and view the CLI menu, use the following co...


[uncategorized] ~1070-~1070: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...: bash celestia --help To view help menu for a specific method, use the fol...


[style] ~1091-~1091: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...rces ### Submitting a blob using curl In order to post a blob using curl, you will need a...

Additional comments not posted (1)
developers/node-tutorial.md (1)

465-467: Ensure the link to submit-data.md is correct.

Comment thread nodes/mainnet.md
Comment thread developers/submit-data.md

## Maximum blob size

The maximum total blob size in a transaction is just under **2 MiB
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Although this is technically the max blob size, I think we should provide an advisable maximum size of something like 80-90% of the max size to avoid timeouts on users submitting large blobs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't make sense to me yet WHY it happens. I know things would get congested if the entire block gets filled, but I wasn't aware it happens to individual blobs as well?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

if the whole block is filled with just 1 blob then there is no room for any other transactions, so it will most likely take longer to get it included, unless you really jack up the gas

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

so i think encouraging people to not try to push the limit would help things get included without wasting gas on beating the lower fees out

Copy link
Copy Markdown
Contributor

@distractedm1nd distractedm1nd left a comment

Choose a reason for hiding this comment

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

Thank you for explaining, makes sense

@jcstein jcstein requested a review from rootulp July 19, 2024 16:40
Comment thread developers/submit-data.md
Comment thread developers/submit-data.md
@jcstein jcstein merged commit ba92df2 into main Jul 19, 2024
@jcstein jcstein deleted the jcs/max-blob-size branch July 19, 2024 21:56
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 P0 Top priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants