fix(CodecV7): fix L1 message hash bug

[jonastheis]

Purpose or design rationale of this PR

When converting transactions to TransactionData we did not store the Sender of the L1Message in the From field of TransactionData.

This led to different L1 message queue hashes and therefore wrong computation of the L1 message queue rolling hash.

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

Breaking change label

Does this PR have the breaking-change label?

• No, this PR is not a breaking change
• Yes

Summary by CodeRabbit

• New Features

  • Enhanced transaction processing to include sender information and authorization details.
  • Improved the conversion of transaction messages to offer clearer error feedback and more consistent behavior.

• Tests

  • Added new tests to ensure that transaction data conversion maintains integrity and aligns with expected outcomes.

[coderabbitai]

Walkthrough

The changes update the transaction encoding mechanism in the encoding/da.go file and add a corresponding test in encoding/da_test.go. In da.go, the TxsToTxsData function now extracts and includes the sender in the transaction data, and the MessageQueueV2ApplyL1MessagesFromBlocks function is refactored to use a new helper function, l1MessageFromTxData. The helper centralizes the logic for building an L1MessageTx from transaction data. The test file introduces a new test function to verify the encoding and decoding process of an L1 message transaction.

Changes

File(s)	Change Summary
encoding/da.go	Enhanced TxsToTxsData by declaring a new sender variable and augmenting TransactionData with a From field and an AuthorizationList. Refactored MessageQueueV2ApplyL1MessagesFromBlocks to use the new helper function l1MessageFromTxData, and introduced the helper function to decode L1 messages.
encoding/da_test.go	Added test function TestTxsToTxsData_L1Message to validate encoding and decoding of an L1 message transaction. Modified import statements to include math/big and the require package from testify for assertions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TxsToTxsData
    participant MsgQueueV2
    participant l1MessageFromTxData
    participant L1MessageTx

    User->>TxsToTxsData: Submit L1MessageTx transaction
    TxsToTxsData-->>TxsToTxsData: Extract sender and initialize TransactionData (with From & AuthorizationList)
    TxsToTxsData->>MsgQueueV2: Pass TransactionData
    MsgQueueV2->>l1MessageFromTxData: Invoke helper function for decoding
    l1MessageFromTxData-->>MsgQueueV2: Return constructed L1MessageTx
    MsgQueueV2-->>User: Processed L1MessageTx

Loading

Poem

I hop through lines of crafted code,
New fields and functions in my humble abode.
A sender now shines within each tx byte,
And helper functions ease our flight.
In tests we trust, with assertions so bright,
A rabbit's joy in code takes flight!
🐰💻

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 012aaee and a8341d0.

📒 Files selected for processing (2)

• encoding/da.go (3 hunks)
• encoding/da_test.go (2 hunks)

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

• GitHub Check: tests

🔇 Additional comments (8)

encoding/da_test.go (3)

6-6: Import added for test requirements.

The addition of math/big is necessary for creating the test values in the new test function.

---

14-14: Added require package for stronger assertions.

Good addition of the require package which provides stronger assertion functions that fail the test immediately, which is appropriate for the new test.

---

228-247: Test case for L1Message transaction handling fix.

This comprehensive test validates the fix for the L1 message hash bug by ensuring that an L1MessageTx can be correctly converted to TransactionData and back, preserving the transaction hash. The test appropriately checks:

1. Creation of an L1MessageTx with proper sender information
2. Conversion to TransactionData
3. Decoding back to L1MessageTx
4. Verification that the hash remains consistent

This test is essential for preventing regression of the bug addressed in this PR.

encoding/da.go (5)

384-384: Added variable to track sender address.

This change introduces a variable to store the sender address, which is critical for fixing the L1 message hash bug. Without tracking the sender, the rolling hash calculation would be incorrect.

---

391-391: Fixed the core issue: capture sender information.

This is the key fix for the bug. Before this change, the sender information from L1MessageTx was not being stored, causing discrepancies in the L1 message queue hashes.

---

395-413: Updated TransactionData struct initialization.

The TransactionData struct initialization has been enhanced to:

1. Include the From field capturing the sender's address (line 403)
2. Add the AuthorizationList field (line 409)

These changes ensure that all necessary information is preserved when converting transactions to TransactionData.

---

803-806: Refactored to use a dedicated helper function.

Good refactoring to use the new l1MessageFromTxData helper function instead of inline decoding. This improves code organization and error handling with a more specific error message.

---

815-829: Added helper function to centralize L1 message decoding logic.

This new helper function centralizes the logic for building an L1MessageTx from transaction data. It properly extracts all fields, including the sender address from the From field, which is crucial for the fix. This function improves code maintainability and makes the error handling more robust.

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