@etherisc/gif-next 0.0.2-bb3faee-097 → 0.0.2-bb9ecaf-723

package/contracts/instance/InstanceReader.sol

@@ -4,12 +4,12 @@ pragma solidity ^0.8.20;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IAccess} from "../authorization/IAccess.sol";
+import {IBaseStore} from "./IBaseStore.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
 import {IDistributionService} from "../distribution/IDistributionService.sol";
 import {IInstance} from "./IInstance.sol";
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
 import {IOracle} from "../oracle/IOracle.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
@@ -18,7 +18,7 @@ import {IRisk} from "../instance/module/IRisk.sol";
 import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
-import {BUNDLE, COMPONENT, DISTRIBUTOR, DISTRIBUTION, FEE, PREMIUM, POLICY, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {BUNDLE, COMPONENT, DISTRIBUTION, PREMIUM, POLICY} from "../type/ObjectType.sol";
 import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
@@ -27,6 +27,7 @@ import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {PolicyServiceLib} from "../product/PolicyServiceLib.sol";
+import {ProductStore} from "./ProductStore.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
@@ -51,6 +52,7 @@ contract InstanceReader {
     InstanceAdmin internal _instanceAdmin;
 
     InstanceStore internal _store;
+    ProductStore internal _productStore;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
     IDistributionService internal _distributionService;
@@ -79,6 +81,7 @@ contract InstanceReader {
         _registry = _instance.getRegistry();
 
         _store = _instance.getInstanceStore();
+        _productStore = _instance.getProductStore();
         _bundleSet = _instance.getBundleSet();
         _riskSet = _instance.getRiskSet();
         _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
@@ -107,17 +110,10 @@ contract InstanceReader {
 
     //--- component functions ------------------------------------------------------//
 
-    /// @dev Returns the number of registered components.
-    /// Components may be products, distributions, oracles or pools.
-    function components() public view returns (uint256 componentCount) {
-        return _instanceAdmin.components();
-    }
-
 
     /// @dev Returns the component info for the given component NFT ID.
     function getComponentInfo(NftId componentNftId) public view returns (IComponents.ComponentInfo memory info) {
-        (bytes memory data, bool success) = _getData(_toComponentKey(componentNftId));
-        if (success) { return abi.decode(data, (IComponents.ComponentInfo)); }
+        return _store.getComponentInfo(componentNftId);
     }
 
 
@@ -133,8 +129,10 @@ contract InstanceReader {
     /// The wallet holds the component's funds. Tokens collected by the component are transferred to the wallet and 
     /// Tokens distributed from the component are transferred from this wallet.
     function getWallet(NftId componentNftId) public view returns (address wallet) {
-        TokenHandler tokenHandler = getTokenHandler(componentNftId);
-        if (address(tokenHandler) != address(0)) { return tokenHandler.getWallet(); }
+        IComponents.ComponentInfo memory info = getComponentInfo(componentNftId);
+        if (address(info.tokenHandler) != address(0)) { 
+            return info.tokenHandler.getWallet();
+        }
     }
 
 
@@ -143,8 +141,10 @@ contract InstanceReader {
     /// To allow a component to collect funds from an account, it has to create a corresponding allowance from the
     /// account to the address of the component's token handler.
     function getTokenHandler(NftId componentNftId) public view returns (TokenHandler tokenHandler) {
-        (bytes memory data, bool success) = _getData(_toComponentKey(componentNftId));
-        if (success) { return abi.decode(data, (IComponents.ComponentInfo)).tokenHandler; }
+        IComponents.ComponentInfo memory info = _store.getComponentInfo(componentNftId);
+        if(address(info.tokenHandler) != address(0)) {
+            return info.tokenHandler;
+        }
     }
 
 
@@ -184,15 +184,13 @@ contract InstanceReader {
 
     /// @dev Returns the product info for the given product NFT ID.
     function getProductInfo(NftId productNftId) public view returns (IComponents.ProductInfo memory info) {
-        (bytes memory data, bool success) = _getData(productNftId.toKey32(PRODUCT()));
-        if (success) { return abi.decode(data, (IComponents.ProductInfo)); }
+        return _productStore.getProductInfo(productNftId);
     }
 
 
     /// @dev Returns the current fee settings for the given product NFT ID.
     function getFeeInfo(NftId productNftId) public view returns (IComponents.FeeInfo memory feeInfo) {
-        (bytes memory data, bool success) = _getData(productNftId.toKey32(FEE()));
-        if (success) { return abi.decode(data, (IComponents.FeeInfo)); }
+        return _productStore.getFeeInfo(productNftId);
     }
 
     //--- risk functions ---------------------------------------------------------//
@@ -223,14 +221,13 @@ contract InstanceReader {
 
     /// @dev Returns the risk info for the given risk ID.
     function getRiskInfo(RiskId riskId) public view returns (IRisk.RiskInfo memory info) {
-        (bytes memory data, bool success) = _getData(riskId.toKey32()); 
-        if (success) { return abi.decode(data, (IRisk.RiskInfo)); }
+        return _productStore.getRiskInfo(riskId);
     }
 
 
     /// @dev Returns the risk state for the given risk ID.
     function getRiskState(RiskId riskId) public view returns (StateId stateId) {
-        return getState(riskId.toKey32());
+        return _productStore.getState(riskId.toKey32());
     }
 
 
@@ -250,14 +247,13 @@ contract InstanceReader {
 
     /// @dev Returns the info for the given policy NFT ID.
     function getPolicyInfo(NftId policyNftId) public view returns (IPolicy.PolicyInfo memory info) {
-        (bytes memory data, bool success) = _getData(_toPolicyKey(policyNftId));
-        if (success) { return abi.decode(data, (IPolicy.PolicyInfo)); }
+        return _productStore.getPolicyInfo(policyNftId);
     }
 
 
     /// @dev Returns the state for the given policy NFT ID.
     function getPolicyState(NftId policyNftId) public view returns (StateId state) {
-        return getState(_toPolicyKey(policyNftId));
+        return _productStore.getState(_toPolicyKey(policyNftId));
     }
 
 
@@ -282,16 +278,13 @@ contract InstanceReader {
 
     /// @dev Returns the claim info for the given policy NFT ID and claim ID.
     function getClaimInfo(NftId policyNftId, ClaimId claimId) public view returns (IPolicy.ClaimInfo memory info) {
-        (bytes memory data, bool success) = _getData(claimId.toKey32(policyNftId));
-        if (success) {
-            return abi.decode(data, (IPolicy.ClaimInfo));
-        }
+        return _productStore.getClaimInfo(policyNftId, claimId);
     }
 
 
     /// @dev Returns the current claim state for the given policy NFT ID and claim ID.
     function getClaimState(NftId policyNftId, ClaimId claimId) public view returns (StateId state) {
-        return getState(claimId.toKey32(policyNftId));
+        return _productStore.getState(claimId.toKey32(policyNftId));
     }
 
 
@@ -319,44 +312,40 @@ contract InstanceReader {
 
     /// @dev Returns the payout info for the given policy NFT ID and payout ID.
     function getPayoutInfo(NftId policyNftId, PayoutId payoutId) public view returns (IPolicy.PayoutInfo memory info) {
-        (bytes memory data, bool success) = _getData(payoutId.toKey32(policyNftId));
-        if (success) { return abi.decode(data, (IPolicy.PayoutInfo)); }
+        return _productStore.getPayoutInfo(policyNftId, payoutId);
     }
 
 
     /// @dev Returns the payout state for the given policy NFT ID and payout ID.
     function getPayoutState(NftId policyNftId, PayoutId payoutId) public view returns (StateId state) {
-        return getState(payoutId.toKey32(policyNftId));
+        return _productStore.getState(payoutId.toKey32(policyNftId));
     }
 
     //--- premium functions -------------------------------------------------------//
 
     /// @dev Returns the premium info for the given policy NFT ID.
     function getPremiumInfo(NftId policyNftId) public view returns (IPolicy.PremiumInfo memory info) {
-        (bytes memory data, bool success) = _getData(_toPremiumKey(policyNftId));
-        if (success) { return abi.decode(data, (IPolicy.PremiumInfo)); }
+        return _productStore.getPremiumInfo(policyNftId);
     }
 
 
     /// @dev Returns the premium state for the given policy NFT ID.
     function getPremiumState(NftId policyNftId) public view returns (StateId state) {
-        return getState(_toPremiumKey(policyNftId));
+        return _productStore.getState(_toPremiumKey(policyNftId));
     }
 
     //--- oracle functions ---------------------------------------------------------//
 
     /// @dev Returns the request info for the given oracle request ID.
     function getRequestInfo(RequestId requestId) public view returns (IOracle.RequestInfo memory requestInfo) {
-        (bytes memory data, bool success) = _getData(requestId.toKey32());
-        if (success) { return abi.decode(data, (IOracle.RequestInfo)); }
+        return _store.getRequestInfo(requestId);
     }
 
     //--- pool functions -----------------------------------------------------------//
 
     /// @dev Returns the pool info for the given pool NFT ID.
     function getPoolInfo(NftId poolNftId) public view returns (IComponents.PoolInfo memory info) {
-        (bytes memory data, bool success) = _getData(poolNftId.toKey32(POOL()));
-        if (success) { return abi.decode(data, (IComponents.PoolInfo)); }
+        return _store.getPoolInfo(poolNftId);
     }
 
     //--- bundle functions -------------------------------------------------------//
@@ -387,8 +376,7 @@ contract InstanceReader {
 
     /// @dev Returns the bundle info for the given bundle NFT ID.
     function getBundleInfo(NftId bundleNftId) public view  returns (IBundle.BundleInfo memory info) {
-        (bytes memory data, bool success) = _getData(_toBundleKey(bundleNftId));
-        if (success) { return abi.decode(data, (IBundle.BundleInfo)); }
+        return _store.getBundleInfo(bundleNftId);
     }
 
 
@@ -400,14 +388,12 @@ contract InstanceReader {
     //--- distribution functions -------------------------------------------------------//
 
     function getDistributorTypeInfo(DistributorType distributorType) public view returns (IDistribution.DistributorTypeInfo memory info) {
-        (bytes memory data, bool success) = _getData(distributorType.toKey32());
-        if (success) { return abi.decode(data, (IDistribution.DistributorTypeInfo)); }
+        return _store.getDistributorTypeInfo(distributorType);
     }
 
 
     function getDistributorInfo(NftId distributorNftId) public view returns (IDistribution.DistributorInfo memory info) {
-        (bytes memory data, bool success) = _getData(distributorNftId.toKey32(DISTRIBUTOR()));
-        if (success) { return abi.decode(data, (IDistribution.DistributorInfo)); }
+        return _store.getDistributorInfo(distributorNftId);
     }
 
 
@@ -424,8 +410,7 @@ contract InstanceReader {
 
 
     function getReferralInfo(ReferralId referralId) public view returns (IDistribution.ReferralInfo memory info) {
-        (bytes memory data, bool success) = _getData(referralId.toKey32());
-        if (success) { return abi.decode(data, (IDistribution.ReferralInfo)); }
+        return _store.getReferralInfo(referralId);
     }
 
 
@@ -569,22 +554,16 @@ contract InstanceReader {
         return _instanceAdmin;
     }
 
-    function getInstanceStore() external view returns (IKeyValueStore store) {
-        return _store;
-    }
-
-
     function getBundleSet() external view returns (BundleSet bundleSet) {
         return _bundleSet;
     }
 
-
     function getRiskSet() external view returns (RiskSet riskSet) {
         return _riskSet;
     }
 
 
-    function getMetadata(Key32 key) public view returns (IKeyValueStore.Metadata memory metadata) {
+    function getMetadata(Key32 key) public view returns (IBaseStore.Metadata memory metadata) {
         return _store.getMetadata(key);
     }
 
@@ -605,11 +584,6 @@ contract InstanceReader {
 
     //--- internal functions ----------------------------------------------------//
 
-    function _getData(Key32 key) internal view returns (bytes memory data, bool success) {
-        data = _store.getData(key);
-        return (data, data.length > 0);
-    }
-
 
     function _toPolicyKey(NftId policyNftId) internal pure returns (Key32) { 
         return policyNftId.toKey32(POLICY());

package/contracts/instance/InstanceService.sol

@@ -21,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";
@@ -49,6 +50,7 @@ contract InstanceService is
     address internal _masterInstanceBundleSet;
     address internal _masterInstanceRiskSet;
     address internal _masterInstanceStore;
+    address internal _masterProductStore;
 
 
     modifier onlyInstance() {
@@ -323,45 +325,54 @@ 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;
+        }
     }
 
 
@@ -426,11 +437,14 @@ contract InstanceService is
         // clone instance
         Instance clonedInstance = Instance(Clones.clone(_masterInstance));
         clonedInstance.initialize(
-            instanceAdmin,
-            InstanceStore(Clones.clone(address(_masterInstanceStore))),
-            BundleSet(Clones.clone(_masterInstanceBundleSet)),
-            RiskSet(Clones.clone(_masterInstanceRiskSet)),
-            InstanceReader(Clones.clone(address(_masterInstanceReader))),
+            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,