@etherisc/gif-next 0.0.2-86e23a6-752 → 0.0.2-86fb77b-888

package/contracts/instance/InstanceService.sol

@@ -3,284 +3,384 @@ pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 
-import {Instance} from "./Instance.sol";
+import {IAccess} from "../authorization/IAccess.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstance} from "./IInstance.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {IInstanceService} from "./IInstanceService.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
-import {ChainNft} from "../registry/ChainNft.sol";
-import {Service} from "../../contracts/shared/Service.sol";
-import {IService} from "../shared/IService.sol";
-import {NftId} from "../../contracts/types/NftId.sol";
-import {RoleId} from "../types/RoleId.sol";
-import {ADMIN_ROLE, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE, POOL_SERVICE_ROLE, PRODUCT_SERVICE_ROLE, POLICY_SERVICE_ROLE, BUNDLE_SERVICE_ROLE} from "../types/RoleId.sol";
-import {ObjectType, INSTANCE, BUNDLE, POLICY, PRODUCT, DISTRIBUTION, REGISTRY, POOL} from "../types/ObjectType.sol";
-import {IDistributionComponent} from "../components/IDistributionComponent.sol";
-import {IPoolComponent} from "../components/IPoolComponent.sol";
-import {IProductComponent} from "../components/IProductComponent.sol";
-
-contract InstanceService is Service, IInstanceService {
-
-    address internal _masterInstanceAccessManager;
-    address internal _masterInstance;
-    address internal _masterInstanceReader;
-    address internal _masterInstanceBundleManager;
+import {IStakingService} from "../staking/IStakingService.sol";
+
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {Instance} from "./Instance.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, INSTANCE, COMPONENT, INSTANCE, REGISTRY, STAKING} from "../type/ObjectType.sol";
+import {ProductStore} from "./ProductStore.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {Service} from "../shared/Service.sol";
+import {TargetManagerLib} from "../staking/TargetManagerLib.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
+
+
+contract InstanceService is
+    Service,
+    IInstanceService
+{
 
     // TODO update to real hash when instance is stable
     bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
 
-    modifier onlyInstanceOwner(NftId instanceNftId) {
-        IRegistry registry = getRegistry();
-        ChainNft chainNft = ChainNft(registry.getChainNftAddress());
-        
-        if( msg.sender != chainNft.ownerOf(instanceNftId.toInt())) {
-            revert ErrorInstanceServiceNotInstanceOwner(msg.sender, instanceNftId);
-        }
+    IRegistryService internal _registryService;
+    IStakingService internal _stakingService;
+    IComponentService internal _componentService;
+
+    address internal _masterAccessManager;
+    address internal _masterInstanceAdmin;
+    address internal _masterInstance;
+    address internal _masterInstanceReader;
+    address internal _masterInstanceBundleSet;
+    address internal _masterInstanceRiskSet;
+    address internal _masterInstanceStore;
+    address internal _masterProductStore;
+
+
+    modifier onlyInstance() {
+        _checkInstance(msg.sender, getRelease());
         _;
     }
 
-    modifier onlyRegisteredService() {
-        address caller = msg.sender;
-        if (! getRegistry().isRegisteredService(caller)) {
-            revert ErrorInstanceServiceRequestUnauhorized(caller);
-        }
-        _;
+
+    /// @inheritdoc IInstanceService
+    function createRole(
+        string memory roleName, 
+        RoleId adminRoleId,
+        uint32 maxMemberCount
+    )
+        external
+        restricted()
+        onlyInstance()
+        returns (RoleId roleId)
+    {
+        IInstance instance = IInstance(msg.sender);
+        roleId = instance.getInstanceAdmin().createRole(
+            roleName, 
+            adminRoleId, 
+            maxMemberCount);
     }
 
-    function createInstanceClone()
-        external 
-        returns (
-            InstanceAccessManager clonedAccessManager, 
-            Instance clonedInstance,
-            NftId clonedInstanceNftId,
-            InstanceReader clonedInstanceReader,
-            BundleManager clonedBundleManager
-        )
+
+    /// @inheritdoc IInstanceService
+    function setRoleActive(RoleId roleId, bool active)
+        external
+        restricted()
+        onlyInstance()
     {
-        address instanceOwner = msg.sender;
-        IRegistry registry = getRegistry();
-        address registryAddress = address(registry);
-        NftId registryNftId = registry.getNftId(registryAddress);
-        address registryServiceAddress = registry.getServiceAddress(REGISTRY(), getMajorVersion());
-        IRegistryService registryService = IRegistryService(registryServiceAddress);
-
-        // initially set the authority of the access managar to this (being the instance service). 
-        // This will allow the instance service to bootstrap the authorizations of the instance
-        // and then transfer the ownership of the access manager to the instance owner once everything is setup
-        clonedAccessManager = InstanceAccessManager(Clones.clone(_masterInstanceAccessManager));
-        clonedAccessManager.initialize(address(this));
-
-        clonedInstance = Instance(Clones.clone(_masterInstance));
-        clonedInstance.initialize(address(clonedAccessManager), registryAddress, registryNftId, msg.sender);
-        
-        clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        clonedInstanceReader.initialize(registryAddress, address(clonedInstance));
-        clonedInstance.setInstanceReader(clonedInstanceReader);
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().setRoleActive(roleId, active);
+    }
 
-        clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
-        clonedBundleManager.initialize(address(clonedAccessManager), registryAddress, address(clonedInstance));
-        clonedInstance.setBundleManager(clonedBundleManager);
 
-        // TODO amend setters with instance specific , policy manager ...
+    /// @inheritdoc IInstanceService
+    function grantRole(RoleId roleId, address account)
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().grantRole(roleId, account);
+    }
 
-        _grantInitialAuthorizations(clonedAccessManager, clonedInstance, clonedBundleManager);
 
-        // to complete setup switch instance ownership to the instance owner
-        // TODO: use a role less powerful than admin, maybe INSTANCE_ADMIN (does not exist yet)
-        clonedAccessManager.grantRole(ADMIN_ROLE(), instanceOwner);
-        clonedAccessManager.revokeRole(ADMIN_ROLE(), address(this));
+    /// @inheritdoc IInstanceService
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().revokeRole(roleId, account);
+    }
 
-        IRegistry.ObjectInfo memory info = registryService.registerInstance(clonedInstance, instanceOwner);
-        clonedInstanceNftId = info.nftId;
-        // clonedInstance.linkToRegisteredNftId();
 
-        emit LogInstanceCloned(address(clonedAccessManager), address(clonedInstance), address(clonedInstanceReader), clonedInstanceNftId);
+    /// @inheritdoc IInstanceService
+    function createTarget(address target, string memory name)
+        external
+        restricted()
+        onlyInstance()
+        returns (RoleId contractRoleId)
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().createTarget(target, name);
     }
 
-    function _grantInitialAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance, BundleManager clonedBundleManager) internal {
-        _createGifRoles(clonedAccessManager);
-        _createGifTargets(clonedAccessManager, clonedInstance, clonedBundleManager);
-        _grantDistributionServiceAuthorizations(clonedAccessManager, clonedInstance);
-        _grantPoolServiceAuthorizations(clonedAccessManager, clonedInstance);
-        _grantProductServiceAuthorizations(clonedAccessManager, clonedInstance);
-        _grantPolicyServiceAuthorizations(clonedAccessManager, clonedInstance);    
-        _grantBundleServiceAuthorizations(clonedAccessManager, clonedInstance, clonedBundleManager);
-        _grantInstanceServiceAuthorizations(clonedAccessManager, clonedInstance);
+
+    /// @inheritdoc IInstanceService
+    function authorizeFunctions(
+        address target, 
+        RoleId roleId, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external 
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().authorizeFunctions(target, roleId, functions);
     }
 
-    function _createGifRoles(InstanceAccessManager clonedAccessManager) internal {
-        clonedAccessManager.createGifRole(DISTRIBUTION_OWNER_ROLE(), "DistributionOwnerRole");
-        clonedAccessManager.createGifRole(POOL_OWNER_ROLE(), "PoolOwnerRole");
-        clonedAccessManager.createGifRole(PRODUCT_OWNER_ROLE(), "ProductOwnerRole");
-
-        clonedAccessManager.createGifRole(DISTRIBUTION_SERVICE_ROLE(), "DistributionServiceRole");
-        clonedAccessManager.createGifRole(POOL_SERVICE_ROLE(), "PoolServiceRole");
-        clonedAccessManager.createGifRole(PRODUCT_SERVICE_ROLE(), "ProductServiceRole");
-        clonedAccessManager.createGifRole(POLICY_SERVICE_ROLE(), "PolicyServiceRole");
-        clonedAccessManager.createGifRole(BUNDLE_SERVICE_ROLE(), "BundleServiceRole");
-        clonedAccessManager.createGifRole(INSTANCE_SERVICE_ROLE(), "InstanceServiceRole");
+
+    /// @inheritdoc IInstanceService
+    function unauthorizeFunctions(
+        address target, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().unauthorizeFunctions(target, functions);
     }
 
-    function _createGifTargets(InstanceAccessManager clonedAccessManager, Instance clonedInstance, BundleManager clonedBundleManager) internal {
-        clonedAccessManager.createGifTarget(address(clonedAccessManager), "InstanceAccessManager");
-        clonedAccessManager.createGifTarget(address(clonedInstance), "Instance");
-        clonedAccessManager.createGifTarget(address(clonedBundleManager), "BundleManager");
-    }   
 
-    function _grantDistributionServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for distribution service on instance
-        IRegistry registry = getRegistry();
-        address distributionServiceAddress = registry.getServiceAddress(DISTRIBUTION(), getMajorVersion());
-        clonedAccessManager.grantRole(DISTRIBUTION_SERVICE_ROLE(), distributionServiceAddress);
-        bytes4[] memory instanceDistributionServiceSelectors = new bytes4[](11);
-        instanceDistributionServiceSelectors[0] = clonedInstance.createDistributionSetup.selector;
-        instanceDistributionServiceSelectors[1] = clonedInstance.updateDistributionSetup.selector;
-        instanceDistributionServiceSelectors[2] = clonedInstance.createDistributorType.selector;
-        instanceDistributionServiceSelectors[3] = clonedInstance.updateDistributorType.selector;
-        instanceDistributionServiceSelectors[4] = clonedInstance.updateDistributorTypeState.selector;
-        instanceDistributionServiceSelectors[5] = clonedInstance.createDistributor.selector;
-        instanceDistributionServiceSelectors[6] = clonedInstance.updateDistributor.selector;
-        instanceDistributionServiceSelectors[7] = clonedInstance.updateDistributorState.selector;
-        instanceDistributionServiceSelectors[8] = clonedInstance.createReferral.selector;
-        instanceDistributionServiceSelectors[9] = clonedInstance.updateReferral.selector;
-        instanceDistributionServiceSelectors[10] = clonedInstance.updateReferralState.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instanceDistributionServiceSelectors, 
-            DISTRIBUTION_SERVICE_ROLE());        
+    /// @inheritdoc IInstanceService
+    function setTargetLocked(address target, bool locked)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance(instanceAddress).getInstanceAdmin().setTargetLocked(target, locked);
     }
 
-    function _grantPoolServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for pool service on instance
-        address poolServiceAddress = getRegistry().getServiceAddress(POOL(), getMajorVersion());
-        clonedAccessManager.grantRole(POOL_SERVICE_ROLE(), address(poolServiceAddress));
-        bytes4[] memory instancePoolServiceSelectors = new bytes4[](4);
-        instancePoolServiceSelectors[0] = clonedInstance.createPoolSetup.selector;
-        instancePoolServiceSelectors[1] = clonedInstance.updatePoolSetup.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instancePoolServiceSelectors, 
-            POOL_SERVICE_ROLE());
+
+    /// @inheritdoc IInstanceService
+    function setInstanceLocked(bool locked)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
+
+        emit LogInstanceServiceInstanceLocked(
+            getRegistry().getNftIdForAddress(instanceAddress),
+            locked);
     }
 
-    function _grantProductServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for product service on instance
-        address productServiceAddress = getRegistry().getServiceAddress(PRODUCT(), getMajorVersion());
-        clonedAccessManager.grantRole(PRODUCT_SERVICE_ROLE(), address(productServiceAddress));
-        bytes4[] memory instanceProductServiceSelectors = new bytes4[](5);
-        instanceProductServiceSelectors[0] = clonedInstance.createProductSetup.selector;
-        instanceProductServiceSelectors[1] = clonedInstance.updateProductSetup.selector;
-        instanceProductServiceSelectors[2] = clonedInstance.createRisk.selector;
-        instanceProductServiceSelectors[3] = clonedInstance.updateRisk.selector;
-        instanceProductServiceSelectors[4] = clonedInstance.updateRiskState.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instanceProductServiceSelectors, 
-            PRODUCT_SERVICE_ROLE());
+
+    /// @inheritdoc IInstanceService
+    function createInstance(bool allowAnyToken)
+        external 
+        virtual
+        restricted()
+        returns (
+            IInstance instance,
+            NftId instanceNftId
+        )
+    {
+        // tx sender will become instance owner
+        address instanceOwner = msg.sender;
+
+        // create instance admin and instance
+        InstanceAdmin instanceAdmin = _cloneNewInstanceAdmin();
+        instance = _createInstance(instanceAdmin, instanceOwner, allowAnyToken);
+
+        // register cloned instance with registry
+        instanceNftId = _registryService.registerInstance(
+            instance, instanceOwner).nftId;
+
+        // MUST be set after instance is set up and registered
+        IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
+        instanceAdmin.completeSetup(
+            address(getRegistry()),
+            address(instanceAuthorization),
+            getRelease(),
+            address(instance));
+
+        // hard checks for newly cloned instance
+        assert(address(instance.getRegistry()) == address(getRegistry()));
+        assert(instance.getRelease() == getRelease());
+
+        // register cloned instance as staking target
+        _stakingService.createInstanceTarget(
+            instanceNftId,
+            TargetManagerLib.getDefaultLockingPeriod(),
+            TargetManagerLib.getDefaultRewardRate());
+
+        emit LogInstanceServiceInstanceCreated(
+            instanceNftId,
+            address(instance));
     }
 
-    function _grantPolicyServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for policy service on instance
-        address policyServiceAddress = getRegistry().getServiceAddress(POLICY(), getMajorVersion());
-        clonedAccessManager.grantRole(POLICY_SERVICE_ROLE(), address(policyServiceAddress));
-        bytes4[] memory instancePolicyServiceSelectors = new bytes4[](3);
-        instancePolicyServiceSelectors[0] = clonedInstance.createPolicy.selector;
-        instancePolicyServiceSelectors[1] = clonedInstance.updatePolicy.selector;
-        instancePolicyServiceSelectors[2] = clonedInstance.updatePolicyState.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instancePolicyServiceSelectors, 
-            POLICY_SERVICE_ROLE());
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceLockingPeriod(
+            instanceNftId,
+            stakeLockingPeriod);
     }
 
-    function _grantBundleServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance, BundleManager clonedBundleManager) internal {
-        // configure authorization for bundle service on instance
-        address bundleServiceAddress = getRegistry().getServiceAddress(BUNDLE(), getMajorVersion());
-        clonedAccessManager.grantRole(BUNDLE_SERVICE_ROLE(), address(bundleServiceAddress));
-        bytes4[] memory instanceBundleServiceSelectors = new bytes4[](2);
-        instanceBundleServiceSelectors[0] = clonedInstance.createBundle.selector;
-        instanceBundleServiceSelectors[1] = clonedInstance.updateBundle.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instanceBundleServiceSelectors, 
-            BUNDLE_SERVICE_ROLE());
-
-        // configure authorization for bundle service on bundle manager
-        bytes4[] memory bundleManagerBundleServiceSelectors = new bytes4[](5);
-        bundleManagerBundleServiceSelectors[0] = clonedBundleManager.linkPolicy.selector;
-        bundleManagerBundleServiceSelectors[1] = clonedBundleManager.unlinkPolicy.selector;
-        bundleManagerBundleServiceSelectors[2] = clonedBundleManager.add.selector;
-        bundleManagerBundleServiceSelectors[3] = clonedBundleManager.lock.selector;
-        bundleManagerBundleServiceSelectors[4] = clonedBundleManager.unlock.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "BundleManager",
-            bundleManagerBundleServiceSelectors, 
-            BUNDLE_SERVICE_ROLE());
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceRewardRate(
+            instanceNftId,
+            rewardRate);
     }
 
-    function _grantInstanceServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-// configure authorization for instance service on instance
-        address instanceServiceAddress = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
-        clonedAccessManager.grantRole(INSTANCE_SERVICE_ROLE(), instanceServiceAddress);
-        bytes4[] memory instanceInstanceServiceSelectors = new bytes4[](1);
-        instanceInstanceServiceSelectors[0] = clonedInstance.setInstanceReader.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instanceInstanceServiceSelectors, 
-            INSTANCE_SERVICE_ROLE());
-
-        bytes4[] memory instanceAccessManagerInstanceServiceSelectors = new bytes4[](1);
-        instanceAccessManagerInstanceServiceSelectors[0] = clonedAccessManager.createGifTarget.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "InstanceAccessManager",
-            instanceAccessManagerInstanceServiceSelectors, 
-            INSTANCE_SERVICE_ROLE());
+    function setStakingMaxAmount(Amount maxStakedAmount)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceMaxStakedAmount(
+            instanceNftId,
+            maxStakedAmount);
+    }    
+
+
+    function refillInstanceRewardReserves(address rewardProvider, Amount dipAmount)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+        returns (Amount newBalance)
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        newBalance = _stakingService.refillInstanceRewardReserves(
+            instanceNftId,
+            rewardProvider,
+            dipAmount);
     }
 
