@etherisc/gif-next 0.0.2-c00cf5d-513 → 0.0.2-c0457ac-280

package/contracts/instance/InstanceReader.sol

@@ -3,30 +3,31 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, TREASURY, BUNDLE} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, BUNDLE} from "../type/ObjectType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
-import {Registerable} from "../shared/Registerable.sol";
+import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {StateId} from "../type/StateId.sol";
 import {UFixed, MathLib, UFixedLib} from "../type/UFixed.sol";
 import {Version} from "../type/Version.sol";
-import {StateId} from "../type/StateId.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
 import {IInstance} from "./IInstance.sol";
-import {IKeyValueStore} from "../instance/base/IKeyValueStore.sol";
+import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
+import {IOracle} from "../oracle/IOracle.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
 import {TimestampLib} from "../type/Timestamp.sol";
 
 import {InstanceStore} from "./InstanceStore.sol";
@@ -40,7 +41,7 @@ contract InstanceReader {
     bool private _initialized;
 
     IInstance internal _instance;
-    IKeyValueStore internal _store;
+    InstanceStore internal _store;
 
     function initialize(address instance) public {
         if(_initialized) {
@@ -157,30 +158,19 @@ contract InstanceReader {
         }
     }
 
-    function getTokenHandler(NftId productNftId)
+    function getTokenHandler(NftId componentNftId)
         public
         view
         returns (address tokenHandler)
     {
-        bytes memory data = _store.getData(toTreasuryKey(productNftId));
+        bytes memory data = _store.getData(toComponentKey(componentNftId));
 
         if (data.length > 0) {
-            ITreasury.TreasuryInfo memory info = abi.decode(data, (ITreasury.TreasuryInfo));
+            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
             return address(info.tokenHandler);
         }
     }
 
-    function getTreasuryInfo(NftId productNftId)
-        public 
-        view 
-        returns (ITreasury.TreasuryInfo memory info)
-    {
-        bytes memory data = _store.getData(toTreasuryKey(productNftId));
-        if (data.length > 0) {
-            return abi.decode(data, (ITreasury.TreasuryInfo));
-        }
-    }
-    
     function getBundleInfo(NftId bundleNftId)
         public 
         view 
@@ -214,37 +204,48 @@ contract InstanceReader {
         }
     }
 
-    function getDistributionSetupInfo(NftId distributionNftId)
+    function getBalanceAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getBalanceAmount(targetNftId);
+    }
+
+    function getLockedAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getLockedAmount(targetNftId);
+    }
+
+    function getFeeAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getFeeAmount(targetNftId);
+    }
+
+    function getComponentInfo(NftId componentNftId)
         public
         view
-        returns (ISetup.DistributionSetupInfo memory info)
+        returns (IComponents.ComponentInfo memory info)
     {
-        bytes memory data = _store.getData(toDistributionKey(distributionNftId));
+        bytes memory data = _store.getData(toComponentKey(componentNftId));
         if (data.length > 0) {
-            return abi.decode(data, (ISetup.DistributionSetupInfo));
+            return abi.decode(data, (IComponents.ComponentInfo));
         }
     }
 
-    // TODO consider to replace by component type specific getXyzInfo
-    function getComponentInfo(NftId poolNftId)
+    function getProductInfo(NftId productNftId)
         public
         view
-        returns (IComponents.ComponentInfo memory info)
+        returns (IComponents.ProductInfo memory info)
     {
-        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        bytes memory data = _store.getData(toProductKey(productNftId));
         if (data.length > 0) {
-            return abi.decode(data, (IComponents.ComponentInfo));
+            return abi.decode(data, (IComponents.ProductInfo));
         }
     }
 
-    function getProductSetupInfo(NftId productNftId)
+    function getPoolInfo(NftId poolNftId)
         public
         view
-        returns (ISetup.ProductSetupInfo memory info)
+        returns (IComponents.PoolInfo memory info)
     {
-        bytes memory data = _store.getData(toProductKey(productNftId));
+        bytes memory data = _store.getData(toPoolKey(poolNftId));
         if (data.length > 0) {
-            return abi.decode(data, (ISetup.ProductSetupInfo));
+            return abi.decode(data, (IComponents.PoolInfo));
         }
     }
 
@@ -259,6 +260,16 @@ contract InstanceReader {
         }
     }
 
+    function getRequestInfo(RequestId requestId)
+        public
+        view
+        returns (IOracle.RequestInfo memory requestInfo)
+    {
+        bytes memory data = _store.getData(requestId.toKey32());
+        if (data.length > 0) {
+            return abi.decode(data, (IOracle.RequestInfo));
+        }
+    }
 
     function getMetadata(Key32 key)
         public 
@@ -268,6 +279,14 @@ contract InstanceReader {
         return _store.getMetadata(key);
     }
 
+    function getState(Key32 key)
+        public 
+        view 
+        returns (StateId state)
+    {
+        return _store.getMetadata(key).state;
+    }
+
 
     function toReferralId(
         NftId distributionNftId,
@@ -319,8 +338,9 @@ contract InstanceReader {
     }
 
 
-    function toTreasuryKey(NftId productNftId) public pure returns (Key32) { 
-        return productNftId.toKey32(TREASURY());
+    function hasRole(address account, RoleId roleId) public view returns (bool isMember) {
+        (isMember, ) = _instance.getInstanceAccessManager().hasRole(
+            roleId.toInt(), account);
     }
 
 
@@ -333,14 +353,18 @@ contract InstanceReader {
         return distributorNftId.toKey32(DISTRIBUTOR());
     }
 
-    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
-        return distributionNftId.toKey32(DISTRIBUTION());
-    }
-
     function toBundleKey(NftId poolNftId) public pure returns (Key32) { 
         return poolNftId.toKey32(BUNDLE());
     }
 
+    function toComponentKey(NftId componentNftId) public pure returns (Key32) { 
+        return componentNftId.toKey32(COMPONENT());
+    }
+
+    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
+        return distributionNftId.toKey32(DISTRIBUTION());
+    }
+
     function toPoolKey(NftId poolNftId) public pure returns (Key32) { 
         return poolNftId.toKey32(POOL());
     }

package/contracts/instance/InstanceService.sol

@@ -4,12 +4,18 @@ pragma solidity ^0.8.20;
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
+import {Amount} from "../type/Amount.sol";
+import {BundleManager} from "./BundleManager.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, 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 {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";
 
