@etherisc/gif-next 0.0.2-abde86b-349 → 0.0.2-acc7efa-771

package/contracts/product/BasicProduct.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Fee} from "../type/Fee.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 import {NftId} from "../type/NftId.sol";
 import {Product} from "../product/Product.sol";
 
@@ -25,13 +26,11 @@ abstract contract BasicProduct is
     function _initializeBasicProduct(
         address registry,
         NftId instanceNftId,
-        IAuthorization authorization,
-        address initialOwner,
         string memory name,
         address token,
-        bool isInterceptor,
-        address pool,
-        address distribution
+        IComponents.ProductInfo memory productInfo,
+        IAuthorization authorization,
+        address initialOwner
     )
         internal
         virtual
@@ -40,14 +39,11 @@ abstract contract BasicProduct is
         _initializeProduct(
             registry, 
             instanceNftId, 
-            authorization, 
-            initialOwner, 
             name, 
             token, 
-            isInterceptor, 
-            pool,
-            distribution,
-            "", //registryData, 
-            ""); // componentData
+            productInfo,
+            authorization, 
+            initialOwner, 
+            ""); // component data
     }
 }

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

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 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";
@@ -13,12 +13,14 @@ 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";
 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";
 
 
@@ -27,6 +29,7 @@ contract ClaimService is
     IClaimService
 {
 
+    IPolicyService internal _policyService;
     IPoolService internal _poolService;
 
     function _initialize(
@@ -44,6 +47,7 @@ contract ClaimService is
 
         _initializeService(registryAddress, authority, owner);
 
+        _policyService = IPolicyService(getRegistry().getServiceAddress(POLICY(), getVersion().toMajorPart()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
         _registerInterface(type(IClaimService).interfaceId);
@@ -61,8 +65,8 @@ contract ClaimService is
     {
         (
             ,
-            IInstance instance,
-            InstanceReader instanceReader,
+            IInstance instance,,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -82,7 +86,7 @@ contract ClaimService is
 
         // create new claim
         claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
-        instance.getInstanceStore().createClaim(
+        instanceStore.createClaim(
             policyNftId, 
             claimId, 
             IPolicy.ClaimInfo({
@@ -95,10 +99,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);
     }
@@ -118,6 +122,7 @@ contract ClaimService is
             NftId productNftId,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -127,14 +132,16 @@ 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());
-
-        // TODO test if claim results in total claim amount == sum insured amount
-        // should policy still be active it needs to automatically become expired
+        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) {
+            _policyService.expirePolicy(instance, policyNftId, TimestampLib.blockTimestamp());
+        }
 
         emit LogClaimServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
 
@@ -159,6 +166,7 @@ contract ClaimService is
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -166,11 +174,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);
     }
@@ -189,17 +197,18 @@ contract ClaimService is
             ,
             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);
     }
@@ -217,6 +226,7 @@ contract ClaimService is
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -241,7 +251,7 @@ contract ClaimService is
         }
 
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+        instanceStore.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
     }
 
 
@@ -302,6 +312,7 @@ contract ClaimService is
             ,
             IInstance instance,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -310,7 +321,7 @@ 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;
