Refactor receipt model

[sideninja]

Description

Refactor and improve receipt model and add factory from bytes.

This PR has a lot of changes because it renames StorageReceipt to just Receipt to be consistent with other model names. It also adds a method ReceiptsFromBytes so we have on place to handle decoding of receipts. It also moves marshal receipt into the API layer.

---

For contributor use:

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

Summary by CodeRabbit

• New Features

  • Introduced a new receipt type for improved flexibility in transaction handling.
  • Added a function to decode RLP-encoded receipts into structured formats.
  • Implemented a new method for converting receipts to a standardized structure.

• Bug Fixes

  • Enhanced error handling for receipt processing to ensure consistency.

• Refactor

  • Replaced all instances of StorageReceipt with a more generalized Receipt type across multiple components.
  • Improved clarity and maintainability by restructuring receipt-related logic.

• Tests

  • Updated test cases to reflect changes in receipt data types, enhancing type safety and reducing potential runtime errors.

[coderabbitai[bot]]

Walkthrough

The changes primarily involve a transition from using models.StorageReceipt to a more generalized models.Receipt across multiple files. This modification impacts function signatures, return types, and internal logic related to transaction and block receipt handling. Additionally, several new functions have been introduced, and some functions have been renamed to align with the updated data structure. The overall structure and logic flow remain consistent throughout the codebase.

Changes

Files	Change Summary
api/api.go, api/models.go, models/events.go, models/receipt.go, models/transaction.go, services/ingestion/engine.go, services/ingestion/engine_test.go, services/logs/filter_test.go, storage/index.go, storage/index_testsuite.go, storage/mocks/AccountIndexer.go, storage/mocks/ReceiptIndexer.go, storage/mocks/mocks.go, storage/pebble/accounts.go, storage/pebble/receipts.go	Transitioned from models.StorageReceipt to models.Receipt in function signatures and return types across various files, reflecting a unified approach to receipt handling. New functions added and some functions renamed for clarity.
storage/index_testsuite.go, storage/mocks/AccountIndexer.go, storage/mocks/ReceiptIndexer.go, storage/mocks/mocks.go, storage/pebble/accounts.go, storage/pebble/receipts.go	Updated test cases and mock implementations to use the new models.Receipt type, ensuring consistency in the tests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Storage
    participant Receipt

    Client->>API: Request Transaction Receipt
    API->>Storage: Fetch Receipts
    Storage->>Receipt: Process Receipt Data
    Receipt->>Storage: Return Processed Receipt
    Storage->>API: Return Receipts
    API->>Client: Send Response with Receipts

🐇 In the code where receipts dwell,
A change was made, oh what a spell!
From storage types, we leap and bound,
To general receipts, now we’re unbound.
With functions fresh and tests in tow,
Hopping along, we’re ready to go!
🐇

---

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.