Local state index engine

[sideninja]

Description

Implementation of state engine and state index.

There are two components:

• engine is a process that currently listens to new block events (this should be changed in the future to have it's own database source, because it will be more reliable) and upon receiving a new block it executes all the transactions using the state index. Upon receiving a receipt, we make sure the receipt matches expected already indexed receipt.
• state index handles creation of an emulator instance and executes the transaction. It then produces the receipt.

---

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 state management engine for processing blockchain transactions.
  • Added new fields for request handling and state indexing in the Bootstrap struct.
  • Enhanced the emulator's configuration with a new option to skip transaction validation.
  • Launched a new method for state indexing management.

• Bug Fixes

  • Corrected the allocation logic in the ledger's slab index management.

• Tests

  • Implemented a comprehensive integration test for state execution of transfers in the Flow EVM Gateway.

[coderabbitai[bot]]

Walkthrough

The pull request introduces significant enhancements to the state management and transaction processing capabilities of the Flow EVM Gateway. Key modifications include the addition of new fields and methods for state indexing in the Bootstrap struct, a new state management engine, and improved configurations in the emulator. These changes enhance the handling of transactions and state inspections, enabling better integration with JSON RPC APIs and bolstering the overall functionality of the system.

Changes

Files	Change Summary
bootstrap/bootstrap.go	Added fields Requester, State, and Ledger to Bootstrap struct; changed visibility of several fields to public; updated methods to utilize new fields; introduced StartStateIndex and StopStateIndex methods.
models/transaction.go	Modified formatting of NewReceipt function call for improved readability.
tests/helpers.go	Enhanced startEmulator function with SkipTransactionValidation field; improved readability of evmSign function.
services/state/state.go	Introduced State struct with methods for transaction execution and state management, including NewState and Execute.

Possibly related issues

• onflow/flow-evm-gateway#322: The changes in this PR address the need for better state management and inspection capabilities, which are critical for implementing JSON RPC APIs as outlined in the issue.

Possibly related PRs

• #362: The changes in the bootstrap/bootstrap.go file involve modifications to the Bootstrap struct, specifically the addition of new fields and changes to existing field visibility, which enhances functionality related to state management.
• #374: This PR modifies the bootstrap/bootstrap.go file, specifically the startIngestion and startServer functions, which are related to the overall management of transactions and state, aligning with the changes made in the main PR.
• #542: The changes in the bootstrap/bootstrap.go file regarding the client setup and its parameters are relevant as they enhance the functionality of the Bootstrap struct, which is a central focus of the main PR.

Poem

🐇 In the meadow where code does play,
New fields and methods brighten the day.
With state and ledger, we leap and bound,
In the world of EVM, joy is found!
So hop along, let’s dance and cheer,
For changes that bring us all good cheer! 🎉

---

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 4eb1229faf1dc7fbb7e239bb74663863bca54eeb and 169c24509123d1e0c0e719c636e4abf254ae2624.

Files selected for processing (3)

* bootstrap/bootstrap.go (13 hunks) * models/transaction.go (1 hunks) * tests/helpers.go (2 hunks)

Files skipped from review as they are similar to previous changes (3)

* bootstrap/bootstrap.go * models/transaction.go * tests/helpers.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 , 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 generate interesting stats about this repository and render them as a table.` -- `@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.