@@ -321,26 +332,26 @@ 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();
-            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+            claimInfo.closedAt = TimestampLib.blockTimestamp();
+            instanceStore.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
 
             policyInfo.openClaimsCount -= 1;
         } else {
-            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+            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.reduceCollateral(
+        _poolService.processPayout(
             instance, 
             address(instanceReader.getComponentInfo(policyInfo.productNftId).token),
             policyNftId, 
             policyInfo, 
             payoutAmount);
-
+        
         // transfer payout token and fee
         (
             Amount netPayoutAmount,
@@ -382,8 +393,9 @@ contract ClaimService is
     {
         (
             ,
-            IInstance instance,
+            ,
             InstanceReader instanceReader,
+            InstanceStore instanceStore,
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
@@ -398,7 +410,11 @@ contract ClaimService is
         // create payout info with instance
         uint24 payoutNo = claimInfo.payoutsCount + 1;
         payoutId = PayoutIdLib.toPayoutId(claimId, payoutNo);
-        instance.getInstanceStore().createPayout(
+        if (beneficiary == address(0)) {
+            beneficiary = getRegistry().ownerOf(policyNftId);
+        }
+
+        instanceStore.createPayout(
             policyNftId, 
             payoutId, 
             IPolicy.PayoutInfo({
@@ -411,13 +427,13 @@ 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);
+        emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount, beneficiary);
     }
 
 
@@ -469,11 +485,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/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);

package/contracts/product/IPolicyService.sol

@@ -4,6 +4,7 @@ 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";
@@ -69,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/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.

package/contracts/product/PolicyService.sol

@@ -38,9 +38,6 @@ contract PolicyService is
     ComponentVerifyingService, 
     IPolicyService
 {
-    using NftIdLib for NftId;
-    using TimestampLib for Timestamp;
-
     IApplicationService internal _applicationService;
     IComponentService internal _componentService;
     IBundleService internal _bundleService;
@@ -178,9 +175,12 @@ contract PolicyService is
         // update referral counter 
         {
             IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
-            _distributionService.processReferral(
-                productInfo.distributionNftId, 
-                applicationInfo.referralId);
+
+            if (! productInfo.distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product    
+                _distributionService.processReferral(
+                    productInfo.distributionNftId, 
+                    applicationInfo.referralId);
+            }
         }
 
         // log policy creation before interactions with token and policy holder
@@ -274,10 +274,9 @@ contract PolicyService is
         returns (Timestamp expiredAt)
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
+        
         // check policy matches with calling product
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if(policyInfo.productNftId != productNftId) {
             revert ErrorPolicyServicePolicyProductMismatch(
                 policyNftId, 
@@ -285,8 +284,44 @@ contract PolicyService is
                 productNftId);
         }
 
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    /// @inheritdoc IPolicyService
+    function expirePolicy(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        external
+        virtual
+        nonReentrant()
+        returns (Timestamp expiredAt)
+    {
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    function _expire(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        internal
+        returns (Timestamp expiredAt)
+    {
+        InstanceReader instanceReader = instance.getInstanceReader();
+        
         // check policy is active
         StateId policyState = instanceReader.getPolicyState(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if (!_policyHasBeenActivated(policyState, policyInfo)) {
             revert ErrorPolicyServicePolicyNotActive(policyNftId, policyState);
         }
@@ -453,10 +488,12 @@ contract PolicyService is
             premium.productFeeVarAmount + premium.productFeeFixAmount);
 
         // update distribution fees and distributor commission and pool fees 
-        _distributionService.processSale(
-            distributionNftId, 
-            referralId, 
-            premium);
+        if (!distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product
+            _distributionService.processSale(
+                distributionNftId, 
+                referralId, 
+                premium);
+        }
 
         // update pool and bundle fees 
         _poolService.processSale(

package/contracts/product/PricingService.sol

@@ -31,11 +31,8 @@ contract PricingService is
     ComponentVerifyingService, 
     IPricingService
 {
-    using UFixedLib for UFixed;
-
     IDistributionService internal _distributionService;
 
-
     function _initialize(
         address owner, 
         bytes memory data
@@ -101,7 +98,7 @@ contract PricingService is
 
             IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
             if(bundleInfo.poolNftId != productInfo.poolNftId) {
-                revert ErrorIPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productInfo.poolNftId);
+                revert ErrorPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productInfo.poolNftId);
             }
 
             // calculate fixed fees for product, pool, bundle
@@ -138,7 +135,7 @@ contract PricingService is
             }
 
             if (premium.distributionOwnerFeeFixAmount.toInt() < productInfo.minDistributionOwnerFee.fixedFee) {
-                revert ErrorIPricingServiceFeeCalculationMismatch( 
+                revert ErrorPricingServiceFeeCalculationMismatch( 
                     premium.distributionFeeFixAmount,
                     premium.distributionFeeVarAmount,
                     premium.distributionOwnerFeeFixAmount,
@@ -149,7 +146,7 @@ contract PricingService is
             }
 
             if ((premium.distributionFeeVarAmount) != (premium.discountAmount + premium.distributionOwnerFeeVarAmount + premium.commissionAmount)) {
-                revert ErrorIPricingServiceFeeCalculationMismatch(
+                revert ErrorPricingServiceFeeCalculationMismatch(
                     premium.distributionFeeFixAmount,
                     premium.distributionFeeVarAmount,
                     premium.distributionOwnerFeeFixAmount,
@@ -239,7 +236,7 @@ contract PricingService is
     {
 
         // if the referral is not valid, then the distribution owner gets everything
-        if (! _distributionService.referralIsValid(productInfo.distributionNftId, referralId)) {
+        if (productInfo.distributionNftId.eqz() || ! _distributionService.referralIsValid(productInfo.distributionNftId, referralId)) {
             premium.distributionOwnerFeeFixAmount = premium.distributionFeeFixAmount;
             premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount;
             premium.premiumAmount = premium.fullPremiumAmount;