@etherisc/gif-next 0.0.2-b3a9c97-695 → 0.0.2-b3b68b6-318

package/contracts/registry/RegistryAdmin.sol

@@ -2,22 +2,26 @@
 pragma solidity ^0.8.20;
 
 import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {IAccess} from "../authorization/IAccess.sol";
+import {IComponent} from "../shared/IComponent.sol";
 import {IRegistry} from "./IRegistry.sol";
 import {IService} from "../shared/IService.sol";
 import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
 import {IStaking} from "../staking/IStaking.sol";
-import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
+import {ObjectType, ObjectTypeLib, ALL, COMPONENT, 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 {Staking} from "../staking/Staking.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";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 /*
     1) GIF_MANAGER_ROLE
         - can have arbitrary number of members
+        - responsible for release preparation
         - responsible for services registrations
         - responsible for token registration and activation
 
@@ -25,83 +29,88 @@ import {VersionPart} from "../type/Version.sol";
         - 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
-
-    createServiceTarget(type, release)
-    createServiceRole(type,release)
-    getServiceRole(type, release)
+        - responsible for creation, activation and locking/unlocking of releases
 */
+
+/// @dev The RegistryAdmin contract implements the central authorization for the GIF core contracts.
+/// These are the release independent registry and staking contracts and their respective helper contracts.
+/// The RegistryAdmin also manages the access from service contracts to the GIF core contracts
 contract RegistryAdmin is
     AccessAdmin
 {
-    error ErrorRegistryAdminIsAlreadySetUp();
-
+    /// @dev gif core roles
     string public constant GIF_ADMIN_ROLE_NAME = "GifAdminRole";
     string public constant GIF_MANAGER_ROLE_NAME = "GifManagerRole";
-    string public constant POOL_SERVICE_ROLE_NAME = "PoolServiceRole";
     string public constant RELEASE_REGISTRY_ROLE_NAME = "ReleaseRegistryRole";
-    string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
     string public constant STAKING_ROLE_NAME = "StakingRole";
 
+    /// @dev gif roles for external contracts
+    string public constant REGISTRY_SERVICE_ROLE_NAME = "RegistryServiceRole";
+    string public constant COMPONENT_SERVICE_ROLE_NAME = "ComponentServiceRole";
+    string public constant POOL_SERVICE_ROLE_NAME = "PoolServiceRole";
+    string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
+
+    /// @dev gif core targets
+    string public constant REGISTRY_ADMIN_TARGET_NAME = "RegistryAdmin";
+    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_TH_TARGET_NAME = "StakingTH";
     string public constant STAKING_STORE_TARGET_NAME = "StakingStore";
+    string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistry";
+    string public constant TOKEN_HANDLER_TARGET_NAME = "TokenHandler";
 
     uint8 public constant MAX_NUM_RELEASES = 99;
 
-    mapping(address service => VersionPart majorVersion) private _ServiceRelease;
-
+    address internal _registry;
     address private _releaseRegistry;
     address private _tokenRegistry;
     address private _staking;
     address private _stakingStore;
-    bool private _setupCompleted;
 
-    constructor() AccessAdmin() { }
+    constructor() {
+        initialize(new AccessManagerCloneable());
+    }
 
     function completeSetup(
         IRegistry registry,
         address gifAdmin, 
         address gifManager
     )
-        external
+        public
+        virtual
+        reinitializer(type(uint8).max)
         onlyDeployer()
     {
-        if (_setupCompleted) { revert ErrorRegistryAdminIsAlreadySetUp(); } 
-        else { _setupCompleted = true; }
+        AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+        accessManager.completeSetup(
+            address(registry), 
+            VersionPartLib.toVersionPart(type(uint8).max),
+            false); 
 
+        _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, true, false);
+        _createTargets();
 
         _setupGifAdminRole(gifAdmin);
         _setupGifManagerRole(gifManager);
 
-        _setupReleaseRegistry();
-        _setupStaking();
+        _setupRegistryRoles();
+        _setupStakingRoles();
     }
 
-
-    /// @dev Sets up authorizaion for specified service.
-    /// For all authorized services its authorized functions are enabled.
-    /// Permissioned function: Access is restricted to release manager.
-    function authorizeService(
-        IServiceAuthorization serviceAuthorization,
-        IService service
-    )
+    /*function transferAdmin(address to)
         external
-        restricted()
+        restricted // only with GIF_ADMIN_ROLE or nft owner
     {
-        _createServiceTargetAndRole(service);
-        _authorizeServiceFunctions(serviceAuthorization, service);
-    }
-
+        _accessManager.revoke(GIF_ADMIN_ROLE, );
+        _accesssManager.grant(GIF_ADMIN_ROLE, to, 0);
+    }*/
 
     function grantServiceRoleForAllVersions(IService service, ObjectType domain)
         external
@@ -112,92 +121,6 @@ contract RegistryAdmin is
             address(service)); 
     }
 
