State index ledger database

[sideninja]

Closes: #449

Description

This is adding a ledger database implementation for creating a local state. This is the first version and it might be changing.

---

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

  • Added a new field PrecompiledCalls to enhance transaction receipt data.
  • Introduced constants for improved ledger management.
  • Launched a new Ledger implementation for better key-value operations.

• Improvements

  • Simplified function interfaces by removing unnecessary parameters, enhancing maintainability.
  • Enhanced transaction and block ingestion tests for better clarity and error handling.

• Bug Fixes

  • Improved safety checks for receipt storage to prevent block height mismatches.

• Tests

  • Updated test suite to reflect changes in method signatures and added scenarios for error conditions.

[coderabbitai[bot]]

Walkthrough

This update enhances the codebase by incorporating precompiled call data into receipt storage, simplifying function signatures through the removal of unnecessary parameters, and improving transaction ingestion tests. These modifications increase clarity, ensure robust error handling, and facilitate easier maintenance and future development.

Changes

Files	Change Summary
models/receipt.go, models/transaction.go	Added PrecompiledCalls field to StorageReceipt and updated related constructors for enhanced transaction data.
services/ingestion/engine.go, services/ingestion/engine_test.go	Removed block parameter from indexReceipts, simplifying its signature and updated tests to validate against heights.
storage/index.go, storage/mocks/ReceiptIndexer.go	Removed height parameter from Store method in ReceiptIndexer, simplifying method calls.
storage/index_testsuite.go	Updated test functions to eliminate block height requirement and added validation for storing receipts.
storage/pebble/keys.go	Introduced new constants ledgerValue and ledgerSlabIndex for ledger management.
storage/pebble/ledger.go	Added Ledger type for managing key-value pairs, ensuring thread safety with a mutex.
storage/pebble/receipts.go	Modified Store method to remove evmHeight, improving logic for block height validation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Engine
    participant ReceiptIndexer
    participant Storage

    Client->>Engine: Process Events
    Engine->>ReceiptIndexer: Index Receipts
    ReceiptIndexer->>Storage: Store Receipts
    Storage-->>ReceiptIndexer: Acknowledge Storage
    ReceiptIndexer-->>Engine: Acknowledge Indexing
    Engine-->>Client: Return Result

Poem

In the meadow where changes bloom,
Our code hops high, dispelling gloom.
With simplified paths and clearer skies,
We store our treasures, watch them rise.
A precompiled call, a leap so grand,
Together we code, hand in hand! 🐇✨

---

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.