feat: add pilFlavor to generate license terms (#177)

* feat: introduce PILFlavor class for managing programmable IP license terms

* feat: enhance PILFlavor class with camelCase to snake_case conversion and improve error messages for clarity

* feat: add unit tests for PILFlavor class to validate non-commercial and commercial use cases

* feat: refactor License class to utilize PILFlavor for license terms management and enhance validation logic

* feat: enhance License class tests by integrating PILFlavorError for improved validation and error handling

* feat: enhance PILFlavor class with new method for converting camelCase to snake_case license terms and update return types for license terms methods

* refactor: the pil_flavor class

* feat: update License class to use LicenseTermsInput for license terms management and enhance deprecation messages for clarity

* feat: add unit tests for various PILFlavor registration scenarios, including non-commercial and commercial use cases

* feat: enhance IPAsset and License classes with camelCase conversion for license terms and improve validation logic

* refactor: replace Web3 checksum address validation with a dedicated validate_address function and update related unit tests

* feat: integrate ModuleRegistryClient into IPAsset and update licensing configuration validation logic

* fix: update hookData handling in LicensingConfigData to use text conversion and adjust related tests for consistency

* refactor: remove LicenseTerms class and integrate LicensingConfigData into Group and IPAsset for improved licensing configuration management

* feat: add comprehensive tests for various licensing configurations in IPAsset, including commercial remix and non-commercial terms

* refactor: improve deprecation messages in License class methods to clarify future usage of register_pil_terms

* docs: update parameter descriptions in License and PILFlavor classes for improved clarity and consistency

* test: add unit tests for snake_to_camel and convert_dict_keys_to_camel_case functions

* feat: enhance IPAsset validation by adding checks for whitelisted royalty policies and currencies, along with corresponding unit tests

* refactor: streamline currency whitelisting check in IPAsset validation logic for improved readability

* refactor: enhance License class by utilizing replace for commercial revenue share calculation and streamline address validation in DerivativeData class

Author: bonnie57

src/story_protocol_python_sdk/__init__.py

@@ -30,8 +30,8 @@
     RegistrationWithRoyaltyVaultAndLicenseTermsResponse,
     RegistrationWithRoyaltyVaultResponse,
 )
-from .types.resource.License import LicenseTermsInput
-from .types.resource.Royalty import RoyaltyShareInput
+from .types.resource.License import LicenseTermsInput, LicenseTermsOverride
+from .types.resource.Royalty import NativeRoyaltyPolicy, RoyaltyShareInput
 from .utils.constants import (
     DEFAULT_FUNCTION_SELECTOR,
     MAX_ROYALTY_TOKEN,
@@ -45,6 +45,7 @@
 from .utils.derivative_data import DerivativeDataInput
 from .utils.ip_metadata import IPMetadataInput
 from .utils.licensing_config_data import LicensingConfig
+from .utils.pil_flavor import PILFlavor, PILFlavorError
 
 __all__ = [
     "StoryClient",
@@ -73,7 +74,9 @@
     "LicensingConfig",
     "RegisterPILTermsAndAttachResponse",
     "RoyaltyShareInput",
+    "NativeRoyaltyPolicy",
     "LicenseTermsInput",
+    "LicenseTermsOverride",
     "MintNFT",
     "MintedNFT",
     "RegisterIpAssetResponse",
@@ -88,4 +91,7 @@
     "DEFAULT_FUNCTION_SELECTOR",
     "MAX_ROYALTY_TOKEN",
     "WIP_TOKEN_ADDRESS",
+    # utils
+    "PILFlavor",
+    "PILFlavorError",
 ]

src/story_protocol_python_sdk/resources/Group.py

@@ -22,6 +22,9 @@
 from story_protocol_python_sdk.abi.LicensingModule.LicensingModule_client import (
     LicensingModuleClient,
 )
+from story_protocol_python_sdk.abi.ModuleRegistry.ModuleRegistry_client import (
+    ModuleRegistryClient,
+)
 from story_protocol_python_sdk.abi.PILicenseTemplate.PILicenseTemplate_client import (
     PILicenseTemplateClient,
 )
@@ -32,7 +35,7 @@
     CollectRoyaltiesResponse,
 )
 from story_protocol_python_sdk.utils.constants import ZERO_ADDRESS, ZERO_HASH
-from story_protocol_python_sdk.utils.license_terms import LicenseTerms
+from story_protocol_python_sdk.utils.licensing_config_data import LicensingConfigData
 from story_protocol_python_sdk.utils.sign import Sign
 from story_protocol_python_sdk.utils.transaction_utils import build_and_send_transaction
 from story_protocol_python_sdk.utils.validation import get_revenue_share
@@ -59,8 +62,7 @@ def __init__(self, web3: Web3, account, chain_id: int):
         self.licensing_module_client = LicensingModuleClient(web3)
         self.license_registry_client = LicenseRegistryClient(web3)
         self.pi_license_template_client = PILicenseTemplateClient(web3)
-
-        self.license_terms_util = LicenseTerms(web3)
+        self.module_registry_client = ModuleRegistryClient(web3)
         self.sign_util = Sign(web3, self.chain_id, self.account)
 
     def register_group(self, group_pool: str, tx_options: dict | None = None) -> dict:
@@ -707,8 +709,8 @@ def _get_license_data(self, license_data: list) -> list:
             processed_item = {
                 "licenseTemplate": license_template,
                 "licenseTermsId": item["license_terms_id"],
-                "licensingConfig": self.license_terms_util.validate_licensing_config(
-                    item.get("licensing_config", {})
+                "licensingConfig": LicensingConfigData.validate_license_config(
+                    self.module_registry_client, item.get("licensing_config", {})
                 ),
             }
 

src/story_protocol_python_sdk/resources/IPAsset.py

@@ -1,6 +1,6 @@
 """Module for handling IP Account operations and transactions."""
 
-from dataclasses import asdict, is_dataclass
+from dataclasses import asdict, is_dataclass, replace
 from typing import cast
 
 from ens.ens import Address, HexStr
@@ -37,6 +37,9 @@
 from story_protocol_python_sdk.abi.LicensingModule.LicensingModule_client import (
     LicensingModuleClient,
 )
+from story_protocol_python_sdk.abi.ModuleRegistry.ModuleRegistry_client import (
+    ModuleRegistryClient,
+)
 from story_protocol_python_sdk.abi.Multicall3.Multicall3_client import Multicall3Client
 from story_protocol_python_sdk.abi.PILicenseTemplate.PILicenseTemplate_client import (
     PILicenseTemplateClient,
@@ -69,6 +72,7 @@
     RegistrationWithRoyaltyVaultAndLicenseTermsResponse,
     RegistrationWithRoyaltyVaultResponse,
 )
+from story_protocol_python_sdk.types.resource.License import LicenseTermsInput
 from story_protocol_python_sdk.types.resource.Royalty import RoyaltyShareInput
 from story_protocol_python_sdk.utils.constants import (
     DEADLINE,
@@ -87,11 +91,14 @@
     get_ip_metadata_dict,
     is_initial_ip_metadata,
 )
-from story_protocol_python_sdk.utils.license_terms import LicenseTerms
+from story_protocol_python_sdk.utils.licensing_config_data import LicensingConfigData
+from story_protocol_python_sdk.utils.pil_flavor import PILFlavor
 from story_protocol_python_sdk.utils.royalty import get_royalty_shares
 from story_protocol_python_sdk.utils.sign import Sign
 from story_protocol_python_sdk.utils.transaction_utils import build_and_send_transaction
+from story_protocol_python_sdk.utils.util import convert_dict_keys_to_camel_case
 from story_protocol_python_sdk.utils.validation import (
+    get_revenue_share,
     validate_address,
     validate_max_rts,
 )
@@ -129,8 +136,8 @@ def __init__(self, web3: Web3, account, chain_id: int):
         )
         self.royalty_module_client = RoyaltyModuleClient(web3)
         self.multicall3_client = Multicall3Client(web3)
-        self.license_terms_util = LicenseTerms(web3)
         self.sign_util = Sign(web3, self.chain_id, self.account)
+        self.module_registry_client = ModuleRegistryClient(web3)
 
     def mint(
         self,
@@ -755,7 +762,6 @@ def register_ip_and_attach_pil_terms(
                     f"The NFT with id {token_id} is already registered as IP."
                 )
             license_terms = self._validate_license_terms_data(license_terms_data)
-
             calculated_deadline = self.sign_util.get_deadline(deadline=deadline)
 
             # Get permission signature for all required permissions
@@ -1399,7 +1405,6 @@ def register_ip_and_attach_pil_terms_and_distribute_royalty_tokens(
             license_terms = self._validate_license_terms_data(license_terms_data)
             calculated_deadline = self.sign_util.get_deadline(deadline=deadline)
             royalty_shares_obj = get_royalty_shares(royalty_shares)
-
             signature_response = self.sign_util.get_permission_signature(
                 ip_id=ip_id,
                 deadline=calculated_deadline,
@@ -2251,11 +2256,34 @@ def _validate_license_terms_data(
                 terms_dict = term["terms"]
                 licensing_config_dict = term["licensing_config"]
 
+            license_terms = PILFlavor.validate_license_terms(
+                LicenseTermsInput(**terms_dict)
+            )
+            license_terms = replace(
+                license_terms,
+                commercial_rev_share=get_revenue_share(
+                    license_terms.commercial_rev_share
+                ),
+            )
+            if license_terms.royalty_policy != ZERO_ADDRESS:
+                is_whitelisted = self.royalty_module_client.isWhitelistedRoyaltyPolicy(
+                    license_terms.royalty_policy
+                )
+                if not is_whitelisted:
+                    raise ValueError("The royalty_policy is not whitelisted.")
+
+            if license_terms.currency != ZERO_ADDRESS:
+                is_whitelisted = self.royalty_module_client.isWhitelistedRoyaltyToken(
+                    license_terms.currency
+                )
+                if not is_whitelisted:
+                    raise ValueError("The currency is not whitelisted.")
+
             validated_license_terms_data.append(
                 {
-                    "terms": self.license_terms_util.validate_license_terms(terms_dict),
-                    "licensingConfig": self.license_terms_util.validate_licensing_config(
-                        licensing_config_dict
+                    "terms": convert_dict_keys_to_camel_case(asdict(license_terms)),
+                    "licensingConfig": LicensingConfigData.validate_license_config(
+                        self.module_registry_client, licensing_config_dict
                     ),
                 }
             )