Skip to content

feat(feynman): include history storage in witness for blockhash opcode #1218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2025

Conversation

Thegaram
Copy link

@Thegaram Thegaram commented Jul 1, 2025

1. Purpose or design rationale of this PR

l2geth counterpart to scroll-tech/scroll-revm#54.

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:

  • feat: A new feature

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

    • Improved handling of historical block hash retrieval to ensure correct state access and support for provability requirements.
  • Chores

    • Updated protocol parameters for historical state access.
    • Incremented the patch version number to 64.

Copy link

coderabbitai bot commented Jul 1, 2025

Walkthrough

The changes introduce additional state read logic in the opBlockhashPostFeynman function to support witness generation, update the HistoryServeWindow from a constant to a variable with a new value, and increment the software patch version. No public API signatures are modified.

Changes

File(s) Change Summary
core/vm/instructions.go Added logic to read from history storage after block hash retrieval in opBlockhashPostFeynman.
params/protocol_params.go Changed HistoryServeWindow from a constant (8192) to a variable (8191).
params/version.go Incremented patch version from 63 to 64.

Sequence Diagram(s)

sequenceDiagram
    participant Interpreter
    participant StateDB
    participant HistoryStorageContract

    Interpreter->Interpreter: Retrieve block hash for block number
    Interpreter->Interpreter: Compute ring index (blockNum % HistoryServeWindow)
    Interpreter->Interpreter: Construct key with ring index
    Interpreter->StateDB: GetState(HistoryStorageContract, key)
    StateDB->Interpreter: Return state value
    Interpreter->Interpreter: Ensure slot is present in witness
Loading

Suggested labels

bump-version

Suggested reviewers

  • georgehao

Poem

In the warren of code, a patch hops in,
A window shrinks, a version spins.
The blockhash now with witness checks,
Ensures the state is free of wrecks.
With every nibble, byte, and bound,
The rabbit keeps our chain spellbound! 🐇✨


📜 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 3661d18 and 382ce19.

📒 Files selected for processing (3)
  • core/vm/instructions.go (1 hunks)
  • params/protocol_params.go (1 hunks)
  • params/version.go (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
core/vm/instructions.go (1)
Learnt from: Thegaram
PR: scroll-tech/go-ethereum#1193
File: core/state/statedb.go:170-174
Timestamp: 2025-06-11T12:09:04.380Z
Learning: `StateDB.Witness()` returns the live *stateless.Witness pointer because downstream code (`generateWitness`) needs to push data into it, and that path is executed sequentially, so concurrency safety is not a concern.
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: check
  • GitHub Check: test
  • GitHub Check: Analyze (go)
🔇 Additional comments (3)
params/protocol_params.go (1)

198-198: LGTM! Parameter update supports witness generation feature.

The conversion from constant to variable and the type change to uint64 are appropriate for the new witness generation logic. The value change from 8192 to 8191 creates a proper ring buffer index range (0-8190) when used in modulo operations.

params/version.go (1)

27-27: Appropriate version increment for feature addition.

The patch version bump correctly reflects the introduction of history storage witness generation for the blockhash opcode.

core/vm/instructions.go (1)

494-499: Well-implemented witness generation for provability.

The implementation correctly:

  • Calculates ring index using the updated HistoryServeWindow parameter
  • Encodes the ring index into the last 8 bytes of a 32-byte key
  • Performs a state read to ensure the corresponding storage slot is included in the execution witness

This aligns with the requirement to support provability when revm loads block hashes from the history storage system contract.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

Copy link
Member

@georgehao georgehao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Thegaram Thegaram merged commit 1043f66 into develop Jul 1, 2025
14 checks passed
@Thegaram Thegaram deleted the feat-include-history-storage-in-witness branch July 1, 2025 09:59
@colinlyguo colinlyguo changed the title feay(feynman): include history storage in witness for blockhash opcode feat(feynman): include history storage in witness for blockhash opcode Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants