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(solidity-devops): set only priority fee until foundry bug is fixed #2447

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

ChiTimesChi
Copy link
Collaborator

@ChiTimesChi ChiTimesChi commented Apr 4, 2024

Description
Temp fix to prevent sending txs with maxGasFee = maxPriority, like this one:

Additional context

Summary by CodeRabbit

  • Bug Fixes
    • Temporarily disabled maxGasPrice calculation in gas price options due to a bug, now using only priorityFee.

Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Walkthrough

The recent update focuses on a workaround in the applyAutoFillGasPrice function, where the calculation of maxGasPrice using baseFee and priorityFee has been temporarily disabled due to a discovered bug. Now, the gas price is solely determined by the priorityFee, sidestepping the bug while awaiting a more permanent fix.

Changes

File Change Summary
.../js/utils/chain.js Disabled maxGasPrice calculation; using only priorityFee

Assessment against linked issues

Objective Addressed Explanation
Max Priority gas price does not work (#7486) The change addresses the symptom but may not resolve the underlying issue with maxPriorityGasPrice not being respected.

🐇✨
In the land of code and night,
A bug did give us quite the fright.
With a hop and a skip, we made a change,
Though temporary, it may seem strange.
Until the bug is truly gone,
We hop along and carry on.
🌟🐰

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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.
  • 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/coderabbit-overrides.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.

@ChiTimesChi ChiTimesChi merged commit 8720608 into master Apr 4, 2024
46 of 48 checks passed
@ChiTimesChi ChiTimesChi deleted the fix/sol-devops-gas-pricing-1559-temp-fix branch April 4, 2024 15:09
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.

Actionable comments posted: 1

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between c21ec2f and f84f59a.
Files selected for processing (1)
  • packages/solidity-devops/js/utils/chain.js (1 hunks)

Comment on lines +95 to +109
/*
TODO: reenable this once the foundry bug is fixed: https://github.com/foundry-rs/foundry/issues/7486
Currently the maxGasPrice is used for both base and priority, rendering the setting of priority fee useless.

// Use 2*base + priority as the max gas price
const maxGasPrice = 2 * baseFee + priorityFee
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--with-gas-price ${maxGasPrice} --priority-gas-price ${priorityFee}`
)
*/
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--priority-gas-price ${priorityFee}`
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a more detailed comment explaining the temporary nature of this workaround, including a link to the Foundry issue and a note about the intended reintegration of the original logic.

  /* 
+  // Temporary workaround for Foundry bug #7486
+  // Issue link: https://github.com/foundry-rs/foundry/issues/7486
+  // This change bypasses the original calculation of maxGasPrice to avoid incorrect gas fee settings.
+  // The original logic should be reintegrated once the Foundry bug is resolved.
   TODO: reenable this once the foundry bug is fixed: https://github.com/foundry-rs/foundry/issues/7486
   Currently the maxGasPrice is used for both base and priority, rendering the setting of priority fee useless.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
/*
TODO: reenable this once the foundry bug is fixed: https://github.com/foundry-rs/foundry/issues/7486
Currently the maxGasPrice is used for both base and priority, rendering the setting of priority fee useless.
// Use 2*base + priority as the max gas price
const maxGasPrice = 2 * baseFee + priorityFee
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--with-gas-price ${maxGasPrice} --priority-gas-price ${priorityFee}`
)
*/
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--priority-gas-price ${priorityFee}`
)
/*
// Temporary workaround for Foundry bug #7486
// Issue link: https://github.com/foundry-rs/foundry/issues/7486
// This change bypasses the original calculation of maxGasPrice to avoid incorrect gas fee settings.
// The original logic should be reintegrated once the Foundry bug is resolved.
TODO: reenable this once the foundry bug is fixed: https://github.com/foundry-rs/foundry/issues/7486
Currently the maxGasPrice is used for both base and priority, rendering the setting of priority fee useless.
// Use 2*base + priority as the max gas price
const maxGasPrice = 2 * baseFee + priorityFee
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--with-gas-price ${maxGasPrice} --priority-gas-price ${priorityFee}`
)
*/
return options.replace(
OPTION_AUTO_FILL_GAS_PRICE_1559,
`--priority-gas-price ${priorityFee}`
)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant