@etherisc/gif-next 0.0.2-98e9f45-792 → 0.0.2-998ff1b-277

package/contracts/product/ClaimService.sol

@@ -7,15 +7,17 @@ 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 {SUBMITTED, KEEP_STATE, DECLINED, CONFIRMED, CLOSED, PAID} from "../type/StateId.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";
 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 {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 
 
@@ -35,16 +37,15 @@ 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);
 
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
-        registerInterface(type(IClaimService).interfaceId);
+        _registerInterface(type(IClaimService).interfaceId);
     }
 
     function submit(
@@ -54,6 +55,7 @@ contract ClaimService is
     )
         external
         virtual
+        nonReentrant()
         returns (ClaimId claimId)
     {
         (
@@ -67,6 +69,7 @@ contract ClaimService is
             revert ErrorClaimServicePolicyNotOpen(policyNftId);
         }
 
+        // TODO check claim amount > 0
         // check policy including this claim is still within sum insured
         if(policyInfo.payoutAmount + claimAmount > policyInfo.sumInsuredAmount) {
             revert ErrorClaimServiceClaimExceedsSumInsured(
@@ -80,14 +83,14 @@ contract ClaimService is
         instance.getInstanceStore().createClaim(
             policyNftId, 
             claimId, 
-            IPolicy.ClaimInfo(
-                claimAmount,
-                AmountLib.zero(), // paidAmount
-                0, // payoutsCount
-                0, // openPayoutsCount
-                claimData, // claim submission data
-                "", // claim processing data
-                TimestampLib.zero())); // closedAt
+            IPolicy.ClaimInfo({
+                claimAmount: claimAmount,
+                paidAmount: AmountLib.zero(),
+                payoutsCount: 0,
+                openPayoutsCount: 0,
+                submissionData: claimData,
+                processData: "",
+                closedAt: TimestampLib.zero()}));
 
         // update and save policy info with instance
         policyInfo.claimsCount += 1;
@@ -107,6 +110,7 @@ contract ClaimService is
     )
         external
         virtual
+        nonReentrant()
     {
         (
             IInstance instance,
@@ -114,19 +118,28 @@ contract ClaimService is
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
+        // TODO add check for confirmedAmount > 0 and does not lead to exceeding sum insured
+
         // check/update claim info
         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
+
         // update and save policy info with instance
         policyInfo.claimAmount = policyInfo.claimAmount + confirmedAmount;
         instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
+
+        // callback to policy holder if applicable
+        _policyHolderClaimConfirmed(policyNftId, claimId, confirmedAmount);
     }
 
+
     function decline(
         NftId policyNftId, 
         ClaimId claimId,
@@ -134,6 +147,7 @@ contract ClaimService is
     )
         external
         virtual
+        nonReentrant()
     {
         (
             IInstance instance,
@@ -154,12 +168,42 @@ contract ClaimService is
         emit LogClaimServiceClaimDeclined(policyNftId, claimId);
     }
 
+
+    // TODO add test case
+    function revoke(
+        NftId policyNftId, 
+        ClaimId claimId
+    )
+        external
+        virtual
+        nonReentrant()
+    {
+        (
+            IInstance instance,
+            InstanceReader instanceReader,
+            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());
+
+        // update and save policy info with instance
+        policyInfo.openClaimsCount -= 1;
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+
+        emit LogClaimServiceClaimRevoked(policyNftId, claimId);
+    }
+
+
     function close(
         NftId policyNftId, 
         ClaimId claimId
     )
         external
         virtual
+        nonReentrant()
     {
         (
             IInstance instance,
@@ -192,51 +236,48 @@ contract ClaimService is
     }
 
 
-    function createPayout(
+    function createPayoutForBeneficiary(
         NftId policyNftId, 
         ClaimId claimId,
         Amount amount,
+        address beneficiary,
         bytes memory data
     )
         external
+        virtual
+        nonReentrant()
         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
+        if (beneficiary == address(0)) {
+            revert ErrorClaimServiceBeneficiaryIsZero(policyNftId, claimId);
+        }
 
-        // check/update claim info
-        // create payout info with instance
-        uint8 claimNo = claimInfo.payoutsCount + 1;
-        payoutId = PayoutIdLib.toPayoutId(claimId, claimNo);
-        instance.getInstanceStore().createPayout(
+        return _createPayout(
             policyNftId, 
-            payoutId, 
-            IPolicy.PayoutInfo(
-                payoutId.toClaimId(),
-                amount,
-                data,
-                TimestampLib.zero()));
-
-        // update and save claim info with instance
-        claimInfo.payoutsCount += 1;
-        claimInfo.openPayoutsCount += 1;
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+            claimId, 
+            amount, 
+            beneficiary,
+            data);
+    }
 
-        // update and save policy info with instance
-        policyInfo.payoutAmount.add(amount);
-        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
-        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount);
+    function createPayout(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        bytes memory data
+    )
+        external
+        virtual
+        nonReentrant()
+        returns (PayoutId payoutId)
+    {
+        return _createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            address(0), // defaults to owner of policy nft
+            data);
     }
 
 
@@ -246,6 +287,7 @@ contract ClaimService is
     )
         external
         virtual
+        nonReentrant()
     {
         (
             IInstance instance,
@@ -260,7 +302,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);
@@ -293,6 +334,7 @@ contract ClaimService is
         // transfer payout token and fee
         (
             Amount netPayoutAmount,
+            Amount processingFeeAmount,
             address beneficiary
         ) = _calculatePayoutAmount(
             instanceReader,
@@ -300,17 +342,74 @@ contract ClaimService is
             policyInfo,
             payoutInfo);
 
-        // TODO callback IPolicyHolder
-
-        emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount);
+        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
         }
+
+        // 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
+        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 _calculatePayoutAmount(
         InstanceReader instanceReader,
         NftId policyNftId,
@@ -320,6 +419,7 @@ contract ClaimService is
         internal
         returns (
             Amount netPayoutAmount,
+            Amount processingFeeAmount,
             address beneficiary
         )
     {
@@ -333,33 +433,20 @@ contract ClaimService is
             IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
 
             netPayoutAmount = payoutAmount;
-            beneficiary = _getBeneficiary(policyNftId, payoutInfo.claimId);
+
+            if (payoutInfo.beneficiary == address(0)) {
+                beneficiary = getRegistry().ownerOf(policyNftId);
+            } else { 
+                beneficiary = payoutInfo.beneficiary;
+            }
 
             IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
             if(FeeLib.gtz(productInfo.processingFee)) {
-                // TODO calculate net payout and processing fees
-                // TODO transfer processing fees to product wallet
-                // TODO inform product to update fee book keeping
+                // TODO calculate and set net payout and processing fees
             }
         }
     }
 
-    // internal functions
-
-    function _getBeneficiary(
-        NftId policyNftId,
-        ClaimId claimId
-    )
-        internal
-        returns (address beneficiary)
-    {
-        // TODO check if owner is IPolicyHolder
-        // if so, obtain beneficiary from this contract
-
-        // default beneficiary is policy nft owner
-        beneficiary = getRegistry().ownerOf(policyNftId);
-    }
-
 
     function _verifyCallerWithPolicy(
         NftId policyNftId
@@ -410,6 +497,49 @@ contract ClaimService is
     }
 
 
+    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

@@ -23,14 +23,16 @@ interface IClaimService is
     event LogClaimServiceClaimSubmitted(NftId policyNftId, ClaimId claimId, Amount claimAmount);
     event LogClaimServiceClaimConfirmed(NftId policyNftId, ClaimId claimId, Amount confirmedAmount);
     event LogClaimServiceClaimDeclined(NftId policyNftId, ClaimId claimId);
+    event LogClaimServiceClaimRevoked(NftId policyNftId, ClaimId claimId);
     event LogClaimServiceClaimClosed(NftId policyNftId, ClaimId claimId);
 
     event LogClaimServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount);
