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): Fix unit inconsistency related to AuthInfo.Fee and txData.Fee #2157

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

Unique-Divine
Copy link
Member

@Unique-Divine Unique-Divine commented Jan 10, 2025

Purpose / Abstract

fix(evm): Fix unit inconsistency related to AuthInfo.Fee and txData.Fee by using effective fee. Prior to this change, there were two areas where a wei amount was passed as an argument to a "Cosmos" fee where it expects units of unibi (micronibi).

Since txData.Fee does not take into account the fact that the network has a global and absolute minimum gas price of 1 unibi == 10^{12} wei, this is fixed by using txData.EffectiveFeeWei, as the latter function guarantees the minimum gas price without adding configuration on the part of end-users. This is similar to what we do to compute weiPerGas in EthereumTx:

	weiPerGas := txMsg.EffectiveGasPriceWeiPerGas(evmConfig.BaseFeeWei)

Summary by CodeRabbit

  • Bug Fixes

    • Resolved unit inconsistency in transaction fees for Nibiru EVM
    • Improved fee computation logic to ensure correct effective fee calculation
    • Enforced minimum gas price of 1 unibi in transaction processing
  • Documentation

    • Updated changelog to reflect recent EVM-related fixes
    • Enhanced code comments for fee calculation methods

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

This pull request addresses a unit inconsistency in transaction fee calculations within the Nibiru EVM. The changes modify how transaction fees are computed across multiple files, introducing an effective fee calculation that enforces a minimum gas price of 1 unibi. The modifications ensure more consistent and accurate fee handling in Ethereum-compatible transactions, focusing on aligning AuthInfo.Fee and txData.Fee to prevent potential discrepancies in fee processing.

Changes

File Change Summary
CHANGELOG.md Added entry for fee unit inconsistency fix
app/evmante/evmante_validate_basic.go Updated fee computation logic to use effectiveFeeMicronibi
x/evm/msg.go Modified BuildTx method to compute effective fee with minimum 1 unibi gas price

Sequence Diagram

sequenceDiagram
    participant TX as Ethereum Transaction
    participant Validator as EVM Ante Handler
    participant FeeCalc as Fee Calculator
    
    TX->>Validator: Submit Transaction
    Validator->>FeeCalc: Calculate Effective Fee
    FeeCalc-->>Validator: Compute Fee (Min 1 unibi)
    Validator->>TX: Validate and Process Transaction
Loading

Possibly related PRs

Suggested reviewers

  • k-yang

Poem

🐰 Hopping through code with glee,
Fees now dance in harmony!
One unibi, minimum and bright,
Transactions flow with pure delight
A rabbit's fix, precise and neat! 🚀


📜 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 da4c2c7 and 1e9ef8a.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • app/evmante/evmante_validate_basic.go (1 hunks)
  • x/evm/msg.go (2 hunks)
🔇 Additional comments (3)
x/evm/msg.go (1)

Line range hint 348-370: LGTM! Fee computation now correctly enforces minimum gas price.

The changes properly handle the unit conversion from wei to micronibi (unibi) using the effective fee calculation, which ensures the minimum gas price of 1 unibi is respected.

Let's verify that all fee calculations are consistent by checking other fee-related code:

✅ Verification successful

Fee calculations are consistent across the codebase

The fee handling implementation maintains consistency throughout:

  • Base fee is properly defined as 1 micronibi (unibi)
  • All fee calculations correctly use EffectiveFeeWei with proper unit conversion
  • The changes integrate well with both EVM and Cosmos-SDK fee mechanisms
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for fee-related calculations to ensure consistency
rg -A 3 "Fee|fee|EffectiveFee" 

Length of output: 71175

app/evmante/evmante_validate_basic.go (1)

125-130: LGTM! Consistent fee handling with msg.go changes.

The fee computation changes in the ante handler correctly mirror the approach used in BuildTx, ensuring consistent minimum gas price enforcement across the system.

CHANGELOG.md (1)

76-76: LGTM! Clear and descriptive changelog entry.

The changelog entry properly documents the fix for the fee unit inconsistency issue and its resolution using effective fee calculations.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

@Unique-Divine Unique-Divine changed the title fix(evm): Fix unit inconsistency related to AuthInfo.Fee and txData.Fee using effective fee fix(evm): Fix unit inconsistency related to AuthInfo.Fee and txData.Fee Jan 10, 2025
@Unique-Divine Unique-Divine marked this pull request as ready for review January 10, 2025 09:15
@Unique-Divine Unique-Divine requested a review from a team as a code owner January 10, 2025 09:15
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.20%. Comparing base (5533a2a) to head (1e9ef8a).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2157   +/-   ##
=======================================
  Coverage   65.19%   65.20%           
=======================================
  Files         277      277           
  Lines       22240    22242    +2     
=======================================
+ Hits        14500    14502    +2     
  Misses       6746     6746           
  Partials      994      994           
Files with missing lines Coverage Δ
app/evmante/evmante_validate_basic.go 86.23% <100.00%> (+0.12%) ⬆️
x/evm/msg.go 62.38% <100.00%> (+0.11%) ⬆️

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.

1 participant