-    function setAndRegisterMasterInstance(address instanceAddress) 
-            external 
-            onlyOwner 
-            returns(NftId masterInstanceNftId)
+
+    function withdrawInstanceRewardReserves(Amount dipAmount)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+        returns (Amount newBalance)
     {
-        if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
-        if(_masterInstanceAccessManager != address(0)) { revert ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet(); }
-        if(_masterInstanceBundleManager != address(0)) { revert ErrorInstanceServiceMasterBundleManagerAlreadySet(); }
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        newBalance = _stakingService.withdrawInstanceRewardReserves(
+            instanceNftId,
+            dipAmount);
+    }
 
-        if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
-        IInstance instance = IInstance(instanceAddress);
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        address accessManagerAddress = address(accessManager);
-        InstanceReader instanceReader = instance.getInstanceReader();
-        address instanceReaderAddress = address(instanceReader);
-        BundleManager bundleManager = instance.getBundleManager();
-        address bundleManagerAddress = address(bundleManager);
-
-        if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
-        if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
-        if(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleManagerZero(); }
+    function upgradeInstanceReader() 
+        external 
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance instance = IInstance(msg.sender);
         
-        if(instance.authority() != accessManagerAddress) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
-        if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
-        if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
+        InstanceReader upgradedInstanceReaderClone = InstanceReader(
+            Clones.clone(address(_masterInstanceReader)));
 
