@etherisc/gif-next 0.0.2-b9366f5-670 → 0.0.2-b98b2b0-875

package/contracts/product/ClaimService.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
 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";
@@ -14,8 +11,15 @@ import {StateId} from "../type/StateId.sol";
 import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 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 {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";
 
 
@@ -24,6 +28,7 @@ contract ClaimService is
     IClaimService
 {
 
+    IPolicyService internal _policyService;
     IPoolService internal _poolService;
 
     function _initialize(
@@ -35,16 +40,16 @@ contract ClaimService is
         initializer()
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
+        _policyService = IPolicyService(getRegistry().getServiceAddress(POLICY(), getVersion().toMajorPart()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
-        registerInterface(type(IClaimService).interfaceId);
+        _registerInterface(type(IClaimService).interfaceId);
     }
 
     function submit(
@@ -54,9 +59,11 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
         returns (ClaimId claimId)
     {
         (
+            ,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -108,8 +115,10 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
         (
+            NftId productNftId,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -123,16 +132,25 @@ contract ClaimService is
         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
-
         // update and save policy info with instance
         policyInfo.claimAmount = policyInfo.claimAmount + confirmedAmount;
         instance.getInstanceStore().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);
+
+        // callback to pool if applicable
+        _processConfirmedClaimByPool(instanceReader, productNftId, policyNftId, claimId, confirmedAmount);
+
+        // callback to policy holder if applicable
+        _policyHolderClaimConfirmed(policyNftId, claimId, confirmedAmount);
     }
 
+
     function decline(
         NftId policyNftId, 
         ClaimId claimId,
@@ -140,8 +158,10 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
         (
+            ,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -168,8 +188,10 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
         (
+            ,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -194,8 +216,10 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
         (
+            ,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -225,7 +249,7 @@ contract ClaimService is
         instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
     }
 
-    // TODO add test
+
     function createPayoutForBeneficiary(
         NftId policyNftId, 
         ClaimId claimId,
@@ -235,6 +259,7 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance claim in a single tx
         returns (PayoutId payoutId)
     {
         if (beneficiary == address(0)) {
@@ -258,6 +283,7 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance payout in a single tx
         returns (PayoutId payoutId)
     {
         return _createPayout(
@@ -268,56 +294,6 @@ contract ClaimService is
             data);
     }
 
-    function _createPayout(
-        NftId policyNftId, 
-        ClaimId claimId,
-        Amount amount,
-        address beneficiary,
-        bytes memory data
-    )
-        internal
-        virtual
-        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
-        // create payout info with instance
-        uint8 claimNo = claimInfo.payoutsCount + 1;
-        payoutId = PayoutIdLib.toPayoutId(claimId, claimNo);
-        instance.getInstanceStore().createPayout(
-            policyNftId, 
-            payoutId, 
-            IPolicy.PayoutInfo({
-                claimId: payoutId.toClaimId(),
-                amount: amount,
-                beneficiary: beneficiary,
-                data: data,
-                paidAt: TimestampLib.zero()}));
-
-        // update and save claim info with instance
-        claimInfo.payoutsCount += 1;
-        claimInfo.openPayoutsCount += 1;
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
-
-        // update and save policy info with instance
-        policyInfo.payoutAmount.add(amount);
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
-
-        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount);
-    }
-
 
     function processPayout(
         NftId policyNftId, 
@@ -325,8 +301,10 @@ contract ClaimService is
     )
         external
         virtual
+        // nonReentrant() // prevents creating a reinsurance payout in a single tx
     {
         (
+            ,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
@@ -339,7 +317,6 @@ contract ClaimService is
         payoutInfo.paidAt = TimestampLib.blockTimestamp();
         instance.getInstanceStore().updatePayout(policyNftId, payoutId, payoutInfo, PAID());
 
-        // TODO update and save claim info with instance
         ClaimId claimId = payoutId.toClaimId();
         Amount payoutAmount = payoutInfo.amount;
         IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
@@ -349,7 +326,7 @@ contract ClaimService is
         // 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();
+            claimInfo.closedAt = TimestampLib.blockTimestamp();
             instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
 
             policyInfo.openClaimsCount -= 1;
@@ -362,13 +339,13 @@ contract ClaimService is
         instance.getInstanceStore().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,
@@ -390,9 +367,68 @@ contract ClaimService is
             // TODO add 2nd token tx if processingFeeAmount > 0
         }
 
-        // TODO callback IPolicyHolder
+        // callback to policy holder if applicable
+        _policyHolderPayoutExecuted(policyNftId, payoutId, beneficiary, payoutAmount);
     }
 
+    // internal functions
+
+
+    function _createPayout(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        internal
+        virtual
+        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
+        // create payout info with instance
+        uint24 payoutNo = claimInfo.payoutsCount + 1;
+        payoutId = PayoutIdLib.toPayoutId(claimId, payoutNo);
+        if (beneficiary == address(0)) {
+            beneficiary = getRegistry().ownerOf(policyNftId);
+        }
+        instance.getInstanceStore().createPayout(
+            policyNftId, 
+            payoutId, 
+            IPolicy.PayoutInfo({
+                claimId: payoutId.toClaimId(),
+                amount: amount,
+                beneficiary: beneficiary,
+                data: data,
+                paidAt: TimestampLib.zero()}));
+
+        // update and save claim info with instance
+        claimInfo.payoutsCount += 1;
+        claimInfo.openPayoutsCount += 1;
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+
+        // update and save policy info with instance
+        policyInfo.payoutAmount.add(amount);
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+
+        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount, beneficiary);
+    }
+
+
     function _calculatePayoutAmount(
         InstanceReader instanceReader,
         NftId policyNftId,
@@ -430,7 +466,6 @@ contract ClaimService is
         }
     }
 
-    // internal functions
 
     function _verifyCallerWithPolicy(
         NftId policyNftId
@@ -439,12 +474,12 @@ contract ClaimService is
         view
         virtual
         returns (
+            NftId productNftId,
             IInstance instance,
             InstanceReader instanceReader,
             IPolicy.PolicyInfo memory policyInfo
         )
     {
-        NftId productNftId;
         (productNftId,, instance) = _getAndVerifyActiveComponent(PRODUCT());
         instanceReader = instance.getInstanceReader();
 
@@ -480,6 +515,65 @@ contract ClaimService is
         claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
     }
 
+    function _processConfirmedClaimByPool(
+        InstanceReader instanceReader, 
+        NftId productNftId, 
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount amount
+    )
+        internal
+    {
+        NftId poolNftId = instanceReader.getProductInfo(productNftId).poolNftId;
+        if (instanceReader.getPoolInfo(poolNftId).isProcessingConfirmedClaims) {
+            address poolAddress = getRegistry().getObjectAddress(poolNftId);
+            IPoolComponent(poolAddress).processConfirmedClaim(policyNftId, claimId, amount);
+        }
+    }
+
+
+    function _policyHolderClaimConfirmed(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount confirmedAmount
+    )
+        internal
+    {
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+        if(address(policyHolder) != address(0)) {
+            policyHolder.claimConfirmed(policyNftId, claimId, confirmedAmount);
+        }
+    }
+
+
+    function _policyHolderPayoutExecuted(
+        NftId policyNftId, 
+        PayoutId payoutId,
+        address beneficiary,
+        Amount payoutAmount
+    )
+        internal
+    {
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+        if(address(policyHolder) != address(0)) {
+            policyHolder.payoutExecuted(policyNftId, payoutId, payoutAmount, beneficiary);
+        }
+    }
+
+
+    function _getPolicyHolder(NftId policyNftId)
+        internal 
+        view 
+        returns (IPolicyHolder policyHolder)
+    {
+        address policyHolderAddress = getRegistry().ownerOf(policyNftId);
+        policyHolder = IPolicyHolder(policyHolderAddress);
+
+        if (!ContractLib.isPolicyHolder(policyHolderAddress)) {
+            policyHolder = IPolicyHolder(address(0));
+        }
+    }
+
 
     function _getDomain() internal pure override returns(ObjectType) {
         return CLAIM();

package/contracts/product/ClaimServiceManager.sol

@@ -12,14 +12,14 @@ contract ClaimServiceManager is ProxyManager {
     /// @dev initializes proxy manager with service implementation 
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
         ClaimService svc = new ClaimService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);

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,12 +4,20 @@ 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";
 
 interface IPolicyService is IService {
 
+    event LogPolicyServicePolicyCreated(NftId policyNftId, Amount premiumAmount, Timestamp activatedAt);
+    event LogPolicyServicePolicyDeclined(NftId policyNftId);
+    event LogPolicyServicePolicyPremiumCollected(NftId policyNftId, Amount premiumAmount);
+    event LogPolicyServicePolicyActivated(NftId policyNftId, Timestamp activatedAt);
+    event LogPolicyServicePolicyExpirationUpdated(NftId policyNftId, Timestamp originalExpiredAt, Timestamp expiredAt);
+    event LogPolicyServicePolicyClosed(NftId policyNftId);
+
     error ErrorPolicyServicePolicyProductMismatch(NftId applicationNftId, NftId expectedProductNftId, NftId actualProductNftId);
     error ErrorPolicyServicePolicyStateNotApplied(NftId applicationNftId);
     error ErrorPolicyServicePolicyStateNotCollateralized(NftId applicationNftId);
@@ -32,9 +40,6 @@ interface IPolicyService is IService {
     error ErrorPolicyServicePremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount recalculatedPremiumAmount);
     error ErrorPolicyServiceTransferredPremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount transferredPremiumAmount);
 
-    event LogPolicyServicePolicyDeclined(NftId policyNftId);
-    event LogPolicyServicePolicyExpirationUpdated(NftId policyNftId, Timestamp expiredAt);
-
     /// @dev creates the policy from {applicationNftId}. 
     /// After successful completion of the function the policy can be referenced using the application NftId.
     /// Locks the sum insured amount in the pool, but does not transfer tokens. Call collectPremium to transfer tokens. 
@@ -65,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/IProductComponent.sol

@@ -2,6 +2,7 @@
 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";
@@ -13,6 +14,18 @@ interface IProductComponent is
     IInstanceLinkedComponent
 {
 
+    /// @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 +35,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 +46,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);