@etherisc/gif-next 0.0.2-ff282a4-523 → 0.0.2-ffa91a6-022

package/contracts/product/PolicyServiceLib.sol

@@ -0,0 +1,65 @@
+// 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 checkExpiration(
+        Timestamp newExpiredAt,
+        NftId policyNftId,
+        StateId policyState,
+        IPolicy.PolicyInfo memory policyInfo
+    )
+        external 
+        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

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {PolicyService} from "./PolicyService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {VersionLib} from "../type/Version.sol";
 
 contract PolicyServiceManager is ProxyManager {
 
@@ -14,32 +11,20 @@ contract PolicyServiceManager is ProxyManager {
 
     /// @dev initializes proxy manager with product service implementation 
     constructor(
-        address registryAddress
-    )
-        ProxyManager(registryAddress)
+        address authority, 
+        address registry,
+        bytes32 salt
+    ) 
     {
-        PolicyService svc = new PolicyService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
+        PolicyService svc = new PolicyService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
-            data);
+            data,
+            salt);
 
         _policyService = PolicyService(address(versionable));
-
-        // Registry registry = Registry(registryAddress);
-        // address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
-        // RegistryService registryService = RegistryService(registryServiceAddress);
-        // TODO this must have a role or own nft to register service
-        //registryService.registerService(_productService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_productService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        // _isDeployed = true;
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/product/PricingService.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
+import {Amount, AmountLib} from "../type/Amount.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 import {ObjectType} from "../type/ObjectType.sol";
@@ -8,8 +9,7 @@ import {NftId} from "../type/NftId.sol";
 import {Fee} from "../type/Fee.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {PRODUCT, DISTRIBUTION, PRICE} from "../type/ObjectType.sol";
-import {Amount} from "../type/Amount.sol";
+import {PRODUCT, BUNDLE, DISTRIBUTION, PRICE} from "../type/ObjectType.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IProductComponent} from "./IProductComponent.sol";
@@ -19,24 +19,20 @@ import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
 
-import {ComponentService} from "../shared/ComponentService.sol";
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 
 import {IPricingService} from "./IPricingService.sol";
 import {IDistributionService} from "../distribution/IDistributionService.sol";
 
 
 contract PricingService is 