-        _masterInstanceAccessManager = accessManagerAddress;
-        _masterInstance = instanceAddress;
-        _masterInstanceReader = instanceReaderAddress;
-        _masterInstanceBundleManager = bundleManagerAddress;
-        
-        IRegistryService registryService = IRegistryService(getRegistry().getServiceAddress(REGISTRY(), getMajorVersion()));
-        IInstance masterInstance = IInstance(_masterInstance);
-        IRegistry.ObjectInfo memory info = registryService.registerInstance(masterInstance, getOwner());
-        masterInstanceNftId = info.nftId;
+        upgradedInstanceReaderClone.initializeWithInstance(instanceAddress);
+        instance.setInstanceReader(upgradedInstanceReaderClone);
 
-        // masterInstance.linkToRegisteredNftId();
+        emit LogInstanceServiceInstanceReaderUpgraded(
+            getRegistry().getNftIdForAddress(instanceAddress),
+            address(upgradedInstanceReaderClone));
     }
 
-    function setMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
+
+    function setAndRegisterMasterInstance(address instanceAddress)
+        external 
+        virtual
+        onlyOwner()
+        returns(NftId masterInstanceNftId)
+    {
+        if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
+        if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
+        if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
+        if(_masterInstanceRiskSet != address(0)) { revert ErrorInstanceServiceMasterRiskSetAlreadySet(); }
+        if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
+
+        {
+            IInstance instance = IInstance(instanceAddress);
+            address accessManagerAddress = instance.authority();
+            InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+            address instanceAdminAddress = address(instanceAdmin);
+            InstanceReader instanceReader = instance.getInstanceReader();
+            address instanceReaderAddress = address(instanceReader);
+            BundleSet bundleSet = instance.getBundleSet();
+            address bundleSetAddress = address(bundleSet);
+            RiskSet riskSet = instance.getRiskSet();
+            address riskSetAddress = address(riskSet);
+            InstanceStore instanceStore = instance.getInstanceStore();
+            address instanceStoreAddress = address(instanceStore);
+            ProductStore productStore = instance.getProductStore();
+            address productStoreAddress = address(productStore);
+
+            if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
+            if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
+            if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
+            if(bundleSetAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+            if(riskSetAddress == address(0)) { revert ErrorInstanceServiceRiskSetZero(); }
+            if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
+            if(productStoreAddress == address(0)) { revert ErrorInstanceServiceProductStoreZero(); } // TODO: rename exception
+            
+            if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
+            if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+            if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
+            if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
+            if(productStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceProductStoreAuthorityMismatch(); } 
+            if(bundleSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
+            if(riskSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
+            if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
+
+            _masterAccessManager = accessManagerAddress;
+            _masterInstanceAdmin = instanceAdminAddress;
+            _masterInstance = instanceAddress;
+            _masterInstanceReader = instanceReaderAddress;
+            _masterInstanceBundleSet = bundleSetAddress;
+            _masterInstanceRiskSet = riskSetAddress;
+            _masterInstanceStore = instanceStoreAddress;
+            _masterProductStore = productStoreAddress;
+        }
+        
+        {
+            IInstance masterInstance = IInstance(_masterInstance);
+            IRegistry.ObjectInfo memory info = _registryService.registerInstance(masterInstance, getOwner());
+            masterInstanceNftId = info.nftId;
+        }
+    }
+
+
+    function upgradeMasterInstanceReader(address instanceReaderAddress)
+        external
+        virtual
+        onlyOwner
+    {
         if(_masterInstanceReader == address(0)) { revert ErrorInstanceServiceMasterInstanceReaderNotSet(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderAddressZero(); }
         if(instanceReaderAddress == _masterInstanceReader) { revert ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader(); }
@@ -289,154 +389,126 @@ contract InstanceService is Service, IInstanceService {
         if(instanceReader.getInstance() != IInstance(_masterInstance)) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch(); }
 
         _masterInstanceReader = instanceReaderAddress;
-    }
 
-    // TODO access restriction
-    function upgradeInstanceReader(NftId instanceNftId) external {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        address owner = instance.getOwner();
-
-        if (msg.sender != owner) {
-            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
-        }
-        
-        InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initialize(address(registry), address(instance));
-        instance.setInstanceReader(upgradedInstanceReaderClone);
+        emit LogInstanceServiceMasterInstanceReaderUpgraded(
+            getRegistry().getNftIdForAddress(_masterInstance),
+            instanceReaderAddress);
     }
 
-    function getMasterInstanceReader() external view returns (address) {
+    function getMasterInstanceReader() external virtual view returns (address) {
         return _masterInstanceReader;
     }
 
-    function getMasterInstance() external view returns (address) {
-        return _masterInstance;
-    }
+    //--- internal functions --------------------------------------------------------//
 
-    function getMasterInstanceAccessManager() external view returns (address) {
-        return _masterInstanceAccessManager;
-    }
+    /// @dev create new cloned instance admin
+    /// function used to setup a new instance
+    function _cloneNewInstanceAdmin()
+        internal
+        virtual
+        returns (InstanceAdmin clonedAdmin)
+    {
+        // clone instance specific access manager
+        AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
+            Clones.clone(
+                InstanceAdmin(_masterInstanceAdmin).authority()));
+        
+        // set up the instance admin
+        clonedAdmin = InstanceAdmin(
+            Clones.clone(_masterInstanceAdmin));
 
-    function getMasterInstanceBundleManager() external view returns (address) {
-        return _masterInstanceBundleManager;
+        clonedAdmin.initialize(
+            address(clonedAccessManager),
+            "InstanceAdmin");
     }
 
-    // From IService
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return INSTANCE();
+
+    /// @dev create new cloned instance
+    /// function used to setup a new instance
+    function _createInstance(
+        InstanceAdmin instanceAdmin,
+        address instanceOwner,
+        bool allowAnyToken
+    )
+        internal
+        virtual
+        returns (IInstance)
+    {
+        // clone instance
+        Instance clonedInstance = Instance(Clones.clone(_masterInstance));
+        clonedInstance.initialize(
+            IInstance.InstanceContracts({
+                instanceAdmin: instanceAdmin,
+                instanceStore: InstanceStore(Clones.clone(address(_masterInstanceStore))),
+                productStore: ProductStore(Clones.clone(address(_masterProductStore))),
+                bundleSet: BundleSet(Clones.clone(_masterInstanceBundleSet)),
+                riskSet: RiskSet(Clones.clone(_masterInstanceRiskSet)),
+                instanceReader: InstanceReader(Clones.clone(address(_masterInstanceReader)))
+            }),
+            getRegistry(),
+            getRelease(),
+            instanceOwner,
+            allowAnyToken);
+
+        return clonedInstance;
     }
-    
-    /// @dev top level initializer
+
+
+    /// @dev top level initializer (upgradable contract)
     function _initialize(
         address owner, 
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while InstanceService is not deployed in InstanceServiceManager constructor
-        //      owner is InstanceServiceManager deployer
-        initializeService(registryAddress, owner);
-        registerInterface(type(IInstanceService).interfaceId);
-    }
-
-    function hasRole(address account, RoleId role, address instanceAddress) public view returns (bool) {
-        Instance instance = Instance(instanceAddress);
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        return accessManager.hasRole(role, account);
-    }
-
-    function createGifTarget(NftId instanceNftId, address targetAddress, string memory targetName) external onlyRegisteredService {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        accessManager.createGifTarget(targetAddress, targetName);
-    }
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-    function grantDistributionDefaultPermissions(NftId instanceNftId, address distributionAddress, string memory distributionName) external onlyRegisteredService {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory distributionInfo = registry.getObjectInfo(distributionAddress);
-
-        if (distributionInfo.objectType != DISTRIBUTION()) {
-            revert ErrorInstanceServiceInvalidComponentType(distributionAddress, DISTRIBUTION(), distributionInfo.objectType);
-        }
-
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        InstanceAccessManager instanceAccessManager = InstanceAccessManager(instance.authority());
+        __Service_init(authority, registry, owner);
 
-        bytes4[] memory fctSelectors = new bytes4[](1);
-        fctSelectors[0] = IDistributionComponent.setFees.selector;
-        instanceAccessManager.setTargetFunctionRole(distributionName, fctSelectors, DISTRIBUTION_OWNER_ROLE());
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _stakingService = IStakingService(_getServiceAddress(STAKING()));
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
-        bytes4[] memory fctSelectors2 = new bytes4[](2);
-        fctSelectors2[0] = IDistributionComponent.processSale.selector;
-        fctSelectors2[1] = IDistributionComponent.processRenewal.selector;
-        instanceAccessManager.setTargetFunctionRole(distributionName, fctSelectors2, PRODUCT_SERVICE_ROLE());
+        _registerInterface(type(IInstanceService).interfaceId);
     }
 
-    function grantPoolDefaultPermissions(NftId instanceNftId, address poolAddress, string memory poolName) external onlyRegisteredService {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory poolInfo = registry.getObjectInfo(poolAddress);
-
-        if (poolInfo.objectType != POOL()) {
-            revert ErrorInstanceServiceInvalidComponentType(poolAddress, POOL(), poolInfo.objectType);
-        }
-
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        InstanceAccessManager instanceAccessManager = InstanceAccessManager(instance.authority());
 
-        bytes4[] memory fctSelectors = new bytes4[](1);
-        fctSelectors[0] = IPoolComponent.setFees.selector;
-        instanceAccessManager.setTargetFunctionRole(poolName, fctSelectors, POOL_OWNER_ROLE());
-
-        bytes4[] memory fctSelectors2 = new bytes4[](1);
-        fctSelectors2[0] = IPoolComponent.verifyApplication.selector;
-        instanceAccessManager.setTargetFunctionRole(poolName, fctSelectors2, POLICY_SERVICE_ROLE());
-    }
-
-    function grantProductDefaultPermissions(NftId instanceNftId, address productAddress, string memory productName) external onlyRegisteredService {
+    function _checkInstance(
+        address instanceAddress,
+        VersionPart expectedRelease
+    )
+        internal
+        virtual
+        view
+    {
         IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory productInfo = registry.getObjectInfo(productAddress);
 
-        if (productInfo.objectType != PRODUCT()) {
-            revert ErrorInstanceServiceInvalidComponentType(productAddress, PRODUCT(), productInfo.objectType);
+        NftId instanceNftId = registry.getNftIdForAddress(instanceAddress);
+        if (instanceNftId.eqz()) {
+            revert ErrorInstanceServiceNotRegistered(instanceAddress);
         }
 
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        InstanceAccessManager instanceAccessManager = InstanceAccessManager(instance.authority());
-
-        bytes4[] memory fctSelectors = new bytes4[](1);
-        fctSelectors[0] = IProductComponent.setFees.selector;
-        instanceAccessManager.setTargetFunctionRole(productName, fctSelectors, PRODUCT_OWNER_ROLE());
-    }
-
-    function setTargetLocked(string memory targetName, bool locked) external {
-        address componentAddress = msg.sender;
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory componentInfo = registry.getObjectInfo(componentAddress);
-        if (componentInfo.nftId.eqz()) {
-            revert ErrorInstanceServiceComponentNotRegistered(componentAddress);
+        ObjectType objectType = registry.getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorInstanceServiceNotInstance(instanceAddress, objectType);
         }
 
-        // TODO validate component type
-
+        if (expectedRelease.gtz()) {
+            VersionPart instanceRelease = IInstance(instanceAddress).getRelease();
+            if (instanceRelease != expectedRelease) {
+                revert ErrorInstanceServiceInstanceVersionMismatch(instanceNftId, expectedRelease, instanceRelease);
+            }
+        }
+    }
 
-        address instanceAddress = registry.getObjectInfo(componentInfo.parentNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
 
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        accessManager.setTargetClosed(targetName, locked);
+    // From IService
+    function _getDomain() internal pure override returns(ObjectType) {
+        return INSTANCE();
     }
-    
-}
-
+}