@etherisc/gif-next 0.0.2-bca36d7-613 → 0.0.2-bd1522a-487

package/contracts/instance/InstanceReader.sol

@@ -3,69 +3,105 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/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, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, 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, MathLib, UFixedLib} from "../types/UFixed.sol";
-import {Version} from "../types/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 {IDistributionService} from "../distribution/IDistributionService.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 {IRegistry} from "../registry/IRegistry.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 "../types/Timestamp.sol";
+import {TimestampLib} from "../type/Timestamp.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 {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {Key32} from "../type/Key32.sol";
+import {NftId} from "../type/NftId.sol";
+import {PayoutId, PayoutIdLib} 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 {RiskSet} from "./RiskSet.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {StateId} from "../type/StateId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+
 
 
 contract InstanceReader {
-    bool private _initialized;
+
+    error ErrorInstanceReaderAlreadyInitialized();
+    error ErrorInstanceReaderInstanceAddressZero();
+
+    bool private _initialized = false;
 
     IRegistry internal _registry;
-    NftId internal _instanceNftId;
     IInstance internal _instance;
-    IKeyValueStore internal _store;
 
-    constructor(
-        address registry, 
-        NftId instanceNftId
-    )
+    InstanceStore internal _store;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
+    IDistributionService internal _distributionService;
+
+    /// @dev This initializer needs to be called from the instance itself.
+    function initialize() public {
+        if(_initialized) {
+            revert ErrorInstanceReaderAlreadyInitialized();
+        }
+
+        initializeWithInstance(msg.sender);
+    }
+
+    function initializeWithInstance(address instanceAddress)
+        public
     {
-        initialize(registry, instanceNftId);
+        if(_initialized) {
+            revert ErrorInstanceReaderAlreadyInitialized();
+        }
+
+        _initialized = true;
+        _instance = IInstance(instanceAddress);
+        _registry = _instance.getRegistry();
+
+        _store = _instance.getInstanceStore();
+        _bundleSet = _instance.getBundleSet();
+        _riskSet = _instance.getRiskSet();
+        _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
     }
 
-    function initialize(address registry, NftId instanceNftId) public {
-        require(!_initialized, "ERROR:CRD-000:ALREADY_INITIALIZED");
 
-        require(
-            address(registry) != address(0),
-            "ERROR:CRD-001:REGISTRY_ZERO");
+    // instance level functions
 
-        require(
-            instanceNftId.gtz(),
-            "ERROR:CRD-002:NFT_ID_ZERO");
+    function getRegistry() public view returns (IRegistry registry) {
+        return _registry;
+    }
 
-        _registry = IRegistry(registry);
-        _instanceNftId = instanceNftId;
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(_instanceNftId);
+    function getInstanceNftId() public view returns (NftId instanceNftid) {
+        return _registry.getNftIdForAddress(address(_instance));
+    }
 
-        require(
-            instanceInfo.objectType == INSTANCE(), 
-            "ERROR:CRD-003:PARENT_NOT_INSTANCE");
+    function getInstance() public view returns (IInstance instance) {
+        return _instance;
+    }
 
-        _instance = IInstance(instanceInfo.objectAddress);
-        _store = IKeyValueStore(instanceInfo.objectAddress);
+    function components() public view returns (uint256 componentCount) {
+        return _instance.getInstanceAdmin().components();
+    }
 
-        _initialized = true;
+    function products() public view returns (uint256 productCount) {
+        return _instance.products();
     }
 
+    function getProductNftId(uint256 idx) public view returns (NftId productNftId) {
+        return _instance.getProductNftId(idx);
+    }
 
     // module specific functions
 
@@ -80,6 +116,205 @@ contract InstanceReader {
         }
     }
 
+    function getPolicyState(NftId policyNftId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toPolicyKey(policyNftId));
+    }
+
+    function getPremiumInfo(NftId policyNftId) 
+        public
+        view
+        returns (IPolicy.PremiumInfo memory info)
+    {
+        bytes memory data = _store.getData(toPremiumKey(policyNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IPolicy.PremiumInfo));
+        }
+    }
+
+    function getPremiumInfoState(NftId policyNftId) 
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toPremiumKey(policyNftId));
+    }
+
+    function bundles(NftId poolNftId)
+        public
+        view
+        returns (uint256 bundleCount)
+    {
+        return _bundleSet.bundles(poolNftId);
+    }
+
+    function activeBundles(NftId poolNftId)
+        public
+        view
+        returns (uint256 bundleCount)
+    {
+        return _bundleSet.activeBundles(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx)
+        public
+        view
+        returns (NftId bundleNftId)
+    {
+        return _bundleSet.getActiveBundleNftId(poolNftId, idx);
+    }
+
+    function getBundleNftId(NftId poolNftId, uint256 idx)
+        public
+        view
+        returns (NftId bundleNftId)
+    {
+        return _bundleSet.getBundleNftId(poolNftId, idx);
+    }
+
+    function getBundleState(NftId bundleNftId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toBundleKey(bundleNftId));
+    }
+
+    /// @dev Returns true iff policy is active.
+    function policyIsActive(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.activatedAt > TimestampLib.blockTimestamp()) { return false; } // not yet active
+        if (info.expiredAt <= TimestampLib.blockTimestamp()) { return false; } // already expired
+
+        return true;
+    }
+
+    function claims(NftId policyNftId)
+        public
+        view
+        returns (uint16 claimCount)
+    {
+        return getPolicyInfo(policyNftId).claimsCount;
+    }
+
+
+    function getClaimId(uint idx)
+        public
+        view
+        returns (ClaimId claimId)
+    {
+        return ClaimIdLib.toClaimId(idx + 1);
+    }
+
+    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 payouts(NftId policyNftId, ClaimId claimId)
+        public
+        view
+        returns (uint24 payoutCount)
+    {
+        return getClaimInfo(policyNftId, claimId).payoutsCount;
+    }
+
+
+    function getPayoutId(ClaimId claimId, uint24 idx)
+        public
+        view
+        returns (PayoutId payoutId)
+    {
+        return PayoutIdLib.toPayoutId(claimId, idx + 1);
+    }
+
+
+    function getRemainingClaimableAmount(NftId policyNftId)
+        public
+        view
+        returns (Amount remainingClaimableAmount)
+    {
+        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
+        return info.sumInsuredAmount - info.claimAmount;
+    }
+
+    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 risks(NftId productNftId)
+        public
+        view
+        returns (uint256 riskCount)
+    {
+        return _riskSet.risks(productNftId);
+    }
+
+    function getRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getRiskId(productNftId, idx);
+    }
+
+    function activeRisks(NftId productNftId)
+        public
+        view
+        returns (uint256 activeRiskCount)
+    {
+        return _riskSet.activeRisks(productNftId);
+    }
+
+    function getActiveRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getActiveRiskId(productNftId, idx);
+    }
+
     function getRiskInfo(RiskId riskId)
         public 
         view 
