@etherisc/gif-next 0.0.2-7f39e38-904 → 0.0.2-7fbee0d-269

package/contracts/instance/InstanceReader.sol

@@ -3,282 +3,436 @@ 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, COMPONENT, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, FEE, 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 {RiskId} from "../type/RiskId.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 {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";
 import {IRisk} from "../instance/module/IRisk.sol";
-import {TimestampLib} from "../type/Timestamp.sol";
 
+import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.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";
 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 {ProductStore} from "./ProductStore.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.
+/// Provides reading functions for all instance data and related component data.
 contract InstanceReader {
 
     error ErrorInstanceReaderAlreadyInitialized();
     error ErrorInstanceReaderInstanceAddressZero();
 
-    bool private _initialized;
+    bool private _initialized = false;
 
+    IRegistry internal _registry;
     IInstance internal _instance;
+    InstanceAdmin internal _instanceAdmin;
+
     InstanceStore internal _store;
+    ProductStore internal _productStore;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
+    IDistributionService internal _distributionService;
 
-    function initialize(address instance) public {
+    /// @dev This initializer needs to be called from the instance itself.
+    function initialize() public {
         if(_initialized) {
             revert ErrorInstanceReaderAlreadyInitialized();
         }
 
-        if(instance == address(0)) {
-            revert ErrorInstanceReaderInstanceAddressZero();
+        initializeWithInstance(msg.sender);
+    }
+
+
+    /// @dev Initializer to upgrade instance reader via instance service
+    function initializeWithInstance(address instanceAddress)
+        public
+    {
+        if(_initialized) {
+            revert ErrorInstanceReaderAlreadyInitialized();
         }
 
-        _instance = IInstance(instance);
+        _initialized = true;
+        _instance = IInstance(instanceAddress);
+        _instanceAdmin = _instance.getInstanceAdmin();
+        _registry = _instance.getRegistry();
+
         _store = _instance.getInstanceStore();
+        _productStore = _instance.getProductStore();
+        _bundleSet = _instance.getBundleSet();
+        _riskSet = _instance.getRiskSet();
+        _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
+    }
 
-        _initialized = true;
+
+    //--- instance functions ---------------------------------------------------------//
+
+    /// @dev Returns the registry this instance is registered in.
+    function getRegistry() public view returns (IRegistry registry) {
+        return _registry;
     }
 
 
-    // module specific functions
+    /// @dev Returns the instance NFT ID.
+    function getInstanceNftId() public view returns (NftId instanceNftid) {
+        return _registry.getNftIdForAddress(address(_instance));
+    }
 
-    function getPolicyInfo(NftId policyNftId)
-        public
-        view
-        returns (IPolicy.PolicyInfo memory info)
-    {
-        bytes memory data = _store.getData(toPolicyKey(policyNftId));
-        if (data.length > 0) {
-            return abi.decode(data, (IPolicy.PolicyInfo));
+
+    /// @dev Returns the instance contract.
+    function getInstance() public view returns (IInstance instance) {
+        return _instance;
+    }
+
+
+    //--- component functions ------------------------------------------------------//
+
+
+    /// @dev Returns the component info for the given component NFT ID.
+    function getComponentInfo(NftId componentNftId) public view returns (IComponents.ComponentInfo memory info) {
+        return _store.getComponentInfo(componentNftId);
+    }
+
+
+    /// @dev Returns the registered token for the given component NFT ID.
+    function getToken(NftId componentNftId) public view returns (IERC20Metadata token) {
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) { return tokenHandler.TOKEN(); }
+    }
+
+
+    /// @dev Returns the current wallet address for the given component NFT ID.
+    /// The wallet address is either the component's own address or any other wallet address specified by the component owner.
+    /// 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) {
+        IComponents.ComponentInfo memory info = getComponentInfo(componentNftId);
+        if (address(info.tokenHandler) != address(0)) { 
+            return info.tokenHandler.getWallet();
         }
     }
 
-    function getPolicyState(NftId policyNftId)
-        public
-        view
-        returns (StateId state)
-    {
-        return _store.getState(toPolicyKey(policyNftId));
+
+    /// @dev Returns the token handler for the given component NFT ID.
+    /// The token handler manages all transfers from/to the component's wallet.
+    /// 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) {
+        IComponents.ComponentInfo memory info = _store.getComponentInfo(componentNftId);
+        if(address(info.tokenHandler) != address(0)) {
+            return info.tokenHandler;
+        }
     }
 
-    /// @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
+    /// @dev Returns the current token balance amount for the given component NFT ID.
+    /// The balance amount includes the fee amount.
+    function getBalanceAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getBalanceAmount(targetNftId);
+    }
 
-        // 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; }
+    /// @dev Returns the current fee amount for the given NFT ID.
+    /// The target NFT ID may reference a component, a distributor or a bundle.
+    function getFeeAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getFeeAmount(targetNftId);
+    }
 
-        // all conditionsl to close the policy are met
-        return true; 
+
+    /// @dev Returns the currently locked amount for the given NFT ID.
+    /// The target NFT ID may reference a pool or a bundle.
+    function getLockedAmount(NftId targetNftId) external view returns (Amount) { 
+        return _store.getLockedAmount(targetNftId);
     }
 
-    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));
-        }
+    //--- product functions ------------------------------------------------------//
+
+    /// @dev Returns the number of registered products.
+    function products() public view returns (uint256 productCount) {
+        return _instance.products();
     }
 
-    function getClaimState(NftId policyNftId, ClaimId claimId)
-        public
-        view
-        returns (StateId state)
-    {
-        return _store.getState(claimId.toKey32(policyNftId));
+
+    /// @dev Returns th product NFT ID for the given index.
+    function getProduct(uint256 idx) public view returns (NftId productNftId) {
+        return _instance.getProduct(idx);
     }
 
-    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));
-        }
+
+    /// @dev Returns the product info for the given product NFT ID.
+    function getProductInfo(NftId productNftId) public view returns (IComponents.ProductInfo memory info) {
+        return _productStore.getProductInfo(productNftId);
     }
 
-    function getPayoutState(NftId policyNftId, PayoutId payoutId)
-        public
-        view
-        returns (StateId state)
-    {
-        return _store.getState(payoutId.toKey32(policyNftId));
+
+    /// @dev Returns the current fee settings for the given product NFT ID.
+    function getFeeInfo(NftId productNftId) public view returns (IComponents.FeeInfo memory feeInfo) {
+        return _productStore.getFeeInfo(productNftId);
     }
 
-    function getRiskInfo(RiskId riskId)
-        public 
-        view 
-        returns (IRisk.RiskInfo memory info)
-    {
-        bytes memory data = _store.getData(riskId.toKey32());
-        if (data.length > 0) {
-            return abi.decode(data, (IRisk.RiskInfo));
-        }
+    //--- risk functions ---------------------------------------------------------//
+
+    /// @dev Returns the total number of registered risks for the specified product.
+    function risks(NftId productNftId) public view returns (uint256 riskCount) {
+        return _riskSet.risks(productNftId);
     }
 
-    function getTokenHandler(NftId componentNftId)
-        public
-        view
-        returns (address 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);
-        }
+    /// @dev Returns the number of active risks for the specified product.
+    function activeRisks(NftId productNftId) public view returns (uint256 activeRiskCount) {
+        return _riskSet.activeRisks(productNftId);
     }
 
-    function getBundleInfo(NftId bundleNftId)
-        public 
-        view 
-        returns (IBundle.BundleInfo memory info)
-    {
-        bytes memory data = _store.getData(toBundleKey(bundleNftId));
-        if (data.length > 0) {
-            return abi.decode(data, (IBundle.BundleInfo));
-        }
+
+    /// @dev Returns the risk ID for the given product NFT ID and (registered) risk index.
+    function getRiskId(NftId productNftId, uint256 idx) public view returns (RiskId riskId) {
+        return _riskSet.getRiskId(productNftId, idx);
     }
 
-    function getDistributorTypeInfo(DistributorType distributorType)
-        public 
-        view 
-        returns (IDistribution.DistributorTypeInfo memory info)
-    {
-        bytes memory data = _store.getData(distributorType.toKey32());
-        if (data.length > 0) {
-            return abi.decode(data, (IDistribution.DistributorTypeInfo));
-        }
+
+    /// @dev Returns the active risk ID for the given product NFT ID and (active) risk index.
+    function getActiveRiskId(NftId productNftId, uint256 idx) public view returns (RiskId riskId) {
+        return _riskSet.getActiveRiskId(productNftId, idx);
     }
 
-    function getDistributorInfo(NftId distributorNftId)
-        public
-        view
-        returns (IDistribution.DistributorInfo memory info)
-    {
-        bytes memory data = _store.getData(toDistributorKey(distributorNftId));
-        if (data.length > 0) {
-            return abi.decode(data, (IDistribution.DistributorInfo));
-        }
+
+    /// @dev Returns true if the specified risk exists for the given product NFT ID.
+    function isProductRisk(NftId productNftId, RiskId riskId) public view returns (bool exists) {
+        return _riskSet.hasRisk(productNftId, riskId);
     }
 
-    function getBalanceAmount(NftId targetNftId) external returns (Amount) { 
-        return _store.getBalanceAmount(targetNftId);
+
+    /// @dev Returns the risk info for the given risk ID.
+    function getRiskInfo(RiskId riskId) public view returns (IRisk.RiskInfo memory info) {
+        return _productStore.getRiskInfo(riskId);
     }
 
-    function getLockedAmount(NftId targetNftId) external returns (Amount) { 
-        return _store.getLockedAmount(targetNftId);
+
+    /// @dev Returns the risk state for the given risk ID.
+    function getRiskState(RiskId riskId) public view returns (StateId stateId) {
+        return _productStore.getState(riskId.toKey32());
     }
 
-    function getFeeAmount(NftId targetNftId) external returns (Amount) { 
-        return _store.getFeeAmount(targetNftId);
+
+    //--- policy functions -------------------------------------------------------//
+
+    /// @dev Returns the number of linked policies for the given risk ID.
+    function policiesForRisk(RiskId riskId) public view returns (uint256 linkedPolicies) {
+        return _riskSet.linkedPolicies(riskId);
     }
 
-    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));
-        }
+
+    /// @dev Returns the linked policy NFT ID for the given risk ID and index.
+    function getPolicyForRisk(RiskId riskId, uint256 idx) public view returns (NftId linkedPolicyNftId) {
+        return _riskSet.getLinkedPolicyNftId(riskId, idx);
     }
 
-    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));
-        }
+    /// @dev Returns the number of linked policies for the given bundle NFT ID.
+    function policiesForBundle(NftId bundleNftId) public view returns (uint256 linkedPolicies) {
+        return _bundleSet.activePolicies(bundleNftId);
     }
 
-    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));
-        }
+
+    /// @dev Returns the linked policy NFT ID for the given risk ID and index.
+    function getPolicyForBundle(NftId bundleNftId, uint256 idx) public view returns (NftId linkedPolicyNftId) {
+        return _bundleSet.getActivePolicy(bundleNftId, idx);
     }
 
