feat(licensing): enable multi-license attachment in LicenseAttachmentWorkflows

.github/workflows/foundry_ci.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - release-v1.2.4
 
 jobs:
 

contracts/interfaces/workflows/ILicenseAttachmentWorkflows.sol

@@ -12,12 +12,12 @@ interface ILicenseAttachmentWorkflows {
     /// @param ipId The ID of the IP.
     /// @param terms The PIL terms to be registered.
     /// @param sigAttach Signature data for attachLicenseTerms to the IP via the Licensing Module.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerPILTermsAndAttach(
         address ipId,
-        PILTerms calldata terms,
+        PILTerms[] calldata terms,
         WorkflowStructs.SignatureData calldata sigAttach
-    ) external returns (uint256 licenseTermsId);
+    ) external returns (uint256[] memory licenseTermsIds);
 
     /// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
     /// register Programmable IPLicense
@@ -29,13 +29,13 @@ interface ILicenseAttachmentWorkflows {
     /// @param terms The PIL terms to be registered.
     /// @return ipId The ID of the newly registered IP.
     /// @return tokenId The ID of the newly minted NFT.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function mintAndRegisterIpAndAttachPILTerms(
         address spgNftContract,
         address recipient,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        PILTerms calldata terms
-    ) external returns (address ipId, uint256 tokenId, uint256 licenseTermsId);
+        PILTerms[] calldata terms
+    ) external returns (address ipId, uint256 tokenId, uint256[] memory licenseTermsIds);
 
     /// @notice Register a given NFT as an IP and attach Programmable IP License Terms.
     /// @dev Because IP Account is created in this function, we need to set the permission via signature to allow this
@@ -47,13 +47,13 @@ interface ILicenseAttachmentWorkflows {
     /// @param sigMetadata OPTIONAL. Signature data for setAll (metadata) for the IP via the Core Metadata Module.
     /// @param sigAttach Signature data for attachLicenseTerms to the IP via the Licensing Module.
     /// @return ipId The ID of the newly registered IP.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerIpAndAttachPILTerms(
         address nftContract,
         uint256 tokenId,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        PILTerms calldata terms,
+        PILTerms[] calldata terms,
         WorkflowStructs.SignatureData calldata sigMetadata,
         WorkflowStructs.SignatureData calldata sigAttach
-    ) external returns (address ipId, uint256 licenseTermsId);
+    ) external returns (address ipId, uint256[] memory licenseTermsIds);
 }

contracts/lib/LicensingHelper.sol

