@etherisc/gif-next 0.0.2-ff1bf36-818 → 0.0.2-ff795d8-141

package/contracts/instance/InstanceReader.sol

@@ -1,33 +1,43 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {ClaimId} from "../type/ClaimId.sol";
-import {DistributorType} from "../type/DistributorType.sol";
-import {Key32} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {COMPONENT, DISTRIBUTOR, DISTRIBUTION, 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, UFixedLib} from "../type/UFixed.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {IAccess} from "../authorization/IAccess.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";
 import {IRisk} from "../instance/module/IRisk.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 {PolicyServiceLib} from "../product/PolicyServiceLib.sol";
+import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
+import {RequestId} from "../type/RequestId.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {RoleId, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
+import {StateId} from "../type/StateId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
+/// @dev Central reader contract for a specific instance.
+/// Should provide convenient reading functions for all instance and related component data.
 contract InstanceReader {
 
     error ErrorInstanceReaderAlreadyInitialized();
@@ -35,8 +45,13 @@ contract InstanceReader {
 
     bool private _initialized = false;
 
+    IRegistry internal _registry;
     IInstance internal _instance;
+
     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 {
@@ -47,18 +62,50 @@ contract InstanceReader {
         initializeWithInstance(msg.sender);
     }
 
-    /// @dev This initializer needs to be called from the instance itself.
-    function initializeWithInstance(address instanceAddress) public {
+    function initializeWithInstance(address instanceAddress)
+        public
+    {
         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()));
     }
 
 
+    // instance level functions
+
+    function getRegistry() public view returns (IRegistry registry) {
+        return _registry;
+    }
+
+    function getInstanceNftId() public view returns (NftId instanceNftid) {
+        return _registry.getNftIdForAddress(address(_instance));
+    }
+
+    function getInstance() public view returns (IInstance instance) {
+        return _instance;
+    }
+
+    function components() public view returns (uint256 componentCount) {
+        return _instance.getInstanceAdmin().components();
+    }
+
+    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
 
     function getPolicyInfo(NftId policyNftId)
@@ -80,6 +127,57 @@ contract InstanceReader {
         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
@@ -88,33 +186,30 @@ contract InstanceReader {
         return _store.getState(toBundleKey(bundleNftId));
     }
 
-    /// @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)
+    /// @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.closedAt.gtz()) { return false; } // not closeable: already closed
-        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
+        return PolicyServiceLib.policyIsActive(this, policyNftId);
+    }
 
-        // 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; }
+    function claims(NftId policyNftId)
+        public
+        view
+        returns (uint16 claimCount)
+    {
+        return getPolicyInfo(policyNftId).claimsCount;
+    }
 
-        // not closeable: not yet expired
-        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
 
-        // all conditionsl to close the policy are met
-        return true; 
+    function getClaimId(uint idx)
+        public
+        pure
+        returns (ClaimId claimId)
+    {
+        return ClaimIdLib.toClaimId(idx + 1);
     }
 
     function getClaimInfo(NftId policyNftId, ClaimId claimId)
@@ -128,6 +223,7 @@ contract InstanceReader {
         }
     }
 
+
     function getClaimState(NftId policyNftId, ClaimId claimId)
         public
         view
@@ -136,6 +232,34 @@ contract InstanceReader {
         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
+        pure
+        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
@@ -155,6 +279,38 @@ contract InstanceReader {
         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 
@@ -166,19 +322,68 @@ contract InstanceReader {
         }
     }
 
+    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 (IERC20Metadata token)
+    {
+        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 (address tokenHandler)
+        returns (TokenHandler tokenHandler)
     {
         bytes memory data = _store.getData(toComponentKey(componentNftId));
-
         if (data.length > 0) {
-            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return address(info.tokenHandler);
+            return abi.decode(data, (IComponents.ComponentInfo)).tokenHandler;
         }
     }
 
+
     function getBundleInfo(NftId bundleNftId)
         public 
         view 
@@ -246,6 +451,17 @@ contract InstanceReader {
         }
     }
 
+    function getFeeInfo(NftId productNftId)
+        public
+        view
+        returns (IComponents.FeeInfo memory feeInfo)
+    {
+        bytes memory data = _store.getData(toFeeKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.FeeInfo));
+        }
+    }
+
     function getPoolInfo(NftId poolNftId)
         public
         view
@@ -268,6 +484,16 @@ contract InstanceReader {
         }
     }
 
+    function isReferralValid(NftId distributionNftId, ReferralId referralId)
+        external
+        view
+        returns (bool isValid)
+    {
+        return _distributionService.referralIsValid(
+            distributionNftId,
+            referralId);
+    }
+
     function getRequestInfo(RequestId requestId)
         public
         view
