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

package/contracts/instance/service/PolicyService.sol

@@ -14,17 +14,21 @@ 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} 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";
@@ -40,10 +44,11 @@ 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;
 
     event LogProductServiceSender(address sender);
 
@@ -64,6 +69,7 @@ contract PolicyService is
         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));
 
@@ -82,32 +88,6 @@ contract PolicyService is
         product = Product(productInfo.objectAddress);
     }
 
-    // function _getAndVerifyUnderwritingSetup(
-    //     IInstance instance,
-    //     InstanceReader instanceReader,
-    //     IPolicy.PolicyInfo memory policyInfo,
-    //     ISetup.ProductSetupInfo memory productSetupInfo
-    // )
-    //     internal
-    //     view
-    //     returns (
-    //         NftId poolNftId,
-    //         IComponents.PoolInfo memory poolInfo,
-    //         NftId bundleNftId,
-    //         IBundle.BundleInfo memory bundleInfo
-    //     )
-    // {
-    //     // check match between policy and bundle (via pool)
-    //     poolNftId = productSetupInfo.poolNftId;
-    //     bundleNftId = policyInfo.bundleNftId;
-    //     bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-    //     require(bundleInfo.poolNftId == poolNftId, "BUNDLE_POOL_MISMATCH");
-
-    //     // calculate required collateral
-    //     IComponents.ComponentInfo memory componentInfo = instanceReader.getComponentInfo(poolNftId);
-    //     poolInfo = abi.decode(componentInfo.data, (IComponents.PoolInfo));
-    // }
-
 
     function decline(
         NftId policyNftId
@@ -120,7 +100,7 @@ contract PolicyService is
 
 
     /// @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
@@ -139,7 +119,7 @@ contract PolicyService is
         // check policy is in state applied
         require(instanceReader.getPolicyState(applicationNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
         
-        StateId newPolicyState = UNDERWRITTEN();
+        StateId newPolicyState = COLLATERALIZED();
 
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
@@ -269,6 +249,7 @@ contract PolicyService is
             revert ErrorIPolicyServicePolicyAlreadyClosed(policyNftId);
         }
 
+        // 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);
         }
@@ -277,10 +258,6 @@ contract PolicyService is
             revert ErrorIPolicyServiceOpenClaims(policyNftId, policyInfo.openClaimsCount);
         }
 
-        if (TimestampLib.blockTimestamp().lte(policyInfo.expiredAt) && (policyInfo.payoutAmount < policyInfo.sumInsuredAmount)) {
-            revert ErrorIPolicyServicePolicyHasNotExpired(policyNftId, policyInfo.expiredAt);
-        }
-
         policyInfo.closedAt = TimestampLib.blockTimestamp();
 
         _poolService.releaseCollateral(
@@ -291,6 +268,205 @@ contract PolicyService is
         instance.updatePolicy(policyNftId, policyInfo, CLOSED());
     }
 
