Add Licensing Module

contracts/FranchiseRegistry.sol

@@ -11,6 +11,7 @@ import { IIPAssetRegistry } from "./ip-assets/IIPAssetRegistry.sol";
 import { LibIPAssetId } from "./ip-assets/LibIPAssetId.sol";
 import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import { ERC721Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
+import { IERC721 } from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
 contract FranchiseRegistry is
     UUPSUpgradeable,
@@ -49,7 +50,6 @@ contract FranchiseRegistry is
     uint256 public constant PROTOCOL_ROOT_ID = 0;
     address public constant PROTOCOL_ROOT_ADDRESS = address(0);
     string private constant _VERSION = "0.1.0";
-
 
     constructor(address _factory) {
         if (_factory == address(0)) revert ZeroAddress();
@@ -85,6 +85,7 @@ contract FranchiseRegistry is
         $.ipAssetRegistries[nextId] = ipAssetRegistry;
         $.tokenURIs[nextId] = params.tokenURI;
         _safeMint(msg.sender, nextId);
+        // TODO: set licensing restrictions per franchise, maybe grant commercial root license to the franchise NFT
 
         emit FranchiseRegistered(msg.sender, nextId, ipAssetRegistry, params.name, params.symbol, params.tokenURI);
 
@@ -98,6 +99,7 @@ contract FranchiseRegistry is
         return $.ipAssetRegistries[franchiseId];
     }
 
+
     /**
      * @notice checks if an address is a valid SP IPAssetRegistry.
      * @param ipAssetRegistry the address to check
@@ -111,6 +113,7 @@ contract FranchiseRegistry is
         }
     }
 
+
     function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
         _requireMinted(tokenId);
         FranchiseStorage storage $ = _getFranchiseStorage();

contracts/access-control/ProtocolRoles.sol

@@ -2,6 +2,13 @@
 
 pragma solidity ^0.8.13;
 
+// This roles are used by the AccessControlSingleton, accessed by AccessControlled contracts.
+
+// Default admin role as per OZ AccessControl system. All other roles stem from this.
 bytes32 constant PROTOCOL_ADMIN_ROLE = bytes32(0);
+// Role that can upgrade UUPS contracts or Beacon Proxies
 bytes32 constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");
+// Role that can perform admin tasks on the Protocol Relationship Module contract (e.g. adding new protocol-wide links)
 bytes32 constant RELATIONSHIP_MANAGER_ROLE = keccak256("RELATIONSHIP_MANAGER_ROLE");
+// Role that can perform admin tasks on the Licensing Module contracts (setNonCommercialLicenseURI)
+bytes32 constant LICENSING_MANAGER_ROLE = keccak256("LICENSING_MANAGER_ROLE");

contracts/errors/General.sol

@@ -6,4 +6,6 @@ error ZeroAddress();
 error ZeroAmount();
 error UnsupportedInterface(string name);
 error Unauthorized();
-error NonExistentID(uint256 id);
+error NonExistentID(uint256 id);
+error EmptyArray();
+error LengthMismatch();

contracts/ip-assets/IIPAssetRegistry.sol

@@ -2,22 +2,26 @@
 pragma solidity ^0.8.13;
 
 import { IVersioned } from "../utils/IVersioned.sol";
-import { IIPAssetDataManager } from './storage/IIPAssetDataManager.sol';
+import { IIPAssetDataManager } from "./storage/IIPAssetDataManager.sol";
 import { IERC165Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/introspection/IERC165Upgradeable.sol";
-import { IERC721Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
-import { IPAsset } from "contracts/IPAsset.sol";
+import { IERC5218 } from "../modules/licensing/IERC5218.sol";
+import { IPAsset } from "../IPAsset.sol";
 
-interface IIPAssetRegistry is 
+interface IIPAssetRegistry is
     IVersioned,
     IERC165Upgradeable,
-    IERC721Upgradeable,
+    IERC5218,
     IIPAssetDataManager
-    {
-        function createIPAsset(
-            IPAsset sb,
-            string calldata name,
-            string calldata _description,
-            string calldata mediaUrl
-        ) external returns (uint256);
-        function franchiseId() external view returns (uint256);
-    }
+{
+    function franchiseId() external view returns (uint256);
+
+    function createIPAsset(
+        IPAsset sb,
+        string calldata name,
+        string calldata _description,
+        string calldata mediaUrl,
+        address to,
+        uint256 parentIpAssetId
+    ) external returns (uint256);
+
+}

contracts/ip-assets/IPAssetRegistry.sol

@@ -1,25 +1,25 @@
 // SPDX-License-Identifier: BUSL-1.1
 pragma solidity ^0.8.13;
-//import "forge-std/console.sol";
+
 import { IIPAssetRegistry } from "./IIPAssetRegistry.sol";
 import { LibIPAssetId } from "./LibIPAssetId.sol";
 import { Unauthorized, ZeroAmount, ZeroAddress } from "../errors/General.sol";
 import { IPAsset } from "contracts/IPAsset.sol";
 import { IIPAssetEventEmitter } from "./events/IIPAssetEventEmitter.sol";
-import { IIPAssetDataManager } from "./storage/IIPAssetDataManager.sol";
 import { IPAssetDataManager } from "./storage/IPAssetDataManager.sol";
 import { ERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
 import { IERC165Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/introspection/IERC165Upgradeable.sol";
 import { MulticallUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/MulticallUpgradeable.sol";
+import { RightsManager } from "../modules/licensing/RightsManager.sol";
+import { ILicensingModule } from "../modules/licensing/ILicensingModule.sol";
 
 contract IPAssetRegistry is
-    IIPAssetRegistry,
     IPAssetDataManager,
-    ERC721Upgradeable,
+    RightsManager,
     MulticallUpgradeable
 {
-
     error IdOverBounds();
+    error LicensingNotConfigured();
 
     /// @custom:storage-location erc7201:story-protocol.ip-assets-registry.storage
     struct IPAssetRegistryStorage {
@@ -30,13 +30,19 @@ contract IPAssetRegistry is
     }
 
     IIPAssetEventEmitter public immutable EVENT_EMITTER;
+    ILicensingModule public immutable LICENSING_MODULE;
     // keccak256(bytes.concat(bytes32(uint256(keccak256("story-protocol.ip-assets-registry.storage")) - 1)))
-    bytes32 private constant _STORAGE_LOCATION = 0x1a0b8fa444ff575656111a4368b8e6a743b70cbf31ffb9ee2c7afe1983f0e378;
+    bytes32 private constant _STORAGE_LOCATION =
+        0x1a0b8fa444ff575656111a4368b8e6a743b70cbf31ffb9ee2c7afe1983f0e378;
     string private constant _VERSION = "0.1.0";
+    uint256 private constant _ROOT_IP_ASSET = 0;
 
-    constructor(address _eventEmitter) {
+    constructor(address _eventEmitter, address _licensingModule, address _franchiseRegistry) RightsManager(_franchiseRegistry) {
+        // TODO: should Franchise owner be able to change this?
         if (_eventEmitter == address(0)) revert ZeroAddress();
         EVENT_EMITTER = IIPAssetEventEmitter(_eventEmitter);
+        if (_licensingModule == address(0)) revert ZeroAddress();
+        LICENSING_MODULE = ILicensingModule(_licensingModule);
         _disableInitializers();
     }
 
@@ -46,7 +52,7 @@ contract IPAssetRegistry is
         string calldata _symbol,
         string calldata _description
     ) public initializer {
-        __ERC721_init(_name, _symbol);
+        __RightsManager_init(_name, _symbol);
         __Multicall_init();
         if (_franchiseId == 0) revert ZeroAmount();
         IPAssetRegistryStorage storage $ = _getIPAssetRegistryStorage();
@@ -64,24 +70,110 @@ contract IPAssetRegistry is
         }
     }
 
-    function version() external pure virtual override returns (string memory) {
+    function version() external pure virtual returns (string memory) {
         return _VERSION;
     }
 
+    /**
+     * Creates a new IPAsset, and assigns licenses (rights) to it, according to the Franchise config in LicensingModule.
+     * A Non commercial license is always assigned, and if the IPAsset is a root IPAsset, a commercial license may also be assigned.
+     * @dev reverts if LicensingModule is not configured for the Franchise.
+     * Logs to IPAssetEventEmitter, common contract for all IPAsset registries.
+     * @param ipAssetType the type of IPAsset to create
+     * @param name IPAsset name
+     * @param _description short description of the IPAsset
+     * @param mediaUrl url to the IPAsset media and metadata
+     * @param to holder of the IPAsset (and thus the licenses)
+     * @param parentIpAssetId 0 if this is a root IPAsset, if it is a derivative, set the parent IPAsset id
+     * @return the created IPAsset id
+     */
     function createIPAsset(
-        IPAsset sb,
+        IPAsset ipAssetType,
         string calldata name,
         string calldata _description,
-        string calldata mediaUrl
-    ) external virtual override returns (uint256) {
-        if (sb == IPAsset.UNDEFINED) revert InvalidBlockType();
-        uint256 sbId = _mintBlock(msg.sender, sb);
-        _writeIPAsset(sbId, name, _description, mediaUrl);
+        string calldata mediaUrl,
+        address to,
+        uint256 parentIpAssetId
+    )
+        public
+        returns (uint256)
+    {
+        if (ipAssetType == IPAsset.UNDEFINED) revert InvalidBlockType();
+        uint256 ipAssetId = _mintBlock(to, ipAssetType);
+        _writeIPAsset(ipAssetId, name, _description, mediaUrl);
         IPAssetRegistryStorage storage $ = _getIPAssetRegistryStorage();
-        EVENT_EMITTER.emitIPAssetCreation($.franchiseId, sbId);
-        return sbId;
+        EVENT_EMITTER.emitIPAssetCreation($.franchiseId, ipAssetId);
+
+        // Non commercial
+        ILicensingModule.FranchiseConfig memory config = LICENSING_MODULE.getFranchiseConfig($.franchiseId);
+        if (config.revoker == address(0)) revert LicensingNotConfigured();
+
+        _setNonCommercialRights(ipAssetId, parentIpAssetId, to, config.revoker, config.nonCommercialConfig, config.nonCommercialTerms);
+        // If non derivative IpAsset, then franchise config may dictate commercial rights
+        // Derivative works do not have commercial rights unless a deal with the relevant licensor is made
+        if (config.rootIpAssetHasCommercialRights && parentIpAssetId == 0) {
+            // Commercial
+            _setCommercialRights(ipAssetId, _ROOT_IP_ASSET, to, config.revoker, config.commercialLicenseUri, config.commercialConfig, config.commercialTerms);
+        }
+
+        return ipAssetId;
+    }
+
+    /**
+     * Sets the non commercial rights for an IPAsset, with terms from the Franchise config in LicensingModule.
+     * If no parent asset id is provided, the root IPAsset id is used if it exists in the Franchise config.
+     * @param ipAssetId the IPAsset id
+     * @param parentIpAssetId in case this is a derivative IPAsset, set the parent IPAsset id, 0 otherwise
+     * @param holder of the IPAsset and licenses
+     * @param revoker of the license. Can't be zero or changed later
+     * @param config Franchise config
+     * @param terms for the license to be active
+     */
+    function _setNonCommercialRights(uint256 ipAssetId, uint256 parentIpAssetId, address holder, address revoker, ILicensingModule.IpAssetConfig memory config, TermsProcessorConfig memory terms) internal {
+        uint256 parentLicenseId = parentIpAssetId == 0 ? config.franchiseRootLicenseId : getLicenseIdByTokenId(parentIpAssetId, false);
+        _createLicense(
+            ipAssetId,
+            parentLicenseId,
+            holder,
+            LICENSING_MODULE.getNonCommercialLicenseURI(),
+            revoker,
+            false,
+            config.canSublicense,
+            terms,
+            false
+        );
+    }
+
+    /**
+     * Sets the commercial rights for an IPAsset, with terms from the Franchise config in LicensingModule.
+     * If no parent asset id is provided, the root IPAsset id is used if it exists in the Franchise config.
+     * @param ipAssetId the IPAsset id
+     * @param parentIpAssetId in case this is a derivative IPAsset, set the parent IPAsset id, 0 otherwise
+     * @param holder of the IPAsset and licenses
+     * @param revoker of the license. Can't be zero or changed later
+     * @param config Franchise config
+     * @param terms for the license to be active
+     */
+    function _setCommercialRights(uint256 ipAssetId, uint256 parentIpAssetId, address holder, address revoker, string memory licenseUri, ILicensingModule.IpAssetConfig memory config, TermsProcessorConfig memory terms) internal {
+        uint256 parentLicenseId = parentIpAssetId == _ROOT_IP_ASSET ? config.franchiseRootLicenseId : getLicenseIdByTokenId(parentIpAssetId, true);
+        _createLicense(
+            ipAssetId,
+            parentLicenseId,
+            holder,
+            licenseUri,
+            revoker,
+            true,
+            config.canSublicense,
+            terms,
+            false
+        );
     }
 
+    /**
+     * mints the IPAsset block, and assigns the next id to it.
+     * @param to holder
+     * @param sb ip asset type
+     */
     function _mintBlock(address to, IPAsset sb) private returns (uint256) {
         uint256 nextId = currentIdFor(sb) + 1;
         if (nextId > LibIPAssetId._lastId(sb)) revert IdOverBounds();
@@ -111,7 +203,10 @@ contract IPAssetRegistry is
         return $.franchiseId;
     }
 
-    function tokenURI(uint256 tokenId) public view override returns (string memory) {
+    function tokenURI(
+        uint256 tokenId
+    ) public view override returns (string memory) {
+        // TODO: should this reference the license too?
         return readIPAsset(tokenId).mediaUrl;
     }
 

contracts/ip-assets/IPAssetRegistryFactory.sol

@@ -7,6 +7,7 @@ import { IPAssetRegistry } from "./IPAssetRegistry.sol";
 import { ZeroAddress } from "../errors/General.sol";
 import { IVersioned } from "../utils/IVersioned.sol";
 import { UnsupportedInterface } from "../errors/General.sol";
+import { LicenseRegistry } from "../modules/licensing/LicenseRegistry.sol";
 import { RevertingIPAssetRegistry } from "contracts/utils/RevertingIPAssetRegistry.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { UpgradeableBeacon } from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
@@ -40,6 +41,9 @@ contract IPAssetRegistryFactory is Ownable {
             description
         );
         address proxy = address(new BeaconProxy(address(BEACON), data));
+        LicenseRegistry licenseRegistry = new LicenseRegistry(proxy, string.concat("Licenses for ", name), string.concat("sl", symbol));
+        IPAssetRegistry(proxy).setLicenseRegistry(address(licenseRegistry));
+
         emit FranchiseCreated(proxy, name, symbol);
         return proxy;
     }