@etherisc/gif-next 0.0.2-9dd1984-554 → 0.0.2-9e03baf-990

package/contracts/instance/InstanceService.sol

@@ -2,292 +2,359 @@
 pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
+
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {ChainNft} from "../registry/ChainNft.sol";
+import {NftId} from "../type/NftId.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {SecondsLib} from "../type/Seconds.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {ADMIN_ROLE} from "../type/RoleId.sol";
+import {ObjectType, INSTANCE, BUNDLE, APPLICATION, CLAIM, DISTRIBUTION, INSTANCE, POLICY, POOL, PRODUCT, REGISTRY, STAKING} from "../type/ObjectType.sol";
+
+import {Service} from "../shared/Service.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IService} from "../shared/IService.sol";
+
+import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
+import {IPoolComponent} from "../pool/IPoolComponent.sol";
+import {IProductComponent} from "../product/IProductComponent.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IStakingService} from "../staking/IStakingService.sol";
+import {TargetManagerLib} from "../staking/TargetManagerLib.sol";
 
 import {Instance} from "./Instance.sol";
 import {IInstance} from "./IInstance.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {RegistryService} from "../registry/RegistryService.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 {InstanceStore} from "./InstanceStore.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
-contract InstanceService is Service, IInstanceService {
 
-    address internal _masterInstanceAccessManager;
-    address internal _masterInstance;
-    address internal _masterInstanceReader;
-    address internal _masterInstanceBundleManager;
+contract InstanceService is
+    Service,
+    IInstanceService
+{
 
     // TODO update to real hash when instance is stable
     bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
-    string public constant NAME = "InstanceService";
 
-    modifier onlyInstanceOwner(NftId instanceNftId) {
-        IRegistry registry = getRegistry();
-        ChainNft chainNft = registry.getChainNft();
-        
-        if( msg.sender != chainNft.ownerOf(instanceNftId.toInt())) {
-            revert ErrorInstanceServiceNotInstanceOwner(msg.sender, instanceNftId);
+    IRegistryService internal _registryService;
+    IStakingService internal _stakingService;
+
+    address internal _masterAccessManager;
+    address internal _masterInstanceAdmin;
+    address internal _masterInstance;
+    address internal _masterInstanceReader;
+    address internal _masterInstanceBundleSet;
+    address internal _masterInstanceStore;
+
+
+    modifier onlyInstance() {        
+        address instanceAddress = msg.sender;
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        if (instanceNftId.eqz()) {
+            revert ErrorInstanceServiceNotRegistered(instanceAddress);
+        }
+
+        ObjectType objectType = getRegistry().getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorInstanceServiceNotInstance(instanceAddress, objectType);
         }
+
+        VersionPart instanceVersion = IInstance(instanceAddress).getRelease();
+        if (instanceVersion != getVersion().toMajorPart()) {
+            revert ErrorInstanceServiceInstanceVersionMismatch(instanceAddress, instanceVersion);
+        }
+
         _;
     }
 
-    modifier onlyRegisteredService() {
-        address caller = msg.sender;
-        if (! getRegistry().isRegisteredService(caller)) {
-            revert ErrorInstanceServiceRequestUnauhorized(caller);
+
+    modifier onlyInstanceOwner(NftId instanceNftId) {        
+        if(msg.sender != getRegistry().ownerOf(instanceNftId)) {
+            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
         }
         _;
     }
 
-    function createInstanceClone()
+    // TODO check component - service - instance version match
+    modifier onlyComponent() {
+        if (! getRegistry().isRegisteredComponent(msg.sender)) {
+            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
+        }
+        _;
+    }
+
+    function createInstance()
         external 
         returns (
-            InstanceAccessManager clonedAccessManager, 
-            Instance clonedInstance,
-            NftId clonedInstanceNftId,
-            InstanceReader clonedInstanceReader,
-            BundleManager clonedBundleManager
+            IInstance instance,
+            NftId instanceNftId
         )
     {
+        // tx sender will become instance owner
         address instanceOwner = msg.sender;
-        IRegistry registry = getRegistry();
-        address registryAddress = address(registry);
-        NftId registryNftId = registry.getNftId(registryAddress);
-        address registryServiceAddress = registry.getServiceAddress(REGISTRY(), getMajorVersion());
-        RegistryService registryService = RegistryService(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.__InstanceAccessManager_initialize(address(this));
-
-        clonedInstance = Instance(Clones.clone(_masterInstance));
-        clonedInstance.initialize(address(clonedAccessManager), registryAddress, registryNftId, msg.sender);
-        ( IRegistry.ObjectInfo memory info, ) = registryService.registerInstance(clonedInstance);
-        clonedInstanceNftId = info.nftId;
-        
-        clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        clonedInstanceReader.initialize(registryAddress, clonedInstanceNftId);
-        clonedInstance.setInstanceReader(clonedInstanceReader);
 
-        clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
-        clonedBundleManager.initialize(address(clonedAccessManager), registryAddress, clonedInstanceNftId);
-        clonedInstance.setBundleManager(clonedBundleManager);
+        // create instance admin and instance
+        InstanceAdmin instanceAdmin = _createInstanceAdmin();
+        instance = _createInstance(instanceAdmin, instanceOwner);
 
-        // TODO amend setters with instance specific , policy manager ...
+        // register cloned instance with registry
+        instanceNftId = _registryService.registerInstance(
+            instance, instanceOwner).nftId;
 
-        _grantInitialAuthorizations(clonedAccessManager, clonedInstance, clonedBundleManager);
+        // register cloned instance as staking target
+        _stakingService.createInstanceTarget(
+            instanceNftId,
+            TargetManagerLib.getDefaultLockingPeriod(),
+            TargetManagerLib.getDefaultRewardRate());
 
-        // 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));
+        // MUST be set after instance is set up and registered
+        instanceAdmin.initializeInstanceAuthorization(address(instance));
 
-        emit LogInstanceCloned(address(clonedAccessManager), address(clonedInstance), address(clonedInstanceReader), clonedInstanceNftId);
+        emit LogInstanceCloned(
+            instanceNftId,
+            address(instance));
     }
 
-    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);
-    }
 
-    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");
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceLockingPeriod(
+            instanceNftId,
+            stakeLockingPeriod);
     }
 
-    function _createGifTargets(InstanceAccessManager clonedAccessManager, Instance clonedInstance, BundleManager clonedBundleManager) internal {
-        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[](2);
-        instanceDistributionServiceSelectors[0] = clonedInstance.createDistributionSetup.selector;
-        instanceDistributionServiceSelectors[1] = clonedInstance.updateDistributionSetup.selector;
-        clonedAccessManager.setTargetFunctionRole(
-            "Instance",
-            instanceDistributionServiceSelectors, 
-            DISTRIBUTION_SERVICE_ROLE());
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceRewardRate(
+            instanceNftId,
+            rewardRate);
     }
 
-    function _grantPoolServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for pool service on instance
-        address poolServiceAddress = _registry.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());
-    }
 
-    function _grantProductServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for product service on instance
-        address productServiceAddress = _registry.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());
+    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.refillInstanceRewardReserves(
+            instanceNftId,
+            rewardProvider,
+            dipAmount);
     }
 