@@ -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 {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,6 +48,8 @@ contract InstanceService is
     bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
 
     IRegistryService internal _registryService;
+    IStakingService internal _stakingService;
+
     address internal _masterAccessManager;
     address internal _masterInstanceAdmin;
     address internal _masterInstance;
@@ -46,6 +57,28 @@ contract InstanceService is
     address internal _masterInstanceBundleManager;
     address internal _masterInstanceStore;
 
+
+    modifier onlyInstance() {        
+        address instanceAddress = msg.sender;
+        NftId instanceNftId = getRegistry().getNftId(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);
@@ -115,9 +148,16 @@ contract InstanceService is
 
         clonedAccessManager.renounceRole(ADMIN_ROLE().toInt(), address(this));
 
+        // register new instance with registry
         IRegistry.ObjectInfo memory info = _registryService.registerInstance(clonedInstance, instanceOwner);
         clonedInstanceNftId = info.nftId;
 
+        // create corresponding staking target
+        _stakingService.createInstanceTarget(
+            clonedInstanceNftId,
+            TargetManagerLib.getDefaultLockingPeriod(),
+            TargetManagerLib.getDefaultRewardRate());
+
         emit LogInstanceCloned(
             address(clonedAccessManager), 
             address(clonedInstanceAdmin), 
@@ -128,21 +168,102 @@ contract InstanceService is
             clonedInstanceNftId);
     }
 
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        _stakingService.setInstanceLockingPeriod(
+            instanceNftId,
+            stakeLockingPeriod);
+    }
+
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        _stakingService.setInstanceRewardRate(
+            instanceNftId,
+            rewardRate);
+    }
+
+
+    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+    {
+        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        _stakingService.refillInstanceRewardReserves(
+            instanceNftId,
+            rewardProvider,
+            dipAmount);
+    }
+
+
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        virtual
+        onlyInstance()
+        returns (Amount newBalance)
+    {
+        NftId instanceNftId = getRegistry().getNftId(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
+        instance.getInstanceAdmin().setTargetLockedByService(
+            componentAddress, 
+            locked);
+    }
+
+
+    function getMasterInstanceReader() external view returns (address) {
+        return _masterInstanceReader;
+    }
+
     function setAndRegisterMasterInstance(address instanceAddress)
             external 
             onlyOwner 
             returns(NftId masterInstanceNftId)
     {
         if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
-        if(_masterAccessManager != address(0)) { revert ErrorInstanceServiceMasterOzAccessManagerAlreadySet(); }
+        if(_masterAccessManager != address(0)) { revert ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet(); }
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
         if(_masterInstanceBundleManager != address(0)) { revert ErrorInstanceServiceMasterBundleManagerAlreadySet(); }
 
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         IInstance instance = IInstance(instanceAddress);
-        InstanceAdmin InstanceAdmin = instance.getInstanceAdmin();
-        address InstanceAdminAddress = address(InstanceAdmin);
+        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+        address instanceAdminAddress = address(instanceAdmin);
         InstanceReader instanceReader = instance.getInstanceReader();
         address instanceReaderAddress = address(instanceReader);
         BundleManager bundleManager = instance.getBundleManager();
@@ -150,19 +271,19 @@ contract InstanceService is
         InstanceStore instanceStore = instance.getInstanceStore();
         address instanceStoreAddress = address(instanceStore);
 
-        if(InstanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
+        if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
         if(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleManagerZero(); }
         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 ErrorInstanceServiceBundleManagerAuthorityMismatch(); }
+        if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
         if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
         if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
 
         _masterAccessManager = instance.authority();
-        _masterInstanceAdmin = InstanceAdminAddress;
+        _masterInstanceAdmin = instanceAdminAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
         _masterInstanceBundleManager = bundleManagerAddress;
@@ -198,7 +319,6 @@ contract InstanceService is
     }
 
 
-    // all gif targets MUST be childs of instanceNftId
     function createGifTarget(
         NftId instanceNftId,
         address targetAddress,
@@ -207,7 +327,50 @@ contract InstanceService is
         RoleId[] memory roles
     )
         external
-        restricted
+        virtual
+        restricted()
+    {
+        _createGifTarget(
+            instanceNftId,
+            targetAddress,
+            targetName,
+            roles,
+            selectors
+        );
+    }
+
+
+    function createComponentTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    )
+        external
+        virtual
+        restricted()
+    {
+        _createGifTarget(
+            instanceNftId,
+            targetAddress,
+            targetName,
+            roles,
+            selectors
+        );
+    }
+
+
+    /// 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
         (
@@ -220,36 +383,10 @@ contract InstanceService is
         // 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++)
-        {
+        for(uint roleIdx = 0; roleIdx < roles.length; roleIdx++) {
             instanceAdmin.setTargetFunctionRoleByService(targetName, selectors[roleIdx], roles[roleIdx]);
         }
     }
-
-    function setComponentLocked(bool locked) onlyComponent external {
-
-        address componentAddress = msg.sender;
-        IRegistry registry = getRegistry();
-        NftId instanceNftId = registry.getObjectInfo(componentAddress).parentNftId;
-
-        IInstance instance = IInstance(
-            registry.getObjectInfo(
-                instanceNftId).objectAddress);
-
-        instance.getInstanceAdmin().setTargetLockedByService(
-            componentAddress, 
-            locked);
-    }
-
-
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
-    }
-
-    // From IService
-    function getDomain() public pure override returns(ObjectType) {
-        return INSTANCE();
-    }
     
     /// @dev top level initializer
     function _initialize(
@@ -268,10 +405,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);
     }
@@ -285,7 +420,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);
@@ -296,4 +431,9 @@ contract InstanceService is
         instance = Instance(instanceInfo.objectAddress);
         componentNftId = componentInfo.nftId;
     }
+
+    // From IService
+    function _getDomain() internal pure override returns(ObjectType) {
+        return INSTANCE();
+    }
 }