-
-    function _createServiceTargetAndRole(IService service)
-        private
-    {
-        ObjectType serviceDomain = service.getDomain();
-        string memory baseName = ObjectTypeLib.toName(serviceDomain);
-        VersionPart version = service.getVersion().toMajorPart();
-        uint256 versionInt = version.toInt();
-
-        // create service target
-        string memory serviceTargetName = ObjectTypeLib.toVersionedName(
-            baseName, "Service", versionInt);
-
-        _createTarget(
-            address(service), 
-            serviceTargetName,
-            true,
-            false);
-
-        // create service role
-        RoleId serviceRoleId = RoleIdLib.roleForTypeAndVersion(
-            serviceDomain, 
-            version);
-
-        _createRole(
-            serviceRoleId, 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Contract,
-                maxMemberCount: 1,
-                name: ObjectTypeLib.toVersionedName(
-                    baseName, 
-                    "ServiceRole", 
-                    versionInt)}));
-
-        _grantRoleToAccount( 
-            serviceRoleId,
-            address(service)); 
-    }
-
-
-    function _authorizeServiceFunctions(
-        IServiceAuthorization serviceAuthorization,
-        IService service
-    )
-        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++) {
-            authorizedDomain = authorizedDomains[i];
-
-            // derive authorized role from authorized domain
-            if (authorizedDomain == ALL()) {
-                authorizedRoleId = PUBLIC_ROLE();
-            } else {
-                authorizedRoleId = RoleIdLib.roleForTypeAndVersion(
-                authorizedDomain, 
-                release);
-            }
-
-            // get authorized functions for authorized domain
-            IAccess.FunctionInfo[] memory authorizatedFunctions = serviceAuthorization.getAuthorizedFunctions(
-                serviceDomain, 
-                authorizedDomain);
-
-            _authorizeTargetFunctions(
-                    address(service), 
-                    authorizedRoleId, 
-                    authorizatedFunctions);
-        }
-    }
-
-    /*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) {
@@ -208,10 +131,29 @@ contract RegistryAdmin is
         return GIF_MANAGER_ROLE();
     }
 
-    //--- private functions -------------------------------------------------//
+    //--- private initialization functions -------------------------------------------//
+
+    function _createTargets()
+        private 
+        onlyInitializing()
+    {
+        IStaking staking = IStaking(_staking);
+        address tokenHandler = address(staking.getTokenHandler());
+
+        _createTarget(address(this), REGISTRY_ADMIN_TARGET_NAME, false, false);
+        _createTarget(_registry, REGISTRY_TARGET_NAME, true, false);
+        _createTarget(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, true, false);
+        _createTarget(_staking, STAKING_TARGET_NAME, true, false);
+        _createTarget(_stakingStore, STAKING_STORE_TARGET_NAME, true, false);
+        _createTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME, true, false);
+        _createTarget(tokenHandler, TOKEN_HANDLER_TARGET_NAME, true, false);
+    }
 
-    function _setupGifAdminRole(address gifAdmin) private {
-        
+    function _setupGifAdminRole(address gifAdmin) 
+        private 
+        onlyInitializing()
+    {
+        // create gif admin role
         _createRole(
             GIF_ADMIN_ROLE(), 
             toRole({
@@ -220,29 +162,36 @@ contract RegistryAdmin is
                 maxMemberCount: 2, // TODO decide on max member count
                 name: GIF_ADMIN_ROLE_NAME}));
 
-        // for ReleaseRegistry
+        // grant permissions to the gif admin role for registry contract
         FunctionInfo[] memory functions;
-        functions = new FunctionInfo[](4);
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(IRegistry.registerRegistry.selector, "registerRegistry");
+        _authorizeTargetFunctions(_registry, GIF_ADMIN_ROLE(), functions);
+
+        // grant permissions to the gif admin role for release registry contract
+        functions = new FunctionInfo[](3);
         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");
+        functions[2] = toFunction(ReleaseRegistry.setActive.selector, "setActive");
         _authorizeTargetFunctions(_releaseRegistry, GIF_ADMIN_ROLE(), functions);
 
         _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
     }
     
-    function _setupGifManagerRole(address gifManager) private {
-
+    function _setupGifManagerRole(address gifManager)
+        private 
+        onlyInitializing()
+    {
+        // create gif manager role
         _createRole(
             GIF_MANAGER_ROLE(), 
             toRole({
                 adminRoleId: ADMIN_ROLE(),
                 roleType: RoleType.Gif,
-                maxMemberCount: 1,
+                maxMemberCount: 1, // TODO decide on max member count
                 name: GIF_MANAGER_ROLE_NAME}));
 
-        // for TokenRegistry
+        // grant permissions to the gif manager role for token registry contract
         FunctionInfo[] memory functions;
         functions = new FunctionInfo[](5);
         functions[0] = toFunction(TokenRegistry.registerToken.selector, "registerToken");
@@ -253,7 +202,7 @@ contract RegistryAdmin is
         functions[4] = toFunction(TokenRegistry.setActiveWithVersionCheck.selector, "setActiveWithVersionCheck");
         _authorizeTargetFunctions(_tokenRegistry, GIF_MANAGER_ROLE(), functions);
 
-        // for ReleaseRegistry
+        // grant permissions to the gif manager role for release registry contract
         functions = new FunctionInfo[](2);
         functions[0] = toFunction(ReleaseRegistry.prepareNextRelease.selector, "prepareNextRelease");
         functions[1] = toFunction(ReleaseRegistry.registerService.selector, "registerService");
@@ -262,11 +211,12 @@ contract RegistryAdmin is
         _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
     }
 
-
-    function _setupReleaseRegistry() private {
-
-        _createTarget(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, true, false);
-
+    function _setupRegistryRoles()
+        private
+        onlyInitializing()
+    {
+        // TODO use RELEASE_REGISTRY_ROLE instead
+        // create and grant release registry role
         RoleId releaseRegistryRoleId = RoleIdLib.roleForType(RELEASE());
         _createRole(
             releaseRegistryRoleId, 
@@ -275,22 +225,79 @@ contract RegistryAdmin is
                 roleType: RoleType.Contract,
                 maxMemberCount: 1,
                 name: RELEASE_REGISTRY_ROLE_NAME}));
+        _grantRoleToAccount(releaseRegistryRoleId, _releaseRegistry);
 
+        // grant permissions to the release registry role for release admin contract
         FunctionInfo[] memory functions;
-        functions = new FunctionInfo[](2);
-        functions[0] = toFunction(RegistryAdmin.authorizeService.selector, "authorizeService");
-        functions[1] = toFunction(RegistryAdmin.grantServiceRoleForAllVersions.selector, "grantServiceRoleForAllVersions");
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(RegistryAdmin.grantServiceRoleForAllVersions.selector, "grantServiceRoleForAllVersions");
         _authorizeTargetFunctions(address(this), releaseRegistryRoleId, functions);
 
-        _grantRoleToAccount(releaseRegistryRoleId, _releaseRegistry);
+        // grant permissions to the release registry role for registry contract
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(IRegistry.registerService.selector, "registerService");
+        _authorizeTargetFunctions(_registry, releaseRegistryRoleId, functions);
+
+        // create registry service role
+        RoleId registryServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(REGISTRY());
+        _createRole(
+            registryServiceRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: MAX_NUM_RELEASES,
+                name: REGISTRY_SERVICE_ROLE_NAME}));
+
+        // grant permissions to the registry service role for registry contract
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(IRegistry.register.selector, "register");
+        functions[1] = toFunction(IRegistry.registerWithCustomType.selector, "registerWithCustomType");
+        _authorizeTargetFunctions(_registry, registryServiceRoleId, functions);
     }
 
 
-    function _setupStaking() private {
-        _createTarget(_staking, STAKING_TARGET_NAME, true, false);
-        _createTarget(_stakingStore, STAKING_STORE_TARGET_NAME, true, false);
+    function _setupStakingRoles()
+        private 
+        onlyInitializing()
+    {
+        // create and grant staking contract role
+        RoleId stakingRoleId = RoleIdLib.roleForType(STAKING());
+        _createRole(
+            stakingRoleId, 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: 1,
+                name: STAKING_ROLE_NAME}));
+        _grantRoleToAccount(stakingRoleId, _staking);
 
-        // staking function authorization for staking service
+        // grant permissions to the staking role for staking store contract
+        FunctionInfo[] memory functions;
+        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");
+        functions[3] = toFunction(StakingStore.increaseReserves.selector, "increaseReserves");
+        functions[4] = toFunction(StakingStore.decreaseReserves.selector, "decreaseReserves");
+        functions[5] = toFunction(StakingStore.increaseTotalValueLocked.selector, "increaseTotalValueLocked");
+        functions[6] = toFunction(StakingStore.decreaseTotalValueLocked.selector, "decreaseTotalValueLocked");
+        functions[7] = toFunction(StakingStore.create.selector, "create");
+        functions[8] = toFunction(StakingStore.update.selector, "update");
+        functions[9] = toFunction(StakingStore.increaseStake.selector, "increaseStake");
+        functions[10] = toFunction(StakingStore.restakeRewards.selector, "restakeRewards");
+        functions[11] = toFunction(StakingStore.updateRewards.selector, "updateRewards");
+        functions[12] = toFunction(StakingStore.claimUpTo.selector, "claimUpTo");
+        functions[13] = toFunction(StakingStore.unstakeUpTo.selector, "unstakeUpTo");
+        _authorizeTargetFunctions(_stakingStore, stakingRoleId, functions);
+    
+        // grant permissions to the staking role for token handler contract
+        IStaking staking = IStaking(_staking);
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(TokenHandler.pullToken.selector, "pullToken");
+        functions[1] = toFunction(TokenHandler.pushToken.selector, "pushToken");
+        _authorizeTargetFunctions(address(staking.getTokenHandler()), stakingRoleId, functions);
+
+        // create staking service role
         RoleId stakingServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(STAKING());
         _createRole(
             stakingServiceRoleId, 
@@ -300,8 +307,8 @@ contract RegistryAdmin is
                 maxMemberCount: MAX_NUM_RELEASES,
                 name: STAKING_SERVICE_ROLE_NAME}));
 
-        FunctionInfo[] memory functions;
-        functions = new FunctionInfo[](13);
+        // grant permissions to the staking service role for staking contract
+        functions = new FunctionInfo[](11);
         functions[0] = toFunction(IStaking.registerTarget.selector, "registerTarget");
         functions[1] = toFunction(IStaking.setLockingPeriod.selector, "setLockingPeriod");
         functions[2] = toFunction(IStaking.setRewardRate.selector, "setRewardRate");
@@ -313,11 +320,17 @@ contract RegistryAdmin is
         functions[8] = toFunction(IStaking.restake.selector, "restake");
         functions[9] = toFunction(IStaking.updateRewards.selector, "updateRewards");
         functions[10] = toFunction(IStaking.claimRewards.selector, "claimRewards");
-        functions[11] = toFunction(IStaking.collectDipAmount.selector, "collectDipAmount");
-        functions[12] = toFunction(IStaking.transferDipAmount.selector, "transferDipAmount");
         _authorizeTargetFunctions(_staking, stakingServiceRoleId, functions);
 
-        // staking function authorization for pool service
+        // grant permissions to the staking service role for staking token handler
+        functions = new FunctionInfo[](3);
+        functions[0] = toFunction(TokenHandler.approve.selector, "approve");
+        functions[1] = toFunction(TokenHandler.pullToken.selector, "pullToken");
+        functions[2] = toFunction(TokenHandler.pushToken.selector, "pushToken");
+        _authorizeTargetFunctions(
+            address(IComponent(_staking).getTokenHandler()), stakingServiceRoleId, functions);
+
+        // create pool service role
         RoleId poolServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(POOL());
         _createRole(
             poolServiceRoleId, 
@@ -327,39 +340,15 @@ contract RegistryAdmin is
                 maxMemberCount: MAX_NUM_RELEASES,
                 name: POOL_SERVICE_ROLE_NAME}));
 
-        // staking function authorizations
+        // grant permissions to the pool service role for staking contract
         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, 
-            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");
-        functions[3] = toFunction(StakingStore.increaseReserves.selector, "increaseReserves");
-        functions[4] = toFunction(StakingStore.decreaseReserves.selector, "decreaseReserves");
-        functions[5] = toFunction(StakingStore.increaseTotalValueLocked.selector, "increaseTotalValueLocked");
-        functions[6] = toFunction(StakingStore.decreaseTotalValueLocked.selector, "decreaseTotalValueLocked");
-        functions[7] = toFunction(StakingStore.create.selector, "create");
-        functions[8] = toFunction(StakingStore.update.selector, "update");
-        functions[9] = toFunction(StakingStore.increaseStake.selector, "increaseStake");
-        functions[10] = toFunction(StakingStore.restakeRewards.selector, "restakeRewards");
-        functions[11] = toFunction(StakingStore.updateRewards.selector, "updateRewards");
-        functions[12] = toFunction(StakingStore.claimUpTo.selector, "claimUpTo");
-        functions[13] = toFunction(StakingStore.unstakeUpTo.selector, "unstakeUpTo");
-        _authorizeTargetFunctions(_stakingStore, stakingRoleId, functions);
-
-        _grantRoleToAccount(stakingRoleId, _staking);
+        // grant permissions to public role for staking contract
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(Staking.approveTokenHandler.selector, "approveTokenHandler");
+        _authorizeTargetFunctions(_staking, PUBLIC_ROLE(), functions);
     }
 }