fix: avoid using snapshots when generating witness

[omerfirmak]

1. Purpose or design rationale of this PR

StateDB might serve the data from snapshots and not read the trie for some state read request. Our witness collection relies on reads hitting the trie.

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

• build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
• ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
• docs: Documentation-only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests

3. Deployment tag versioning

Has the version in params/version.go been updated?

• This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
• Yes

4. Breaking change label

Does this PR have the breaking-change label?

• This PR is not a breaking change
• Yes

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error reporting during witness data generation to clearly communicate issues when they occur.
• Chores
  • Updated the application’s patch version to 6, ensuring version information reflects the latest iteration.

[coderabbitai]

Walkthrough

The changes improve error handling and state retrieval in the witness generation process within the ExecutionWitness function. The function now checks for errors after witness generation and returns a formatted error message if any occur. Additionally, the method for obtaining the state database has been modified to instantiate a new state database using state.New instead of relying on snapshots. The patch version in the parameters package has also been incremented from 5 to 6.

Changes

File(s)	Change Summary
eth/api.go	Enhanced error handling in the ExecutionWitness function by checking errors after calling generateWitness. Updated state DB retrieval from snapshot-based access to using state.New for witness generation.
params/version.go	Updated versioning constant VersionPatch from 5 to 6, affecting the version string outputs.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant API as PublicDebugAPI
    participant G as generateWitness
    participant S as State DB
    C->>API: ExecutionWitness(ctx, blockNrOrHash)
    API->>G: Call generateWitness(parentHeader)
    G->>S: Create state DB with state.New(root, StateCache, nil)
    S-->>G: Return state DB instance
    alt Error in witness generation
        G-->>API: Return error
        API-->>C: Return formatted error message
    else Successful witness generation
        G-->>API: Return witness data
        API-->>C: Return ExecutionWitness result from ToExecutionWitness(witness)
    end

Loading

Poem

I'm a little rabbit, hopping along,
Spotting new errors where things went wrong.
Now the witness is clear, with each bug in sight,
State DB is fresh, shining bright.
Version bumped up, like fresh carrots in the light!
🐰✨
Hurray for changes done just right!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b56dd9f and 4235cd4.

📒 Files selected for processing (2)

• eth/api.go (2 hunks)
• params/version.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (3)

params/version.go (1)

27-27: LGTM! Version increment is appropriate.

The patch version increment from 5 to 6 aligns with semantic versioning principles for a bug fix.

eth/api.go (2)

337-341: LGTM! Improved error handling.

The changes enhance error reporting by explicitly checking for errors after witness generation and providing a formatted error message.

---

351-352: LGTM! State retrieval now avoids snapshots.

The changes ensure that witness data is collected properly by reading directly from the trie instead of potentially using snapshots. The comment clearly explains the rationale.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this PR. (Beta)
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.