@etherisc/gif-next 0.0.2-df73b56-462 → 0.0.2-dfb8aa3-070

package/contracts/product/ClaimService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {TimestampLib} from "../type/Timestamp.sol";
-import {ObjectType, CLAIM, PRODUCT, POOL} from "../type/ObjectType.sol";
+import {ObjectType, CLAIM, POLICY, POOL, PRODUCT} from "../type/ObjectType.sol";
 import {SUBMITTED, KEEP_STATE, DECLINED, REVOKED, CONFIRMED, CLOSED, PAID} from "../type/StateId.sol";
 import {NftId} from "../type/NftId.sol";
 import {FeeLib} from "../type/Fee.sol";
@@ -13,12 +13,14 @@ import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {ContractLib} from "../shared/ContractLib.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IClaimService} from "./IClaimService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 
 
@@ -27,6 +29,7 @@ contract ClaimService is
     IClaimService
 {
 
+    IPolicyService internal _policyService;
     IPoolService internal _poolService;
 
     function _initialize(
@@ -44,6 +47,7 @@ contract ClaimService is
 
         _initializeService(registryAddress, authority, owner);
 
+        _policyService = IPolicyService(getRegistry().getServiceAddress(POLICY(), getVersion().toMajorPart()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
         _registerInterface(type(IClaimService).interfaceId);
@@ -56,13 +60,15 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
         returns (ClaimId claimId)
     {
+        _checkNftType(policyNftId, POLICY());
+
         (
             ,
-            IInstance instance,
-            InstanceReader instanceReader,
+            IInstance instance,,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -82,7 +88,7 @@ contract ClaimService is
 
         // create new claim
         claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
-        instance.getInstanceStore().createClaim(
+        instanceStore.createClaim(
             policyNftId, 
             claimId, 
             IPolicy.ClaimInfo({
@@ -95,10 +101,10 @@ contract ClaimService is
                 closedAt: TimestampLib.zero()}));
 
         // update and save policy info with instance
+        // policy claim amount is only updated when claim is confirmed
         policyInfo.claimsCount += 1;
         policyInfo.openClaimsCount += 1;
-        // policy claim amount is only updated when claim is confirmed
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimSubmitted(policyNftId, claimId, claimAmount);
     }
@@ -112,12 +118,15 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
+        _checkNftType(policyNftId, POLICY());
+
         (
             NftId productNftId,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -127,14 +136,16 @@ contract ClaimService is
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
         claimInfo.claimAmount = confirmedAmount;
         claimInfo.processData = data;
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CONFIRMED());
-
-        // TODO test if claim results in total claim amount == sum insured amount
-        // should policy still be active it needs to automatically become expired
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, CONFIRMED());
 
         // update and save policy info with instance
         policyInfo.claimAmount = policyInfo.claimAmount + confirmedAmount;
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+
+        // should policy still be active it needs to become expired
+        if (policyInfo.claimAmount >= policyInfo.sumInsuredAmount) {
+            _policyService.expirePolicy(instance, policyNftId, TimestampLib.blockTimestamp());
+        }
 
         emit LogClaimServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
 
@@ -153,12 +164,15 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
+        _checkNftType(policyNftId, POLICY());
+
         (
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -166,11 +180,11 @@ contract ClaimService is
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
         claimInfo.processData = data;
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, DECLINED());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, DECLINED());
 
         // update and save policy info with instance
         policyInfo.openClaimsCount -= 1;
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimDeclined(policyNftId, claimId);
     }
@@ -183,23 +197,26 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
+        _checkNftType(policyNftId, POLICY());
+        
         (
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
         // check/update claim info
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, REVOKED());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, REVOKED());
 
         // update and save policy info with instance
         policyInfo.openClaimsCount -= 1;
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimRevoked(policyNftId, claimId);
     }
@@ -211,12 +228,15 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
+        _checkNftType(policyNftId, POLICY());
+        
         (
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -241,7 +261,7 @@ contract ClaimService is
         }
 
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
     }
 
 