-    function _grantPolicyServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-        // configure authorization for policy service on instance
-        address policyServiceAddress = _registry.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 _grantBundleServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance, BundleManager clonedBundleManager) internal {
-        // configure authorization for bundle service on instance
-        address bundleServiceAddress = _registry.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 withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+        returns (Amount newBalance)
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.withdrawInstanceRewardReserves(
+            instanceNftId,
+            dipAmount);
     }
 
-    function _grantInstanceServiceAuthorizations(InstanceAccessManager clonedAccessManager, Instance clonedInstance) internal {
-// configure authorization for instance service on instance
-        address instanceServiceAddress = _registry.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());
+
+    function setComponentLocked(bool locked)
+        external
+        virtual
+        onlyComponent()
+    {
+        // checks
+        address componentAddress = msg.sender;
+
+        if (!IInstanceLinkedComponent(componentAddress).supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
+            revert ErrorInstanceServiceComponentNotInstanceLinked(componentAddress);
+        }
+
+        IRegistry registry = getRegistry();
+        NftId instanceNftId = registry.getObjectInfo(componentAddress).parentNftId;
+
+        IInstance instance = IInstance(
+            registry.getObjectAddress(instanceNftId));
+
+        // no revert in case already locked
+        // TODO refactor/implement
+        // instance.getInstanceAdmin().setTargetLockedByService(
+        //     componentAddress, 
+        //     locked);
     }
 
-    function setMasterInstance(address accessManagerAddress, address instanceAddress, address instanceReaderAddress, address bundleManagerAddress) external onlyOwner {
-        require(_masterInstanceAccessManager == address(0), "ERROR:CRD-001:ACCESS_MANAGER_MASTER_ALREADY_SET");
-        require(_masterInstance == address(0), "ERROR:CRD-002:INSTANCE_MASTER_ALREADY_SET");
-        require(_masterInstanceBundleManager == address(0), "ERROR:CRD-004:BUNDLE_MANAGER_MASTER_ALREADY_SET");
 
-        require (accessManagerAddress != address(0), "ERROR:CRD-005:ACCESS_MANAGER_ZERO");
-        require (instanceAddress != address(0), "ERROR:CRD-006:INSTANCE_ZERO");
-        require (instanceReaderAddress != address(0), "ERROR:CRD-007:INSTANCE_READER_ZERO");
-        require (bundleManagerAddress != address(0), "ERROR:CRD-008:BUNDLE_MANAGER_ZERO");
+    function getMasterInstanceReader() external view returns (address) {
+        return _masterInstanceReader;
+    }
 
-        Instance instance = Instance(instanceAddress);
-        InstanceReader instanceReader = InstanceReader(instanceReaderAddress);
-        BundleManager bundleManager = BundleManager(bundleManagerAddress);
+    function setAndRegisterMasterInstance(address instanceAddress)
+            external 
+            onlyOwner 
+            returns(NftId masterInstanceNftId)
+    {
+        if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
+        if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
+        if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
 
-        require(instance.authority() == accessManagerAddress, "ERROR:CRD-009:INSTANCE_AUTHORITY_MISMATCH");
-        require(instanceReader.getInstanceNftId() == instance.getNftId(), "ERROR:CRD-010:INSTANCE_READER_INSTANCE_MISMATCH");
-        require(bundleManager.getInstanceNftId() == instance.getNftId(), "ERROR:CRD-011:BUNDLE_MANAGER_INSTANCE_MISMATCH");
+        if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
-        _masterInstanceAccessManager = accessManagerAddress;
+        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 bundleManager = instance.getBundleSet();
+        address bundleManagerAddress = address(bundleManager);
+        InstanceStore instanceStore = instance.getInstanceStore();
+        address instanceStoreAddress = address(instanceStore);
+
+        if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
+        if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
+        if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
+        if(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+        if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
+        
+        if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
+        if(bundleManager.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+        if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
+        if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
+        if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
+
+        _masterAccessManager = accessManagerAddress;
+        _masterInstanceAdmin = instanceAdminAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
-        _masterInstanceBundleManager = bundleManagerAddress;
+        _masterInstanceBundleSet = bundleManagerAddress;
+        _masterInstanceStore = instanceStoreAddress;
+        
+        IInstance masterInstance = IInstance(_masterInstance);
+        IRegistry.ObjectInfo memory info = _registryService.registerInstance(masterInstance, getOwner());
+        masterInstanceNftId = info.nftId;
     }
 
-    function setMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
-        require(_masterInstanceReader != address(0), "ERROR:CRD-003:INSTANCE_READER_MASTER_NOT_SET");
-        require (instanceReaderAddress != address(0), "ERROR:CRD-012:INSTANCE_READER_ZERO");
-        require(instanceReaderAddress != _masterInstanceReader, "ERROR:CRD-014:INSTANCE_READER_MASTER_SAME_AS_NEW");
+    function upgradeMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
+        if(_masterInstanceReader == address(0)) { revert ErrorInstanceServiceMasterInstanceReaderNotSet(); }
+        if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderAddressZero(); }
+        if(instanceReaderAddress == _masterInstanceReader) { revert ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader(); }
 
         InstanceReader instanceReader = InstanceReader(instanceReaderAddress);
-        require(instanceReader.getInstanceNftId() == Instance(_masterInstance).getNftId(), "ERROR:CRD-015:INSTANCE_READER_INSTANCE_MISMATCH");
+        if(instanceReader.getInstance() != IInstance(_masterInstance)) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch(); }
 
         _masterInstanceReader = instanceReaderAddress;
     }
 