-    function getReferralInfo(ReferralId referralId)
-        public 
-        view 
-        returns (IDistribution.ReferralInfo memory info)
-    {
-        bytes memory data = _store.getData(referralId.toKey32());
-        if (data.length > 0) {
-            return abi.decode(data, (IDistribution.ReferralInfo));
-        }
+
+    /// @dev Returns the info for the given policy NFT ID.
+    function getPolicyInfo(NftId policyNftId) public view returns (IPolicy.PolicyInfo memory info) {
+        return _productStore.getPolicyInfo(policyNftId);
     }
 
 
-    function getMetadata(Key32 key)
-        public 
-        view 
-        returns (IKeyValueStore.Metadata memory metadata)
-    {
-        return _store.getMetadata(key);
+    /// @dev Returns the state for the given policy NFT ID.
+    function getPolicyState(NftId policyNftId) public view returns (StateId state) {
+        return _productStore.getState(_toPolicyKey(policyNftId));
     }
 
 
-    function toReferralId(
-        NftId distributionNftId,
-        string memory referralCode
-    )
-        public
-        pure 
-        returns (ReferralId referralId)
-    {
-        return ReferralLib.toReferralId(
-            distributionNftId, 
-            referralCode);      
+    /// @dev Returns true iff policy is active.
+    function policyIsActive(NftId policyNftId) public view returns (bool isCloseable) {
+        return PolicyServiceLib.policyIsActive(this, policyNftId);
+    }
+
+    //--- claim functions -------------------------------------------------------//
+
+    /// @dev Returns the number of claims for the given policy NFT ID.
+    function claims(NftId policyNftId) public view returns (uint16 claimCount) {
+        return getPolicyInfo(policyNftId).claimsCount;
+    }
+
+
+    /// @dev Returns the claim ID for the given policy NFT ID and index.
+    function getClaimId(uint256 idx) public pure returns (ClaimId claimId) {
+        return ClaimIdLib.toClaimId(idx + 1);
+    }
+
+
+    /// @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) {
+        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 _productStore.getState(claimId.toKey32(policyNftId));
+    }
+
+
+    /// @dev Returns the remaining claimable amount for the given policy NFT ID.
+    /// The remaining claimable amount is the difference between the sum insured amount and total approved claim amounts so far.
+    function getRemainingClaimableAmount(NftId policyNftId)
+        public view returns (Amount remainingClaimableAmount) {
+        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
+        return info.sumInsuredAmount - info.claimAmount;
+    }
+
+    //--- payout functions -------------------------------------------------------//
+
+    /// @dev Returns the number of payouts for the given policy NFT ID and claim ID.
+    function payouts(NftId policyNftId, ClaimId claimId) public view returns (uint24 payoutCount) {
+        return getClaimInfo(policyNftId, claimId).payoutsCount;
+    }
+
+
+    /// @dev Returns the payout ID for the given claim ID and index.
+    function getPayoutId(ClaimId claimId, uint24 idx) public pure returns (PayoutId payoutId) {
+        return PayoutIdLib.toPayoutId(claimId, idx + 1);
+    }
+
+
+    /// @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) {
+        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 _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) {
+        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 _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) {
+        return _store.getRequestInfo(requestId);
+    }
+
+    /// @dev Returns the request info for the given oracle request ID.
+    function getRequestState(RequestId requestId) public view returns (StateId state) {
+        return getState(requestId.toKey32());
+    }
+
+    //--- pool functions -----------------------------------------------------------//
+
+    /// @dev Returns the pool info for the given pool NFT ID.
+    function getPoolInfo(NftId poolNftId) public view returns (IComponents.PoolInfo memory info) {
+        return _store.getPoolInfo(poolNftId);
+    }
+
+    //--- bundle functions -------------------------------------------------------//
+
+    /// @dev Returns the total number of registered bundles for the given pool.
+    function bundles(NftId poolNftId) public view returns (uint256 bundleCount) {
+        return _bundleSet.bundles(poolNftId);
+    }
+
+
+    /// @dev Returns the number of active bundles for the given pool.
+    function activeBundles(NftId poolNftId) public view returns (uint256 bundleCount) {
+        return _bundleSet.activeBundles(poolNftId);
+    }
+
+
+    /// @dev Returns the bunde NFT ID for the given pool and index.
+    function getBundleNftId(NftId poolNftId, uint256 idx) public view returns (NftId bundleNftId) {
+        return _bundleSet.getBundleNftId(poolNftId, idx);
+    }
+
+
+    /// @dev Returns the active bunde NFT ID for the given pool and index.
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) public view returns (NftId bundleNftId) {
+        return _bundleSet.getActiveBundleNftId(poolNftId, idx);
+    }
+
+
+    /// @dev Returns the bundle info for the given bundle NFT ID.
+    function getBundleInfo(NftId bundleNftId) public view  returns (IBundle.BundleInfo memory info) {
+        return _store.getBundleInfo(bundleNftId);
+    }
+
+
+    /// @dev Returns the bundle state for the given bundle NFT ID.
+    function getBundleState(NftId bundleNftId) public view returns (StateId state) {
+        return getState(_toBundleKey(bundleNftId));
+    }
+
+    //--- distribution functions -------------------------------------------------------//
+
+    function getDistributorTypeInfo(DistributorType distributorType) public view returns (IDistribution.DistributorTypeInfo memory info) {
+        return _store.getDistributorTypeInfo(distributorType);
+    }
+
+
+    function getDistributorInfo(NftId distributorNftId) public view returns (IDistribution.DistributorInfo memory info) {
+        return _store.getDistributorInfo(distributorNftId);
+    }
+
+
+    //--- referral functions -------------------------------------------------------//
+
+    function toReferralId(NftId distributionNftId, string memory referralCode) public pure returns (ReferralId referralId) {
+        return ReferralLib.toReferralId(distributionNftId, referralCode);      
+    }
+
+
+    function isReferralValid(NftId distributionNftId, ReferralId referralId) external view returns (bool isValid) {
+        return _distributionService.referralIsValid(distributionNftId, referralId);
+    }
+
+
+    function getReferralInfo(ReferralId referralId) public view returns (IDistribution.ReferralInfo memory info) {
+        return _store.getReferralInfo(referralId);
     }
 
 
