Skip to content

docs: clarify fee estimation section#1996

Merged
jcstein merged 1 commit intomainfrom
jcstein-patch-1
Apr 22, 2025
Merged

docs: clarify fee estimation section#1996
jcstein merged 1 commit intomainfrom
jcstein-patch-1

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Apr 18, 2025

Overview

Summary by CodeRabbit

  • Documentation
    • Clarified the fee estimation process for Celestia transactions, including distinctions between PayForBlobs (PFB) and other transaction types.
    • Improved wording for third-party fee estimation and updated notes to provide more detailed guidance.

@jcstein jcstein requested review from adlerjohn and renaynay April 18, 2025 14:15
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 18, 2025

Walkthrough

The documentation for submitting data on Celestia was updated to clarify how fee estimation works for different transaction types. The language was refined to consistently refer to "fee estimation," and a new note was added explaining that for PayForBlobs (PFB) transactions, only the gas price is dynamically estimated while gas usage remains fixed. For all other transactions, both gas price and gas usage are dynamically estimated. This replaces a previous, less detailed note about fee estimation applicability.

Changes

File(s) Change Summary
how-to-guides/submit-data.md Refined wording around fee estimation, replaced the note about fee estimation with a detailed explanation of its behavior for PFB and non-PFB transactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    Note over Docs: User reads updated documentation
    User->>Docs: Consults fee estimation section
    alt PFB Transaction
        Docs-->>User: Explains only gas price is estimated, gas usage fixed
    else Other Transaction
        Docs-->>User: Explains both gas price and gas usage are estimated
    end
Loading

Possibly related PRs

Poem

In the warren of docs, a change hops by,
Clarifying fees as transactions fly.
PFB or not, now all is clear—
Gas price or usage, distinctions appear.
With every byte and every fee,
The Celestia docs hop toward clarity!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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 generate docstrings to generate docstrings for this 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.

@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.6.1

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1996/

Built to branch main at 2025-04-18 14:16 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@jcstein jcstein self-assigned this Apr 18, 2025
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

🧹 Nitpick comments (1)
how-to-guides/submit-data.md (1)

49-52: Refine the PFB note for clarity
The new tip is helpful, but the first bullet can be more concise and mirror the summary’s phrasing. For example:

- - PayForBlobs (PFB) transactions: Only the gas price (cost per unit) is dynamically estimated. The gas usage (number of units) uses a fixed calculation method.
+ - PayForBlobs (PFB) transactions: Only the gas price (cost per unit) is dynamically estimated, while gas usage remains fixed.

This version reads more fluidly and keeps both bullets parallel.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe86c79 and dc72305.

📒 Files selected for processing (1)
  • how-to-guides/submit-data.md (2 hunks)
🔇 Additional comments (1)
how-to-guides/submit-data.md (1)

44-44: Consistent terminology for fee estimation
The updated description correctly replaces “gas price and gas estimation” with “fee estimation,” aligning with the PR’s objective to standardize terminology and clarify the feature.

@jcstein jcstein merged commit 24dea9f into main Apr 22, 2025
6 checks passed
@jcstein jcstein deleted the jcstein-patch-1 branch April 22, 2025 15:38
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