rename PILTermsData -> LicenseTermsData

storyprotocol · Nov 30, 2024 · 151b15d · 151b15d
1 parent 00b13ea
commit 151b15d
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 69 deletions.
diff --git a/contracts/interfaces/workflows/ILicenseAttachmentWorkflows.sol b/contracts/interfaces/workflows/ILicenseAttachmentWorkflows.sol
@@ -7,12 +7,12 @@ import { WorkflowStructs } from "../../lib/WorkflowStructs.sol";
 interface ILicenseAttachmentWorkflows {
     /// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
     /// @param ipId The ID of the IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param sigAttachAndConfig Signature data for attachLicenseTerms and setLicensingConfig to the IP via the Licensing Module.
     /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerPILTermsAndAttach(
         address ipId,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         WorkflowStructs.SignatureData calldata sigAttachAndConfig
     ) external returns (uint256[] memory licenseTermsIds);
 
@@ -23,7 +23,7 @@ interface ILicenseAttachmentWorkflows {
     /// @param spgNftContract The address of the SPGNFT collection.
     /// @param recipient The address of the recipient of the minted NFT.
     /// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
     /// @return ipId The ID of the newly registered IP.
     /// @return tokenId The ID of the newly minted NFT.
@@ -32,7 +32,7 @@ interface ILicenseAttachmentWorkflows {
         address spgNftContract,
         address recipient,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         bool allowDuplicates
     ) external returns (address ipId, uint256 tokenId, uint256[] memory licenseTermsIds);
 
@@ -42,7 +42,7 @@ interface ILicenseAttachmentWorkflows {
     /// @param nftContract The address of the NFT collection.
     /// @param tokenId The ID of the NFT.
     /// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param sigMetadataAndAttachAndConfig Signature data for setAll (metadata), attachLicenseTerms, and
     /// setLicensingConfig to the IP via the Core Metadata Module and Licensing Module.
     /// @return ipId The ID of the newly registered IP.
@@ -51,7 +51,7 @@ interface ILicenseAttachmentWorkflows {
         address nftContract,
         uint256 tokenId,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         WorkflowStructs.SignatureData calldata sigMetadataAndAttachAndConfig
     ) external returns (address ipId, uint256[] memory licenseTermsIds);
 }
diff --git a/contracts/lib/LicensingHelper.sol b/contracts/lib/LicensingHelper.sol
@@ -15,21 +15,21 @@ library LicensingHelper {
     /// @param ipId The ID of the IP.
     /// @param pilTemplate The address of the PIL License Template.
     /// @param licensingModule The address of the Licensing Module.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @return licenseTermsId The ID of the registered PIL terms.
     function registerPILTermsAndAttachAndSetConfigs(
         address ipId,
         address pilTemplate,
         address licensingModule,
-        WorkflowStructs.PILTermsData memory pilTermsData
+        WorkflowStructs.LicenseTermsData memory licenseTermsData
     ) internal returns (uint256 licenseTermsId) {
-        licenseTermsId = IPILicenseTemplate(pilTemplate).registerLicenseTerms(pilTermsData.terms);
+        licenseTermsId = IPILicenseTemplate(pilTemplate).registerLicenseTerms(licenseTermsData.terms);
         attachLicenseTermsAndSetConfigs(
             ipId,
             licensingModule,
             pilTemplate,
             licenseTermsId,
-            pilTermsData.licensingConfig
+            licenseTermsData.licensingConfig
         );
     }
 

diff --git a/contracts/lib/WorkflowStructs.sol b/contracts/lib/WorkflowStructs.sol
@@ -59,7 +59,7 @@ library WorkflowStructs {
     /// @notice Struct for PIL terms data for PIL registration and attachment on IP registration.
     /// @param terms The PIL terms to be used for the licensing.
     /// @param licenseTermsConfig The licensing configuration for the PIL terms.
-    struct PILTermsData {
+    struct LicenseTermsData {
         PILTerms terms;
         Licensing.LicensingConfig licensingConfig;
     }

diff --git a/contracts/workflows/LicenseAttachmentWorkflows.sol b/contracts/workflows/LicenseAttachmentWorkflows.sol
@@ -91,12 +91,12 @@ contract LicenseAttachmentWorkflows is
 
     /// @notice Register Programmable IP License Terms (if unregistered) and attach it to IP.
     /// @param ipId The ID of the IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param sigAttachAndConfig Signature data for attachLicenseTerms and setLicensingConfig to the IP via the Licensing Module.
     /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function registerPILTermsAndAttach(
         address ipId,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         WorkflowStructs.SignatureData calldata sigAttachAndConfig
     ) external returns (uint256[] memory licenseTermsIds) {
         address[] memory modules = new address[](2);
@@ -113,7 +113,7 @@ contract LicenseAttachmentWorkflows is
             sigData: sigAttachAndConfig
         });
 
-        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, pilTermsData);
+        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, licenseTermsData);
     }
 
     /// @notice Mint an NFT from a SPGNFT collection, register it with metadata as an IP,
@@ -122,7 +122,7 @@ contract LicenseAttachmentWorkflows is
     /// @param spgNftContract The address of the SPGNFT collection.
     /// @param recipient The address of the recipient of the minted NFT.
     /// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
     /// @return ipId The ID of the newly registered IP.
     /// @return tokenId The ID of the newly minted NFT.
@@ -131,7 +131,7 @@ contract LicenseAttachmentWorkflows is
         address spgNftContract,
         address recipient,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         bool allowDuplicates
     )
         external
@@ -149,7 +149,7 @@ contract LicenseAttachmentWorkflows is
         ipId = IP_ASSET_REGISTRY.register(block.chainid, spgNftContract, tokenId);
         MetadataHelper.setMetadata(ipId, address(CORE_METADATA_MODULE), ipMetadata);
 
-        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, pilTermsData);
+        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, licenseTermsData);
 
         ISPGNFT(spgNftContract).safeTransferFrom(address(this), recipient, tokenId, "");
     }
@@ -160,7 +160,7 @@ contract LicenseAttachmentWorkflows is
     /// @param nftContract The address of the NFT collection.
     /// @param tokenId The ID of the NFT.
     /// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @param sigMetadataAndAttachAndConfig Signature data for setAll (metadata), attachLicenseTerms, and
     /// setLicensingConfig to the IP via the Core Metadata Module and Licensing Module.
     /// @return ipId The ID of the newly registered IP.
@@ -169,7 +169,7 @@ contract LicenseAttachmentWorkflows is
         address nftContract,
         uint256 tokenId,
         WorkflowStructs.IPMetadata calldata ipMetadata,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData,
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData,
         WorkflowStructs.SignatureData calldata sigMetadataAndAttachAndConfig
     ) external returns (address ipId, uint256[] memory licenseTermsIds) {
         ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
@@ -192,24 +192,24 @@ contract LicenseAttachmentWorkflows is
 
         MetadataHelper.setMetadata(ipId, address(CORE_METADATA_MODULE), ipMetadata);
 
-        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, pilTermsData);
+        licenseTermsIds = _registerMultiplePILTermsAndAttachAndSetConfigs(ipId, licenseTermsData);
     }
 
     /// @notice Registers multiple PIL terms and attaches them to the given IP and sets their licensing configurations.
     /// @param ipId The ID of the IP.
-    /// @param pilTermsData The PIL terms and licensing configuration data to be attached to the IP.
+    /// @param licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
     /// @return licenseTermsIds The IDs of the newly registered PIL terms.
     function _registerMultiplePILTermsAndAttachAndSetConfigs(
         address ipId,
-        WorkflowStructs.PILTermsData[] calldata pilTermsData
+        WorkflowStructs.LicenseTermsData[] calldata licenseTermsData
     ) private returns (uint256[] memory licenseTermsIds) {
-        licenseTermsIds = new uint256[](pilTermsData.length);
-        for (uint256 i; i < pilTermsData.length; i++) {
+        licenseTermsIds = new uint256[](licenseTermsData.length);
+        for (uint256 i; i < licenseTermsData.length; i++) {
             licenseTermsIds[i] = LicensingHelper.registerPILTermsAndAttachAndSetConfigs(
                 ipId,
                 address(PIL_TEMPLATE),
                 address(LICENSING_MODULE),
-                pilTermsData[i]
+                licenseTermsData[i]
             );
         }
     }

diff --git a/test/integration/workflows/DerivativeIntegration.t.sol b/test/integration/workflows/DerivativeIntegration.t.sol
@@ -23,7 +23,7 @@ contract DerivativeIntegration is BaseIntegration {
     address[] private parentIpIds;
     uint256[] private parentLicenseTermIds;
     address private parentLicenseTemplate;
-    WorkflowStructs.PILTermsData[] internal pilTermsData;
+    WorkflowStructs.LicenseTermsData[] internal licenseTermsData;
     uint32 private revShare;
 
     /// @dev To use, run the following command:
@@ -385,8 +385,8 @@ contract DerivativeIntegration is BaseIntegration {
 
         revShare = 10 * 10 ** 6; // 10%
 
-        pilTermsData.push(
-            WorkflowStructs.PILTermsData({
+        licenseTermsData.push(
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialRemix({
                     mintingFee: testMintFee,
                     commercialRevShare: revShare,
@@ -413,7 +413,7 @@ contract DerivativeIntegration is BaseIntegration {
             spgNftContract: address(spgNftContract),
             recipient: testSender,
             ipMetadata: testIpMetadata,
-            pilTermsData: pilTermsData,
+            licenseTermsData: licenseTermsData,
             allowDuplicates: true
         });
 

diff --git a/test/integration/workflows/LicenseAttachmentIntegration.t.sol b/test/integration/workflows/LicenseAttachmentIntegration.t.sol
@@ -18,7 +18,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
     using Strings for uint256;
 
     ISPGNFT private spgNftContract;
-    WorkflowStructs.PILTermsData[] private commTermsData;
+    WorkflowStructs.LicenseTermsData[] private commTermsData;
 
     /// @dev To use, run the following command:
     /// forge script test/integration/workflows/LicenseAttachmentIntegration.t.sol:LicenseAttachmentIntegration \
@@ -58,7 +58,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
 
         uint256[] memory licenseTermsIds = licenseAttachmentWorkflows.registerPILTermsAndAttach({
             ipId: ipId,
-            pilTermsData: commTermsData,
+            licenseTermsData: commTermsData,
             sigAttachAndConfig: WorkflowStructs.SignatureData({
                 signer: testSender,
                 deadline: deadline,
@@ -85,7 +85,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
                     spgNftContract: address(spgNftContract),
                     recipient: testSender,
                     ipMetadata: testIpMetadata,
-                    pilTermsData: commTermsData,
+                    licenseTermsData: commTermsData,
                     allowDuplicates: true
                 });
             assertTrue(ipAssetRegistry.isRegistered(ipId1));
@@ -110,7 +110,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
                     spgNftContract: address(spgNftContract),
                     recipient: testSender,
                     ipMetadata: testIpMetadata,
-                    pilTermsData: commTermsData,
+                    licenseTermsData: commTermsData,
                     allowDuplicates: true
                 });
             assertTrue(ipAssetRegistry.isRegistered(ipId2));
@@ -158,7 +158,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
             nftContract: address(spgNftContract),
             tokenId: tokenId,
             ipMetadata: testIpMetadata,
-            pilTermsData: commTermsData,
+            licenseTermsData: commTermsData,
             sigMetadataAndAttachAndConfig: WorkflowStructs.SignatureData({
                 signer: testSender,
                 deadline: deadline,
@@ -200,7 +200,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
         );
 
         commTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialUse({
                     mintingFee: testMintFee,
                     currencyToken: testMintFeeToken,
@@ -220,7 +220,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
         );
 
         commTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialUse({
                     mintingFee: testMintFee,
                     currencyToken: testMintFeeToken,
@@ -240,7 +240,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
         );
 
         commTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialRemix({
                     mintingFee: testMintFee,
                     commercialRevShare: 5_000_000, // 5%
@@ -261,7 +261,7 @@ contract LicenseAttachmentIntegration is BaseIntegration {
         );
 
         commTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialRemix({
                     mintingFee: testMintFee,
                     commercialRevShare: 8_000_000, // 8%

diff --git a/test/integration/workflows/RoyaltyIntegration.t.sol b/test/integration/workflows/RoyaltyIntegration.t.sol
@@ -33,7 +33,7 @@ contract RoyaltyIntegration is BaseIntegration {
     uint256 internal defaultMintingFeeC = 500 * 10 ** StoryUSD.decimals(); // 500 SUSD
     uint32 internal defaultCommRevShareC = 20 * 10 ** 6; // 20%
 
-    WorkflowStructs.PILTermsData[] internal commTermsData;
+    WorkflowStructs.LicenseTermsData[] internal commTermsData;
 
     uint256 internal amountLicenseTokensToMint = 1;
 
@@ -212,7 +212,7 @@ contract RoyaltyIntegration is BaseIntegration {
 
         {
             commTermsData.push(
-                WorkflowStructs.PILTermsData({
+                WorkflowStructs.LicenseTermsData({
                     terms: PILFlavors.commercialRemix({
                         mintingFee: defaultMintingFeeA,
                         commercialRevShare: defaultCommRevShareA,
@@ -232,7 +232,7 @@ contract RoyaltyIntegration is BaseIntegration {
                 })
             );
             commTermsData.push(
-                WorkflowStructs.PILTermsData({
+                WorkflowStructs.LicenseTermsData({
                     terms: PILFlavors.commercialRemix({
                         mintingFee: defaultMintingFeeC,
                         commercialRevShare: defaultCommRevShareC,
@@ -263,7 +263,7 @@ contract RoyaltyIntegration is BaseIntegration {
 
             uint256[] memory licenseTermsIds = licenseAttachmentWorkflows.registerPILTermsAndAttach({
                 ipId: ancestorIpId,
-                pilTermsData: commTermsData,
+                licenseTermsData: commTermsData,
                 sigAttachAndConfig: WorkflowStructs.SignatureData({
                     signer: testSender,
                     deadline: deadline,

diff --git a/test/workflows/DerivativeWorkflows.t.sol b/test/workflows/DerivativeWorkflows.t.sol
@@ -21,12 +21,12 @@ contract DerivativeWorkflowsTest is BaseTest {
     using Strings for uint256;
 
     address internal ipIdParent;
-    WorkflowStructs.PILTermsData[] internal nonCommTermsData;
-    WorkflowStructs.PILTermsData[] internal commTermsData;
+    WorkflowStructs.LicenseTermsData[] internal nonCommTermsData;
+    WorkflowStructs.LicenseTermsData[] internal commTermsData;
     function setUp() public override {
         super.setUp();
         nonCommTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.nonCommercialSocialRemixing(),
                 licensingConfig: Licensing.LicensingConfig({
                     isSet: true,
@@ -42,7 +42,7 @@ contract DerivativeWorkflowsTest is BaseTest {
         );
 
         commTermsData.push(
-            WorkflowStructs.PILTermsData({
+            WorkflowStructs.LicenseTermsData({
                 terms: PILFlavors.commercialRemix({
                     mintingFee: 100 * 10 ** mockToken.decimals(),
                     commercialRevShare: 10 * 10 ** 6, // 10%
@@ -69,7 +69,7 @@ contract DerivativeWorkflowsTest is BaseTest {
                 spgNftContract: address(nftContract),
                 recipient: caller,
                 ipMetadata: ipMetadataDefault,
-                pilTermsData: nonCommTermsData,
+                licenseTermsData: nonCommTermsData,
                 allowDuplicates: true
             });
         }
@@ -82,7 +82,7 @@ contract DerivativeWorkflowsTest is BaseTest {
                 spgNftContract: address(nftContract),
                 recipient: caller,
                 ipMetadata: ipMetadataDefault,
-                pilTermsData: commTermsData,
+                licenseTermsData: commTermsData,
                 allowDuplicates: true
             });
         }