@etherisc/gif-next 0.0.2-e1f23dc-329 → 0.0.2-e20063b-144

package/contracts/registry/RegistryAccessManager.sol

@@ -0,0 +1,216 @@
+// 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 {RoleId, RoleIdLib,
+        GIF_MANAGER_ROLE,
+        GIF_ADMIN_ROLE,
+        RELEASE_MANAGER_ROLE} from "../types/RoleId.sol";
+
+import {TokenRegistry} from "./TokenRegistry.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
+
+/*
+    4 types of roles:
+    1) RELEASE_MANAGER_ROLE
+        - has only ReleaseManager as member
+        - responsible for setting and granting of REGISTRAR roles
+    1) REGISTRAR roles
+        - set and granted by RELEASE_MANAGER_ROLE
+        - each has 1 unique member (regular service ver.X) (subject to change)
+        - each set to 1 target (registry service ver.X) and 1 selector (function of registry service ver.X) (subject to change)
+    2) GIF_MANAGER_ROLE
+        - can have arbitrary number of members
+        - responsible for services registrations
+        - responsible for token registration and activation
+    3) 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 RegistryAccessManager is AccessManaged
+{
+    error NotInitialized();
+    error AlreadyInitialized();
+
+    uint64 public constant UNIQUE_ROLE_ID_MIN = 1000000;
+    
+    AccessManager private immutable _accessManager;
+    address private _releaseManager;
+    address private _tokenRegistry;
+
+    uint64 private _idNext; // role id
+    bool private _isInitialized;
+
+    modifier onlyOnce() {
+        if(_isInitialized) {
+            revert AlreadyInitialized();
+        } 
+        _;
+        _isInitialized = true;
+    }
+
+    modifier onlyInitialized() {
+        if(!_isInitialized) {
+            revert NotInitialized();
+        }
+        _;
+    }
+
+    constructor(address manager)
+        AccessManaged(msg.sender)
+    {
+        _accessManager = new AccessManager(address(this));
+        setAuthority(address(_accessManager));
+
+        _idNext = UNIQUE_ROLE_ID_MIN;
+
+        _configureAdminRoleInitial();
+
+        address admin = msg.sender;
+        _grantRole(GIF_ADMIN_ROLE(), admin, 0);
+        _grantRole(GIF_MANAGER_ROLE(), manager, 0);
+    }
+
+    function initialize(address releaseManager, address tokenRegistry)
+        external 
+        restricted // GIF_ADMIN_ROLE
+        onlyOnce
+    {
+        require(
+            ReleaseManager(releaseManager).authority() == address(_accessManager),
+            "RegistryAccessManager: release manager authority is invalid");
+        require(tokenRegistry > address(0), "RegistryAccessManager: token registry is 0");
+        //require(tokenRegistry.authority() == address(_accessManager));
+
+        _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)
+    {
+        // TODO questionable check...
+        // target is not part of `runtime`
+        //if(
+        //    target == address(this) ||
+        //    target == address(_accessManager) || 
+        //    target == _releaseManager || 
+        //    target == _tokenRegistry)
+        //{ return TargetInvalid(); }
+
+        RoleId roleId = _getNextRoleId();
+
+        _setTargetFunctionRole(target, selector, roleId);
+        _grantRole(roleId, account, 0);
+    }
+
+    /*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 ----------------------------------------------------//
+
+    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, GIF_ADMIN_ROLE());
+    }
+
+    function _configureAdminRole() private
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // for RegistryServiceProxyManager
+        // TODO upgrading with releaseManager.upgrade()->proxy.upgrade()???
+        //functionSelector[0] = RegistryServiceManager.upgrade.selector;
+        //_setTargetFunctionRole(address(this), functionSelector, GIF_ADMIN_ROLE());
+
+        // for TokenRegistry
+
+        // 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 _configureManagerRole() private 
+    {
+        bytes4[] memory functionSelector = new bytes4[](1);
+
+        // for TokenRegistry
+        functionSelector[0] = TokenRegistry.setActive.selector;
+        _setTargetFunctionRole(address(_tokenRegistry), functionSelector, GIF_MANAGER_ROLE());
+
+        // for ReleaseManager
+        functionSelector[0] = ReleaseManager.registerService.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+
+        functionSelector[0] = ReleaseManager.registerRegistryService.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+
+        // set admin
+        _setRoleAdmin(GIF_MANAGER_ROLE(), GIF_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

@@ -2,13 +2,13 @@
 pragma solidity ^0.8.20;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+// import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
 import {IRegistry} from "./IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
 
 import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+import {IComponent} from "../../contracts/components/IComponent.sol";
 import {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
 import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
 import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
@@ -16,9 +16,10 @@ 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";
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE} from "../../contracts/types/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
 import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
@@ -30,81 +31,62 @@ import {IRegistryService} from "./IRegistryService.sol";
 import {Registry} from "./Registry.sol";
 
 contract RegistryService is
-    AccessManagedUpgradeable,
     Service,
     IRegistryService
 {
     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
-        ) 
-    {
+    // From IService
+    function getDomain() public pure override returns(ObjectType serviceDomain) {
+        return REGISTRY(); 
+    }
 
-        // CAN revert if no ERC165 support -> will revert with empty message 
-        if(!service.supportsInterface(type(IService).interfaceId)) {
-            revert NotService();
-        }
+    // from Versionable
 
+    /// @dev top level initializer
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer()
+    {
         (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+            address registryAddress,
+            address initialAuthority
+        ) = abi.decode(data, (address, address));
+
+        initializeService(registryAddress, initialAuthority, owner);
 
-        info.nftId = _registry.register(info);
-        service.linkToRegisteredNftId();
-        return (info, data);
+        registerInterface(type(IRegistryService).interfaceId);
     }
 
-    function registerInstance(IRegisterable instance)
+    function registerInstance(IRegisterable instance, address owner)
         external
+        restricted
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
         if(!instance.supportsInterface(type(IInstance).interfaceId)) {
             revert NotInstance();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
+        info = _getAndVerifyContractInfo(instance, INSTANCE(), owner);
+        info.nftId = getRegistry().register(info);
 
-        info.nftId = _registry.register(info);
         instance.linkToRegisteredNftId(); // asume safe
-        
-        return (info, data);
     }
 
-    function registerProduct(IBaseComponent product, address owner)
+    function registerProduct(IComponent product, address owner)
         external
         restricted
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
         // CAN revert if no ERC165 support -> will revert with empty message 
@@ -112,62 +94,47 @@ contract RegistryService is
             revert NotProduct();
         }
 
-        (
-            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  
-        product.linkToRegisteredNftId();
-
-        return (info, data);  
+        info = _getAndVerifyContractInfo(product, PRODUCT(), owner);
+        info.nftId = getRegistry().register(info);
     }
 
-    function registerPool(IBaseComponent pool, address owner)
+    function registerPool(IComponent pool, address owner)
         external
         restricted
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
         if(!pool.supportsInterface(type(IPoolComponent).interfaceId)) {
             revert NotPool();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(pool, POOL(), owner);
-
-        info.nftId = _registry.register(info);
-        pool.linkToRegisteredNftId();
-
-        return (info, data);  
+        info = _getAndVerifyContractInfo(pool, POOL(), owner);
+        info.nftId = getRegistry().register(info);
     }
 
-    function registerDistribution(IBaseComponent distribution, address owner)
+    function registerDistribution(IComponent distribution, address owner)
         external
         restricted
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
         if(!distribution.supportsInterface(type(IDistributionComponent).interfaceId)) {
             revert NotDistribution();
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
-
-        info.nftId = _registry.register(info); 
-        distribution.linkToRegisteredNftId();
+        info = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
+        info.nftId = getRegistry().register(info);
+    }
 
-        return (info, data);  
+    function registerDistributor(IRegistry.ObjectInfo memory info)
+        external
+        restricted 
+        returns(NftId nftId) 
+    {
+        _verifyObjectInfo(info, DISTRIBUTOR());
+        nftId = getRegistry().register(info);
     }
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
@@ -177,7 +144,7 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, POLICY());
 
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
@@ -187,7 +154,7 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, BUNDLE());
 
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerStake(IRegistry.ObjectInfo memory info)
@@ -197,78 +164,72 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, STAKE());
 
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
-    // From IService
-    function getName() public pure override(IService, Service) returns(string memory) {
-        return NAME;
-    }
-    //function getType() public pure override(IService, ServiceBase) returns(ObjectType serviceType) {
-    //    return SERVICE_TYPE;
-    //}
+    // from IRegisterable
 
+    function getFunctionConfigs()
+        external
+        pure
+        returns(
+            FunctionConfig[] memory config
+        )
+    {
+        config = new FunctionConfig[](8);
 
-    // from Versionable
+        // order of service registrations MUST be reverse to this array 
+        /*config[-1].serviceDomain = STAKE();
+        config[-1].selector = RegistryService.registerStake.selector;*/
 
