Fix: Refactor Receipt Validation to ReceiptsProvider

[axelKingsley]

What

Moves validateReceipts to ReceiptProvider implementations, and changes the interface to support the required BlockInfo.

Why

In certain scenarios, the caching Receipt Fetcher was saving results which were not validated. Previously, validation happened only at the EthClient, but this left other access methods open to getting cached data which hadn't been validated.

How

The EthClient no longer does validateReceipts. Instead, it passes a BlockInfo down to the ReceiptProvider, and expects that implementor to satisfy validation.

There are multiple Implementations of ReceiptProvider:

• RPCReceiptsFetcher routes the call down to an inner fetcher, or to some other RPC call entirely
• CachingReceiptsProvider routes the call down to an inner fetcher
• mockReceiptsProvider is a mock
• BasicRPCReceiptsFetcher does actual Receipt Fetching!

By adding validation to the RPCReceiptsFetcher, all calls to FetchReceipts yield exactly one round of validation.

If ever a Receipts Provider is used outside of this callchain, it will need to support validation. We can extend the FetchReceipts function to support shouldValidate bool, to allow bespoke validation, but default to assuming another layer will handle it. This was not implemented in this PR as there is currently not a need to do this.

Tests

Modified unit tests which required the new method signature, and ran just those tests locally.

[coderabbitai]

Walkthrough

Walkthrough

The overall change involves enhancing the FetchReceipts method across various files by introducing a new parameter blockInfo of type eth.BlockInfo. This parameter facilitates the passing of block information for receipt fetching and validation. The update impacts method signatures and implementations in components like EthClient, ReceiptsProvider, and specific receipts fetcher implementations. Furthermore, the validation process for receipts has been integrated into the fetching mechanism.

Changes

Files	Change Summary
.../eth_client.go, .../receipts.go, .../receipts_basic.go, .../receipts_caching.go	Added blockInfo eth.BlockInfo parameter to FetchReceipts. Removed receipt validation in eth_client.go.
.../receipts_basic_test.go, .../receipts_caching_test.go	Updated FetchReceipts function calls in test functions to include bInfo parameter.
.../receipts_rpc.go	Modified FetchReceipts in RPCReceiptsFetcher to accept blockInfo instead of block and added receipt validation logic.

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
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[trianglesphere]

tests also failing

Issues are fixed