@etherisc/gif-next 0.0.2-f2df3e2-873 → 0.0.2-f398177-971

package/contracts/instance/service/PolicyService.sol

@@ -18,7 +18,7 @@ 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, CLAIM} from "../../types/ObjectType.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";
@@ -33,10 +33,10 @@ 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
@@ -49,6 +49,7 @@ contract PolicyService is
     IClaimService internal _claimService;
     IDistributionService internal _distributionService;
     IPoolService internal _poolService;
+    IPricingService internal _pricingService;
 
     event LogProductServiceSender(address sender);
 
@@ -72,6 +73,7 @@ contract PolicyService is
         _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);
     }
@@ -84,7 +86,7 @@ contract PolicyService is
 
     function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
         IRegistry.ObjectInfo memory productInfo;
-        (, productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (, productInfo,) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         product = Product(productInfo.objectAddress);
     }
 
@@ -95,7 +97,7 @@ contract PolicyService is
         external
         override
     {
-        require(false, "ERROR:PRS-235:NOT_YET_IMPLEMENTED");
+        revert();
     }
 
 
@@ -109,15 +111,22 @@ contract PolicyService is
         virtual override
     {
         // check caller is registered product
-        (NftId productNftId,, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         // check policy matches with calling product
         IPolicy.PolicyInfo memory applicationInfo = instanceReader.getPolicyInfo(applicationNftId);
-        require(applicationInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
+        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");
+        if (instanceReader.getPolicyState(applicationNftId) != APPLIED()) {
+            revert ErrorPolicyServicePolicyStateNotApplied(applicationNftId);
+        }
         
         StateId newPolicyState = COLLATERALIZED();
 
@@ -129,7 +138,7 @@ contract PolicyService is
         }
 
         // 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) {
@@ -138,11 +147,11 @@ contract PolicyService is
                 applicationNftId, 
                 applicationInfo.premiumAmount);
 
-            applicationInfo.premiumPaidAmount += applicationInfo.premiumAmount;
+            applicationInfo.premiumPaidAmount = applicationInfo.premiumPaidAmount + applicationInfo.premiumAmount;
         }
 
         // store updated policy info
-        instance.updatePolicy(applicationNftId, applicationInfo, newPolicyState);
+        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
@@ -160,33 +169,46 @@ contract PolicyService is
     }
 
 
-    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
-        (NftId productNftId,, 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);
@@ -197,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);
@@ -209,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
     }
@@ -231,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);
@@ -250,8 +272,8 @@ contract PolicyService is
         }
 
         // TODO consider to allow for underpaid premiums (with the effects of reducing max payouts accordingly)
-        if (policyInfo.premiumAmount != policyInfo.premiumPaidAmount) {
-            revert ErrorIPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
+        if (!(policyInfo.premiumAmount == policyInfo.premiumPaidAmount)) {
+            revert ErrorPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
         }
 
         if (policyInfo.openClaimsCount > 0) {
@@ -265,277 +287,90 @@ contract PolicyService is
             policyNftId, 
             policyInfo);
 
-        instance.updatePolicy(policyNftId, policyInfo, CLOSED());
+        instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, CLOSED());
     }
 