-    function upgradeInstanceReader(NftId instanceNftId) external {
+    function upgradeInstanceReader(NftId instanceNftId) 
+        external 
+        onlyInstanceOwner(instanceNftId) 
+        onlyNftOfType(instanceNftId, INSTANCE())
+    {
         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), instanceNftId);
+        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
         instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
+    /// @dev create new cloned instance admin
+    /// function used to setup a new instance
+    function _createInstanceAdmin()
+        internal
+        virtual
+        returns (InstanceAdmin clonedInstanceAdmin)
+    {
+        // start with setting up a new OZ access manager
+        AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
+            Clones.clone(_masterAccessManager));
+        
+        // set up the instance admin
+        clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
+        clonedAccessManager.initialize(
+            address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
+
+        address authorization = address(
+            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
+        clonedInstanceAdmin.initialize(
+            clonedAccessManager,
+            authorization);
     }
 
-    function getMasterInstance() external view returns (address) {
-        return _masterInstance;
-    }
 
-    function getMasterInstanceAccessManager() external view returns (address) {
-        return _masterInstanceAccessManager;
+    /// @dev create new cloned instance
+    /// function used to setup a new instance
+    function _createInstance(
+        InstanceAdmin instanceAdmin,
+        address instanceOwner
+    )
+        internal
+        virtual
+        returns (IInstance)
+    {
+        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
+        BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
+        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
+
+        // clone instance
+        Instance clonedInstance = Instance(Clones.clone(_masterInstance));
+        clonedInstance.initialize(
+            instanceAdmin,
+            clonedInstanceStore,
+            clonedBundleSet,
+            clonedInstanceReader,
+            getRegistry(),
+            instanceOwner);
+        return clonedInstance;
     }
 
-    function getMasterInstanceBundleManager() external view returns (address) {
-        return _masterInstanceBundleManager;
-    }
 
-    // From IService
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return INSTANCE();
+    /// all gif targets MUST be children of instanceNftId
+    function _createGifTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        RoleId[] memory roles,
+        bytes4[][] memory selectors
+    )
+        internal
+        virtual
+    {
+        // TODO instanceAdmin will check target instance match anyway
+        (
+            IInstance instance, // or instanceInfo
+            // or targetInfo
+        ) = _validateInstanceAndComponent(instanceNftId, targetAddress);
+
+        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+
+        // TODO refactor/implement
+        // instanceAdmin.createGifTarget(targetAddress, targetName);
+
+        // set proposed target config
+        for(uint roleIdx = 0; roleIdx < roles.length; roleIdx++) {
+            // TODO refactor/implement
+            // instanceAdmin.setTargetFunctionRoleByService(targetName, selectors[roleIdx], roles[roleIdx]);
+        }
     }
     
     /// @dev top level initializer
@@ -296,50 +363,52 @@ contract InstanceService is Service, IInstanceService {
         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);
-        
+        (
+            address registryAddress,
+            address authority
+        ) = abi.decode(data, (address, address));
+
+        _initializeService(registryAddress, authority, owner);
+
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _stakingService = IStakingService(_getServiceAddress(STAKING()));
+
         _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 createTarget(NftId instanceNftId, address targetAddress, string memory targetName) external onlyRegisteredService {
+    function _validateInstanceAndComponent(NftId instanceNftId, address componentAddress) 
+        internal
+        view
+        returns (IInstance instance, NftId componentNftId)
+    {
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        accessManager.createTarget(targetAddress, targetName);
-    }
-
-    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);
+        if(instanceInfo.objectType != INSTANCE()) {
+            revert ErrorInstanceServiceNotInstanceNftId(instanceNftId);
         }
 
-        // TODO validate component type
+        if (registry.getNftIdForAddress(componentAddress).gtz()) {
+            IRegistry.ObjectInfo memory componentInfo = registry.getObjectInfo(componentAddress);
 
+            if(componentInfo.parentNftId != instanceNftId) {
+                revert ErrorInstanceServiceInstanceComponentMismatch(instanceNftId, componentInfo.nftId);
+            }
 
-        address instanceAddress = registry.getObjectInfo(componentInfo.parentNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
+            componentNftId = componentInfo.nftId;
+        } else {
+
+        }
 
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        accessManager.setTargetClosed(targetName, locked);
+        instance = Instance(instanceInfo.objectAddress);
+        
     }
-    
-}
 
+    // From IService
+    function _getDomain() internal pure override returns(ObjectType) {
+        return INSTANCE();
+    }
+}