@etherisc/gif-next 0.0.2-d13bb9e-069 → 0.0.2-d18e1c5-511

package/contracts/instance/InstanceAdmin.sol

@@ -1,178 +1,221 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
-import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
-
-import {AccessAdmin} from "../authorization/AccessAdmin.sol";
-import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
-import {IAccessAdmin} from "../authorization/IAccessAdmin.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "./IInstance.sol";
-import {IService} from "../shared/IService.sol";
-import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
-import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
-import {Str, StrLib} from "../type/String.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {ObjectType, INSTANCE} from "../type/ObjectType.sol";
+import {RoleId, ADMIN_ROLE} from "../type/RoleId.sol";
+import {Str} from "../type/String.sol";
 import {VersionPart} from "../type/Version.sol";
+import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME} from "./TargetNames.sol";
 
 
 contract InstanceAdmin is
     AccessAdmin
 {
-    string public constant INSTANCE_TARGET_NAME = "Instance";
-    string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
-    string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
-    string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
+    // onlyInstanceService
+    error ErrorInstanceAdminNotInstanceService(address caller);
 
-    uint64 public constant CUSTOM_ROLE_ID_MIN = 10000; // MUST be even
+    // authorizeFunctions
+    error ErrorInstanceAdminNotComponentOrCustomTarget(address target);
 
-    error ErrorInstanceAdminNotRegistered(address target);
-    error ErrorInstanceAdminAlreadyAuthorized(address target);
-    error ErrorInstanceAdminReleaseMismatch();
-    error ErrorInstanceAdminExpectedTargetMissing(string targetName);
-
-    IInstance _instance;
+    IInstance internal _instance;
     IRegistry internal _registry;
-    uint64 _idNext;
+    VersionPart internal _release;
+
+    uint64 internal _customRoleIdNext;
 
-    IModuleAuthorization _instanceAuthorization;
+    mapping(address target => RoleId roleId) internal _targetRoleId;
+    uint64 internal _components;
+
+
+    modifier onlyInstanceService() {
+        if (msg.sender != _registry.getServiceAddress(INSTANCE(), getRelease())) {
+            revert ErrorInstanceAdminNotInstanceService(msg.sender);
+        }
+        _;
+    }
 
     /// @dev Only used for master instance admin.
-    /// Contracts created via constructor come with disabled initializers.
-    constructor(
-        IModuleAuthorization instanceAuthorization
-    )
-        AccessAdmin()
-    {
-        _instanceAuthorization = instanceAuthorization;
+    constructor(address accessManager) {
+        initialize(
+            accessManager,
+            "MasterInstanceAdmin");
     }
 
-    /// @dev Initializes this instance admin with the provided instances authorization specification.
-    /// Internally the function creates an instance specific OpenZeppelin AccessManager that is used as the authority
-    /// for the inststance authorizatios.
-    /// Important: Initialization of this instance admin is only complete after calling function initializeInstance. 
-    function initialize(
-        AccessManagerCloneable accessManager,
-        IModuleAuthorization instanceAuthorization
+
+    /// @dev Completes the initialization of this instance admin using the provided instance, registry and version.
+    /// Important: Initialization of instance admin is only complete after calling this function. 
+    /// Important: The instance MUST be registered and all instance supporting contracts must be wired to this instance.
+    function completeSetup(
+        address registry,
+        address authorization,
+        VersionPart release,
+        address instance
     )
         external
-        initializer() 
+        reinitializer(uint64(release.toInt()))
+        onlyDeployer()
     {
-        // create new access manager for this instance admin
-        _initializeAuthority(address(accessManager));
+        // checks
+        AccessAdminLib.checkIsRegistered(registry, instance, INSTANCE());
 
-        // create basic instance independent setup
-        _createAdminAndPublicRoles();
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
 
-        // store instance authorization specification
-        _instanceAuthorization = IModuleAuthorization(instanceAuthorization);
-    }
+        _checkAuthorization(authorization, INSTANCE(), release, false, true);
 
-    function _checkTargetIsReadyForAuthorization(address target)
-        internal
-        view
-    {
-        if (address(_registry) != address(0) && !_registry.isRegistered(target)) {
-            revert ErrorInstanceAdminNotRegistered(target);
-        }
+        // effects
+        _registry = IRegistry(registry);
+        _release = release;
 
-        if (targetExists(target)) {
-            revert ErrorInstanceAdminAlreadyAuthorized(target);
-        }
+        _instance = IInstance(instance);
+        _authorization = IAuthorization(authorization);
+        _components = 0;
+        _customRoleIdNext = 0;
+
+        // link nft ownability to instance
+        _linkToNftOwnable(instance);
+
+        // setup instance targets
+        _createInstanceTargets(_authorization.getMainTargetName());
+
+        // setup non-contract roles
+        _setupServiceRoles(_authorization);
+        _createRoles(_authorization);
+
+        // authorize functions of instance contracts
+        _createTargetAuthorizations(_authorization);
     }
 
-    /// @dev Completes the initialization of this instance admin using the provided instance.
-    /// Important: The instance MUST be registered and all instance supporting contracts must be wired to this instance.
-    function initializeInstanceAuthorization(address instanceAddress)
-        external
+
+    /// @dev grants the service roles to the service addresses based on the authorization specification.
+    /// Service addresses used for the granting are determined by the registry and the release of this instance.
+    function _setupServiceRoles(IAuthorization authorization)
+        internal
     {
-        _checkTargetIsReadyForAuthorization(instanceAddress);
+        ObjectType[] memory serviceDomains = authorization.getServiceDomains();
+
+        for(uint256 i = 0; i < serviceDomains.length; i++) {
+            ObjectType serviceDomain = serviceDomains[i];
+            RoleId serviceRoleId = authorization.getServiceRole(serviceDomain);
+            string memory serviceRoleName = authorization.getRoleName(serviceRoleId);
 
-        _idNext = CUSTOM_ROLE_ID_MIN;
-        _instance = IInstance(instanceAddress);
-        _registry = _instance.getRegistry();
+            // create service role if missing
+            if (!roleExists(serviceRoleId)) {
+                _createRole(
+                    serviceRoleId, 
+                    AccessAdminLib.toRole(
+                        ADMIN_ROLE(), 
+                        IAccess.RoleType.Contract, 
+                        1, 
+                        serviceRoleName));
+            }
 
-        // check matching releases
-        if (_instanceAuthorization.getRelease() != _instance.getMajorVersion()) {
-            revert ErrorInstanceAdminReleaseMismatch();
+            // grant service role to service
+            address service = _registry.getServiceAddress(serviceDomain, _release);
+            _grantRoleToAccount(
+                serviceRoleId,
+                service);
         }
+    }
 
-        // add instance authorization
-        _createRoles(_instanceAuthorization);
-        _createModuleTargetsWithRoles();
-        _createTargetAuthorizations(_instanceAuthorization);
 
-        // grant component owner roles to instance owner
-        _grantComponentOwnerRoles();
+    function _createInstanceTargets(string memory instanceTargetName)
+        internal
+    {
+        _createManagedTarget(address(_instance), instanceTargetName, TargetType.Instance); 
+        _createManagedTarget(address(this), INSTANCE_ADMIN_TARGET_NAME, TargetType.Instance); 
+        _createManagedTarget(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME, TargetType.Instance); 
+        _createManagedTarget(address(_instance.getProductStore()), PRODUCT_STORE_TARGET_NAME, TargetType.Instance);
+        _createManagedTarget(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME, TargetType.Instance); 
+        _createManagedTarget(address(_instance.getRiskSet()), RISK_SET_TARGET_NAME, TargetType.Instance); 
     }
 
 
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
-        IComponent component,
-        IAuthorization authorization
+        address componentAddress,
+        ObjectType expectedType
     )
         external
+        restricted()
     {
-        _checkTargetIsReadyForAuthorization(address(component));
+        // checks
+        AccessAdminLib.checkIsRegistered(address(getRegistry()), componentAddress, expectedType);
 
-        _createRoles(authorization);
+        IInstanceLinkedComponent component = IInstanceLinkedComponent(componentAddress);
+        IAuthorization authorization = component.getAuthorization();
+        _checkAuthorization(address(authorization), expectedType, getRelease(), false, false);
 
-        // create component target
-        _createTarget(
-            address(component), 
-            authorization.getTargetName(), 
-            true, // checkAuthority
-            false); // custom
-
-        _createTarget(
-            address(component.getTokenHandler()), 
-            string(abi.encodePacked(authorization.getTargetName(), "TH")), 
-            true, 
-            false);
-        
-        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
-        FunctionInfo[] memory functions = new FunctionInfo[](3);
-        functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
-        functions[1] = toFunction(TokenHandler.collectTokensToThreeRecipients.selector, "collectTokensToThreeRecipients");
-        functions[2] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
-
-        _authorizeTargetFunctions(
-            address(component.getTokenHandler()),
-            getPublicRole(),
-            functions);
-
-        _grantRoleToAccount(
-            authorization.getTargetRole(
-                authorization.getTarget()), 
-            address(component));
-        
+        // effects
+        _createRoles(authorization);
+        _createManagedTarget(componentAddress, authorization.getMainTargetName(), TargetType.Component);
         _createTargetAuthorizations(authorization);
+
+        // increase component count
+        _components++;
+    }
+
+    function getRelease()
+        public
+        view
+        override
+        returns (VersionPart release)
+    {
+        return _release;
     }
 
 
-    function _grantComponentOwnerRoles()
-        internal
+    /// @dev Creates a custom role.
+    function createRole(
+        string memory name,
+        RoleId adminRoleId,
+        uint32 maxMemberCount
+    )
+        external
+        restricted()
+        returns (RoleId roleId)
     {
-        address instanceOwner = _registry.ownerOf(_instance.getNftId());
-        _grantRoleToAccount(DISTRIBUTION_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(ORACLE_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(POOL_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(PRODUCT_OWNER_ROLE(), instanceOwner);
+        // check role does not yet exist
+        if (roleExists(name)) {
+            revert ErrorAccessAdminRoleAlreadyCreated(
+                getRoleForName(name),
+                name);
+        }
+
+        // create roleId
+        roleId = AccessAdminLib.getCustomRoleId(_customRoleIdNext++);
+
+        // create role
+        _createRole(
+            roleId, 
+            AccessAdminLib.toRole(
+                adminRoleId, 
+                IAccess.RoleType.Custom, 
+                maxMemberCount, 
+                name));
     }
 
-    /// @dev Creates a custom role
-    // TODO implement
-    // function createRole()
-    //     external
-    //     restricted()
-    // {
 
-    // }
+    /// @dev Activtes/pauses the specified role.
+    function setRoleActive(RoleId roleId, bool active)
+        external
+        restricted()
+    {
+        _setRoleActive(roleId, active);
+    }
+
 
     /// @dev Grants the provided role to the specified account
     function grantRole(
@@ -184,27 +227,121 @@ contract InstanceAdmin is
         _grantRoleToAccount(roleId, account);
     }
 
+
+    /// @dev Revokes the provided role from the specified account
+    function revokeRole(
+        RoleId roleId, 
+        address account)
+        external
+        restricted()
+    {
+        _revokeRoleFromAccount(roleId, account);
+    }
+
+
+    /// @dev Create a new custom target.
+    /// The target needs to be an access managed contract.
+    function createTarget(
+        address target, 
+        string memory name
+    )
+        external
+        restricted()
+        returns (RoleId contractRoleId)
+    {
+        return _createManagedTarget(
+            target, 
+            name, 
+            TargetType.Custom);
+    }
+
+
+    /// @dev Add function authorizations for the specified component or custom target.
+    function authorizeFunctions(
+        address target,
+        RoleId roleId,
+        IAccess.FunctionInfo[] memory functions
+    )
+        external
+        restricted()
+    {
+        _checkComponentOrCustomTarget(target);
+        _authorizeTargetFunctions(target, roleId, functions, true);
+    }
+
+
+    /// @dev Removes function authorizations for the specified component or custom target.
+    function unauthorizeFunctions(
+        address target,
+        IAccess.FunctionInfo[] memory functions
+    )
+        external
+        restricted()
+    {
+        _checkComponentOrCustomTarget(target);
+        _authorizeTargetFunctions(target, ADMIN_ROLE(), functions, false);
+    }
+
+
+    /// @dev locks the instance and all its releated targets including component and custom targets.
+    function setInstanceLocked(bool locked)
+        external
+        // not restricted(): need to operate on locked instances to unlock instance
+        onlyInstanceService()
+    {
+        AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+        accessManager.setLocked(locked);
+    }
+
+
+    function setTargetLocked(address target, bool locked) 
+        external 
+        // not restricted(): might need to operate on targets while instance is locked
+        onlyInstanceService()
+    {
+        _setTargetLocked(target, locked);
+    }
+
+
+    function setComponentLocked(address target, bool locked) 
+        external 
+        restricted()
+    {
+        _setTargetLocked(target, locked);
+    }
+
+    /// @dev Returns the number of components that have been registered with this instance.   
+    function components() 
+        external 
+        view 
+        returns (uint64)
+    {
+        return _components;
+    }
+
     /// @dev Returns the instance authorization specification used to set up this instance admin.
     function getInstanceAuthorization()
         external
         view
-        returns (IModuleAuthorization instanceAuthorizaion)
+        returns (IAuthorization instanceAuthorizaion)
     {
-        return _instanceAuthorization;
+        return _authorization;
     }
 
+    // ------------------- Internal functions ------------------- //
 
     function _createRoles(IAuthorization authorization)
         internal
     {
         RoleId[] memory roles = authorization.getRoles();
-        RoleId roleId;
-        RoleInfo memory roleInfo;
+        RoleId mainTargetRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
 
         for(uint256 i = 0; i < roles.length; i++) {
-            roleId = roles[i];
+            RoleId roleId = roles[i];
 
-            if (!roleExists(roleId)) {
+            // skip main target role, create role if not exists
+            if (roleId != mainTargetRoleId && !roleExists(roleId)) {
                 _createRole(
                     roleId,
                     authorization.getRoleInfo(roleId));
@@ -222,67 +359,21 @@ contract InstanceAdmin is
         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));
+                _authorizeFunctions(authorization, target, authorizedRoles[j]);
             }
         }
     }
 
-    function _checkAndCreateTargetWithRole(
-        address target,
-        string memory targetName
-    )
-        internal
-    {
-        // check that target name is defined in authorization specification
-        Str name = StrLib.toStr(targetName);
-        if (!_instanceAuthorization.targetExists(name)) {
-            revert ErrorInstanceAdminExpectedTargetMissing(targetName);
-        }
-
-        // create named target
-        _createTarget(
-            target, 
-            targetName, 
-            false, // check authority TODO check normal targets, don't check service targets (they share authority with registry admin)
-            false);
-
-        // assign target role if defined
-        RoleId targetRoleId = _instanceAuthorization.getTargetRole(name);
-        if (targetRoleId != RoleIdLib.zero()) {
-            _grantRoleToAccount(targetRoleId, target);
-        }
-    }
 
-    function _createModuleTargetsWithRoles()
+    function _checkComponentOrCustomTarget(address target) 
         internal
+        view
     {
-        // create module targets
-        _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
-        _checkAndCreateTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME);
-        _checkAndCreateTargetWithRole(address(_instance.getInstanceAdmin()), INSTANCE_ADMIN_TARGET_NAME);
-        _checkAndCreateTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME);
-
-        // create targets for services that need to access the module targets
-        ObjectType[] memory serviceDomains = _instanceAuthorization.getServiceDomains();
-        VersionPart release = _instanceAuthorization.getRelease();
-        ObjectType serviceDomain;
-
-        for (uint256 i = 0; i < serviceDomains.length; i++) {
-            serviceDomain = serviceDomains[i];
-
-            _checkAndCreateTargetWithRole(
-                _registry.getServiceAddress(serviceDomain, release),
-                _instanceAuthorization.getServiceTarget(serviceDomain).toString());
+        IAccess.TargetType targetType = getTargetInfo(target).targetType;
+        if (targetType != TargetType.Component && targetType != TargetType.Custom) {
+            revert ErrorInstanceAdminNotComponentOrCustomTarget(target);
         }
     }
 }