@etherisc/gif-next 0.0.2-f30e0eb-805 → 0.0.2-f398177-971

package/contracts/instance/service/PolicyService.sol

@@ -14,24 +14,29 @@ import {ISetup} from "../module/ISetup.sol";
 
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 
+import {Amount, AmountLib} from "../../types/Amount.sol";
+import {ClaimId, ClaimIdLib} from "../../types/ClaimId.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
 import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-import {ObjectType, APPLICATION, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE} from "../../types/ObjectType.sol";
-import {APPLIED, UNDERWRITTEN, ACTIVE, KEEP_STATE, CLOSED} from "../../types/StateId.sol";
+import {ObjectType, APPLICATION, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE, CLAIM, PRICE} from "../../types/ObjectType.sol";
+import {APPLIED, COLLATERALIZED, ACTIVE, KEEP_STATE, CLOSED, DECLINED, CONFIRMED} from "../../types/StateId.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {PayoutId, PayoutIdLib} from "../../types/PayoutId.sol";
 import {StateId} from "../../types/StateId.sol";
+import {VersionPart} from "../../types/Version.sol";
 
 import {ComponentService} from "../base/ComponentService.sol";
 import {IApplicationService} from "./IApplicationService.sol";
 import {IBundleService} from "./IBundleService.sol";
+import {IClaimService} from "./IClaimService.sol";
 import {IDistributionService} from "./IDistributionService.sol";
 import {InstanceReader} from "../InstanceReader.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IPoolService} from "./IPoolService.sol";
+import {IPricingService} from "./IPricingService.sol";
 import {IService} from "../../shared/IService.sol";
 import {Service} from "../../shared/Service.sol";
 
-
 contract PolicyService is
     ComponentService, 
     IPolicyService
@@ -39,10 +44,12 @@ contract PolicyService is
     using NftIdLib for NftId;
     using TimestampLib for Timestamp;
 
-    IPoolService internal _poolService;
-    IBundleService internal _bundleService;
     IApplicationService internal _applicationService;
+    IBundleService internal _bundleService;
+    IClaimService internal _claimService;
     IDistributionService internal _distributionService;
+    IPoolService internal _poolService;
+    IPricingService internal _pricingService;
 
     event LogProductServiceSender(address sender);
 
@@ -58,59 +65,31 @@ contract PolicyService is
         address initialOwner;
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, owner);
+        initializeService(registryAddress, address(0), owner);
 
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getMajorVersion()));
-        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), getMajorVersion()));
-        _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), getMajorVersion()));
-        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), getMajorVersion()));
+        VersionPart majorVersion = getVersion().toMajorPart();
+        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), majorVersion));
+        _bundleService = IBundleService(getRegistry().getServiceAddress(BUNDLE(), majorVersion));
+        _claimService = IClaimService(getRegistry().getServiceAddress(CLAIM(), majorVersion));
+        _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
+        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
+        _pricingService = IPricingService(getRegistry().getServiceAddress(PRICE(), majorVersion));
 
         registerInterface(type(IPolicyService).interfaceId);
     }
 
 
