@etherisc/gif-next 0.0.2-d5fac82-078 → 0.0.2-d62f29e-108

package/contracts/instance/InstanceService.sol

@@ -4,14 +4,20 @@ 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 {ADMIN_ROLE, INSTANCE_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE, POOL_SERVICE_ROLE, PRODUCT_SERVICE_ROLE, APPLICATION_SERVICE_ROLE, POLICY_SERVICE_ROLE, CLAIM_SERVICE_ROLE, BUNDLE_SERVICE_ROLE, INSTANCE_ROLE} from "../type/RoleId.sol";
-import {ObjectType, INSTANCE, BUNDLE, APPLICATION, POLICY, CLAIM, PRODUCT, DISTRIBUTION, REGISTRY, POOL} from "../type/ObjectType.sol";
+import {SecondsLib} from "../type/Seconds.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {ADMIN_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_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 {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 
 import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
@@ -19,16 +25,19 @@ import {IProductComponent} from "../product/IProductComponent.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
-import {ChainNft} from "../registry/ChainNft.sol";
+import {IStakingService} from "../staking/IStakingService.sol";
+import {TargetManagerLib} from "../staking/TargetManagerLib.sol";
 
 import {Instance} from "./Instance.sol";
+import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
 import {IInstance} from "./IInstance.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-import {InstanceAuthorizationsLib} from "./InstanceAuthorizationsLib.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
+
 
 contract InstanceService is
     Service,
@@ -39,13 +48,37 @@ contract InstanceService is
     bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
 
     IRegistryService internal _registryService;
-    address internal _masterOzAccessManager;
+    IStakingService internal _stakingService;
+
+    address internal _masterAccessManager;
     address internal _masterInstanceAdmin;
     address internal _masterInstance;
     address internal _masterInstanceReader;
-    address internal _masterInstanceBundleManager;
+    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).getMajorVersion();
+        if (instanceVersion != getVersion().toMajorPart()) {
+            revert ErrorInstanceServiceInstanceVersionMismatch(instanceAddress, instanceVersion);
+        }
+
+        _;
+    }
+
+
     modifier onlyInstanceOwner(NftId instanceNftId) {        
         if(msg.sender != getRegistry().ownerOf(instanceNftId)) {
             revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
@@ -61,71 +94,118 @@ contract InstanceService is
         _;
     }
 
-    function createInstanceClone()
+    function createInstance()
         external 
         returns (
             Instance clonedInstance,
             NftId clonedInstanceNftId
         )
     {
+        // tx sender will become instance owner
         address instanceOwner = msg.sender;
-        AccessManagerExtendedInitializeable clonedOzAccessManager = AccessManagerExtendedInitializeable(
-            Clones.clone(_masterOzAccessManager));
 
-        // initially grants ADMIN_ROLE to this (being the instance service). 
-        // This will allow the instance service to bootstrap the authorizations of the instance.
-        // Instance service will renounce ADMIN_ROLE when bootstraping is finished
-        clonedOzAccessManager.initialize(address(this));
+        // create instance admin and instance
+        InstanceAdmin instanceAdmin = _createInstanceAdmin();
+        clonedInstance = _createInstance(instanceAdmin, instanceOwner);
 
-        clonedInstance = Instance(Clones.clone(_masterInstance));
-        clonedInstance.initialize(
-            address(clonedOzAccessManager),
-            address(getRegistry()), 
-            instanceOwner);
-        // initialize and set before instance reader
-        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
-        clonedInstanceStore.initialize(address(clonedInstance));
-        clonedInstance.setInstanceStore(clonedInstanceStore);
-        
-        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        clonedInstanceReader.initialize(address(clonedInstance));
-        clonedInstance.setInstanceReader(clonedInstanceReader);
-
-        BundleManager clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
-        clonedBundleManager.initialize(address(clonedInstance));
-        clonedInstance.setBundleManager(clonedBundleManager);
-
-        InstanceAdmin clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedOzAccessManager.grantRole(ADMIN_ROLE().toInt(), address(clonedInstanceAdmin), 0);
-        clonedInstanceAdmin.initialize(address(clonedInstance));
-        clonedInstance.setInstanceAdmin(clonedInstanceAdmin);
-
-        // TODO amend setters with instance specific , policy manager ...
-
-        // TODO library does external calls -> but it is registry and access manager -> find out is it best practice
-        InstanceAuthorizationsLib.grantInitialAuthorizations(
-            clonedOzAccessManager, 
-            clonedInstanceAdmin, 
-            clonedInstance, 
-            clonedBundleManager, 
-            clonedInstanceStore, 
-            instanceOwner,
-            getRegistry(),
-            getVersion().toMajorPart());
+        // register cloned instance with registry
+        clonedInstanceNftId = _registryService.registerInstance(
+            clonedInstance, instanceOwner).nftId;
 
-        clonedOzAccessManager.renounceRole(ADMIN_ROLE().toInt(), address(this));
+        // register cloned instance as staking target
+        _stakingService.createInstanceTarget(
+            clonedInstanceNftId,
+            TargetManagerLib.getDefaultLockingPeriod(),
+            TargetManagerLib.getDefaultRewardRate());
 
-        IRegistry.ObjectInfo memory info = _registryService.registerInstance(clonedInstance, instanceOwner);
-        clonedInstanceNftId = info.nftId;
+        // MUST be set after instance is set up and registered
+        instanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
 
         emit LogInstanceCloned(
-            address(clonedOzAccessManager), 
-            address(clonedInstanceAdmin), 
-            address(clonedInstance),
-            address(clonedInstanceStore),
-            address(clonedBundleManager), 
-            address(clonedInstanceReader), 
-            clonedInstanceNftId);
+            clonedInstanceNftId,
+            address(clonedInstance));
+    }
+
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceLockingPeriod(
+            instanceNftId,
+            stakeLockingPeriod);
+    }
+
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceRewardRate(
+            instanceNftId,
+            rewardRate);
+    }
+
+
+    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.refillInstanceRewardReserves(
+            instanceNftId,
+            rewardProvider,
+            dipAmount);
+    }
+
+
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+        returns (Amount newBalance)
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.withdrawInstanceRewardReserves(
+            instanceNftId,
+            dipAmount);
+    }
+
+
+    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.getObjectInfo(
+                instanceNftId).objectAddress);
+
+        // no revert in case already locked
+        // TODO refactor/implement
+        // instance.getInstanceAdmin().setTargetLockedByService(
+        //     componentAddress, 
+        //     locked);
+    }
+
+
+    function getMasterInstanceReader() external view returns (address) {
+        return _masterInstanceReader;
     }
 
     function setAndRegisterMasterInstance(address instanceAddress)
