@etherisc/gif-next 0.0.2-b060f43-287 → 0.0.2-b12de3e-067

package/contracts/instance/service/ProductService.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.19;
 import {IRegistry} from "../../registry/IRegistry.sol";
 import {IProductComponent} from "../../components/IProductComponent.sol";
 import {Product} from "../../components/Product.sol";
+import {IBaseComponent} from "../../components/IBaseComponent.sol";
 import {IPoolComponent} from "../../components/IPoolComponent.sol";
 import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
 import {IInstance} from "../IInstance.sol";
@@ -30,6 +31,7 @@ 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";
@@ -47,7 +49,6 @@ contract ProductService is ComponentServiceBase, IProductService {
 
     string public constant NAME = "ProductService";
 
-    address internal _registryAddress;
     IPoolService internal _poolService;
 
     event LogProductServiceSender(address sender);
@@ -60,14 +61,14 @@ contract ProductService is ComponentServiceBase, IProductService {
         initializer
         virtual override
     {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+        address registryAddress;
+        address initialOwner;
+        (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        _initializeService(_registryAddress, owner);
+        _initializeService(registryAddress, owner);
 
         _poolService = IPoolService(_registry.getServiceAddress(POOL_SERVICE_NAME, getMajorVersion()));
 
-        _registerInterface(type(IService).interfaceId);
         _registerInterface(type(IProductService).interfaceId);
     }
 
@@ -76,12 +77,40 @@ contract ProductService is ComponentServiceBase, IProductService {
         return NAME;
     }
 
-    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
-        ISetup.ProductSetupInfo memory initialSetup = abi.decode(
-            initialObjData,
+    function register(address productAddress) 
+        external
+        returns(NftId productNftId)
+    {
+        address productOwner = msg.sender;
+        IBaseComponent product = IBaseComponent(productAddress);
+
+        IRegistry.ObjectInfo memory info;
+        bytes memory data;
+        (info, data) = getRegistryService().registerProduct(product, productOwner);
+
+        IInstance instance = _getInstance(info);
+        bool hasRole = getInstanceService().hasRole(
+            productOwner, 
+            PRODUCT_OWNER_ROLE(), 
+            address(instance));
+
+        if(!hasRole) {
+            revert ExpectedRoleMissing(PRODUCT_OWNER_ROLE(), productOwner);
+        }
+
+        productNftId = info.nftId;
+        ISetup.ProductSetupInfo memory initialSetup = _decodeAndVerifyProductSetup(data);
+        instance.createProductSetup(productNftId, initialSetup);
+    }
+
+    function _decodeAndVerifyProductSetup(bytes memory data) internal returns(ISetup.ProductSetupInfo memory setup)
+    {
+        setup = abi.decode(
+            data,
             (ISetup.ProductSetupInfo)
         );
-        instance.createProductSetup(componentNftId, initialSetup);
+
+        // TODO add checks if applicable 
     }
 
     function setFees(
@@ -89,13 +118,18 @@ contract ProductService is ComponentServiceBase, IProductService {
         Fee memory processingFee
     )
         external
-        override
     {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        // TODO check args 
+
+        (
+            IRegistry.ObjectInfo memory productInfo, 
+            IInstance instance
+        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+
         InstanceReader instanceReader = instance.getInstanceReader();
         NftId productNftId = productInfo.nftId;
-
         ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
+
         productSetupInfo.productFee = productFee;
         productSetupInfo.processingFee = processingFee;
         
@@ -106,7 +140,10 @@ contract ProductService is ComponentServiceBase, IProductService {
         RiskId riskId,
         bytes memory data
     ) external override {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (
+            IRegistry.ObjectInfo memory productInfo, 
+            IInstance instance
+        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         NftId productNftId = productInfo.nftId;
         IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
         instance.createRisk(
@@ -133,438 +170,4 @@ contract ProductService is ComponentServiceBase, IProductService {
         (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
         instance.updateRiskState(riskId, state);
     }
-
-    function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
-        IRegistry.ObjectInfo memory productInfo;
-        (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        product = Product(productInfo.objectAddress);
-    }
-
-    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
-        )
-    {
-        Product product = _getAndVerifyInstanceAndProduct();
-        uint256 netPremiumAmount = product.calculateNetPremium(
-            sumInsuredAmount,
-            riskId,
-            lifetime,
-            applicationData
-        );
-
-        (
-            productFeeAmount,
-            poolFeeAmount,
-            bundleFeeAmount,
-            distributionFeeAmount
-        ) = _calculateFeeAmounts(
-            netPremiumAmount,
-            product,
-            bundleNftId,
-            referralId
-        );
-
-        premiumAmount = netPremiumAmount + productFeeAmount;
-        premiumAmount += poolFeeAmount + bundleFeeAmount;
-        premiumAmount += distributionFeeAmount;
-    }
-
-    function _calculateFeeAmounts(
-        uint256 netPremiumAmount,
-        Product product,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        internal
-        view
-        returns (
-            uint256 productFeeAmount,
-            uint256 poolFeeAmount,
-            uint256 bundleFeeAmount,
-            uint256 distributionFeeAmount
-        )
-    {
-        InstanceReader instanceReader;
-        {
-            IInstance instance = product.getInstance();
-            instanceReader = instance.getInstanceReader();
-        }
-        
-        NftId poolNftId = product.getPoolNftId();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == poolNftId,"ERROR:PRS-035:BUNDLE_POOL_MISMATCH");
-
-        {
-            ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(product.getProductNftId());
-            (productFeeAmount,) = FeeLib.calculateFee(productSetupInfo.productFee, netPremiumAmount);
-        }
-        {
-            ISetup.PoolSetupInfo memory poolSetupInfo = instanceReader.getPoolSetupInfo(poolNftId);
-            (poolFeeAmount,) = FeeLib.calculateFee(poolSetupInfo.poolFee, netPremiumAmount);
-        }
-        {
-            NftId distributionNftId = product.getDistributionNftId();
-            ISetup.DistributionSetupInfo memory distributionSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
-            (distributionFeeAmount,) = FeeLib.calculateFee(distributionSetupInfo.distributionFee, netPremiumAmount);
-        }
-        
-        (bundleFeeAmount,) = FeeLib.calculateFee(bundleInfo.fee, netPremiumAmount);
-    }
-
-
-    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,
-                ""
-            )
-        );
-
-        (uint256 premiumAmount,,,,) = calculatePremium(
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-
-        IPolicy.PolicyInfo memory policyInfo = IPolicy.PolicyInfo(
-            productInfo.nftId,
-            bundleNftId,
-            referralId,
-            riskId,
-            sumInsuredAmount,
-            premiumAmount,
-            0,
-            lifetime,
-            applicationData,
-            "",
-            0,
-            0,
-            0,
-            zeroTimestamp(),
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-        
-        instance.createPolicy(policyNftId, policyInfo);
-        instance.updatePolicyState(policyNftId, APPLIED());
-
-        // TODO add logging
-    }
-
-    function _getAndVerifyUnderwritingSetup(
-        IInstance instance,
-        InstanceReader instanceReader,
-        IPolicy.PolicyInfo memory policyInfo,
-        ISetup.ProductSetupInfo memory productSetupInfo
-    )
-        internal
-        view
-        returns (
-            NftId bundleNftId,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount
-        )
-    {
-        // check match between policy and bundle (via pool)
-        bundleNftId = policyInfo.bundleNftId;
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId == productSetupInfo.poolNftId, "POLICY_BUNDLE_MISMATCH");
-
-        // calculate required collateral
-        NftId poolNftId = productSetupInfo.poolNftId;
-        ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
-
-        // obtain remaining return values
-        collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
-    }
-
-    function _lockCollateralInBundle(
-        IInstance instance,
-        NftId bundleNftId, 
-        IBundle.BundleInfo memory bundleInfo,
-        NftId policyNftId, 
-        uint256 collateralAmount
-    )
-        internal
-        returns (IBundle.BundleInfo memory)
-    {
-        bundleInfo.lockedAmount += collateralAmount;
-        // TODO: track policy associated to bundle in bundlemanager (tbd) and how much is locked for it
-        return bundleInfo;
-    }
-
-    function _underwriteByPool(
-        NftId poolNftId,
-        NftId policyNftId,
-        IPolicy.PolicyInfo memory policyInfo,
-        bytes memory bundleFilter,
-        uint256 collateralAmount
-    )
-        internal
-    {
-        address poolAddress = getRegistry().getObjectInfo(poolNftId).objectAddress;
-        IPoolComponent pool = IPoolComponent(poolAddress);
-        pool.underwrite(
-            policyNftId, 
-            policyInfo.applicationData, 
-            bundleFilter,
-            collateralAmount);
-    }
-
-
-    function revoke(
-        NftId policyNftId
-    )
-        external
-        override
-    {
-        require(false, "ERROR:PRS-234:NOT_YET_IMPLEMENTED");
-    }
-
-
-    function underwrite(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    )
-        external 
-        override
-    {
-        // check caller is registered product
-        (
-            IRegistry.ObjectInfo memory productInfo, 
-            IInstance instance
-        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        // check match between policy and calling product
-        NftId productNftId = productInfo.nftId;
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-        require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
-        require(instanceReader.getPolicyState(policyNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
-
-        NftId bundleNftId;
-        IBundle.BundleInfo memory bundleInfo;
-        uint256 collateralAmount;
-        uint256 netPremiumAmount = 0; // > 0 if immediate premium payment 
-        {
-            ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-            IBundle.BundleInfo memory bundleInfo;
-            
-            (
-                bundleNftId,
-                bundleInfo,
-                collateralAmount
-            ) = _getAndVerifyUnderwritingSetup(
-                instance,
-                instanceReader,
-                policyInfo,
-                productSetupInfo
-            );
-        }
-
-
-        // lock bundle collateral
-        bundleInfo = _lockCollateralInBundle(
-            instance,
-            bundleNftId,
-            bundleInfo,
-            policyNftId, 
-            collateralAmount);
-        
-        // lock bundle collateral
-        bundleInfo = _lockCollateralInBundle(
-            instance,
-            bundleNftId,
-            bundleInfo,
-            policyNftId, 
-            collateralAmount);
-        StateId newPolicyState = UNDERWRITTEN();
-        
-        // optional activation of policy
-        if(activateAt > zeroTimestamp()) {
-            newPolicyState = ACTIVE();
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-        }
-
-        // optional collection of premium
-        if(requirePremiumPayment) {
-            netPremiumAmount = _processPremiumByTreasury(
-                instance, 
-                productInfo.nftId,
-                policyNftId, 
-                policyInfo.premiumAmount);
-
-            policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
-        }
-
-        _poolService.underwritePolicy(instance, policyNftId, bundleNftId, collateralAmount, netPremiumAmount);
-        instance.updatePolicy(policyNftId, policyInfo, newPolicyState);
-
-        // involve pool if necessary
-        {
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(bundleInfo.poolNftId);
-
-            if(poolInfo.isConfirmingApplication) {
-                _underwriteByPool(
-                    bundleInfo.poolNftId,
-                    policyNftId,
-                    policyInfo,
-                    bundleInfo.filter,
-                    collateralAmount
-                );
-            }
-        }
-
-        // TODO add logging
-    }
-
-    function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
-        UFixed sumInsuredUFixed = UFixedLib.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());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        // TODO: check if not paid
-        // TODO: transfer premium 
-        // TODO: optionally activate
-
-        // // perform actual token transfers (this code is probably not complete)
-        // IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-        
-        // uint256 premiumAmount = policyInfo.premiumAmount;
-        // _processPremiumByTreasury(instance, productInfo.nftId, policyNftId, premiumAmount);
-
-        // // policy level book keeping for premium paid
-        // policyInfo.premiumPaidAmount += premiumAmount;
-
-        // instance.updatePolicy(policyNftId, policyInfo, KEEP_STATE());
-
-        // // optional activation of policy
-        // if(activateAt > zeroTimestamp()) {
-        //     activate(policyNftId, activateAt);
-        // }
-
-        // TODO add logging
-    }
-
-    function activate(NftId policyNftId, Timestamp activateAt) public override {
-        // check caller is registered product
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        require(
-            policyInfo.activatedAt.eqz(),
-            "ERROR:PRS-020:ALREADY_ACTIVATED");
-
-        policyInfo.activatedAt = activateAt;
-        policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-        instance.updatePolicy(policyNftId, policyInfo, 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)
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-        return productSetupInfo.poolNftId;
-    }
-
-
-    function _processPremiumByTreasury(
-        IInstance instance,
-        NftId productNftId,
-        NftId policyNftId,
-        uint256 premiumAmount
-    )
-        internal
-        returns (uint256 netPremiumAmount)
-    {
-        // process token transfer(s)
-        if(premiumAmount > 0) {
-            ISetup.ProductSetupInfo memory productSetupInfo = instance.getInstanceReader().getProductSetupInfo(productNftId);
-            TokenHandler tokenHandler = productSetupInfo.tokenHandler;
-            address policyOwner = getRegistry().ownerOf(policyNftId);
-            ISetup.PoolSetupInfo memory poolSetupInfo = instance.getInstanceReader().getPoolSetupInfo(productSetupInfo.poolNftId);
-            address poolWallet = poolSetupInfo.wallet;
-            netPremiumAmount = premiumAmount;
-            Fee memory productFee = productSetupInfo.productFee;
-
-            if (FeeLib.feeIsZero(productFee)) {
-                tokenHandler.transfer(
-                    policyOwner,
-                    poolWallet,
-                    premiumAmount
-                );
-            } else {
-                (uint256 productFeeAmount, uint256 netAmount) = FeeLib.calculateFee(productSetupInfo.productFee, netPremiumAmount);
-                address productWallet = productSetupInfo.wallet;
-                if (tokenHandler.getToken().allowance(policyOwner, address(tokenHandler)) < premiumAmount) {
-                    revert ErrorIProductServiceInsufficientAllowance(policyOwner, address(tokenHandler), premiumAmount);
-                }
-                tokenHandler.transfer(policyOwner, productWallet, productFeeAmount);
-                tokenHandler.transfer(policyOwner, poolWallet, netAmount);
-                netPremiumAmount = netAmount;
-            }
-        }
-
-        // TODO add logging
-    }
 }

package/contracts/types/RoleId.sol

@@ -39,6 +39,8 @@ function PRODUCT_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRol
 function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10000); }
 function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10100); }
 function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10200); }
+function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10300); }
+function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10400); }
 
 function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11000); }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-b060f43-287",
+  "version": "0.0.2-b12de3e-067",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {