Safeguard EVM event identifier comparisons

m-Peter commented 2 months ago

Closes: https://github.com/onflow/flow-evm-gateway/issues/356

Description

This change performs a strict comparison on the type IDs from the emitted events, to make sure that we're only accepting events emitted from the AddressLocation of the EVM contract, on each network.

For contributor use:

[x] Targeted PR against master branch
[x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[x] Code follows the standards mentioned here.
[x] Updated relevant documentation
[x] Re-reviewed Files changed in the Github PR explorer
[x] Added appropriate labels

Summary by CodeRabbit

New Features
- Enhanced event identification by incorporating EVM event IDs, improving accuracy in event processing.
Refactor
- Updated functions and methods to accept and utilize EVM event identifiers, streamlining event type comparisons.
Bug Fixes
- Fixed various issues related to event ID mismanagement and improved the reliability of block and transaction event handling.
Tests
- Updated test cases to integrate the new EVM event ID parameters, ensuring thorough validation of changes.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce stricter checks for EVM-related event ingestion by comparing event type IDs directly to predefined identifiers based on the chain ID. This avoids false positives from fake contracts. New structures and modified functions now pass and utilize these identifiers, ensuring precise event validation.

Changes

Files	Change Summary
`models/events.go`	Imported necessary packages, added event identifier structs, and modified functions to use these IDs
`models/events_test.go`	Updated tests to include the new event identifiers
`services/ingestion/engine_test.go`	Refactored function calls to include new parameters
`services/ingestion/subscriber.go`	Replaced chain field with evmEventIDs and adjusted methods accordingly

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RPCSubscriber
    participant CadenceEvents
    participant EVMEventIdentifiers

    Client->>RPCSubscriber: NewRPCSubscriber()
    RPCSubscriber->>EVMEventIdentifiers: NewEVMEventIdentifiers(chainID)
    EVMEventIdentifiers-->>RPCSubscriber: Identifiers
    Client->>RPCSubscriber: subscribe()
    RPCSubscriber->>CadenceEvents: NewCadenceEvents(events, evmEventIDs)
    CadenceEvents-->>RPCSubscriber: CadenceEvents
    RPCSubscriber->>RPCSubscriber: blocksFilter() using evmEventIDs
    RPCSubscriber-->>Client: Filtered BlockEvents

Assessment against linked issues

Objective (Issues)	Addressed	Explanation
Safeguard the logic for ingesting EVM-related events (#356)	✅

Poem

In the code where events do play, EVM checks now have their way. With stricter IDs, they stand tall, No fake events shall slip or call. Logic firm, our code refined, In Flow's domain, true events we'll find.

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 .` - `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 show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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 months ago

Since the event subscription already filters only the events we are interested in we don't have to check again if events are coming from the correct address.

onflow / flow-evm-gateway