@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-ce8fb44-591

package/contracts/instance/InstanceReader.sol

@@ -1,61 +1,69 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {DistributorType} from "../types/DistributorType.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {Key32} from "../types/Key32.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType, DISTRIBUTOR, INSTANCE, PRODUCT, POLICY, TREASURY} from "../types/ObjectType.sol";
-import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../types/Referral.sol";
-import {Registerable} from "../shared/Registerable.sol";
-import {RiskId} from "../types/RiskId.sol";
-import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
-import {Version} from "../types/Version.sol";
+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, 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 {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 {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 {ITreasury} from "../instance/module/ITreasury.sol";
-import {TimestampLib} from "../types/Timestamp.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+
+import {InstanceStore} from "./InstanceStore.sol";
 
 
 contract InstanceReader {
 
-    IRegistry internal _registry;
-    NftId internal _instanceNftId;
-    IInstance internal _instance;
-    IKeyValueStore internal _store;
+    error ErrorInstanceReaderAlreadyInitialized();
+    error ErrorInstanceReaderInstanceAddressZero();
 
-    constructor(
-        address registry, 
-        NftId instanceNftId
-    )
-    {
-        require(
-            address(registry) != address(0),
-            "ERROR:CRD-001:REGISTRY_ZERO");
+    bool private _initialized = false;
 
-        require(
-            instanceNftId.gtz(),
-            "ERROR:CRD-002:NFT_ID_ZERO");
+    IInstance internal _instance;
+    InstanceStore internal _store;
 
-        _registry = IRegistry(registry);
-        _instanceNftId = instanceNftId;
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(_instanceNftId);
+    /// @dev This initializer needs to be called from the instance itself.
+    function initialize() public {
+        if(_initialized) {
+            revert ErrorInstanceReaderAlreadyInitialized();
+        }
 
-        require(
-            instanceInfo.objectType == INSTANCE(), 
-            "ERROR:CRD-003:PARENT_NOT_INSTANCE");
+        initializeWithInstance(msg.sender);
+    }
 
-        _instance = IInstance(instanceInfo.objectAddress);
-        _store = IKeyValueStore(instanceInfo.objectAddress);
+    /// @dev This initializer needs to be called from the instance itself.
+    function initializeWithInstance(address instanceAddress) public {
+        if(_initialized) {
+            revert ErrorInstanceReaderAlreadyInitialized();
+        }
+
+        _initialized = true;
+        _instance = IInstance(instanceAddress);
+        _store = _instance.getInstanceStore();
     }
 
+
     // module specific functions
 
     function getPolicyInfo(NftId policyNftId)
@@ -69,6 +77,81 @@ contract InstanceReader {
         }
     }
 
+    function getPolicyState(NftId policyNftId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toPolicyKey(policyNftId));
+    }
+
+    /// @dev returns true iff policy may be closed
+    /// a policy can be closed all conditions below are met
+    /// - policy exists
+    /// - has been activated
+    /// - is not yet closed
+    /// - has no open claims
+    /// - claim amount matches sum insured amount or is expired
+    function policyIsCloseable(NftId policyNftId)
+        public
+        view
+        returns (bool isCloseable)
+    {
+        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
+
+        if (info.productNftId.eqz()) { return false; } // not closeable: policy does not exist (or does not belong to this instance)
+        if (info.activatedAt.eqz()) { return false; } // not closeable: not yet activated
+        if (info.closedAt.gtz()) { return false; } // not closeable: already closed
+        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
+
+        // closeable: if sum of claims matches sum insured a policy may be closed prior to the expiry date
+        if (info.claimAmount == info.sumInsuredAmount) { return true; }
+
+        // not closeable: not yet expired
+        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
+
+        // all conditionsl to close the policy are met
+        return true; 
+    }
+
+    function getClaimInfo(NftId policyNftId, ClaimId claimId)
+        public
+        view
+        returns (IPolicy.ClaimInfo memory info)
+    {
+        bytes memory data = _store.getData(claimId.toKey32(policyNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IPolicy.ClaimInfo));
+        }
+    }
+
+    function getClaimState(NftId policyNftId, ClaimId claimId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(claimId.toKey32(policyNftId));
+    }
+
+    function getPayoutInfo(NftId policyNftId, PayoutId payoutId)
+        public
+        view
+        returns (IPolicy.PayoutInfo memory info)
+    {
+        bytes memory data = _store.getData(payoutId.toKey32(policyNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IPolicy.PayoutInfo));
+        }
+    }
+
+    function getPayoutState(NftId policyNftId, PayoutId payoutId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(payoutId.toKey32(policyNftId));
+    }
+
     function getRiskInfo(RiskId riskId)
         public 
         view 
