@etherisc/gif-next 0.0.2-f398177-971 → 0.0.2-f3b4c66-505

package/contracts/instance/service/PricingService.sol

@@ -1,275 +0,0 @@
-// 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 {Amount} from "../../types/Amount.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,
-        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 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 = _calculateDistributionOwnerFeeAmount(
-                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(
-        Amount 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.toInt();
-        premium.fullPremiumAmount = netPremiumAmount.toInt();
-
-        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 _calculateDistributionOwnerFeeAmount(
-        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

@@ -1,51 +0,0 @@
-// 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)
-    {
-        return _pricingService;
-    }
-
-}

package/contracts/instance/service/ProductService.sol

@@ -1,210 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {Product} from "../../components/Product.sol";
-import {IComponent} from "../../components/IComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IInstance} from "../IInstance.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IRisk} from "../module/IRisk.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IProductService} from "./IProductService.sol";
-import {ITreasury} from "../module/ITreasury.sol";
-import {ISetup} from "../module/ISetup.sol";
-
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {Timestamp, zeroTimestamp} from "../../types/Timestamp.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {ObjectType, PRODUCT, POOL, POLICY} from "../../types/ObjectType.sol";
-import {APPLIED, ACTIVE, KEEP_STATE} from "../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-import {StateId} from "../../types/StateId.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {RoleId, PRODUCT_OWNER_ROLE} from "../../types/RoleId.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {ComponentService} from "../base/ComponentService.sol";
-import {IProductService} from "./IProductService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IPoolService} from "./PoolService.sol";
-
-// TODO or name this ProtectionService to have Product be something more generic (loan, savings account, ...)
-contract ProductService is ComponentService, IProductService {
-    using NftIdLib for NftId;
-
-    IPoolService internal _poolService;
-
-    event LogProductServiceSender(address sender);
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-
-        initializeService(registryAddress, address(0), owner);
-
-        _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
-
-        registerInterface(type(IProductService).interfaceId);
-    }
-
-
-    function register(address productAddress) 
-        external
-        returns(NftId productNftId)
-    {
-        (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        ) = _checkComponentForRegistration(
-            productAddress,
-            PRODUCT(),
-            PRODUCT_OWNER_ROLE());
-
-        IProductComponent product = IProductComponent(productAddress);
-        IRegistry.ObjectInfo memory productInfo = getRegistryService().registerProduct(product, owner);
-        productNftId = productInfo.nftId;
-        _createProductSetup(
-            instance, 
-            product, 
-            productNftId);
-    }
-
-
-    function _createProductSetup(
-        IInstance instance, 
-        IProductComponent product, 
-        NftId productNftId 
-    )
-        internal
-        returns (string memory name)
-    {
-        // wire distribution and pool components to product component
-        ISetup.ProductSetupInfo memory setup = product.getSetupInfo();
-        IComponent distribution = IComponent(getRegistry().getObjectInfo(setup.distributionNftId).objectAddress);
-        IComponent pool = IComponent(getRegistry().getObjectInfo(setup.poolNftId).objectAddress);
-
-        distribution.setProductNftId(productNftId);
-        pool.setProductNftId(productNftId);
-        product.setProductNftId(productNftId);
-        product.linkToRegisteredNftId();
-
-        // create product setup in instance
-        instance.getInstanceStore().createProductSetup(productNftId, product.getSetupInfo());
-
-        bytes4[][] memory selectors = new bytes4[][](1);
-        selectors[0] = new bytes4[](1);
-        selectors[0][0] = IProductComponent.setFees.selector;
-
-        RoleId[] memory roles = new RoleId[](1);
-        roles[0] = PRODUCT_OWNER_ROLE();
-
-        // create target for instane access manager
-        getInstanceService().createGifTarget(
-            getRegistry().getNftId(address(instance)), 
-            address(product), 
-            product.getName(),
-            selectors,
-            roles);
-    }
-
-    function getDomain() public pure override returns(ObjectType) {
-        return PRODUCT();
-    }
-
-
-    function _decodeAndVerifyProductData(bytes memory data) 
-        internal 
-        returns(string memory name, ISetup.ProductSetupInfo memory setup)
-    {
-        (name, setup) = abi.decode(
-            data,
-            (string, ISetup.ProductSetupInfo)
-        );
-
-        // TODO add checks
-        // if(wallet == address(0)) {
-        //     revert WalletIsZero();
-        // }
-    }
-
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    )
-        external
-    {
-        // TODO check args 
-
-        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-
-        productSetupInfo.productFee = productFee;
-        productSetupInfo.processingFee = processingFee;
-        
-        instance.getInstanceStore().updateProductSetup(productNftId, productSetupInfo, KEEP_STATE());
-    }
-
-    function createRisk(
-        RiskId riskId,
-        bytes memory data
-    )
-        external 
-        override
-    {
-        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
-        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
-
-        instance.getInstanceStore().createRisk(
-            riskId,
-            riskInfo
-        );
-    }
-
-    function updateRisk(
-        RiskId riskId,
-        bytes memory data
-    )
-        external
-    {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
-        riskInfo.data = data;
-        instance.getInstanceStore().updateRisk(riskId, riskInfo, KEEP_STATE());
-    }
-
-    function updateRiskState(
-        RiskId riskId,
-        StateId state
-    )
-        external
-    {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
-        instance.getInstanceStore().updateRiskState(riskId, state);
-    }
-}

package/contracts/instance/service/ProductServiceManager.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
-import {ProductService} from "./ProductService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {VersionLib} from "../../types/Version.sol";
-
-contract ProductServiceManager is ProxyManager {
-
-    ProductService private _productService;
-
-    /// @dev initializes proxy manager with product service implementation 
-    constructor(
-        address registryAddress
-    )
-        ProxyManager(registryAddress)
-    {
-        ProductService svc = new ProductService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(svc), 
-            data);
-
-        _productService = ProductService(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 ----------------------------------------------------//
-    function getProductService()
-        external
-        view
-        returns (ProductService productService)
-    {
-        return _productService;
-    }
-
-}