@@ -134,38 +214,39 @@ contract InstanceService is
             returns(NftId masterInstanceNftId)
     {
         if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
-        if(_masterOzAccessManager != address(0)) { revert ErrorInstanceServiceMasterOzAccessManagerAlreadySet(); }
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
-        if(_masterInstanceBundleManager != address(0)) { revert ErrorInstanceServiceMasterBundleManagerAlreadySet(); }
+        if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
 
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         IInstance instance = IInstance(instanceAddress);
-        InstanceAdmin InstanceAdmin = instance.getInstanceAdmin();
-        address InstanceAdminAddress = address(InstanceAdmin);
+        address accessManagerAddress = instance.authority();
+        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+        address instanceAdminAddress = address(instanceAdmin);
         InstanceReader instanceReader = instance.getInstanceReader();
         address instanceReaderAddress = address(instanceReader);
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         address bundleManagerAddress = address(bundleManager);
         InstanceStore instanceStore = instance.getInstanceStore();
         address instanceStoreAddress = address(instanceStore);
 
-        if(InstanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
+        if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
+        if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
-        if(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleManagerZero(); }
+        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 ErrorInstanceServiceBundleManagerAuthorityMismatch(); }
-        if(instanceStore.authority() != InstanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
+        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(); }
 
-        _masterOzAccessManager = instance.authority();
-        _masterInstanceAdmin = InstanceAdminAddress;
+        _masterAccessManager = accessManagerAddress;
+        _masterInstanceAdmin = instanceAdminAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
-        _masterInstanceBundleManager = bundleManagerAddress;
+        _masterInstanceBundleSet = bundleManagerAddress;
         _masterInstanceStore = instanceStoreAddress;
         
         IInstance masterInstance = IInstance(_masterInstance);
@@ -173,7 +254,7 @@ contract InstanceService is
         masterInstanceNftId = info.nftId;
     }
 
