fix: correctly initialize latest l1msg gauge

[Thegaram]

1. Purpose or design rationale of this PR

Initialize latest relayed msg hash gauge to avoid it "jumping back to 0" when we redeploy a node.

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

• Refactor
  • Improved the handling and processing of transaction metrics within blocks to enhance overall efficiency.
• Chores
  • Updated the application’s patch version to reflect the latest release changes.

[coderabbitai]

Walkthrough

This pull request introduces a new function, updateHeadL1msgGauge, in the blockchain module to encapsulate the logic for processing block transactions and updating the headL1MessageGauge metric. The previous inline logic within writeBlockWithState is replaced by this function. Additionally, the patch version in the versioning file is incremented from 29 to 30.

Changes

File	Change Summary
core/blockchain.go	Added updateHeadL1msgGauge function to iterate through block transactions and update the gauge for L1 messages; replaced inline gauge update in writeBlockWithState.
params/version.go	Updated the VersionPatch constant from 29 to 30.

Sequence Diagram(s)

sequenceDiagram
    participant B as Blockchain
    participant T as Block Transactions
    participant G as headL1MessageGauge

    B->>T: Iterate transactions in block
    alt Transaction is L1 message
        T-->>G: Extract queue index and update gauge
        loop Process additional L1 transactions
            T->>G: Continue updating gauge
        end
    else Transaction is not L1 message
        T-->>B: Break iteration
    end

Loading

Possibly related PRs

• feat: include L1 message with insufficient balance #462: Addresses L1 message handling within the blockchain context by modifying how L1 transactions are processed.
• feat: track latest relayed l1 message #1150: Involves adjustments to the headL1MessageGauge metric logic in the blockchain module, similar to encapsulating gauge updates.

Suggested labels

bump-version

Suggested reviewers

• colinlyguo
• jonastheis

Poem

I'm a rabbit in the code field, hopping with glee,
Functions now neatly defined, as clear as can be!
L1 messages dance in a sequence so bright,
Gauge updates and version bumps make everything right.
Code hops along in a joyful, rhythmic spree!
🐇💻

---

📜 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 048db62 and 11fa450.

📒 Files selected for processing (2)

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

🧰 Additional context used

🧬 Code Definitions (1)

core/blockchain.go (3)

core/types/block.go (1) (1)

• Block (223-241)

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

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

core/blockchain_reader.go (11) (11)

• bc (36-38)
• bc (42-44)
• bc (48-50)
• bc (54-56)
• bc (60-62)
• bc (66-68)
• bc (72-74)
• bc (78-95)
• bc (99-115)
• bc (118-123)
• bc (126-134)

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

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

🔇 Additional comments (4)

params/version.go (1)

27-27: Version bump for patch release.

Correctly incremented version patch number from 29 to 30 to reflect the bug fix changes in this PR.

core/blockchain.go (3)

152-162: Good extraction of L1 message gauge update logic.

This new function nicely encapsulates the logic for processing block transactions and updating the headL1MessageGauge metric. The implementation correctly:

1. Iterates through transactions in the block
2. Identifies L1 message transactions
3. Updates the gauge with the queue index
4. Breaks early when no more L1 messages are found

This refactoring improves code maintainability and helps fix the original issue.

---

439-439: Critical fix: initialize gauge on blockchain creation.

This is the key change that addresses the PR's main objective. By calling updateHeadL1msgGauge(bc.CurrentBlock()) during blockchain initialization, the gauge will now retain its value when a node is redeployed, preventing it from resetting to zero.

---

1273-1273: Replaced inline code with the new encapsulated function.

Appropriately replaced the previous inline logic with a call to the new updateHeadL1msgGauge function, maintaining the same functionality while improving code organization.

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

[Thegaram]

Okay, I didn't think this through. Latest block likely won't have any l1 messages. Instead, we should initialize with the latest index from db.