@etherisc/gif-next 0.0.2-f034782-101 → 0.0.2-f080b71-868

package/contracts/instance/service/PricingService.sol

@@ -0,0 +1,275 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Seconds} from "../../types/Seconds.sol";
+import {UFixed, UFixedLib} from "../../types/UFixed.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {ReferralId} from "../../types/Referral.sol";
+import {RiskId} from "../../types/RiskId.sol";
+import {PRODUCT, DISTRIBUTION, PRICE} from "../../types/ObjectType.sol";
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+
+import {IProductComponent} from "../../components/IProductComponent.sol";
+
+import {IInstance} from "../IInstance.sol";
+import {InstanceReader} from "../InstanceReader.sol";
+import {IComponents} from "../module/IComponents.sol";
+import {IPolicy} from "../module/IPolicy.sol";
+import {IBundle} from "../module/IBundle.sol";
+import {ISetup} from "../module/ISetup.sol";
+import {IDistribution} from "../module/IDistribution.sol";
+
+import {ComponentService} from "../base/ComponentService.sol";
+
+import {IPricingService} from "./IPricingService.sol";
+import {IDistributionService} from "./IDistributionService.sol";
+
+
+contract PricingService is 
+    ComponentService, 
+    IPricingService
+{
+    using UFixedLib for UFixed;
+
+    IDistributionService internal _distributionService;
+
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        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));
+
+        initializeService(registryAddress, address(0), 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,
+        NftId bundleNftId,
+        RiskId riskId,
+        ReferralId referralId,
+        uint256 sumInsuredAmount,
+        Seconds lifetime,
+        bytes memory applicationData
+    )
+        external
+        view
+        virtual override
+        returns (
+            IPolicy.Premium memory premium
+        )
+    {
+        InstanceReader reader;
+        uint256 netPremiumAmount;
+
+        {
+            // verify product
+            (
+                IRegistry.ObjectInfo memory productInfo, 
+                IInstance instance
+            ) = _getAndVerifyComponentInfoAndInstance(productNftId, PRODUCT());
+
+            reader = instance.getInstanceReader();
+
+            // calculate net premium
+            netPremiumAmount = IProductComponent(productInfo.objectAddress).calculateNetPremium(
+                sumInsuredAmount,
+                riskId,
+                lifetime,
+                applicationData
+            );
+        }
+
+        {
+            // 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));
+
+            IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
+            if(bundleInfo.poolNftId != productSetup.poolNftId) {
+                revert ErrorIPricingServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, productSetup.poolNftId);
+            }
+
+            NftId distributionNftId = productSetup.distributionNftId;
+            ISetup.DistributionSetupInfo memory distSetup = reader.getDistributionSetupInfo(distributionNftId);
+
+            // calculate premium, order is important
+            premium = _getFixedFeeAmounts(
+                netPremiumAmount,
+                productSetup,
+                poolInfo,
+                distSetup,
+                bundleInfo
+            );
+
+            premium = _calculateVariableFeeAmounts(
+                premium,
+                productSetup,
+                poolInfo,
+                distSetup,
+                bundleInfo
+            );
+
+            premium = _calculateFeeAmount(
+                premium,
+                distSetup,
+                referralId,
+                distributionNftId,
+                reader
+            );
+
+            // sanity check to validate the fee calculation
+            if (premium.distributionOwnerFeeFixAmount < distSetup.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(
+        uint256 netPremiumAmount,
+        ISetup.ProductSetupInfo memory productInfo,
+        IComponents.PoolInfo memory poolInfo,
+        ISetup.DistributionSetupInfo memory distInfo,
+        IBundle.BundleInfo memory bundleInfo
+    )
+        internal
+        view
+        returns (
+            IPolicy.Premium memory premium
+        )
+    {
+        // initial premium amount is the net premium
+        premium.netPremiumAmount = netPremiumAmount;
+        premium.fullPremiumAmount = netPremiumAmount;
+
+        uint256 t = productInfo.productFee.fixedFee;
+        premium.productFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = poolInfo.poolFee.fixedFee;
+        premium.poolFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = bundleInfo.fee.fixedFee;
+        premium.bundleFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = distInfo.distributionFee.fixedFee;
+        premium.distributionFeeFixAmount = t;
+        premium.fullPremiumAmount += t;
+    }
+
+    function _calculateVariableFeeAmounts(
+        IPolicy.Premium memory premium,
+        ISetup.ProductSetupInfo memory productInfo,
+        IComponents.PoolInfo memory poolInfo,
+        ISetup.DistributionSetupInfo memory distInfo,
+        IBundle.BundleInfo memory bundleInfo
+    )
+        internal
+        view
+        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 * poolInfo.poolFee.fractionalFee).toInt();
+        premium.poolFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = (netPremiumAmount * bundleInfo.fee.fractionalFee).toInt();
+        premium.bundleFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        t = (netPremiumAmount * distInfo.distributionFee.fractionalFee).toInt();
+        premium.distributionFeeVarAmount = t;
+        premium.fullPremiumAmount += t;
+
+        return premium;
+    }
+
+    function _calculateFeeAmount(
+        IPolicy.Premium memory premium,
+        ISetup.DistributionSetupInfo memory distInfo,
+        ReferralId referralId,
+        NftId distributionNftId,
+        InstanceReader reader
+    )
+        internal
+        view 
+        returns (IPolicy.Premium memory finalPremium)
+    {
+        // if the referral is not valid, then the distribution owner gets everything
+        if (! _distributionService.referralIsValid(distributionNftId, referralId)) {
+            premium.distributionOwnerFeeFixAmount = premium.distributionFeeFixAmount;
+            premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount;
+            premium.premiumAmount = premium.fullPremiumAmount;
+            return premium;
+        }
+
+        Fee memory minDistributionOwnerFee = distInfo.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 = distInfo.minDistributionOwnerFee.fixedFee;
+            premium.distributionOwnerFeeVarAmount = premium.distributionFeeVarAmount - commissionAmount - premium.discountAmount;
+            premium.premiumAmount = premium.fullPremiumAmount - premium.discountAmount;
+        }
+
+        return premium; 
+    }
+}

package/contracts/instance/service/PricingServiceManager.sol

@@ -0,0 +1,51 @@
+// 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 "../../types/ObjectType.sol";
+
+contract PricingServiceManager is ProxyManager {
+
+    PricingService private _pricingService;
+
+    /// @dev initializes proxy manager with distribution service implementation and deploys instance
+    constructor(
+        address registryAddress
+    )
+        ProxyManager(registryAddress)
+    {
+        PricingService pricingSrv = new PricingService();
+        bytes memory data = abi.encode(registryAddress, address(this));
+        IVersionable versionable = deploy(
+            address(pricingSrv), 
+            data);
+
+        _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 ----------------------------------------------------//
+    function getPricingService()
+        external
+        view
+        returns (PricingService getPricingService)
+    {
+        return _pricingService;
+    }
+
+}

package/contracts/instance/service/ProductService.sol

@@ -60,9 +60,9 @@ contract ProductService is ComponentService, IProductService {
         address initialOwner;
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, owner);
+        initializeService(registryAddress, address(0), owner);
 
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getMajorVersion()));
+        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
         registerInterface(type(IProductService).interfaceId);
     }
@@ -111,7 +111,7 @@ contract ProductService is ComponentService, IProductService {
         product.linkToRegisteredNftId();
 
         // create product setup in instance
-        instance.createProductSetup(productNftId, product.getSetupInfo());
+        instance.getInstanceStore().createProductSetup(productNftId, product.getSetupInfo());
 
         bytes4[][] memory selectors = new bytes4[][](1);
         selectors[0] = new bytes4[](1);
@@ -129,7 +129,7 @@ contract ProductService is ComponentService, IProductService {
             roles);
     }
 
