Skip to content
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

feat: add overhead and l1feescalar proofs to trace #94

Merged
merged 1 commit into from
Apr 8, 2024

Conversation

jyc228
Copy link
Collaborator

@jyc228 jyc228 commented Apr 8, 2024

No description provided.

@jyc228 jyc228 requested a review from a team April 8, 2024 07:48
@jyc228 jyc228 self-assigned this Apr 8, 2024
Copy link

coderabbitai bot commented Apr 8, 2024

Walkthrough

The recent update introduces a method named MaybeAddL1BlockInfo to the StructLogger within the vm package, designed to selectively update storage based on the transaction's contract address. This addition plays a pivotal role in enhancing how L1 block information is processed by being invoked within the getTxResult function in api_blocktrace.go. This strategic enhancement is aimed at refining the interaction with L1 block data, marking a significant improvement in the system's operational efficiency.

Changes

Files Summary
core/vm/logger.go
eth/tracers/.../api_blocktrace.go
Introduced MaybeAddL1BlockInfo in StructLogger for conditional storage updates based on contract address. Now utilized in getTxResult to improve L1 block information processing.

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

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>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9cc463d and ebd7d5b.
Files selected for processing (2)
  • core/vm/logger.go (2 hunks)
  • eth/tracers/api_blocktrace.go (1 hunks)
Additional comments not posted (1)
eth/tracers/api_blocktrace.go (1)

265-265: Ensure MaybeAddL1BlockInfo properly handles errors and null checks.

Comment on lines +506 to +511
func (l *StructLogger) MaybeAddL1BlockInfo(tx *types.Transaction) {
if contractAddress := *tx.To(); bytes.Equal(contractAddress[:], types.L1BlockAddr[:]) {
l.storage[contractAddress][types.OverheadSlot] = l.env.StateDB.GetState(contractAddress, types.OverheadSlot)
l.storage[contractAddress][types.L1FeeScalarsSlot] = l.env.StateDB.GetState(contractAddress, types.L1FeeScalarsSlot)
}
}
Copy link

Choose a reason for hiding this comment

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

Consider adding a nil check for tx.To() to prevent potential panics.

if tx.To() != nil && bytes.Equal((*tx.To())[:], types.L1BlockAddr[:]) {

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
func (l *StructLogger) MaybeAddL1BlockInfo(tx *types.Transaction) {
if contractAddress := *tx.To(); bytes.Equal(contractAddress[:], types.L1BlockAddr[:]) {
l.storage[contractAddress][types.OverheadSlot] = l.env.StateDB.GetState(contractAddress, types.OverheadSlot)
l.storage[contractAddress][types.L1FeeScalarsSlot] = l.env.StateDB.GetState(contractAddress, types.L1FeeScalarsSlot)
}
}
func (l *StructLogger) MaybeAddL1BlockInfo(tx *types.Transaction) {
if tx.To() != nil && bytes.Equal((*tx.To())[:], types.L1BlockAddr[:]) {
l.storage[contractAddress][types.OverheadSlot] = l.env.StateDB.GetState(contractAddress, types.OverheadSlot)
l.storage[contractAddress][types.L1FeeScalarsSlot] = l.env.StateDB.GetState(contractAddress, types.L1FeeScalarsSlot)
}
}

Copy link
Contributor

@seolaoh seolaoh left a comment

Choose a reason for hiding this comment

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

LGTM

@jyc228 jyc228 merged commit f5b70a2 into dev Apr 8, 2024
4 checks passed
@jyc228 jyc228 deleted the feat/add-overhead-l1feescalar-to-trace branch April 8, 2024 08:34
chokobole added a commit that referenced this pull request Apr 23, 2024
0xHansLee pushed a commit that referenced this pull request May 7, 2024
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.

5 participants