-    ComponentService, 
+    ComponentVerifyingService, 
     IPricingService
 {
-    using UFixedLib for UFixed;
-
     IDistributionService internal _distributionService;
 
-
     function _initialize(
         address owner, 
         bytes memory data
@@ -45,20 +41,16 @@ contract PricingService is
         virtual override
         initializer()
     {
-        // TODO check this, might no longer be the way, refactor if necessary
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, address(0), owner);
-        registerInterface(type(IPricingService).interfaceId);
+        __Service_init(authority, registry, owner);
 
         _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
-    }
 
-
-    function getDomain() public pure override returns(ObjectType) {
-        return PRICE();
+        _registerInterface(type(IPricingService).interfaceId);
     }
 
     /// @dev calculates the premium amount for the specified attributes
@@ -76,23 +68,32 @@ contract PricingService is
         view
         virtual override
         returns (
-            IPolicy.Premium memory premium
+            IPolicy.PremiumInfo memory premium
         )
     {
+        _checkNftType(productNftId, PRODUCT());
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceReader reader;
         Amount netPremiumAmount;
 
         {
             // verify product
             (
-                IRegistry.ObjectInfo memory productInfo, 
+                IRegistry.ObjectInfo memory registryInfo, 
                 IInstance instance
-            ) = _getAndVerifyComponentInfoAndInstance(productNftId, PRODUCT());
+            ) = _getAndVerifyComponentInfo(productNftId, PRODUCT(), false);
 
+            // 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(productInfo.objectAddress).calculateNetPremium(
+            netPremiumAmount = IProductComponent(registryInfo.objectAddress).calculateNetPremium(
                 sumInsuredAmount,
                 riskId,
                 lifetime,
@@ -102,47 +103,50 @@ contract PricingService is
 
         {
             // get configurations for all involed objects
-            ISetup.ProductSetupInfo memory productSetup = reader.getProductSetupInfo(productNftId);
-
-            bytes memory componentData = reader.getComponentInfo(productSetup.poolNftId).data;
-            IComponents.PoolInfo memory poolInfo = abi.decode(componentData, (IComponents.PoolInfo));
+            IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+            IComponents.FeeInfo memory feeInfo = reader.getFeeInfo(productNftId);
 
             IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
-            if(bundleInfo.poolNftId != productSetup.poolNftId) {
-                revert ErrorIPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productSetup.poolNftId);
+            if(bundleInfo.poolNftId != productInfo.poolNftId) {
+                revert ErrorPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productInfo.poolNftId);
             }
 
-            NftId distributionNftId = productSetup.distributionNftId;
-            ISetup.DistributionSetupInfo memory distSetup = reader.getDistributionSetupInfo(distributionNftId);
-
-            // calculate premium, order is important
+            // calculate fixed fees for product, pool, bundle
             premium = _getFixedFeeAmounts(
                 netPremiumAmount,
-                productSetup,
-                poolInfo,
-                distSetup,
+                feeInfo,
                 bundleInfo
             );
 
+            // calculate variable fees for product, pool, bundle
             premium = _calculateVariableFeeAmounts(
                 premium,
-                productSetup,
-                poolInfo,
-                distSetup,
+                feeInfo,
                 bundleInfo
             );
 
+            // calculate distribution fee and (if applicable) commission
             premium = _calculateDistributionOwnerFeeAmount(
                 premium,
-                distSetup,
+                feeInfo,
+                productInfo.distributionNftId,
                 referralId,
-                distributionNftId,
                 reader
             );
 
+            // calculate resulting amounts for product, pool, and distribution wallets
+            premium = _calculateTargetWalletAmounts(premium);
+
             // sanity check to validate the fee calculation
-            if (premium.distributionOwnerFeeFixAmount < distSetup.minDistributionOwnerFee.fixedFee) {
-                revert ErrorIPricingServiceFeeCalculationMismatch( 
+            if(premium.premiumAmount != premium.productFeeAmount 
+                + premium.distributionFeeAndCommissionAmount 
+                + premium.poolPremiumAndFeeAmount)
+            {
+                revert ErrorPricingServiceTargetWalletAmountsMismatch();
+            }
+
+            if (premium.distributionOwnerFeeFixAmount.toInt() < feeInfo.minDistributionOwnerFee.fixedFee) {
+                revert ErrorPricingServiceFeeCalculationMismatch( 
                     premium.distributionFeeFixAmount,
                     premium.distributionFeeVarAmount,
                     premium.distributionOwnerFeeFixAmount,
@@ -153,7 +157,7 @@ contract PricingService is
             }
 
             if ((premium.distributionFeeVarAmount) != (premium.discountAmount + premium.distributionOwnerFeeVarAmount + premium.commissionAmount)) {
-                revert ErrorIPricingServiceFeeCalculationMismatch(
+                revert ErrorPricingServiceFeeCalculationMismatch(
                     premium.distributionFeeFixAmount,
                     premium.distributionFeeVarAmount,
                     premium.distributionOwnerFeeFixAmount,
@@ -168,92 +172,90 @@ contract PricingService is
     // internal functions
     function _getFixedFeeAmounts(
         Amount netPremiumAmount,
-        ISetup.ProductSetupInfo memory productInfo,
-        IComponents.PoolInfo memory poolInfo,
-        ISetup.DistributionSetupInfo memory distInfo,
+        IComponents.FeeInfo memory feeInfo,
         IBundle.BundleInfo memory bundleInfo
     )
         internal
-        view
+        pure
         returns (
-            IPolicy.Premium memory premium
+            IPolicy.PremiumInfo memory premium
         )
     {
         // initial premium amount is the net premium
-        premium.netPremiumAmount = netPremiumAmount.toInt();
-        premium.fullPremiumAmount = netPremiumAmount.toInt();
+        premium.netPremiumAmount = netPremiumAmount;
+        premium.fullPremiumAmount = netPremiumAmount;
 
-        uint256 t = productInfo.productFee.fixedFee;
+        Amount t = AmountLib.toAmount(feeInfo.productFee.fixedFee);
         premium.productFeeFixAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = poolInfo.poolFee.fixedFee;
+        t = AmountLib.toAmount(feeInfo.poolFee.fixedFee);
         premium.poolFeeFixAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = bundleInfo.fee.fixedFee;
+        t = AmountLib.toAmount(bundleInfo.fee.fixedFee);
         premium.bundleFeeFixAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = distInfo.distributionFee.fixedFee;
+        t = AmountLib.toAmount(feeInfo.distributionFee.fixedFee);
         premium.distributionFeeFixAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
     }
 
     function _calculateVariableFeeAmounts(
-        IPolicy.Premium memory premium,
-        ISetup.ProductSetupInfo memory productInfo,
-        IComponents.PoolInfo memory poolInfo,
-        ISetup.DistributionSetupInfo memory distInfo,
+        IPolicy.PremiumInfo memory premium,
+        IComponents.FeeInfo memory feeInfo,
         IBundle.BundleInfo memory bundleInfo
     )
         internal
-        view
+        pure
         returns (
-            IPolicy.Premium memory intermadiatePremium
+            IPolicy.PremiumInfo memory intermadiatePremium
         )
     {
-        UFixed netPremiumAmount = UFixedLib.toUFixed(premium.netPremiumAmount);
+        Amount netPremiumAmount = premium.netPremiumAmount;
 
-        uint256 t = (netPremiumAmount * productInfo.productFee.fractionalFee).toInt();
+        Amount t = netPremiumAmount.multiplyWith(feeInfo.productFee.fractionalFee);
         premium.productFeeVarAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = (netPremiumAmount * poolInfo.poolFee.fractionalFee).toInt();
+        t = netPremiumAmount.multiplyWith(feeInfo.poolFee.fractionalFee);
         premium.poolFeeVarAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = (netPremiumAmount * bundleInfo.fee.fractionalFee).toInt();
+        t = netPremiumAmount.multiplyWith(bundleInfo.fee.fractionalFee);
         premium.bundleFeeVarAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
-        t = (netPremiumAmount * distInfo.distributionFee.fractionalFee).toInt();
+        t = netPremiumAmount.multiplyWith(feeInfo.distributionFee.fractionalFee);
         premium.distributionFeeVarAmount = t;
-        premium.fullPremiumAmount += t;
+        premium.fullPremiumAmount = premium.fullPremiumAmount + t;
 
         return premium;
     }
 
     function _calculateDistributionOwnerFeeAmount(
-        IPolicy.Premium memory premium,
-        ISetup.DistributionSetupInfo memory distInfo,
-        ReferralId referralId,
+        IPolicy.PremiumInfo memory premium,
+        IComponents.FeeInfo memory feeInfo,
         NftId distributionNftId,
+        // ISetup.DistributionSetupInfo memory distInfo,
+        ReferralId referralId,
         InstanceReader reader
     )
         internal
         view 
-        returns (IPolicy.Premium memory finalPremium)
+        returns (IPolicy.PremiumInfo memory finalPremium)
     {
+
         // if the referral is not valid, then the distribution owner gets everything
-        if (! _distributionService.referralIsValid(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 = distInfo.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
@@ -262,14 +264,46 @@ contract PricingService is
             IDistribution.DistributorInfo memory distributorInfo = reader.getDistributorInfo(referralInfo.distributorNftId);
             IDistribution.DistributorTypeInfo memory distributorTypeInfo = reader.getDistributorTypeInfo(distributorInfo.distributorType);
 
-            uint256 commissionAmount = UFixedLib.toUFixed(premium.netPremiumAmount).mul(distributorTypeInfo.commissionPercentage).toInt();
+            Amount commissionAmount = premium.netPremiumAmount.multiplyWith(distributorTypeInfo.commissionPercentage);
             premium.commissionAmount = commissionAmount;
-            premium.discountAmount = UFixedLib.toUFixed(premium.fullPremiumAmount).mul(referralInfo.discountPercentage).toInt();
-            premium.distributionOwnerFeeFixAmount = distInfo.minDistributionOwnerFee.fixedFee;
+            premium.discountAmount = premium.fullPremiumAmount.multiplyWith(referralInfo.discountPercentage);
+            premium.distributionOwnerFeeFixAmount = AmountLib.toAmount(minDistributionOwnerFee.fixedFee);
             premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount - commissionAmount - premium.discountAmount;
             premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
         }
 
         return premium; 
     }
+
+
+    function _calculateTargetWalletAmounts(
+        IPolicy.PremiumInfo memory premium
+    )
+        internal
+        virtual
+        view
+        returns (
+            IPolicy.PremiumInfo memory premiumWithTargetWalletAmounts
+        )
+    {
+        // fees for product owner
+        premium.productFeeAmount = premium.productFeeFixAmount + premium.productFeeVarAmount;
+
+        // fees for distribution owner + distributor commission
+        premium.distributionFeeAndCommissionAmount = 
+            premium.distributionFeeFixAmount + premium.distributionOwnerFeeVarAmount 
+            + premium.commissionAmount;
+
+        // net premium + fees for pool owner + bundle owner
+        premium.poolPremiumAndFeeAmount = premium.netPremiumAmount 
+            + premium.poolFeeFixAmount + premium.poolFeeVarAmount 
+            + premium.bundleFeeFixAmount + premium.bundleFeeVarAmount;
+
+        premiumWithTargetWalletAmounts = premium;
+    }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return PRICE();
+    }
 }

package/contracts/product/PricingServiceManager.sol

@@ -1,42 +1,30 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {PricingService} from "./PricingService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract PricingServiceManager is ProxyManager {
 
     PricingService private _pricingService;
 
-    /// @dev initializes proxy manager with distribution service implementation and deploys instance
+    /// @dev initializes proxy manager with pricing service implementation and deploys instance
     constructor(
-        address registryAddress
+        address authority, 
+        address registry,
+        bytes32 salt
     )
-        ProxyManager(registryAddress)
     {
-        PricingService pricingSrv = new PricingService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
+        PricingService pricingSrv = new PricingService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
             address(pricingSrv), 
-            data);
+            data,
+            salt);
 
         _pricingService = PricingService(address(versionable));
-        
-        // TODO `thi` must have a role or own nft to register service
-        //Registry registry = Registry(registryAddress);
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _distributionService.getMajorVersion());
-        //RegistryService registryService = RegistryService(registryServiceAddress);
-        //registryService.registerService(_distributionService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_distributionService));
     }
 
     //--- view functions ----------------------------------------------------//