`EffectiveGasPrice` is not properly set for all transaction types

m-Peter commented 1 month ago

Closes: https://github.com/onflow/flow-evm-gateway/issues/355

Description

There was a bug, with the EffectiveGasPrice field on receipts from dynamic fee transactions. We fix this, and add plenty of test cases, to make sure that we use the proper value for this field, and that we correctly drop transactions which do not meet the minimum gas price set by EVM Gateway operators. EffectiveGasPrice implementation from our fork of go-ethereum.

For contributor use:

[x] Targeted PR against master branch
[x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[x] Code follows the standards mentioned here.
[x] Updated relevant documentation
[x] Re-reviewed Files changed in the Github PR explorer
[x] Added appropriate labels

Summary by CodeRabbit

New Features
- Introduced a method for calculating effective gas prices in transactions, enhancing transaction handling with varying gas fees.
- Added a comprehensive test suite for evaluating transaction fee calculations across different Ethereum transaction types.
Bug Fixes
- Improved clarity in comments related to gas price assignments, aiding user understanding without altering functionality.
Tests
- Expanded end-to-end tests to cover transaction type fees, enhancing the overall test suite for Web3 functionality.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve enhancements to the transaction model and testing framework within the codebase. Key modifications include the introduction of an EffectiveGasPrice method to better calculate gas prices based on transaction types, updates to comments for clarity, and the addition of end-to-end tests for transaction fee evaluations across various Ethereum transaction types.

Changes

Files	Change Summary
api/models.go	Updated comments in `NewTransaction` for clarity regarding `GasPrice` assignment.
models/transaction.go	Introduced `EffectiveGasPrice` method in `Transaction` interface and its implementations in structs.
tests/e2e_web3js_test.go	Added a new sub-test in `TestWeb3_E2E` for evaluating transaction type fees.
tests/web3js/eth_transaction_type_fees_test.js	New test file for comprehensive testing of transaction fee calculations across different Ethereum transaction types.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant EVM Gateway
    participant TransactionProcessor
    participant Database

    Client->>EVM Gateway: Send transaction
    EVM Gateway->>TransactionProcessor: Process transaction
    TransactionProcessor->>TransactionProcessor: Calculate EffectiveGasPrice
    TransactionProcessor->>Database: Store transaction details
    Database->>EVM Gateway: Confirm transaction
    EVM Gateway->>Client: Return transaction receipt

Assessment against linked issues

Objective	Addressed	Explanation
Use the proper value for `EffectiveGasPrice` (#355)	✅

🐇 In the meadow, transactions play,
Gas prices dance in a whimsical way.
With methods new and tests so bright,
We hop along, all feels just right!
For every fee, we now have a guide,
In the code, our joys reside! 🌼✨

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ramtinms commented 1 month ago

Question? why not just using the EffectiveGasTipValue method on the geth.Transaction type, it automatically make internal calls based on the types.

m-Peter commented 1 month ago

Question? why not just using the EffectiveGasTipValue method on the geth.Transaction type, it automatically make internal calls based on the types.

@ramtinms Good idea :ok_hand: Updated in https://github.com/onflow/flow-evm-gateway/pull/479/commits/a355b9c4228c9c39e6344389c399b14fd27e2bb5

onflow / flow-evm-gateway