@etherisc/gif-next 0.0.2-9c44ae6-473 → 0.0.2-9d3eab3-323

package/contracts/registry/RegistryAccessManager.sol

@@ -0,0 +1,210 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
+
+import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
+import {RoleId, RoleIdLib,
+        REGISTRY_SERVICE_MANAGER_ROLE,
+        REGISTRY_SERVICE_ADMIN_ROLE,
+        RELEASE_MANAGER_ROLE} from "../types/RoleId.sol";
+
+import {Registry} from "./Registry.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {IRegistryService} from "./IRegistryService.sol";
+import {TokenRegistry} from "./TokenRegistry.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
+
+/*
+    3 types of roles: 
+    1) REGISTRAR roles 
+        - each one is unique
+        - always have 1 member
+        - one role is set for each function of each version of registry service
+    2) REGISTRY_SERVICE_MANAGER_ROLE aka GIF_MANAGER_ROLE
+        - can have arbitrary number of members
+        - responsible for services registrations
+        - responsible for token registration and activation
+    3) REGISTRY_SERVICE_ADMIN_ROLE aka GIF_ADMIN_ROLE
+        - admin of REGISTRY_SERVICE_MANAGER_ROLE
+        - MUST have 1 member at any time
+        - granted/revoked ONLY in transferAdminRole() -> consider lock out situations!!!
+        - responsible for release manager initialization
+        - responsible for creation and activation of each release
+
+*/
+
+contract RegistryAccessManager is AccessManaged
+{
+    uint64 public constant CUSTOM_ROLE_ID_MIN = 1000000;
+    
+    AccessManager private _accessManager;
+    address private _releaseManager;
+    address private _tokenRegistry;
+
+    uint64 private _idNext; // role id
+    bool private _isInitialized;
+
+    modifier onlyOnce() {
+        if(_isInitialized) {
+            revert();
+        }
+        _;
+        _isInitialized = true;
+    }
+
+    modifier onlyInitialized() {
+        if(!_isInitialized) {
+            revert();
+        }
+        _;
+    }
+
+    constructor(address manager)
+        AccessManaged(msg.sender)
+    {
+        _accessManager = new AccessManager(address(this));
+        setAuthority(address(_accessManager));
+
+        _idNext = CUSTOM_ROLE_ID_MIN;
+
+        _configureAdminRoleInitial();
+
+        address admin = msg.sender;
+        _grantRole(REGISTRY_SERVICE_ADMIN_ROLE(), admin, 0);
+        _grantRole(REGISTRY_SERVICE_MANAGER_ROLE(), manager, 0);
+    }
+
+    // TODO need release manager authorization to configure roles for service functions and to grant those roles
+    function initialize(address releaseManager, address tokenRegistry)
+        external 
+        restricted // GIF_ADMIN_ROLE
+        onlyOnce
+    {
+        if(
+            _releaseManager > address(0) ||
+            _tokenRegistry > address(0))
+        { revert(); }
+
+        _releaseManager = releaseManager;
+        _tokenRegistry = tokenRegistry;
+
+        _configureAdminRole();
+        _configureManagerRole();
+        _configureReleaseManagerRole();
+
+        _grantRole(RELEASE_MANAGER_ROLE(), releaseManager, 0);
+    }
+
+    // set unique role for target, role forever have 1 member and never revoked
+    function setAndGrantUniqueRole(
+        address account, 
+        address target, 
+        bytes4[] memory selector
+    )
+        external
+        restricted // RELEASE_MANAGER_ROLE
+        onlyInitialized
+        returns(RoleId)
+    {
+        // target is not part of `runtime`
+        if(
+            target == address(this) ||
+            target == address(_accessManager) || 
+            target == _releaseManager || 
+            target == _tokenRegistry)
+        { revert(); }
+
+        RoleId roleId = _getNextRoleId();
+
+        _setTargetFunctionRole(target, selector, roleId);
+        _grantRole(roleId, account, 0);
+    }
+
+    /*function transferAdmin(address to)
+        external
+        restricted // only with REGISTRY_SERVICE_ADMIN_ROLE or nft owner
+    {
+        _accessManager.revoke(REGISTRY_SERVICE_ADMIN_ROLE, );
+        _accesssManager.grant(REGISTRY_SERVICE_ADMIN_ROLE, to, 0);
+    }*/
+
+    //--- view functions ----------------------------------------------------//
+
+    function getAccessManager()
+        external
+        view
+        returns (AccessManager)
+    {
+        return _accessManager;
+    }
+
+    //--- private functions -------------------------------------------------//
+
+    function _configureAdminRoleInitial() private
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        functionSelector[0] = RegistryAccessManager.initialize.selector;
+        _setTargetFunctionRole(address(this), functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+    }
+
+    function _configureAdminRole() private
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // REGISTRY_SERVICE_ADMIN_ROLE for RegistryServiceProxyManager
+        // TODO upgrading with releaseManager.upgrade()->proxy.upgrade()???
+        //functionSelector[0] = RegistryServiceManager.upgrade.selector;
+        //_setTargetFunctionRole(address(this), functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+
+        // REGISTRY_SERVICE_ADMIN_ROLE for TokenRegistry
+
+        // REGISTRY_SERVICE_ADMIN_ROLE for ReleaseManager
+        functionSelector[0] = ReleaseManager.createNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+        //functionSelector[0] = ReleaseManager.activateNextRelease.selector;
+        //_setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+    }
+    
+    function _configureManagerRole() private 
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // REGISTRY_SERVICE_MANAGER_ROLE for TokenRegistry
+        functionSelector[0] = TokenRegistry.setActive.selector;
+        _setTargetFunctionRole(address(_tokenRegistry), functionSelector, REGISTRY_SERVICE_MANAGER_ROLE());
+
+        // REGISTRY_SERVICE_MANAGER_ROLE for ReleaseManager
+        functionSelector[0] = ReleaseManager.registerService.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_MANAGER_ROLE());
+
+        // set REGISTRY_SERVICE_ADMIN_ROLE as admin for REGISTRY_SERVICE_MANAGER_ROLE
+        _setRoleAdmin(REGISTRY_SERVICE_MANAGER_ROLE(), REGISTRY_SERVICE_ADMIN_ROLE());
+    }
+
+    function _configureReleaseManagerRole() private
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        functionSelector[0] = RegistryAccessManager.setAndGrantUniqueRole.selector;
+        _setTargetFunctionRole(address(this), functionSelector, RELEASE_MANAGER_ROLE());
+    }
+
+    function _setTargetFunctionRole(address target, bytes4[] memory selectors, RoleId roleId) private {
+        _accessManager.setTargetFunctionRole(target, selectors, roleId.toInt());        
+    }
+
+    function _setRoleAdmin(RoleId roleId, RoleId adminRoleId) private {
+        _accessManager.setRoleAdmin(roleId.toInt(), adminRoleId.toInt());
+    }
+
+    function _grantRole(RoleId roleId, address account, uint32 executionDelay) private {
+            _accessManager.grantRole(roleId.toInt(), account, executionDelay);
+    }
+
+    function _getNextRoleId() private returns(RoleId roleId) {
+        roleId = RoleIdLib.toRoleId(_idNext++);
+    }
+}

package/contracts/registry/RegistryService.sol

@@ -16,6 +16,7 @@ import {IDistributionComponent} from "../../contracts/components/IDistributionCo
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
+import {Registerable} from "../../contracts/shared/Registerable.sol";
 
 import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
 import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, POLICY, BUNDLE, STAKE} from "../../contracts/types/ObjectType.sol";
@@ -36,46 +37,11 @@ contract RegistryService is
 {
     using NftIdLib for NftId;
 
-
-    // Initial value for constant variable has to be compile-time constant
-    // TODO define types as constants?
-    //ObjectType public constant SERVICE_TYPE = REGISTRY(); 
-    string public constant NAME = "RegistryService";
-
     // TODO update to real hash when registry is stable
     bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
 
     address public constant NFT_LOCK_ADDRESS = address(0x1);
 
-    /// @dev 
-    //  msg.sender - ONLY registry owner
-    //      CAN NOT register itself
-    //      CAN register ONLY valid object-parent types combinations for SERVICE
-    //      CAN register ONLY IRegisterable address he owns
-    // IMPORTANT: MUST NOT check owner before calling external contract
-    function registerService(IService service)
-        external
-        restricted
-        returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) 
-    {
-
-        // CAN revert if no ERC165 support -> will revert with empty message 
-        if(!service.supportsInterface(type(IService).interfaceId)) {
-            revert NotService();
-        }
-
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
-
-        info.nftId = _registry.register(info);
-        service.linkToRegisteredNftId();
-        return (info, data);
-    }
 
     function registerInstance(IRegisterable instance)
         external
