Relationship Module

contracts/FranchiseRegistry.sol

@@ -40,7 +40,7 @@ contract FranchiseRegistry is
 
     constructor(address _factory) {
         _disableInitializers();
-        if (_factory == address(0)) revert ZeroAddress("factory");
+        if (_factory == address(0)) revert ZeroAddress();
         FACTORY = IPAssetRegistryFactory(_factory);
     }
 
@@ -66,7 +66,7 @@ contract FranchiseRegistry is
         string calldata description
     ) external returns (uint256, address) {
         FranchiseStorage storage $ = _getFranchiseStorage();
-        address ipAssetRegistry = FACTORY.createFranchiseBlocks(
+        address ipAssetRegistry = FACTORY.createFranchiseIPAssets(
             ++$.franchiseIds,
             name,
             symbol,

contracts/IPAsset.sol

@@ -12,4 +12,4 @@ enum IPAsset {
     ITEM
 }
 
-    
+uint8 constant EXTERNAL_ASSET = type(uint8).max; 

contracts/access-control/AccessControlSingleton.sol

@@ -20,7 +20,7 @@ contract AccessControlSingleton is AccessControlUpgradeable, UUPSUpgradeable, Mu
      * @param _admin address to be the PROTOCOL_ADMIN_ROLE.
      */
     function initialize(address _admin) external initializer {
-        if (_admin == address(0)) revert ZeroAddress("_admin");
+        if (_admin == address(0)) revert ZeroAddress();
         __AccessControl_init();
         __UUPSUpgradeable_init();
         _grantRole(PROTOCOL_ADMIN_ROLE, _admin);

contracts/access-control/AccessControlledUpgradeable.sol

@@ -73,4 +73,9 @@ abstract contract AccessControlledUpgradeable is UUPSUpgradeable {
         emit AccessControlUpdated(accessControl);
     }
 
+    function getAccessControl() public view returns (address) {
+        AccessControlledStorage storage $ = _getAccessControlledUpgradeable();
+        return address($.accessControl);
+    }
+
 }

contracts/access-control/ProtocolRoles.sol

@@ -4,4 +4,5 @@ pragma solidity ^0.8.13;
 
 bytes32 constant PROTOCOL_ADMIN_ROLE = bytes32(0);
 bytes32 constant UPGRADER_ROLE = keccak256("UPGRADER_ROLE");
-bytes32 constant DAM_APPROVER = keccak256("DAM_APPROVER");
+bytes32 constant RELATIONSHIP_MANAGER_ROLE = keccak256("RELATIONSHIP_MANAGER_ROLE");
+bytes32 constant RELATIONSHIP_DISPUTER_ROLE = keccak256("RELATIONSHIP_DISPUTER_ROLE");

contracts/errors/General.sol

@@ -2,8 +2,8 @@
 
 pragma solidity ^0.8.13;
 
-error ZeroAddress(string name);
-error ZeroAmount(string name);
+error ZeroAddress();
+error ZeroAmount();
 error UnsupportedInterface(string name);
 error Unauthorized();
 error NonExistentID(uint256 id);

contracts/ip-assets/IIPAssetRegistry.sol

@@ -13,4 +13,6 @@ interface IIPAssetRegistry is
     IERC721Upgradeable,
     IIPAssetData,
     IGroupDAM
-    { }
+    { 
+    function franchiseId() external view returns (uint256);
+    }

contracts/ip-assets/IPAssetRegistry.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 //import "forge-std/console.sol";
 import { IIPAssetRegistry } from "./IIPAssetRegistry.sol";
 import { LibIPAssetId } from "./LibIPAssetId.sol";
-import { Unauthorized, ZeroAddress } from "../errors/General.sol";
+import { Unauthorized, ZeroAmount } from "../errors/General.sol";
 import { IPAssetData } from "./data-access-modules/storage/IPAssetData.sol";
 import { IPAsset } from "contracts/IPAsset.sol";
 import { GroupDAM } from "./data-access-modules/group/GroupDAM.sol";
@@ -44,7 +44,7 @@ contract IPAssetRegistry is
     ) public initializer {
         __ERC721_init(_name, _symbol);
         __Multicall_init();
-        if (_franchiseId == 0) revert ZeroAddress("franchiseId");
+        if (_franchiseId == 0) revert ZeroAmount();
         IPAssetRegistryStorage storage $ = _getIPAssetRegistryStorage();
         $.franchiseId = _franchiseId;
         $.description = _description;

contracts/ip-assets/IPAssetRegistryFactory.sol

@@ -25,7 +25,7 @@ contract IPAssetRegistryFactory is Ownable {
         BEACON = new UpgradeableBeacon(address(new IPAssetRegistry()));
     }
 
-    function createFranchiseBlocks(
+    function createFranchiseIPAssets(
         uint256 franchiseId,
         string calldata name,
         string calldata symbol,

contracts/modules/relationships/IRelationshipModule.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.13;
+
+import { IRelationshipProcessor } from "./RelationshipProcessors/IRelationshipProcessor.sol";
+import { IPAsset } from "contracts/IPAsset.sol";
+
+
+interface IRelationshipModule {
+
+    event RelationSet(
+        address sourceContract,
+        uint256 sourceId,
+        address destContract,
+        uint256 destId,
+        bytes32 indexed relationshipId,
+        uint256 endTime
+    );
+    event RelationUnset(
+        address sourceContract,
+        uint256 sourceId,
+        address destContract,
+        uint256 destId,
+        bytes32 indexed relationshipId
+    );
+    event RelationPendingProcessor(
+        address sourceContract,
+        uint256 sourceId,
+        address destContract,
+        uint256 destId,
+        bytes32 indexed relationshipId
+    );
+
+    event RelationshipConfigSet(
+        bytes32 indexed relationshipId,
+        uint256 sourceIPAssetTypeMask,
+        uint256 destIPAssetTypeMask,
+        bool onlySameFranchise,
+        address processor,
+        uint256 maxTTL,
+        uint256 minTTL
+    );
+
+    event RelationshipConfigUnset(bytes32 indexed relationshipId);
+
+    error NonExistingRelationship();
+    error IntentAlreadyRegistered();
+    error UnsupportedRelationshipSrc();
+    error UnsupportedRelationshipDst();
+    error CannotRelateToOtherFranchise();
+    error InvalidTTL();
+    error InvalidEndTimestamp();
+
+    struct TimeConfig {
+        uint112 maxTTL;
+        uint112 minTTL;
+        bool renewable;
+    }
+
+    struct RelationshipConfig {
+        uint256 sourceIPAssetTypeMask;
+        uint256 destIPAssetTypeMask;
+        bool onlySameFranchise;
+        IRelationshipProcessor processor;
+        address disputer;
+        TimeConfig timeConfig;
+    }
+
+    struct SetRelationshipConfigParams {
+        IPAsset[] sourceIPAssets;
+        bool allowedExternalSource;
+        IPAsset[] destIPAssets;
+        bool allowedExternalDest;
+        bool onlySameFranchise;
+        address processor;
+        address disputer;
+        TimeConfig timeConfig;
+    }
+
+    struct RelationshipParams {
+        address sourceContract;
+        uint256 sourceId;
+        address destContract;
+        uint256 destId;
+        bytes32 relationshipId;
+        uint256 ttl;
+    }
+
+    function relate(RelationshipParams calldata params, bytes calldata data) external;
+    function unrelate(RelationshipParams calldata params) external;
+    function areTheyRelated(RelationshipParams calldata params) external view returns (bool);
+    function isRelationshipExpired(RelationshipParams calldata params) external view returns (bool);
+    function setRelationshipConfig(bytes32 relationshipId, SetRelationshipConfigParams calldata params) external;
+    function unsetRelationshipConfig(bytes32 relationshipId) external;
+    function relationshipConfig(bytes32 relationshipId) external view returns (RelationshipConfig memory);
+}

contracts/modules/relationships/ProtocolRelationshipModule.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.13;
+
+import { RelationshipModuleBase } from "./RelationshipModuleBase.sol";
+import { UPGRADER_ROLE, RELATIONSHIP_MANAGER_ROLE, RELATIONSHIP_DISPUTER_ROLE } from "contracts/access-control/ProtocolRoles.sol";
+
+/**
+ * @title ProtocolRelationshipModule
+ * @dev Implementation of RelationshipModuleBase that allows relationship configs that will be used protocol wide.
+ * The meaning and parameters of the relationships are to be defined in Story Protocol Improvement Proposals.
+ * Example: https://github.com/storyprotocol/protocol-contracts/issues/33
+ * The relationship configs are set by the RELATIONSHIP_MANAGER_ROLE.
+ * Upgrades are done by the UPGRADER_ROLE.
+ */
+contract ProtocolRelationshipModule is RelationshipModuleBase {
+
+    constructor(address _franchiseRegistry) RelationshipModuleBase(_franchiseRegistry) {}
+
+    function initialize(address accessControl) public initializer {
+        __RelationshipModuleBase_init(accessControl);
+    }
+
+    /********* Setting Relationships *********/
+    function setRelationshipConfig(bytes32 relationshipId, SetRelationshipConfigParams calldata params) external onlyRole(RELATIONSHIP_MANAGER_ROLE) {
+        _setRelationshipConfig(relationshipId, params);
+    }
+
+    function unsetRelationshipConfig(bytes32 relationshipId) external onlyRole(RELATIONSHIP_MANAGER_ROLE) {
+        _unsetRelationshipConfig(relationshipId);
+    }
+
+
+    function _authorizeUpgrade(
+        address newImplementation
+    ) internal virtual override onlyRole(UPGRADER_ROLE) {}
+
+}