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

feat: document --gas.price flag #1403

Merged
merged 3 commits into from
Feb 12, 2024
Merged

feat: document --gas.price flag #1403

merged 3 commits into from
Feb 12, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Feb 8, 2024

Overview

This documents celestiaorg/celestia-node#3094

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated the tutorial on setting gas prices in the celestia CLI. The --fee and --gas.limit flags have been replaced by a single --gas-price flag. Gas limit calculation now depends on submitted data size.

@jcstein jcstein self-assigned this Feb 8, 2024
Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Walkthrough

The celestia CLI has updated its gas price handling by introducing the --gas-price flag to simplify setting gas prices. The --fee and --gas.limit flags have been replaced, and the gas limit is now dynamically calculated based on data size. These changes enhance user experience by automating gas limit determination.

Changes

File(s) Change Summary
developers/.../node-tutorial.md Updated to reflect the replacement of --fee and --gas.limit with --gas-price. Gas limit calculation based on data size.

🐰✨
In the land of code, where the celestia lies,
A change has been made, under the digital skies.
No more --fee or --gas.limit, just --gas-price to set,
A rabbit hops along, with no regret.
🌌🚀

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@jcstein jcstein added the documentation Improvements or additions to documentation label Feb 8, 2024
Copy link
Contributor

github-actions bot commented Feb 8, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs/pr-preview/pr-1403/
on branch gh-pages at 2024-02-08 15:58 UTC

Copy link
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a60eef4 and db98b00.
Files selected for processing (1)
  • developers/node-tutorial.md (1 hunks)
Additional comments: 1
developers/node-tutorial.md (1)
  • 791-794: The example command for submitting a blob with a specified gas price correctly demonstrates the usage of the --gas-price flag. However, the preceding text contains a typo in the gas price value, which could confuse readers.

developers/node-tutorial.md Outdated Show resolved Hide resolved
developers/node-tutorial.md Outdated Show resolved Hide resolved
@jcstein jcstein enabled auto-merge (squash) February 8, 2024 00:32
@jcstein jcstein requested a review from Bidon15 February 8, 2024 02:36
@jcstein
Copy link
Member Author

jcstein commented Feb 8, 2024

however, this shouldn't be merged until we've upgraded Arabica/Mocha/Mainnet IMO cc @Bidon15 for vis
#1404

developers/node-tutorial.md Outdated Show resolved Hide resolved
developers/node-tutorial.md Outdated Show resolved Hide resolved
developers/node-tutorial.md Outdated Show resolved Hide resolved
developers/node-tutorial.md Outdated Show resolved Hide resolved
Copy link
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between db98b00 and 149fe88.
Files selected for processing (1)
  • developers/node-tutorial.md (1 hunks)
Additional comments: 3
developers/node-tutorial.md (3)
  • 778-787: The introduction of the --gas-price flag and its default behavior is clear. However, ensure that the documentation elsewhere (not in the provided diff) also reflects this change, especially in sections that previously referenced the now-replaced --fee and --gas.limit flags.
  • 789-789: The link to learn more about gas fees and limits should be verified to ensure it leads to updated content reflecting the new --gas-price flag.
  • 791-794: The example command for setting a higher gas price using the --gas.price flag is correct and demonstrates the intended usage well. Ensure that examples like this are consistently updated across all relevant documentation sections.

@jcstein jcstein changed the title feat: document gas-price flag feat: document --gas.price flag Feb 8, 2024
@jcstein jcstein merged commit 6e63196 into main Feb 12, 2024
4 checks passed
@jcstein jcstein deleted the jcs/celestia-node-gas-change branch February 12, 2024 16:33
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants