@etherisc/gif-next 0.0.2-92c50c2-136 → 0.0.2-9306579-093

package/contracts/registry/RegistryAdmin.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
-import {AccessAdmin} from "../shared/AccessAdmin.sol";
-import {IAccessAdmin} from "../shared/IAccessAdmin.sol";
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {IRegistry} from "./IRegistry.sol";
 import {IService} from "../shared/IService.sol";
-import {IServiceAuthorization} from "./IServiceAuthorization.sol";
+import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
 import {IStaking} from "../staking/IStaking.sol";
-import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
-import {ReleaseManager} from "./ReleaseManager.sol";
+import {ObjectType, ObjectTypeLib, ALL, REGISTRY, STAKING, POOL, RELEASE} from "../type/ObjectType.sol";
+import {ReleaseRegistry} from "./ReleaseRegistry.sol";
 import {RoleId, RoleIdLib, ADMIN_ROLE, GIF_MANAGER_ROLE, GIF_ADMIN_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {StakingStore} from "../staking/StakingStore.sol";
-import {STAKING} from "../type/ObjectType.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {TokenRegistry} from "./TokenRegistry.sol";
 import {VersionPart} from "../type/Version.sol";
 
@@ -26,33 +26,33 @@ import {VersionPart} from "../type/Version.sol";
         - MUST have 1 member at any time
         - granted/revoked ONLY in transferAdminRole() -> consider lock out situations!!!
         - responsible for creation and activation of releases
-
-    createServiceTarget(type, release)
-    createServiceRole(type,release)
-    getServiceRole(type, release)
 */
 contract RegistryAdmin is
     AccessAdmin
 {
-    error ErrorRegistryAdminIsAlreadySetUp();
-
     string public constant GIF_ADMIN_ROLE_NAME = "GifAdminRole";
     string public constant GIF_MANAGER_ROLE_NAME = "GifManagerRole";
-    string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
     string public constant POOL_SERVICE_ROLE_NAME = "PoolServiceRole";
+    string public constant RELEASE_REGISTRY_ROLE_NAME = "ReleaseRegistryRole";
+    string public constant REGISTRY_SERVICE_ROLE_NAME = "RegistryServiceRole";
+    string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
+    string public constant STAKING_ROLE_NAME = "StakingRole";
 
-    string public constant RELEASE_MANAGER_TARGET_NAME = "ReleaseManagerTarget";
-    string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistryTarget";
-    string public constant STAKING_TARGET_NAME = "StakingTarget";
-    string public constant STAKING_STORE_TARGET_NAME = "StakingStoreTarget";
+    string public constant REGISTRY_TARGET_NAME = "Registry";
+    string public constant RELEASE_REGISTRY_TARGET_NAME = "ReleaseRegistry";
+    string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistry";
+    string public constant STAKING_TARGET_NAME = "Staking";
+    string public constant STAKING_STORE_TARGET_NAME = "StakingStore";
 
+    uint8 public constant MAX_NUM_RELEASES = 99;
+    // TODO consider deleting this
     mapping(address service => VersionPart majorVersion) private _ServiceRelease;
 
-    address private _releaseManager;
+    address internal _registry;
+    address private _releaseRegistry;
     address private _tokenRegistry;
     address private _staking;
     address private _stakingStore;
-    bool private _setupCompleted;
 
     constructor() AccessAdmin() { }
 
@@ -62,24 +62,24 @@ contract RegistryAdmin is
         address gifManager
     )
         external
+        initializer
         onlyDeployer()
     {
-        if (_setupCompleted) { revert ErrorRegistryAdminIsAlreadySetUp(); } 
-        else { _setupCompleted = true; }
-
-        _releaseManager = registry.getReleaseManagerAddress();
+        _registry = address(registry);
+        _releaseRegistry = registry.getReleaseRegistryAddress();
         _tokenRegistry = registry.getTokenRegistryAddress();
         _staking = registry.getStakingAddress();
         _stakingStore = address(
             IStaking(_staking).getStakingStore());
 
         // at this moment all registry contracts are deployed and fully intialized
-        _createTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME);
+        _createTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME, true, false);
 
         _setupGifAdminRole(gifAdmin);
         _setupGifManagerRole(gifManager);
 
-        _setupReleaseManager();
+        _setupReleaseRegistry();
+        _setupRegistry();
         _setupStaking();
     }
 
@@ -89,15 +89,46 @@ contract RegistryAdmin is
     /// Permissioned function: Access is restricted to release manager.
     function authorizeService(
         IServiceAuthorization serviceAuthorization,
-        IService service
+        IService service,
+        ObjectType serviceDomain,
+        VersionPart releaseVersion
     )
         external
         restricted()
     {
-        _createServiceTargetAndRole(service);
-        _authorizeServiceFunctions(serviceAuthorization, service);
+        _createServiceTargetAndRole(service, serviceDomain, releaseVersion);
+        _authorizeServiceFunctions(serviceAuthorization, service, serviceDomain, releaseVersion);
     }
 
+    function grantServiceRole(
+        IService service,
+        ObjectType domain, 
+        VersionPart version
+    )
+        external
+        restricted()
+    {
+        _grantRoleToAccount( 
+            RoleIdLib.roleForTypeAndVersion(
+                domain, 
+                version),
+            address(service)); 
+    }
+
+    function revokeServiceRole(
+        IService service,
+        ObjectType domain, 
+        VersionPart version
+    )
+        external
+        restricted()
+    {
+        _revokeRoleFromAccount(
+            RoleIdLib.roleForTypeAndVersion(
+                domain, 
+                version), 
+            address(service));
+    }
 
     function grantServiceRoleForAllVersions(IService service, ObjectType domain)
         external
@@ -108,69 +139,88 @@ contract RegistryAdmin is
             address(service)); 
     }
 
+    function revokeServiceRoleForAllVersions(IService service, ObjectType domain)
+        external
+        restricted()
+    {
+        _revokeRoleFromAccount(
+            RoleIdLib.roleForTypeAndAllVersions(domain), 
+            address(service));
+    }
 
-    function _createServiceTargetAndRole(IService service)
+    /*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 getGifAdminRole() external view returns (RoleId) {
+        return GIF_ADMIN_ROLE();
+    }
+
+    function getGifManagerRole() external view returns (RoleId) {
+        return GIF_MANAGER_ROLE();
+    }
+
+    //--- private functions -------------------------------------------------//
+
+    function _createServiceTargetAndRole(
+        IService service, 
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    )
         private
     {
-        ObjectType domain = service.getDomain();
-        string memory baseName = ObjectTypeLib.toName(domain);
-        VersionPart version = service.getVersion().toMajorPart();
-        uint256 versionInt = version.toInt();
-        string memory versionName = "_v0";
-        string memory versionNumber = ObjectTypeLib.toString(versionInt);
-
-        if (versionInt >= 10) {
-            versionName = "_v";
-        }
+        string memory baseName = ObjectTypeLib.toName(serviceDomain);
+        uint256 versionInt = releaseVersion.toInt();
 
         // create service target
-        string memory serviceTargetName = string(
-            abi.encodePacked(
-                baseName,
-                "Service",
-                versionName,
-                versionNumber));
+        string memory serviceTargetName = ObjectTypeLib.toVersionedName(
+            baseName, "Service", versionInt);
 
         _createTarget(
             address(service), 
-            serviceTargetName);
+            serviceTargetName,
+            true,
+            false);
 
         // create service role
-        string memory serviceRoleName = string(
-            abi.encodePacked(
-                baseName,
-                "ServiceRole",
-                versionName,
-                versionNumber));
-
-        RoleId roleId = RoleIdLib.roleForTypeAndVersion(
-            domain, 
-            version);
+        RoleId serviceRoleId = RoleIdLib.roleForTypeAndVersion(
+            serviceDomain, 
+            releaseVersion);
 
         _createRole(
-            roleId, 
-            ADMIN_ROLE(), 
-            serviceRoleName,
-            1, // service roles must only be given to this unique service
-            true); // it must not be possible to remove this role once granted
+            serviceRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: 1,
+                name: ObjectTypeLib.toVersionedName(
+                    baseName, 
+                    "ServiceRole", 
+                    versionInt)}));
 
         _grantRoleToAccount( 
-            roleId,
+            serviceRoleId,
             address(service)); 
     }
 
 
     function _authorizeServiceFunctions(
         IServiceAuthorization serviceAuthorization,
-        IService service
+        IService service,
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
     )
         private
     {
-        ObjectType serviceDomain = service.getDomain();
         ObjectType authorizedDomain;
         RoleId authorizedRoleId;
 
-        VersionPart release = service.getVersion().toMajorPart();
         ObjectType[] memory authorizedDomains = serviceAuthorization.getAuthorizedDomains(serviceDomain);
 
         for (uint256 i = 0; i < authorizedDomains.length; i++) {
@@ -182,11 +232,11 @@ contract RegistryAdmin is
             } else {
                 authorizedRoleId = RoleIdLib.roleForTypeAndVersion(
                 authorizedDomain, 
-                release);
+                releaseVersion);
             }
 
             // get authorized functions for authorized domain
-            IAccessAdmin.Function[] memory authorizatedFunctions = serviceAuthorization.getAuthorizedFunctions(
+            IAccess.FunctionInfo[] memory authorizatedFunctions = serviceAuthorization.getAuthorizedFunctions(
                 serviceDomain, 
                 authorizedDomain);
 
@@ -197,50 +247,54 @@ contract RegistryAdmin is
         }
     }
 
-    /*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 getGifAdminRole() external view returns (RoleId) {
-        return GIF_ADMIN_ROLE();
-    }
-
-    function getGifManagerRole() external view returns (RoleId) {
-        return GIF_MANAGER_ROLE();
-    }
+    //--- private initialization functions -------------------------------------------//
 
-    //--- private functions -------------------------------------------------//
+    function _setupGifAdminRole(address gifAdmin) 
+        private 
+        onlyInitializing()
+    {
+        
+        _createRole(
+            GIF_ADMIN_ROLE(), 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Gif,
+                maxMemberCount: 2, // TODO decide on max member count
+                name: GIF_ADMIN_ROLE_NAME}));
+
+        // for Registry
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(IRegistry.registerRegistry.selector, "registerRegistry");
+        _authorizeTargetFunctions(_registry, GIF_ADMIN_ROLE(), functions);
+
+        // for ReleaseRegistry
+        functions = new FunctionInfo[](4);
+        functions[0] = toFunction(ReleaseRegistry.createNextRelease.selector, "createNextRelease");
+        functions[1] = toFunction(ReleaseRegistry.activateNextRelease.selector, "activateNextRelease");
+        functions[2] = toFunction(ReleaseRegistry.pauseRelease.selector, "pauseRelease");
+        functions[3] = toFunction(ReleaseRegistry.unpauseRelease.selector, "unpauseRelease");
+        _authorizeTargetFunctions(_releaseRegistry, GIF_ADMIN_ROLE(), functions);
 
-    function _setupGifAdminRole(address gifAdmin) private {
-        // TODO decide on max member count
-        _createRole(GIF_ADMIN_ROLE(), getAdminRole(), GIF_ADMIN_ROLE_NAME, 2, false);
         _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
-
-        // for ReleaseManager
-        Function[] memory functions;
-        functions = new Function[](4);
-        functions[0] = toFunction(ReleaseManager.createNextRelease.selector, "createNextRelease");
-        functions[1] = toFunction(ReleaseManager.activateNextRelease.selector, "activateNextRelease");
-        functions[2] = toFunction(ReleaseManager.pauseRelease.selector, "pauseRelease");
-        functions[3] = toFunction(ReleaseManager.unpauseRelease.selector, "unpauseRelease");
-        _authorizeTargetFunctions(_releaseManager, GIF_ADMIN_ROLE(), functions);
-
-        // for Staking
     }
     
-    function _setupGifManagerRole(address gifManager) private {
-        _createRole(GIF_MANAGER_ROLE(), GIF_ADMIN_ROLE(), GIF_MANAGER_ROLE_NAME, 1, false);
-        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
+    function _setupGifManagerRole(address gifManager)
+        private 
+        onlyInitializing()
+    {
+
+        _createRole(
+            GIF_MANAGER_ROLE(), 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Gif,
+                maxMemberCount: 1,
+                name: GIF_MANAGER_ROLE_NAME}));
 
         // for TokenRegistry
-        Function[] memory functions;
-        functions = new Function[](5);
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](5);
         functions[0] = toFunction(TokenRegistry.registerToken.selector, "registerToken");
         functions[1] = toFunction(TokenRegistry.registerRemoteToken.selector, "registerRemoteToken");
         functions[2] = toFunction(TokenRegistry.setActive.selector, "setActive");
@@ -249,42 +303,96 @@ contract RegistryAdmin is
         functions[4] = toFunction(TokenRegistry.setActiveWithVersionCheck.selector, "setActiveWithVersionCheck");
         _authorizeTargetFunctions(_tokenRegistry, GIF_MANAGER_ROLE(), functions);
 
-        // for ReleaseManager
-        functions = new Function[](2);
-        functions[0] = toFunction(ReleaseManager.prepareNextRelease.selector, "prepareNextRelease");
-        functions[1] = toFunction(ReleaseManager.registerService.selector, "registerService");
-        _authorizeTargetFunctions(_releaseManager, GIF_MANAGER_ROLE(), functions);
+        // for ReleaseRegistry
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(ReleaseRegistry.prepareNextRelease.selector, "prepareNextRelease");
+        functions[1] = toFunction(ReleaseRegistry.registerService.selector, "registerService");
+        _authorizeTargetFunctions(_releaseRegistry, GIF_MANAGER_ROLE(), functions);
 
-        // for Staking
+        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
     }
 
 
-    function _setupReleaseManager() private {
-        _createTarget(_releaseManager, RELEASE_MANAGER_TARGET_NAME);
+    function _setupReleaseRegistry()
+        private 
+        onlyInitializing()
+    {
 
-        RoleId releaseManagerRoleId = RoleIdLib.roleForType(RELEASE());
-        _createRole(releaseManagerRoleId, ADMIN_ROLE(), RELEASE_MANAGER_TARGET_NAME, 1, true);
-        _grantRoleToAccount(releaseManagerRoleId, _releaseManager);
+        _createTarget(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, true, false);
 
-        Function[] memory functions;
-        functions = new Function[](2);
+        RoleId releaseRegistryRoleId = RoleIdLib.roleForType(RELEASE());
+        _createRole(
+            releaseRegistryRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: 1,
+                name: RELEASE_REGISTRY_ROLE_NAME}));
+
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](5);
         functions[0] = toFunction(RegistryAdmin.authorizeService.selector, "authorizeService");
         functions[1] = toFunction(RegistryAdmin.grantServiceRoleForAllVersions.selector, "grantServiceRoleForAllVersions");
-        _authorizeTargetFunctions(address(this), releaseManagerRoleId, functions);
+        functions[2] = toFunction(RegistryAdmin.revokeServiceRoleForAllVersions.selector, "revokeServiceRoleForAllVersions");
+        functions[3] = toFunction(RegistryAdmin.grantServiceRole.selector, "grantServiceRole");
+        functions[4] = toFunction(RegistryAdmin.revokeServiceRole.selector, "revokeServiceRole");
+        _authorizeTargetFunctions(address(this), releaseRegistryRoleId, functions);
+
+        _grantRoleToAccount(releaseRegistryRoleId, _releaseRegistry);
     }
 
 
-    function _setupStaking() private {
-        _createTarget(_staking, STAKING_TARGET_NAME);
-        _createTarget(_stakingStore, STAKING_STORE_TARGET_NAME);
+    function _setupRegistry()
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _createTarget(_registry, REGISTRY_TARGET_NAME, true, false);
+
+        // registry function authorization for registry service
+        RoleId registryServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(REGISTRY());
+        _createRole(
+            registryServiceRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: MAX_NUM_RELEASES,
+                name: REGISTRY_SERVICE_ROLE_NAME}));
+
+        // authorize registry service
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(IRegistry.register.selector, "register");
+        functions[1] = toFunction(IRegistry.registerWithCustomType.selector, "registerWithCustomType");
+        _authorizeTargetFunctions(_registry, registryServiceRoleId, functions);
+
+        // authorize release registry
+        RoleId releaseRegistryRoleId = RoleIdLib.roleForType(RELEASE());
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(IRegistry.registerService.selector, "registerService");
+        _authorizeTargetFunctions(_registry, releaseRegistryRoleId, functions);
+    }
+
 
+    function _setupStaking()
+        private 
+        onlyInitializing()
+    {
+        _createTarget(_staking, STAKING_TARGET_NAME, true, false);
+        _createTarget(_stakingStore, STAKING_STORE_TARGET_NAME, true, false);
 
         // staking function authorization for staking service
         RoleId stakingServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(STAKING());
-        _createRole(stakingServiceRoleId, ADMIN_ROLE(), STAKING_SERVICE_ROLE_NAME, 1, true);
-
-        Function[] memory functions;
-        functions = new Function[](13);
+        _createRole(
+            stakingServiceRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: MAX_NUM_RELEASES,
+                name: STAKING_SERVICE_ROLE_NAME}));
+
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](13);
         functions[0] = toFunction(IStaking.registerTarget.selector, "registerTarget");
         functions[1] = toFunction(IStaking.setLockingPeriod.selector, "setLockingPeriod");
         functions[2] = toFunction(IStaking.setRewardRate.selector, "setRewardRate");
@@ -302,20 +410,31 @@ contract RegistryAdmin is
 
         // staking function authorization for pool service
         RoleId poolServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(POOL());
-        _createRole(poolServiceRoleId, ADMIN_ROLE(), POOL_SERVICE_ROLE_NAME, 1, true);
+        _createRole(
+            poolServiceRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: MAX_NUM_RELEASES,
+                name: POOL_SERVICE_ROLE_NAME}));
 
         // staking function authorizations
-        functions = new Function[](2);
+        functions = new FunctionInfo[](2);
         functions[0] = toFunction(IStaking.increaseTotalValueLocked.selector, "increaseTotalValueLocked");
         functions[1] = toFunction(IStaking.decreaseTotalValueLocked.selector, "decreaseTotalValueLocked");
         _authorizeTargetFunctions(_staking, poolServiceRoleId, functions);
 
         // staking store function authorizations
         RoleId stakingRoleId = RoleIdLib.roleForType(STAKING());
-        _createRole(stakingRoleId, ADMIN_ROLE(), STAKING_TARGET_NAME, 1, true);
-        _grantRoleToAccount(stakingRoleId, _staking);
-
-        functions = new Function[](14);
+        _createRole(
+            stakingRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: 1,
+                name: STAKING_ROLE_NAME}));
+
+        functions = new FunctionInfo[](14);
         functions[0] = toFunction(StakingStore.setStakingRate.selector, "setStakingRate");
         functions[1] = toFunction(StakingStore.createTarget.selector, "createTarget");
         functions[2] = toFunction(StakingStore.updateTarget.selector, "updateTarget");
@@ -331,5 +450,15 @@ contract RegistryAdmin is
         functions[12] = toFunction(StakingStore.claimUpTo.selector, "claimUpTo");
         functions[13] = toFunction(StakingStore.unstakeUpTo.selector, "unstakeUpTo");
         _authorizeTargetFunctions(_stakingStore, stakingRoleId, functions);
+        
+        _grantRoleToAccount(stakingRoleId, _staking);
+    
+        // grant token handler authorizations
+        IStaking staking = IStaking(_staking);
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
+        functions[1] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
+        
+        _authorizeTargetFunctions(address(staking.getTokenHandler()), stakingRoleId, functions);
     }
 }