@etherisc/gif-next 0.0.2-e9c5694-914 → 0.0.2-ea09fbf-195

package/contracts/product/ClaimService.sol

@@ -1,19 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {TimestampLib} from "../type/Timestamp.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";
-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 {InstanceStore} from "../instance/InstanceStore.sol";
 import {IClaimService} from "./IClaimService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
@@ -22,10 +9,25 @@ import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IPolicyService} from "../product/IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
+import {FeeLib} from "../type/Fee.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, COMPONENT, CLAIM, POLICY, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {Service} from "../shared/Service.sol";
+import {StateId} from "../type/StateId.sol";
+import {SUBMITTED, KEEP_STATE, DECLINED, REVOKED, CANCELLED, CONFIRMED, CLOSED, EXPECTED, PAID} from "../type/StateId.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
 
 
 contract ClaimService is 
-    ComponentVerifyingService, 
+    Service, 
     IClaimService
 {
 
@@ -41,11 +43,11 @@ contract ClaimService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         _policyService = IPolicyService(getRegistry().getServiceAddress(POLICY(), getVersion().toMajorPart()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
@@ -61,10 +63,10 @@ contract ClaimService is
         external
         virtual
         // nonReentrant() // prevents creating a reinsurance claim in a single tx
+        restricted()
         returns (ClaimId claimId)
     {
-        _checkNftType(policyNftId, POLICY());
-
+        // checks
         (
             ,
             IInstance instance,,
@@ -77,15 +79,9 @@ 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(
-                policyNftId, 
-                policyInfo.sumInsuredAmount,
-                AmountLib.toAmount(policyInfo.payoutAmount.toInt() + claimAmount.toInt()));
-        }
+        _checkClaimAmount(policyNftId, policyInfo, claimAmount);
 
+        // effects
         // create new claim
         claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
         instanceStore.createClaim(
@@ -120,6 +116,7 @@ contract ClaimService is
         virtual
         // nonReentrant() // prevents creating a reinsurance claim in a single tx
     {
+        // checks
         _checkNftType(policyNftId, POLICY());
 
         (
@@ -130,8 +127,9 @@ contract ClaimService is
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
-        // TODO add check for confirmedAmount > 0 and does not lead to exceeding sum insured
+        _checkClaimAmount(policyNftId, policyInfo, confirmedAmount);
 
+        // effects
         // check/update claim info
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
         claimInfo.claimAmount = confirmedAmount;
@@ -149,6 +147,7 @@ contract ClaimService is
 
         emit LogClaimServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
 
+        // interactions
         // callback to pool if applicable
         _processConfirmedClaimByPool(instanceReader, productNftId, policyNftId, claimId, confirmedAmount);
 
@@ -190,7 +189,6 @@ contract ClaimService is
     }
 
 
-    // TODO add test case
     function revoke(
         NftId policyNftId, 
         ClaimId claimId
@@ -198,9 +196,7 @@ contract ClaimService is
         external
         virtual
         // nonReentrant() // prevents creating a reinsurance claim in a single tx
-    {
-        _checkNftType(policyNftId, POLICY());
-        
+    {        
         (
             ,
             IInstance instance,
@@ -277,8 +273,6 @@ contract ClaimService is
         // nonReentrant() // prevents creating a reinsurance claim in a single tx
         returns (PayoutId payoutId)
     {
-        _checkNftType(policyNftId, POLICY());
-        
         if (beneficiary == address(0)) {
             revert ErrorClaimServiceBeneficiaryIsZero(policyNftId, claimId);
         }
@@ -322,8 +316,7 @@ contract ClaimService is
         virtual
         // nonReentrant() // prevents creating a reinsurance payout in a single tx
     {
-        _checkNftType(policyNftId, POLICY());
-        
+        // checks
         (
             ,
             IInstance instance,
@@ -332,9 +325,24 @@ contract ClaimService is
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
-        // TODO add check that payout exists and is open
+        // check that payout exists and is open
         IPolicy.PayoutInfo memory payoutInfo = instanceReader.getPayoutInfo(policyNftId, payoutId);
+        StateId payoutState = instanceReader.getPayoutState(policyNftId, payoutId);
+        if(payoutState != EXPECTED()) {
+            revert ErrorClaimServicePayoutNotExpected(policyNftId, payoutId, payoutState);
+        }
+
+        // check that payout amount does not violate claim amount
+        IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, payoutId.toClaimId());
+        if(claimInfo.paidAmount + payoutInfo.amount > claimInfo.claimAmount) {
+            revert ErrorClaimServicePayoutExceedsClaimAmount(
+                policyNftId, 
+                payoutId.toClaimId(), 
+                claimInfo.claimAmount, 
+                claimInfo.paidAmount + payoutInfo.amount);
+        }
 
+        // effects
         // update and save payout info with instance
         payoutInfo.paidAt = TimestampLib.blockTimestamp();
         instanceStore.updatePayout(policyNftId, payoutId, payoutInfo, PAID());
@@ -360,7 +368,7 @@ contract ClaimService is
         }
 
         // update and save policy info with instance
-        policyInfo.payoutAmount = policyInfo.payoutAmount.add(payoutAmount);
+        policyInfo.payoutAmount = policyInfo.payoutAmount + payoutAmount;
         instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         // inform pool about payout
@@ -388,7 +396,9 @@ contract ClaimService is
             {
                 NftId poolNftId = getRegistry().getObjectInfo(policyInfo.bundleNftId).parentNftId;
                 IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
-                poolInfo.tokenHandler.distributeTokens(poolInfo.wallet, beneficiary, netPayoutAmount);
+                poolInfo.tokenHandler.pushToken(
+                    beneficiary, 
+                    netPayoutAmount);
 
                 // TODO add 2nd token tx if processingFeeAmount > 0
             }
@@ -398,8 +408,64 @@ contract ClaimService is
         }
     }
 
+    function cancelPayout(
+        NftId policyNftId, 
+        PayoutId payoutId
+    )
+        external
+        virtual
+    {
+        // checks
+        (
+            ,
+            IInstance instance,
+            InstanceReader instanceReader,
+            InstanceStore instanceStore,
+            IPolicy.PolicyInfo memory policyInfo
+        ) = _verifyCallerWithPolicy(policyNftId);
+
+        StateId payoutState = instanceReader.getPayoutState(policyNftId, payoutId);
+        if (payoutState != EXPECTED()) {
+            revert ErrorClaimServicePayoutNotExpected(policyNftId, payoutId, payoutState);
+        }
+
+        // effects
+        // update and save payout info with instance
+        instanceStore.updatePayoutState(policyNftId, payoutId, CANCELLED());
+
+        {
+            ClaimId claimId = payoutId.toClaimId();
+            IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
+            claimInfo.openPayoutsCount -= 1;
+            instanceStore.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+        }
+
+        emit LogClaimServicePayoutCancelled(policyNftId, payoutId);
+    }
+
     // internal functions
 
+    function _checkClaimAmount(
+        NftId policyNftId,
+        IPolicy.PolicyInfo memory policyInfo,
+        Amount claimAmount
+    )
+        internal
+        pure
+    {
+        // check claim amount > 0
+        if (claimAmount.eqz()) {
+            revert ErrorClaimServiceClaimAmountIsZero(policyNftId);
+        }
+
+        // check policy including this claim is still within sum insured
+        if(policyInfo.claimAmount + claimAmount > policyInfo.sumInsuredAmount) {
+            revert ErrorClaimServiceClaimExceedsSumInsured(
+                policyNftId, 
+                policyInfo.sumInsuredAmount,
+                policyInfo.payoutAmount + claimAmount);
+        }
+    }
 
     function _createPayout(
         NftId policyNftId, 
@@ -412,6 +478,7 @@ contract ClaimService is
         virtual
         returns (PayoutId payoutId)
     {
+        // checks
         (
             ,
             ,
@@ -421,13 +488,23 @@ contract ClaimService is
         ) = _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 claim state
+            StateId claimState = instanceReader.getClaimState(policyNftId, claimId);
+            if (claimState != CONFIRMED()) {
+                revert ErrorClaimServiceClaimNotConfirmed(policyNftId, claimId, claimState);
+            }
+
+            // check total payout amount remains within claim limit
+            Amount newPaidAmount = claimInfo.paidAmount + amount;
+            if (newPaidAmount > claimInfo.claimAmount) {
+                revert ErrorClaimServicePayoutExceedsClaimAmount(
+                    policyNftId, claimId, claimInfo.claimAmount, newPaidAmount);
+            }
+        }
 
-        // check/update claim info
+        // effects
         // create payout info with instance
         uint24 payoutNo = claimInfo.payoutsCount + 1;
         payoutId = PayoutIdLib.toPayoutId(claimId, payoutNo);
@@ -450,10 +527,6 @@ contract ClaimService is
         claimInfo.openPayoutsCount += 1;
         instanceStore.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
 
-        // update and save policy info with instance
-        policyInfo.payoutAmount.add(amount);
-        instanceStore.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
-
         emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount, beneficiary);
     }
 
@@ -465,6 +538,7 @@ contract ClaimService is
         IPolicy.PayoutInfo memory payoutInfo
     )
         internal
+        view
         returns (
             Amount netPayoutAmount,
             Amount processingFeeAmount,
@@ -488,8 +562,8 @@ contract ClaimService is
                 beneficiary = payoutInfo.beneficiary;
             }
 
-            IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
-            if(FeeLib.gtz(productInfo.processingFee)) {
+            IComponents.FeeInfo memory feeInfo = instanceReader.getFeeInfo(productNftId);
+            if(FeeLib.gtz(feeInfo.processingFee)) {
                 // TODO calculate and set net payout and processing fees
             }
         }
@@ -510,7 +584,7 @@ contract ClaimService is
             IPolicy.PolicyInfo memory policyInfo
         )
     {
-        (productNftId,, instance) = _getAndVerifyActiveComponent(PRODUCT());
+        (productNftId, instance) = _getAndVerifyActiveComponent(PRODUCT());
         instanceReader = instance.getInstanceReader();
         instanceStore = instance.getInstanceStore();
 
@@ -523,6 +597,28 @@ contract ClaimService is
         }
     }
 
+    function _getAndVerifyActiveComponent(ObjectType expectedType) 
+        internal 
+        view 
+        returns (
+            NftId productNftId,
+            IInstance instance
+        )
+    {
+        (
+            IRegistry.ObjectInfo memory info,
+            address instanceAddress
+        ) = ContractLib.getAndVerifyComponent(
+            getRegistry(),
+            msg.sender, // caller
+            PRODUCT(),
+            true); // isActive 
+
+        // get component nft id and instance
+        productNftId = info.nftId;
+        instance = IInstance(instanceAddress);
+    }
+
     function _verifyClaim(
         InstanceReader instanceReader,
         NftId policyNftId, 

package/contracts/product/ClaimServiceManager.sol

@@ -17,7 +17,7 @@ contract ClaimServiceManager is ProxyManager {
     ) 
     {
         ClaimService svc = new ClaimService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/product/IApplicationService.sol

@@ -15,8 +15,11 @@ import {Seconds} from "../type/Seconds.sol";
 /// only product components may call transaction functions
 interface IApplicationService is IService {
     
-    error ErrorApplicationServiceNotProduct(NftId callerNftId, ObjectType callerType);
-    error ErrorApplicationServiceBundlePoolMismatch(NftId bundleNftId, NftId bundlePoolNftId, NftId poolNftId);
+    // _checkLinkedApplicationParameters
+    error ErrorApplicationServiceRiskUnknown(RiskId riskId, NftId productNftId);
+    error ErrorApplicationServiceRiskPaused(RiskId riskId, NftId productNftId);
+    error ErrorApplicationServiceBundleUnknown(NftId bundleNftId, NftId poolNftId);
+    error ErrorApplicationServiceBundleLocked(NftId bundleNftId, NftId poolNftId);
 
     /// @dev creates a new application based on the specified attributes
     /// may only be called by a product component

package/contracts/product/IClaimService.sol

@@ -28,10 +28,13 @@ interface IClaimService is
 
     event LogClaimServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary);
     event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount, Amount processingFeeAmount);
+    event LogClaimServicePayoutCancelled(NftId policyNftId, PayoutId payoutId);
+
     error ErrorClaimServiceBeneficiarySet(NftId policyNftId, PayoutId payoutId, address beneficiary);
 
     error ErrorClaimServicePolicyProductMismatch(NftId policyNftId, NftId expectedProduct, NftId actualProduct);
     error ErrorClaimServicePolicyNotOpen(NftId policyNftId);
+    error ErrorClaimServiceClaimAmountIsZero(NftId policyNftId);
     error ErrorClaimServiceClaimExceedsSumInsured(NftId policyNftId, Amount sumInsured, Amount payoutsIncludingClaimAmount);
     error ErrorClaimServiceBeneficiaryIsZero(NftId policyNftId, ClaimId claimId);
     error ErrorClaimsServicePayoutAmountIsZero(NftId policyNftId, PayoutId payoutId);
@@ -40,6 +43,10 @@ interface IClaimService is
     error ErrorClaimServiceClaimWithMissingPayouts(NftId policyNftId, ClaimId claimId, Amount claimAmount, Amount paidAmount);
     error ErrorClaimServiceClaimNotInExpectedState(NftId policyNftId, ClaimId claimId, StateId expectedState, StateId actualState);
 
+    error ErrorClaimServiceClaimNotConfirmed(NftId policyNftId, ClaimId claimId, StateId actualState);
+    error ErrorClaimServicePayoutExceedsClaimAmount(NftId policyNftId, ClaimId claimId, Amount claimAmount, Amount totalPayoutAmount);
+    error ErrorClaimServicePayoutNotExpected(NftId policyNftId, PayoutId payoutId, StateId actualState);
+
     /// @dev create a new claim for the specified policy
     /// returns the id of the newly created claim
     /// function can only be called by product, policy needs to match with calling product
@@ -120,4 +127,10 @@ interface IClaimService is
         NftId policyNftId, 
         PayoutId payoutId
     ) external;
+
+    /// @dev cancels the specified payout. no tokens are moved, payout is set to cancelled. 
+    function cancelPayout(
+        NftId policyNftId, 
+        PayoutId payoutId
+    ) external;
 }

package/contracts/product/IPolicyService.sol

@@ -5,6 +5,7 @@ import {IService} from "../shared/IService.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {IInstance} from "../instance/IInstance.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {NftId} from "../type/NftId.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -28,8 +29,9 @@ interface IPolicyService is IService {
 
     error ErrorPolicyServiceInsufficientAllowance(address customer, address tokenHandlerAddress, uint256 amount);
     error ErrorPolicyServicePremiumAlreadyPaid(NftId policyNftId);
-    error ErrorPolicyServicePolicyNotActivated(NftId policyNftId);
-    error ErrorPolicyServicePolicyAlreadyClosed(NftId policyNftId);
+
+    error ErrorPolicyServicePolicyNotCloseable(NftId policyNftId);
+
     error ErrorPolicyServicePolicyNotActive(NftId policyNftId, StateId state);
     error ErrorPolicyServicePremiumNotPaid(NftId policyNftId, Amount premiumAmount);
     error ErrorPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
@@ -49,7 +51,9 @@ interface IPolicyService is IService {
     function createPolicy(
         NftId applicationNftId,
         Timestamp activateAt
-    ) external;
+    )
+        external
+        returns (Amount premiumAmount);
 
     /// @dev declines an application represented by {policyNftId}
     /// an application can only be declined in applied state
@@ -63,18 +67,24 @@ interface IPolicyService is IService {
     /// to activate a policy it needs to be in underwritten state
     function activate(NftId policyNftId, Timestamp activateAt) external;
 
-    /// @dev expires the specified policy and sets the expiry date in the policy metadata. If expiry date is set to 0, then the earliest possible expiry date (current blocktime) is set
+    /// @dev Expires the specified policy and sets the expiry date in the policy metadata. 
+    /// Function consumers are products.
+    /// If expiry date is set to 0, then the earliest possible expiry date (current blocktime) is set
     /// to expire a policy it must be in active state, policies may be expired even when the predefined expiry date is still in the future
     /// 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
     /// @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
+    /// @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
     function close(NftId policyNftId) external;
 
+    /// @dev Expires the specified policy and sets the expiry date in the policy metadata. 
+    /// Function consumers is claim service.
+    function expirePolicy(IInstance instance, NftId policyNftId, Timestamp expireAt) external returns (Timestamp expiredAt);
+
+    /// @dev Returns true iff policy is closeable
+    function policyIsCloseable(InstanceReader instanceReader, NftId policyNftId) external view returns (bool isCloseable);
 }

package/contracts/product/IProductComponent.sol

@@ -53,7 +53,10 @@ interface IProductComponent is
     ) external view returns (Amount netPremiumAmount);    
 
 
-    /// @dev returns initial pool specific infos for this pool
+    /// @dev returns initial product specific infos 
     function getInitialProductInfo() external view returns (IComponents.ProductInfo memory info);
+
+    /// @dev returns initial fee infos
+    function getInitialFeeInfo() external view returns (IComponents.FeeInfo memory info);
     
 }