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

package/contracts/instance/module/treasury/ITreasury.sol

@@ -13,25 +13,14 @@ interface ITreasury {
     // TODO add events
     // TODO add errors
 
-    struct ProductSetup {
-        NftId productNftId;
-        NftId distributorNftId;
+    // treasury info is linked to product nft id
+    struct TreasuryInfo {
+        NftId compensationNftId;
         NftId poolNftId;
         IERC20Metadata token;
-        address wallet;
+        Fee commissionFee;
         Fee policyFee;
         Fee processingFee;
-    }
-
-    struct DistributorSetup {
-        NftId distributorNftId;
-        address wallet;
-        Fee commissionFee;
-    }
-
-    struct PoolSetup {
-        NftId poolNftId;
-        address wallet;
         Fee stakingFee;
         Fee performanceFee;
     }
@@ -39,47 +28,51 @@ interface ITreasury {
 
 interface ITreasuryModule is ITreasury {
 
-    function registerProduct(
+    function registerProductSetup(
         NftId productNftId,
         NftId distributorNftId,
         NftId poolNftId,
         IERC20Metadata token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-
-    function setProductFees(
-        NftId productNftId,
         Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
+        Fee memory processingFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     ) external;
 
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
+    function setTreasuryInfo(
+        NftId productNftId,
+        TreasuryInfo memory info
     ) external;
 
+    function getTreasuryInfo(
+        NftId productNftId
+    ) external view returns (TreasuryInfo memory info);
+
+    // function setProductFees(
+    //     NftId productNftId,
+    //     Fee memory policyFee,
+    //     Fee memory processingFee
+    // ) external;
+
+    // function setCompensationFees(
+    //     NftId poolNftId,
+    //     Fee memory distributionFee
+    // ) external;
+
+    // function setPoolFees(
+    //     NftId poolNftId,
+    //     Fee memory stakingFee,
+    //     Fee memory performanceFee
+    // ) external;
+
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId);
+
     function getTokenHandler(
         NftId componentNftId
     ) external view returns (TokenHandler tokenHandler);
 
-    function getProductSetup(
-        NftId productNftId
-    ) external view returns (ProductSetup memory setup);
-
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view returns (PoolSetup memory setup);
-
     function calculateFeeAmount(
         uint256 amount,
         Fee memory fee
@@ -90,7 +83,7 @@ interface ITreasuryModule is ITreasury {
         uint256 fixedFee
     ) external pure returns (Fee memory fee);
 
-    function getZeroFee() external pure returns (Fee memory fee);
+    function getZeroFee() external view returns (Fee memory fee);
 
     function getUFixed(
         uint256 a

package/contracts/instance/module/treasury/TreasuryModule.sol

@@ -4,100 +4,125 @@ pragma solidity ^0.8.19;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {NftId} from "../../../types/NftId.sol";
+import {TREASURY} from "../../../types/ObjectType.sol";
 import {Fee, FeeLib} from "../../../types/Fee.sol";
 import {UFixed, UFixedMathLib} from "../../../types/UFixed.sol";
 import {TokenHandler} from "./TokenHandler.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {ITreasuryModule} from "./ITreasury.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
+
+abstract contract TreasuryModule is
+    ModuleBase,
+    ITreasuryModule
+{
+    // relation of distributor and pool nft map to product nft
+    mapping(NftId componentNftId => NftId productNftId) internal _productNft;
+    // relation of component nft to token hanlder
+    mapping(NftId componentNftId => TokenHandler tokenHandler) internal _tokenHandler;
+    Fee internal _zeroFee;
+    
+
+    function initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+        _zeroFee = FeeLib.zeroFee();
+    }
 
-abstract contract TreasuryModule is ITreasuryModule {
-    mapping(NftId productNftId => ProductSetup setup) private _productSetup;
-    mapping(NftId distributorNftId => DistributorSetup setup)
-        private _distributorSetup;
-    mapping(NftId poolNftId => PoolSetup setup) private _poolSetup;
-    mapping(NftId componentNftId => TokenHandler tokenHanlder) _tokenHandler;
-
-    function registerProduct(
+    function registerProductSetup(
         NftId productNftId,
-        NftId distributorNftId,
+        NftId compensationNftId,
         NftId poolNftId,
         IERC20Metadata token,
-        address wallet,
         Fee memory policyFee,
-        Fee memory processingFee
+        Fee memory processingFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
     ) external override // TODO add authz (only component module)
     {
         require(address(_tokenHandler[productNftId]) == address(0), "ERROR:TRS-010:TOKEN_HANDLER_ALREADY_REGISTERED");
-        require(address(_tokenHandler[poolNftId]) == address(0), "ERROR:TRS-011:TOKEN_HANDLER_ALREADY_REGISTERED");
-        require(address(_tokenHandler[distributorNftId]) == address(0), "ERROR:TRS-012:TOKEN_HANDLER_ALREADY_REGISTERED");
-        // TODO add additional validations
+        require(_productNft[compensationNftId].eqz(), "ERROR:TRS-011:COMPENSATION_ALREADY_LINKED");
+        require(_productNft[poolNftId].eqz(), "ERROR:TRS-012:POOL_ALREADY_LINKED");
 
         // deploy product specific handler contract
         TokenHandler tokenHandler = new TokenHandler(productNftId, address(token));
         _tokenHandler[productNftId] = tokenHandler;
-        _tokenHandler[poolNftId] = tokenHandler;
-        _tokenHandler[distributorNftId] = tokenHandler;
+        _productNft[compensationNftId] = productNftId;
+        _productNft[poolNftId] = productNftId;
 
-        // create product setup
-        _productSetup[productNftId] = ProductSetup(
-            productNftId,
-            distributorNftId,
+        TreasuryInfo memory info = TreasuryInfo(
+            compensationNftId,
             poolNftId,
             token,
-            wallet,
+            _zeroFee,
             policyFee,
-            processingFee
-        );
-
-        // TODO add logging
-    }
-
-    function setProductFees(
-        NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component owner service)
-    {
-        // TODO add validation
-
-        ProductSetup storage setup = _productSetup[productNftId];
-        setup.policyFee = policyFee;
-        setup.processingFee = processingFee;
-
-        // TODO add logging
-    }
-
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component module)
-    {
-        // TODO add validation
-
-        _poolSetup[poolNftId] = PoolSetup(
-            poolNftId,
-            wallet,
+            processingFee,
             stakingFee,
             performanceFee
         );
 
-        // TODO add logging
+        _create(TREASURY(), productNftId, abi.encode(info));
     }
 
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component owner service)
+    function setTreasuryInfo(
+        NftId productNftId,
+        TreasuryInfo memory info
+    )
+        external
+        // TODO add authz (only component module)
+        override
     {
-        // TODO add validation
-
-        PoolSetup storage setup = _poolSetup[poolNftId];
-        setup.stakingFee = stakingFee;
-        setup.performanceFee = performanceFee;
+        _updateData(TREASURY(), productNftId, abi.encode(info));
+    }
 
-        // TODO add logging
+    // function setProductFees(
+    //     NftId productNftId,
+    //     Fee memory policyFee,
+    //     Fee memory processingFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-020:NOT_FOUND");
+
+    //     info.policyFee = policyFee;
+    //     info.processingFee = processingFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    // function setCompensationFees(
+    //     NftId compensationNftId,
+    //     Fee memory distributionFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     NftId productNftId = _productNft[compensationNftId];
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-030:NOT_FOUND");
+
+    //     info.commissionFee = distributionFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    // function setPoolFees(
+    //     NftId poolNftId,
+    //     Fee memory stakingFee,
+    //     Fee memory performanceFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     NftId productNftId = _productNft[poolNftId];
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-040:NOT_FOUND");
+
+    //     info.stakingFee = stakingFee;
+    //     info.performanceFee = performanceFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId) {
+        return _productNft[componentNftId];
     }
 
     function getTokenHandler(
@@ -106,16 +131,10 @@ abstract contract TreasuryModule is ITreasuryModule {
         return _tokenHandler[componentNftId];
     }
 
-    function getProductSetup(
+    function getTreasuryInfo(
         NftId productNftId
-    ) external view override returns (ProductSetup memory setup) {
-        return _productSetup[productNftId];
-    }
-
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view override returns (PoolSetup memory setup) {
-        return _poolSetup[poolNftId];
+    ) public view override returns (TreasuryInfo memory info) {
+        return abi.decode(_getData(TREASURY(), productNftId), (TreasuryInfo));
     }
 
     function calculateFeeAmount(
@@ -132,8 +151,8 @@ abstract contract TreasuryModule is ITreasuryModule {
         return FeeLib.toFee(fractionalFee, fixedFee);
     }
 
-    function getZeroFee() external pure override returns (Fee memory fee) {
-        return FeeLib.zeroFee();
+    function getZeroFee() external view override returns (Fee memory fee) {
+        return _zeroFee;
     }
 
     function getUFixed(

package/contracts/instance/service/ComponentOwnerService.sol

@@ -11,13 +11,14 @@ import {TreasuryModule} from "../module/treasury/TreasuryModule.sol";
 import {IComponent, IComponentModule} from "../module/component/IComponent.sol";
 import {IBaseComponent} from "../../components/IBaseComponent.sol";
 import {IPoolComponent} from "../../components/IPoolComponent.sol";
-
+import {IKeyValueStore} from "../../instance/base/IKeyValueStore.sol";
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {Versionable} from "../../shared/Versionable.sol";
 
 import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
+import {ObjectType, COMPONENT, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
+import {Key32} from "../../types/Key32.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
@@ -97,29 +98,28 @@ contract ComponentOwnerService is
 
         instance.registerComponent(
             nftId,
-            objectType,
-            token);
-
-        address wallet = component.getWallet();
+            token,
+            component.getWallet()); 
 
         // component type specific registration actions
         if (component.getType() == PRODUCT()) {
             IProductComponent product = IProductComponent(address(component));
             NftId poolNftId = product.getPoolNftId();
             require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
-            // validate pool token and product token are same
+            IPoolComponent pool = IPoolComponent(_registry.getObjectInfo(poolNftId).objectAddress);
 
             // register with tresury
             // implement and add validation
             NftId distributorNftId = zeroNftId();
-            instance.registerProduct(
+            instance.registerProductSetup(
                 nftId,
                 distributorNftId,
                 poolNftId,
                 token,
-                wallet,
                 product.getPolicyFee(),
-                product.getProcessingFee()
+                product.getProcessingFee(),
+                pool.getStakingFee(),
+                pool.getPerformanceFee()
             );
         } else if (component.getType() == POOL()) {
             IPoolComponent pool = IPoolComponent(address(component));
@@ -129,42 +129,27 @@ contract ComponentOwnerService is
                 nftId,
                 pool.isVerifying(),
                 pool.getCollateralizationLevel());
-
-            // register with tresury
-            instance.registerPool(
-                nftId,
-                wallet,
-                pool.getStakingFee(),
-                pool.getPerformanceFee());
         }
-        // TODO add distribution
+        // TODO add compensation
     }
 
     function lock(
         IBaseComponent component
     ) external override onlyRegisteredComponent(component) {
+        // TODO use msg.sender to get component and get instance via registered parent nft id
         IInstance instance = component.getInstance();
-        IComponent.ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info.state = PAUSED();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
+        NftId nftId = component.getNftId();
+        Key32 key = nftId.toKey32(COMPONENT());
+        instance.updateState(key, PAUSED());
     }
 
     function unlock(
         IBaseComponent component
     ) external override onlyRegisteredComponent(component) {
+        // TODO use msg.sender to get component and get instance via registered parent nft id
         IInstance instance = component.getInstance();
-        IComponent.ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info.state = ACTIVE();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
+        NftId nftId = component.getNftId();
+        Key32 key = nftId.toKey32(COMPONENT());
+        instance.updateState(key, ACTIVE());
     }
 }

package/contracts/instance/service/IProductService.sol

@@ -1,11 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {IRisk} from "../module/risk/IRisk.sol";
+import {IService} from "../base/IService.sol";
+
 import {NftId} from "../../types/NftId.sol";
+import {RiskId} from "../../types/RiskId.sol";
+import {StateId} from "../../types/StateId.sol";
 import {Timestamp} from "../../types/Timestamp.sol";
 import {UFixed} from "../../types/UFixed.sol";
 import {Fee} from "../../types/Fee.sol";
-import {IService} from "../base/IService.sol";
 
 interface IProductService is IService {
     function setFees(
@@ -13,8 +17,24 @@ interface IProductService is IService {
         Fee memory processingFee
     ) external;
 
+    function createRisk(
+        RiskId riskId,
+        bytes memory data
+    ) external;
+
+    function setRiskInfo(
+        RiskId riskId,
+        IRisk.RiskInfo memory data
+    ) external;
+
+    function updateRiskState(
+        RiskId riskId,
+        StateId state
+    ) external;
+
     function createApplication(
         address applicationOwner,
+        RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 premiumAmount,
         uint256 lifetime,

package/contracts/instance/service/PoolService.sol

@@ -50,8 +50,13 @@ contract PoolService is ComponentServiceBase, IPoolService {
         external
         override
     {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        instance.setPoolFees(info.nftId, stakingFee, performanceFee);
+        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+
+        NftId productNftId = instance.getProductNftId(poolInfo.nftId);
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
+        treasuryInfo.stakingFee = stakingFee;
+        treasuryInfo.performanceFee = performanceFee;
+        instance.setTreasuryInfo(productNftId, treasuryInfo);
     }
 
     function createBundle(
@@ -109,9 +114,10 @@ contract PoolService is ComponentServiceBase, IPoolService {
     {
         // process token transfer(s)
         if(stakingAmount > 0) {
-            TokenHandler tokenHandler = instance.getTokenHandler(poolNftId);
+            NftId productNftId = instance.getProductNftId(poolNftId);
+            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
             address bundleOwner = _registry.getOwner(bundleNftId);
-            address poolWallet = instance.getPoolSetup(poolNftId).wallet;
+            address poolWallet = instance.getComponentWallet(poolNftId);
 
             tokenHandler.transfer(
                 bundleOwner,