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

fix(api): change gas_price to use pending block #1082

Merged
merged 3 commits into from
Oct 29, 2024
Merged

Conversation

yiweichi
Copy link
Member

@yiweichi yiweichi commented Oct 24, 2024

1. Purpose or design rationale of this PR

The eth_gasPrice API returns gas price based on latest block, but eth_estimateGas use gas price based on pending block. So if we use the eth_gasPrice API gas price to do an eth_estimateGas API call, there is a possibility it will fail and return max fee per gas less than block base fee. that's because if L1 gas spike and gas-oracle updates the l1BaseFee, the pending block baseFee will be higher than the one based on latest block.
So I think we could change eth_gasPrice API to return gas price based on pending block, that will prevent this issue, and provides a more accurate suggest gas price.

See more details here: https://www.notion.so/scrollzkp/l2geth-returns-wrong-gas-price-issue-1297792d22af8045bbb1e57ff974e6c7

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • fix: A bug fix

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced gas price suggestion logic for improved accuracy.
    • Streamlined transaction sending process with clearer method naming.
    • Added method for retrieving pending block data and receipts.
  • Bug Fixes

    • Improved error handling pathways for block retrieval in gas price calculations.
  • Chores

    • Incremented patch version from 24 to 25, reflecting updates in the software release.

Copy link

coderabbitai bot commented Oct 24, 2024

Walkthrough

The changes in this pull request primarily focus on the GasPrice and SendTransaction methods within the PublicEthereumAPI struct in internal/ethapi/api.go. The GasPrice method's logic is updated to fetch the base fee from a pending block, enhancing error handling. The SignAndSendTransaction method is renamed to SendTransaction, reflecting a shift in API clarity while maintaining the same functionality. Additionally, the VersionPatch constant in params/version.go is incremented from 24 to 25, updating the versioning scheme without altering other logic in the file. A new method, PendingBlockAndReceipts, is added to the Backend interface in internal/ethapi/backend.go.

Changes

File Change Summary
internal/ethapi/api.go Updated GasPrice method to retrieve base fee from pending block; renamed SignAndSendTransaction to SendTransaction.
internal/ethapi/backend.go Added PendingBlockAndReceipts() method to Backend interface.
params/version.go Incremented VersionPatch constant from 24 to 25, affecting version output formatting.

Poem

In the code where rabbits hop,
Gas prices rise, they never stop.
With a new name, transactions fly,
Version's up, oh my, oh my!
Hopping through changes, swift and bright,
Code's a dance, a pure delight! 🐇✨


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>, 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 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.

colinlyguo
colinlyguo previously approved these changes Oct 28, 2024
internal/ethapi/api.go Outdated Show resolved Hide resolved
Copy link

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

🧹 Outside diff range and nitpick comments (1)
internal/ethapi/backend.go (1)

66-66: Add documentation for the new method.

The method signature looks good and aligns well with the interface's design. However, please add documentation to clarify:

  • The purpose of this method
  • Whether the returned block/receipts can be nil
  • Any thread safety guarantees

Consider this documentation:

+// PendingBlockAndReceipts returns the currently pending block and associated receipts.
+// Both return values may be nil if no block is pending.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7ea1d52 and d13e8fd.

📒 Files selected for processing (2)
  • internal/ethapi/api.go (1 hunks)
  • internal/ethapi/backend.go (1 hunks)
🔇 Additional comments (1)
internal/ethapi/api.go (1)

71-73: LGTM! The changes improve gas price estimation accuracy.

The modification to use pending block's base fee instead of latest block's base fee is a good improvement that will help prevent transaction failures during L1 gas price spikes. The implementation is robust with proper nil checks for both pending block and base fee.

internal/ethapi/backend.go Show resolved Hide resolved
@yiweichi yiweichi merged commit 9fff27e into develop Oct 29, 2024
9 checks passed
@yiweichi yiweichi deleted the fix-gas-price-api branch October 29, 2024 08:07
0xmountaintop pushed a commit that referenced this pull request Oct 30, 2024
* fix(api): change gas_price to use pending block
0xmountaintop added a commit that referenced this pull request Oct 30, 2024
* fix(api): change gas_price to use pending block (#1082)

* fix(api): change gas_price to use pending block

* fix

---------

Co-authored-by: Morty <70688412+yiweichi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants