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

fix: add ABI with removed functions from contract #1135

Merged
merged 3 commits into from
Mar 5, 2025

Conversation

jonastheis
Copy link

@jonastheis jonastheis commented Mar 5, 2025

1. Purpose or design rationale of this PR

This PR updates the ScrollChainABI to include also removed functions from the contracts as these are still needed to sync from genesis with L1 follower mode.

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:

  • fix: A bug fix

3. Deployment tag versioning

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

  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor

    • Adjusted logging verbosity during batch processing to provide more granular debug information.
  • New Features

    • Updated the blockchain contract interface with revised function inputs and new methods enhancing batch handling and finalization.
  • Tests

    • Introduced additional tests to ensure the correctness of the updated contract methods.
  • Chores

    • Incremented the patch version to reflect the latest release.

Copy link

coderabbitai bot commented Mar 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request implements several changes, including adjusting the logging level in the processAndDeleteBatch method from informational to debug. Additionally, it updates the ABI structure for the ScrollChain contract, modifying existing functions and introducing new ones. A new test function, TestMethodSignatures, is added to verify the method signatures of the updated ABI, ensuring that the changes are properly validated. Lastly, the version patch number is incremented from 21 to 22.

Changes

File(s) Summary
rollup/da_syncer/batch_queue.go Changed logging in processAndDeleteBatch from log.Info to log.Debug, altering the verbosity of log outputs during batch processing.
rollup/l1/abi.go, rollup/l1/abi_test.go Updated the ABI structure in ScrollChainMetaData (renaming and restructuring functions, such as commitAndFinalizeBatch and new functions) and added a new test (TestMethodSignatures) to verify method signatures.
params/version.go Updated VersionPatch constant from 21 to 22, reflecting a new state of the software versioning.

Possibly related PRs

Suggested reviewers

  • Thegaram
  • colinlyguo

Poem

I'm a little rabbit, skipping through the code,
Hopping on debug trails, lightening our heavy load.
The ABI now sings with functions fresh and new,
While tests ensure each signature is true.
With logs now whispered in a debug hue,
I celebrate these changes with a joyful "yoo-hoo!"
🐇🌟


📜 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 a53725b and b175df2.

📒 Files selected for processing (1)
  • params/version.go (1 hunks)

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

@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: 0

🧹 Nitpick comments (1)
rollup/l1/abi_test.go (1)

21-26: Add descriptive messages to your assert.Equal() calls and safeguard lookups.

Although the tests effectively verify the 4-byte method IDs, consider including descriptive assertion messages to identify which signature fails if there's a mismatch. Also, to prevent potential lookup panics, you could verify ScrollChainABI.Methods[<methodName>] exists before comparing the IDs.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c454e7 and a53725b.

📒 Files selected for processing (3)
  • rollup/da_syncer/batch_queue.go (1 hunks)
  • rollup/l1/abi.go (1 hunks)
  • rollup/l1/abi_test.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • rollup/da_syncer/batch_queue.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (1)
rollup/l1/abi.go (1)

27-27:

❓ Verification inconclusive

Validate ABI correctness and consider externalizing the ABI.

The updated ABI JSON appears comprehensive; however, ensure it exactly matches the contract code (including function overloads like revertBatch). As an enhancement, consider storing the ABI in a separate file or using abigen to generate bindings for improved maintainability.

Below is an optional script to check for multiple revertBatch definitions in the Solidity sources:


🏁 Script executed:

#!/bin/bash
# Searches for 'function revertBatch' definitions in Solidity files to confirm overload usage.
fd . --extension sol --exec rg -A 2 -B 2 'function revertBatch'

Length of output: 65


Action Required: Verify ABI Consistency and Consider Externalization
The ABI in rollup/l1/abi.go (line 27) appears comprehensive but ensure it exactly matches your Solidity contract implementations—particularly for functions like the overloaded revertBatch. Note that our automated search for revertBatch definitions did not return any results, so please manually verify this against your Solidity sources. As a maintainability improvement, consider externalizing the ABI (for example, storing it in a separate file or using abigen to generate bindings).

colinlyguo
colinlyguo previously approved these changes Mar 5, 2025
Thegaram
Thegaram previously approved these changes Mar 5, 2025
@github-actions github-actions bot dismissed stale reviews from Thegaram and colinlyguo via b175df2 March 5, 2025 10:26
@Thegaram Thegaram merged commit e62c6f0 into develop Mar 5, 2025
1 check was pending
@Thegaram Thegaram deleted the fix/scroll-chain-abi branch March 5, 2025 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants