@etherisc/gif-next 0.0.2-78bf628-134 → 0.0.2-7b53731-045

package/contracts/instance/module/pool/PoolModule.sol

@@ -8,18 +8,22 @@ import {IPolicy, IPolicyModule} from "../../module/policy/IPolicy.sol";
 import {ITreasuryModule} from "../../module/treasury/ITreasury.sol";
 
 import {NftId} from "../../../types/NftId.sol";
+import {POOL} from "../../../types/ObjectType.sol";
 import {LibNftIdSet} from "../../../types/NftIdSet.sol";
 import {StateId, APPLIED} from "../../../types/StateId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
 
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {IPoolModule} from "./IPoolModule.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
 
 abstract contract PoolModule is
+    ModuleBase,
     IPoolModule
 {
     using LibNftIdSet for LibNftIdSet.Set;
 
-    mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
+    // mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
     mapping(NftId poolNftId => LibNftIdSet.Set bundles) private _bundlesForPool;
 
     modifier poolServiceCallingPool() {
@@ -30,6 +34,10 @@ abstract contract PoolModule is
         _;
     }
 
+    function initializePoolModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+    }
+
     function registerPool(
         NftId nftId, 
         bool isVerifying,
@@ -38,17 +46,12 @@ abstract contract PoolModule is
         public
         override
     {
-        require(
-            _poolInfo[nftId].nftId.eqz(), 
-            "ERROR:PL-010:ALREADY_CREATED");
-
-        _poolInfo[nftId] = PoolInfo(
-            nftId,
+        PoolInfo memory info  = PoolInfo(
             isVerifying,
             collateralizationRate
         );
 
-        // TODO add logging
+        _create(POOL(), nftId, abi.encode(info));
     }
 
     function addBundleToPool(
@@ -71,7 +74,7 @@ abstract contract PoolModule is
     function getPoolInfo(
         NftId nftId
     ) external view override returns (PoolInfo memory info) {
-        info = _poolInfo[nftId];
+        return abi.decode(_getData(POOL(), nftId), (PoolInfo));
     }
 
 

package/contracts/instance/module/risk/IRisk.sol

@@ -1,10 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-interface IRisk {
+import {NftId} from "../../../types/NftId.sol";
+import {RiskId} from "../../../types/RiskId.sol";
+import {StateId} from "../../../types/StateId.sol";
 
+interface IRisk {
+    struct RiskInfo {
+        NftId productNftId;
+        bytes data;
+    }
 }
 
 interface IRiskModule is IRisk {
-    
+    function createRisk(
+        RiskId riskId,
+        NftId productNftId,
+        bytes memory data
+    ) external;
+
+    function setRiskInfo(RiskId riskId, RiskInfo memory info) external;
+    function updateRiskState(RiskId riskId, StateId state) external;
+
+    function getRiskInfo(RiskId riskId) external view returns (RiskInfo memory info);
 }

package/contracts/instance/module/risk/RiskModule.sol

@@ -1,8 +1,62 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {NftId} from "../../../types/NftId.sol";
+import {RISK} from "../../../types/ObjectType.sol";
+import {RiskId} from "../../../types/RiskId.sol";
+import {StateId} from "../../../types/StateId.sol";
+
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {IRiskModule} from "./IRisk.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
+
+contract RiskModule is
+    ModuleBase,
+    IRiskModule
+{
+    function initializeRiskModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+    }
+
+    function createRisk(
+        RiskId riskId,
+        NftId productNftId,
+        bytes memory data
+    ) external override {
+        RiskInfo memory info = RiskInfo(
+            productNftId,
+            data
+        );
+
+        _create(RISK(), riskId.toKey32(), abi.encode(info));
+    }
+
+    function setRiskInfo(
+        RiskId riskId, 
+        RiskInfo memory info
+    )
+        external
+        override
+    {
+
+    }
+
+    function updateRiskState(
+        RiskId riskId, 
+        StateId state
+    )
+        external
+        override
+    {
+
+    }
+
+    function getRiskInfo(RiskId riskId)
+        external
+        view
+        override
+        returns (RiskInfo memory info)
+    {
 
-contract RiskModule is IRiskModule {
-    
+    }
 }

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

@@ -2,6 +2,9 @@
 pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
+import {IPoolComponent} from "../../../components/IPoolComponent.sol";
+import {IProductComponent} from "../../../components/IProductComponent.sol";
 
 import {NftId} from "../../../types/NftId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
@@ -13,73 +16,49 @@ 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 poolNftId;
+        NftId distributionNftId;
         IERC20Metadata token;
-        address wallet;
-        Fee policyFee;
-        Fee processingFee;
-    }
-
-    struct DistributorSetup {
-        NftId distributorNftId;
-        address wallet;
-        Fee commissionFee;
-    }
-
-    struct PoolSetup {
-        NftId poolNftId;
-        address wallet;
-        Fee stakingFee;
-        Fee performanceFee;
+        Fee productFee; // product fee on net premium
+        Fee processingFee; // product fee on payout amounts
+        Fee poolFee; // pool fee on net premium
+        Fee stakingFee; // pool fee on staked capital from investor
+        Fee performanceFee; // pool fee on profits from capital investors
+        Fee distributionFee; // default distribution fee (no referral id)
     }
 }
 
 interface ITreasuryModule is ITreasury {
 
-    function registerProduct(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
+    function registerProductSetup(
+        IProductComponent product,
+        IPoolComponent pool,
+        IDistributionComponent distribution
     ) external;
 
-    function setProductFees(
+    function setTreasuryInfo(
         NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
+        TreasuryInfo memory info
     ) external;
 
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
+    function hasTreasuryInfo(
+        NftId productNftId
+    ) external view returns (bool hasInfo);
 
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
+    function getTreasuryInfo(
+        NftId productNftId
+    ) external view returns (TreasuryInfo memory info);
+
+    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 +69,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

@@ -2,102 +2,88 @@
 pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
+import {IPoolComponent} from "../../../components/IPoolComponent.sol";
+import {IProductComponent} from "../../../components/IProductComponent.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(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
+    function registerProductSetup(
+        IProductComponent product,
+        IPoolComponent pool,
+        IDistributionComponent distribution
     ) 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
+        NftId productNftId = product.getNftId();
+        NftId poolNftId = pool.getNftId();
+        NftId distributionNftId = distribution.getNftId();
+
+        require(productNftId.gtz(), "ERROR:TRS-010:PRODUCT_UNDEFINED");
+        require(poolNftId.gtz(), "ERROR:TRS-011:POOL_UNDEFINED");
+
+        require(address(_tokenHandler[productNftId]) == address(0), "ERROR:TRS-012:TOKEN_HANDLER_ALREADY_REGISTERED");
+        require(_productNft[poolNftId].eqz(), "ERROR:TRS-013:POOL_ALREADY_LINKED");
+        require(_productNft[distributionNftId].eqz(), "ERROR:TRS-014:COMPENSATION_ALREADY_LINKED");
 
         // deploy product specific handler contract
-        TokenHandler tokenHandler = new TokenHandler(productNftId, address(token));
-        _tokenHandler[productNftId] = tokenHandler;
-        _tokenHandler[poolNftId] = tokenHandler;
-        _tokenHandler[distributorNftId] = tokenHandler;
-
-        // create product setup
-        _productSetup[productNftId] = ProductSetup(
-            productNftId,
-            distributorNftId,
+        IERC20Metadata token = product.getToken();
+        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(token));
+        _productNft[distributionNftId] = productNftId;
+        _productNft[poolNftId] = productNftId;
+
+        TreasuryInfo memory info = TreasuryInfo(
             poolNftId,
+            distributionNftId,
             token,
-            wallet,
-            policyFee,
-            processingFee
+            product.getProductFee(),
+            product.getProcessingFee(),
+            pool.getPoolFee(),
+            pool.getStakingFee(),
+            pool.getPerformanceFee(),
+            distribution.getDistributionFee()
         );
 
-        // TODO add logging
+        _create(TREASURY(), productNftId, abi.encode(info));
     }
 
-    function setProductFees(
+    function setTreasuryInfo(
         NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component owner service)
+        TreasuryInfo memory info
+    )
+        external
+        // TODO add authz (only component module)
+        override
     {
-        // TODO add validation
-
-        ProductSetup storage setup = _productSetup[productNftId];
-        setup.policyFee = policyFee;
-        setup.processingFee = processingFee;
-
-        // TODO add logging
+        _updateData(TREASURY(), productNftId, abi.encode(info));
     }
 
-    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,
-            stakingFee,
-            performanceFee
-        );
-
-        // TODO add logging
-    }
-
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component owner service)
-    {
-        // TODO add validation
-
-        PoolSetup storage setup = _poolSetup[poolNftId];
-        setup.stakingFee = stakingFee;
-        setup.performanceFee = performanceFee;
-
-        // TODO add logging
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId) {
+        return _productNft[componentNftId];
     }
 
     function getTokenHandler(
@@ -106,23 +92,23 @@ abstract contract TreasuryModule is ITreasuryModule {
         return _tokenHandler[componentNftId];
     }
 
-    function getProductSetup(
+    function hasTreasuryInfo(
         NftId productNftId
-    ) external view override returns (ProductSetup memory setup) {
-        return _productSetup[productNftId];
+    ) public view override returns (bool hasInfo) {
+        return _exists(TREASURY(), productNftId);
     }
 
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view override returns (PoolSetup memory setup) {
-        return _poolSetup[poolNftId];
+    function getTreasuryInfo(
+        NftId productNftId
+    ) public view override returns (TreasuryInfo memory info) {
+        return abi.decode(_getData(TREASURY(), productNftId), (TreasuryInfo));
     }
 
     function calculateFeeAmount(
         uint256 amount,
         Fee memory fee
     ) public pure override returns (uint256 feeAmount, uint256 netAmount) {
-        return FeeLib.calculateFee(amount, fee);
+        return FeeLib.calculateFee(fee, amount);
     }
 
     function getFee(
@@ -132,8 +118,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

@@ -15,14 +15,16 @@ 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, COMPONENT, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
+import {ObjectType, COMPONENT, PRODUCT, ORACLE, POOL, DISTRIBUTION} 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";
 
+import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
+import {IPoolComponent} from "../../components/IPoolComponent.sol";
 import {IProductComponent} from "../../components/IProductComponent.sol";
 import {ServiceBase} from "../base/ServiceBase.sol";
 import {IComponentOwnerService} from "./IComponentOwnerService.sol";
@@ -71,6 +73,9 @@ contract ComponentOwnerService is
         if (cType == POOL()) {
             return POOL_OWNER_ROLE();
         }
+        if (cType == DISTRIBUTION()) {
+            return DISTRIBUTION_OWNER_ROLE();
+        }
         if (cType == ORACLE()) {
             return ORACLE_OWNER_ROLE();
         }
@@ -98,28 +103,25 @@ contract ComponentOwnerService is
 
         instance.registerComponent(
             nftId,
-            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);
+
+            NftId distributionNftId = product.getDistributionNftId();
+            IDistributionComponent distribution = IDistributionComponent(_registry.getObjectInfo(distributionNftId).objectAddress);
 
             // register with tresury
-            // implement and add validation
-            NftId distributorNftId = zeroNftId();
-            instance.registerProduct(
-                nftId,
-                distributorNftId,
-                poolNftId,
-                token,
-                wallet,
-                product.getPolicyFee(),
-                product.getProcessingFee()
+            instance.registerProductSetup(
+                product,
+                pool,
+                distribution
             );
         } else if (component.getType() == POOL()) {
             IPoolComponent pool = IPoolComponent(address(component));
@@ -129,15 +131,8 @@ 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(

package/contracts/instance/service/DistributionService.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {ITreasury} from "../../instance/module/treasury/ITreasury.sol";
+
+import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {DISTRIBUTION} from "../../types/ObjectType.sol";
+import {Version, VersionLib} from "../../types/Version.sol";
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+
+import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {IDistributionService} from "./IDistributionService.sol";
+
+contract DistributionService is
+    ComponentServiceBase,
+    IDistributionService
+{
+    string public constant NAME = "DistributionService";
+
+    constructor(
+        address registry,
+        NftId registryNftId
+    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+    {
+        _registerInterface(type(IDistributionService).interfaceId);
+    }
+
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(3,0,0);
+    }
+
+    function getName() external pure override returns(string memory name) {
+        return NAME;
+    }
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory distributionInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
+
+        NftId productNftId = instance.getProductNftId(distributionInfo.nftId);
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
+        treasuryInfo.distributionFee = distributionFee;
+        instance.setTreasuryInfo(productNftId, treasuryInfo);
+    }
+}

package/contracts/instance/service/IDistributionService.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {IService} from "../base/IService.sol";
+
+interface IDistributionService is IService {
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+}

package/contracts/instance/service/IPoolService.sol

@@ -7,17 +7,24 @@ import {IService} from "../base/IService.sol";
 
 interface IPoolService is IService {
     function setFees(
+        Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     ) external;
 
     function createBundle(
         address owner,
+        Fee memory fee, 
         uint256 amount,
         uint256 lifetime, 
         bytes calldata filter
     ) external returns(NftId bundleNftId);
 
+    function setBundleFee(
+        NftId bundleNftId,
+        Fee memory fee
+    ) external;
+
     // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
     // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);