@@ -88,10 +54,7 @@ contract RegistryService is
             revert NotInstance();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
+        (info, data) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
 
         info.nftId = _registry.register(info);
         instance.linkToRegisteredNftId(); // asume safe
@@ -112,10 +75,7 @@ contract RegistryService is
             revert NotProduct();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
+        (info, data) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
 
         info.nftId = _registry.register(info);
         // TODO unsafe, let component or its owner derive nftId latter, when state assumptions and modifications of GIF contracts are finished  
@@ -136,10 +96,7 @@ contract RegistryService is
             revert NotPool();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(pool, POOL(), owner);
+        (info, data) = _getAndVerifyContractInfo(pool, POOL(), owner);
 
         info.nftId = _registry.register(info);
         pool.linkToRegisteredNftId();
@@ -159,10 +116,7 @@ contract RegistryService is
             revert NotDistribution();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
+        (info, data) = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
 
         info.nftId = _registry.register(info); 
         distribution.linkToRegisteredNftId();
@@ -201,21 +155,13 @@ contract RegistryService is
     }
 
     // From IService
-    function getName() public pure override(IService, Service) returns(string memory) {
-        return NAME;
+    function getDomain() public pure override(IService, Service) returns(ObjectType serviceDomain) {
+        return SERVICE(); 
     }
-    //function getType() public pure override(IService, ServiceBase) returns(ObjectType serviceType) {
-    //    return SERVICE_TYPE;
-    //}
-
 
     // from Versionable
 
     /// @dev top level initializer
-    // 1) registry is non upgradeable -> don't need a proxy and uses constructor !
-    // 2) deploy registry service first -> from its initialization func it is easier to deploy registry then vice versa
-    // 3) deploy registry -> pass registry service address as constructor argument
-    // registry is getting instantiated and locked to registry service address forever
     function _initialize(
         address owner, 
         bytes memory data
@@ -226,37 +172,66 @@ contract RegistryService is
     {
         (
             address initialAuthority,
-            bytes memory registryByteCodeWithInitCode
-        ) = abi.decode(data, (address, bytes));
+            address registry
+        ) = abi.decode(data, (address, address));
 
         __AccessManaged_init(initialAuthority);
 
-        bytes memory encodedConstructorArguments = abi.encode(
-            owner,
-            getMajorVersion());
+        _initializeService(address(registry), owner);
+
+        _registerInterface(type(IRegistryService).interfaceId);
+    }
+
+    // from IRegisterable
+
+    function getInitialInfo() 
+        public 
+        view
+        override(IRegisterable, Registerable)
+        returns (IRegistry.ObjectInfo memory info, bytes memory data)
+    {
+        (info , data) = super.getInitialInfo();
 
-        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
-            registryByteCodeWithInitCode,
-            encodedConstructorArguments);
+        FunctionConfig[] memory config = new FunctionConfig[](6);
 
-        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
-            registryCreationCode,
-            REGISTRY_CREATION_CODE_HASH));
+        // registerInstance() have no restriction
+        config[0].serviceDomain = INSTANCE();
+        config[0].selector = new bytes4[](1);
+        config[0].selector[0] = RegistryService.registerInstance.selector;
 
-        NftId registryNftId = registry.getNftId(address(registry));
+        config[1].serviceDomain = POOL();
+        config[1].selector = new bytes4[](1);
+        config[1].selector[0] = RegistryService.registerPool.selector;
 