+    function submitClaim(
+        NftId policyNftId, 
+        Amount claimAmount,
+        bytes memory claimData
+    )
+        external
+        virtual
+        returns (ClaimId claimId)
+    {
+        (
+            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);
+        }
+
+        // check policy including this claim is still within sum insured
+        if(policyInfo.payoutAmount.toInt() + claimAmount.toInt() > policyInfo.sumInsuredAmount) {
+            revert ErrorPolicyServiceClaimExceedsSumInsured(
+                policyNftId, 
+                AmountLib.toAmount(policyInfo.sumInsuredAmount), 
+                AmountLib.toAmount(policyInfo.payoutAmount.toInt() + claimAmount.toInt()));
+        }
+
+        // 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());
+        }
+
+        emit LogPolicyServicePayoutProcessed(policyNftId, payoutId, amount);
+    }
+
+    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);
+        }
+    }
+
     function _getPoolNftId(
         IInstance instance,
         NftId productNftId
@@ -308,13 +484,13 @@ contract PolicyService is
     function _processPremiumByTreasury(
         IInstance instance,
         NftId policyNftId,
-        uint256 premiumAmount
+        uint256 premiumExpectedAmount
     )
         internal
         returns (uint256 netPremiumAmount)
     {
         // process token transfer(s)
-        if(premiumAmount > 0) {
+        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);
@@ -331,8 +507,11 @@ contract PolicyService is
                 policyInfo.referralId
                 );
 
-            if (premium.premiumAmount != premiumAmount) {
-                revert ErrorIPolicyServicePremiumMismatch(policyNftId, premiumAmount, premium.premiumAmount);
+            if (premium.premiumAmount != premiumExpectedAmount) {
+                revert ErrorIPolicyServicePremiumMismatch(
+                    policyNftId, 
+                    premiumExpectedAmount, 
+                    premium.premiumAmount);
             }
 
             // move product fee to product wallet

package/contracts/instance/service/ProductService.sol

@@ -24,7 +24,7 @@ import {Timestamp, zeroTimestamp} from "../../types/Timestamp.sol";
 import {UFixed, UFixedLib} from "../../types/UFixed.sol";
 import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
 import {ObjectType, PRODUCT, POOL, POLICY} from "../../types/ObjectType.sol";
-import {APPLIED, UNDERWRITTEN, ACTIVE, KEEP_STATE} from "../../types/StateId.sol";
+import {APPLIED, ACTIVE, KEEP_STATE} from "../../types/StateId.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {Fee, FeeLib} from "../../types/Fee.sol";
 import {ReferralId} from "../../types/Referral.sol";

package/contracts/types/Amount.sol

@@ -9,6 +9,7 @@ using {
     AmountLib.eqz,
     AmountLib.gtz,
     AmountLib.toInt,
+    AmountLib.add,
     AmountLib.toUFixed
 } for Amount global;
 
@@ -45,6 +46,10 @@ library AmountLib {
         return Amount.unwrap(amount) > 0;
     }
 
+    function add(Amount a1, Amount a2) public pure returns (Amount) {
+        return Amount.wrap(Amount.unwrap(a1) + Amount.unwrap(a2));
+    }
+
     function toInt(Amount amount) public pure returns (uint256) {
         return uint256(uint96(Amount.unwrap(amount)));
     }

package/contracts/types/ClaimId.sol

@@ -4,13 +4,18 @@ pragma solidity ^0.8.20;
 // uint16 allows for 65'535 claims per policy
 type ClaimId is uint16;
 
+import {CLAIM} from "./ObjectType.sol";
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+
 // type bindings
 using {
     eqClaimId as ==, 
     neClaimId as !=, 
     ClaimIdLib.eqz,
     ClaimIdLib.gtz,
-    ClaimIdLib.toInt
+    ClaimIdLib.toInt,
+    ClaimIdLib.toKey32
 } for ClaimId global;
 
 
@@ -25,10 +30,14 @@ function neClaimId(ClaimId a, ClaimId b) pure returns (bool isDifferent) {
 
 // library functions that operate on user defined type
 library ClaimIdLib {
-    /// @dev Converts the ClaimId to a uint.
+    /// @dev claim id min value (0), use only for non-initialized values
     function zero() public pure returns (ClaimId) {
         return ClaimId.wrap(0);
     }
+    /// @dev claim id max value (2**16-1), use only for non-initialized values
+    function max() public pure returns (ClaimId) {
+        return ClaimId.wrap(type(uint16).max);
+    }
 
     /// @dev Converts an uint into a ClaimId.
     function toClaimId(uint256 a) public pure returns (ClaimId) {
@@ -40,6 +49,20 @@ library ClaimIdLib {
         return uint16(ClaimId.unwrap(a));
     }
 
+    /// @dev Converts the ClaimId and NftId to a Key32.
+    function toKey32(ClaimId claimId, NftId policyNftId) public pure returns (Key32) {
+        return Key32Lib.toKey32(CLAIM(), toKeyId(claimId, policyNftId));
+    }
+
+    /// @dev Converts the ClaimId and NftId to a Key32.
+    function toKeyId(ClaimId claimId, NftId policyNftId) public pure returns (KeyId) {
+        return KeyId.wrap(
+            bytes31(
+                bytes14(
+                    uint112(
+                        NftId.unwrap(policyNftId) << 16 + ClaimId.unwrap(claimId)))));
+    }
+
     /// @dev Returns true if the value is non-zero (> 0).
     function gtz(ClaimId a) public pure returns (bool) {
         return ClaimId.unwrap(a) > 0;

package/contracts/types/ObjectType.sol

@@ -86,6 +86,10 @@ function POOL() pure returns (ObjectType) {
     return toObjectType(140);
 }
 
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(220);
+}
+
 function RISK() pure returns (ObjectType) {
     return toObjectType(200);
 }
@@ -102,12 +106,8 @@ function CLAIM() pure returns (ObjectType) {
     return toObjectType(212);
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
-}
-
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(212);
+    return toObjectType(213); 
 }
 
 /// @dev Converts the uint8 to a ObjectType.

package/contracts/types/PayoutId.sol

@@ -4,13 +4,21 @@ pragma solidity ^0.8.20;
 // uint24 allows for 65'535 claims with 255 payouts each per policy
 type PayoutId is uint24;
 
+import {ClaimId} from "./ClaimId.sol";
+import {PAYOUT} from "./ObjectType.sol";
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+
 // type bindings
 using {
     eqPayoutId as ==, 
     nePayoutId as !=, 
     PayoutIdLib.eqz,
     PayoutIdLib.gtz,
-    PayoutIdLib.toInt
+    PayoutIdLib.toInt,
+    PayoutIdLib.toClaimId,
+    PayoutIdLib.toPayoutNo,
+    PayoutIdLib.toKey32
 } for PayoutId global;
 
 
@@ -23,8 +31,6 @@ function nePayoutId(PayoutId a, PayoutId b) pure returns (bool isDifferent) {
     return PayoutId.unwrap(a) != PayoutId.unwrap(b);
 }
 
-// TODO come up with a way to code claim id into payout id
-// eg payoutId.getClaimId(), payoutId.getPayoutNo()
 // library functions that operate on user defined type
 library PayoutIdLib {
     /// @dev Converts the PayoutId to a uint.
@@ -33,8 +39,16 @@ library PayoutIdLib {
     }
 
     /// @dev Converts an uint into a PayoutId.
-    function toPayoutId(uint256 a) public pure returns (PayoutId) {
-        return PayoutId.wrap(uint24(a));
+    function toPayoutId(ClaimId claimId, uint8 payoutNo) public pure returns (PayoutId) {
+        return PayoutId.wrap((ClaimId.unwrap(claimId) << 8) + payoutNo);
+    }
+
+    function toClaimId(PayoutId payoutId) public pure returns (ClaimId) {
+        return ClaimId.wrap(uint16(PayoutId.unwrap(payoutId) >> 8));
+    }
+
+    function toPayoutNo(PayoutId payoutId) public pure returns (uint8) {
+        return uint8(PayoutId.unwrap(payoutId) & 255);
     }
 
     /// @dev Converts the PayoutId to a uint.
@@ -51,4 +65,18 @@ library PayoutIdLib {
     function eqz(PayoutId a) public pure returns (bool) {
         return PayoutId.unwrap(a) == 0;
     }
+
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKey32(PayoutId payoutId, NftId policyNftId) public pure returns (Key32) {
+        return Key32Lib.toKey32(PAYOUT(), toKeyId(payoutId, policyNftId));
+    }
+
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKeyId(PayoutId payoutId, NftId policyNftId) public pure returns (KeyId) {
+        return KeyId.wrap(
+            bytes31(
+                bytes15(
+                    uint120(
+                        (NftId.unwrap(policyNftId) << 24) + PayoutId.unwrap(payoutId)))));
+    }
 }

package/contracts/types/StateId.sol

@@ -26,14 +26,18 @@ function DECLINED() pure returns (StateId) {
     return toStateId(30);
 }
 
-function UNDERWRITTEN() pure returns (StateId) {
+function COLLATERALIZED() pure returns (StateId) {
     return toStateId(40);
 }
 
-function CONFIRMED() pure returns (StateId) {
+function SUBMITTED() pure returns (StateId) {
     return toStateId(50);
 }
 
+function CONFIRMED() pure returns (StateId) {
+    return toStateId(51);
+}
+
 function EXPECTED() pure returns (StateId) {
     return toStateId(60);
 }

package/contracts/types/Timestamp.sol

@@ -60,6 +60,11 @@ function zeroTimestamp() pure returns (Timestamp) {
 }
 
 library TimestampLib {
+
+    function zero() public pure returns (Timestamp) {
+        return toTimestamp(0);
+    }
+    
     function blockTimestamp() public view returns (Timestamp) {
         return Timestamp.wrap(uint40(block.timestamp));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-db1e1e4-828",
+  "version": "0.0.2-db81915-875",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {