@etherisc/gif-next 0.0.2-ceb30b2-601 → 0.0.2-cf22d7b-845

package/contracts/product/PricingService.sol

@@ -0,0 +1,301 @@
+// SPDX-License-Identifier: Apache-2.0
+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";
+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 {IRegistry} from "../registry/IRegistry.sol";
+
+import {IProductComponent} from "./IProductComponent.sol";
+
+import {IInstance} from "../instance/IInstance.sol";
+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 {IDistribution} from "../instance/module/IDistribution.sol";
+
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+
+import {IPricingService} from "./IPricingService.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+
+
+contract PricingService is 
+    ComponentVerifyingService, 
+    IPricingService
+{
+    using UFixedLib for UFixed;
+
+    IDistributionService internal _distributionService;
+
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer()
+    {
+        (
+            address registryAddress,, 
+            //address managerAddress
+            address authority
+        ) = abi.decode(data, (address, address, address));
+
+        initializeService(registryAddress, authority, owner);
+        registerInterface(type(IPricingService).interfaceId);
+
+        _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
+    }
+
+
+    function getDomain() public pure override returns(ObjectType) {
+        return PRICE();
+    }
+
+    /// @dev calculates the premium amount for the specified attributes
+    /// also returns the various fee components involved with creating a policy
+    function calculatePremium(
+        NftId productNftId,
+        RiskId riskId,
+        Amount sumInsuredAmount,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        external
+        view
+        virtual override
+        returns (
+            IPolicy.Premium memory premium
+        )
+    {
+        InstanceReader reader;
+        Amount netPremiumAmount;
+
+        {
+            // verify product
+            (
+                IRegistry.ObjectInfo memory registryInfo, 
+                IInstance instance
+            ) = _getAndVerifyComponentInfo(productNftId, PRODUCT());
+
+            reader = instance.getInstanceReader();
+
+            // calculate net premium
+            netPremiumAmount = IProductComponent(registryInfo.objectAddress).calculateNetPremium(
+                sumInsuredAmount,
+                riskId,
+                lifetime,
+                applicationData
+            );
+        }
+
+        {
+            // get configurations for all involed objects
+            IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+
+            IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
+            if(bundleInfo.poolNftId != productInfo.poolNftId) {
+                revert ErrorIPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productInfo.poolNftId);
+            }
+
+            // calculate premium, order is important
+            premium = _getFixedFeeAmounts(
+                netPremiumAmount,
+                productInfo,
+                bundleInfo
+            );
+
+            premium = _calculateVariableFeeAmounts(
+                premium,
+                productInfo,
+                bundleInfo
+            );
+
+            premium = _calculateDistributionOwnerFeeAmount(
+                premium,
+                productInfo,
+                referralId,
+                reader
+            );
+
+            premium = _calculateTargetWalletAmounts(premium);
+
+            // sanity check to validate the fee calculation
+            if(AmountLib.toAmount(premium.premiumAmount) != 
+                premium.productFeeAmount 
+                + premium.distributionFeeAndCommissionAmount 
+                + premium.poolPremiumAndFeeAmount)
+            {
+                revert ErrorPricingServiceTargetWalletAmountsMismatch();
+            }
+
+            if (premium.distributionOwnerFeeFixAmount < productInfo.minDistributionOwnerFee.fixedFee) {
+                revert ErrorIPricingServiceFeeCalculationMismatch( 
+                    premium.distributionFeeFixAmount,
+                    premium.distributionFeeVarAmount,
+                    premium.distributionOwnerFeeFixAmount,
+                    premium.distributionOwnerFeeVarAmount,
+                    premium.commissionAmount,
+                    premium.discountAmount
+                );
+            }
+
+            if ((premium.distributionFeeVarAmount) != (premium.discountAmount + premium.distributionOwnerFeeVarAmount + premium.commissionAmount)) {
+                revert ErrorIPricingServiceFeeCalculationMismatch(
+                    premium.distributionFeeFixAmount,
+                    premium.distributionFeeVarAmount,
+                    premium.distributionOwnerFeeFixAmount,
+                    premium.distributionOwnerFeeVarAmount,
+                    premium.commissionAmount,
+                    premium.discountAmount
+                );
+            }
+        }
+    }
+
+    // internal functions
+    function _getFixedFeeAmounts(
+        Amount netPremiumAmount,
+        IComponents.ProductInfo memory productInfo,
+        IBundle.BundleInfo memory bundleInfo
+    )
+        internal
+        pure
+        returns (
+            IPolicy.Premium memory premium
+        )
+    {
+        // initial premium amount is the net premium
+        premium.netPremiumAmount = netPremiumAmount.toInt();
+        premium.fullPremiumAmount = netPremiumAmount.toInt();
+
+        uint256 t = productInfo.productFee.fixedFee;
+        premium.productFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = productInfo.poolFee.fixedFee;
+        premium.poolFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = bundleInfo.fee.fixedFee;
+        premium.bundleFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = productInfo.distributionFee.fixedFee;
+        premium.distributionFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+    }
+
+    function _calculateVariableFeeAmounts(
+        IPolicy.Premium memory premium,
+        IComponents.ProductInfo memory productInfo,
+        IBundle.BundleInfo memory bundleInfo
+    )
+        internal
+        pure
+        returns (
+            IPolicy.Premium memory intermadiatePremium
+        )
+    {
+        UFixed netPremiumAmount = UFixedLib.toUFixed(premium.netPremiumAmount);
+
+        uint256 t = (netPremiumAmount * productInfo.productFee.fractionalFee).toInt();
+        premium.productFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = (netPremiumAmount * productInfo.poolFee.fractionalFee).toInt();
+        premium.poolFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = (netPremiumAmount * bundleInfo.fee.fractionalFee).toInt();
+        premium.bundleFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = (netPremiumAmount * productInfo.distributionFee.fractionalFee).toInt();
+        premium.distributionFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        return premium;
+    }
+
+    function _calculateDistributionOwnerFeeAmount(
+        IPolicy.Premium memory premium,
+        IComponents.ProductInfo memory productInfo,
+        // ISetup.DistributionSetupInfo memory distInfo,
+        ReferralId referralId,
+        InstanceReader reader
+    )
+        internal
+        view 
+        returns (IPolicy.Premium memory finalPremium)
+    {
+
+        // if the referral is not valid, then the distribution owner gets everything
+        if (! _distributionService.referralIsValid(productInfo.distributionNftId, referralId)) {
+            premium.distributionOwnerFeeFixAmount = premium.distributionFeeFixAmount;
+            premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount;
+            premium.premiumAmount = premium.fullPremiumAmount;
+            return premium;
+        }
+
+        Fee memory minDistributionOwnerFee = productInfo.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
+        {
+            IDistribution.ReferralInfo memory referralInfo = reader.getReferralInfo(referralId);
+            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();
+            premium.commissionAmount = commissionAmount;
+            premium.discountAmount = UFixedLib.toUFixed(premium.fullPremiumAmount).mul(referralInfo.discountPercentage).toInt();
+            premium.distributionOwnerFeeFixAmount = minDistributionOwnerFee.fixedFee;
+            premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount - commissionAmount - premium.discountAmount;
+            premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
+        }
+
+        return premium; 
+    }
+
+
+    function _calculateTargetWalletAmounts(
+        IPolicy.Premium memory premium
+    )
+        internal
+        virtual
+        view
+        returns (
+            IPolicy.Premium memory premiumWithTargetWalletAmounts
+        )
+    {
+        // fees for product owner
+        premium.productFeeAmount = AmountLib.toAmount(
+            premium.productFeeFixAmount + premium.productFeeVarAmount);
+
+        // fees for distribution owner + distributor commission
+        premium.distributionFeeAndCommissionAmount = AmountLib.toAmount(
+            premium.distributionFeeFixAmount + premium.distributionOwnerFeeVarAmount 
+            + premium.commissionAmount);
+
+        // net premium + fees for pool owner + bundle owner
+        premium.poolPremiumAndFeeAmount = AmountLib.toAmount(
+            premium.netPremiumAmount 
+            + premium.poolFeeFixAmount + premium.poolFeeVarAmount 
+            + premium.bundleFeeFixAmount + premium.bundleFeeVarAmount);
+
+        premiumWithTargetWalletAmounts = premium;
+    }
+
+}