-        _initializeService(address(registry), owner);
+        config[2].serviceDomain = DISTRIBUTION();
+        config[2].selector = new bytes4[](1);
+        config[2].selector[0] = RegistryService.registerDistribution.selector;
 
-        // TODO why do registry service proxy need to keep its nftId??? -> no registryServiceNftId checks in implementation
-        // if they are -> use registry address to obtain owner of registry service nft (works the same with any registerable and(or) implementation)
-        linkToRegisteredNftId(); 
-        _registerInterface(type(IRegistryService).interfaceId);
+        config[3].serviceDomain = PRODUCT();
+        config[3].selector = new bytes4[](1);
+        config[3].selector[0] = RegistryService.registerProduct.selector;
+
+        config[4].serviceDomain = POLICY();
+        config[4].selector = new bytes4[](1);
+        config[4].selector[0] = RegistryService.registerPolicy.selector;
+
+        config[5].serviceDomain = BUNDLE();
+        config[5].selector = new bytes4[](1);
+        config[5].selector[0] = RegistryService.registerBundle.selector;
+
+        /*config[6].serviceDomain = STAKE();
+        config[6].selector = new bytes4[](1);
+        config[6].selector[0] = RegistryService.registerStake.selector;*/
+
+        data = abi.encode(config);
     }
 
+    // Internal
+
     function _getAndVerifyContractInfo(
         IRegisterable registerable,
         ObjectType expectedType, // assume can be valid only
-        address expectedOwner // assume can be 0
+        address expectedOwner // assume can be 0 when given by other service
     )
         internal
         view
@@ -305,10 +280,7 @@ contract RegistryService is
             revert InvalidParent(parentNftId);
         }*/
 
-        return(
-            info,
-            data
-        );
+        return(info, data);
     }
 
     function _verifyObjectInfo(

package/contracts/registry/RegistryServiceManager.sol

@@ -17,19 +17,18 @@ contract RegistryServiceManager is
 {
     bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
 
-    AccessManager private _accessManager;
-    RegistryService private _registryService; 
-    TokenRegistry private _tokenRegistry;
+    RegistryService private immutable _registryService; 
 
     /// @dev initializes proxy manager with registry service implementation and deploys registry
     constructor(
-        address accessManager
-    )
+        address initialAuthority, // used by implementation 
+        address registry) // used by implementation 
         ProxyManager()
     {
-        _accessManager = AccessManager(accessManager);
-
-        bytes memory initializationData = abi.encode(accessManager, type(Registry).creationCode);
+        // implementation's initializer func `data` argument
+        bytes memory initializationData = abi.encode(
+            initialAuthority,
+            registry); 
 
         IVersionable versionable = deploy(
             address(new RegistryService()), 
@@ -37,31 +36,20 @@ contract RegistryServiceManager is
 
         _registryService = RegistryService(address(versionable));
 
-        // link ownership of registry service manager ot nft owner of registry service
-        _linkToNftOwnable(
-            address(_registryService.getRegistry()),
-            address(_registryService));
-
-        // deploy token registry
-
-        // _tokenRegistry = new TokenRegistry(
-        //     address(_registryService.getRegistry()),
-        //     address(_registryService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        _isDeployed = true;
     }
 
-    //--- view functions ----------------------------------------------------//
+    // from IRegisterable
 
-    function getAccessManager()
-        external
-        view
-        returns (AccessManager)
+    // IMPORTANT: registry here and in constructor MUST be the same
+    function linkToNftOwnable(address registry)
+        public
+        onlyOwner
     {
-        return _accessManager;
+        _linkToNftOwnable(registry, address(_registryService));
     }
 
+    //--- view functions ----------------------------------------------------//
+
     function getRegistryService()
         external
         view
@@ -69,12 +57,4 @@ contract RegistryServiceManager is
     {
         return _registryService;
     }
-
-    function getTokenRegistry()
-        external
-        view
-        returns (TokenRegistry)
-    {
-        return _tokenRegistry;
-    }
 }