@etherisc/gif-next 0.0.2-db1e1e4-828 → 0.0.2-db81915-875

package/contracts/components/Product.sol

@@ -3,6 +3,10 @@ pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount} from "../types/Amount.sol";
+import {ClaimId} from "../types/ClaimId.sol";
+import {Component} from "./Component.sol";
+import {Fee} from "../types/Fee.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
 import {IApplicationService} from "../instance/service/IApplicationService.sol";
 import {IPolicyService} from "../instance/service/IPolicyService.sol";
@@ -10,14 +14,13 @@ import {IProductService} from "../instance/service/IProductService.sol";
 import {IClaimService} from "../instance/service/IClaimService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
+import {PayoutId} from "../types/PayoutId.sol";
 import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {Seconds} from "../types/Seconds.sol";
 import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
-import {Fee} from "../types/Fee.sol";
-import {Component} from "./Component.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
@@ -70,7 +73,7 @@ abstract contract Product is
 
         ProductStorage storage $ = _getProductStorage();
         // TODO add validation
-        // TODO refactor to go via registry
+        // TODO refactor to go via registry ?
         $._productService = IProductService(_getServiceAddress(PRODUCT())); 
         $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
         $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
@@ -86,50 +89,17 @@ abstract contract Product is
         registerInterface(type(IProductComponent).interfaceId);  
     }
 
-
-    function calculatePremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external 
-        view 
-        override 
-        returns (uint256 premiumAmount)
-    {
-        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
-            getNftId(),
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-        premiumAmount = premium.premiumAmount;
-    }
-
-
-    function calculateNetPremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData
+    // from product component
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
     )
         external
-        view
-        virtual override
-        returns (uint256 netPremiumAmount)
+        onlyOwner
+        restricted()
+        override
     {
-        // default 10% of sum insured
-        return sumInsuredAmount / 10;
-    }
-
-    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
-        return RiskIdLib.toRiskId(riskName);
+        _getProductService().setFees(productFee, processingFee);
     }
 
     function _createRisk(
@@ -189,14 +159,14 @@ abstract contract Product is
         );
     }
 
-    function _underwrite(
+    function _collateralize(
         NftId policyNftId,
         bool requirePremiumPayment,
         Timestamp activateAt
     )
         internal
     {
-        _getProductStorage()._policyService.underwrite(
+        _getProductStorage()._policyService.collateralize(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -229,28 +199,136 @@ abstract contract Product is
     )
         internal
     {
-        _getProductStorage()._policyService.close(policyNftId);
+        _getProductStorage()._policyService.close(
+            policyNftId);
     }
 
-    function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._pool));
+    function _submitClaim(
+        NftId policyNftId,
+        Amount claimAmount,
+        bytes memory claimData
+    )
+        internal
+        returns(ClaimId)
+    {
+        return _getProductStorage()._policyService.submitClaim(
+            policyNftId,
+            claimAmount,
+            claimData);
     }
 
-    function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._distribution));
+    function _confirmClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount confirmedAmount
+    )
+        internal
+    {
+        _getProductStorage()._policyService.confirmClaim(
+            policyNftId,
+            claimId,
+            confirmedAmount);
     }
 
-    // from product component
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
+    function _declineClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.declineClaim(
+            policyNftId,
+            claimId);
+    }
+
+    function _closeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.closeClaim(
+            policyNftId,
+            claimId);
+    }
+
+    function _createPayout(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        bytes memory data
+    )
+        internal
+        returns (PayoutId)
+    {
+        return _getProductStorage()._policyService.createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            data);
+    }
+
+    function _processPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.processPayout(
+            policyNftId,
+            payoutId);
+    }
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
+            getNftId(),
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+        premiumAmount = premium.premiumAmount;
+    }
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData
     )
         external
