feat(protocol): add GuardianApproval event to GuardianProver

[adaki2004]

Summary by CodeRabbit

• New Features
  • The system now emits a GuardianApproval event when a guardian approves a block, including details such as the guardian's address, block ID, block hash, and approval status.

[coderabbitai]

Walkthrough

The update introduces a new event, GuardianApproval, in the GuardianProver contract. This event is triggered whenever a guardian approves a block, capturing essential information such as the guardian's address, block ID, block hash, and the approval status. This enhancement aims to improve transparency and traceability of guardian approvals within the system.

Changes

File	Summary
.../L1/provers/GuardianProver.sol	Added GuardianApproval event to emit upon guardian's block approval, including address, block ID, block hash, and approval status.

🐇✨
In the realm of code, where guardians tread,
A new event blooms, its details spread.
Approval's echo, through the blockchain vast,
A tale of trust, in bytes that last.
🌟📜 In every hash and ID, a story told,
Of guardians bold, and approvals gold.
🐾🥕

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6803a91 and 50e4b83.

Files selected for processing (1)

• packages/protocol/contracts/L1/provers/GuardianProver.sol (2 hunks)

Additional comments: 2

packages/protocol/contracts/L1/provers/GuardianProver.sol (2)

• 23-25: The GuardianApproval event is well-defined, including all necessary information (guardian's address, block ID, block hash, and approval status) as specified in the PR objectives. This addition aligns with the goal of enhancing transparency and traceability of guardian approvals. Ensure that the data types used for the event parameters are consistent with how they are used elsewhere in the contract and the broader system, particularly uint256 for blockId and bytes32 for blockHash, to maintain data integrity and compatibility.
• 53-53: The emission of the GuardianApproval event within the approve function correctly captures the essential details as intended. However, it's important to ensure that tran.blockHash is the correct source for the block hash in this context. Given the event's purpose to log approvals transparently, verify that tran.blockHash accurately represents the hash of the block being approved and not a different or related value. If tran.blockHash is indeed the correct value, this implementation meets the objectives. Otherwise, consider adjusting to use the correct source for the block hash.