@etherisc/gif-next 0.0.2-d5522f6-712 → 0.0.2-d5fac82-078

package/contracts/registry/Registry.sol

@@ -1,12 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-import {NftId, toNftId, zeroNftId} from "../types/NftId.sol";
-import {VersionPart} from "../types/Version.sol";
-import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
-
-import {ERC165} from "../shared/ERC165.sol";
+import {NftId, toNftId, zeroNftId} from "../type/NftId.sol";
+import {VersionPart} from "../type/Version.sol";
+import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../type/ObjectType.sol";
 
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
@@ -23,39 +22,40 @@ import {ReleaseManager} from "./ReleaseManager.sol";
 // 4) state object by regular service (POLICY, BUNDLE, STAKE)
 
 contract Registry is
-    ERC165,
     IRegistry
 {
     address public constant NFT_LOCK_ADDRESS = address(0x1);
     uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
     string public constant EMPTY_URI = "";
 
-    mapping(NftId nftId => ObjectInfo info) internal _info;
-    mapping(address object => NftId nftId) internal _nftIdByAddress;
+    mapping(NftId nftId => ObjectInfo info) private _info;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
+
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
 
-    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) _service;
+    mapping(ObjectType objectType => bool) private _coreTypes;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidContractCombination;
+            ObjectType parentType => bool)) private _coreContractCombinations;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidObjectCombination;
+            ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId internal _registryNftId;
-    ChainNft internal _chainNft;
+    NftId private _registryNftId;
+    ChainNft private _chainNft;
 
-    ReleaseManager internal _releaseManager;
+    ReleaseManager private _releaseManager;
 
     modifier onlyRegistryService() {
         if(!_releaseManager.isActiveRegistryService(msg.sender)) {
-            revert CallerNotRegistryService();
+            revert ErrorRegistryCallerNotRegistryService();
         }
         _;
     }
 
     modifier onlyReleaseManager() {
         if(msg.sender != address(_releaseManager)) {
-            revert CallerNotReleaseManager();
+            revert ErrorRegistryCallerNotReleaseManager();
         }
         _;
     }
@@ -65,16 +65,14 @@ contract Registry is
         _releaseManager = ReleaseManager(msg.sender);
 
         // deploy NFT 
-        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
+        _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _registerProtocol();
         _registerRegistry();
 
