feat: track latest relayed l1 message

[Thegaram]

1. Purpose or design rationale of this PR

Expose metric chain/head/l1msg, which tracks the latest seen L1 message queue index.

This is generally increasing (unless there is a reorg).

We can use it to track L1 message inclusion and detect if it is stuck for some reason.

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?

• Yes

4. Breaking change label

Does this PR have the breaking-change label?

• This PR is not a breaking change

Summary by CodeRabbit

• New Features

  • We've introduced enhanced monitoring that offers detailed insights into message processing within the blockchain system. This improvement enables users to observe operational performance and understand key processing trends.

• Chores

  • The patch version has been incremented to 27, reflecting the latest maintenance and quality improvements, which contribute to better system stability and overall performance.

[coderabbitai]

Walkthrough

This pull request introduces a new metric gauge in the blockchain module to track the latest relayed L1 message queue index. The gauge is initialized in the variable declarations and updated in the writeBlockWithState method by iterating over block transactions. Additionally, the patch version in the parameters is incremented from 26 to 27, signaling a new patch release.

Changes

File	Change Summary
core/blockchain.go	Adds a metric gauge headL1MessageGauge and updates it within the transaction loop in writeBlockWithState for L1 message transactions.
params/version.go	Increments the VersionPatch constant from 26 to 27, indicating a new patch release.

Sequence Diagram(s)

sequenceDiagram
    participant B as Blockchain
    participant T as Transaction Loop
    participant G as Gauge
    B->>T: Start processing block transactions
    loop For each transaction
        T-->>B: Check transaction type
        alt Transaction is L1MessageTx
            B->>G: Update headL1MessageGauge with queue index
        else Not L1MessageTx
            B->>T: Break loop
        end
    end

Loading

Possibly related PRs

• feat: include L1 message with insufficient balance #462: Modifies handling of L1 message transactions in state transition logic; relates closely with the gauge update for monitoring L1 messages.

Suggested labels

bump-version

Suggested reviewers

• omerfirmak
• jonastheis

Poem

I'm a bunny coder on the run,
With gauges hopping in the fun,
L1 messages now tracked with cheer,
Each patch a step, each line so clear,
Hoppin' through code with a joyful pun!

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 b393386 and d040dab.

📒 Files selected for processing (2)

• core/blockchain.go (2 hunks)
• params/version.go (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

core/blockchain.go (4)

core/blockchain_test.go (3) (3)

• tx (1317-1317)
• tx (1380-1380)
• tx (1425-1425)

core/types/transaction.go (7) (7)

• tx (104-116)
• tx (119-122)
• tx (127-134)
• tx (137-164)
• tx (168-186)
• tx (189-191)
• tx (194-215)

eth/tracers/api.go (3) (3)

• block (865-865)
• msg (544-544)
• msg (754-754)

eth/tracers/api_blocktrace.go (3) (3)

• block (35-35)
• block (61-61)
• block (90-90)

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

• GitHub Check: test
• GitHub Check: Analyze (go)

🔇 Additional comments (3)

params/version.go (1)

27-27: Version bump for the new feature.

The patch version is incrementing from 26 to 27, which aligns with the new L1 message tracking feature being added.

core/blockchain.go (2)

56-56: Added new metric gauge for tracking L1 messages.

The new headL1MessageGauge will track the latest relayed L1 message queue index, which will help monitor message inclusion and identify stalled messages.

---

1257-1266: Implementation to update the L1 message gauge.

The code iterates through block transactions, looking for L1 message transactions, and updates the gauge with the queue index from each message. The implementation breaks the loop when encountering the first non-L1 message transaction, which is correct assuming all L1 messages appear at the beginning of the transaction list.

The comment on line 1261 correctly notes that the queue index is guaranteed to fit into an int64, which is required for the gauge value.

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