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

feat: restore v1.2 compatibility to RoyaltyTokenDistributionWorkflows #152

Merged
merged 2 commits into from
Dec 20, 2024

Conversation

sebsadface
Copy link
Member

@sebsadface sebsadface commented Dec 20, 2024

Description

This PR reintroduces compatibility with protocol periphery v1.2 in RoyaltyTokenDistributionWorkflows. The v1.2 interface has been restored, with updated function implementations to ensure compatibility with protocol core v1.3. Due to contract size limit, this contract cannot be 100% backward compatible, the changes required are listed in the Notes section below.

Test Plan

Restored and updated the test cases for the v1.2 interface. All tests passes locally.

Related Issue

Notes

  • For downstream integrations, update your implementation with the following changes to ensure compatibility:
    • mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens:
      • Modify the derivData argument to include the newly required fields.
      • Add support for the new allowDuplicates parameter. It should defaults to true.
    • registerIpAndMakeDerivativeAndDeployRoyaltyVault:
      • Update your integration to handle the updated derivData argument with the additional fields.
      • Use a single batch permission signature for both metadata and derivative registration instead of two separate signatures.
    • distributeRoyaltyTokens:
      • Remove the ipRoyaltyVault parameter in your implementation.
  • No additional changes are required from downstream integrations

@sebsadface sebsadface merged commit d8930f9 into storyprotocol:main Dec 20, 2024
3 checks passed
sebsadface added a commit to sebsadface/pp-v1 that referenced this pull request Dec 20, 2024
@sebsadface sebsadface deleted the bc-rt-distribution branch January 9, 2025 19:42
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.

Ensure Backward Compatibility with v1.2.4 in Periphery
2 participants