@@ -91,27 +326,76 @@ contract InstanceReader {
         }
     }
 
-    function getTokenHandler(NftId productNftId)
+    function getRiskState(RiskId riskId)
+        public 
+        view 
+        returns (StateId stateId)
+    {
+        bytes memory data = _store.getData(riskId.toKey32());
+        return _store.getState(riskId.toKey32());
+    }
+
+    function policiesForRisk(RiskId riskId)
+        public
+        view
+        returns (uint256 linkedPolicies)
+    {
+        return _riskSet.linkedPolicies(riskId);
+    }
+
+    function getPolicyNftIdForRisk(RiskId riskId, uint256 idx)
+        public
+        view
+        returns (NftId linkedPolicyNftId)
+    {
+        return _riskSet.getLinkedPolicyNftId(riskId, idx);
+    }
+
+
+    function getToken(NftId componentNftId)
         public
         view
-        returns (address tokenHandler)
+        returns (IERC20Metadata token)
     {
-        bytes memory data = _store.getData(toTreasuryKey(productNftId));
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.TOKEN();
+        }
+    }
+
 
+    function getWallet(NftId componentNftId)
+        public
+        view
+        returns (address wallet)
+    {
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.getWallet();
+        }
+    }
+
+
+    function getTokenHandler(NftId componentNftId)
+        public
+        view
+        returns (TokenHandler tokenHandler)
+    {
+        bytes memory data = _store.getData(toComponentKey(componentNftId));
         if (data.length > 0) {
-            ITreasury.TreasuryInfo memory info = abi.decode(data, (ITreasury.TreasuryInfo));
-            return address(info.tokenHandler);
+            return abi.decode(data, (IComponents.ComponentInfo)).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));
         }
     }
 
@@ -137,36 +421,59 @@ 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 (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 (ISetup.DistributionSetupInfo memory info)
+        returns (IComponents.ProductInfo memory info)
     {
-        bytes memory data = _store.getData(toDistributionKey(distributionNftId));
+        bytes memory data = _store.getData(toProductKey(productNftId));
         if (data.length > 0) {
-            return abi.decode(data, (ISetup.DistributionSetupInfo));
+            return abi.decode(data, (IComponents.ProductInfo));
         }
     }
 
-    function getPoolSetupInfo(NftId poolNftId)
+    function getFeeInfo(NftId productNftId)
         public
         view
-        returns (ISetup.PoolSetupInfo memory info)
+        returns (IComponents.FeeInfo memory feeInfo)
     {
-        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        bytes memory data = _store.getData(toFeeKey(productNftId));
         if (data.length > 0) {
-            return abi.decode(data, (ISetup.PoolSetupInfo));
+            return abi.decode(data, (IComponents.FeeInfo));
         }
     }
 
-    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));
         }
     }
 
@@ -181,6 +488,26 @@ contract InstanceReader {
         }
     }
 
+    function isReferralValid(NftId distributionNftId, ReferralId referralId)
+        external
+        view
+        returns (bool isValid)
+    {
+        return _distributionService.referralIsValid(
+            distributionNftId,
+            referralId);
+    }
+
+    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 
@@ -190,6 +517,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,
@@ -241,20 +576,40 @@ 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 isLocked(address target) public view returns (bool) {
+        return _instance.getInstanceAdmin().isTargetLocked(target);
+    }
+
     function toPolicyKey(NftId policyNftId) public pure returns (Key32) { 
         return policyNftId.toKey32(POLICY());
     }
 
+    function toPremiumKey(NftId policyNftId) public pure returns (Key32) { 
+        return policyNftId.toKey32(PREMIUM());
+    }
 
     function toDistributorKey(NftId distributorNftId) public pure returns (Key32) { 
         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());
     }
@@ -267,17 +622,22 @@ contract InstanceReader {
         return productNftId.toKey32(PRODUCT());
     }
 
-    // low level function
-    function getInstance() external view returns (IInstance instance) {
-        return _instance;
+    function toFeeKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(FEE());
     }
 
+    // low level function
+
     function getInstanceStore() external view returns (IKeyValueStore store) {
         return _store;
     }
 
-    function getInstanceNftId() external view returns (NftId nftId) {
-        return _instanceNftId;
+    function getBundleSet() external view returns (BundleSet bundleSet) {
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet riskSet) {
+        return _riskSet;
     }
 
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
@@ -287,4 +647,4 @@ contract InstanceReader {
     function toInt(UFixed value) public pure returns (uint256) {
         return UFixedLib.toInt(value);
     }
-}
+}