@etherisc/gif-next 0.0.2-c68eaf3-087 → 0.0.2-c75d1c9-841

package/contracts/product/PolicyServiceLib.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {NftId} from "../type/NftId.sol";
+import {StateId, CLOSED, COLLATERALIZED} from "../type/StateId.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+
+library PolicyServiceLib {
+
+    function activate(
+        NftId policyNftId, 
+        IPolicy.PolicyInfo memory policyInfo,
+        Timestamp activateAt
+    )
+        external
+        pure 
+        returns (IPolicy.PolicyInfo memory)
+    {
+        // fail if policy has already been activated and activateAt is different
+        if(! policyInfo.activatedAt.eqz() && activateAt != policyInfo.activatedAt) {
+            revert IPolicyService.ErrorPolicyServicePolicyAlreadyActivated(policyNftId);
+        }
+
+        // ignore if policy has already been activated and activateAt is the same
+        if (policyInfo.activatedAt == activateAt) {
+            return policyInfo;
+        }
+
+        policyInfo.activatedAt = activateAt;
+        policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+
+        return policyInfo;
+    }
+
+    function expire(
+        InstanceReader instanceReader,
+        NftId policyNftId,
+        IPolicy.PolicyInfo memory policyInfo,
+        Timestamp expireAt
+    )
+        external
+        view
+        returns (IPolicy.PolicyInfo memory)
+    {
+        StateId policyState = instanceReader.getPolicyState(policyNftId);
+
+        checkExpiration(
+            expireAt,
+            policyNftId,
+            policyState,
+            policyInfo);
+
+        // effects
+        // update policyInfo with new expiredAt timestamp
+        if (expireAt.gtz()) {
+            policyInfo.expiredAt = expireAt;
+        } else {
+            policyInfo.expiredAt = TimestampLib.blockTimestamp();
+        }
+
+        return policyInfo;
+    }
+
+    function checkExpiration(
+        Timestamp newExpiredAt,
+        NftId policyNftId,
+        StateId policyState,
+        IPolicy.PolicyInfo memory policyInfo
+    )
+        public 
+        view
+    {
+        if (policyState != COLLATERALIZED()) { 
+            revert IPolicyService.ErrorPolicyServicePolicyNotActive(policyNftId, policyState);
+        } 
+        if (TimestampLib.blockTimestamp() < policyInfo.activatedAt) { 
+            revert IPolicyService.ErrorPolicyServicePolicyNotActive(policyNftId, policyState);
+        } 
+
+        // check expiredAt represents a valid expiry time
+        if (newExpiredAt >= policyInfo.expiredAt) {
+            revert IPolicyService.ErrorPolicyServicePolicyExpirationTooLate(policyNftId, policyInfo.expiredAt, newExpiredAt);
+        }
+
+        if (newExpiredAt.gtz() && newExpiredAt < TimestampLib.blockTimestamp()) {
+            revert IPolicyService.ErrorPolicyServicePolicyExpirationTooEarly(policyNftId, TimestampLib.blockTimestamp(), newExpiredAt);
+        }
+    }
+
+    function policyIsCloseable(InstanceReader instanceReader, NftId policyNftId)
+        external 
+        view
+        returns (bool isCloseable)
+    {
+        // policy already closed
+        if (instanceReader.getPolicyState(policyNftId) == CLOSED()) {
+            return false;
+        }
+
+        IPolicy.PolicyInfo memory info = instanceReader.getPolicyInfo(policyNftId);
+        
+        if (info.productNftId.eqz()) { return false; } // not closeable: policy does not exist (or does not belong to this instance)
+        if (info.activatedAt.eqz()) { return false; } // not closeable: not yet activated
+        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
+
+        // closeable: if sum of claims matches sum insured a policy may be closed prior to the expiry date
+        if (info.claimAmount == info.sumInsuredAmount) { return true; }
+
+        // not closeable: not yet expired
+        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
+
+        // all conditions to close the policy are met
+        return true; 
+    }
+
+}

package/contracts/product/PolicyServiceManager.sol

