@etherisc/gif-next 0.0.2-ffa91a6-022 → 3.0.0-04e2e0d-531

package/contracts/instance/InstanceService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 
+import {IAccess} from "../authorization/IAccess.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstance} from "./IInstance.sol";
@@ -20,6 +21,7 @@ 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";
@@ -48,6 +50,7 @@ contract InstanceService is
     address internal _masterInstanceBundleSet;
     address internal _masterInstanceRiskSet;
     address internal _masterInstanceStore;
+    address internal _masterProductStore;
 
 
     modifier onlyInstance() {
@@ -56,35 +59,100 @@ contract InstanceService is
     }
 
 
-    modifier onlyInstanceOwner(NftId instanceNftId) {        
-        if(msg.sender != getRegistry().ownerOf(instanceNftId)) {
-            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
-        }
-        _;
+    /// @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);
     }
 
 
-    // TODO check component - service - instance version match
-    modifier onlyComponent() {
-        if (! getRegistry().isRegisteredComponent(msg.sender)) {
-            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
-        }
-        _;
+    /// @inheritdoc IInstanceService
+    function setRoleActive(RoleId roleId, bool active)
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().setRoleActive(roleId, active);
     }
 
+
     /// @inheritdoc IInstanceService
-    function setInstanceLocked(bool locked)
+    function grantRole(RoleId roleId, address account)
         external
-        virtual
         restricted()
         onlyInstance()
     {
-        address instanceAddress = msg.sender;
-        IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().grantRole(roleId, account);
     }
 
 
-    /// @dev Locks/unlocks the specified target constrolled by the corresponding instance admin.
+    /// @inheritdoc IInstanceService
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().revokeRole(roleId, account);
+    }
+
+
+    /// @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);
+    }
+
+
+    /// @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);
+    }
+
+
+    /// @inheritdoc IInstanceService
+    function unauthorizeFunctions(
+        address target, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().unauthorizeFunctions(target, functions);
+    }
+
+
+    /// @inheritdoc IInstanceService
     function setTargetLocked(address target, bool locked)
         external
         virtual
@@ -96,7 +164,24 @@ contract InstanceService is
     }
 
 
-    function createInstance()
+    /// @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);
+    }
+
+
+    /// @inheritdoc IInstanceService
+    function createInstance(bool allowAnyToken)
         external 
         virtual
         restricted()
@@ -110,7 +195,7 @@ contract InstanceService is
 
         // create instance admin and instance
         InstanceAdmin instanceAdmin = _cloneNewInstanceAdmin();
-        instance = _createInstance(instanceAdmin, instanceOwner);
+        instance = _createInstance(instanceAdmin, instanceOwner, allowAnyToken);
 
         // register cloned instance with registry
         instanceNftId = _registryService.registerInstance(
@@ -120,9 +205,9 @@ contract InstanceService is
         IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
         instanceAdmin.completeSetup(
             address(getRegistry()),
-            address(instance),
             address(instanceAuthorization),
-            getRelease());
+            getRelease(),
+            address(instance));
 
         // hard checks for newly cloned instance
         assert(address(instance.getRegistry()) == address(getRegistry()));
@@ -134,7 +219,7 @@ contract InstanceService is
             TargetManagerLib.getDefaultLockingPeriod(),
             TargetManagerLib.getDefaultRewardRate());
 
-        emit LogInstanceCloned(
+        emit LogInstanceServiceInstanceCreated(
             instanceNftId,
             address(instance));
     }
@@ -178,21 +263,22 @@ contract InstanceService is
     }    
 
 
-    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
+    function refillInstanceRewardReserves(address rewardProvider, Amount dipAmount)
         external
         virtual
         restricted()
         onlyInstance()
+        returns (Amount newBalance)
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
-        _stakingService.refillInstanceRewardReserves(
+        newBalance = _stakingService.refillInstanceRewardReserves(
             instanceNftId,
             rewardProvider,
             dipAmount);
     }
 
 
-    function withdrawStakingRewardReserves(Amount dipAmount)
+    function withdrawInstanceRewardReserves(Amount dipAmount)
         external
         virtual
         restricted()
@@ -200,7 +286,7 @@ contract InstanceService is
         returns (Amount newBalance)
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
-        _stakingService.withdrawInstanceRewardReserves(
+        newBalance = _stakingService.withdrawInstanceRewardReserves(
             instanceNftId,
             dipAmount);
     }
@@ -208,6 +294,7 @@ contract InstanceService is
 
     function upgradeInstanceReader() 
         external 
+        virtual
         restricted()
         onlyInstance()
     {
@@ -219,11 +306,16 @@ contract InstanceService is
 
         upgradedInstanceReaderClone.initializeWithInstance(instanceAddress);
         instance.setInstanceReader(upgradedInstanceReaderClone);
+
+        emit LogInstanceServiceInstanceReaderUpgraded(
+            getRegistry().getNftIdForAddress(instanceAddress),
+            address(upgradedInstanceReaderClone));
     }
 
 
     function setAndRegisterMasterInstance(address instanceAddress)
         external 
+        virtual
         onlyOwner()
         returns(NftId masterInstanceNftId)
     {
@@ -233,49 +325,64 @@ contract InstanceService is
         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);
-
-        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(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(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;
+        {
+            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;
+        {
+            IInstance masterInstance = IInstance(_masterInstance);
+            IRegistry.ObjectInfo memory info = _registryService.registerInstance(masterInstance, getOwner());
+            masterInstanceNftId = info.nftId;
+            
+            emit LogInstanceServiceMasterInstanceRegistered(
+                masterInstanceNftId, _masterInstance, _masterInstanceAdmin, _masterAccessManager, 
+                _masterInstanceReader, _masterInstanceBundleSet, _masterInstanceRiskSet, _masterInstanceStore, _masterProductStore);
+        }
     }
 
+
     function upgradeMasterInstanceReader(address instanceReaderAddress)
         external
+        virtual
         onlyOwner
     {
         if(_masterInstanceReader == address(0)) { revert ErrorInstanceServiceMasterInstanceReaderNotSet(); }
@@ -286,12 +393,18 @@ contract InstanceService is
         if(instanceReader.getInstance() != IInstance(_masterInstance)) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch(); }
 
         _masterInstanceReader = instanceReaderAddress;
+
+        emit LogInstanceServiceMasterInstanceReaderUpgraded(
+            getRegistry().getNftIdForAddress(_masterInstance),
+            instanceReaderAddress);
     }
 
-    function getMasterInstanceReader() external view returns (address) {
+    function getMasterInstanceReader() external virtual view returns (address) {
         return _masterInstanceReader;
     }
 
+    //--- internal functions --------------------------------------------------------//
+
     /// @dev create new cloned instance admin
     /// function used to setup a new instance
     function _cloneNewInstanceAdmin()
@@ -318,63 +431,34 @@ contract InstanceService is
     /// function used to setup a new instance
     function _createInstance(
         InstanceAdmin instanceAdmin,
-        address instanceOwner
+        address instanceOwner,
+        bool allowAnyToken
     )
         internal
         virtual
         returns (IInstance)
     {
-        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
-        BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
-        RiskSet clonedRiskSet = RiskSet(Clones.clone(_masterInstanceRiskSet));
-        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-
         // clone instance
         Instance clonedInstance = Instance(Clones.clone(_masterInstance));
         clonedInstance.initialize(
-            instanceAdmin,
-            clonedInstanceStore,
-            clonedBundleSet,
-            clonedRiskSet,
-            clonedInstanceReader,
+            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);
+            instanceOwner,
+            allowAnyToken);
 
         return clonedInstance;
     }
 
 
-    /// 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
+    /// @dev top level initializer (upgradable contract)
     function _initialize(
         address owner, 
         bytes memory data
@@ -398,34 +482,6 @@ contract InstanceService is
     }
 
 
-    function _validateInstanceAndComponent(NftId instanceNftId, address componentAddress) 
-        internal
-        view
-        returns (IInstance instance, NftId componentNftId)
-    {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        if(instanceInfo.objectType != INSTANCE()) {
-            revert ErrorInstanceServiceNotInstanceNftId(instanceNftId);
-        }
-
-        if (registry.getNftIdForAddress(componentAddress).gtz()) {
-            IRegistry.ObjectInfo memory componentInfo = registry.getObjectInfo(componentAddress);
-
-            if(componentInfo.parentNftId != instanceNftId) {
-                revert ErrorInstanceServiceInstanceComponentMismatch(instanceNftId, componentInfo.nftId);
-            }
-
-            componentNftId = componentInfo.nftId;
-        } else {
-
-        }
-
-        instance = Instance(instanceInfo.objectAddress);
-        
-    }
-
-
     function _checkInstance(
         address instanceAddress,
         VersionPart expectedRelease