Skip to content

docs: improve feegrant#2037

Merged
jcstein merged 4 commits intomainfrom
jcs/feegrant-fix
Jun 4, 2025
Merged

docs: improve feegrant#2037
jcstein merged 4 commits intomainfrom
jcs/feegrant-fix

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented May 14, 2025

Overview

Resolves #2036

Summary by CodeRabbit

  • Documentation
    • Updated instructions to include setting the RPC_PORT environment variable.
    • Revised transaction command to use both RPC_URL and RPC_PORT for node specification.
    • Added a new section demonstrating how a grantee can submit transactions using the --fee-granter flag, including a detailed example and explanation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 14, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation for feegrant usage in Celestia has been updated to include the RPC_PORT environment variable, clarify its use in transaction commands, and add an example demonstrating how a grantee can submit transactions using the --fee-granter flag. No code or logic changes were made.

Changes

File(s) Change Summary
how-to-guides/feegrant-for-blobs.md Added RPC_PORT environment variable, updated command to use $RPC_URL:$RPC_PORT, and included a new section with an example for grantee transactions using --fee-granter.

Sequence Diagram(s)

sequenceDiagram
    participant Granter
    participant Grantee
    participant CelestiaAppd

    Granter->>CelestiaAppd: Grant fee allowance to Grantee (via feegrant grant)
    Grantee->>CelestiaAppd: Submit transaction with --fee-granter=Granter
    CelestiaAppd->>CelestiaAppd: Process transaction, deduct fees from Granter
Loading

Assessment against linked issues

Objective Addressed Explanation
Add example of sending tx with grantee account using celestia-appd (#2036)
Update command to use --node $RPC_URL:$RPC_PORT and add RPC_PORT env var in celestia-appd section (#2036)
Add export for RPC_PORT in celestia-node step (#2036)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Poem

In the meadow of docs, a rabbit did write,
About fee grants and ports, making things right.
With $RPC_PORT and grantee in tow,
Celestia’s commands now perfectly flow.
So hop along, friends, and send blobs with glee—
The fee’s on the granter, not you or me! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0423205 and 1a8ac18.

📒 Files selected for processing (1)
  • how-to-guides/feegrant-for-blobs.md (3 hunks)

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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

github-actions bot commented May 14, 2025

PR Preview Action v1.6.1
Preview removed because the pull request was closed.
2025-06-04 03:52 UTC

Comment thread how-to-guides/feegrant-for-blobs.md Outdated
@jcstein jcstein self-assigned this Jun 4, 2025
@jcstein jcstein marked this pull request as ready for review June 4, 2025 03:52
@jcstein jcstein merged commit d08dfe8 into main Jun 4, 2025
7 checks passed
@jcstein jcstein deleted the jcs/feegrant-fix branch June 4, 2025 03:52
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.

docs: update feegrant guide

1 participant