package/contracts/product/PricingServiceManager.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../shared/IVersionable.sol";
+import {ProxyManager} from "../shared/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 pricing service implementation and deploys instance
+    constructor(
+        address authority, 
+        address registryAddress,
+        bytes32 salt
+    )
+        ProxyManager(registryAddress)
+    {
+        PricingService pricingSrv = new PricingService{salt: salt}();
+        bytes memory data = abi.encode(registryAddress, address(this), authority);
+        IVersionable versionable = deployDetermenistic(
+            address(pricingSrv), 
+            data,
+            salt);
+
+        _pricingService = PricingService(address(versionable));
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getPricingService()
+        external
+        view
+        returns (PricingService)
+    {
+        return _pricingService;
+    }
+
+}

package/contracts/{components → product}/Product.sol

@@ -1,38 +1,39 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {Amount} from "../types/Amount.sol";
-import {ClaimId} from "../types/ClaimId.sol";
-import {Component} from "./Component.sol";
-import {Fee} from "../types/Fee.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
-import {IApplicationService} from "../instance/service/IApplicationService.sol";
-import {IPolicyService} from "../instance/service/IPolicyService.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IClaimService} from "../instance/service/IClaimService.sol";
+import {IApplicationService} from "./IApplicationService.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IPolicyService} from "./IPolicyService.sol";
+import {IProductService} from "./IProductService.sol";
+import {IClaimService} from "./IClaimService.sol";
+import {IPricingService} from "./IPricingService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
-import {NftId, NftIdLib} from "../types/NftId.sol";
-import {PayoutId} from "../types/PayoutId.sol";
-import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
-import {ReferralId} from "../types/Referral.sol";
-import {RiskId, RiskIdLib} from "../types/RiskId.sol";
-import {Seconds} from "../types/Seconds.sol";
-import {StateId} from "../types/StateId.sol";
-import {Timestamp} from "../types/Timestamp.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {COMPONENT, PRODUCT, APPLICATION, POLICY, CLAIM, PRICE } from "../type/ObjectType.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {RiskId, RiskIdLib} from "../type/RiskId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {StateId} from "../type/StateId.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {Pool} from "../components/Pool.sol";
-import {Distribution} from "../components/Distribution.sol";
+import {Pool} from "../pool/Pool.sol";
+import {Distribution} from "../distribution/Distribution.sol";
 
 abstract contract Product is
