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(evm): proper block gas calculation in precompile calls #2131

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

onikonychev
Copy link
Contributor

@onikonychev onikonychev commented Dec 26, 2024

Summary by CodeRabbit

  • New Features

    • Added a new entry in the changelog for a bug fix related to block gas calculation in precompile calls.
    • Updated the changelog to reflect results from a third-party audit and highlight recent features and fixes.
  • Bug Fixes

    • Improved gas consumption tracking and error handling in contract calls.
  • Tests

    • Adjusted gas meter reset logic in test cases to enhance accuracy in gas consumption tracking.

@onikonychev onikonychev requested a review from a team as a code owner December 26, 2024 15:49
Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

This pull request introduces updates to the Nibiru EVM project's changelog and several code modifications related to gas management and testing. The changes focus on improving block gas calculation in precompile calls, refining gas meter handling in test suites, and updating documentation to reflect recent developments. The modifications aim to enhance the accuracy of gas consumption tracking and provide a clear record of project improvements.

Changes

File Change Summary
CHANGELOG.md Added new entry for PR #2131 fixing block gas calculation in precompile calls
x/evm/keeper/call_contract.go Modified gas consumption and error handling logic in CallContractWithInput method
x/evm/keeper/funtoken_from_coin_test.go Added deps.ResetGasMeter() to reset gas meter during testing
x/evm/precompile/funtoken_test.go Refined gas meter reset locations in FuntokenSuite test suite

Possibly related PRs

Suggested labels

x: evm

Suggested reviewers

  • Unique-Divine

Poem

🐰 Hopping through the EVM's maze,
Gas meters reset, code ablaze!
Precompile calls now crystal clear,
Nibiru's blockchain, ever so dear.
A rabbit's tale of code refined! 🔧

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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: 0

🧹 Nitpick comments (2)
x/evm/precompile/funtoken_test.go (2)

174-175: Refactor repeated ResetGasMeter call

Invoking deps.ResetGasMeter() right before the contract call is appropriate for measuring gas usage, but consider DRY (Don’t Repeat Yourself) by extracting this into a helper if it appears frequently throughout the tests.


258-259: Reinitialize gas meter consistently

Once again, deps.ResetGasMeter() is invoked. Confirm if each test block truly needs an independent reset or if a shared setup function could centralize this logic, improving maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3954394 and d25a668.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • x/evm/keeper/call_contract.go (1 hunks)
  • x/evm/keeper/funtoken_from_coin_test.go (1 hunks)
  • x/evm/precompile/funtoken_test.go (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • x/evm/keeper/funtoken_from_coin_test.go
🔇 Additional comments (3)
x/evm/keeper/call_contract.go (2)

111-111: Question the full gas consumption on error case

On error, the code consumes the entire gas limit by calling k.ResetGasMeterAndConsumeGas(ctx, ctx.GasMeter().Limit()). Confirm if the intended behavior is to fully charge for gas in all error cases, regardless of how much gas was actually used.


115-119: Validate double reset scenario and final block gas usage

After blockGasUsed is calculated, the code resets the gas meter again. Verify that calling ResetGasMeterAndConsumeGas again (after line 111’s usage) does not inadvertently double charge or overshadow prior consumption. Ensure that it reflects the precise final usage without incorrectly penalizing the user or contract.

CHANGELOG.md (1)

54-54: Looks good

The new entry under Nibiru EVM is consistent with the existing style, properly referencing pull request #2131 and describing the fix. No further changes needed.

Copy link

codecov bot commented Dec 26, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 4 lines in your changes missing coverage. Please review.

Project coverage is 64.95%. Comparing base (3954394) to head (d25a668).

Files with missing lines Patch % Lines
x/evm/keeper/call_contract.go 33.33% 3 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2131      +/-   ##
==========================================
+ Coverage   64.93%   64.95%   +0.02%     
==========================================
  Files         273      273              
  Lines       21656    21663       +7     
==========================================
+ Hits        14063    14072       +9     
+ Misses       6617     6615       -2     
  Partials      976      976              
Files with missing lines Coverage Δ
x/evm/keeper/call_contract.go 80.51% <33.33%> (+4.80%) ⬆️

Copy link
Member

@k-yang k-yang left a comment

Choose a reason for hiding this comment

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

This doesn't necessarily implement the desired functionality. Please see my comment at https://github.com/code-423n4/2024-11-nibiru-findings/issues/46#issuecomment-2564154771.

Specifically, we need to always add to block gas used, and never set the current tx's context's gas used to the blockGasUsed or else we'll OOG panic in later txs in the block.

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

Successfully merging this pull request may close these issues.

2 participants