Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify Royalty Claims in RoyaltyWorkflows and GroupingWorkflows by Removing Snapshots #118

Merged
merged 8 commits into from
Nov 14, 2024

Conversation

sebsadface
Copy link
Member

Description

This PR simplifies RoyaltyWorkflows and GroupingWorkflows to use the updated royalty vault API, introduced in PR#291 of the core protocol, which simplifies the royalty claiming process by removing the need for snapshots.

Key Changes

  • Removed the following functions from RoyaltyWorkflows:
    • transferToVaultAndSnapshotAndClaimBySnapshotBatch
    • snapshotAndClaimBySnapshotBatch
    • snapshotAndClaimByTokenBatch
  • Modified transferToVaultAndSnapshotAndClaimBySnapshotBatch in RoyaltyWorkflows to remove snapshot logic and renamed it to transferToVaultAndClaimByTokenBatch.
  • Added claimAllRevenue in RoyaltyWorkflows to allow claiming all available revenue for an ancestor IP.
  • Removed snapshot logic from collectRoyaltiesAndClaimReward in GroupingWorkflows.
  • Updated tests and documentation to reflect these changes.

Test Plan

New test cases were added for the claimAllRevenue function, and existing unit and integration tests for RoyaltyWorkflows and GroupingWorkflows were updated.

Related Issue

Notes

This PR introduces major interface changes to RoyaltyWorkflows.

Copy link
Collaborator

@kingster-will kingster-will left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@sebsadface sebsadface merged commit 3fc7b22 into storyprotocol:main Nov 14, 2024
3 checks passed
@sebsadface sebsadface deleted the update-royalty branch December 4, 2024 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update RoyaltyWorkflows and GroupingWorkflows to Simplified Royalty Claiming Without Snapshots
2 participants