refactor(client/tx): Fix gas-adjustment only works with Simulate
#22973
Conversation
hieuvubk
requested review from
julienrbrt,
JulianToledano and
a team
as code owners
📝 WalkthroughWalkthroughThe pull request modifies the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
client/tx/tx.go (1)
90-93: Implementation aligns with PR objectives but needs safety checksThe change correctly implements gas adjustment for non-simulation mode, fixing the original issue. However, there are some safety considerations to address:
- Add bounds checking for gas adjustment factor to prevent unreasonable values
- Consider potential precision loss and overflow scenarios
Consider adding safety checks:
} else { + if txf.GasAdjustment() <= 0 { + return fmt.Errorf("gas adjustment must be positive: %f", txf.GasAdjustment()) + } // If not simulate, calculate gas_limit by gas * gas_adjustment gasUse := uint64(float64(txf.Gas()) * txf.GasAdjustment()) + if gasUse < txf.Gas() { + return fmt.Errorf("adjusted gas %d is less than original gas %d, possible overflow", gasUse, txf.Gas()) + } txf = txf.WithGas(gasUse) }
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
client/tx/tx.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
client/tx/tx.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -87,6 +87,10 @@ | |||
|
|
|||
| txf = txf.WithGas(adjusted) | |||
| _, _ = fmt.Fprintf(os.Stderr, "%s\n", GasEstimateResponse{GasEstimate: txf.Gas()}) | |||
| } else { | |||
| // If not simulate, calculate gas_limit by gas * gas_adjustment | |||
| gasUse := uint64(float64(txf.Gas()) * txf.GasAdjustment()) | |||
Check notice
Code scanning / CodeQL
Floating point arithmetic Note
There was a problem hiding this comment.
I think this is fine as is, because the gas-adjustment flag is meant to adjust over the calculated/simulated gas, not the passed in gas AFAIK. Also this is the description of the flag:
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
That does make sense 👍🏾 Closing this then. |
Description
Closes: #XXXX
gas-adjustmentonly works when tx in simulate mode (gas-autoor no gas passed). We should make the flag work even if user passes gas to the commandAuthor Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
Documentation