release v1.2.2

storyprotocol · Sep 24, 2024 · e69ac3d · e69ac3d
1 parent 4225263
commit e69ac3d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v1.2.2
+
+* Introduced `RoyaltyWorkflows` for IP Revenue Claiming
+
+**Full Changelog**: [v1.2.1...v1.2.2](https://github.com/storyprotocol/protocol-periphery-v1/compare/v1.2.1...v1.2.2)
+
 ## v1.2.1
 
 * Added support for public minting in SPG and SPGNFT

diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ Batch calling functions is supported both natively and through the `Multicall3`
 ```json
 {
   "GroupingWorkflows": "0xDed2AF44142489d5c380322A22cB9A0B8f22111A",
+  "RoyaltyWorkflows": "0xA07f6f4258440d8128Ab86362F17361391F4CA2B",
   "SPG": "0xAceb5E631d743AF76aF69414eC8D356c13435E59",
   "SPGNFTBeacon": "0x769A0F5197D427a7fC4378317437e924c8c74b33",
   "SPGNFTImpl": "0xbE0EB11e256093e22c8802977023970Da6B97fAB",

diff --git a/deploy-out/deployment-1513.json b/deploy-out/deployment-1513.json
@@ -1,6 +1,7 @@
 {
   "main": {
     "GroupingWorkflows": "0xDed2AF44142489d5c380322A22cB9A0B8f22111A",
+    "RoyaltyWorkflows": "0xA07f6f4258440d8128Ab86362F17361391F4CA2B",
     "SPG": "0xAceb5E631d743AF76aF69414eC8D356c13435E59",
     "SPGNFTBeacon": "0x769A0F5197D427a7fC4378317437e924c8c74b33",
     "SPGNFTImpl": "0xbE0EB11e256093e22c8802977023970Da6B97fAB"

diff --git a/docs/WORKFLOWS.md b/docs/WORKFLOWS.md
@@ -28,4 +28,19 @@
 - `registerGroupAndAttachLicenseAndAddIps`: Registers a group IP → Attaches the given license terms to the group IP → Adds existing IPs to the group IP
 
 
+### Claiming IP Revenue
+- `transferToVaultAndSnapshotAndClaimByTokenBatch`:
+  - Transfers revenue tokens to ancestor IP’s royalty vault → Takes a snapshot of the royalty vault → Claims all available revenue tokens from the snapshot to the claimer’s wallet
+  - *Use Case*: For IP royalty token holders who want to claim both their direct revenue and royalties from descendant IPs.
+- `transferToVaultAndSnapshotAndClaimBySnapshotBatch`:
+  - Transfers revenue tokens to ancestor IP’s royalty vault → Takes a snapshot of the royalty vault → Claims all available revenue tokens from the new snapshot to the claimer’s wallet → Claims all available revenue tokens from each provided unclaimed snapshot to the claimer’s wallet
+  - *Use Case*: For IP royalty token holders who want to claim both direct revenue and descendant royalties from the latest snapshot and previously taken snapshots.
+- `snapshotAndClaimByTokenBatch`:
+  - Takes a snapshot of the royalty vault → Claims all available revenue tokens from the new snapshot to the claimer’s wallet
+  - *Use Case*: For IP royalty token holders who want to claim the current revenue in their IP’s royalty vault (which may or may not include descendant royalties).
+- `snapshotAndClaimBySnapshotBatch`:
+  - Takes a snapshot of the royalty vault → Claims all available revenue tokens from the new snapshot to the claimer’s wallet → Claims all available revenue tokens from each provided unclaimed snapshot to the claimer’s wallet
+  - *Use Case*: For IP royalty token holders who want to claim the current revenue in their IP’s royalty vault from the latest snapshot and previously taken snapshots.
+
+
 > 📚 For full contract interfaces, check out `contracts/interfaces`.