@etherisc/gif-next 0.0.2-c5049d4-401 → 0.0.2-c554b1e-622

package/contracts/instance/InstanceService.sol

@@ -2,41 +2,31 @@
 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, 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 {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IProductComponent} from "../product/IProductComponent.sol";
 
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstance} from "./IInstance.sol";
+import {IInstanceService} from "./IInstanceService.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 {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.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 {InstanceStore} from "./InstanceStore.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, INSTANCE, COMPONENT, INSTANCE, REGISTRY, STAKING} from "../type/ObjectType.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {VersionPart, VersionPartLib} from "../type/Version.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
@@ -49,32 +39,19 @@ contract InstanceService is
 
     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;
 
 
-    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 onlyInstance() {
+        _checkInstance(msg.sender, getRelease());
         _;
     }
 
@@ -86,6 +63,7 @@ contract InstanceService is
         _;
     }
 
+
     // TODO check component - service - instance version match
     modifier onlyComponent() {
         if (! getRegistry().isRegisteredComponent(msg.sender)) {
@@ -94,42 +72,78 @@ contract InstanceService is
         _;
     }
 
+    /// @inheritdoc IInstanceService
+    function setInstanceLocked(bool locked)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
+    }
+
+
+    /// @dev Locks/unlocks the specified target constrolled by the corresponding instance admin.
+    function setTargetLocked(address target, bool locked)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance(instanceAddress).getInstanceAdmin().setTargetLocked(target, locked);
+    }
+
+
     function createInstance()
         external 
+        virtual
+        restricted()
         returns (
-            Instance clonedInstance,
-            NftId clonedInstanceNftId
+            IInstance instance,
+            NftId instanceNftId
         )
     {
         // tx sender will become instance owner
         address instanceOwner = msg.sender;
 
         // create instance admin and instance
-        InstanceAdmin instanceAdmin = _createInstanceAdmin();
-        clonedInstance = _createInstance(instanceAdmin, instanceOwner);
+        InstanceAdmin instanceAdmin = _cloneNewInstanceAdmin();
+        instance = _createInstance(instanceAdmin, instanceOwner);
 
         // register cloned instance with registry
-        clonedInstanceNftId = _registryService.registerInstance(
-            clonedInstance, instanceOwner).nftId;
+        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(instance),
+            address(instanceAuthorization),
+            getRelease());
+
+        // hard checks for newly cloned instance
+        assert(address(instance.getRegistry()) == address(getRegistry()));
+        assert(instance.getRelease() == getRelease());
 
         // register cloned instance as staking target
         _stakingService.createInstanceTarget(
-            clonedInstanceNftId,
+            instanceNftId,
             TargetManagerLib.getDefaultLockingPeriod(),
             TargetManagerLib.getDefaultRewardRate());
 
-        // MUST be set after instance is set up and registered
-        instanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
-
         emit LogInstanceCloned(
-            clonedInstanceNftId,
-            address(clonedInstance));
+            instanceNftId,
+            address(instance));
     }
 
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -142,6 +156,7 @@ contract InstanceService is
     function setStakingRewardRate(UFixed rewardRate)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -150,10 +165,23 @@ contract InstanceService is
             rewardRate);
     }
 
+    function setStakingMaxAmount(Amount maxStakedAmount)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        _stakingService.setInstanceMaxStakedAmount(
+            instanceNftId,
+            maxStakedAmount);
+    }    
+
 
     function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -167,6 +195,7 @@ contract InstanceService is
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
         returns (Amount newBalance)
     {
@@ -177,46 +206,31 @@ contract InstanceService is
     }
 
 
-    function setComponentLocked(bool locked)
-        external
-        virtual
-        onlyComponent()
+    function upgradeInstanceReader() 
+        external 
+        restricted()
+        onlyInstance()
     {
-        // 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);
+        address instanceAddress = msg.sender;
+        IInstance instance = IInstance(msg.sender);
+        
+        InstanceReader upgradedInstanceReaderClone = InstanceReader(
+            Clones.clone(address(_masterInstanceReader)));
 
-        // no revert in case already locked
-        // TODO refactor/implement
-        // instance.getInstanceAdmin().setTargetLockedByService(
-        //     componentAddress, 
-        //     locked);
+        upgradedInstanceReaderClone.initializeWithInstance(instanceAddress);
+        instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 
 
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
-    }
-
     function setAndRegisterMasterInstance(address instanceAddress)
-            external 
-            onlyOwner 
-            returns(NftId masterInstanceNftId)
+        external 
+        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);
@@ -225,28 +239,34 @@ contract InstanceService is
         address instanceAdminAddress = address(instanceAdmin);
         InstanceReader instanceReader = instance.getInstanceReader();
         address instanceReaderAddress = address(instanceReader);
-        BundleSet bundleManager = instance.getBundleSet();
-        address bundleManagerAddress = address(bundleManager);
+        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(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+        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(bundleManager.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+        if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+        if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
         if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
-        if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
+        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 = bundleManagerAddress;
+        _masterInstanceBundleSet = bundleSetAddress;
+        _masterInstanceRiskSet = riskSetAddress;
         _masterInstanceStore = instanceStoreAddress;
         
         IInstance masterInstance = IInstance(_masterInstance);
@@ -254,7 +274,10 @@ contract InstanceService is
         masterInstanceNftId = info.nftId;
     }
 
-    function upgradeMasterInstanceReader(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(); }
@@ -265,99 +288,29 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
     }
 