@@ -279,6 +505,7 @@ contract InstanceReader {
         }
     }
 
+
     function getMetadata(Key32 key)
         public 
         view 
@@ -287,6 +514,7 @@ contract InstanceReader {
         return _store.getMetadata(key);
     }
 
+
     function getState(Key32 key)
         public 
         view 
@@ -318,90 +546,159 @@ contract InstanceReader {
             ReferralStatus status
         )
     {
-        IDistribution.ReferralInfo memory info = getReferralInfo(
-            referralId);        
+        return IDistributionService(
+            _registry.getServiceAddress(
+                DISTRIBUTION(),
+                _instance.getRelease())).getDiscountPercentage(
+                    this, // instance reader
+                    referralId);
+    }
 
-        if (info.expiryAt.eqz()) {
-            return (
-                UFixedLib.zero(),
-                REFERRAL_ERROR_UNKNOWN());
-        }
 
-        if (info.expiryAt < TimestampLib.blockTimestamp()) {
-            return (
-                UFixedLib.zero(),
-                REFERRAL_ERROR_EXPIRED());
-        }
+    function roles() public view returns (uint256) {
+        return _instance.getInstanceAdmin().roles();
+    }
 
-        if (info.usedReferrals >= info.maxReferrals) {
-            return (
-                UFixedLib.zero(),
-                REFERRAL_ERROR_EXHAUSTED());
-        }
 
-        return (
-            info.discountPercentage,
-            REFERRAL_OK()
-        );
+    function getInstanceOwnerRole() public pure returns (RoleId roleId) {
+        return INSTANCE_OWNER_ROLE();
+    }
+
+
+    function getRoleId(uint256 idx) public view returns (RoleId roleId) {
+        return _instance.getInstanceAdmin().getRoleId(uint64(idx));
+    }
+
+    function roleExists(RoleId roleId) public view returns (bool exists) {
+        return _instance.getInstanceAdmin().roleExists(roleId);
+    }
+
+    function getRoleInfo(RoleId roleId) public view returns (IAccess.RoleInfo memory roleInfo) { 
+        return _instance.getInstanceAdmin().getRoleInfo(roleId);
+    }
+
+
+    function isRoleCustom(RoleId roleId) public view returns (bool isCustom) {
+        return _instance.getInstanceAdmin().isRoleCustom(roleId);
+    }
+
+
+    function isRoleActive(RoleId roleId) public view returns (bool isActive) {
+        return _instance.getInstanceAdmin().isRoleActive(roleId);
+    }
+
+
+    function roleMembers(RoleId roleId) public view returns (uint256 numberOfMembers) {
+        return _instance.getInstanceAdmin().roleMembers(roleId);
+    }
+
+
+    function getRoleMember(RoleId roleId, uint256 idx) public view returns (address account) {
+        return _instance.getInstanceAdmin().getRoleMember(roleId, idx);
+    }
+
+
+    function isRoleMember(RoleId roleId, address account) public view returns (bool isMember) {
+        return _instance.getInstanceAdmin().isRoleMember(roleId, account);
+    }
+
+
+    function isRoleAdmin(RoleId roleId, address account) public view returns (bool isMember) {
+        return _instance.getInstanceAdmin().isRoleAdmin(roleId, account);
+    }
+
+
+    function targets() public view returns (uint256 targetCount) {
+        return _instance.getInstanceAdmin().targets();
+    }
+
+
+    function getTargetAddress(uint256 idx) public view returns (address target) {
+        return _instance.getInstanceAdmin().getTargetAddress(idx);
     }
 
 
-    function hasRole(address account, RoleId roleId) public view returns (bool isMember) {
-        return _instance.getInstanceAdmin().hasRole(account, roleId);
+    function targetExists(address target) public view returns (bool exists) {
+        return _instance.getInstanceAdmin().targetExists(target);
     }
 
 
-    function hasAdminRole(address account, RoleId roleId) public view returns (bool isMember) {
-        return _instance.getInstanceAdmin().hasAdminRole(account, roleId);
+    function getTargetInfo(address target) public view returns (IAccess.TargetInfo memory targetInfo) {
+        return _instance.getInstanceAdmin().getTargetInfo(target);
     }
 
 
-    function isTargetLocked(address target) public view returns (bool) {
+    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());
     }
 
+
     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;
+
+    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 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) {
         return UFixedLib.toUFixed(value, exp);
     }
 
+
     function toInt(UFixed value) public pure returns (uint256) {
         return UFixedLib.toInt(value);
     }