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

Improve error handling on the local state #559

Closed sideninja closed 1 month ago

sideninja commented 1 month ago

This PR improves error handling on the local state and how we handle known errors.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve significant updates across multiple files in the codebase, focusing on improving naming conventions, enhancing error handling, and refining the blockchain API interactions. Key modifications include renaming network environments in the README, restructuring the BlockChainAPI for better clarity, introducing a ClientHandler for EVM operations, and adding new functionalities related to state management and validation. Additionally, the dependency management has been updated, and various tests have been adjusted to reflect these changes.

Changes

File(s) Change Summary
README.md Renamed network environments for Flow Testnet and Mainnet for clarity.
api/api.go Updated BlockChainAPI struct and methods for better clarity and error handling; renamed methods.
api/pull.go Replaced LatestEVMHeight with LatestIndexedHeight in multiple functions.
bootstrap/bootstrap.go Added State field to Bootstrap struct and associated methods for state management.
config/config.go Introduced ValidateRegisters boolean field for configuration and command-line flag.
go.mod Updated dependencies, including specific versions for flow-go and protobuf.
models/block.go Removed legacy block event decoding logic for simplification.
models/block_test.go Renamed test function to reflect changes in block event decoding.
models/errors/errors.go Added new error variable ErrStateMismatch for improved error handling.
models/transaction.go Reformatted decodeTransactionEvent for improved readability.
services/requester/client_handler.go Introduced ClientHandler struct for managing EVM operations with local and remote clients.
services/requester/evm.go Defined EVMClient interface for EVM interactions.
services/requester/local_client.go Implemented LocalClient struct for read-only queries on local state.
services/requester/remote_client.go Refactored Requester interface into RemoteClient struct, improving error handling and type safety.
storage/index.go Updated BlockIndexer interface with new methods for managing EVM heights.
storage/pebble/blocks.go Renamed methods for height management and added new functionalities.
tests/e2e_web3js_test.go Added new test case for cadence architecture and modified transaction gas limit.
tests/web3js/cadence_arch_env_test.js Introduced tests for cadence architecture functions and block environment interactions.

Suggested labels

Improvement, Technical Debt, EVM

Suggested reviewers

🐰 In the code where changes abound,
A clearer path has been found.
With names that shine and errors tamed,
The blockchain sings, no longer shamed.
Hops of joy for tests anew,
A brighter future, we pursue! 🌟

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.