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.

Sign up for GitHub

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

Jump to bottom

fix(precompile): consume gas before returning error #2152

Merged
merged 2 commits into from
Jan 8, 2025
Merged

fix(precompile): consume gas before returning error #2152

merged 2 commits into from
Jan 8, 2025
+11 −9

Conversation

k-yang
Copy link
Member

@k-yang k-yang commented Jan 8, 2025 •
edited by coderabbitai bot
Loading

Purpose / Abstract

Summary by CodeRabbit

  • Bug Fixes

    • Fixed gas consumption for precompile calls to ensure gas is consumed regardless of errors
    • Corrected ERC20 token burning process after converting coins back to ERC20

  • Documentation

    • Updated CHANGELOG.md with recent fixes and improvements

@k-yang k-yang requested a review from a team as a code owner January 8, 2025 18:30
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025 •
edited
Loading

Walkthrough

This pull request focuses on improving gas consumption tracking for precompile calls in the Nibiru EVM. The changes span multiple precompile files (funtoken, oracle, and wasm) to ensure consistent gas metering. The modifications involve explicitly recording gas consumption after contract method execution, regardless of whether an error occurs. The changelog is updated to reflect these changes, with a new entry added for pull request #2152 addressing the gas consumption fix.

Changes

File Change Summary
CHANGELOG.md - Added entry for #2152 about gas consumption for precompile calls
- Minor formatting adjustment for #2139 entry
x/evm/precompile/funtoken.go Re-enabled gas consumption tracking by uncommenting gas meter update line
x/evm/precompile/oracle.go Moved gas consumption recording before error checking
x/evm/precompile/wasm.go Added explicit gas consumption recording after contract method execution

Sequence Diagram

sequenceDiagram
    participant Contract
    participant EVMRuntime
    participant GasMeter

    Contract->>EVMRuntime: Execute Precompile Method
    EVMRuntime->>GasMeter: Record Gas Consumed
    EVMRuntime->>Contract: Return Execution Result
Loading

Possibly related PRs

Suggested reviewers

  • Unique-Divine

Poem

🐰 Hopping through the EVM's maze,
Gas meters dancing in coding phase,
Precompiles now track each spark,
No more silent, hidden mark!
Nibiru's blockchain hops with grace 🔥

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7aebf75 and e4c330e.

📒 Files selected for processing (4)
  • CHANGELOG.md (1 hunks)
  • x/evm/precompile/funtoken.go (1 hunks)
  • x/evm/precompile/oracle.go (1 hunks)
  • x/evm/precompile/wasm.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
🧰 Additional context used
📓 Learnings (1)
x/evm/precompile/funtoken.go (1) 
Learnt from: k-yang
PR: NibiruChain/nibiru#2093
File: x/evm/precompile/funtoken.go:85-87
Timestamp: 2024-11-12T10:02:53.398Z
Learning: In the `Run` methods of precompiled contracts in `x/evm/precompile/`, after handling errors from `OnRunStart`, it's unnecessary to check if `err` is nil before consuming gas with `contract.UseGas()`, as `err` will always be nil at that point.
🔇 Additional comments (3)
x/evm/precompile/wasm.go (1)

73-77: LGTM! Gas consumption is now properly tracked.

The gas consumption is now recorded immediately after contract method execution, ensuring that gas is consumed before any potential errors are returned. The comment correctly explains why checking for success is unnecessary.

x/evm/precompile/funtoken.go (1)

87-88: LGTM! Gas consumption is now properly tracked.

The gas consumption is now recorded immediately after contract method execution, ensuring that gas is consumed before any potential errors are returned. This change aligns with previous feedback about gas consumption in precompile functions.

x/evm/precompile/oracle.go (1)

60-60: LGTM! Gas consumption is now properly tracked.

The gas consumption is now recorded immediately after contract method execution, ensuring that gas is consumed before any potential errors are returned. This change is consistent with the gas consumption tracking in other precompile functions.

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.

@codecov Codecov
Copy link

codecov bot commented Jan 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.19%. Comparing base (7aebf75) to head (e4c330e).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2152      +/-   ##
==========================================
- Coverage   65.20%   65.19%   -0.01%     
==========================================
  Files         277      277              
  Lines       22202    22203       +1     
==========================================
- Hits        14476    14475       -1     
- Misses       6736     6739       +3     
+ Partials      990      989       -1
Files with missing lines Coverage Δ
x/evm/precompile/funtoken.go 53.37% <100.00%> (ø)
x/evm/precompile/oracle.go 54.83% <100.00%> (ø)
x/evm/precompile/wasm.go 64.43% <100.00%> (+0.18%) ⬆️

... and 1 file with indirect coverage changes

@k-yang k-yang merged commit 3a8ff23 into main Jan 8, 2025
16 checks passed
@k-yang k-yang deleted the fix/precompile/consume-gas-on-error branch January 8, 2025 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@onikonychev onikonychev onikonychev approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@k-yang @onikonychev