-        onlyOwner
-        restricted()
-        override
+        view
+        virtual override
+        returns (uint256 netPremiumAmount)
     {
-        _getProductService().setFees(productFee, processingFee);
+        // default 10% of sum insured
+        return sumInsuredAmount / 10;
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function getPoolNftId() external view override returns (NftId poolNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
     function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {

package/contracts/instance/BundleManager.sol

@@ -34,8 +34,7 @@ contract BundleManager is
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
     /// @dev links a policy to its bundle
-    // to link a policy it MUST NOT yet have been activated
-    // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
+    // to link a policy it MUST NOT yet have been linked
     function linkPolicy(NftId policyNftId) external restricted() {
         NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
         // decision will likely depend on the decision what to check here and what in the service
@@ -87,14 +86,14 @@ contract BundleManager is
     }
 
 
-    /// @dev unlocked (active) bundles are available to underwrite new policies
+    /// @dev unlocked (active) bundles are available to collateralize new policies
     function unlock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _activate(poolNftId, bundleNftId);
         emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
     }
 
-    /// @dev locked (deactivated) bundles may not underwrite any new policies
+    /// @dev locked (deactivated) bundles may not collateralize any new policies
     function lock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _deactivate(poolNftId, bundleNftId);

package/contracts/instance/IInstance.sol

@@ -3,8 +3,12 @@ pragma solidity ^0.8.20;
 
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
+import {ClaimId} from "../types/ClaimId.sol";
+import {DistributorType} from "../types/DistributorType.sol";
+import {PayoutId} from "../types/PayoutId.sol";
 import {NftId} from "../types/NftId.sol";
 import {StateId} from "../types/StateId.sol";
+import {ReferralId} from "../types/Referral.sol";
 import {RiskId} from "../types/RiskId.sol";
 import {VersionPart} from "../types/Version.sol";
 import {Key32} from "../types/Key32.sol";
@@ -20,16 +24,10 @@ import {InstanceReader} from "./InstanceReader.sol";
 import {IBundle} from "./module/IBundle.sol";
 import {IBundleService} from "./service/IBundleService.sol";
 import {IComponents} from "./module/IComponents.sol";
-import {IDistributionService} from "./service/IDistributionService.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {IKeyValueStore} from "./base/IKeyValueStore.sol";
 import {IPolicy} from "./module/IPolicy.sol";
 import {IDistribution} from "./module/IDistribution.sol";
-import {IPolicyService} from "./service/IPolicyService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPolicyService} from "./service/IPolicyService.sol";
-import {IBundleService} from "./service/IBundleService.sol";
 import {IRisk} from "./module/IRisk.sol";
 import {ISetup} from "./module/ISetup.sol";
 
@@ -41,11 +39,14 @@ interface IInstance is
     IAccessManaged, 
     IKeyValueStore 
 {
-    function getDistributionService() external view returns (IDistributionService);
-    function getProductService() external view returns (IProductService);
-    function getPoolService() external view returns (IPoolService);
-    function getPolicyService() external view returns (IPolicyService);
-    function getBundleService() external view returns (IBundleService);
+    error ErrorInstanceInstanceAccessManagerAlreadySet(address instanceAccessManager);
+    error ErrorInstanceInstanceAccessManagerAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceBundleManagerAlreadySet(address instanceBundleManager);
+    error ErrorInstanceBundleManagerInstanceMismatch(address instance);
+    error ErrorInstanceBundleManagerAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
     function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
     function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external;
@@ -63,17 +64,17 @@ interface IInstance is
     function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external;
     function updateProductSetupState(NftId productNftId, StateId newState) external;
 
-    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external;
-    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
-    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external;
+    function createDistributorType(DistributorType distributorType, IDistribution.DistributorTypeInfo memory info) external;
+    function updateDistributorType(DistributorType distributorType, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
+    function updateDistributorTypeState(DistributorType distributorType, StateId newState) external;
 
     function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external;
     function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external;
     function updateDistributorState(NftId nftId, StateId newState) external;
 
-    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external;
-    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
-    function updateReferralState(Key32 referralKey, StateId newState) external;
+    function createReferral(ReferralId referralId, IDistribution.ReferralInfo memory referralInfo) external;
+    function updateReferral(ReferralId referralId, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
+    function updateReferralState(ReferralId referralId, StateId newState) external;
 
     function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external;
     function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external;
@@ -86,13 +87,16 @@ interface IInstance is
     function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
     function updatePolicyState(NftId policyNftId, StateId newState) external;
 
-    // TODO add claims/payouts function to instance
-    // function updateClaims(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+    function createClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim) external;
+    function updateClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim, StateId newState) external;
+    function updateClaimState(NftId policyNftId, ClaimId claimId, StateId newState) external;
+
+    function createPayout(NftId policyNftId, PayoutId payoutId, IPolicy.PayoutInfo memory claim) external;
+    function updatePayout(NftId policyNftId, PayoutId payoutId, IPolicy.PayoutInfo memory claim, StateId newState) external;
+    function updatePayoutState(NftId policyNftId, PayoutId payoutId, StateId newState) external;
 
     function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleManager() external view returns (BundleManager);
-
-    function setInstanceAccessManager(InstanceAccessManager accessManager) external;
     function getInstanceAccessManager() external view returns (InstanceAccessManager);
 }

package/contracts/instance/IInstanceService.sol

@@ -5,10 +5,6 @@ import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 import {RoleId} from "../types/RoleId.sol";
 import {IService} from "../shared/IService.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IComponent} from "../components/IComponent.sol";
 
 import {AccessManagerUpgradeableInitializeable} from "./AccessManagerUpgradeableInitializeable.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";