@etherisc/gif-next 0.0.2-ecbd488-936 → 0.0.2-ed1536c-164

package/contracts/registry/RegistryAccessManager.sol

@@ -0,0 +1,196 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
+import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
+import {AuthorityUtils} from "@openzeppelin/contracts/access/manager/AuthorityUtils.sol";
+
+import {AccessManagerUpgradeableInitializeable} from "../shared/AccessManagerUpgradeableInitializeable.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
+import {RoleId, RoleIdLib, GIF_MANAGER_ROLE, GIF_ADMIN_ROLE} from "../type/RoleId.sol";
+import {TokenRegistry} from "./TokenRegistry.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
+*/
+
+// grants GIF_ADMIN_ROLE to registry owner as registryOwner is transaction sender
+// grants GIF_MANAGER_ROLE to registry owner via contructor argument
+contract RegistryAccessManager is
+    AccessManaged
+{
+    uint64 public constant UNIQUE_ROLE_ID_MIN = 1000000;
+    
+    address private _releaseManager;
+    uint64 private _idNext; // role id
+
+
+    // IMPORTNAT: this.authority() must be valid before initialize() function....
+    // -> have constructor and initializer function
+    constructor(
+        address gifAdmin,
+        address gifManager
+    )
+        AccessManaged(msg.sender)
+    {
+        _releaseManager = msg.sender;
+
+        AccessManagerUpgradeableInitializeable accessManager = new AccessManagerUpgradeableInitializeable();
+        accessManager.initialize(address(this));
+        setAuthority(address(accessManager));
+
+        _idNext = UNIQUE_ROLE_ID_MIN;
+
+        _setAdminRole();
+        _setManagerRole();
+
+        _grantRole(GIF_ADMIN_ROLE(), gifAdmin, 0);
+        _grantRole(GIF_MANAGER_ROLE(), gifManager, 0);
+
+        // set gif manager role admin
+        _setRoleAdmin(GIF_MANAGER_ROLE(), GIF_ADMIN_ROLE());
+    }
+
+
+    function setTokenRegistry(
+        address tokenRegistry    
+    )
+        external
+        restricted() // GIF_ADMIN_ROLE
+    {
+        // for TokenRegistry
+        bytes4[] memory functionSelector = new bytes4[](5);
+        functionSelector[0] = TokenRegistry.registerToken.selector;
+        functionSelector[1] = TokenRegistry.registerRemoteToken.selector;
+        functionSelector[2] = TokenRegistry.setActive.selector;
+        functionSelector[3] = TokenRegistry.setActiveForVersion.selector;
+
+        // only needed for testing TODO find a better way
+        functionSelector[4] = TokenRegistry.setActiveWithVersionCheck.selector;
+        _setTargetFunctionRole(address(tokenRegistry), functionSelector, GIF_MANAGER_ROLE());
+    }
+
+
+    // 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
+        returns(RoleId)
+    {
+        // TODO define and add checks
+        RoleId roleId = _getNextRoleId();
+
+        _setTargetFunctionRole(target, selector, roleId);
+        _grantRole(roleId, account, 0);
+    }
+
+    function setTargetFunctionRole(
+        address target, 
+        bytes4[] memory selector,
+        RoleId roleId
+    )
+        external
+        restricted // RELEASE_MANAGER_ROLE
+    {
+        _setTargetFunctionRole(target, selector, roleId);
+    }
+
+    /*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 hasRole(
+        address account,
+        RoleId roleId
+    )
+        external
+        view
+        returns(bool)
+    {
+        (bool isMember, ) = AccessManager(authority()).hasRole(roleId.toInt(), account);
+        return isMember;
+    }
+
+
+    function canCall(
+        address account,
+        address target,
+        bytes4 functionSelector
+    )
+        external
+        view
+        returns(bool)
+    {
+        (bool immediate,) = AuthorityUtils.canCallWithDelay(
+            authority(),
+            account,
+            target,
+            functionSelector);
+
+        return immediate;
+    }
+
+    //--- private functions -------------------------------------------------//
+
+    function _setAdminRole() private
+    {
+        // for this contract
+        bytes4[] memory functionSelector = new bytes4[](1);
+        functionSelector[0] = RegistryAccessManager.setTokenRegistry.selector;
+
+        _setTargetFunctionRole(address(this), functionSelector, GIF_ADMIN_ROLE());
+
+        // for ReleaseManager
+        bytes4[] memory functionSelector2 = new bytes4[](3);
+        functionSelector2[0] = ReleaseManager.registerStaking.selector;
+        functionSelector2[1] = ReleaseManager.createNextRelease.selector;
+        functionSelector2[2] = ReleaseManager.activateNextRelease.selector;
+
+        _setTargetFunctionRole(_releaseManager, functionSelector2, GIF_ADMIN_ROLE());
+    }
+    
+    function _setManagerRole() private 
+    {
+        // for ReleaseManager
+        bytes4[] memory functionSelector = new bytes4[](2);
+        functionSelector[0] = ReleaseManager.registerService.selector; // for ReleaseManager
+        functionSelector[1] = ReleaseManager.prepareNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+    }
+
+
+    function _setTargetFunctionRole(address target, bytes4[] memory selectors, RoleId roleId) private {
+        AccessManager(authority()).setTargetFunctionRole(target, selectors, roleId.toInt());        
+    }
+
+    function _setRoleAdmin(RoleId roleId, RoleId adminRoleId) private {
+        AccessManager(authority()).setRoleAdmin(roleId.toInt(), adminRoleId.toInt());
+    }
+
+    function _grantRole(RoleId roleId, address account, uint32 executionDelay) private {
+        AccessManager(authority()).grantRole(roleId.toInt(), account, executionDelay);
+    }
+
+    function _getNextRoleId() private returns(RoleId roleId) {
+        roleId = RoleIdLib.toRoleId(_idNext++);
+    }
+}

package/contracts/registry/RegistryService.sol

@@ -2,27 +2,27 @@
 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 {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
-import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
-import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
+import {IComponent} from "../../contracts/shared/IComponent.sol";
+import {IPoolComponent} from "../../contracts/pool/IPoolComponent.sol";
+import {IProductComponent} from "../../contracts/product/IProductComponent.sol";
+import {IDistributionComponent} from "../../contracts/distribution/IDistributionComponent.sol";
 
 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 {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";
-import {Version, VersionPart, VersionLib} from "../../contracts/types/Version.sol";
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/type/RoleId.sol";
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE, STAKING, PRICE} from "../../contracts/type/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED} from "../../contracts/type/StateId.sol";
+import {NftId, NftIdLib} from "../../contracts/type/NftId.sol";
+import {Fee, FeeLib} from "../../contracts/type/Fee.sol";
+import {Version, VersionPart, VersionLib} from "../../contracts/type/Version.sol";
 
 import {Service} from "../shared/Service.sol";
 import {IService} from "../shared/IService.sol";
@@ -30,144 +30,144 @@ 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);
+    // From IService
+    function getDomain() public pure override returns(ObjectType serviceDomain) {
+        return REGISTRY(); 
+    }
 
-    /// @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 Versionable
+
+    /// @dev top level initializer
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer()
     {
+        (
+            address registryAddress,
+            address initialAuthority
+        ) = abi.decode(data, (address, address));
 
-        // CAN revert if no ERC165 support -> will revert with empty message 
-        if(!service.supportsInterface(type(IService).interfaceId)) {
-            revert NotService();
-        }
+        initializeService(registryAddress, initialAuthority, owner);
+        registerInterface(type(IRegistryService).interfaceId);
+    }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
 
-        info.nftId = _registry.register(info);
-        service.linkToRegisteredNftId();
-        return (info, data);
+    function registerStaking(IRegisterable staking, address owner)
+        external
+        virtual
+        restricted()
+        returns(
+            IRegistry.ObjectInfo memory info
+        )
+    {
+        info = _getAndVerifyContractInfo(staking, STAKING(), owner);
+        info.nftId = getRegistry().register(info);
     }
 
-    function registerInstance(IRegisterable instance)
+
+    function registerInstance(IRegisterable instance, address owner)
         external
+        virtual
+        restricted
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
         if(!instance.supportsInterface(type(IInstance).interfaceId)) {
-            revert NotInstance();
+            revert ErrorRegistryServiceNotInstance(address(instance));
         }
 
-        (
-            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 
         if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
-            revert NotProduct();
+            revert ErrorRegistryServiceNotProduct(address(product));
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
+        info = _getAndVerifyContractInfo(product, PRODUCT(), owner);
+        info.nftId = getRegistry().register(info);
+    }
 
-        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();
+    function registerComponent(
+        IComponent component, 
+        ObjectType objectType,
+        address initialOwner
+    )
+        external
+        restricted
+        returns(
+            IRegistry.ObjectInfo memory info
+        ) 
+    {
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!component.supportsInterface(type(IComponent).interfaceId)) {
+            revert ErrorRegistryServiceNotComponent(address(component));
+        }
 
-        return (info, data);  
+        info = _getAndVerifyContractInfo(component, objectType, initialOwner);
+        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();
+            revert ErrorRegistryServiceNotPool(address(pool));
         }
 
-        (
-            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();
+            revert ErrorRegistryServiceNotDistribution(address(distribution));
         }
 
-        (
-            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)
@@ -176,8 +176,7 @@ contract RegistryService is
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, POLICY());
-
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
@@ -186,8 +185,7 @@ contract RegistryService is
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, BUNDLE());
-
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerStake(IRegistry.ObjectInfo memory info)
@@ -196,119 +194,49 @@ contract RegistryService is
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, STAKE());
-
-        nftId = _registry.register(info);
-    }
-
-    // From IService
-    function getName() public pure override(IService, Service) returns(string memory) {
-        return NAME;
+        nftId = getRegistry().register(info);
     }
-    //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
-    )
-        internal
-        initializer
-        virtual override
-    {
-        (
-            address initialAuthority,
-            bytes memory registryByteCodeWithInitCode
-        ) = abi.decode(data, (address, bytes));
-
-        __AccessManaged_init(initialAuthority);
-
-        bytes memory encodedConstructorArguments = abi.encode(
-            owner,
-            getMajorVersion());
-
-        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
-            registryByteCodeWithInitCode,
-            encodedConstructorArguments);
-
-        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
-            registryCreationCode,
-            REGISTRY_CREATION_CODE_HASH));
 
-        NftId registryNftId = registry.getNftId(address(registry));
-
-        _initializeService(address(registry), owner);
-
-        // 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);
-    }
+    // 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
         returns(
-            IRegistry.ObjectInfo memory info, 
-            bytes memory data
+            IRegistry.ObjectInfo memory info 
         )
     {
-        (
-            info, 
-            data
-        ) = registerable.getInitialInfo();
-        info.objectAddress = address(registerable);
+        info = registerable.getInitialInfo();
+
+        if(info.objectAddress != address(registerable)) {
+            revert ErrorRegistryServiceRegisterableAddressInvalid(registerable, info.objectAddress);
+        }
 
         if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
-            revert UnexpectedRegisterableType(expectedType, info.objectType);
+            revert ErrorRegistryServiceRegisterableTypeInvalid(registerable, expectedType, info.objectType);
         }
 
         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 ErrorRegistryServiceRegisterableOwnerInvalid(registerable, expectedOwner, owner);
         }
 
         if(owner == address(registerable)) {
-            revert SelfRegistration();
+            revert ErrorRegistryServiceRegisterableSelfRegistration(registerable);
         }
 
         if(owner == address(0)) {
-            revert RegisterableOwnerIsZero();
+            revert ErrorRegistryServiceRegisterableOwnerZero(registerable);
         }
         
         if(getRegistry().isRegistered(owner)) { 
-            revert RegisterableOwnerIsRegistered();
+            revert ErrorRegistryServiceRegisterableOwnerRegistered(registerable, owner);
         }
-
-        /*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(
@@ -322,37 +250,17 @@ contract RegistryService is
         info.objectAddress = address(0);
 
         if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
-            revert UnexpectedRegisterableType(expectedType, info.objectType);
+            revert ErrorRegistryServiceObjectTypeInvalid(expectedType, info.objectType);
         }
 
         address owner = info.initialOwner;
 
         if(owner == address(0)) {
-            revert RegisterableOwnerIsZero();
+            revert ErrorRegistryServiceObjectOwnerZero(info.objectType);
         }
 
         if(getRegistry().isRegistered(owner)) { 
-            revert RegisterableOwnerIsRegistered();
-        }
-
-        // can catch all 3 if check that initialOwner is not registered
-        /*if(info.initialOwner == msg.sender) {
-            revert InitialOwnerIsParent();
+            revert ErrorRegistryServiceObjectOwnerRegistered(info.objectType, owner);
         }
-
-        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);
-        }*/        
     }
-}
+}