@@ -14,17 +14,19 @@ library LicensingHelper {
     /// @param licensingModule The address of the Licensing Module.
     /// @param licenseRegistry The address of the License Registry.
     /// @param terms The PIL terms to be registered.
-    /// @return licenseTermsId The ID of the registered PIL terms.
+    /// @return licenseTermsIds The IDs of the registered PIL terms.
     function registerPILTermsAndAttach(
         address ipId,
         address pilTemplate,
         address licensingModule,
         address licenseRegistry,
-        PILTerms calldata terms
-    ) internal returns (uint256 licenseTermsId) {
-        licenseTermsId = IPILicenseTemplate(pilTemplate).registerLicenseTerms(terms);
-
-        attachLicenseTerms(ipId, licensingModule, licenseRegistry, pilTemplate, licenseTermsId);
+        PILTerms[] calldata terms
+    ) internal returns (uint256[] memory licenseTermsIds) {
+        licenseTermsIds = new uint256[](terms.length);
+        for (uint256 i = 0; i < terms.length; i++) {
+            licenseTermsIds[i] = IPILicenseTemplate(pilTemplate).registerLicenseTerms(terms[i]);
+            attachLicenseTerms(ipId, licensingModule, licenseRegistry, pilTemplate, licenseTermsIds[i]);
+        }
     }
 
     /// @dev Attaches license terms to the given IP.

contracts/workflows/LicenseAttachmentWorkflows.sol

@@ -93,12 +93,12 @@ contract LicenseAttachmentWorkflows is
     /// @param ipId The ID of the IP.
     /// @param terms The PIL terms to be registered.
     /// @param sigAttach Signature data for attachLicenseTerms to the IP via the Licensing Module.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerPILTermsAndAttach(
         address ipId,
-        PILTerms calldata terms,
+        PILTerms[] calldata terms,
         WorkflowStructs.SignatureData calldata sigAttach
-    ) external returns (uint256 licenseTermsId) {
+    ) external returns (uint256[] memory licenseTermsIds) {
         PermissionHelper.setPermissionForModule(
             ipId,
             address(LICENSING_MODULE),
@@ -107,7 +107,7 @@ contract LicenseAttachmentWorkflows is
             sigAttach
         );
 
-        licenseTermsId = LicensingHelper.registerPILTermsAndAttach(
+        licenseTermsIds = LicensingHelper.registerPILTermsAndAttach(
             ipId,
             address(PIL_TEMPLATE),
             address(LICENSING_MODULE),
@@ -125,13 +125,17 @@ contract LicenseAttachmentWorkflows is
     /// @param terms The PIL terms to be registered.
     /// @return ipId The ID of the newly registered IP.
     /// @return tokenId The ID of the newly minted NFT.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function mintAndRegisterIpAndAttachPILTerms(
         address spgNftContract,
         address recipient,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        PILTerms calldata terms
-    ) external onlyMintAuthorized(spgNftContract) returns (address ipId, uint256 tokenId, uint256 licenseTermsId) {
+        PILTerms[] calldata terms
+    )
+        external
+        onlyMintAuthorized(spgNftContract)
+        returns (address ipId, uint256 tokenId, uint256[] memory licenseTermsIds)
+    {
         tokenId = ISPGNFT(spgNftContract).mintByPeriphery({
             to: address(this),
             payer: msg.sender,
@@ -140,7 +144,7 @@ contract LicenseAttachmentWorkflows is
         ipId = IP_ASSET_REGISTRY.register(block.chainid, spgNftContract, tokenId);
         MetadataHelper.setMetadata(ipId, address(CORE_METADATA_MODULE), ipMetadata);
 
-        licenseTermsId = LicensingHelper.registerPILTermsAndAttach(
+        licenseTermsIds = LicensingHelper.registerPILTermsAndAttach(
             ipId,
             address(PIL_TEMPLATE),
             address(LICENSING_MODULE),
@@ -161,15 +165,15 @@ contract LicenseAttachmentWorkflows is
     /// @param sigMetadata OPTIONAL. Signature data for setAll (metadata) for the IP via the Core Metadata Module.
     /// @param sigAttach Signature data for attachLicenseTerms to the IP via the Licensing Module.
     /// @return ipId The ID of the newly registered IP.
-    /// @return licenseTermsId The ID of the newly registered PIL terms.
+    /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerIpAndAttachPILTerms(
         address nftContract,
         uint256 tokenId,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        PILTerms calldata terms,
+        PILTerms[] calldata terms,
         WorkflowStructs.SignatureData calldata sigMetadata,
         WorkflowStructs.SignatureData calldata sigAttach
-    ) external returns (address ipId, uint256 licenseTermsId) {
+    ) external returns (address ipId, uint256[] memory licenseTermsIds) {
         ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
         MetadataHelper.setMetadataWithSig(
             ipId,
@@ -187,7 +191,7 @@ contract LicenseAttachmentWorkflows is
             sigAttach
         );
 
-        licenseTermsId = LicensingHelper.registerPILTermsAndAttach(
+        licenseTermsIds = LicensingHelper.registerPILTermsAndAttach(
             ipId,
             address(PIL_TEMPLATE),
             address(LICENSING_MODULE),

test/integration/workflows/DerivativeIntegration.t.sol

@@ -7,6 +7,7 @@ import { ICoreMetadataModule } from "@storyprotocol/core/interfaces/modules/meta
 import { IIPAccount } from "@storyprotocol/core/interfaces/IIPAccount.sol";
 import { ILicensingModule } from "@storyprotocol/core/interfaces/modules/licensing/ILicensingModule.sol";
 import { PILFlavors } from "@storyprotocol/core/lib/PILFlavors.sol";
+import { IPILicenseTemplate, PILTerms } from "@storyprotocol/core/interfaces/modules/licensing/IPILicenseTemplate.sol";
 
 // contracts
 import { ISPGNFT } from "../../../contracts/interfaces/ISPGNFT.sol";
@@ -353,25 +354,28 @@ contract DerivativeIntegration is BaseIntegration {
             )
         );
 
+        PILTerms[] memory commTerms = new PILTerms[](1);
+        commTerms[0] = PILFlavors.commercialUse({
+            mintingFee: testMintFee,
+            currencyToken: testMintFeeToken,
+            royaltyPolicy: royaltyPolicyLRPAddr
+        });
+
         StoryUSD.mint(testSender, testMintFee);
         StoryUSD.approve(address(spgNftContract), testMintFee);
-        (address parentIpId, , uint256 licenseTermsIdParent) = licenseAttachmentWorkflows
+        (address parentIpId, , uint256[] memory licenseTermsIdParent) = licenseAttachmentWorkflows
             .mintAndRegisterIpAndAttachPILTerms({
                 spgNftContract: address(spgNftContract),
                 recipient: testSender,
                 ipMetadata: testIpMetadata,
-                terms: PILFlavors.commercialUse({
-                    mintingFee: testMintFee,
-                    currencyToken: testMintFeeToken,
-                    royaltyPolicy: royaltyPolicyLRPAddr
-                })
+                terms: commTerms
             });
 
         parentIpIds = new address[](1);
         parentIpIds[0] = parentIpId;
 
         parentLicenseTermIds = new uint256[](1);
-        parentLicenseTermIds[0] = licenseTermsIdParent;
+        parentLicenseTermIds[0] = licenseTermsIdParent[0];
         parentLicenseTemplate = pilTemplateAddr;
     }