-        // set object parent relations
-        _setupValidObjectParentCombinations();
-
-        _registerInterface(type(IRegistry).interfaceId);
+        // set object types and object parent relations
+        _setupValidCoreTypesAndCombinations();
     }
 
     function registerService(
@@ -86,18 +84,34 @@ contract Registry is
         onlyReleaseManager
         returns(NftId nftId)
     {
+        address service = info.objectAddress;
         /* must be guaranteed by release manager
+        if(service == address(0)) {
+            revert();
+        }
+
+        if(version.eqz()) {
+            revert();
+        }
+
         if(info.objectType != SERVICE()) {
             revert();
         }
-        info.initialOwner = NFT_LOCK_ADDRESS <- if services are access managed
+        if(info.parentType != REGISTRY()) {
+            revert();
+        }        
+        info.initialOwner == NFT_LOCK_ADDRESS <- if services are access managed
         */
 
-        if(_service[version][domain] > address(0)) {
-            revert ServiceAlreadyRegistered(info.objectAddress);
+        if(domain.eqz()) {
+            revert ErrorRegistryDomainZero(service);
         }
 
-        _service[version][domain] = info.objectAddress; // nftId;
+        if(_service[version][domain] > address(0)) {
+            revert ErrorRegistryDomainAlreadyRegistered(service, version, domain);
+        }
+        
+        _service[version][domain] = service;
 
         nftId = _register(info);
 
@@ -109,41 +123,70 @@ contract Registry is
         onlyRegistryService
         returns(NftId nftId)
     {
-        // no service registrations
-        if(info.objectType == SERVICE()) {
-            revert ServiceRegistration();
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        // only valid core types combinations
+        if(info.objectAddress == address(0)) 
+        {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+            }
+        }
+        else
+        {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+            }
         }
 
         nftId = _register(info);
     }
 
+    function registerWithCustomType(ObjectInfo memory info)
+        external
+        onlyRegistryService
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        if(_coreTypes[objectType]) {
+            revert ErrorRegistryCoreTypeRegistration();
+        }
+
+        if(
+            parentType == PROTOCOL() ||
+            parentType == REGISTRY() ||
+            parentType == SERVICE()
+        ) {
+            revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+        }
+
+        _register(info);
+    }
+
+
     /// @dev earliest GIF major version 
-    function getMajorVersionMin() external view returns (VersionPart) {
+    function getInitialVersion() external view returns (VersionPart) {
         return _releaseManager.getInitialVersion();
     }
 
-    // TODO make distinction between active an not yet active version
-    // need to be thought trough, not yet clear if necessary
-    // need to answer question: what is the latest version during the upgrade process?
-    // likely setting up a new gif version does not fit into a single tx
-    // in this case we might want to have a period where the latest version is
-    // in the process of being set up while the latest active version is 1 major release smaller
-    /// @dev latest GIF major version (might not yet be active)
-    function getMajorVersionMax() external view returns (VersionPart) {
+    /// @dev next GIF release version to be released
+    function getNextVersion() external view returns (VersionPart) {
         return _releaseManager.getNextVersion();
     }
 
     /// @dev latest active GIF release version 
-    function getMajorVersion() external view returns (VersionPart) { 
+    function getLatestVersion() external view returns (VersionPart) { 
         return _releaseManager.getLatestVersion();
     }
 
-    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory)
-    {
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
         return _releaseManager.getReleaseInfo(version);
     }
 
-    function getObjectCount() external view override returns (uint256) {
+    function getObjectCount() external view returns (uint256) {
         return _chainNft.totalSupply();
     }
 
@@ -151,11 +194,11 @@ contract Registry is
         return _registryNftId;
     }
 
-    function getNftId(address object) external view override returns (NftId id) {
+    function getNftId(address object) external view returns (NftId id) {
         return _nftIdByAddress[object];
     }
 
-    function ownerOf(NftId nftId) public view override returns (address) {
+    function ownerOf(NftId nftId) public view returns (address) {
         return _chainNft.ownerOf(nftId.toInt());
     }
 
@@ -163,42 +206,70 @@ contract Registry is
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
-    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
-    function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(address object) external view returns (ObjectInfo memory) {
         return _info[_nftIdByAddress[object]];
     }
 
-    function isRegistered(NftId nftId) public view override returns (bool) {
+    function isRegistered(NftId nftId) public view returns (bool) {
         return _info[nftId].objectType.gtz();
     }
 
-    function isRegistered(address object) external view override returns (bool) {
+    function isRegistered(address object) external view returns (bool) {
         return _nftIdByAddress[object].gtz();
     }
 
-    function isRegisteredService(address object) external view override returns (bool) {
-        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    function isRegisteredService(address object) external view returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
+    function isRegisteredComponent(address object) external view returns (bool) {
+        NftId objectParentNftId = _info[_nftIdByAddress[object]].parentNftId;
+        return _info[objectParentNftId].objectType == INSTANCE();
+    }
+
+    function isActiveRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseManager.isActiveRelease(version);
     }
 
     function getServiceAddress(
         ObjectType serviceDomain, 
         VersionPart releaseVersion
-    ) external view returns (address)
+    ) external view returns (address service)
     {
-        return _service[releaseVersion][serviceDomain];
+            service =  _service[releaseVersion][serviceDomain]; 
+    }
+
+    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address) {
+        return address(_releaseManager.getReleaseAccessManager(version));
+    }
+
+    function getReleaseManagerAddress() external view returns (address) {
+        return address(_releaseManager);
     }
 
-    function getChainNft() external view override returns (ChainNft) {
-        return _chainNft;
+    function getChainNftAddress() external view override returns (address) {
+        return address(_chainNft);
     }
 
     function getOwner() public view returns (address owner) {
         return ownerOf(address(this));
     }
 
+    // IERC165
+
+    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+        if(interfaceId == type(IERC165).interfaceId || interfaceId == type(IRegistry).interfaceId) {
+            return true;
+        }
+
+        return false;
+    }
+
     // Internals
 
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
@@ -218,48 +289,36 @@ contract Registry is
         // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
         // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
         if(parentAddress == address(0)) {
-            revert ZeroParentAddress();
+            revert ErrorRegistryParentAddressZero();
         }
 
         address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
+        uint256 tokenId = _chainNft.getNextTokenId();
+        nftId = toNftId(tokenId);
 
-        // TODO does external call
-        // compute next nftId, do all checks and stores, mint() at most end...
-        uint256 mintedTokenId = _chainNft.mint(
-            info.initialOwner,
-            interceptor,
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-
-        // TODO move nftId out of info struct
-        // getters by nftId -> return struct without nftId
-        // getters by address -> return nftId AND struct
         info.nftId = nftId;
         _info[nftId] = info;
 
         if(info.objectAddress > address(0)) 
         {
-            // parent is registered + object-parent types are valid
-            if(_isValidContractCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
-            }
-
             address contractAddress = info.objectAddress;
 
             if(_nftIdByAddress[contractAddress].gtz()) { 
-                revert ContractAlreadyRegistered(contractAddress);
+                revert ErrorRegistryContractAlreadyRegistered(contractAddress);
             }
 
             _nftIdByAddress[contractAddress] = nftId;
         }
-        else
-        {
-            if(_isValidObjectCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
-            }
-        }
 
         emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
+
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = _chainNft.mint(
+            info.initialOwner,
+            interceptor,
+            EMPTY_URI);
+        assert(mintedTokenId == tokenId);
+        
     }
 
     /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
@@ -370,27 +429,37 @@ contract Registry is
     // 2) DO NOT use object type (e.g. POLCY, BUNDLE, STAKE) as parent type
     // 3) DO NOT use REGISTRY as object type
     // 2) DO NOT use PROTOCOL and "zeroObjectType"
-    function _setupValidObjectParentCombinations() 
+    function _setupValidCoreTypesAndCombinations() 
         private 
     {
-        // registry as parent, ONLY registry owner
-        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
-        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
-
-        // registry as parent, ONLY approved
-        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
+        _coreTypes[REGISTRY()] = true;
+        _coreTypes[SERVICE()] = true;
+        _coreTypes[TOKEN()] = true;
+        _coreTypes[INSTANCE()] = true;
+        _coreTypes[PRODUCT()] = true;
+        _coreTypes[POOL()] = true;
+        _coreTypes[DISTRIBUTION()] = true;
+        _coreTypes[DISTRIBUTOR()] = true;
+        _coreTypes[ORACLE()] = true;
+        _coreTypes[POLICY()] = true;
+        _coreTypes[BUNDLE()] = true;
+        _coreTypes[STAKE()] = true;
+
+        _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
+        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
+        _coreContractCombinations[POOL()][INSTANCE()] = true;
 
-        // instance as parent, ONLY approved
-        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
-        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
-        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
-        _isValidContractCombination[POOL()][INSTANCE()] = true;
-
-        // product as parent, ONLY approved
-        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
+        if(registryId == _chainNft.GLOBAL_REGISTRY_ID()) 
+        {// we are global registry
+            _coreObjectCombinations[REGISTRY()][REGISTRY()] = true;
+        }
 
-        // pool as parent, ONLY approved
-        _isValidObjectCombination[BUNDLE()][POOL()] = true;
-        _isValidObjectCombination[STAKE()][POOL()] = true;
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+        _coreObjectCombinations[STAKE()][POOL()] = true;
     }
-}
+}

package/contracts/registry/RegistryAdmin.sol

@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+
+import {RoleId, RoleIdLib, GIF_MANAGER_ROLE, GIF_ADMIN_ROLE} from "../type/RoleId.sol";
+
+import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
+
+import {TokenRegistry} from "./TokenRegistry.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
+
+/*
+    1) GIF_MANAGER_ROLE
+        - can have arbitrary number of members
+        - responsible for services registrations
+        - responsible for token registration and activation
+    2) GIF_ADMIN_ROLE
+        - admin of GIF_MANAGER_ROLE
+        - MUST have 1 member at any time
+        - granted/revoked ONLY in transferAdminRole() -> consider lock out situations!!!
+        - responsible for creation and activation of releases
+
+*/
+
+contract RegistryAdmin is AccessManaged, Initializable 
+{
+    error ErrorRegistryAdminReleaseManagerAuthorityMismatch();
+    error ErrorRegistryAdminTokenRegistryZero();
+
+    string public constant GIF_ADMIN_ROLE_NAME = "GifAdminRole";
+    string public constant GIF_MANAGER_ROLE_NAME = "GifManagerRole";
+
+    string public constant RELEASE_MANAGER_TARGET_NAME = "ReleaseManager";
+    //string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistry";
+
+    uint64 public constant UNIQUE_ROLE_ID_MIN = 1000000;
+    
+    address private _releaseManager;
+    address private _tokenRegistry;
+
+    // IMPORTNAT: this.authority() must be valid before initialize() function
+    // -> have both, constructor and initializer
+    constructor()
+        AccessManaged(msg.sender)
+    {
+        AccessManagerExtendedInitializeable accessManager = new AccessManagerExtendedInitializeable();
+        accessManager.initialize(address(this));
+        setAuthority(address(accessManager));
+    }
+
+    /// @dev any body can call this function
+    function initialize(address admin, address manager, address releaseManager, address tokenRegistry)
+        external
+        initializer
+    {
+        // validate input
+        if(AccessManaged(releaseManager).authority() != authority()) {
+            revert ErrorRegistryAdminReleaseManagerAuthorityMismatch();
+        }
+        if(tokenRegistry == address(0)) {
+            revert ErrorRegistryAdminTokenRegistryZero();
+        }
+
+        _releaseManager = releaseManager;
+        _tokenRegistry = tokenRegistry;
+
+        _createRole(GIF_ADMIN_ROLE(), GIF_ADMIN_ROLE_NAME);
+        _createRole(GIF_MANAGER_ROLE(), GIF_MANAGER_ROLE_NAME);
+
+        _createTarget(_releaseManager, RELEASE_MANAGER_TARGET_NAME);
+        //_createTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME);
+
+        _setGifAdminRole();
+        _setGifManagerRole();
+
+        _grantRole(GIF_ADMIN_ROLE(), admin, 0);
+        _grantRole(GIF_MANAGER_ROLE(), manager, 0);
+
+        _setRoleAdmin(GIF_MANAGER_ROLE(), GIF_ADMIN_ROLE());
+    }
+    // in instance access mamanger it done differently -> instance have role and calls instance access manager revoke()/grant()
+    /*function transferAdmin(address to)
+        external
+        restricted // only with GIF_ADMIN_ROLE or nft owner
+    {
+        _accessManager.revoke(GIF_ADMIN_ROLE, );
+        _accesssManager.grant(GIF_ADMIN_ROLE, to, 0);
+    }*/
+
+    //--- view functions ----------------------------------------------------//
+
+    //--- private functions -------------------------------------------------//
+
+    function _setGifAdminRole() private
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // for ReleaseManager
+        functionSelector[0] = ReleaseManager.createNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_ADMIN_ROLE());
+
+        functionSelector[0] = ReleaseManager.activateNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_ADMIN_ROLE());
+    }
+    
+    function _setGifManagerRole() private 
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // for TokenRegistry
+        //functionSelector[0] = TokenRegistry.setActive.selector;
+        //_setTargetFunctionRole(_tokenRegistry, functionSelector, GIF_MANAGER_ROLE());
+
+        // for ReleaseManager
+        functionSelector[0] = ReleaseManager.registerService.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+
+        functionSelector[0] = ReleaseManager.prepareNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+    }
+
+    function _setTargetFunctionRole(address target, bytes4[] memory selectors, RoleId roleId) private {
+        AccessManagerExtendedInitializeable(authority()).setTargetFunctionRole(target, selectors, roleId.toInt());        
+    }
+
+    function _setRoleAdmin(RoleId roleId, RoleId adminRoleId) private {
+        AccessManagerExtendedInitializeable(authority()).setRoleAdmin(roleId.toInt(), adminRoleId.toInt());
+    }
+
+    function _grantRole(RoleId roleId, address account, uint32 executionDelay) private {
+        AccessManagerExtendedInitializeable(authority()).grantRole(roleId.toInt(), account, executionDelay);
+    }
+
+    function _createRole(RoleId roleId, string memory roleName) private {
+        AccessManagerExtendedInitializeable(authority()).createRole(roleId.toInt(), roleName);
+    }
+
+    function _createTarget(address target, string memory targetName) private {
+        AccessManagerExtendedInitializeable(authority()).createTarget(target, targetName);
+    }
+}