@etherisc/gif-next 0.0.2-f9bc4c7-556 → 0.0.2-fe34d97-357

package/contracts/instance/service/ProductService.sol

@@ -6,6 +6,7 @@ import {IPoolComponent} from "../../components/IPoolComponent.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 {IProductService} from "./IProductService.sol";
 import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
@@ -15,11 +16,13 @@ import {Versionable} from "../../shared/Versionable.sol";
 
 import {Timestamp, zeroTimestamp} from "../../types/Timestamp.sol";
 import {UFixed, UFixedMathLib} 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 {NftId, NftIdLib} from "../../types/NftId.sol";
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
 import {Fee, FeeLib} from "../../types/Fee.sol";
+import {RiskId} from "../../types/RiskId.sol";
+import {StateId} from "../../types/StateId.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
 
 import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
@@ -62,11 +65,51 @@ contract ProductService is ComponentServiceBase, IProductService {
         override
     {
         (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instance.setProductFees(productInfo.nftId, policyFee, processingFee);
+        NftId productNftId = productInfo.nftId;
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
+        treasuryInfo.policyFee = policyFee;
+        treasuryInfo.processingFee = processingFee;
+        instance.setTreasuryInfo(productNftId, treasuryInfo);
+    }
+
+    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
+        );
+    }
+
+    function setRiskInfo(
+        RiskId riskId,
+        IRisk.RiskInfo memory info
+    ) external {
+        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        instance.setRiskInfo(
+            riskId,
+            info
+        );
+    }
+
+    function updateRiskState(
+        RiskId riskId,
+        StateId state
+    ) external {
+        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        instance.updateRiskState(
+            riskId,
+            state
+        );
     }
 
     function createApplication(
         address applicationOwner,
+        RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 premiumAmount,
         uint256 lifetime,
@@ -83,9 +126,10 @@ contract ProductService is ComponentServiceBase, IProductService {
             ""
         );
 
-        instance.createApplication(
-            productNftId,
+        instance.createPolicyInfo(
             policyNftId,
+            productNftId,
+            riskId,
             sumInsuredAmount,
             premiumAmount,
             lifetime,
@@ -102,30 +146,29 @@ contract ProductService is ComponentServiceBase, IProductService {
         internal
         view
         returns (
-            ITreasury.ProductSetup memory productSetup,
+            ITreasury.TreasuryInfo memory treasuryInfo,
+            NftId bundleNftId,
             IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount,
-            bool poolIsVerifying,
-            bytes memory bundleFilter
+            uint256 collateralAmount
         )
     {
         // check match between policy and bundle (via pool)
-        productSetup = instance.getProductSetup(policyInfo.productNftId);
-        bundleInfo = instance.getBundleInfo(policyInfo.bundleNftId);
-        require(bundleInfo.poolNftId == productSetup.poolNftId, "POLICY_BUNDLE_MISMATCH");
+        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 = productSetup.poolNftId;
+        NftId poolNftId = treasuryInfo.poolNftId;
         IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
 
         // obtain remaining return values
-        poolIsVerifying = poolInfo.isVerifying;
         collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
-        bundleFilter = bundleInfo.filter;
     }
 
     function _lockCollateralInBundle(
         IInstance instance,
+        NftId bundleNftId, 
         IBundle.BundleInfo memory bundleInfo,
         NftId policyNftId, 
         uint256 collateralAmount
@@ -134,23 +177,24 @@ contract ProductService is ComponentServiceBase, IProductService {
         returns (IBundle.BundleInfo memory)
     {
         bundleInfo.lockedAmount += collateralAmount;
-        instance.collateralizePolicy(bundleInfo.nftId, policyNftId, collateralAmount);
+        instance.collateralizePolicy(bundleNftId, policyNftId, collateralAmount);
         return bundleInfo;
     }
 
     function _underwriteByPool(
-        ITreasury.ProductSetup memory productSetup,
+        ITreasury.TreasuryInfo memory treasuryInfo,
+        NftId policyNftId,
         IPolicy.PolicyInfo memory policyInfo,
         bytes memory bundleFilter,
         uint256 collateralAmount
     )
         internal
     {
-        address poolAddress = _registry.getObjectInfo(productSetup.poolNftId).objectAddress;
+        address poolAddress = _registry.getObjectInfo(treasuryInfo.poolNftId).objectAddress;
         IPoolComponent pool = IPoolComponent(poolAddress);
         pool.underwrite(
-            policyInfo.nftId, 
-            policyInfo.data, 
+            policyNftId, 
+            policyInfo.applicationData, 
             bundleFilter,
             collateralAmount);
     }
@@ -174,14 +218,18 @@ contract ProductService is ComponentServiceBase, IProductService {
         NftId productNftId = productInfo.nftId;
         IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
         require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
-        require(policyInfo.state == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
+        require(instance.getPolicyState(policyNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
+
+        ITreasury.TreasuryInfo memory treasuryInfo;
+        NftId bundleNftId;
+        IBundle.BundleInfo memory bundleInfo;
+        uint256 collateralAmount;
 
         (
-            ITreasury.ProductSetup memory productSetup,
-            IBundle.BundleInfo memory bundleInfo,
-            uint256 collateralAmount,
-            bool poolIsVerifying,
-            bytes memory bundleFilter
+            treasuryInfo,
+            bundleNftId,
+            bundleInfo,
+            collateralAmount
         ) = _getAndVerifyUnderwritingSetup(
             instance,
             policyInfo
@@ -190,15 +238,28 @@ contract ProductService is ComponentServiceBase, IProductService {
         // lock bundle collateral
         bundleInfo = _lockCollateralInBundle(
             instance,
+            bundleNftId,
             bundleInfo,
             policyNftId, 
             collateralAmount);
 
-        // collect premium
+        // 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, 
-                productSetup, 
+                productInfo.nftId,
+                treasuryInfo, 
                 policyNftId, 
                 policyInfo.premiumAmount);
 
@@ -206,31 +267,23 @@ contract ProductService is ComponentServiceBase, IProductService {
             bundleInfo.balanceAmount += netPremiumAmount;
         }
 
-        // set policy state to underwritten
-        // TODO add require for state change
-        policyInfo.state = UNDERWRITTEN();
-        policyInfo.updatedIn = blockNumber();
-
-        // optional activation of policy
-        if(activateAt > zeroTimestamp()) {
-            policyInfo.activatedAt = activateAt;
-            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
-
-            // TODO add require for state change
-            policyInfo.state = ACTIVE();
-        }
-
-        instance.setPolicyInfo(policyInfo);
-        instance.setBundleInfo(bundleInfo);
-
-        // integrate pool component
-        if(poolIsVerifying) {
-            _underwriteByPool(
-                productSetup,
-                policyInfo,
-                bundleFilter,
-                collateralAmount
-            );
+        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
@@ -248,14 +301,13 @@ contract ProductService is ComponentServiceBase, IProductService {
 
         // perform actual token transfers
         IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
-        ITreasury.ProductSetup memory product = instance.getProductSetup(productInfo.nftId);
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productInfo.nftId);
 
         uint256 premiumAmount = policyInfo.premiumAmount;
-        _processPremiumByTreasury(instance, product, policyNftId, premiumAmount);
+        _processPremiumByTreasury(instance, productInfo.nftId, treasuryInfo, policyNftId, premiumAmount);
 
         // policy level book keeping for premium paid
         policyInfo.premiumPaidAmount += premiumAmount;
-        policyInfo.updatedIn = blockNumber();
 
         // optional activation of policy
         if(activateAt > zeroTimestamp()) {
@@ -266,11 +318,10 @@ contract ProductService is ComponentServiceBase, IProductService {
             policyInfo.activatedAt = activateAt;
             policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
 
-            // TODO add require for state change
-            policyInfo.state = ACTIVE();
+            instance.updatePolicyState(policyNftId, ACTIVE());
         }
 
-        instance.setPolicyInfo(policyInfo);
+        instance.setPolicyInfo(policyNftId, policyInfo);
 
         // TODO add logging
     }
@@ -288,10 +339,8 @@ contract ProductService is ComponentServiceBase, IProductService {
         policyInfo.activatedAt = activateAt;
         policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
 
-        // TODO add require for state change
-        policyInfo.state = ACTIVE();
-
-        instance.setPolicyInfo(policyInfo);
+        instance.setPolicyInfo(policyNftId, policyInfo);
+        instance.updatePolicyState(policyNftId, ACTIVE());
 
         // TODO add logging
     }
@@ -311,12 +360,14 @@ contract ProductService is ComponentServiceBase, IProductService {
         view
         returns (NftId poolNftid)
     {
-        return instance.getProductSetup(productNftId).poolNftId;
+        return instance.getTreasuryInfo(productNftId).poolNftId;
     }
 
+
     function _processPremiumByTreasury(
         IInstance instance,
-        ITreasury.ProductSetup memory product,
+        NftId productNftId,
+        ITreasury.TreasuryInfo memory treasuryInfo,
         NftId policyNftId,
         uint256 premiumAmount
     )
@@ -325,11 +376,11 @@ contract ProductService is ComponentServiceBase, IProductService {
     {
         // process token transfer(s)
         if(premiumAmount > 0) {
-            TokenHandler tokenHandler = instance.getTokenHandler(product.productNftId);
+            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
             address policyOwner = _registry.getOwner(policyNftId);
-            address poolWallet = instance.getPoolSetup(product.poolNftId).wallet;
+            address poolWallet = instance.getComponentWallet(treasuryInfo.poolNftId);
             netPremiumAmount = premiumAmount;
-            Fee memory policyFee = product.policyFee;
+            Fee memory policyFee = treasuryInfo.policyFee;
 
             if (FeeLib.feeIsZero(policyFee)) {
                 tokenHandler.transfer(
@@ -343,7 +394,8 @@ contract ProductService is ComponentServiceBase, IProductService {
                     policyFee
                 );
 
-                tokenHandler.transfer(policyOwner, product.wallet, feeAmount);
+                address productWallet = instance.getComponentWallet(productNftId);
+                tokenHandler.transfer(policyOwner, productWallet, feeAmount);
                 tokenHandler.transfer(policyOwner, poolWallet, netAmount);
                 netPremiumAmount = netAmount;
             }

package/contracts/registry/Registry.sol

@@ -9,7 +9,7 @@ import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
 import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
 import {VersionPart} from "../types/Version.sol";
-import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
+import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, COMPENSATION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
 
 // TODO make registry upgradable
 contract Registry is
@@ -293,7 +293,7 @@ contract Registry is
 
         // instance as parent
         _isValidParentType[PRODUCT()][INSTANCE()] = true;
-        _isValidParentType[DISTRIBUTOR()][INSTANCE()] = true;
+        _isValidParentType[COMPENSATION()][INSTANCE()] = true;
         _isValidParentType[ORACLE()][INSTANCE()] = true;
         _isValidParentType[POOL()][INSTANCE()] = true;
 

package/contracts/test/TestPool.sol

@@ -14,9 +14,11 @@ contract TestPool is Pool {
         NftId instanceNftid,
         address token,
         bool isVerifying,
-        UFixed collateralizationLevel
+        UFixed collateralizationLevel,
+        Fee memory stakingFee,
+        Fee memory performanceFee
     )
-        Pool(registry, instanceNftid, token, isVerifying, collateralizationLevel)
+        Pool(registry, instanceNftid, token, isVerifying, collateralizationLevel, stakingFee, performanceFee)
     // solhint-disable-next-line no-empty-blocks
     {}
 }

package/contracts/test/TestProduct.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.19;
 
 import {Product} from "../../contracts/components/Product.sol";
 import {NftId, toNftId} from "../../contracts/types/NftId.sol";
+import {RiskId} from "../../contracts/types/RiskId.sol";
 import {Timestamp, blockTimestamp} from "../../contracts/types/Timestamp.sol";
 import {Fee} from "../../contracts/types/Fee.sol";
 
@@ -10,10 +11,25 @@ contract TestProduct is Product {
 
     event LogTestProductSender(address sender);
 
-    constructor(address registry, NftId instanceNftid, address token, address pool)
-        Product(registry, instanceNftid, token, pool)
+    string public constant DEFAULT_RISK_NAME = "DEFAULT_RISK";
+    bool private defaultRiskCreated;
+
+    constructor(
+        address registry,
+        NftId instanceNftid,
+        address token,
+        address pool,
+        Fee memory policyFee,
+        Fee memory processingFee
+    )
+        Product(registry, instanceNftid, token, pool, policyFee, processingFee)
     // solhint-disable-next-line no-empty-blocks
-    {}
+    {
+    }
+
+    function getDefaultRiskId() public pure returns (RiskId) {
+        return _toRiskId(DEFAULT_RISK_NAME);
+    }
 
     function applyForPolicy(
         uint256 sumInsuredAmount,
@@ -24,8 +40,14 @@ contract TestProduct is Product {
         external
         returns(NftId nftId)
     {
+        if (!defaultRiskCreated) {
+            _createRisk(getDefaultRiskId() , "");
+            defaultRiskCreated = true;
+        }
+
         nftId = _createApplication(
             msg.sender, // policy holder
+            getDefaultRiskId(),
             sumInsuredAmount,
             premiumAmount,
             lifetime,

package/contracts/types/ObjectType.sol

@@ -37,36 +37,48 @@ function STAKE() pure returns (ObjectType) {
     return toObjectType(60);
 }
 
-function PRODUCT() pure returns (ObjectType) {
+function COMPONENT() pure returns (ObjectType) {
     return toObjectType(100);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
+function TREASURY() pure returns (ObjectType) {
+    return toObjectType(101);
+}
+
+function PRODUCT() pure returns (ObjectType) {
     return toObjectType(110);
 }
 
-function ORACLE() pure returns (ObjectType) {
+function COMPENSATION() pure returns (ObjectType) {
     return toObjectType(120);
 }
 
-function POOL() pure returns (ObjectType) {
+function ORACLE() pure returns (ObjectType) {
     return toObjectType(130);
 }
 
-function POLICY() pure returns (ObjectType) {
+function POOL() pure returns (ObjectType) {
+    return toObjectType(140);
+}
+
+function RISK() pure returns (ObjectType) {
     return toObjectType(200);
 }
 
-function BUNDLE() pure returns (ObjectType) {
+function POLICY() pure returns (ObjectType) {
     return toObjectType(210);
 }
 
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(220);
+}
+
 function CLAIM() pure returns (ObjectType) {
-    return toObjectType(201);
+    return toObjectType(211);
 }
 
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(202);
+    return toObjectType(212);
 }
 
 /// @dev Converts the uint8 to a ObjectType.

package/contracts/types/RiskId.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {RISK} from "./ObjectType.sol";
+
+type RiskId is bytes8;
+
+// type bindings
+using {
+    eqRiskId as ==, 
+    neRiskId as !=,
+    RiskIdLib.toKey32
+} for RiskId global;
+
+// general pure free functions
+
+// @dev Returns true iff risk ids a and b are identical
+function eqRiskId(RiskId a, RiskId b) pure returns (bool isSame) {
+    return RiskId.unwrap(a) == RiskId.unwrap(b);
+}
+
+// @dev Returns true iff risk ids a and b are different
+function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
+    return RiskId.unwrap(a) != RiskId.unwrap(b);
+}
+
+library RiskIdLib {
+    // @dev Converts a role string into a role id.
+    function toRiskId(string memory risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(RiskId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(RISK(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(RiskId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(RiskId.unwrap(id)));
+    }
+}

package/package.json

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