Introduce RoyaltyWorkflows
for IP Revenue Claiming
#74
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the
RoyaltyWorkflows
contract, which allows IP royalty token holders to claim revenue across multiple revenue tokens and snapshots in a single function call.Key Functions and Use Cases:
transferToVaultAndSnapshotAndClaimByTokenBatch
:transferToVaultAndSnapshotAndClaimBySnapshotBatch
:transferToVaultAndSnapshotAndClaimByTokenBatch
, but also claims revenue from specific snapshots.snapshotAndClaimByTokenBatch
:snapshotAndClaimBySnapshotBatch
:snapshotAndClaimByTokenBatch
, but also includes claims from specific snapshots.Additional Changes:
RoyaltyWorkflows
.Users.t.sol
andMockERC20.sol
to support royalty workflow testing.Test Plan
Added test cases for each new function. Tests simulate a IP graph structure with different policies, licenses, and revenue tokens to test function behaviors. For details, see
test/workflows/RoyaltyWorkflows.t.sol
.All new and existing tests pass locally.
Related Issue
Closes #34