-    function submitClaim(
-        NftId policyNftId, 
-        Amount claimAmount,
-        bytes memory claimData
+
+    function _processPremiumByTreasury(
+        IInstance instance,
+        NftId policyNftId,
+        Amount premiumExpectedAmount
     )
-        external
-        virtual
-        returns (ClaimId claimId)
+        internal
+        returns (Amount netPremiumAmount)
     {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        // check policy is in its active period
-        if(policyInfo.activatedAt.eqz() || TimestampLib.blockTimestamp() >= policyInfo.expiredAt) {
-            revert ErrorPolicyServicePolicyNotOpen(policyNftId);
+        // process token transfer(s)
+        if(premiumExpectedAmount.eqz()) {
+            return AmountLib.zero();
         }
 
-        // check policy including this claim is still within sum insured
-        if(policyInfo.payoutAmount.toInt() + claimAmount.toInt() > policyInfo.sumInsuredAmount) {
-            revert ErrorPolicyServiceClaimExceedsSumInsured(
+        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, 
-                AmountLib.toAmount(policyInfo.sumInsuredAmount), 
-                AmountLib.toAmount(policyInfo.payoutAmount.toInt() + claimAmount.toInt()));
+                premiumExpectedAmount, 
+                AmountLib.toAmount(premium.premiumAmount));
         }
 
-        // create new claim
-        claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
-        _claimService.submit(instance, policyNftId, claimId, claimAmount, claimData);
-
-        // update and save policy info with instance
-        policyInfo.claimsCount += 1;
-        policyInfo.openClaimsCount += 1;
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        emit LogPolicyServiceClaimSubmitted(policyNftId, claimId, claimAmount);
-    }
-
-    function confirmClaim(
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount confirmedAmount
-    )
-        external
-    {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        // check/update claim info
-        _claimService.confirm(instance, instanceReader, policyNftId, claimId, confirmedAmount);
-
-        // update and save policy info with instance
-        instance.updatePolicy(policyNftId, policyInfo, CONFIRMED());
-
-        emit LogPolicyServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
-    }
-
-    function declineClaim(
-        NftId policyNftId, 
-        ClaimId claimId
-    )
-        external
-    {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        // check/update claim info
-        _claimService.decline(instance, instanceReader, policyNftId, claimId);
-
-        // update and save policy info with instance
-        policyInfo.openClaimsCount -= 1;
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        emit LogPolicyServiceClaimDeclined(policyNftId, claimId);
-    }
-
-    function closeClaim(
-        NftId policyNftId, 
-        ClaimId claimId
-    )
-        external
-    {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        // check/update claim info
-        _claimService.close(instance, instanceReader, policyNftId, claimId);
-
-        // update and save policy info with instance
-        policyInfo.openClaimsCount -= 1;
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        emit LogPolicyServiceClaimClosed(policyNftId, claimId);
-    }
-
-    function createPayout(
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount amount,
-        bytes memory data
-    )
-        external
-        returns (PayoutId payoutId)
-    {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
-        StateId claimState = instanceReader.getClaimState(policyNftId, claimId);
-
-        // TODO add checks
-        // claim needs to be open
-        // claim.paidAmount + amount <= claim.claimAmount
-
-        // check/update claim info
-        uint8 claimNo = claimInfo.payoutsCount + 1;
-        payoutId = PayoutIdLib.toPayoutId(claimId, claimNo);
-        _claimService.createPayout(
-            instance, 
-            policyNftId, 
-            payoutId,
-            amount,
-            data);
-
-        // update and save policy info with instance
-        policyInfo.payoutAmount.add(amount);
-        instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        emit LogPolicyServicePayoutCreated(policyNftId, payoutId, amount);
-    }
-
-    function processPayout(
-        NftId policyNftId, 
-        PayoutId payoutId
-    )
-        external
-    {
-        (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        ) = _verifyCallerWithPolicy(policyNftId);
-
-        // check/update claim info
-        (
-            Amount amount,
-            bool payoutIsClosingClaim
-        ) = _claimService.processPayout(
-            instance, 
-            instanceReader, 
-            policyNftId, 
-            payoutId);
-
-        // update policy info if affected by processed payout
-        if(payoutIsClosingClaim) {
-            policyInfo.openClaimsCount -= 1;
-            instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
+        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);
         }
 
-        emit LogPolicyServicePayoutProcessed(policyNftId, payoutId, amount);
-    }
+        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);
 
-    function _verifyCallerWithPolicy(
-        NftId policyNftId
-    )
-        internal
-        returns (
-            IInstance instance,
-            InstanceReader instanceReader,
-            IPolicy.PolicyInfo memory policyInfo
-        )
-    {
-        NftId productNftId;
-        (productNftId,, instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instanceReader = instance.getInstanceReader();
-
-        // check caller(product) policy match
-        policyInfo = instanceReader.getPolicyInfo(policyNftId);
-        if(policyInfo.productNftId != productNftId) {
-            revert ErrorPolicyServicePolicyProductMismatch(policyNftId, 
-            policyInfo.productNftId, 
-            productNftId);
-        }
-    }
+        netPremiumAmount = AmountLib.toAmount(premium.netPremiumAmount);
 
-    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;
-    }
-
-
-    function _processPremiumByTreasury(
-        IInstance instance,
-        NftId policyNftId,
-        uint256 premiumExpectedAmount
-    )
-        internal
-        returns (uint256 netPremiumAmount)
-    {
-        // process token transfer(s)
-        if(premiumExpectedAmount > 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 != premiumExpectedAmount) {
-                revert ErrorIPolicyServicePremiumMismatch(
-                    policyNftId, 
-                    premiumExpectedAmount, 
-                    premium.premiumAmount);
-            }
-
-            // move product fee to product wallet
+        // 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
     }
-}
+}