Add royalty policy LAP events

[Spablob]

Description

Adds the events SnapshotIntervalSet and IpRoyaltyVaultBeaconSet

Summary by CodeRabbit

• New Features
  • Introduced events for setting snapshot intervals and IP royalty vault beacons in royalty policies.
• Tests
  • Updated tests to verify the emission of new events for snapshot intervals and IP royalty vault beacons.

[coderabbitai]

Walkthrough

Recent updates focus on adding event emission functionality to track changes in the RoyaltyPolicyLAP contract. Specifically, events are introduced to log when the snapshot interval and IP royalty vault beacon addresses are set. Corresponding tests were also updated to validate these changes.

Changes

File	Change Summary
contracts/interfaces/modules/royalty/policies/IRoyaltyPolicyLAP.sol	Introduced two new events: SnapshotIntervalSet(uint256 interval) and IpRoyaltyVaultBeaconSet(address beacon).
contracts/modules/royalty/policies/RoyaltyPolicyLAP.sol	Updated setSnapshotInterval and setIpRoyaltyVaultBeacon functions to emit corresponding events after setting their respective values.
test/foundry/modules/royalty/RoyaltyPolicyLAP.t.sol	Added tests for the new events SnapshotIntervalSet and IpRoyaltyVaultBeaconSet to ensure they trigger correctly with the set values.

Sequence Diagram(s)

sequenceDiagram
    participant Admin
    participant RoyaltyPolicyLAP
    
    Admin->>RoyaltyPolicyLAP: call setSnapshotInterval
    RoyaltyPolicyLAP-->>Admin: SnapshotIntervalSet Event
    
    Admin->>RoyaltyPolicyLAP: call setIpRoyaltyVaultBeacon
    RoyaltyPolicyLAP-->>Admin: IpRoyaltyVaultBeaconSet Event

Loading

Poem

Amid the code, new changes bloom,
Events that sing in digital rooms,
Snapshot set with care and cheer,
Royalty beacons now crystal clear.
Tests confirm the paths we took,
In lines of code, just take a look.
The contract's heart now beats anew,
With every event, it speaks to you.

---

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.
• 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b2b1e82 and 651178d.

Files selected for processing (3)

• contracts/interfaces/modules/royalty/policies/IRoyaltyPolicyLAP.sol (1 hunks)
• contracts/modules/royalty/policies/RoyaltyPolicyLAP.sol (2 hunks)
• test/foundry/modules/royalty/RoyaltyPolicyLAP.t.sol (3 hunks)

Files skipped from review due to trivial changes (1)

• contracts/interfaces/modules/royalty/policies/IRoyaltyPolicyLAP.sol

Additional comments not posted (5)

test/foundry/modules/royalty/RoyaltyPolicyLAP.t.sol (3)

11-12: Correctly declared events for testing.

---

161-163: The test correctly expects the SnapshotIntervalSet event to be emitted with the correct parameters.

---

182-184: The test correctly expects the IpRoyaltyVaultBeaconSet event to be emitted with the correct parameters.

contracts/modules/royalty/policies/RoyaltyPolicyLAP.sol (2)

95-95: Correctly emits the SnapshotIntervalSet event after updating the snapshot interval.

---

106-106: Correctly emits the IpRoyaltyVaultBeaconSet event after updating the IP royalty vault beacon address.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 651178d and 71c75b2.

Files selected for processing (1)

• test/foundry/modules/royalty/RoyaltyPolicyLAP.t.sol (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• test/foundry/modules/royalty/RoyaltyPolicyLAP.t.sol

[Ramarti]

LGTM + Approved by auditors