Merge branch 'dev' into license_metadata

contracts/IPAssetRegistry.sol

@@ -7,6 +7,7 @@ import { IRegistrationModule } from "contracts/interfaces/modules/registration/I
 import { IModuleRegistry } from "contracts/interfaces/modules/IModuleRegistry.sol";
 import { IIPOrg } from "contracts/interfaces/ip-org/IIPOrg.sol";
 import { ModuleRegistryKeys } from "contracts/lib/modules/ModuleRegistryKeys.sol";
+import { REGISTRATION_MODULE_KEY } from "contracts/lib/modules/Module.sol";
 import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title Global IP Asset Registry
@@ -41,7 +42,7 @@ contract IPAssetRegistry is IIPAssetRegistry {
     /// @notice Restricts calls to the registration module of the IP Asset.
     /// TODO(ramarti): Enable IPOrg-specific registration modules to be authorized.
     modifier onlyRegistrationModule() {
-        if (MODULE_REGISTRY.protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE) != msg.sender) {
+        if (address(MODULE_REGISTRY.protocolModule(REGISTRATION_MODULE_KEY)) != msg.sender) {
             revert Errors.Unauthorized();
         }
         _;
@@ -70,10 +71,6 @@ contract IPAssetRegistry is IIPAssetRegistry {
         bytes32 hash_
     ) public onlyRegistrationModule returns (uint256 ipAssetId) {
 
-        if (MODULE_REGISTRY.protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE) != msg.sender) {
-            revert Errors.Unauthorized();
-        }
-
         // Crate a new IP asset with the provided IP attributes.
         ipAssetId = ++totalSupply;
         uint64 registrationDate = uint64(block.timestamp);
@@ -129,7 +126,7 @@ contract IPAssetRegistry is IIPAssetRegistry {
     /// @notice Returns the current owner of an IP asset.
     /// @param ipAssetId_ The id of the IP asset being queried.
     function ipAssetOwner(uint256 ipAssetId_) public view returns (address) {
-        address registrationModule = MODULE_REGISTRY.protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE);
+        address registrationModule = address(MODULE_REGISTRY.protocolModule(REGISTRATION_MODULE_KEY));
         return IRegistrationModule(registrationModule).ownerOf(ipAssetId_);
     }
 

contracts/StoryProtocol.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.19;
 
 import { IIPOrgController } from "contracts/interfaces/ip-org/IIPOrgController.sol";
 import { IIPOrg } from "contracts/interfaces/ip-org/IIPOrg.sol";
+import { Gateway } from "contracts/modules/Gateway.sol";
 import { IPOrgParams } from "contracts/lib/IPOrgParams.sol";
 import { Errors } from "contracts/lib/Errors.sol";
 import { IPOrgParams } from "contracts/lib/IPOrgParams.sol";
@@ -14,6 +15,11 @@ import { ModuleRegistryKeys } from "contracts/lib/modules/ModuleRegistryKeys.sol
 import { Licensing } from "contracts/lib/modules/Licensing.sol";
 import { FixedSet } from "contracts/utils/FixedSet.sol";
 import { Multicall } from "@openzeppelin/contracts/utils/Multicall.sol";
+import { ILicensingModule } from "contracts/interfaces/modules/licensing/ILicensingModule.sol";
+import { IRegistrationModule } from "contracts/interfaces/modules/registration/IRegistrationModule.sol";
+import { IRelationshipModule } from "contracts/interfaces/modules/relationships/IRelationshipModule.sol";
+import { RELATIONSHIP_MODULE, LICENSING_MODULE, REGISTRATION_MODULE } from "contracts/lib/modules/Module.sol";
+import { ModuleKey, REGISTRATION_MODULE_KEY, LICENSING_MODULE_KEY, RELATIONSHIP_MODULE_KEY, ModuleDependencies } from "contracts/lib/modules/Module.sol";
 
 /// @title Story Protocol Gateway Contract
 /// @notice The Story Protocol contract acts as a global gateway for calling all
@@ -24,6 +30,11 @@ import { Multicall } from "@openzeppelin/contracts/utils/Multicall.sol";
 ///         their own frontend contracts (gateways) for IP interaction.
 contract StoryProtocol is Multicall {
 
+    // Modules which the Story Protocol gateway depends on.
+    IRegistrationModule public registrationModule;
+    ILicensingModule public licensingModule;
+    IRelationshipModule public relationshipModule;
+
     IIPOrgController public immutable IP_ORG_CONTROLLER;
     ModuleRegistry public immutable MODULE_REGISTRY;
 
@@ -58,7 +69,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.configure(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.REGISTRATION_MODULE,
+            REGISTRATION_MODULE,
             encodedParams
         );
     }
@@ -77,7 +88,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.configure(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.REGISTRATION_MODULE,
+            REGISTRATION_MODULE,
             encodedParams
         );
     }
@@ -118,7 +129,7 @@ contract StoryProtocol is Multicall {
         bytes memory result = MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.REGISTRATION_MODULE,
+            REGISTRATION_MODULE,
             encodedParams,
             preHooksData_,
             postHooksData_
@@ -150,7 +161,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.REGISTRATION_MODULE,
+            REGISTRATION_MODULE,
             encodedParams,
             preHooksData_,
             postHooksData_
@@ -168,7 +179,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.configure(
             IIPOrg(params_.ipOrg),
             msg.sender,
-            ModuleRegistryKeys.RELATIONSHIP_MODULE,
+            RELATIONSHIP_MODULE,
             abi.encode(LibRelationship.ADD_REL_TYPE_CONFIG, abi.encode(params_))
         );
     }
@@ -180,7 +191,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.configure(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.RELATIONSHIP_MODULE,
+            RELATIONSHIP_MODULE,
             abi.encode(
                 LibRelationship.REMOVE_REL_TYPE_CONFIG,
                 abi.encode(relType)
@@ -197,7 +208,7 @@ contract StoryProtocol is Multicall {
         bytes memory result = MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.RELATIONSHIP_MODULE,
+            RELATIONSHIP_MODULE,
             abi.encode(params_),
             preHooksData_,
             postHooksData_
@@ -219,7 +230,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.configure(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.LICENSING_MODULE,
+            LICENSING_MODULE,
             abi.encode(Licensing.LICENSING_FRAMEWORK_CONFIG, abi.encode(config_))
         );
     }
@@ -240,7 +251,7 @@ contract StoryProtocol is Multicall {
         bytes memory result = MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.LICENSING_MODULE,
+            LICENSING_MODULE,
             abi.encode(
                 Licensing.CREATE_LICENSE,
                 params
@@ -261,7 +272,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.LICENSING_MODULE,
+            LICENSING_MODULE,
             abi.encode(
                 Licensing.ACTIVATE_LICENSE,
                 abi.encode(licenseId_)
@@ -283,7 +294,7 @@ contract StoryProtocol is Multicall {
         MODULE_REGISTRY.execute(
             IIPOrg(ipOrg_),
             msg.sender,
-            ModuleRegistryKeys.LICENSING_MODULE,
+            LICENSING_MODULE,
             abi.encode(
                 Licensing.LINK_LNFT_TO_IPA,
                 abi.encode(licenseId_, ipaId_)

contracts/access-control/AccessControlSingleton.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: UNLICENSED
 // See Story Protocol Alpha Agreement: https://github.com/storyprotocol/protocol-contracts/blob/main/StoryProtocol-AlphaTestingAgreement-17942166.3.pdf
 
-pragma solidity ^0.8.13;
+pragma solidity ^0.8.19;
 
 import { Errors } from "contracts/lib/Errors.sol";
 import { AccessControl } from "contracts/lib/AccessControl.sol";

contracts/interfaces/modules/IGateway.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+import { ModuleDependencies } from "contracts/lib/modules/Module.sol";
+
+/// @title Module Gateway Interface
+/// @notice Interface for a Story Protocol module gateway, which is a contract
+///         that may be granted access by the module registry to call module
+///         functions declared by the gateway's module dependency set.
+interface IGateway {
+
+    /// @notice Synchronizes all downstream dependencies via the module registry.
+    /// @dev This function may only be called by the module registry.
+    /// @return dependencies The freshly updated dependencies needed by the gateway.
+    function updateDependencies() external returns (ModuleDependencies memory dependencies);
+
+    /// @notice Fetches all module dependencies required by the gateway contract.
+    /// @return dependencies The dependencies that the gateway requires from the protocol.
+    function getDependencies() external view returns (ModuleDependencies memory dependencies);
+
+}

contracts/interfaces/modules/IModuleRegistry.sol

@@ -1,21 +1,43 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.19;
 
+import { ModuleKey } from "contracts/lib/modules/Module.sol";
+import { IGateway } from "contracts/interfaces/modules/IGateway.sol";
+import { IModule } from "contracts/interfaces/modules/base/IModule.sol";
+import { IIPOrg } from "contracts/interfaces/ip-org/IIPOrg.sol";
+
 /// @title IModuleRegistry
 /// @notice Module Registry Interface
 interface IModuleRegistry {
 
-    /// @notice Emits when a new module is added for a specific IP Org.
+    /// @notice Emits when a gateway was successfully registered by the protocol
+    ///         for a specific dependency (module type + module function).
+    /// @param key The identifier of the dependent module type.
+    /// @param fn The function identifier of the dependent module type.
+    /// @param gateway The gateway address granted permission to use the dependency.
+    /// @param grant Whether the gateway was authorized to use the dependency.
+    event ModuleAuthorizationGranted(
+        ModuleKey indexed key,
+        bytes4 fn,
+        address indexed gateway,
+        bool grant
+    );
+
+    /// @notice Emits when a brand new module is enrolled to the protocol.
+    /// @param ipOrg The IP Org to which the module belongs.
+    /// @param moduleKey The string identifier of the module type that was added.
+    /// @param module The address of the module.
     event ModuleAdded(
         address indexed ipOrg,
         string moduleKey,
         address indexed module
     );
 
-    /// @notice Emits when a module is removed for an IP Org.
+    /// @notice Emits when the protocol module for a module type is removed.
+    /// @param key The identifier of the module type that was added.
+    /// @param module The address of the removed module
     event ModuleRemoved(
-        address indexed ipOrg,
-        string moduleKey,
+        ModuleKey indexed key,
         address indexed module
     );
 
@@ -51,6 +73,25 @@ interface IModuleRegistry {
         address indexed hook
     );
 
-    /// @notice Fetches the latest protocol module bound to a specific key.
-    function protocolModule(string calldata moduleKey) external view returns (address);
+    /// @notice Registers a new module of a provided type to Story Protocol.
+    /// @param key_ The bytes32 type of the module being registered.
+    /// @param module_ The actual module being registered.
+    function registerProtocolModule(ModuleKey key_, IModule module_) external;
+
+    /// @notice Fetches the protocol module by its string identifier.
+    /// @param key_ The string module type.
+    /// @return The module associated with the module key.
+    function protocolModule(string calldata key_) external view returns (address);
+
+    /// @notice Fetches the protocol module bound to a module type.
+    /// @param key_ The bytes32 module type.
+    /// @return The module associated with the module key.
+    function protocolModule(ModuleKey key_) external view returns (address);
+
+    /// @notice Checks whether a gateway has permission to call a module function.
+    /// @param key_ The module type.
+    /// @param gateway_ The gateway which has the module as a dependency.
+    /// @param fn_ The module function whose access is being checked for.
+    function isAuthorized(ModuleKey key_, IGateway gateway_, bytes4 fn_) external view returns (bool);
+
 }

contracts/interfaces/modules/base/IModule.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-import { IModule } from "./IModule.sol";
 import { IIPOrg } from "contracts/interfaces/ip-org/IIPOrg.sol";
+import { ModuleKey } from "contracts/lib/modules/Module.sol";
 
 /// @title IModule
 /// @notice Interface for a Story Protocol Module, building block of the protocol functionality.
@@ -14,6 +14,10 @@ interface IModule {
     /// Module execution failed.
     event RequestFailed(address indexed sender, string reason);
 
+    /// @notice Gets the protocol-wide key associated with the module.
+    /// @return The bytes32 identifier of the module.
+    function moduleKey() external pure returns (ModuleKey);
+
     /// @notice Main execution entrypoint.
     /// @dev It will verify params, execute pre action hooks, perform the action,
     /// execute post action hooks and emit the RequestCompleted event, plus returning the result.

contracts/interfaces/modules/licensing/ILicensingModule.sol

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.19;
 
+import { IModule } from "contracts/interfaces/modules/base/IModule.sol";
 import { Licensing } from "contracts/lib/modules/Licensing.sol";
 
 /// @title ILicensingModule
-interface ILicensingModule {
+interface ILicensingModule is IModule {
 
     /// Emits when an IP org picks a licensing framework
     /// and sets its configuration.

contracts/interfaces/modules/registration/IRegistrationModule.sol

@@ -2,9 +2,11 @@
 pragma solidity ^0.8.19;
 
 import { Registration } from "contracts/lib/modules/Registration.sol";
+import { IIPOrg } from "contracts/interfaces/ip-org/IIPOrg.sol";
+import { IModule } from "contracts/interfaces/modules/base/IModule.sol";
 
 /// @title IRegistrationModule
-interface IRegistrationModule {
+interface IRegistrationModule is IModule {
 
     /// @notice Emits when an IPOrg updates metadata associated with its IPA.
     /// @param ipOrg The address of the IP Org whose metadata was updated.
@@ -76,4 +78,5 @@ interface IRegistrationModule {
 
     /// @notice Returns true if the index for an IP Org asset type is supported.
     function isValidIpOrgAssetType(address ipOrg_, uint8 index) external view returns (bool);
+
 }

contracts/interfaces/modules/relationships/IRelationshipModule.sol

@@ -2,10 +2,12 @@
 pragma solidity ^0.8.13;
 
 import { LibRelationship } from "contracts/lib/modules/LibRelationship.sol";
+import { IModule } from "contracts/interfaces/modules/base/IModule.sol";
 
 /// @title IRelationshipModule
 /// @notice Interface for the RelationshipModule. 
-interface IRelationshipModule {
+interface IRelationshipModule is IModule {
+
     /// Emitted with a new Relationship Type definitions is created
     event RelationshipTypeSet(
         // Short string naming the type

contracts/ip-org/IPOrg.sol

@@ -11,7 +11,7 @@ import { IPOrgParams } from "contracts/lib/IPOrgParams.sol";
 import { ERC721Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
 import { IERC165Upgradeable } from "@openzeppelin/contracts-upgradeable/utils/introspection/IERC165Upgradeable.sol";
 import { IPAssetRegistry } from "contracts/IPAssetRegistry.sol";
-import { ModuleRegistryKeys } from "contracts/lib/modules/ModuleRegistryKeys.sol";
+import { REGISTRATION_MODULE_KEY } from "contracts/lib/modules/Module.sol";
 import { Errors } from "contracts/lib/Errors.sol";
 
 /// @title IP Organization Contract
@@ -42,7 +42,7 @@ contract IPOrg is
 
     /// @notice Restricts calls to being through the registration module.
     modifier onlyRegistrationModule() {
-        if (IModuleRegistry(MODULE_REGISTRY).protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE) != msg.sender) {
+        if (address(MODULE_REGISTRY.protocolModule(REGISTRATION_MODULE_KEY)) != msg.sender) {
             revert Errors.Unauthorized();
         }
         _;
@@ -74,21 +74,21 @@ contract IPOrg is
     function tokenURI(
         uint256 tokenId_
     ) public view override returns (string memory) {
-        address registrationModule = IModuleRegistry(MODULE_REGISTRY).protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE);
+        address registrationModule = address(IModuleRegistry(MODULE_REGISTRY).protocolModule(REGISTRATION_MODULE_KEY));
         return IRegistrationModule(registrationModule).tokenURI(address(this), tokenId_, ipOrgAssetType(tokenId_));
     }
 
     /// @notice Retrieves the contract URI for the IP Org collection.
     function contractURI() public view override returns (string memory) {
-        address registrationModule = IModuleRegistry(MODULE_REGISTRY).protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE);
+        address registrationModule = address(IModuleRegistry(MODULE_REGISTRY).protocolModule(REGISTRATION_MODULE_KEY));
         return IRegistrationModule(registrationModule).contractURI(address(this));
     }
 
     /// @notice Gets the global IP asset id associated with this IP Org asset.
     /// @param id The local id of the IP Org wrapped IP asset.
     /// @return The global identifier of the IP asset.
     function ipAssetId(uint256 id) public returns (uint256) {
-        address registrationModule = MODULE_REGISTRY.protocolModule(ModuleRegistryKeys.REGISTRATION_MODULE);
+        address registrationModule = address(MODULE_REGISTRY.protocolModule(REGISTRATION_MODULE_KEY));
         return IRegistrationModule(registrationModule).ipAssetId(address(this), id);
     }