-    /// @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
-    )
-        internal
-        initializer
-        virtual override
-    {
-        (
-            address initialAuthority,
-            bytes memory registryByteCodeWithInitCode
-        ) = abi.decode(data, (address, bytes));
+        config[0].serviceDomain = POLICY();
+        config[0].selectors = new bytes4[](0);
 
-        __AccessManaged_init(initialAuthority);
+        config[1].serviceDomain = APPLICATION();
+        config[1].selectors = new bytes4[](1);
+        config[1].selectors[0] = RegistryService.registerPolicy.selector;
 
-        bytes memory encodedConstructorArguments = abi.encode(
-            owner,
-            getMajorVersion());
+        config[2].serviceDomain = CLAIM();
+        config[2].selectors = new bytes4[](0);
 
-        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
-            registryByteCodeWithInitCode,
-            encodedConstructorArguments);
+        config[3].serviceDomain = PRODUCT();
+        config[3].selectors = new bytes4[](1);
+        config[3].selectors[0] = RegistryService.registerProduct.selector;
 
-        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
-            registryCreationCode,
-            REGISTRY_CREATION_CODE_HASH));
+        config[4].serviceDomain = POOL();
+        config[4].selectors = new bytes4[](1);
+        config[4].selectors[0] = RegistryService.registerPool.selector;
 