-    function setMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
+    function upgradeMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
         if(_masterInstanceReader == address(0)) { revert ErrorInstanceServiceMasterInstanceReaderNotSet(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderAddressZero(); }
         if(instanceReaderAddress == _masterInstanceReader) { revert ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader(); }
@@ -193,12 +274,11 @@ contract InstanceService is
         Instance instance = Instance(instanceInfo.objectAddress);
         
         InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initialize(address(instance));
+        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
         instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 
 
-    // all gif targets MUST be childs of instanceNftId
     function createGifTarget(
         NftId instanceNftId,
         address targetAddress,
@@ -207,47 +287,133 @@ contract InstanceService is
         RoleId[] memory roles
     )
         external
-        restricted
+        virtual
+        restricted()
     {
-        (
-            IInstance instance, // or instanceInfo
-            // or targetInfo
-        ) = _validateInstanceAndComponent(instanceNftId, targetAddress);
-
-        InstanceAdmin accessManager = instance.getInstanceAdmin();
-        accessManager.createGifTarget(targetAddress, targetName);
-        // set proposed target config
-        // TODO restriction: gif targets are set only once and only here?
-        //      assume config is a mix of gif and custom roles and no further configuration by INSTANCE_OWNER_ROLE is ever needed?
-        for(uint roleIdx = 0; roleIdx < roles.length; roleIdx++)
-        {
-            accessManager.setCoreTargetFunctionRole(targetName, selectors[roleIdx], roles[roleIdx]);
-        }
+        _createGifTarget(
+            instanceNftId,
+            targetAddress,
+            targetName,
+            roles,
+            selectors
+        );
     }
 
-    function setComponentLocked(bool locked) onlyComponent external {
 
-        address componentAddress = msg.sender;
-        IRegistry registry = getRegistry();
-        NftId instanceNftId = registry.getObjectInfo(componentAddress).parentNftId;
+    function initializeAuthorization(
+        NftId instanceNftId, 
+        IInstanceLinkedComponent component
+    )
+        external
+        virtual
+        restricted()
+    {
+        (IInstance instance, ) = _validateInstanceAndComponent(
+            instanceNftId, 
+            address(component));
+
+        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+        instanceAdmin.initializeComponentAuthorization(
+            component,
+            component.getAuthorization());
+    }
 
-        IInstance instance = IInstance(
-            registry.getObjectInfo(
-                instanceNftId).objectAddress);
 
-        instance.getInstanceAdmin().setTargetLockedByService(
-            componentAddress, 
-            locked);
+    function createComponentTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    )
+        external
+        virtual
+        restricted()
+    {
+        _createGifTarget(
+            instanceNftId,
+            targetAddress,
+            targetName,
+            roles,
+            selectors
+        );
     }
 
+    /// @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
+
+        clonedInstanceAdmin.initialize(
+            clonedAccessManager,
+            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
+    }
 
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
+
+    /// @dev create new cloned instance
+    /// function used to setup a new instance
+    function _createInstance(
+        InstanceAdmin instanceAdmin,
+        address instanceOwner
+    )
+        internal
+        virtual
+        returns (Instance clonedInstance)
+    {
+        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
+        BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
+        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
+
+        // clone instance
+        clonedInstance = Instance(Clones.clone(_masterInstance));
+        clonedInstance.initialize(
+            instanceAdmin,
+            clonedInstanceStore,
+            clonedBundleSet,
+            clonedInstanceReader,
+            getRegistry(),
+            instanceOwner);
     }
 
-    // From IService
-    function getDomain() public pure override 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
@@ -267,10 +433,8 @@ contract InstanceService is
 
         initializeService(registryAddress, authority, owner);
 
-        _registryService = IRegistryService(
-            IRegistry(registryAddress).getServiceAddress(
-                REGISTRY(), 
-                getVersion().toMajorPart()));
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _stakingService = IStakingService(_getServiceAddress(STAKING()));
 
         registerInterface(type(IInstanceService).interfaceId);
     }
@@ -284,7 +448,7 @@ contract InstanceService is
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
         if(instanceInfo.objectType != INSTANCE()) {
-            revert ErrorInstanceServiceNotInstance(instanceNftId);
+            revert ErrorInstanceServiceNotInstanceNftId(instanceNftId);
         }
 
         IRegistry.ObjectInfo memory componentInfo = registry.getObjectInfo(componentAddress);
@@ -295,4 +459,9 @@ contract InstanceService is
         instance = Instance(instanceInfo.objectAddress);
         componentNftId = componentInfo.nftId;
     }
+
+    // From IService
+    function _getDomain() internal pure override returns(ObjectType) {
+        return INSTANCE();
+    }
 }

package/contracts/instance/InstanceServiceManager.sol

@@ -1,13 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Instance} from "./Instance.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {InstanceService} from "./InstanceService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract InstanceServiceManager is ProxyManager {