@etherisc/gif-next 0.0.2-bafc958-412 → 0.0.2-bb3faee-097

package/contracts/registry/RegistryAdmin.sol

@@ -1,23 +1,23 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
-import {AccessAdmin} from "../authorization/AccessAdmin.sol";
-import {IAccess} from "../authorization/IAccess.sol";
+import {IAuthorization} from "../authorization/IAuthorization.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, 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 {TokenHandler} from "../shared/TokenHandler.sol";
-import {TokenRegistry} from "./TokenRegistry.sol";
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {ObjectType, REGISTRY} from "../type/ObjectType.sol";
+import {RoleId, RoleIdLib, GIF_MANAGER_ROLE, GIF_ADMIN_ROLE} from "../type/RoleId.sol";
+import {Str} from "../type/String.sol";
 import {VersionPart} 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,440 +25,167 @@ 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
+        - 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
 {
+    /// @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 REGISTRY_SERVICE_ROLE_NAME = "RegistryServiceRole";
-    string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
-    string public constant STAKING_ROLE_NAME = "StakingRole";
 
+    /// @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_TARGET_HANDLER_NAME = "TargetHandler";
     string public constant STAKING_STORE_TARGET_NAME = "StakingStore";
+    string public constant STAKING_TH_TARGET_NAME = "StakingTH";
+    string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistry";
+    string public constant TOKEN_HANDLER_TARGET_NAME = "TokenHandler";
 
-    uint8 public constant MAX_NUM_RELEASES = 99;
-    // TODO consider deleting this
-    mapping(address service => VersionPart majorVersion) private _ServiceRelease;
+    // completeSetup
+    error ErrorRegistryAdminNotRegistry(address registry);
 
     address internal _registry;
     address private _releaseRegistry;
     address private _tokenRegistry;
     address private _staking;
+    address private _stakingTargetHandler;
     address private _stakingStore;
 
-    constructor() AccessAdmin() { }
+    constructor() {
+        initialize(
+            address(new AccessManagerCloneable()),
+            "RegistryAdmin");
+    }
+
 
     function completeSetup(
-        IRegistry registry,
+        address registry,
+        address authorization,
+        VersionPart release,
         address gifAdmin, 
         address gifManager
     )
-        external
-        initializer
+        public
+        virtual
+        reinitializer(type(uint8).max)
         onlyDeployer()
     {
-        _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);
-
-        _setupGifAdminRole(gifAdmin);
-        _setupGifManagerRole(gifManager);
-
-        _setupReleaseRegistry();
-        _setupRegistry();
-        _setupStaking();
-    }
+        // checks
+        AccessAdminLib.checkRegistry(registry);
 
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
 
-    /// @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,
-        ObjectType serviceDomain,
-        VersionPart releaseVersion
-    )
-        external
-        restricted()
-    {
-        _createServiceTargetAndRole(service, serviceDomain, releaseVersion);
-        _authorizeServiceFunctions(serviceAuthorization, service, serviceDomain, releaseVersion);
-    }
+        _checkAuthorization(authorization, REGISTRY(), release, false, true);
 
-    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));
-    }
+        _registry = registry;
+        _authorization = IAuthorization(authorization);
 
-    function grantServiceRoleForAllVersions(IService service, ObjectType domain)
-        external
-        restricted()
-    {
-        _grantRoleToAccount( 
-            RoleIdLib.roleForTypeAndAllVersions(domain),
-            address(service)); 
-    }
-
-    function revokeServiceRoleForAllVersions(IService service, ObjectType domain)
-        external
-        restricted()
-    {
-        _revokeRoleFromAccount(
-            RoleIdLib.roleForTypeAndAllVersions(domain), 
-            address(service));
-    }
+        IRegistry registryContract = IRegistry(registry);
+        _releaseRegistry = registryContract.getReleaseRegistryAddress();
+        _tokenRegistry = registryContract.getTokenRegistryAddress();
+        _staking = registryContract.getStakingAddress();
+        _stakingTargetHandler = address(IStaking(_staking).getTargetHandler());
+        _stakingStore = address(IStaking(_staking).getStakingStore());
 
-    /*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);
-    }*/
+        // link nft ownability to registry
+        _linkToNftOwnable(_registry);
 
-    //--- view functions ----------------------------------------------------//
+        // setup registry core targets
+        _createCoreTargets(_authorization.getMainTargetName());
 
-    function getGifAdminRole() external view returns (RoleId) {
-        return GIF_ADMIN_ROLE();
-    }
+        // setup non-contract roles
+        _createRoles(_authorization);
+        _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
+        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
 
-    function getGifManagerRole() external view returns (RoleId) {
-        return GIF_MANAGER_ROLE();
+        // authorize functions of registry and staking contracts
+        _createTargetAuthorizations(_authorization);
     }
 
-    //--- private functions -------------------------------------------------//
 
