feat(L1 follower): add commitAndFinalizeBatch method

[jonastheis]

1. Purpose or design rationale of this PR

This PR adds commitAndFinalizeBatch to L1Reader to support enforced batches in L1 follower and rollup verifier. Without it batches committed with this function can't be processed.

Without this fix rollup verifier and L1 follower will report:

ERROR[03-11|14:02:24.083] failed to fetch rollup events            err="failed to get next data: temporary: failed to process rollup events to DA, error: failed to get and append commit batch DA: failed to get commit batch da: 10, err: failed to fetch commit tx data of batch 10, tx hash: 0x1c6578b2ee3970ac80d8c26059bb7a65edf187f6c3269c7da7fc417c71af2d83, err: unknown method name for commit transaction: commitAndFinalizeBatch"

With this fix the error is gone and the batch can be interpreted like any other regular batch.

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

• New Features

  • Expanded contract query capabilities with new methods to retrieve batch information and finalized state status.

• Refactor

  • Renamed a function for improved clarity when fetching the latest finalized batch.

• Tests

  • Extended test coverage to validate the new interface changes.

• Chores

  • Updated the patch version to reflect the latest release.

[coderabbitai]

Walkthrough

This pull request updates the ABI definitions and related tests for batch processing. It adds two new ABI functions (committedBatches and finalizedStateRoots), modifies the withdrawRoots function to include a batch index, and expands test coverage with a new assertion for the commitAndFinalizeBatch signature. Additionally, a reader function is renamed for clarity, and the version patch constant is incremented from 23 to 24.

Changes

File(s)	Change Summary
rollup/l1/abi.go, rollup/l1/abi_test.go, rollup/l1/reader.go	- ABI Updates: Added new functions committedBatches(batchIndex uint256) returns (bytes32) and finalizedStateRoots(batchIndex uint256) returns (bool). - Function Modification: Updated withdrawRoots to include batchIndex. - Test Addition: Added assertion for commitAndFinalizeBatch. - Renaming: Renamed LatestFinalizedBatch to LatestFinalizedBatchIndex in the Reader.
params/version.go	Updated VersionPatch constant from 23 to 24.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant SCM as ScrollChainMetaData
    Client->>SCM: committedBatches(batchIndex)
    SCM-->>Client: bytes32 (batch data)
    Client->>SCM: finalizedStateRoots(batchIndex)
    SCM-->>Client: bool (finalized state)
    Client->>SCM: withdrawRoots(batchIndex)
    SCM-->>Client: bytes32 (withdrawn roots)

Loading

sequenceDiagram
    participant Client as Client
    participant Reader as Reader
    participant Contract as Contract
    Client->>Reader: LatestFinalizedBatchIndex(blockNumber)
    Reader->>Contract: Query for latest finalized batch index
    Contract-->>Reader: uint64 (latest index)
    Reader-->>Client: uint64 (latest index)

Loading

Possibly related PRs

• feat(L1 follower and rollup verifier): support CodecV7 in L1 follower mode and rollup verifier #1105: Addresses modifications in the ScrollChainMetaData ABI related to batch metadata retrieval.
• feat(L1 follower): adjust to recent CodecV7 and contract changes #1120: Involves related ABI updates and introduces a new batch handling function in the l1.Reader.

Suggested reviewers

• Thegaram
• colinlyguo
• omerfirmak

Poem

I’m a code bunny with hops so spry,
New ABI functions make my circuits fly.
Batches and roots all lined up in cheer,
Tests and renames make the pathway clear.
Leaping through commits with a joyful sigh,
CodeRabbit celebrates—oh my, oh my! 🐇

---

📜 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 61cfff3 and 98bc6d5.

📒 Files selected for processing (6)

• rollup/l1/abi.go (2 hunks)
• rollup/l1/abi_test.go (1 hunks)
• rollup/l1/reader.go (2 hunks)
• params/version.go (1 hunks)
• rollup/l1/abi.go (1 hunks)
• rollup/l1/reader.go (1 hunks)

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

• GitHub Check: test

🔇 Additional comments (6)

params/version.go (1)

27-27: Version patch increment looks good

The patch version has been incremented from 23 to 24, which is appropriate for adding new functionality without breaking changes.

rollup/l1/abi_test.go (1)

25-25: Test coverage added for new method signature

Good addition of test coverage for the new commitAndFinalizeBatch method signature, ensuring the ABI definition is correctly registered.

rollup/l1/reader.go (2)

102-102: Improved method naming for clarity

Renaming from LatestFinalizedBatch to LatestFinalizedBatchIndex better reflects the actual return value (an index, not a batch object), making the API more intuitive.

---

403-432: Well-implemented support for commitAndFinalizeBatch method

The implementation correctly handles the new method by extracting the batch information from the finalize struct and constructing the appropriate CommitBatchArgs. The code properly handles codec version, error cases, and maintains consistency with the overall architecture.

rollup/l1/abi.go (2)

48-48: New method constant added

Appropriate addition of constant for the new commitAndFinalizeBatch method.

---

367-381: Well-structured implementation for commitAndFinalizeBatch functionality

The new type and constructor function follow the established patterns in the codebase. The implementation is clean and properly handles error cases.

✨ 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

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