-        NftId registryNftId = registry.getNftId(address(registry));
+        // registration of bundle service must preceed registration of pool service
+        config[5].serviceDomain = BUNDLE();
+        config[5].selectors = new bytes4[](1);
+        config[5].selectors[0] = RegistryService.registerBundle.selector;
 
-        _initializeService(address(registry), owner);
+        config[6].serviceDomain = DISTRIBUTION();
+        config[6].selectors = new bytes4[](2);
+        config[6].selectors[0] = RegistryService.registerDistribution.selector;
+        config[6].selectors[1] = RegistryService.registerDistributor.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);
+        // registerInstance() have no restriction
+        config[7].serviceDomain = INSTANCE();
+        config[7].selectors = new bytes4[](1);
+        config[7].selectors[0] = RegistryService.registerInstance.selector;
     }
 
+    // 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
+        // view
         returns(
-            IRegistry.ObjectInfo memory info, 
-            bytes memory data
+            IRegistry.ObjectInfo memory info 
         )
     {
-        (
-            info, 
-            data
-        ) = registerable.getInitialInfo();
+        info = registerable.getInitialInfo();
         info.objectAddress = address(registerable);
 
         if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
@@ -277,13 +238,8 @@ contract RegistryService is
 
         address owner = info.initialOwner;
 
-        // solhint-disable-next-line 
-        if(expectedType == INSTANCE()) { 
-            // any address may create a new instance via instance service
-        } else {
-            if(owner != expectedOwner) { // registerable owner protection
-                revert NotRegisterableOwner(expectedOwner);
-            }
+        if(owner != expectedOwner) { // registerable owner protection
+            revert NotRegisterableOwner(expectedOwner);
         }
 
         if(owner == address(registerable)) {
@@ -297,18 +253,6 @@ contract RegistryService is
         if(getRegistry().isRegistered(owner)) { 
             revert RegisterableOwnerIsRegistered();
         }
-
-        /*NftId parentNftId = info.parentNftId;
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
-
-        if(parentInfo.objectType != parentType) { // parent registration + type
-            revert InvalidParent(parentNftId);
-        }*/
-
-        return(
-            info,
-            data
-        );
     }
 
     function _verifyObjectInfo(
@@ -334,25 +278,5 @@ contract RegistryService is
         if(getRegistry().isRegistered(owner)) { 
             revert RegisterableOwnerIsRegistered();
         }
-
-        // can catch all 3 if check that initialOwner is not registered
-        /*if(info.initialOwner == msg.sender) {
-            revert InitialOwnerIsParent();
-        }
-
-        if(info.initialOwner == address(this)) {
-            revert InitialOwnerIsService();
-        }
-
-        if(info.initialOwner == address(getRegistry())) {
-            revert InitialOwnerIsRegistry();
-        }*/
-
-        /*NftId parentNftId = info.parentNftId;
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
-
-        if(parentInfo.objectType != parentType) { // parent registration + type
-            revert InvalidParent(parentNftId);
-        }*/        
     }
 }