-    Component, 
+    InstanceLinkedComponent, 
     IProductComponent
 {
     // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Product")) - 1)) & ~bytes32(uint256(0xff));
@@ -43,33 +44,31 @@ abstract contract Product is
         IApplicationService _applicationService;
         IPolicyService _policyService;
         IClaimService _claimService;
-        Pool _pool;
-        Distribution _distribution;
-        Fee _initialProductFee;
-        Fee _initialProcessingFee;
-        TokenHandler _tokenHandler;
+        IPricingService _pricingService;
+        IComponentService _componentService;
         NftId _poolNftId;
         NftId _distributionNftId;
+        Pool _pool;
+        Distribution _distribution;
     }
 
     function initializeProduct(
         address registry,
         NftId instanceNftId,
+        address initialOwner,
         string memory name,
         address token,
         bool isInterceptor,
         address pool,
         address distribution,
-        Fee memory productFee,
-        Fee memory processingFee,
-        address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
+        bytes memory componentData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
         onlyInitializing()
     {
-        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, registryData);
+        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, registryData, componentData);
 
         ProductStorage storage $ = _getProductStorage();
         // TODO add validation
@@ -78,18 +77,26 @@ abstract contract Product is
         $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
         $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
         $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
+        $._pricingService = IPricingService(_getServiceAddress(PRICE()));
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
         $._pool = Pool(pool);
         $._distribution = Distribution(distribution);
-        $._initialProductFee = productFee;
-        $._initialProcessingFee = processingFee;  
-        $._tokenHandler = new TokenHandler(token);
         $._poolNftId = getRegistry().getNftId(pool);
         $._distributionNftId = getRegistry().getNftId(distribution);
 
         registerInterface(type(IProductComponent).interfaceId);  
     }
 