-    function getDomain() public pure override(IService, Service) returns(ObjectType) {
+    function getDomain() public pure override returns(ObjectType) {
         return POLICY();
     }
 
 
     function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
         IRegistry.ObjectInfo memory productInfo;
-        (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (, productInfo,) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         product = Product(productInfo.objectAddress);
     }
 
-    function _getAndVerifyUnderwritingSetup(
-        IInstance instance,
-        InstanceReader instanceReader,
-        IPolicy.PolicyInfo memory policyInfo,
-        ISetup.ProductSetupInfo memory productSetupInfo
-    )
-        internal
-        view
-        returns (
-            NftId poolNftId,
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        )
-    {
-        // check match between policy and bundle (via pool)
-        poolNftId = productSetupInfo.poolNftId;
-        bundleNftId = policyInfo.bundleNftId;
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == poolNftId, "POLICY_BUNDLE_MISMATCH");
-
-        // calculate required collateral
-        IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-        IComponents.PoolInfo memory poolInfo = abi.decode(
-            componentInfo.data, (IComponents.PoolInfo));
-
-        // obtain remaining return values
-        // TODO required collateral amount should be calculated by pool service, not policy service
-        collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
-    }
-
 
     function decline(
         NftId policyNftId
@@ -118,12 +97,12 @@ contract PolicyService is
         external
         override
     {
-        require(false, "ERROR:PRS-235:NOT_YET_IMPLEMENTED");
+        revert();
     }
 
 
     /// @dev underwites application which includes the locking of the required collateral from the pool.
-    function underwrite(
+    function collateralize(
         NftId applicationNftId, // = policyNftId
         bool requirePremiumPayment,
         Timestamp activateAt
@@ -132,126 +111,104 @@ contract PolicyService is
         virtual override
     {
         // check caller is registered product
-        IInstance instance;
-        InstanceReader instanceReader;
-        NftId productNftId;
-        {
-            IRegistry.ObjectInfo memory productInfo;
-            (productInfo, instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-            instanceReader = instance.getInstanceReader();
-            productNftId = productInfo.nftId;
-        }
+        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         // check policy matches with calling product
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(applicationNftId);
-        require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
+        IPolicy.PolicyInfo memory applicationInfo = instanceReader.getPolicyInfo(applicationNftId);
+        if(applicationInfo.productNftId != productNftId) {
+            revert ErrorPolicyServicePolicyProductMismatch(
+                applicationNftId, 
+                applicationInfo.productNftId, 
+                productNftId);
+        }
 
         // check policy is in state applied
-        require(instanceReader.getPolicyState(applicationNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
-        
-        (
-            NftId poolNftId,
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        ) = _getAndVerifyUnderwritingSetup(
-            instance,
-            instanceReader,
-            policyInfo,
-            instanceReader.getProductSetupInfo(productNftId)
-        );
+        if (instanceReader.getPolicyState(applicationNftId) != APPLIED()) {
+            revert ErrorPolicyServicePolicyStateNotApplied(applicationNftId);
+        }
         
-        StateId newPolicyState = UNDERWRITTEN();
+        StateId newPolicyState = COLLATERALIZED();
 
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
             newPolicyState = ACTIVE();
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+            applicationInfo.activatedAt = activateAt;
+            applicationInfo.expiredAt = activateAt.addSeconds(applicationInfo.lifetime);
         }
 
         // lock bundle collateral
-        uint256 netPremiumAmount = 0; // > 0 if immediate premium payment 
+        Amount netPremiumAmount = AmountLib.zero(); // > 0 if immediate premium payment 
 
         // optional collection of premium
         if(requirePremiumPayment) {
             netPremiumAmount = _processPremiumByTreasury(
                 instance, 
                 applicationNftId, 
-                policyInfo.premiumAmount);
+                applicationInfo.premiumAmount);
 
-            policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
+            applicationInfo.premiumPaidAmount = applicationInfo.premiumPaidAmount + applicationInfo.premiumAmount;
         }
 
-        // lock collateral and update bundle book keeping
-        // TODO introduct indirection via pool service?
-        // well pool would only need to be involved when a part of the collateral
-        // is provided by a "re insurance policy" of the pool
-        // but then again the policiy would likely best be attached to the bundle. really? why?
-        // retention level: fraction of sum insured that product will cover from pool funds directly
+        // store updated policy info
+        instance.getInstanceStore().updatePolicy(applicationNftId, applicationInfo, newPolicyState);
+
+        // lock collateral and update pool and bundle book keeping
+        // pool retention level: fraction of sum insured that product will cover from pool funds directly
         // eg retention level 30%, payouts up to 30% of the sum insured will be made from the product's pool directly
         // for the remaining 70% the pool owns a policy that will cover claims that exceed the 30% of the sum insured
-        // open points:
-        // - do we need a link of a bundle to this policy or is it enough to know that the pool has an active policy?
-        // - when to buy such policies and for which amount? manual trigger or link to bundle creation and/or funding?
-        bundleInfo = _bundleService.lockCollateral(
+        // might also call pool component (for isVerifyingApplications pools)
+        _poolService.lockCollateral(
             instance,
+            productNftId,
             applicationNftId, 
-            bundleNftId,
-            collateralAmount,
-            netPremiumAmount);
-
-        instance.updatePolicy(applicationNftId, policyInfo, newPolicyState);
-
-        // also verify/confirm application by pool if necessary
-        if(abi.decode(
-            instanceReader.getComponentInfo(poolNftId).data, 
-            (IComponents.PoolInfo)
-            ).isVerifyingApplications
-        )
-        {
-            IPoolComponent pool = IPoolComponent(
-                getRegistry().getObjectInfo(poolNftId).objectAddress);
-
-            pool.verifyApplication(
-                applicationNftId, 
-                policyInfo.applicationData, 
-                bundleNftId,
-                bundleInfo.filter,
-                collateralAmount);
-        }
+            applicationInfo,
+            netPremiumAmount); // for pool book keeping (fee + additional capital)
 
         // TODO: add logging
     }
 
 
-    function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
-        UFixed sumInsuredUFixed = UFixedLib.toUFixed(sumInsuredAmount);
-        UFixed collateralUFixed =  collateralizationLevel * sumInsuredUFixed;
-        return collateralUFixed.toInt();
+    function calculateRequiredCollateral(
+        UFixed collateralizationLevel, 
+        Amount sumInsuredAmount
+    )
+        public 
+        pure 
+        virtual 
+        returns(Amount collateralAmount)
+    {
+        UFixed collateralUFixed =  collateralizationLevel * sumInsuredAmount.toUFixed();
+        return AmountLib.toAmount(collateralUFixed.toInt());
     } 
 
-    function collectPremium(NftId policyNftId, Timestamp activateAt) external override {
+    function collectPremium(
+        NftId policyNftId, 
+        Timestamp activateAt
+    )
+        external 
+        virtual
+    {
         // check caller is registered product
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
 
         if (policyInfo.premiumPaidAmount == policyInfo.premiumAmount) {
-            revert ErrorIPolicyServicePremiumAlreadyPaid(policyNftId, policyInfo.premiumPaidAmount);
+            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId, policyInfo.premiumPaidAmount);
         }
 
-        uint256 unpaidPremiumAmount = policyInfo.premiumAmount - policyInfo.premiumPaidAmount;
+        Amount unpaidPremiumAmount = policyInfo.premiumAmount - policyInfo.premiumPaidAmount;
 
-        uint256 netPremiumAmount = _processPremiumByTreasury(
+        Amount netPremiumAmount = _processPremiumByTreasury(
                 instance, 
                 policyNftId, 
                 unpaidPremiumAmount);
 
-        policyInfo.premiumPaidAmount += unpaidPremiumAmount;
+        policyInfo.premiumPaidAmount = policyInfo.premiumPaidAmount + unpaidPremiumAmount;
 
         _bundleService.increaseBalance(instance, policyInfo.bundleNftId, netPremiumAmount);
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
         if(activateAt.gtz() && policyInfo.activatedAt.eqz()) {
             activate(policyNftId, activateAt);
@@ -262,7 +219,7 @@ contract PolicyService is
 
     function activate(NftId policyNftId, Timestamp activateAt) public override {
         // check caller is registered product
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -274,7 +231,7 @@ contract PolicyService is
         policyInfo.activatedAt = activateAt;
         policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
 
-        instance.updatePolicy(policyNftId, policyInfo, ACTIVE());
+        instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, ACTIVE());
 
         // TODO: add logging
     }
@@ -296,7 +253,7 @@ contract PolicyService is
         external 
         override
     {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -314,90 +271,106 @@ contract PolicyService is
             revert ErrorIPolicyServicePolicyAlreadyClosed(policyNftId);
         }
 
-        if (policyInfo.premiumAmount != policyInfo.premiumPaidAmount) {
-            revert ErrorIPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
+        // TODO consider to allow for underpaid premiums (with the effects of reducing max payouts accordingly)
+        if (!(policyInfo.premiumAmount == policyInfo.premiumPaidAmount)) {
+            revert ErrorPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
         }
 
         if (policyInfo.openClaimsCount > 0) {
             revert ErrorIPolicyServiceOpenClaims(policyNftId, policyInfo.openClaimsCount);
         }
 
-        if (TimestampLib.blockTimestamp().lte(policyInfo.expiredAt) && (policyInfo.payoutAmount < policyInfo.sumInsuredAmount)) {
-            revert ErrorIPolicyServicePolicyHasNotExpired(policyNftId, policyInfo.expiredAt);
-        }
-
         policyInfo.closedAt = TimestampLib.blockTimestamp();
 
-        _bundleService.closePolicy(instance, policyNftId, policyInfo.bundleNftId, policyInfo.sumInsuredAmount);
-        instance.updatePolicy(policyNftId, policyInfo, CLOSED());
-    }
+        _poolService.releaseCollateral(
+            instance, 
+            policyNftId, 
+            policyInfo);
 
-    function _getPoolNftId(
-        IInstance instance,
-        NftId productNftId
-    )
-        internal
-        view
-        returns (NftId poolNftid)
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-        return productSetupInfo.poolNftId;
+        instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, CLOSED());
     }
 
 
     function _processPremiumByTreasury(
         IInstance instance,
         NftId policyNftId,
-        uint256 premiumAmount
+        Amount premiumExpectedAmount
     )
         internal
-        returns (uint256 netPremiumAmount)
+        returns (Amount netPremiumAmount)
     {
         // process token transfer(s)
-        if(premiumAmount > 0) {
-            NftId productNftId = getRegistry().getObjectInfo(policyNftId).parentNftId;
-            ISetup.ProductSetupInfo memory productSetupInfo = instance.getInstanceReader().getProductSetupInfo(productNftId);
-            IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
-            TokenHandler tokenHandler = productSetupInfo.tokenHandler;
-            address policyOwner = getRegistry().ownerOf(policyNftId);
-            address poolWallet = instance.getInstanceReader().getComponentInfo(productSetupInfo.poolNftId).wallet;
-            IPolicy.Premium memory premium = _applicationService.calculatePremium(
-                productNftId,
-                policyInfo.riskId,
-                policyInfo.sumInsuredAmount,
-                policyInfo.lifetime,
-                policyInfo.applicationData,
-                policyInfo.bundleNftId,
-                policyInfo.referralId
-                );
-
-            if (premium.premiumAmount != premiumAmount) {
-                revert ErrorIPolicyServicePremiumMismatch(policyNftId, premiumAmount, premium.premiumAmount);
-            }
+        if(premiumExpectedAmount.eqz()) {
+            return AmountLib.zero();
+        }
+
+        NftId productNftId = getRegistry().getObjectInfo(policyNftId).parentNftId;
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
+        IPolicy.Premium memory premium = _pricingService.calculatePremium(
+            productNftId,
+            policyInfo.riskId,
+            policyInfo.sumInsuredAmount,
+            policyInfo.lifetime,
+            policyInfo.applicationData,
+            policyInfo.bundleNftId,
+            policyInfo.referralId
+            );
+
+        if (premium.premiumAmount != premiumExpectedAmount.toInt()) {
+            revert ErrorPolicyServicePremiumMismatch(
+                policyNftId, 
+                premiumExpectedAmount, 
+                AmountLib.toAmount(premium.premiumAmount));
+        }
+
+        address policyOwner = getRegistry().ownerOf(policyNftId);
+        ISetup.ProductSetupInfo memory productSetupInfo = instance.getInstanceReader().getProductSetupInfo(productNftId);
+        TokenHandler tokenHandler = productSetupInfo.tokenHandler;
+        if (tokenHandler.getToken().allowance(policyOwner, address(tokenHandler)) < premium.premiumAmount) {
+            revert ErrorIPolicyServiceInsufficientAllowance(policyOwner, address(tokenHandler), premium.premiumAmount);
+        }
 
-            // move product fee to product wallet
+        Amount productFeeAmountToTransfer = AmountLib.toAmount(premium.productFeeFixAmount + premium.productFeeVarAmount);
+        Amount distributionFeeAmountToTransfer = AmountLib.toAmount(premium.distributionFeeFixAmount + premium.distributionFeeVarAmount - premium.discountAmount);
+        uint256 poolFeeAmountToTransfer = premium.poolFeeFixAmount + premium.poolFeeVarAmount;
+        uint256 bundleFeeAmountToTransfer = premium.bundleFeeFixAmount + premium.bundleFeeVarAmount;
+        Amount poolAmountToTransfer = AmountLib.toAmount(premium.netPremiumAmount + poolFeeAmountToTransfer + bundleFeeAmountToTransfer);
+
+        netPremiumAmount = AmountLib.toAmount(premium.netPremiumAmount);
+
+        // move product fee to product wallet
+        {
             address productWallet = productSetupInfo.wallet;
-            if (tokenHandler.getToken().allowance(policyOwner, address(tokenHandler)) < premium.premiumAmount) {
-                revert ErrorIPolicyServiceInsufficientAllowance(policyOwner, address(tokenHandler), premium.premiumAmount);
-            }
-            tokenHandler.transfer(policyOwner, productWallet, premium.productFeeFixAmount + premium.productFeeVarAmount);
+            tokenHandler.transfer(policyOwner, productWallet, productFeeAmountToTransfer);
+        }
 
-            // move distribution fee to distribution wallet
+        // move distribution fee to distribution wallet
+        {
             ISetup.DistributionSetupInfo memory distributionSetupInfo = instance.getInstanceReader().getDistributionSetupInfo(productSetupInfo.distributionNftId);
             address distributionWallet = distributionSetupInfo.wallet;
-            uint256 distributionFeeAmountToTransfer = premium.distributionFeeFixAmount + premium.distributionFeeVarAmount - premium.discountAmount;
             tokenHandler.transfer(policyOwner, distributionWallet, distributionFeeAmountToTransfer);
             _distributionService.processSale(productSetupInfo.distributionNftId, policyInfo.referralId, premium, distributionFeeAmountToTransfer);
-            
-            // move netpremium to pool wallet
-            tokenHandler.transfer(policyOwner, poolWallet, premium.netPremiumAmount);
-            
-            // TODO: move pool related tokens too
-            // TODO: move bundle related tokens too
-            netPremiumAmount = premium.netPremiumAmount;
+        }
+        
+        // move netpremium, bundleFee and poolFee to pool wallet
+        {
+            address poolWallet = instance.getInstanceReader().getComponentInfo(productSetupInfo.poolNftId).wallet;
+            tokenHandler.transfer(policyOwner, poolWallet, poolAmountToTransfer);
+            _poolService.processSale(policyInfo.bundleNftId, premium, poolAmountToTransfer);
+        }
+
+        // validate total amount transferred
+        {
+            Amount totalTransferred = distributionFeeAmountToTransfer + poolAmountToTransfer + productFeeAmountToTransfer;
+
+            if (premium.premiumAmount != totalTransferred.toInt()) {
+                revert ErrorPolicyServiceTransferredPremiumMismatch(
+                    policyNftId, 
+                    AmountLib.toAmount(premium.premiumAmount), 
+                    totalTransferred);
+            }
         }
 
         // TODO: add logging
     }
-}
+}