-    function _createServiceTargetAndRole(
+    function grantServiceRoleForAllVersions(
         IService service, 
-        ObjectType serviceDomain, 
-        VersionPart releaseVersion
+        ObjectType domain
     )
-        private
+        external
+        restricted()
     {
-        string memory baseName = ObjectTypeLib.toName(serviceDomain);
-        uint256 versionInt = releaseVersion.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, 
-            releaseVersion);
-
-        _createRole(
-            serviceRoleId, 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Contract,
-                maxMemberCount: 1,
-                name: ObjectTypeLib.toVersionedName(
-                    baseName, 
-                    "ServiceRole", 
-                    versionInt)}));
-
         _grantRoleToAccount( 
-            serviceRoleId,
+            RoleIdLib.toGenericServiceRoleId(domain),
             address(service)); 
     }
 
+    //--- view functions ----------------------------------------------------//
 
-    function _authorizeServiceFunctions(
-        IServiceAuthorization serviceAuthorization,
-        IService service,
-        ObjectType serviceDomain, 
-        VersionPart releaseVersion
-    )
-        private
-    {
-        ObjectType authorizedDomain;
-        RoleId authorizedRoleId;
-
-        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, 
-                releaseVersion);
-            }
-
-            // get authorized functions for authorized domain
-            IAccess.FunctionInfo[] memory authorizatedFunctions = serviceAuthorization.getAuthorizedFunctions(
-                serviceDomain, 
-                authorizedDomain);
+    function getGifAdminRole() external pure returns (RoleId) {
+        return GIF_ADMIN_ROLE();
+    }
 
-            _authorizeTargetFunctions(
-                    address(service), 
-                    authorizedRoleId, 
-                    authorizatedFunctions);
-        }
+    function getGifManagerRole() external pure returns (RoleId) {
+        return GIF_MANAGER_ROLE();
     }
 
     //--- private initialization 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);
-
-        _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
-    }
-    
-    function _setupGifManagerRole(address gifManager)
-        private 
-        onlyInitializing()
+    function _createRoles(IAuthorization authorization)
+        internal
     {
+        RoleId[] memory roles = authorization.getRoles();
 
-        _createRole(
-            GIF_MANAGER_ROLE(), 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Gif,
-                maxMemberCount: 1,
-                name: GIF_MANAGER_ROLE_NAME}));
-
-        // for TokenRegistry
-        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");
-        functions[3] = toFunction(TokenRegistry.setActiveForVersion.selector, "setActiveForVersion");
-        // TODO find a better way (only needed for testing)
-        functions[4] = toFunction(TokenRegistry.setActiveWithVersionCheck.selector, "setActiveWithVersionCheck");
-        _authorizeTargetFunctions(_tokenRegistry, 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(uint256 i = 0; i < roles.length; i++) {
+            RoleId roleId = roles[i];
+            RoleInfo memory roleInfo = authorization.getRoleInfo(roleId);
 
-        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
+            // create role if not exists
+            if (!roleExists(roleInfo.name.toString())) {
+                _createRole(
+                    roleId,
+                    roleInfo);
+            }
+        }
     }
 
 
-    function _setupReleaseRegistry()
-        private 
-        onlyInitializing()
+    function _createCoreTargets(string memory registryTargetName)
+        internal
     {
-
-        _createTarget(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, true, false);
-
-        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");
-        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);
+        // registry
+        _createUncheckedTarget(_registry, registryTargetName, TargetType.Core);
+        _createUncheckedTarget(address(this), REGISTRY_ADMIN_TARGET_NAME, TargetType.Core);
+        _createUncheckedTarget(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, TargetType.Core);
+        _createUncheckedTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME, TargetType.Core);
+
+        // staking
+        _createUncheckedTarget(_staking, STAKING_TARGET_NAME, TargetType.Core);
+        _createUncheckedTarget(_stakingTargetHandler, STAKING_TARGET_HANDLER_NAME, TargetType.Core);
+        _createUncheckedTarget(_stakingStore, STAKING_STORE_TARGET_NAME, TargetType.Core);
     }
 
 
-    function _setupRegistry()
+    function _createTargetAuthorizations(IAuthorization authorization)
         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);
-    }
+        Str[] memory targets = authorization.getTargets();
+        Str target;
 
+        for(uint256 i = 0; i < targets.length; i++) {
+            target = targets[i];
+            RoleId[] memory authorizedRoles = authorization.getAuthorizedRoles(target);
 
-    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, 
-            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");
-        functions[3] = toFunction(IStaking.refillRewardReserves.selector, "refillRewardReserves");
-        functions[4] = toFunction(IStaking.withdrawRewardReserves.selector, "withdrawRewardReserves");
-        functions[5] = toFunction(IStaking.createStake.selector, "createStake");
-        functions[6] = toFunction(IStaking.stake.selector, "stake");
-        functions[7] = toFunction(IStaking.unstake.selector, "unstake");
-        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
-        RoleId poolServiceRoleId = RoleIdLib.roleForTypeAndAllVersions(POOL());
-        _createRole(
-            poolServiceRoleId, 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Contract,
-                maxMemberCount: MAX_NUM_RELEASES,
-                name: POOL_SERVICE_ROLE_NAME}));
-
-        // staking function authorizations
-        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 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);
+            for(uint256 j = 0; j < authorizedRoles.length; j++) {
+                _authorizeFunctions(authorization, target, authorizedRoles[j]);
+            }
+        }
     }
 }