@@ -290,77 +444,185 @@ 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());
-        }
+    //--- authorization functions -------------------------------------------------------//
 
-        if (info.expiryAt < TimestampLib.blockTimestamp()) {
-            return (
-                UFixedLib.zero(),
-                REFERRAL_ERROR_EXPIRED());
-        }
+    /// @dev Returns the number of defined roles.
+    function roles() public view returns (uint256) {
+        return _instanceAdmin.roles();
+    }
 
-        if (info.usedReferrals >= info.maxReferrals) {
-            return (
-                UFixedLib.zero(),
-                REFERRAL_ERROR_EXHAUSTED());
-        }
 
-        return (
-            info.discountPercentage,
-            REFERRAL_OK()
-        );
+    /// @dev Returns the role ID for the given index.
+    function getRoleId(uint256 idx) public view returns (RoleId roleId) {
+        return _instanceAdmin.getRoleId(uint64(idx));
     }
 
 
-    function toPolicyKey(NftId policyNftId) public pure returns (Key32) { 
-        return policyNftId.toKey32(POLICY());
+    /// @dev Returns the role ID for the instance owner role.
+    /// This role may be used as a "root" admin role for other custom roles defined for this instance.
+    function getInstanceOwnerRole() public pure returns (RoleId roleId) {
+        return INSTANCE_OWNER_ROLE();
     }
 
 
-    function toDistributorKey(NftId distributorNftId) public pure returns (Key32) { 
-        return distributorNftId.toKey32(DISTRIBUTOR());
+    /// @dev Returns the role info for the given role ID.
+    function getRoleInfo(RoleId roleId) public view returns (IAccess.RoleInfo memory roleInfo) { 
+        return _instanceAdmin.getRoleInfo(roleId);
     }
 
-    function toBundleKey(NftId poolNftId) public pure returns (Key32) { 
-        return poolNftId.toKey32(BUNDLE());
+
+    /// @dev Returns true iff the provided role ID is defined for this instance.
+    function roleExists(RoleId roleId) public view returns (bool exists) {
+        return _instanceAdmin.roleExists(roleId);
     }
 
-    function toComponentKey(NftId componentNftId) public pure returns (Key32) { 
-        return componentNftId.toKey32(COMPONENT());
+
+    /// @dev Returns true iff the provided role ID represents a custom role ID.
+    function isRoleCustom(RoleId roleId) public view returns (bool isCustom) {
+        return _instanceAdmin.isRoleCustom(roleId);
     }
 
-    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
-        return distributionNftId.toKey32(DISTRIBUTION());
+
+    /// @dev Returns true iff the provided role ID is active.
+    function isRoleActive(RoleId roleId) public view returns (bool isActive) {
+        return _instanceAdmin.isRoleActive(roleId);
     }
 
-    function toPoolKey(NftId poolNftId) public pure returns (Key32) { 
-        return poolNftId.toKey32(POOL());
+
+    /// @dev Returns the number of members (accounts) for the given role ID.
+    function roleMembers(RoleId roleId) public view returns (uint256 numberOfMembers) {
+        return _instanceAdmin.roleMembers(roleId);
     }
 
-    function toProductKey(NftId productNftId) public pure returns (Key32) { 
-        return productNftId.toKey32(PRODUCT());
+
+    /// @dev Returns the member (account address) for the given role ID and index.
+    function getRoleMember(RoleId roleId, uint256 idx) public view returns (address account) {
+        return _instanceAdmin.getRoleMember(roleId, idx);
     }
 
-    // low level function
-    function getInstance() external view returns (IInstance instance) {
-        return _instance;
+
+    /// @dev Returns true iff the given account is a member of the specified role ID.
+    function isRoleMember(RoleId roleId, address account) public view returns (bool isMember) {
+        return _instanceAdmin.isRoleMember(roleId, account);
+    }
+
+
+    /// @dev Returns true iff the given account is an admin of the specified role ID.
+    /// Role admins may grant and revoke the role to other accounts.
+    function isRoleAdmin(RoleId roleId, address account) public view returns (bool isMember) {
+        return _instanceAdmin.isRoleAdmin(roleId, account);
+    }
+
+
+    /// @dev Returns the number of targets (contracts) defined for this instance.
+    function targets() public view returns (uint256 targetCount) {
+        return _instanceAdmin.targets();
+    }
+
+
+    /// @dev Returns the target address for the given index.
+    function getTargetAddress(uint256 idx) public view returns (address target) {
+        return _instanceAdmin.getTargetAddress(idx);
+    }
+
+
+    /// @dev Returns the target info for the given target address.
+    function getTargetInfo(address target) public view returns (IAccess.TargetInfo memory targetInfo) {
+        return _instanceAdmin.getTargetInfo(target);
+    }
+
+
+    /// @dev Returns true iff the given target is defined for this instance.
+    function targetExists(address target) public view returns (bool exists) {
+        return _instanceAdmin.targetExists(target);
+    }
+
+
+    /// @dev Returns true iff the given target is locked.
+    function isLocked(address target) public view returns (bool) {
+        return _instanceAdmin.isTargetLocked(target);
+    }
+
+
+    /// @dev Returns the number of authorized functions for the given target.
+    function authorizedFunctions(address target) external view returns (uint256 numberOfFunctions) {
+        return _instanceAdmin.authorizedFunctions(target);
+    }
+
+
+    /// @dev Returns the authorized function info for the given target and index.
+    function getAuthorizedFunction(address target, uint256 idx) external view returns (IAccess.FunctionInfo memory func, RoleId roleId) {
+        return _instanceAdmin.getAuthorizedFunction(target, idx);
+    }
+
+
+    /// @dev Returns a function info for the given function signature and function name.
+    /// The function signature must not be zero and the function name must not be empty.
+    function toFunction(bytes4 signature, string memory name) public view returns (IAccess.FunctionInfo memory) {
+        return AccessAdminLib.toFunction(signature, name);
+    }
+
+    //--- low level function ----------------------------------------------------//
+
+    function getInstanceAdmin() external view returns (InstanceAdmin instanceAdmin) {
+        return _instanceAdmin;
+    }
+
+    function getBundleSet() external view returns (BundleSet bundleSet) {
+        return _bundleSet;
     }
 
-    function getInstanceStore() external view returns (IKeyValueStore store) {
-        return _store;
+    function getRiskSet() external view returns (RiskSet riskSet) {
+        return _riskSet;
     }
 
+
+    function getMetadata(Key32 key) public view returns (IBaseStore.Metadata memory metadata) {
+        return _store.getMetadata(key);
+    }
+
+
+    function getState(Key32 key) public view returns (StateId state) {
+        return _store.getState(key);
+    }
+
+
     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);
     }
+
+    //--- internal functions ----------------------------------------------------//
+
+
+    function _toPolicyKey(NftId policyNftId) internal pure returns (Key32) { 
+        return policyNftId.toKey32(POLICY());
+    }
+
+
+    function _toPremiumKey(NftId policyNftId) internal pure returns (Key32) { 
+        return policyNftId.toKey32(PREMIUM());
+    }
+
+
+    function _toBundleKey(NftId poolNftId) internal pure returns (Key32) { 
+        return poolNftId.toKey32(BUNDLE());
+    }
+
+
+    function _toComponentKey(NftId componentNftId) internal pure returns (Key32) { 
+        return componentNftId.toKey32(COMPONENT());
+    }
 }