@etherisc/gif-next 0.0.2-f752d2a-551 → 0.0.2-f79a517-071

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

@@ -1,7 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 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 {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
 
 import {NftId} from "../../../types/NftId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
@@ -13,73 +17,48 @@ 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(
+    function registerProductSetup(
         NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
+        TreasuryInfo memory info
     ) 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
@@ -100,4 +79,6 @@ interface ITreasuryModule is ITreasury {
         uint256 a, 
         int8 exp
     ) external pure returns (UFixed);
+
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
 }

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

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 

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

@@ -1,103 +1,82 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 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 {UFixed, UFixedLib} from "../../../types/UFixed.sol";
 import {TokenHandler} from "./TokenHandler.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {ITreasuryModule} from "./ITreasury.sol";
-
-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
-    ) 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
-
-        // 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,
-            poolNftId,
-            token,
-            wallet,
-            policyFee,
-            processingFee
+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;
+    
+    modifier onlyComponentOwnerService() virtual {
+        require(
+            msg.sender == address(this.getComponentOwnerService()),
+            "ERROR:CMP-001:NOT_COPONENT_OWNER_SERVICE"
         );
+        _;
+    }
 
-        // TODO add logging
+    function _initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        //_initializeModuleBase(keyValueStore);
+        _initialize(keyValueStore);
+        _zeroFee = FeeLib.zeroFee();
     }
 
-    function setProductFees(
+    function registerProductSetup(
         NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component owner service)
+        TreasuryInfo memory setup
+    ) 
+        external
+        onlyComponentOwnerService
     {
-        // TODO add validation
-
-        ProductSetup storage setup = _productSetup[productNftId];
-        setup.policyFee = policyFee;
-        setup.processingFee = processingFee;
-
-        // TODO add logging
-    }
+        NftId poolNftId = setup.poolNftId;
+        NftId distributionNftId = setup.distributionNftId;
 
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component module)
-    {
-        // TODO add validation
+        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");
 
-        _poolSetup[poolNftId] = PoolSetup(
-            poolNftId,
-            wallet,
-            stakingFee,
-            performanceFee
-        );
+        // TODO deploy TokenHandler with separate contract to save space
+        // deploy product specific handler contract
+        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(setup.token));
+        _productNft[distributionNftId] = productNftId;
+        _productNft[poolNftId] = productNftId;
 
-        // TODO add logging
+        _create(TREASURY(), productNftId, abi.encode(setup));
     }
 
-    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 getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId) {
+        return _productNft[componentNftId];
     }
 
     function getTokenHandler(
@@ -106,23 +85,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,14 +111,14 @@ 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(
         uint256 a
     ) external pure override returns (UFixed) {
-        return UFixedMathLib.toUFixed(a);
+        return UFixedLib.toUFixed(a);
     }
 
     function getUFixed(
@@ -147,6 +126,6 @@ abstract contract TreasuryModule is ITreasuryModule {
         int8 exp
     ) external pure returns (UFixed)
     {
-        return UFixedMathLib.toUFixed(a, exp);
+        return UFixedLib.toUFixed(a, exp);
     }
 }