Conversation
WalkthroughThe documentation for submitting data was updated to introduce and explain new fee estimation options for transaction submission via celestia-node. A new section details three modes of fee estimation: default consensus node estimation, third-party estimator via a CLI flag, and a user-defined maximum gas price limit. The document now also includes updated CLI usage examples and descriptions for the new flags. These changes are limited to documentation and do not affect any code or exported entities. Changes
Assessment against linked issues
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by adding a new "Fee estimation" section to clearly explain the available fee estimation options and CLI flags for transaction submissions. Key changes include:
- Adding a dedicated "Fee estimation" section with descriptions for default, third-party, and maximum gas price modes.
- Integrating tip and warning blocks to highlight important notes and requirements.
- Updating the CLI usage example to include additional flags and their explanations.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
how-to-guides/submit-data.md (1)
43-43: Duplicate: Third‑party estimation flag description
This matches the earlier suggestion for using--core.estimator.address. Great clarity here.
🧹 Nitpick comments (1)
how-to-guides/submit-data.md (1)
45-46: Refine max gas price default formatting
Consider wrapping the default value in code formatting for consistency, e.g.:Default maximum is `0.2 TIA` (100× the minimum gas price).This makes the CLI example more uniform.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/submit-data.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/submit-data.md
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s node will be used. - --max.gas.price: Sets the maximum gas price you're willi...
(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (3)
how-to-guides/submit-data.md (3)
37-46: Well-structured fee estimation section added
The new "Fee estimation" section succinctly outlines the three available modes (default, third‑party, maximum gas price) and provides clear context on applicability. This greatly enhances the documentation.
208-209: Approve CLI usage example update
Adding[flags]to thecelestia blob submitcommand prepares users to include the new fee estimation options and aligns with other docs.
211-214: Approve new CLI flags documentation
The--core.estimator.addressand--max.gas.priceflags are clearly documented, including syntax and behavior.🧰 Tools
🪛 LanguageTool
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s node will be used. ---max.gas.price: Sets the maximum gas price you're willi...(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
how-to-guides/submit-data.md (3)
37-39: Suggest consistent naming for the node binary: The section header and bullets use “Celestia‑node” to refer to the software, but elsewhere (including CLI examples) you invoke thecelestiabinary. For clarity, pick one convention (e.g., consistently usecelestia-nodeorcelestia) and apply it throughout the guide.
45-45: Clarify gas price units in the default maximum description: The phrase “100 times the minimum gas price (0.2 TIA)” may be ambiguous without specifying “per gas unit.” Consider updating to something like:Default maximum: 0.2 TIA per gas unit (100× the minimum gas price)
to make the unit context explicit.
213-213: Add explicit type for the--max.gas.priceflag: To match the style used for the--core.estimator.address stringflag, include a type annotation after the flag name. For example:- - `--max.gas.price`: Sets the maximum gas price you’re willing to pay… + - `--max.gas.price string`: Sets the maximum gas price you’re willing to pay…🧰 Tools
🪛 LanguageTool
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s node will be used. ---max.gas.price: Sets the maximum gas price you're willi...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/submit-data.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/submit-data.md
[uncategorized] ~213-~213: Loose punctuation mark.
Context: ...s node will be used. - --max.gas.price: Sets the maximum gas price you're willi...
(UNLIKELY_OPENING_PUNCTUATION)
Overview
Resolves #1942
Summary by CodeRabbit