onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 10 forks source link

Improve client result compare #561

Closed sideninja closed 1 month ago

sideninja commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes encompass a broad range of updates across multiple files, primarily focusing on improving naming conventions, enhancing the functionality of the EVM Gateway, and refining the API interactions. Key modifications include renaming network environments, restructuring the BlockChainAPI and Bootstrap components, introducing new methods for state management, and enhancing error handling. Additionally, various test files have been updated to reflect these changes, ensuring that the codebase remains robust and maintainable.

Changes

File Change Summary
README.md Updated network naming conventions for Flow Testnet and Flow Mainnet to simplify and clarify.
api/api.go Refactored BlockChainAPI struct, replacing requester.Requester with requester.EVMClient, modifying method signatures, and enhancing error handling.
api/pull.go Changed method calls from LatestEVMHeight() to LatestIndexedHeight() in PullAPI struct methods.
bootstrap/bootstrap.go Enhanced Bootstrap struct by adding fields for EVMClient and State, and introduced new methods for state indexing.
config/config.go Added a new boolean field ValidateRegisters to control validation of register sets against on-chain data, along with a command-line flag.
go.mod Updated dependencies, including a specific version of flow-go and removal of indirect dependency on ginkgo.
models/block.go Removed legacy block event decoding logic, streamlining the event handling process.
models/block_test.go Renamed test function for clarity, reflecting changes to block event decoding.
models/errors/errors.go Introduced a new error variable ErrStateMismatch to improve error handling.
models/transaction.go Reformatted code for readability without changing functionality.
services/requester/client_handler.go Introduced ClientHandler for EVM operations, allowing local and remote client interactions with robust error handling.
services/requester/evm.go Defined EVMClient interface for EVM interactions, outlining core functionalities.
services/requester/local_client.go Introduced LocalClient for read-only interactions with local blockchain state.
services/requester/remote_client.go Refactored to implement RemoteClient, integrating error handling and method signature updates.
services/state/engine.go Defined Engine struct for processing blockchain transactions, including lifecycle management methods.
services/state/state.go Introduced BlockState struct for transaction execution management, including methods for executing and calling transactions.
services/state/validator.go Added RegisterValidator for managing and validating register values during block execution.
storage/index.go Removed LatestEVMHeight and introduced methods for managing executed and indexed heights.
storage/pebble/blocks.go Renamed methods for height management and added new methods for setting and retrieving executed heights.
storage/pebble/register.go Introduced Register struct for managing ledger values with methods for value retrieval and storage.
tests/e2e_web3js_test.go Added a new test case for cadence architecture calls and increased gas limit for contract deployment.
tests/web3js/cadence_arch_env_test.js Implemented tests for cadence architecture and block environment functions, validating on-chain data consistency.

Possibly related PRs

Suggested labels

Improvement, Testing, EVM

🐰 "In the meadow where the code does play,
Improvements hop and dance all day.
With clearer names and tests so bright,
Our EVM shines with pure delight!
So let us cheer for changes made,
In this code garden, joy won't fade!" 🌼


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 , 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 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](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.