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

Local state using remote registers #562

Open sideninja opened 1 week ago

sideninja commented 1 week ago

Closes: #574

Description

This PR adds state read and execution using remote registers API from the AN.


For contributor use:

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 6 hours ago

Walkthrough

The pull request introduces significant changes across multiple files, primarily focusing on restructuring the codebase to enhance the Ethereum Virtual Machine (EVM) integration with the Flow blockchain. Key modifications include updating client types, refining transaction execution logic, and implementing caching mechanisms for improved performance. Additionally, the .gitignore file has been updated, and various tests have been adjusted to align with the new functionalities and expectations.

Changes

Files Change Summary
.gitignore Removed entry for tests/web3js/package-lock.json and added metrics/data/ to ignore list.
api/api.go, bootstrap/bootstrap.go Updated client types from requester to evm, modifying struct fields and method signatures accordingly.
go.mod Updated dependency versions for github.com/onflow/flow-go and github.com/onflow/flow/protobuf/go/flow.
models/block.go, models/block_test.go Simplified block decoding logic and updated tests to reflect changes in decoding methods.
services/evm/*.go Refactored EVM client interface, introduced new structs and methods for transaction execution and state management.
tests/*.go, tests/web3js/*.js Adjusted test cases to align with new functionalities, updated expected values, and added new tests for coverage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EVMClient
    participant Ledger
    participant Emulator

    User->>EVMClient: Send Transaction
    EVMClient->>Ledger: Fetch State
    Ledger->>EVMClient: Return State
    EVMClient->>Emulator: Execute Transaction
    Emulator->>EVMClient: Return Execution Result
    EVMClient->>User: Return Transaction Receipt

Assessment against linked issues

Objective Addressed Explanation
Ensure scalability of remote register API during re-execution (574) βœ…
Validate re-executed state (574) ❌ The changes do not include specific validation logic.

Possibly related issues

Suggested labels

Testing

Suggested reviewers

πŸ‡ "In the code where changes bloom,
The EVM finds its room.
With clients new and tests refined,
A brighter path we now can find.
Hopping through each line with glee,
In Flow's embrace, we dance so free!" πŸ‡


πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Files that changed from the base of the PR and between a0e6820dac7911e1b0a886950d1f5eaaa0a89407 and 0ff788bb2b59676140809b5275c9a0be3893d566.
πŸ“’ Files selected for processing (3) * tests/e2e_web3js_test.go (2 hunks) * tests/helpers.go (4 hunks) * tests/web3js/cadence_arch_env_test.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3) * tests/e2e_web3js_test.go * tests/helpers.go * tests/web3js/cadence_arch_env_test.js
--- 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.