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 9 forks source link

Integrate local state index #541

Closed sideninja closed 2 weeks ago

sideninja commented 2 weeks ago

Description

Integrate local state index complying to the EVM client interface. A client handler was added which is a way to execute both remote and local client and compare results. We only use the local state result if the remote client fails. We also can then change this handler to be smarter in ways it chooses which client to use (for example as long as the state index is healthy use local otherwise use remote). Please note there are a lot of changes that are results of renaming types.


For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces significant changes across multiple files, primarily focusing on the integration of Ethereum Virtual Machine (EVM) functionalities. Key modifications include the introduction of new structs and interfaces for handling EVM operations, the refactoring of existing structures to enhance clarity and maintainability, and the addition of comprehensive testing for state execution and transaction handling. The changes also involve renaming and restructuring fields and methods to improve accessibility and consistency throughout the codebase.

Changes

Files Change Summary
api/api.go, bootstrap/bootstrap.go Modified BlockChainAPI to use requester.EVMClient. Updated Bootstrap struct with new fields for EVM and state management, and renamed several fields to public.
models/receipt.go, models/transaction.go Added EqualReceipts function for receipt comparison. Reformatted NewReceipt function call for readability.
services/requester/client_handler.go, services/requester/evm.go, services/requester/local_client.go, services/requester/remote_client.go Introduced ClientHandler for EVM operations, defined EVMClient interface, and created LocalClient for read-only access. Refactored RemoteClient to consolidate methods.
services/state/engine.go, services/state/state.go Implemented Engine for blockchain state management and BlockState for transaction execution within the EVM context.
storage/pebble/register.go, storage/pebble/register_test.go Added Register struct for managing ledger values and introduced tests for SetValue and GetValue methods.
tests/helpers.go, tests/state_integration_test.go Modified test helpers for emulator configuration and added integration tests for state execution of transfers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ClientHandler
    participant EVMClient
    participant LocalClient
    participant RemoteClient
    participant Engine
    participant BlockState

    User->>ClientHandler: Send transaction
    ClientHandler->>LocalClient: Execute transaction
    alt LocalClient fails
        ClientHandler->>RemoteClient: Execute transaction
    end
    ClientHandler->>Engine: Notify transaction
    Engine->>BlockState: Execute transaction
    BlockState-->>Engine: Return result
    Engine-->>ClientHandler: Return transaction status
    ClientHandler-->>User: Return transaction confirmation

πŸ‡ In the code, a change we see,
EVM's magic, oh so free!
With structs and tests, we hop along,
Validating states, where we belong.
A blockchain dance, in code we play,
Hopping through transactions, hip-hip-hooray! πŸ‡βœ¨


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 generate interesting stats about this repository and render them as a table.` -- `@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.
sideninja commented 2 weeks ago

mreged into feature/state