@etherisc/gif-next 0.0.2-93a7619-595 → 0.0.2-93ee1cf-782

package/contracts/product/BasicProductAuthorization.sol

@@ -36,7 +36,6 @@ contract BasicProductAuthorization
           // authorize public role (open access to any account, only allows to lock target)
           functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
           _authorize(functions, BasicProduct.setFees.selector, "setFees");
-
           _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
      }
 }

package/contracts/product/ClaimService.sol

@@ -4,7 +4,7 @@ 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 {SUBMITTED, KEEP_STATE, DECLINED, REVOKED, CANCELLED, 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";
@@ -13,6 +13,7 @@ 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";
@@ -62,10 +63,12 @@ contract ClaimService is
         // 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);
 
@@ -85,7 +88,7 @@ contract ClaimService is
 
         // create new claim
         claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
-        instance.getInstanceStore().createClaim(
+        instanceStore.createClaim(
             policyNftId, 
             claimId, 
             IPolicy.ClaimInfo({
@@ -98,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);
     }
@@ -117,10 +120,13 @@ contract ClaimService is
         virtual
         // 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);
 
@@ -130,11 +136,11 @@ 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());
+        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) {
@@ -160,10 +166,13 @@ contract ClaimService is
         virtual
         // 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);
 
@@ -171,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);
     }
@@ -190,21 +199,24 @@ contract ClaimService is
         virtual
         // 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);
     }
@@ -218,10 +230,13 @@ contract ClaimService is
         virtual
         // 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);
 
@@ -246,7 +261,7 @@ contract ClaimService is
         }
 
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
     }
 
 
@@ -262,6 +277,8 @@ 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);
         }
@@ -286,6 +303,8 @@ contract ClaimService is
         // nonReentrant() // prevents creating a reinsurance payout in a single tx
         returns (PayoutId payoutId)
     {
+        _checkNftType(policyNftId, POLICY());
+        
         return _createPayout(
             policyNftId, 
             claimId, 
@@ -303,10 +322,13 @@ contract ClaimService is
         virtual
         // 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);
 
@@ -315,28 +337,31 @@ 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.processPayout(
@@ -347,33 +372,66 @@ contract ClaimService is
             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.pushToken(
+                    beneficiary, 
+                    netPayoutAmount);
+
+                // TODO add 2nd token tx if processingFeeAmount > 0
+            }
+
+            // callback to policy holder if applicable
+            _policyHolderPayoutExecuted(policyNftId, payoutId, beneficiary, payoutAmount);
+        }
+    }
+
+    function cancelPayout(
+        NftId policyNftId, 
+        PayoutId payoutId
+    )
+        external
+        virtual
+    {
+        _checkNftType(policyNftId, POLICY());
+        
         (
-            Amount netPayoutAmount,
-            Amount processingFeeAmount,
-            address beneficiary
-        ) = _calculatePayoutAmount(
-            instanceReader,
-            policyNftId,
-            policyInfo,
-            payoutInfo);
+            ,
+            IInstance instance,
+            InstanceReader instanceReader,
+            InstanceStore instanceStore,
+            IPolicy.PolicyInfo memory policyInfo
+        ) = _verifyCallerWithPolicy(policyNftId);
 
-        emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount, processingFeeAmount);
+        // update and save payout info with instance
+        instanceStore.updatePayoutState(policyNftId, payoutId, CANCELLED());
 
         {
-            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
+            ClaimId claimId = payoutId.toClaimId();
+            IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
+            claimInfo.openPayoutsCount -= 1;
+            instanceStore.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
         }
 
-        // callback to policy holder if applicable
-        _policyHolderPayoutExecuted(policyNftId, payoutId, beneficiary, payoutAmount);
+        emit LogClaimServicePayoutCancelled(policyNftId, payoutId);
     }
 
     // internal functions
 
-
     function _createPayout(
         NftId policyNftId, 
         ClaimId claimId,
@@ -387,13 +445,14 @@ contract ClaimService is
     {
         (
             ,
-            IInstance instance,
+            ,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
         IPolicy.ClaimInfo memory claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
-        StateId claimState = instanceReader.getClaimState(policyNftId, claimId);
+        // StateId claimState = instanceReader.getClaimState(policyNftId, claimId);
 
         // TODO add checks
         // claim needs to be open
@@ -406,7 +465,8 @@ contract ClaimService is
         if (beneficiary == address(0)) {
             beneficiary = getRegistry().ownerOf(policyNftId);
         }
-        instance.getInstanceStore().createPayout(
+
+        instanceStore.createPayout(
             policyNftId, 
             payoutId, 
             IPolicy.PayoutInfo({
@@ -419,11 +479,11 @@ 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, beneficiary);
     }
@@ -477,11 +537,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);

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,6 +28,7 @@ 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);
@@ -120,4 +121,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/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

@@ -6,6 +6,7 @@ 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";
@@ -14,6 +15,11 @@ 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.