search

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 index register validator #550

Closed sideninja closed 1 week ago

sideninja commented 1 week ago

Description

This PR adds a wrapper around the atree ledger that validates all set registers against the on-chain state. If a mismatch is found it logs it.

For contributor use:

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces significant updates across multiple files, primarily focusing on improving the clarity and functionality of the EVM Gateway's public RPC endpoints, refactoring the blockchain API structure, and enhancing state management. Key changes include renaming network environments in documentation, modifying API methods for better data accuracy, and adding new functionalities for state indexing and register validation. Additionally, the dependency versions have been updated, and several tests have been introduced or modified to ensure comprehensive coverage of the new features.

Changes

File Path Change Summary
README.md Renamed network environments from "EVM on Flow Testnet" to "Testnet" and "EVM on Flow" to "Mainnet".
api/api.go Refactored BlockChainAPI, changed evm field type, updated method calls, and added new helper methods.
api/pull.go Replaced calls to LatestEVMHeight() with LatestIndexedHeight() in PullAPI methods.
bootstrap/bootstrap.go Added state management functionality, including StartStateIndex and StopStateIndex methods.
config/config.go Introduced ValidateRegisters boolean field and command-line flag for register validation.
go.mod Updated dependencies for flow-go and flow/protobuf, removed indirect dependency on ginkgo.
models/block.go Removed legacy block event decoding logic from decodeBlockEvent.
models/block_test.go Renamed test function decodeLegacyBlockEvent to decodeBlockEvent.
models/receipt.go Added EqualReceipts function for comparing Geth and custom EVM GW receipts.
services/requester/client_handler.go Introduced ClientHandler for managing EVM operations with local and remote clients.
services/requester/evm.go Added EVMClient interface with methods for EVM interactions.
services/requester/local_client.go Defined LocalClient struct implementing EVMClient for read-only queries.
services/requester/register_validator.go Added RegisterValidator for managing and validating register values.
storage/index.go Modified BlockIndexer interface to include new methods for executed height management.
storage/pebble/blocks.go Renamed LatestEVMHeight to LatestIndexedHeight and added methods for executed height.
tests/e2e_web3js_test.go Added new test case for cadence architecture calls and modified gas limit for deployment.

Possibly related PRs

Suggested labels

Improvement, EVM

🐰 In the meadow where the bunnies play,
New changes hop in, brightening the day!
With clearer paths and structures refined,
The EVM dances, perfectly aligned.
So let us cheer for the code so spry,
With a twitch of our noses, we reach for the sky! 🌼

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.