@@ -17,7 +17,7 @@ contract PolicyServiceManager is ProxyManager {
     ) 
     {
         PolicyService svc = new PolicyService{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/PricingService.sol

@@ -42,14 +42,15 @@ contract PricingService is
         initializer()
     {
         (
-            address registryAddress, 
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
-        _registerInterface(type(IPricingService).interfaceId);
+        __Service_init(authority, registry, owner);
 
         _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
+
+        _registerInterface(type(IPricingService).interfaceId);
     }
 
     /// @dev calculates the premium amount for the specified attributes
@@ -86,6 +87,11 @@ contract PricingService is
             // get instance reader from local instance variable
             reader = instance.getInstanceReader();
 
+            NftId riskProductNftId = reader.getRiskInfo(riskId).productNftId;
+            if (productNftId != riskProductNftId) {
+                revert ErrorPricingServiceRiskProductMismatch(riskId, riskProductNftId, productNftId);
+            }
+
             // calculate net premium
             netPremiumAmount = IProductComponent(registryInfo.objectAddress).calculateNetPremium(
                 sumInsuredAmount,
@@ -98,6 +104,7 @@ contract PricingService is
         {
             // get configurations for all involed objects
             IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+            IComponents.FeeInfo memory feeInfo = reader.getFeeInfo(productNftId);
 
             IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
             if(bundleInfo.poolNftId != productInfo.poolNftId) {
@@ -107,21 +114,22 @@ contract PricingService is
             // calculate fixed fees for product, pool, bundle
             premium = _getFixedFeeAmounts(
                 netPremiumAmount,
-                productInfo,
+                feeInfo,
                 bundleInfo
             );
 
             // calculate variable fees for product, pool, bundle
             premium = _calculateVariableFeeAmounts(
                 premium,
-                productInfo,
+                feeInfo,
                 bundleInfo
             );
 
             // calculate distribution fee and (if applicable) commission
             premium = _calculateDistributionOwnerFeeAmount(
                 premium,
-                productInfo,
+                feeInfo,
+                productInfo.distributionNftId,
                 referralId,
                 reader
             );
@@ -137,7 +145,7 @@ contract PricingService is
                 revert ErrorPricingServiceTargetWalletAmountsMismatch();
             }
 
-            if (premium.distributionOwnerFeeFixAmount.toInt() < productInfo.minDistributionOwnerFee.fixedFee) {
+            if (premium.distributionOwnerFeeFixAmount < feeInfo.minDistributionOwnerFee.fixedFee) {
                 revert ErrorPricingServiceFeeCalculationMismatch( 
                     premium.distributionFeeFixAmount,
                     premium.distributionFeeVarAmount,
@@ -164,7 +172,7 @@ contract PricingService is
     // internal functions
     function _getFixedFeeAmounts(
         Amount netPremiumAmount,
-        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
         IBundle.BundleInfo memory bundleInfo
     )
         internal
@@ -177,26 +185,26 @@ contract PricingService is
         premium.netPremiumAmount = netPremiumAmount;
         premium.fullPremiumAmount = netPremiumAmount;
 
-        Amount t = AmountLib.toAmount(productInfo.productFee.fixedFee);
+        Amount t = feeInfo.productFee.fixedFee;
         premium.productFeeFixAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = AmountLib.toAmount(productInfo.poolFee.fixedFee);
+        t = feeInfo.poolFee.fixedFee;
         premium.poolFeeFixAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = AmountLib.toAmount(bundleInfo.fee.fixedFee);
+        t = bundleInfo.fee.fixedFee;
         premium.bundleFeeFixAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = AmountLib.toAmount(productInfo.distributionFee.fixedFee);
+        t = feeInfo.distributionFee.fixedFee;
         premium.distributionFeeFixAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
     }
 
     function _calculateVariableFeeAmounts(
         IPolicy.PremiumInfo memory premium,
-        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
         IBundle.BundleInfo memory bundleInfo
     )
         internal
@@ -207,11 +215,11 @@ contract PricingService is
     {
         Amount netPremiumAmount = premium.netPremiumAmount;
 
-        Amount t = netPremiumAmount.multiplyWith(productInfo.productFee.fractionalFee);
+        Amount t = netPremiumAmount.multiplyWith(feeInfo.productFee.fractionalFee);
         premium.productFeeVarAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = netPremiumAmount.multiplyWith(productInfo.poolFee.fractionalFee);
+        t = netPremiumAmount.multiplyWith(feeInfo.poolFee.fractionalFee);
         premium.poolFeeVarAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
@@ -219,7 +227,7 @@ contract PricingService is
         premium.bundleFeeVarAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = netPremiumAmount.multiplyWith(productInfo.distributionFee.fractionalFee);
+        t = netPremiumAmount.multiplyWith(feeInfo.distributionFee.fractionalFee);
         premium.distributionFeeVarAmount = t;
         premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
@@ -228,7 +236,8 @@ contract PricingService is
 
     function _calculateDistributionOwnerFeeAmount(
         IPolicy.PremiumInfo memory premium,
-        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
+        NftId distributionNftId,
         // ISetup.DistributionSetupInfo memory distInfo,
         ReferralId referralId,
         InstanceReader reader
@@ -239,14 +248,14 @@ contract PricingService is
     {
 
         // if the referral is not valid, then the distribution owner gets everything
-        if (productInfo.distributionNftId.eqz() || ! _distributionService.referralIsValid(productInfo.distributionNftId, referralId)) {
+        if (distributionNftId.eqz() || ! _distributionService.referralIsValid(distributionNftId, referralId)) {
             premium.distributionOwnerFeeFixAmount = premium.distributionFeeFixAmount;
             premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount;
             premium.premiumAmount = premium.fullPremiumAmount;
             return premium;
         }
 
-        Fee memory minDistributionOwnerFee = productInfo.minDistributionOwnerFee;
+        Fee memory minDistributionOwnerFee = feeInfo.minDistributionOwnerFee;
 
         // if the referral is valid, the the commission and discount are calculated based in the full premium
         // the remaing amount goes to the distribution owner
@@ -258,7 +267,7 @@ contract PricingService is
             Amount commissionAmount = premium.netPremiumAmount.multiplyWith(distributorTypeInfo.commissionPercentage);
             premium.commissionAmount = commissionAmount;
             premium.discountAmount = premium.fullPremiumAmount.multiplyWith(referralInfo.discountPercentage);
-            premium.distributionOwnerFeeFixAmount = AmountLib.toAmount(minDistributionOwnerFee.fixedFee);
+            premium.distributionOwnerFeeFixAmount = minDistributionOwnerFee.fixedFee;
             premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount - commissionAmount - premium.discountAmount;
             premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
         }

package/contracts/product/PricingServiceManager.sol

@@ -12,14 +12,14 @@ contract PricingServiceManager is ProxyManager {
     /// @dev initializes proxy manager with pricing service implementation and deploys instance
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     )
     {
         PricingService pricingSrv = new PricingService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
-            registryAddress,
+            registry,
             address(pricingSrv), 
             data,
             salt);

package/contracts/product/Product.sol

@@ -3,23 +3,20 @@ pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
+import {Fee} from "../type/Fee.sol";
 import {IApplicationService} from "./IApplicationService.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IRiskService} from "./IRiskService.sol";
 import {IClaimService} from "./IClaimService.sol";
 import {IPricingService} from "./IPricingService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT, BUNDLE, APPLICATION, POLICY, CLAIM, PRICE } from "../type/ObjectType.sol";
+import {NftId} from "../type/NftId.sol";
+import {COMPONENT, PRODUCT, BUNDLE, APPLICATION, POLICY, CLAIM, PRICE } from "../type/ObjectType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
-import {COMPONENT, PRODUCT, APPLICATION, POLICY, CLAIM, PRICE, BUNDLE } from "../type/ObjectType.sol";
+import {COMPONENT, PRODUCT, APPLICATION, POLICY, CLAIM, PRICE, BUNDLE, RISK } from "../type/ObjectType.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {RiskId, RiskIdLib} from "../type/RiskId.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -28,9 +25,6 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
-import {IOracleComponent} from "../oracle/IOracleComponent.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
 
 abstract contract Product is
     InstanceLinkedComponent, 
@@ -40,15 +34,14 @@ abstract contract Product is
     bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
 
     struct ProductStorage {
-        bool _isProcessingFundedClaims;
-        bool _hasDistribution;
-        uint8 _numberOfOracles;
+        IComponents.ProductInfo _productInfo;
+        IComponents.FeeInfo _feeInfo;
+        IComponentService _componentService;
         IRiskService _riskService;
         IApplicationService _applicationService;
         IPolicyService _policyService;
         IClaimService _claimService;
         IPricingService _pricingService;
-        IComponentService _componentService;
     }
 
 
@@ -125,38 +118,27 @@ abstract contract Product is
         view 
         returns (IComponents.ProductInfo memory poolInfo)
     {
-        ProductStorage storage $ = _getProductStorage();
+        return _getProductStorage()._productInfo;
+    }
 
-        return IComponents.ProductInfo({
-            isProcessingFundedClaims: false,
-            hasDistribution: $._hasDistribution,
-            expectedNumberOfOracles: $._numberOfOracles,
-            numberOfOracles: 0,
-            poolNftId: NftIdLib.zero(),
-            distributionNftId: NftIdLib.zero(),
-            oracleNftId: new NftId[]($._numberOfOracles),
-            productFee: FeeLib.zero(),
-            processingFee: FeeLib.zero(),
-            distributionFee: FeeLib.zero(),
-            minDistributionOwnerFee: FeeLib.zero(),
-            poolFee: FeeLib.zero(),
-            stakingFee: FeeLib.zero(),
-            performanceFee: FeeLib.zero()
-        });
+    function getInitialFeeInfo()
+        public 
+        virtual 
+        view 
+        returns (IComponents.FeeInfo memory feeInfo)
+    {
+        return _getProductStorage()._feeInfo;
     }
 
 
     function _initializeProduct(
         address registry,
         NftId instanceNftId,
+        string memory name,
+        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token,
-        bool isInterceptor,
-        bool isProcessingFundedClaims,
-        bool hasDistribution,
-        uint8 numberOfOracles,
         bytes memory componentData // writeonly data that will saved in the object info record of the registry
     )
         internal
@@ -167,18 +149,16 @@ abstract contract Product is
             registry, 
             instanceNftId, 
             name, 
-            token, 
             PRODUCT(), 
             authorization, 
-            isInterceptor, 
+            productInfo.isInterceptingPolicyTransfers, 
             initialOwner, 
             componentData);
 
         ProductStorage storage $ = _getProductStorage();
-        $._isProcessingFundedClaims = isProcessingFundedClaims;
-        $._hasDistribution = hasDistribution;
-        $._numberOfOracles = numberOfOracles;
-        $._riskService = IRiskService(_getServiceAddress(PRODUCT())); 
+        $._productInfo = productInfo;
+        $._feeInfo = feeInfo;
+        $._riskService = IRiskService(_getServiceAddress(RISK())); 
         $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
         $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
         $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
@@ -201,13 +181,14 @@ abstract contract Product is
 
 
     function _createRisk(
-        RiskId id,
+        bytes32 id,
         bytes memory data
     )
         internal
         virtual
+        returns (RiskId riskId)
     {
-        _getProductStorage()._riskService.createRisk(
+        return _getProductStorage()._riskService.createRisk(
             id,
             data
         );
@@ -240,11 +221,6 @@ abstract contract Product is
     }
 
 
-    function _getRiskInfo(RiskId id) internal virtual view returns (IRisk.RiskInfo memory info) {
-        return getInstance().getInstanceReader().getRiskInfo(id);
-    }
-
-
     function _createApplication(
         address applicationOwner,
         RiskId riskId,
@@ -277,8 +253,9 @@ abstract contract Product is
     )
         internal
         virtual
+        returns (Amount premiumAmount)
     {
-        _getProductStorage()._policyService.createPolicy(
+        premiumAmount = _getProductStorage()._policyService.createPolicy(
             applicationNftId, 
             activateAt);
     }
@@ -304,6 +281,21 @@ abstract contract Product is
         expiredAt = _getProductStorage()._policyService.expire(policyNftId, expireAt);
     }
 
+    /// @dev adjust the activation date of the policy. 
+    /// The policy must already have an activation date set.
+    /// Allowed values are from the current blocktime to the expiration date of the policy.
+    function _adjustActivation(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.adjustActivation(
+            policyNftId, 
+            activateAt);
+    }
+
     function _collectPremium(
         NftId policyNftId,
         Timestamp activateAt
@@ -353,6 +345,18 @@ abstract contract Product is
             claimData);
     }
 
+    function _revokeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.revoke(
+            policyNftId,
+            claimId);
+    }
+
     function _confirmClaim(
         NftId policyNftId,
         ClaimId claimId,
@@ -443,8 +447,16 @@ abstract contract Product is
             payoutId);
     }
 
-    function _toRiskId(string memory riskName) internal virtual pure returns (RiskId riskId) {
-        return RiskIdLib.toRiskId(riskName);
+    function _cancelPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.cancelPayout(
+            policyNftId,
+            payoutId);
     }
 
     function _getProductStorage() internal virtual pure returns (ProductStorage storage $) {