-    // from product component
+
+    function register()
+        external
+        virtual
+        onlyOwner()
+    {
+        _getProductStorage()._componentService.registerProduct();
+    }
+
+
     function setFees(
         Fee memory productFee,
         Fee memory processingFee
@@ -99,7 +106,7 @@ abstract contract Product is
         restricted()
         override
     {
-        _getProductService().setFees(productFee, processingFee);
+        _getProductStorage()._componentService.setProductFees(productFee, processingFee);
     }
 
     function _createRisk(
@@ -139,7 +146,7 @@ abstract contract Product is
     function _createApplication(
         address applicationOwner,
         RiskId riskId,
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
@@ -220,25 +227,29 @@ abstract contract Product is
     function _confirmClaim(
         NftId policyNftId,
         ClaimId claimId,
-        Amount confirmedAmount
+        Amount confirmedAmount,
+        bytes memory data
     )
         internal
     {
         _getProductStorage()._claimService.confirm(
             policyNftId,
             claimId,
-            confirmedAmount);
+            confirmedAmount,
+            data);
     }
 
     function _declineClaim(
         NftId policyNftId,
-        ClaimId claimId
+        ClaimId claimId,
+        bytes memory data
     )
         internal
     {
         _getProductStorage()._claimService.decline(
             policyNftId,
-            claimId);
+            claimId,
+            data);
     }
 
     function _closeClaim(
@@ -280,7 +291,7 @@ abstract contract Product is
     }
 
     function calculatePremium(
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         RiskId riskId,
         Seconds lifetime,
         bytes memory applicationData,
@@ -290,9 +301,9 @@ abstract contract Product is
         external 
         view 
         override 
-        returns (uint256 premiumAmount)
+        returns (Amount premiumAmount)
     {
-        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
+        IPolicy.Premium memory premium = _getProductStorage()._pricingService.calculatePremium(
             getNftId(),
             riskId,
             sumInsuredAmount,
@@ -301,11 +312,12 @@ abstract contract Product is
             bundleNftId,
             referralId
         );
-        premiumAmount = premium.premiumAmount;
+
+        return AmountLib.toAmount(premium.premiumAmount);
     }
 
     function calculateNetPremium(
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         RiskId riskId,
         Seconds lifetime,
         bytes memory applicationData
@@ -313,14 +325,32 @@ abstract contract Product is
         external
         view
         virtual override
-        returns (uint256 netPremiumAmount)
+        returns (Amount netPremiumAmount)
     {
         // default 10% of sum insured
-        return sumInsuredAmount / 10;
+        return AmountLib.toAmount(sumInsuredAmount.toInt() / 10);
     }
 
-    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
-        return RiskIdLib.toRiskId(riskName);
+
+    function getInitialProductInfo()
+        public 
+        virtual 
+        view 
+        returns (IComponents.ProductInfo memory poolInfo)
+    {
+        ProductStorage storage $ = _getProductStorage();
+
+        return IComponents.ProductInfo({
+            distributionNftId: $._distributionNftId,
+            poolNftId: $._poolNftId,
+            productFee: FeeLib.zero(),
+            processingFee: FeeLib.zero(),
+            distributionFee: FeeLib.zero(),
+            minDistributionOwnerFee: FeeLib.zero(),
+            poolFee: FeeLib.zero(),
+            stakingFee: FeeLib.zero(),
+            performanceFee: FeeLib.zero()
+        });
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
@@ -331,32 +361,8 @@ abstract contract Product is
         return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
-    function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
-        InstanceReader reader = getInstance().getInstanceReader();
-        setupInfo = reader.getProductSetupInfo(getNftId());
-
-        // fallback to initial setup info (wallet is always != address(0))
-        if(setupInfo.wallet == address(0)) {
-            setupInfo = _getInitialSetupInfo();
-        }
-    }
-
-    function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
-        ProductStorage storage $ = _getProductStorage();
-
-        ISetup.DistributionSetupInfo memory distributionSetupInfo = $._distribution.getSetupInfo();
-        IComponents.PoolInfo memory poolInfo = $._pool.getPoolInfo();
-
-        return ISetup.ProductSetupInfo(
-            getToken(),
-            $._tokenHandler,
-            $._distributionNftId,
-            $._poolNftId,
-            $._initialProductFee,
-            $._initialProcessingFee,
-            false,
-            getWallet()
-        );
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
     }
 
     function _getProductStorage() private pure returns (ProductStorage storage $) {
@@ -368,4 +374,4 @@ abstract contract Product is
     function _getProductService() internal view returns (IProductService) {
         return _getProductStorage()._productService;
     }
-}
+}