@etherisc/gif-next 0.0.2-efef0ea-320 → 0.0.2-f02157b-803

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

@@ -1,82 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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";
-import {Fee} from "../../../types/Fee.sol";
-
-import {TokenHandler} from "./TokenHandler.sol";
-
-interface ITreasury {
-    // TODO add events
-    // TODO add errors
-
-    // treasury info is linked to product nft id
-    struct TreasuryInfo {
-        NftId poolNftId;
-        NftId distributionNftId;
-        IERC20Metadata token;
-        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 registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
-    ) external;
-
-    function setTreasuryInfo(
-        NftId productNftId,
-        TreasuryInfo memory info
-    ) external;
-
-    function hasTreasuryInfo(
-        NftId productNftId
-    ) external view returns (bool hasInfo);
-
-    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 calculateFeeAmount(
-        uint256 amount,
-        Fee memory fee
-    ) external pure returns (uint256 feeAmount, uint256 netAmount);
-
-    function getFee(
-        UFixed fractionalFee, 
-        uint256 fixedFee
-    ) external pure returns (Fee memory fee);
-
-    function getZeroFee() external view returns (Fee memory fee);
-
-    function getUFixed(
-        uint256 a
-    ) external pure returns (UFixed);
-
-    function getUFixed(
-        uint256 a, 
-        int8 exp
-    ) external pure returns (UFixed);
-}

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

@@ -1,48 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {NftId} from "../../../types/NftId.sol";
-
-contract TokenHandler {
-    NftId private _productNftId;
-    IERC20Metadata private _token;
-
-    constructor(
-        NftId productNftId,
-        address token
-    )
-    {
-        _productNftId = productNftId;
-        _token = IERC20Metadata(token);
-    }
-
-    // TODO add logging
-    function transfer(
-        address from,
-        address to,
-        uint256 amount
-    )
-        external // TODO add authz (only treasury/instance/product/pool/ service)
-    {
-        // TODO switch to oz safeTransferFrom
-        _token.transferFrom(from, to, amount);
-    }
-
-    function getProductNftId()
-        external
-        view
-        returns(NftId)
-    {
-        return _productNftId;
-    }
-
-    function getToken()
-        external
-        view
-        returns(IERC20Metadata)
-    {
-        return _token;
-    }
-}

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

@@ -1,138 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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();
-    }
-
-    function registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
-    ) external override // TODO add authz (only component module)
-    {
-        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
-        IERC20Metadata token = product.getToken();
-        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(token));
-        _productNft[distributionNftId] = productNftId;
-        _productNft[poolNftId] = productNftId;
-
-        TreasuryInfo memory info = TreasuryInfo(
-            poolNftId,
-            distributionNftId,
-            token,
-            product.getProductFee(),
-            product.getProcessingFee(),
-            pool.getPoolFee(),
-            pool.getStakingFee(),
-            pool.getPerformanceFee(),
-            distribution.getDistributionFee()
-        );
-
-        _create(TREASURY(), productNftId, abi.encode(info));
-    }
-
-    function setTreasuryInfo(
-        NftId productNftId,
-        TreasuryInfo memory info
-    )
-        external
-        // TODO add authz (only component module)
-        override
-    {
-        _updateData(TREASURY(), productNftId, abi.encode(info));
-    }
-
-    function getProductNftId(
-        NftId componentNftId
-    ) external view returns (NftId productNftId) {
-        return _productNft[componentNftId];
-    }
-
-    function getTokenHandler(
-        NftId componentNftId
-    ) external view override returns (TokenHandler tokenHandler) {
-        return _tokenHandler[componentNftId];
-    }
-
-    function hasTreasuryInfo(
-        NftId productNftId
-    ) public view override returns (bool hasInfo) {
-        return _exists(TREASURY(), productNftId);
-    }
-
-    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(fee, amount);
-    }
-
-    function getFee(
-        UFixed fractionalFee, 
-        uint256 fixedFee
-    ) external pure override returns (Fee memory fee) {
-        return FeeLib.toFee(fractionalFee, fixedFee);
-    }
-
-    function getZeroFee() external view override returns (Fee memory fee) {
-        return _zeroFee;
-    }
-
-    function getUFixed(
-        uint256 a
-    ) external pure override returns (UFixed) {
-        return UFixedMathLib.toUFixed(a);
-    }
-
-    function getUFixed(
-        uint256 a, 
-        int8 exp
-    ) external pure returns (UFixed)
-    {
-        return UFixedMathLib.toUFixed(a, exp);
-    }
-}

package/contracts/instance/service/DistributionService.sol

@@ -1,59 +0,0 @@
-// 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/PoolService.sol

@@ -1,149 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IBundle} from "../../instance/module/bundle/IBundle.sol";
-import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-import {POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {Fee} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
-import {IPoolService} from "./IPoolService.sol";
-
-
-contract PoolService is ComponentServiceBase, IPoolService {
-    using NftIdLib for NftId;
-
-    string public constant NAME = "PoolService";
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
-    {
-        _registerInterface(type(IPoolService).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 poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-
-        NftId productNftId = instance.getProductNftId(poolInfo.nftId);
-        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
-        treasuryInfo.poolFee = poolFee;
-        treasuryInfo.stakingFee = stakingFee;
-        treasuryInfo.performanceFee = performanceFee;
-        instance.setTreasuryInfo(productNftId, treasuryInfo);
-    }
-
-    function createBundle(
-        address owner, 
-        Fee memory fee, 
-        uint256 stakingAmount, 
-        uint256 lifetime, 
-        bytes calldata filter
-    )
-        external
-        override
-        returns(NftId bundleNftId)
-    {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-
-        // register bundle with registry
-        NftId poolNftId = info.nftId;
-        bundleNftId = _registry.registerObjectForInstance(
-            poolNftId, 
-            BUNDLE(), 
-            owner,
-            "");
-
-        // create bundle info in instance
-        instance.createBundleInfo(
-            bundleNftId,
-            poolNftId,
-            fee,
-            stakingAmount,
-            lifetime,
-            filter);
-
-        // add bundle to pool in instance
-        instance.addBundleToPool(
-            bundleNftId,
-            poolNftId,
-            stakingAmount);
-
-        // collect capital
-        _processStakingByTreasury(
-            instance,
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
-
-        // TODO add logging
-    }
-
-    function setBundleFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        IBundle.BundleInfo memory bundleInfo = instance.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId.gtz(), "ERROR:PLS-010:BUNDLE_UNKNOWN");
-        require(poolInfo.nftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
-        bundleInfo.fee = fee;
-        instance.setBundleInfo(bundleNftId, bundleInfo);
-    }
-
-
-    function _processStakingByTreasury(
-        IInstance instance,
-        NftId poolNftId,
-        NftId bundleNftId,
-        uint256 stakingAmount
-    )
-        internal
-    {
-        // process token transfer(s)
-        if(stakingAmount > 0) {
-            NftId productNftId = instance.getProductNftId(poolNftId);
-            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
-            address bundleOwner = _registry.getOwner(bundleNftId);
-            address poolWallet = instance.getComponentWallet(poolNftId);
-
-            tokenHandler.transfer(
-                bundleOwner,
-                poolWallet,
-                stakingAmount
-            );
-        }
-    }
-}