@@ -80,27 +163,27 @@ 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)
+    function getBundleInfo(NftId bundleNftId)
         public 
         view 
-        returns (ITreasury.TreasuryInfo memory info)
+        returns (IBundle.BundleInfo memory info)
     {
-        bytes memory data = _store.getData(toTreasuryKey(productNftId));
+        bytes memory data = _store.getData(toBundleKey(bundleNftId));
         if (data.length > 0) {
-            return abi.decode(data, (ITreasury.TreasuryInfo));
+            return abi.decode(data, (IBundle.BundleInfo));
         }
     }
 
@@ -126,6 +209,50 @@ contract InstanceReader {
         }
     }
 
+    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 (IComponents.ComponentInfo memory info)
+    {
+        bytes memory data = _store.getData(toComponentKey(componentNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.ComponentInfo));
+        }
+    }
+
+    function getProductInfo(NftId productNftId)
+        public
+        view
+        returns (IComponents.ProductInfo memory info)
+    {
+        bytes memory data = _store.getData(toProductKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.ProductInfo));
+        }
+    }
+
+    function getPoolInfo(NftId poolNftId)
+        public
+        view
+        returns (IComponents.PoolInfo memory info)
+    {
+        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.PoolInfo));
+        }
+    }
 
     function getReferralInfo(ReferralId referralId)
         public 
@@ -138,6 +265,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 
@@ -147,6 +284,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,
@@ -175,19 +320,19 @@ contract InstanceReader {
 
         if (info.expiryAt.eqz()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_UNKNOWN());
         }
 
         if (info.expiryAt < TimestampLib.blockTimestamp()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXPIRED());
         }
 
         if (info.usedReferrals >= info.maxReferrals) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXHAUSTED());
         }
 
@@ -198,11 +343,20 @@ 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) {
+        return _instance.getInstanceAdmin().hasRole(account, roleId);
+    }
+
+
+    function hasAdminRole(address account, RoleId roleId) public view returns (bool isMember) {
+        return _instance.getInstanceAdmin().hasAdminRole(account, roleId);
     }
 
 
+    function isTargetLocked(address target) public view returns (bool) {
+        return _instance.getInstanceAdmin().isTargetLocked(target);
+    }
+
     function toPolicyKey(NftId policyNftId) public pure returns (Key32) { 
         return policyNftId.toKey32(POLICY());
     }
@@ -212,6 +366,26 @@ contract InstanceReader {
         return distributorNftId.toKey32(DISTRIBUTOR());
     }
 
+    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());
+    }
+
+    function toProductKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(PRODUCT());
+    }
+
     // low level function
     function getInstance() external view returns (IInstance instance) {
         return _instance;
@@ -221,15 +395,11 @@ contract InstanceReader {
         return _store;
     }
 
-    function getInstanceNftId() external view returns (NftId nftId) {
-        return _instanceNftId;
-    }
-
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
-        return UFixedMathLib.toUFixed(value, exp);
+        return UFixedLib.toUFixed(value, exp);
     }
 
     function toInt(UFixed value) public pure returns (uint256) {
-        return UFixedMathLib.toInt(value);
+        return UFixedLib.toInt(value);
     }
-}
+}