@@ -254,9 +274,11 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
         returns (PayoutId payoutId)
     {
+        _checkNftType(policyNftId, POLICY());
+        
         if (beneficiary == address(0)) {
             revert ErrorClaimServiceBeneficiaryIsZero(policyNftId, claimId);
         }
@@ -278,9 +300,11 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance payout in a single tx
         returns (PayoutId payoutId)
     {
+        _checkNftType(policyNftId, POLICY());
+        
         return _createPayout(
             policyNftId, 
             claimId, 
@@ -296,12 +320,15 @@ contract ClaimService is
     )
         external
         virtual
-        nonReentrant()
+        // nonReentrant() // prevents creating a reinsurance payout in a single tx
     {
+        _checkNftType(policyNftId, POLICY());
+        
         (
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -310,60 +337,65 @@ contract ClaimService is
 
         // update and save payout info with instance
         payoutInfo.paidAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updatePayout(policyNftId, payoutId, payoutInfo, PAID());
+        instanceStore.updatePayout(policyNftId, payoutId, payoutInfo, PAID());
 
-        ClaimId claimId = payoutId.toClaimId();
         Amount payoutAmount = payoutInfo.amount;
-        IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
-        claimInfo.paidAmount = claimInfo.paidAmount.add(payoutAmount);
-        claimInfo.openPayoutsCount -= 1;
-
-        // check if this payout is closing the linked claim
-        // update claim and policy info accordingly
-        if(claimInfo.openPayoutsCount == 0 && claimInfo.paidAmount == claimInfo.claimAmount) {
-            claimInfo.closedAt == TimestampLib.blockTimestamp();
-            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
-
-            policyInfo.openClaimsCount -= 1;
-        } else {
-            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+
+        {
+            ClaimId claimId = payoutId.toClaimId();
+            IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
+            claimInfo.paidAmount = claimInfo.paidAmount.add(payoutAmount);
+            claimInfo.openPayoutsCount -= 1;
+
+            // check if this payout is closing the linked claim
+            // update claim and policy info accordingly
+            if(claimInfo.openPayoutsCount == 0 && claimInfo.paidAmount == claimInfo.claimAmount) {
+                claimInfo.closedAt = TimestampLib.blockTimestamp();
+                instanceStore.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+
+                policyInfo.openClaimsCount -= 1;
+            } else {
+                instanceStore.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+            }
         }
 
         // update and save policy info with instance
         policyInfo.payoutAmount = policyInfo.payoutAmount.add(payoutAmount);
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         // inform pool about payout
-        _poolService.reduceCollateral(
+        _poolService.processPayout(
             instance, 
             address(instanceReader.getComponentInfo(policyInfo.productNftId).token),
             policyNftId, 
             policyInfo, 
             payoutAmount);
-
+        
         // transfer payout token and fee
-        (
-            Amount netPayoutAmount,
-            Amount processingFeeAmount,
-            address beneficiary
-        ) = _calculatePayoutAmount(
-            instanceReader,
-            policyNftId,
-            policyInfo,
-            payoutInfo);
-
-        emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount, processingFeeAmount);
-
         {
-            NftId poolNftId = getRegistry().getObjectInfo(policyInfo.bundleNftId).parentNftId;
-            IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
-            poolInfo.tokenHandler.distributeTokens(poolInfo.wallet, beneficiary, netPayoutAmount);
+            (
+                Amount netPayoutAmount,
+                Amount processingFeeAmount,
+                address beneficiary
+            ) = _calculatePayoutAmount(
+                instanceReader,
+                policyNftId,
+                policyInfo,
+                payoutInfo);
+
+            emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount, processingFeeAmount);
+
+            {
+                NftId poolNftId = getRegistry().getObjectInfo(policyInfo.bundleNftId).parentNftId;
+                IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
+                poolInfo.tokenHandler.distributeTokens(poolInfo.wallet, beneficiary, netPayoutAmount);
+
+                // TODO add 2nd token tx if processingFeeAmount > 0
+            }
 
-            // TODO add 2nd token tx if processingFeeAmount > 0
+            // callback to policy holder if applicable
+            _policyHolderPayoutExecuted(policyNftId, payoutId, beneficiary, payoutAmount);
         }
-
-        // callback to policy holder if applicable
-        _policyHolderPayoutExecuted(policyNftId, payoutId, beneficiary, payoutAmount);
     }
 
     // internal functions
@@ -382,8 +414,9 @@ contract ClaimService is
     {
         (
             ,
-            IInstance instance,
+            ,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -396,9 +429,13 @@ contract ClaimService is
 
         // check/update claim info
         // create payout info with instance
-        uint8 claimNo = claimInfo.payoutsCount + 1;
-        payoutId = PayoutIdLib.toPayoutId(claimId, claimNo);
-        instance.getInstanceStore().createPayout(
+        uint24 payoutNo = claimInfo.payoutsCount + 1;
+        payoutId = PayoutIdLib.toPayoutId(claimId, payoutNo);
+        if (beneficiary == address(0)) {
+            beneficiary = getRegistry().ownerOf(policyNftId);
+        }
+
+        instanceStore.createPayout(
             policyNftId, 
             payoutId, 
             IPolicy.PayoutInfo({
@@ -411,13 +448,13 @@ contract ClaimService is
         // update and save claim info with instance
         claimInfo.payoutsCount += 1;
         claimInfo.openPayoutsCount += 1;
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
 
         // update and save policy info with instance
         policyInfo.payoutAmount.add(amount);
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
-        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount);
+        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount, beneficiary);
     }
 
 
@@ -469,11 +506,13 @@ contract ClaimService is
             NftId productNftId,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         )
     {
         (productNftId,, instance) = _getAndVerifyActiveComponent(PRODUCT());
         instanceReader = instance.getInstanceReader();
+        instanceStore = instance.getInstanceStore();
 
         // check caller(product) policy match
         policyInfo = instanceReader.getPolicyInfo(policyNftId);
@@ -518,7 +557,7 @@ contract ClaimService is
     {
         NftId poolNftId = instanceReader.getProductInfo(productNftId).poolNftId;
         if (instanceReader.getPoolInfo(poolNftId).isProcessingConfirmedClaims) {
-            address poolAddress = getRegistry().getObjectInfo(poolNftId).objectAddress;
+            address poolAddress = getRegistry().getObjectAddress(poolNftId);
             IPoolComponent(poolAddress).processConfirmedClaim(policyNftId, claimId, amount);
         }
     }

package/contracts/product/IClaimService.sol

@@ -26,8 +26,9 @@ interface IClaimService is
     event LogClaimServiceClaimRevoked(NftId policyNftId, ClaimId claimId);
     event LogClaimServiceClaimClosed(NftId policyNftId, ClaimId claimId);
 
-    event LogClaimServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount);
+    event LogClaimServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary);
     event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount, Amount processingFeeAmount);
+    error ErrorClaimServiceBeneficiarySet(NftId policyNftId, PayoutId payoutId, address beneficiary);
 
     error ErrorClaimServicePolicyProductMismatch(NftId policyNftId, NftId expectedProduct, NftId actualProduct);
     error ErrorClaimServicePolicyNotOpen(NftId policyNftId);
@@ -35,7 +36,7 @@ interface IClaimService is
     error ErrorClaimServiceBeneficiaryIsZero(NftId policyNftId, ClaimId claimId);
     error ErrorClaimsServicePayoutAmountIsZero(NftId policyNftId, PayoutId payoutId);
 
-    error ErrorClaimServiceClaimWithOpenPayouts(NftId policyNftId, ClaimId claimId, uint8 openPayouts);
+    error ErrorClaimServiceClaimWithOpenPayouts(NftId policyNftId, ClaimId claimId, uint24 openPayouts);
     error ErrorClaimServiceClaimWithMissingPayouts(NftId policyNftId, ClaimId claimId, Amount claimAmount, Amount paidAmount);
     error ErrorClaimServiceClaimNotInExpectedState(NftId policyNftId, ClaimId claimId, StateId expectedState, StateId actualState);
 

package/contracts/product/IPolicyService.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {IService} from "../shared/IService.sol";
 
 import {Amount} from "../type/Amount.sol";
+import {IInstance} from "../instance/IInstance.sol";
 import {NftId} from "../type/NftId.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -69,6 +70,8 @@ interface IPolicyService is IService {
     /// @return expiredAt the effective expiry date
     function expire(NftId policyNftId, Timestamp expireAt) external returns (Timestamp expiredAt);
 
+    function expirePolicy(IInstance instance, NftId policyNftId, Timestamp expireAt) external returns (Timestamp expiredAt);
+
     /// @dev closes the specified policy and sets the closed data in the policy metadata
     /// a policy can only be closed when it has been expired. in addition, it must not have any open claims
     /// this function can only be called by a product. the policy needs to match with the calling product

package/contracts/product/IPricingService.sol

@@ -14,15 +14,15 @@ interface IPricingService is IService
 {
 
     error ErrorPricingServiceTargetWalletAmountsMismatch();
-    error ErrorIPricingServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
-    error ErrorIPricingServiceFeeCalculationMismatch(
-                Amount distributionFeeFixAmount,
-                Amount distributionFeeVarAmount,
-                Amount distributionOwnerFeeFixAmount,
-                Amount distributionOwnerFeeVarAmount,
-                Amount commissionAmount,
-                Amount discountAmount
-            );
+    error ErrorPricingServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
+    error ErrorPricingServiceFeeCalculationMismatch(
+        Amount distributionFeeFixAmount,
+        Amount distributionFeeVarAmount,
+        Amount distributionOwnerFeeFixAmount,
+        Amount distributionOwnerFeeVarAmount,
+        Amount commissionAmount,
+        Amount discountAmount
+    );
 
     function calculatePremium(
         NftId productNftId,

package/contracts/product/IProductComponent.sol

@@ -2,9 +2,11 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -13,6 +15,23 @@ interface IProductComponent is
     IInstanceLinkedComponent
 {
 
+    // @dev register a new component for this product cluster.
+    function registerComponent(address component)
+        external
+        returns (NftId componentNftId);
+
+    /// @dev Callback function to inform product compnent about arrival of funding for a claim.
+    /// The callback is called by the pool service after the corresponding pool triggers this function.
+    /// The callback is only called when the product's property isProcessingFundedClaims is set.
+    function processFundedClaim(
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount availableAmount
+    ) external;
+
+
+    /// @dev Calculates the premium amount for the provided application data.
+    /// The returned premium amounts takes into account potential discounts and fees.
     function calculatePremium(
         Amount sumInsuredAmount,
         RiskId riskId,
@@ -22,6 +41,10 @@ interface IProductComponent is
         ReferralId referralId
     ) external view returns (Amount premiumAmount);
 
+
+    /// @dev Calculates the net premium amount for the provided application data.
+    /// The returned net premium amounts only covers the cost of collateralizing the application.
+    /// This amount purely depends on the use case specific risk and does not include any fees/commission.
     function calculateNetPremium(
         Amount sumInsuredAmount,
         RiskId riskId,
@@ -29,9 +52,6 @@ interface IProductComponent is
         bytes memory applicationData
     ) external view returns (Amount netPremiumAmount);    
 
-    function getPoolNftId() external view returns (NftId poolNftId);
-    function getDistributionNftId() external view returns (NftId distributionNftId);
-
 
     /// @dev returns initial pool specific infos for this pool
     function getInitialProductInfo() external view returns (IComponents.ProductInfo memory info);