-    event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount);
+    event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount, Amount processingFeeAmount);
 
     error ErrorClaimServicePolicyProductMismatch(NftId policyNftId, NftId expectedProduct, NftId actualProduct);
     error ErrorClaimServicePolicyNotOpen(NftId policyNftId);
     error ErrorClaimServiceClaimExceedsSumInsured(NftId policyNftId, Amount sumInsured, Amount payoutsIncludingClaimAmount);
+    error ErrorClaimServiceBeneficiaryIsZero(NftId policyNftId, ClaimId claimId);
     error ErrorClaimsServicePayoutAmountIsZero(NftId policyNftId, PayoutId payoutId);
 
     error ErrorClaimServiceClaimWithOpenPayouts(NftId policyNftId, ClaimId claimId, uint8 openPayouts);
@@ -47,9 +49,6 @@ interface IClaimService is
     ) external returns (ClaimId claimId);
 
 
-    // TODO add claim revoke functionality
-
-
     /// @dev declines the specified claim
     /// function can only be called by product, policy needs to match with calling product
     function decline(
@@ -59,6 +58,14 @@ interface IClaimService is
     ) external;
 
 
+    /// @dev revokes the specified claim
+    /// function can only be called by product, policy needs to match with calling product
+    function revoke(
+        NftId policyNftId, 
+        ClaimId claimId
+    ) external;
+
+
     /// @dev confirms the specified claim and specifies the payout amount
     /// function can only be called by product, policy needs to match with calling product
     function confirm(
@@ -77,7 +84,8 @@ interface IClaimService is
     ) external;
 
 
-    /// @dev creates a new payout for the specified claim
+    /// @dev Creates a new payout for the specified claim.
+    /// The beneficiary is the holder of the policy NFT
     /// returns the id of the newly created payout, this id is unique for the specified policy
     /// function can only be called by product, policy needs to match with calling product
     function createPayout(
@@ -90,6 +98,20 @@ interface IClaimService is
         returns (PayoutId payoutId);
 
 
+    /// @dev Creates a new payout for the specified claim and beneficiary.
+    /// returns the id of the newly created payout, this id is unique for the specified policy
+    /// function can only be called by product, policy needs to match with calling product
+    function createPayoutForBeneficiary(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        external
+        returns (PayoutId payoutId);
+
+
     /// @dev processes the specified payout
     /// this includes moving the payout token to the beneficiary (default: policy holder)
     /// function can only be called by product, policy needs to match with calling product

package/contracts/product/IPolicyService.sol

@@ -10,6 +10,13 @@ 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);
@@ -19,11 +26,11 @@ interface IPolicyService is IService {
     error ErrorPolicyServiceAllowanceInsufficient(address policyOwner, address tokenHandler, uint256 premiumAmount, uint256 allowance);
 
     error ErrorPolicyServiceInsufficientAllowance(address customer, address tokenHandlerAddress, uint256 amount);
-    error ErrorPolicyServicePremiumAlreadyPaid(NftId policyNftId, Amount premiumPaidAmount);
+    error ErrorPolicyServicePremiumAlreadyPaid(NftId policyNftId);
     error ErrorPolicyServicePolicyNotActivated(NftId policyNftId);
     error ErrorPolicyServicePolicyAlreadyClosed(NftId policyNftId);
     error ErrorPolicyServicePolicyNotActive(NftId policyNftId, StateId state);
-    error ErrorPolicyServicePremiumNotFullyPaid(NftId policyNftId, Amount premiumAmount, Amount premiumPaidAmount);
+    error ErrorPolicyServicePremiumNotPaid(NftId policyNftId, Amount premiumAmount);
     error ErrorPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
     error ErrorPolicyServicePolicyHasNotExpired(NftId policyNftId, Timestamp expiredAt);
     error ErrorPolicyServicePolicyExpirationTooLate(NftId policyNftId, Timestamp upperLimit, Timestamp expiredAt);
@@ -32,9 +39,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. 

package/contracts/product/{IProductService.sol → IRiskService.sol}

@@ -12,8 +12,7 @@ import {Timestamp} from "../type/Timestamp.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {Fee} from "../type/Fee.sol";
 
-// TODO consider renaming to IRiskService
-interface IProductService is IService {
+interface IRiskService is IService {
 
     function createRisk(
         RiskId riskId,