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

feat: make fee deduction from gas charging free #50

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

beer-1
Copy link
Collaborator

@beer-1 beer-1 commented Aug 21, 2024

Description

We only charge gas at fee deduction only for the transaction which contains unknown fee denoms.

Closes: #XXXX


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers 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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced GasFreeFeeDecorator for improved transaction fee handling, allowing for gas-free transactions under certain conditions.
    • Added GetFeeDenom method to enhance fee denomination retrieval in the EVM context.
  • Bug Fixes

    • Removed the Simulate method from the MinitiaApp, streamlining transaction simulation and potentially improving gas management.
  • Chores

    • Removed the FeeDeductionGasAmount constant, simplifying constant declarations.
  • Tests

    • Added comprehensive test suites for GasFreeFeeDecorator and AnteHandler to ensure correct functionality and gas management during transactions.

@beer-1 beer-1 self-assigned this Aug 21, 2024
@beer-1 beer-1 requested a review from a team as a code owner August 21, 2024 06:27
Copy link

coderabbitai bot commented Aug 21, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes introduce a new fee management system in the Cosmos SDK application, transitioning to a gas-free fee structure with the implementation of the GasFreeFeeDecorator. This modification simplifies transaction fees, enhancing user experience by minimizing gas costs. Additionally, comprehensive tests have been added to ensure the reliability of the new functionality, alongside adjustments in the application structure that streamline transaction simulation and fee handling.

Changes

Files Change Summary
app/ante/ante.go, app/ante/ante_test.go, app/ante/fee.go, app/ante/fee_test.go Introduced GasFreeFeeDecorator, replacing the previous fee deduction mechanism, and added a test suite for validating its functionality in transaction handling.
app/app.go Removed the Simulate method from MinitiaApp, indicating a shift in transaction simulation handling.
app/const.go Removed the FeeDeductionGasAmount constant, simplifying gas management related to fee payments.
x/evm/keeper/params.go Added a new method GetFeeDenom in the Keeper struct to retrieve fee denomination parameters, enhancing the fee management capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant GasFreeFeeDecorator
    participant DeductFeeDecorator

    User->>App: Submit transaction with fee
    App->>GasFreeFeeDecorator: Process transaction
    GasFreeFeeDecorator->>DeductFeeDecorator: Check fee conditions
    DeductFeeDecorator-->>GasFreeFeeDecorator: Fee deduction logic
    GasFreeFeeDecorator-->>App: Return transaction result
    App-->>User: Transaction complete, no extra gas used
Loading

Poem

🐰 In a world where fees are free,
Transactions dance with glee,
No more gas to weigh us down,
Just playful hops around the town.
With changes bright, we celebrate,
A gas-free path, oh what a fate! 🎉


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

codecov bot commented Aug 21, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 26.46%. Comparing base (7dd9388) to head (35ad142).
Report is 1 commits behind head on main.

Files Patch % Lines
app/ante/fee.go 86.95% 2 Missing and 1 partial ⚠️
x/evm/keeper/params.go 50.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
+ Coverage   26.32%   26.46%   +0.13%     
==========================================
  Files         111      112       +1     
  Lines       11868    11893      +25     
==========================================
+ Hits         3124     3147      +23     
  Misses       8299     8299              
- Partials      445      447       +2     
Files Coverage Δ
app/ante/ante.go 56.86% <100.00%> (ø)
app/app.go 55.05% <ø> (+0.64%) ⬆️
app/ante/fee.go 86.95% <86.95%> (ø)
x/evm/keeper/params.go 43.75% <50.00%> (+3.75%) ⬆️

Copy link

@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: 3

Outside diff range, codebase verification and nitpick comments (1)
app/app.go (1)

Line range hint 282-284: Fix invalid reference to app.Simulate.

The Simulate method has been removed from the MinitiaApp struct, but RegisterTxService still references it. This will cause a compilation error.

Consider updating the RegisterTxService method to remove or replace the reference to app.Simulate.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7dd9388 and 52581df.

Files selected for processing (7)
  • app/ante/ante.go (1 hunks)
  • app/ante/ante_test.go (1 hunks)
  • app/ante/fee.go (1 hunks)
  • app/ante/fee_test.go (1 hunks)
  • app/app.go (1 hunks)
  • app/const.go (1 hunks)
  • x/evm/keeper/params.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/const.go
Additional context used
GitHub Check: codecov/patch
x/evm/keeper/params.go

[warning] 19-23: x/evm/keeper/params.go#L19-L23
Added lines #L19 - L23 were not covered by tests


[warning] 25-25: x/evm/keeper/params.go#L25
Added line #L25 was not covered by tests

app/ante/fee.go

[warning] 42-43: app/ante/fee.go#L42-L43
Added lines #L42 - L43 were not covered by tests


[warning] 49-53: app/ante/fee.go#L49-L53
Added lines #L49 - L53 were not covered by tests

Additional comments not posted (5)
x/evm/keeper/params.go (1)

19-25: LGTM!

The GetFeeDenom method correctly retrieves the fee denomination and handles errors.

Tools
GitHub Check: codecov/patch

[warning] 19-23: x/evm/keeper/params.go#L19-L23
Added lines #L19 - L23 were not covered by tests


[warning] 25-25: x/evm/keeper/params.go#L25
Added line #L25 was not covered by tests

app/ante/fee.go (1)

18-63: LGTM!

The GasFreeFeeDecorator is implemented correctly, modifying gas meter behavior based on transaction fees.

Tools
GitHub Check: codecov/patch

[warning] 42-43: app/ante/fee.go#L42-L43
Added lines #L42 - L43 were not covered by tests


[warning] 49-53: app/ante/fee.go#L49-L53
Added lines #L49 - L53 were not covered by tests

app/ante/fee_test.go (1)

1-63: LGTM!

The tests for GasFreeFeeDecorator cover various scenarios effectively, ensuring correct behavior.

app/ante/ante.go (1)

91-91: LGTM!

The integration of NewGasFreeFeeDecorator into NewAnteHandler is correctly implemented.

app/ante/ante_test.go (1)

1-136: LGTM!

The test suite setup for ante handler tests is comprehensive and well-structured.

x/evm/keeper/params.go Show resolved Hide resolved
app/ante/fee.go Show resolved Hide resolved
app/ante/fee.go Show resolved Hide resolved
@beer-1 beer-1 changed the title feat: make fee deduction from gas charging feat: make fee deduction from gas charging free Aug 21, 2024
Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

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

LGTM

@Vritra4 Vritra4 merged commit 88ad9b7 into main Aug 21, 2024
8 checks passed
@Vritra4 Vritra4 deleted the feat/free-gas-for-fee-deduction branch August 21, 2024 08:06
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