-    function getDomain() public pure override(IService, Service) returns(ObjectType) {
+    function getDomain() public pure override returns(ObjectType) {
         return PRODUCT();
     }
 
@@ -147,38 +147,6 @@ contract ProductService is ComponentService, IProductService {
         // if(wallet == address(0)) {
         //     revert WalletIsZero();
         // }
-
-        // IRegistry.ObjectInfo memory tokenInfo = getRegistry().getObjectInfo(address(info.token));
-
-        // if(tokenInfo.objectType != TOKEN()) {
-        //     revert InvalidToken();
-        // } 
-
-        // IRegistry.ObjectInfo memory poolInfo = getRegistry().getObjectInfo(info.poolNftId);
-
-        // if(poolInfo.objectType != POOL()) {
-        //     revert InvalidPool();
-        // }
-
-        // if(poolInfo.parentNftId != instanceNftId) {
-        //     revert InvalidPoolsInstance();
-        // }
-        // // TODO pool have the same token
-        // //ITreasury.PoolSetup memory poolSetup = instance.getPoolSetup(info.poolNftId);
-        // //require(tokenInfo.objectAddress == address(poolSetup.token), "ERROR:COS-018:PRODUCT_POOL_TOKEN_MISMATCH");
-        // // TODO pool is not linked
-
-        // IRegistry.ObjectInfo memory distributionInfo = getRegistry().getObjectInfo(info.distributionNftId);
-
-        // if(distributionInfo.objectType != DISTRIBUTION()) {
-        //     revert  InvalidDistribution();
-        // } 
-
-        // if(distributionInfo.parentNftId != instanceNftId) {
-        //     revert InvalidDistributionsInstance();
-        // }
-        // // TODO distribution have the same token
-        // // TODO distribution is not linked
     }
 
     function setFees(
@@ -189,32 +157,28 @@ contract ProductService is ComponentService, IProductService {
     {
         // TODO check args 
 
-        (
-            IRegistry.ObjectInfo memory productInfo, 
-            IInstance instance
-        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-
+        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
-        NftId productNftId = productInfo.nftId;
+
         ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
 
         productSetupInfo.productFee = productFee;
         productSetupInfo.processingFee = processingFee;
         
-        instance.updateProductSetup(productNftId, productSetupInfo, KEEP_STATE());
+        instance.getInstanceStore().updateProductSetup(productNftId, productSetupInfo, KEEP_STATE());
     }
 
     function createRisk(
         RiskId riskId,
         bytes memory data
-    ) external override {
-        (
-            IRegistry.ObjectInfo memory productInfo, 
-            IInstance instance
-        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        NftId productNftId = productInfo.nftId;
+    )
+        external 
+        override
+    {
+        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
-        instance.createRisk(
+
+        instance.getInstanceStore().createRisk(
             riskId,
             riskInfo
         );
@@ -223,19 +187,24 @@ contract ProductService is ComponentService, IProductService {
     function updateRisk(
         RiskId riskId,
         bytes memory data
-    ) external {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+    )
+        external
+    {
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
+
         IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
         riskInfo.data = data;
-        instance.updateRisk(riskId, riskInfo, KEEP_STATE());
+        instance.getInstanceStore().updateRisk(riskId, riskInfo, KEEP_STATE());
     }
 
     function updateRiskState(
         RiskId riskId,
         StateId state
-    ) external {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instance.updateRiskState(riskId, state);
+    )
+        external
+    {
+        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
+        instance.getInstanceStore().updateRiskState(riskId, state);
     }
 }

package/contracts/registry/IRegistryService.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+// import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
@@ -13,8 +13,9 @@ import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IComponent} from "../components/IComponent.sol";
 
 interface IRegistryService is 
-     IService, 
-     IAccessManaged 
+     IService
+     // TODO cleanup
+     // IAccessManaged 
 {
      error SelfRegistration();
      error NotRegistryOwner();

package/contracts/registry/RegistryService.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+// import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
 import {IRegistry} from "./IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
@@ -19,7 +19,7 @@ import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
 import {Registerable} from "../../contracts/shared/Registerable.sol";
 
 import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
-import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE} from "../../contracts/types/ObjectType.sol";
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE, PRICE} from "../../contracts/types/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
 import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
@@ -31,7 +31,6 @@ import {IRegistryService} from "./IRegistryService.sol";
 import {Registry} from "./Registry.sol";
 
 contract RegistryService is
-    AccessManagedUpgradeable,
     Service,
     IRegistryService
 {
@@ -41,7 +40,7 @@ contract RegistryService is
     bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
 
     // From IService
-    function getDomain() public pure override(IService, Service) returns(ObjectType serviceDomain) {
+    function getDomain() public pure override returns(ObjectType serviceDomain) {
         return REGISTRY(); 
     }
 
@@ -61,9 +60,8 @@ contract RegistryService is
             address initialAuthority
         ) = abi.decode(data, (address, address));
 
-        __AccessManaged_init(initialAuthority);
+        initializeService(registryAddress, initialAuthority, owner);
 
-        initializeService(registryAddress, owner);
         registerInterface(type(IRegistryService).interfaceId);
     }
 
@@ -170,7 +168,7 @@ contract RegistryService is
     }
 
     // from IRegisterable
-
+    // TODO store precalculated addresses, deply with CREATE2
     function getFunctionConfigs()
         external
         pure
@@ -178,7 +176,7 @@ contract RegistryService is
             FunctionConfig[] memory config
         )
     {
-        config = new FunctionConfig[](8);
+        config = new FunctionConfig[](9);
 
         // order of service registrations MUST be reverse to this array 
         /*config[-1].serviceDomain = STAKE();
@@ -194,27 +192,32 @@ contract RegistryService is
         config[2].serviceDomain = CLAIM();
         config[2].selectors = new bytes4[](0);
 
-        config[3].serviceDomain = BUNDLE();
+        config[3].serviceDomain = PRODUCT();
         config[3].selectors = new bytes4[](1);
-        config[3].selectors[0] = RegistryService.registerBundle.selector;
+        config[3].selectors[0] = RegistryService.registerProduct.selector;
 
-        config[4].serviceDomain = PRODUCT();
+        config[4].serviceDomain = POOL();
         config[4].selectors = new bytes4[](1);
-        config[4].selectors[0] = RegistryService.registerProduct.selector;
+        config[4].selectors[0] = RegistryService.registerPool.selector;
 
-        config[5].serviceDomain = POOL();
+        // registration of bundle service must preceed registration of pool service
+        config[5].serviceDomain = BUNDLE();
         config[5].selectors = new bytes4[](1);
-        config[5].selectors[0] = RegistryService.registerPool.selector;
+        config[5].selectors[0] = RegistryService.registerBundle.selector;
+
+        // registration of pricing service must preceed registration of application service
+        config[6].serviceDomain = PRICE();
+        config[6].selectors = new bytes4[](0);
 
-        config[6].serviceDomain = DISTRIBUTION();
-        config[6].selectors = new bytes4[](2);
-        config[6].selectors[0] = RegistryService.registerDistribution.selector;
-        config[6].selectors[1] = RegistryService.registerDistributor.selector;
+        // registration of distribution service must preceed registration of pricing service
+        config[7].serviceDomain = DISTRIBUTION();
+        config[7].selectors = new bytes4[](2);
+        config[7].selectors[0] = RegistryService.registerDistribution.selector;
+        config[7].selectors[1] = RegistryService.registerDistributor.selector;
 
-        // registerInstance() have no restriction
-        config[7].serviceDomain = INSTANCE();
-        config[7].selectors = new bytes4[](1);
-        config[7].selectors[0] = RegistryService.registerInstance.selector;
+        config[8].serviceDomain = INSTANCE();
+        config[8].selectors = new bytes4[](1);
+        config[8].selectors[0] = RegistryService.registerInstance.selector;
     }
 
     // Internal