@etherisc/gif-next 0.0.2-e026265-044 → 0.0.2-e04dbfc-031

package/contracts/registry/RegistryAdmin.sol

@@ -1,23 +1,30 @@
 // 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 {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 {ReleaseManager} from "./ReleaseManager.sol";
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
+import {ObjectType, 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 {Str, StrLib} from "../type/String.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,85 +32,105 @@ 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 RELEASE_REGISTRY_ROLE_NAME = "ReleaseRegistryRole";
+    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 RELEASE_MANAGER_ROLE_NAME = "ReleaseManagerRole";
     string public constant STAKING_SERVICE_ROLE_NAME = "StakingServiceRole";
-    string public constant STAKING_ROLE_NAME = "StakingRole";
 
-    string public constant RELEASE_MANAGER_TARGET_NAME = "ReleaseManager";
-    string public constant TOKEN_REGISTRY_TARGET_NAME = "TokenRegistry";
+    /// @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 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;
+    // completeSetup
+    error ErrorRegistryAdminNotRegistry(address registry);
 
-    address private _releaseManager;
+    address internal _registry;
+    address private _releaseRegistry;
     address private _tokenRegistry;
     address private _staking;
     address private _stakingStore;
-    bool private _setupCompleted;
 
-    constructor() AccessAdmin() { }
+    constructor() {
+        initialize(
+            address(new AccessManagerCloneable()),
+            "RegistryAdmin");
+    }
+
 
     function completeSetup(
-        IRegistry registry,
+        address registry,
+        address authorization,
         address gifAdmin, 
         address gifManager
     )
-        external
+        public
+        virtual
+        reinitializer(type(uint8).max)
         onlyDeployer()
     {
-        if (_setupCompleted) { revert ErrorRegistryAdminIsAlreadySetUp(); } 
-        else { _setupCompleted = true; }
+        // checks
+        _checkRegistry(registry);
 
-        _releaseManager = registry.getReleaseManagerAddress();
-        _tokenRegistry = registry.getTokenRegistryAddress();
-        _staking = registry.getStakingAddress();
+        VersionPart release = VersionPartLib.toVersionPart(3);
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
+
+        _checkAuthorization(authorization, REGISTRY(), release, true);
+
+        _registry = registry;
+        _authorization = IAuthorization(authorization);
+
+        IRegistry registryContract = IRegistry(registry);
+        _releaseRegistry = registryContract.getReleaseRegistryAddress();
+        _tokenRegistry = registryContract.getTokenRegistryAddress();
+        _staking = registryContract.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);
+        // link nft ownability to registry
+        _linkToNftOwnable(_registry);
 
-        _setupGifAdminRole(gifAdmin);
-        _setupGifManagerRole(gifManager);
-
-        _setupReleaseManager();
-        _setupStaking();
-    }
+        _setupRegistry(_registry);
 
+        // setup authorization for registry and supporting contracts
+        _createRoles(_authorization);
+        _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
+        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
 
-    /// @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
-    )
-        external
-        restricted()
-    {
-        _createServiceTargetAndRole(service);
-        _authorizeServiceFunctions(serviceAuthorization, service);
+        _createTargets(_authorization);
+        _createTargetAuthorizations(_authorization);
     }
 
 
-    function grantServiceRoleForAllVersions(IService service, ObjectType domain)
+
+    function grantServiceRoleForAllVersions(
+        IService service, 
+        ObjectType domain
+    )
         external
         restricted()
     {
@@ -112,254 +139,120 @@ contract RegistryAdmin is
             address(service)); 
     }
 
+    //--- view functions ----------------------------------------------------//
 
-    function _createServiceTargetAndRole(IService service)
-        private
-    {
-        ObjectType serviceDomain = service.getDomain();
-        string memory baseName = ObjectTypeLib.toName(serviceDomain);
-        VersionPart version = service.getVersion().toMajorPart();
-        uint256 versionInt = version.toInt();
+    function getGifAdminRole() external view returns (RoleId) {
+        return GIF_ADMIN_ROLE();
+    }
 
-        // create service target
-        string memory serviceTargetName = ObjectTypeLib.toVersionedName(
-            baseName, "Service", versionInt);
+    function getGifManagerRole() external view returns (RoleId) {
+        return GIF_MANAGER_ROLE();
+    }
 
-        _createTarget(
-            address(service), 
-            serviceTargetName,
-            true,
-            false);
+    //--- private initialization functions -------------------------------------------//
+
+    // create registry role and target
+    function _setupRegistry(address registry) internal {
 
-        // create service role
-        RoleId serviceRoleId = RoleIdLib.roleForTypeAndVersion(
-            serviceDomain, 
-            version);
+        // create registry role
+        RoleId roleId = _authorization.getTargetRole(
+            _authorization.getMainTarget());
 
         _createRole(
-            serviceRoleId, 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Contract,
-                maxMemberCount: 1,
-                name: ObjectTypeLib.toVersionedName(
-                    baseName, 
-                    "ServiceRole", 
-                    versionInt)}));
+            roleId,
+            _authorization.getRoleInfo(roleId));
 
-        _grantRoleToAccount( 
-            serviceRoleId,
-            address(service)); 
+        // create registry target
+        _createTarget(
+            registry, 
+            _authorization.getMainTargetName(), 
+            true, // checkAuthority
+            false); // custom
+
+        // assign registry role to registry
+        _grantRoleToAccount(
+            roleId, 
+            registry);
     }
 
 
-    function _authorizeServiceFunctions(
-        IServiceAuthorization serviceAuthorization,
-        IService service
-    )
-        private
+    function _createRoles(IAuthorization authorization)
+        internal
     {
-        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);
-            }
+        RoleId[] memory roles = authorization.getRoles();
+        RoleId mainTargetRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
 
-            // 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);
-    }*/
+        RoleId roleId;
+        RoleInfo memory roleInfo;
 
-    //--- view functions ----------------------------------------------------//
+        for(uint256 i = 0; i < roles.length; i++) {
 
-    function getGifAdminRole() external view returns (RoleId) {
-        return GIF_ADMIN_ROLE();
-    }
+            roleId = roles[i];
 
-    function getGifManagerRole() external view returns (RoleId) {
-        return GIF_MANAGER_ROLE();
+            // skip main target role, create role if not exists
+            if (roleId != mainTargetRoleId && !roleExists(roleId)) {
+                _createRole(
+                    roleId,
+                    authorization.getRoleInfo(roleId));
+            }
+        }
     }
 
-    //--- private functions -------------------------------------------------//
 
-    function _setupGifAdminRole(address gifAdmin) private {
-        
-        _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 ReleaseManager
-        FunctionInfo[] memory functions;
-        functions = new FunctionInfo[](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);
+    function _createTargets(IAuthorization authorization)
+        internal
+    {
+        // registry
+        _createTargetWithRole(address(this), REGISTRY_ADMIN_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(REGISTRY_ADMIN_TARGET_NAME)));
+        _createTargetWithRole(_releaseRegistry, RELEASE_REGISTRY_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(RELEASE_REGISTRY_TARGET_NAME)));
+        _createTargetWithRole(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(TOKEN_REGISTRY_TARGET_NAME)));
 
-        _grantRoleToAccount(GIF_ADMIN_ROLE(), gifAdmin);
+        // staking
+        _createTargetWithRole(_staking, STAKING_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(STAKING_TARGET_NAME)));
+        _createTarget(_stakingStore, STAKING_STORE_TARGET_NAME, true, false);
+        _createTarget(address(IComponent(_staking).getTokenHandler()), STAKING_TH_TARGET_NAME, true, false);
     }
-    
-    function _setupGifManagerRole(address gifManager) private {
 
-        _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 ReleaseManager
-        functions = new FunctionInfo[](2);
-        functions[0] = toFunction(ReleaseManager.prepareNextRelease.selector, "prepareNextRelease");
-        functions[1] = toFunction(ReleaseManager.registerService.selector, "registerService");
-        _authorizeTargetFunctions(_releaseManager, GIF_MANAGER_ROLE(), functions);
 
-        _grantRoleToAccount(GIF_MANAGER_ROLE(), gifManager);
+    function _createTargetAuthorizations(IAuthorization authorization)
+        internal
+    {
+        Str[] memory targets = authorization.getTargets();
+        Str target;
+
+        for(uint256 i = 0; i < targets.length; i++) {
+            target = targets[i];
+            RoleId[] memory authorizedRoles = authorization.getAuthorizedRoles(target);
+            RoleId authorizedRole;
+
+            for(uint256 j = 0; j < authorizedRoles.length; j++) {
+                authorizedRole = authorizedRoles[j];
+
+                _authorizeTargetFunctions(
+                    getTargetForName(target),
+                    authorizedRole,
+                    authorization.getAuthorizedFunctions(
+                        target, 
+                        authorizedRole));
+            }
+        }
     }
 
 
-    function _setupReleaseManager() private {
-
-        _createTarget(_releaseManager, RELEASE_MANAGER_TARGET_NAME, true, false);
-
-        RoleId releaseManagerRoleId = RoleIdLib.roleForType(RELEASE());
-        _createRole(
-            releaseManagerRoleId, 
-            toRole({
-                adminRoleId: ADMIN_ROLE(),
-                roleType: RoleType.Contract,
-                maxMemberCount: 1,
-                name: RELEASE_MANAGER_ROLE_NAME}));
-
-        FunctionInfo[] memory functions;
-        functions = new FunctionInfo[](2);
-        functions[0] = toFunction(RegistryAdmin.authorizeService.selector, "authorizeService");
-        functions[1] = toFunction(RegistryAdmin.grantServiceRoleForAllVersions.selector, "grantServiceRoleForAllVersions");
-        _authorizeTargetFunctions(address(this), releaseManagerRoleId, functions);
-
-        _grantRoleToAccount(releaseManagerRoleId, _releaseManager);
-    }
-
+    function _createTargets(address authorization)
+        private 
+        onlyInitializing()
+    {
+        IStaking staking = IStaking(_staking);
+        address tokenHandler = address(staking.getTokenHandler());
 
-    function _setupStaking() private {
+        _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);
-
-        // 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);
+        _createTarget(_tokenRegistry, TOKEN_REGISTRY_TARGET_NAME, true, false);
+        _createTarget(tokenHandler, TOKEN_HANDLER_TARGET_NAME, true, false);
     }
 }