fix(core/gas): Add consumed API for GasMeter #21443
Conversation
WalkthroughWalkthroughThe changes introduce a new Changes
Assessment against linked issues
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
|
|
@sontrinh16 your pull request is missing a changelog! |
julienrbrt
added
backport/v0.52.x
| @@ -38,6 +38,7 @@ type Meter interface { | |||
| Consume(amount Gas, descriptor string) error | |||
| Refund(amount Gas, descriptor string) error | |||
| Remaining() Gas | |||
| Consumed() Gas | |||
There was a problem hiding this comment.
![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
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (3)
- core/gas/service.go (1 hunks)
- core/testing/gas/service_mocks.go (1 hunks)
- runtime/gas.go (2 hunks)
Additional context used
Path-based instructions (3)
core/gas/service.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.runtime/gas.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.core/testing/gas/service_mocks.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (6)
core/gas/service.go (1)
41-41: LGTM!The addition of the
Consumed()method to theMeterinterface is logical and aligns with the objective of accurately reporting gas consumption.The code changes are approved.
runtime/gas.go (3)
39-41: LGTM!The addition of the
Consumed()method to theCoreGasmeterstruct enhances its functionality by allowing users to access gas consumption metrics directly.The code changes are approved.
62-62: LGTM!The modification of the
GasConsumed()method in theSDKGasMeterstruct to returngm.gm.Consumed()instead ofgm.gm.Remaining()aligns with the objective of accurately reporting gas consumption.The code changes are approved.
69-69: LGTM!The modification of the
GasConsumedToLimit()method in theSDKGasMeterstruct to returngm.gm.Consumed()instead ofgm.gm.Remaining()aligns with the objective of accurately reporting gas consumption.The code changes are approved.
core/testing/gas/service_mocks.go (2)
103-109: LGTM!The addition of the
Consumed()method to theMockMeterstruct enhances its functionality by facilitating testing scenarios where gas consumption needs to be tracked or verified.The code changes are approved.
111-115: LGTM!The addition of the
Consumed()method to theMockMeterMockRecorderstruct improves the testing capabilities by providing a clearer interface for tracking gas consumption and setting expectations in mock interactions.The code changes are approved.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (3)
- core/gas/service.go (1 hunks)
- core/testing/gas/service_mocks.go (1 hunks)
- runtime/gas.go (2 hunks)
Additional context used
Path-based instructions (3)
core/gas/service.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.runtime/gas.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.core/testing/gas/service_mocks.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (6)
core/gas/service.go (1)
41-41: LGTM!The
Consumedmethod is correctly added to theMeterinterface, enhancing its functionality.The code changes are approved.
runtime/gas.go (3)
39-41: LGTM!The
Consumedmethod is correctly implemented in theCoreGasmeterstruct, enhancing its functionality.The code changes are approved.
62-62: LGTM!The modification to call
gm.gm.Consumed()instead ofgm.gm.Remaining()correctly aligns the method with the new logic, ensuring consistency in gas consumption reporting.The code changes are approved.
69-69: LGTM!The modification to call
gm.gm.Consumed()instead ofgm.gm.Remaining()correctly aligns the method with the new logic, ensuring consistency in gas consumption reporting.The code changes are approved.
core/testing/gas/service_mocks.go (2)
103-109: LGTM!The
Consumedmethod is correctly implemented in theMockMeterstruct, enhancing its mocking capabilities.The code changes are approved.
111-115: LGTM!The
Consumedmethod is correctly implemented in theMockMeterMockRecorderstruct, enhancing its mocking capabilities.The code changes are approved.
(cherry picked from commit 41a9af7) # Conflicts: # core/gas/service.go # core/testing/gas/service_mocks.go
Description
Closes: #21440
Author 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
Improvements