-    function upgradeInstanceReader(NftId instanceNftId) 
-        external 
-        onlyInstanceOwner(instanceNftId) 
-    {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        
-        InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
-        instance.setInstanceReader(upgradedInstanceReaderClone);
-    }
-
-
-    function createGifTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    )
-        external
-        virtual
-        restricted()
-    {
-        _createGifTarget(
-            instanceNftId,
-            targetAddress,
-            targetName,
-            roles,
-            selectors
-        );
-    }
-
-
-    function initializeAuthorization(
-        NftId instanceNftId, 
-        IInstanceLinkedComponent component
-    )
-        external
-        virtual
-        restricted()
-    {
-        (IInstance instance, ) = _validateInstanceAndComponent(
-            instanceNftId, 
-            address(component));
-
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        instanceAdmin.initializeComponentAuthorization(
-            component,
-            component.getAuthorization());
-    }
-
-
-    function createComponentTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    )
-        external
-        virtual
-        restricted()
-    {
-        _createGifTarget(
-            instanceNftId,
-            targetAddress,
-            targetName,
-            roles,
-            selectors
-        );
+    function getMasterInstanceReader() external view returns (address) {
+        return _masterInstanceReader;
     }
 
     /// @dev create new cloned instance admin
     /// function used to setup a new instance
-    function _createInstanceAdmin()
+    function _cloneNewInstanceAdmin()
         internal
         virtual
-        returns (InstanceAdmin clonedInstanceAdmin)
+        returns (InstanceAdmin clonedAdmin)
     {
-        // start with setting up a new OZ access manager
+        // clone instance specific access manager
         AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
-            Clones.clone(_masterAccessManager));
+            Clones.clone(
+                InstanceAdmin(_masterInstanceAdmin).authority()));
         
         // set up the instance admin
-        clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedAccessManager.initialize(
-            address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
+        clonedAdmin = InstanceAdmin(
+            Clones.clone(_masterInstanceAdmin));
 
-        clonedInstanceAdmin.initialize(
-            clonedAccessManager,
-            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
+        clonedAdmin.initialize(
+            address(clonedAccessManager),
+            "InstanceAdmin");
     }
 
 
@@ -369,21 +322,26 @@ contract InstanceService is
     )
         internal
         virtual
-        returns (Instance clonedInstance)
+        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
-        clonedInstance = Instance(Clones.clone(_masterInstance));
+        Instance clonedInstance = Instance(Clones.clone(_masterInstance));
         clonedInstance.initialize(
             instanceAdmin,
             clonedInstanceStore,
             clonedBundleSet,
+            clonedRiskSet,
             clonedInstanceReader,
             getRegistry(),
+            getRelease(),
             instanceOwner);
+
+        return clonedInstance;
     }
 
 
@@ -426,14 +384,15 @@ contract InstanceService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _stakingService = IStakingService(_getServiceAddress(STAKING()));
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
         _registerInterface(type(IInstanceService).interfaceId);
     }
@@ -450,15 +409,52 @@ contract InstanceService is
             revert ErrorInstanceServiceNotInstanceNftId(instanceNftId);
         }
 
-        IRegistry.ObjectInfo memory componentInfo = registry.getObjectInfo(componentAddress);
-        if(componentInfo.parentNftId != instanceNftId) {
-            revert ErrorInstanceServiceInstanceComponentMismatch(instanceNftId, componentInfo.nftId);
+        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);
-        componentNftId = componentInfo.nftId;
+        
     }
 
+
+    function _checkInstance(
+        address instanceAddress,
+        VersionPart expectedRelease
+    )
+        internal
+        virtual
+        view
+    {
+        IRegistry registry = getRegistry();
+
+        NftId instanceNftId = registry.getNftIdForAddress(instanceAddress);
+        if (instanceNftId.eqz()) {
+            revert ErrorInstanceServiceNotRegistered(instanceAddress);
+        }
+
+        ObjectType objectType = registry.getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorInstanceServiceNotInstance(instanceAddress, objectType);
+        }
+
+        if (expectedRelease.gtz()) {
+            VersionPart instanceRelease = IInstance(instanceAddress).getRelease();
+            if (instanceRelease != expectedRelease) {
+                revert ErrorInstanceServiceInstanceVersionMismatch(instanceNftId, expectedRelease, instanceRelease);
+            }
+        }
+    }
+
+
     // From IService
     function _getDomain() internal pure override returns(ObjectType) {
         return INSTANCE();

package/contracts/instance/InstanceServiceManager.sol

@@ -17,7 +17,7 @@ contract InstanceServiceManager is ProxyManager {
     ) 
     {
         InstanceService svc = new InstanceService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/instance/InstanceStore.sol

@@ -7,10 +7,10 @@ import {Amount} from "../type/Amount.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR, FEE} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {StateId} from "../type/StateId.sol";
+import {StateId, KEEP_STATE} from "../type/StateId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -85,6 +85,17 @@ contract InstanceStore is
         _update(_toNftKey32(productNftId, PRODUCT()), abi.encode(info), newState);
     }
 
+
+    //--- Fee -----------------------------------------------------------//
+    function createFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _create(_toNftKey32(productNftId, FEE()), abi.encode(info));
+    }
+
+    // Fee only has one state, so no change change possible
+    function updateFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _update(_toNftKey32(productNftId, FEE()), abi.encode(info), KEEP_STATE());
+    }
+
     //--- Pool --------------------------------------------------------------//
 
     function createPool(