@etherisc/gif-next 0.0.2-8d47fa1-080 → 0.0.2-90f8ffc-398

package/contracts/instance/service/ProductService.sol

@@ -3,507 +3,231 @@ 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 "../../instance/IInstance.sol";
-import {IPolicy, IPolicyModule} from "../module/policy/IPolicy.sol";
-import {IPool} from "../module/pool/IPoolModule.sol";
-import {IRisk} from "../module/risk/IRisk.sol";
-import {IBundle} from "../module/bundle/IBundle.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, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.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, UFixedMathLib} from "../../types/UFixed.sol";
+import {UFixed, UFixedLib} from "../../types/UFixed.sol";
 import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {ObjectType, INSTANCE, PRODUCT, POLICY} from "../../types/ObjectType.sol";
-import {APPLIED, UNDERWRITTEN, ACTIVE} from "../../types/StateId.sol";
+import {ObjectType, PRODUCT, POOL, POLICY} from "../../types/ObjectType.sol";
+import {APPLIED, UNDERWRITTEN, 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/ReferralId.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 "../base/IService.sol";
-import {ServiceBase} from "../base/ServiceBase.sol";
-import {ComponentServiceBase} from "../base/ComponentServiceBase.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 ComponentServiceBase, IProductService {
+contract ProductService is ComponentService, IProductService {
     using NftIdLib for NftId;
 
-    string public constant NAME = "ProductService";
+    IPoolService internal _poolService;
 
     event LogProductServiceSender(address sender);
 
-    constructor(
-        address registry,
-        NftId registryNftId,
-        address initialOwner
-    ) ComponentServiceBase(registry, registryNftId, initialOwner)
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
     {
-        _registerInterface(type(IProductService).interfaceId);
-    }
+        address registryAddress;
+        address initialOwner;
+        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+
+        _initializeService(registryAddress, owner);
 
+        _poolService = IPoolService(_registry.getServiceAddress(POOL(), getMajorVersion()));
 
-    function getName() public pure override(IService, ServiceBase) returns(string memory name) {
-        return NAME;
+        _registerInterface(type(IProductService).interfaceId);
     }
 
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    )
+
+    function register(address productAddress) 
         external
-        override
+        returns(NftId productNftId)
     {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        NftId productNftId = productInfo.nftId;
-        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
-        treasuryInfo.productFee = productFee;
-        treasuryInfo.processingFee = processingFee;
-        instance.setTreasuryInfo(productNftId, treasuryInfo);
-    }
+        (
+            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(_registry.getObjectInfo(setup.distributionNftId).objectAddress);
+        IComponent pool = IComponent(_registry.getObjectInfo(setup.poolNftId).objectAddress);
 
-    function createRisk(
-        RiskId riskId,
-        bytes memory data
-    ) external override {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        NftId productNftId = productInfo.nftId;
-        instance.createRisk(
-            riskId,
-            productNftId,
-            data
-        );
-    }
+        distribution.setProductNftId(productNftId);
+        pool.setProductNftId(productNftId);
+        product.setProductNftId(productNftId);
+        product.linkToRegisteredNftId();
 
-    function setRiskInfo(
-        RiskId riskId,
-        IRisk.RiskInfo memory info
-    ) external {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instance.setRiskInfo(
-            riskId,
-            info
-        );
-    }
+        // create product setup in instance
+        instance.createProductSetup(productNftId, product.getSetupInfo());
 
-    function updateRiskState(
-        RiskId riskId,
-        StateId state
-    ) external {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instance.updateRiskState(
-            riskId,
-            state
-        );
+        // create target for instane access manager
+        getInstanceService().createGifTarget(
+            _registry.getNftId(address(instance)), 
+            address(product), 
+            product.getName());
+        getInstanceService().grantProductDefaultPermissions(instance.getNftId(), address(product), product.getName());
     }
 
-    function _getAndVerifyInstanceAndProduct() internal view returns (IProductComponent product) {
-        IRegistry.ObjectInfo memory productInfo;
-        (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        product = IProductComponent(productInfo.objectAddress);
+    function getDomain() public pure override(IService, Service) returns(ObjectType) {
+        return PRODUCT();
     }
 
-    function calculatePremium(
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        public
-        view 
-        override
-        returns (
-            uint256 premiumAmount,
-            uint256 productFeeAmount,
-            uint256 poolFeeAmount,
-            uint256 bundleFeeAmount,
-            uint256 distributionFeeAmount
-        )
+
+    function _decodeAndVerifyProductData(bytes memory data) 
+        internal 
+        returns(string memory name, ISetup.ProductSetupInfo memory setup)
     {
-        IProductComponent product = _getAndVerifyInstanceAndProduct();
-        uint256 netPremiumAmount = product.calculateNetPremium(
-            sumInsuredAmount,
-            riskId,
-            lifetime,
-            applicationData
+        (name, setup) = abi.decode(
+            data,
+            (string, ISetup.ProductSetupInfo)
         );
 
-        (
-            productFeeAmount,
-            poolFeeAmount,
-            bundleFeeAmount,
-            distributionFeeAmount
-        ) = _calculateFeeAmounts(
-            netPremiumAmount,
-            product,
-            bundleNftId,
-            referralId
-        );
+        // TODO add checks
+        // if(wallet == address(0)) {
+        //     revert WalletIsZero();
+        // }
 
-        premiumAmount = netPremiumAmount + productFeeAmount;
-        premiumAmount += poolFeeAmount + bundleFeeAmount;
-        premiumAmount += distributionFeeAmount;
-    }
+        // IRegistry.ObjectInfo memory tokenInfo = _registry.getObjectInfo(address(info.token));
 
-    function _calculateFeeAmounts(
-        uint256 netPremiumAmount,
-        IProductComponent product,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        internal
-        view
-        returns (
-            uint256 productFeeAmount,
-            uint256 poolFeeAmount,
-            uint256 bundleFeeAmount,
-            uint256 distributionFeeAmount
-        )
-    {
-        IInstance instance = product.getInstance();
-        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(product.getNftId());
-        IBundle.BundleInfo memory bundleInfo = instance.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == treasuryInfo.poolNftId,"ERROR:PRS-035:BUNDLE_POOL_MISMATCH");
-
-        (productFeeAmount,) = FeeLib.calculateFee(treasuryInfo.productFee, netPremiumAmount);
-        (poolFeeAmount,) = FeeLib.calculateFee(treasuryInfo.poolFee, netPremiumAmount);
-        (bundleFeeAmount,) = FeeLib.calculateFee(bundleInfo.fee, netPremiumAmount);
-
-        IRegistry.ObjectInfo memory distributionInfo = getRegistry().getObjectInfo(treasuryInfo.distributionNftId);
-        IDistributionComponent distribution = IDistributionComponent(distributionInfo.objectAddress);
-        distributionFeeAmount = distribution.calculateFeeAmount(referralId, netPremiumAmount);
-    }
+        // if(tokenInfo.objectType != TOKEN()) {
+        //     revert InvalidToken();
+        // } 
 
+        // IRegistry.ObjectInfo memory poolInfo = _registry.getObjectInfo(info.poolNftId);
 
-    function createApplication(
-        address applicationOwner,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    ) external override returns (NftId policyNftId) {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        // TODO add validations (see create bundle in pool service)
-
-        policyNftId = getRegistryService().registerPolicy(
-            IRegistry.ObjectInfo(
-                zeroNftId(),
-                productInfo.nftId,
-                POLICY(),
-                false, // intercepting property for policies is defined on product
-                address(0),
-                applicationOwner,
-                ""
-            )
-        );
+        // if(poolInfo.objectType != POOL()) {
+        //     revert InvalidPool();
+        // }
 
-        (uint256 premiumAmount,,,,) = calculatePremium(
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
+        // 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
 
-        instance.createPolicyInfo(
-            policyNftId,
-            productInfo.nftId,
-            referralId,
-            riskId,
-            sumInsuredAmount,
-            premiumAmount,
-            lifetime,
-            bundleNftId
-        );
+        // IRegistry.ObjectInfo memory distributionInfo = _registry.getObjectInfo(info.distributionNftId);
 
-        // TODO add logging
-    }
+        // if(distributionInfo.objectType != DISTRIBUTION()) {
+        //     revert  InvalidDistribution();
+        // } 
 
-    function _getAndVerifyUnderwritingSetup(
-        IInstance instance,
-        IPolicy.PolicyInfo memory policyInfo
-    )
-        internal
-        view
-        returns (
-            ITreasury.TreasuryInfo memory treasuryInfo,
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        )
-    {
-        // check match between policy and bundle (via pool)
-        treasuryInfo = instance.getTreasuryInfo(policyInfo.productNftId);
-        bundleNftId = policyInfo.bundleNftId;
-        bundleInfo = instance.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == treasuryInfo.poolNftId, "POLICY_BUNDLE_MISMATCH");
-
-        // calculate required collateral
-        NftId poolNftId = treasuryInfo.poolNftId;
-        IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
-
-        // obtain remaining return values
-        collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
+        // if(distributionInfo.parentNftId != instanceNftId) {
+        //     revert InvalidDistributionsInstance();
+        // }
+        // // TODO distribution have the same token
+        // // TODO distribution is not linked
     }
 
-    function _lockCollateralInBundle(
-        IInstance instance,
-        NftId bundleNftId, 
-        IBundle.BundleInfo memory bundleInfo,
-        NftId policyNftId, 
-        uint256 collateralAmount
-    )
-        internal
-        returns (IBundle.BundleInfo memory)
-    {
-        bundleInfo.lockedAmount += collateralAmount;
-        instance.collateralizePolicy(bundleNftId, policyNftId, collateralAmount);
-        return bundleInfo;
-    }
-
-    function _underwriteByPool(
-        ITreasury.TreasuryInfo memory treasuryInfo,
-        NftId policyNftId,
-        IPolicy.PolicyInfo memory policyInfo,
-        bytes memory bundleFilter,
-        uint256 collateralAmount
-    )
-        internal
-    {
-        address poolAddress = getRegistry().getObjectInfo(treasuryInfo.poolNftId).objectAddress;
-        IPoolComponent pool = IPoolComponent(poolAddress);
-        pool.underwrite(
-            policyNftId, 
-            policyInfo.applicationData, 
-            bundleFilter,
-            collateralAmount);
-    }
-
-
-    function revoke(
-        NftId policyNftId
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
     )
         external
-        override
     {
-        require(false, "ERROR:PRS-234:NOT_YET_IMPLEMENTED");
-    }
+        // TODO check args 
 
-
-    function underwrite(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    )
-        external 
-        override
-    {
-        // check caller is registered product
         (
             IRegistry.ObjectInfo memory productInfo, 
             IInstance instance
         ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
 
-        // check match between policy and calling product
+        InstanceReader instanceReader = instance.getInstanceReader();
         NftId productNftId = productInfo.nftId;
-        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
-        require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
-        require(instance.getState(policyNftId.toKey32(POLICY())) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
+        ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
 
-        ITreasury.TreasuryInfo memory treasuryInfo;
-        NftId bundleNftId;
-        IBundle.BundleInfo memory bundleInfo;
-        uint256 collateralAmount;
+        productSetupInfo.productFee = productFee;
+        productSetupInfo.processingFee = processingFee;
+        
+        instance.updateProductSetup(productNftId, productSetupInfo, KEEP_STATE());
+    }
 
+    function createRisk(
+        RiskId riskId,
+        bytes memory data
+    ) external override {
         (
-            treasuryInfo,
-            bundleNftId,
-            bundleInfo,
-            collateralAmount
-        ) = _getAndVerifyUnderwritingSetup(
-            instance,
-            policyInfo
+            IRegistry.ObjectInfo memory productInfo, 
+            IInstance instance
+        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        NftId productNftId = productInfo.nftId;
+        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
+        instance.createRisk(
+            riskId,
+            riskInfo
         );
-
-        // lock bundle collateral
-        bundleInfo = _lockCollateralInBundle(
-            instance,
-            bundleNftId,
-            bundleInfo,
-            policyNftId, 
-            collateralAmount);
-
-        // set policy state to underwritten
-        instance.updatePolicyState(policyNftId, UNDERWRITTEN());
-
-        // optional activation of policy
-        if(activateAt > zeroTimestamp()) {
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-            instance.updatePolicyState(policyNftId, ACTIVE());
-        }
-
-        // optional collection of premium
-        if(requirePremiumPayment) {
-            uint256 netPremiumAmount = _processPremiumByTreasury(
-                instance, 
-                productInfo.nftId,
-                treasuryInfo, 
-                policyNftId, 
-                policyInfo.premiumAmount);
-
-            policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
-            bundleInfo.balanceAmount += netPremiumAmount;
-        }
-
-        instance.setPolicyInfo(policyNftId, policyInfo);
-        instance.setBundleInfo(bundleNftId, bundleInfo);
-
-        // involve pool if necessary
-        {
-            NftId poolNftId = treasuryInfo.poolNftId;
-            IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
-
-            if(poolInfo.isVerifying) {
-                _underwriteByPool(
-                    treasuryInfo,
-                    policyNftId,
-                    policyInfo,
-                    bundleInfo.filter,
-                    collateralAmount
-                );
-            }
-        }
-
-        // TODO add logging
-    }
-
-    function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
-        UFixed sumInsuredUFixed = UFixedMathLib.toUFixed(sumInsuredAmount);
-        UFixed collateralUFixed =  collateralizationLevel * sumInsuredUFixed;
-        return collateralUFixed.toInt();
-    } 
-
-    function collectPremium(NftId policyNftId, Timestamp activateAt) external override {
-        // check caller is registered product
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-
-        // perform actual token transfers
-        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
-        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productInfo.nftId);
-
-        uint256 premiumAmount = policyInfo.premiumAmount;
-        _processPremiumByTreasury(instance, productInfo.nftId, treasuryInfo, policyNftId, premiumAmount);
-
-        // policy level book keeping for premium paid
-        policyInfo.premiumPaidAmount += premiumAmount;
-
-        // optional activation of policy
-        if(activateAt > zeroTimestamp()) {
-            require(
-                policyInfo.activatedAt.eqz(),
-                "ERROR:PRS-030:ALREADY_ACTIVATED");
-
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-            instance.updatePolicyState(policyNftId, ACTIVE());
-        }
-
-        instance.setPolicyInfo(policyNftId, policyInfo);
-
-        // TODO add logging
     }
 
-    function activate(NftId policyNftId, Timestamp activateAt) external override {
-        // check caller is registered product
+    function updateRisk(
+        RiskId riskId,
+        bytes memory data
+    ) external {
         (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-
-        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
-
-        require(
-            policyInfo.activatedAt.eqz(),
-            "ERROR:PRS-020:ALREADY_ACTIVATED");
-
-        policyInfo.activatedAt = activateAt;
-        policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-        instance.setPolicyInfo(policyNftId, policyInfo);
-        instance.updatePolicyState(policyNftId, ACTIVE());
-
-        // TODO add logging
-    }
-
-    function close(
-        NftId policyNftId
-    ) external override // solhint-disable-next-line no-empty-blocks
-    {
-
-    }
-
-    function _getPoolNftId(
-        IInstance instance,
-        NftId productNftId
-    )
-        internal
-        view
-        returns (NftId poolNftid)
-    {
-        return instance.getTreasuryInfo(productNftId).poolNftId;
+        InstanceReader instanceReader = instance.getInstanceReader();
+        IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
+        riskInfo.data = data;
+        instance.updateRisk(riskId, riskInfo, KEEP_STATE());
     }
 
-
-    function _processPremiumByTreasury(
-        IInstance instance,
-        NftId productNftId,
-        ITreasury.TreasuryInfo memory treasuryInfo,
-        NftId policyNftId,
-        uint256 premiumAmount
-    )
-        internal
-        returns (uint256 netPremiumAmount)
-    {
-        // process token transfer(s)
-        if(premiumAmount > 0) {
-            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
-            address policyOwner = getRegistry().ownerOf(policyNftId);
-            address poolWallet = instance.getComponentWallet(treasuryInfo.poolNftId);
-            netPremiumAmount = premiumAmount;
-            Fee memory productFee = treasuryInfo.productFee;
-
-            if (FeeLib.feeIsZero(productFee)) {
-                tokenHandler.transfer(
-                    policyOwner,
-                    poolWallet,
-                    premiumAmount
-                );
-            } else {
-                (uint256 feeAmount, uint256 netAmount) = instance.calculateFeeAmount(
-                    premiumAmount,
-                    productFee
-                );
-
-                address productWallet = instance.getComponentWallet(productNftId);
-                tokenHandler.transfer(policyOwner, productWallet, feeAmount);
-                tokenHandler.transfer(policyOwner, poolWallet, netAmount);
-                netPremiumAmount = netAmount;
-            }
-        }
-
-        // TODO add logging
+    function updateRiskState(
+        RiskId riskId,
+        StateId state
+    ) external {
+        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        instance.updateRiskState(riskId, state);
     }
 }