@etherisc/gif-next 0.0.2-e875d61-189 → 0.0.2-eb13b47-989

package/contracts/instance/module/policy/PolicyModule.sol

@@ -1,89 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../../registry/IRegistry.sol";
-
-import {IProductService} from "../../service/IProductService.sol";
-import {IPolicy, IPolicyModule} from "./IPolicy.sol";
-import {ObjectType, POLICY} from "../../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../../types/NftId.sol";
-import {StateId} from "../../../types/StateId.sol";
-import {Timestamp, blockTimestamp, zeroTimestamp} from "../../../types/Timestamp.sol";
-
-import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
-import {ModuleBase} from "../../base/ModuleBase.sol";
-
-abstract contract PolicyModule is
-    ModuleBase,
-    IPolicyModule
-{
-
-    // TODO find a better place to avoid dupliation
-    modifier onlyProductService2() {
-        require(
-            msg.sender == address(this.getProductService()),
-            "ERROR:POL-001:NOT_PRODUCT_SERVICE"
-        );
-        _;
-    }
-
-    function initializePolicyModule(IKeyValueStore keyValueStore) internal {
-        _initialize(keyValueStore);
-    }
-
-    function createPolicyInfo(
-        NftId policyNftId,
-        NftId productNftId,
-        uint256 sumInsuredAmount,
-        uint256 premiumAmount,
-        uint256 lifetime,
-        NftId bundleNftId
-    )
-        external
-        onlyProductService2
-        override
-    {
-        PolicyInfo memory info = PolicyInfo(
-            productNftId,
-            bundleNftId,
-            address(0), // beneficiary = policy nft holder
-            sumInsuredAmount,
-            premiumAmount,
-            0, // premium paid amount
-            lifetime, 
-            "", // applicationData
-            "", // policyData
-            zeroTimestamp(), // activatedAt
-            zeroTimestamp(), // expiredAt
-            zeroTimestamp() // closedAt
-        );
-
-        _create(POLICY(), policyNftId, abi.encode(info));
-    }
-
-    function setPolicyInfo(NftId policyNftId, PolicyInfo memory info)
-        external
-        override
-        onlyProductService2
-    {
-        _updateData(POLICY(), policyNftId, abi.encode(info));
-    }
-
-    function updatePolicyState(NftId bundleNftId, StateId state)
-        external
-        override
-        onlyProductService2
-    {
-        _updateState(POLICY(), bundleNftId, state);
-    }
-
-    function getPolicyInfo(
-        NftId nftId
-    ) external view returns (PolicyInfo memory info) {
-        return abi.decode(_getData(POLICY(), nftId), (PolicyInfo));
-    }
-
-    function getPolicyState(NftId nftId) external view override returns(StateId state) {
-        return _getState(POLICY(), nftId);
-    }
-}

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

@@ -1,40 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../../registry/IRegistry.sol";
-import {NftId} from "../../../types/NftId.sol";
-import {UFixed} from "../../../types/UFixed.sol";
-import {IProductService} from "../../service/IProductService.sol";
-import {IPoolService} from "../../service/IPoolService.sol";
-
-interface IPool {
-    struct PoolInfo {
-        bool isVerifying;
-        UFixed collateralizationLevel;
-    }
-}
-
-interface IPoolModule is IPool {
-
-    function registerPool(
-        NftId poolNftId, 
-        bool isVerifying, 
-        UFixed collateralizationLevel
-    ) external;
-
-    function addBundleToPool(
-        NftId bundleNftId,
-        NftId poolNftId,
-        uint256 amount
-    ) external;
-
-    function getPoolInfo(
-        NftId nftId
-    ) external view returns (PoolInfo memory info);
-
-    function getBundleCount(NftId poolNftId) external view returns (uint256 bundleCount);
-    function getBundleNftId(NftId poolNftId, uint256 index) external view returns (NftId bundleNftId);
-
-    // repeat service linked signatures to avoid linearization issues
-    function getPoolService() external returns(IPoolService);
-}

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

@@ -1,90 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../../registry/IRegistry.sol";
-import {IProductService} from "../../service/IProductService.sol";
-import {IPoolService} from "../../service/IPoolService.sol";
-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 => LibNftIdSet.Set bundles) private _bundlesForPool;
-
-    modifier poolServiceCallingPool() {
-        require(
-            msg.sender == address(this.getPoolService()),
-            "ERROR:PL-001:NOT_POOL_SERVICE"
-        );
-        _;
-    }
-
-    function initializePoolModule(IKeyValueStore keyValueStore) internal {
-        _initialize(keyValueStore);
-    }
-
-    function registerPool(
-        NftId nftId, 
-        bool isVerifying,
-        UFixed collateralizationRate
-    )
-        public
-        override
-    {
-        PoolInfo memory info  = PoolInfo(
-            isVerifying,
-            collateralizationRate
-        );
-
-        _create(POOL(), nftId, abi.encode(info));
-    }
-
-    function addBundleToPool(
-        NftId bundleNftId,
-        NftId poolNftId,
-        uint256 // amount
-    )
-        external
-        override
-    {
-        LibNftIdSet.Set storage bundleSet = _bundlesForPool[poolNftId];
-        require(
-            !bundleSet.contains(bundleNftId),
-            "ERROR:PL-020:BUNDLE_ALREADY_ADDED");
-
-        bundleSet.add(bundleNftId);
-    }
-
-
-    function getPoolInfo(
-        NftId nftId
-    ) external view override returns (PoolInfo memory info) {
-        return abi.decode(_getData(POOL(), nftId), (PoolInfo));
-    }
-
-
-    function getBundleCount(NftId poolNftId) external view override returns (uint256 bundleCount) {
-        return _bundlesForPool[poolNftId].getLength();
-    }
-
-
-    function getBundleNftId(NftId poolNftId, uint256 index) external view override returns (NftId bundleNftId) {
-        return _bundlesForPool[poolNftId].getElementAt(index);
-    }
-
-}

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

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IRisk {
-
-}
-
-interface IRiskModule is IRisk {
-    
-}

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

@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRiskModule} from "./IRisk.sol";
-
-import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
-import {ModuleBase} from "../../base/ModuleBase.sol";
-
-contract RiskModule is
-    ModuleBase,
-    IRiskModule
-{
-    function initializeRiskModule(IKeyValueStore keyValueStore) internal {
-        _initialize(keyValueStore);
-    }
-
-}

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

@@ -1,96 +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";
-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 compensationNftId;
-        NftId poolNftId;
-        IERC20Metadata token;
-        Fee commissionFee;
-        Fee policyFee;
-        Fee processingFee;
-        Fee stakingFee;
-        Fee performanceFee;
-    }
-}
-
-interface ITreasuryModule is ITreasury {
-
-    function registerProductSetup(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        Fee memory policyFee,
-        Fee memory processingFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    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 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,171 +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";
-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(
-        NftId productNftId,
-        NftId compensationNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        Fee memory policyFee,
-        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(_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;
-        _productNft[compensationNftId] = productNftId;
-        _productNft[poolNftId] = productNftId;
-
-        TreasuryInfo memory info = TreasuryInfo(
-            compensationNftId,
-            poolNftId,
-            token,
-            _zeroFee,
-            policyFee,
-            processingFee,
-            stakingFee,
-            performanceFee
-        );
-
-        _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 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(
-        NftId componentNftId
-    ) external view override returns (TokenHandler tokenHandler) {
-        return _tokenHandler[componentNftId];
-    }
-
-    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);
-    }
-
-    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/PoolService.sol

@@ -1,129 +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, 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 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.stakingFee = stakingFee;
-        treasuryInfo.performanceFee = performanceFee;
-        instance.setTreasuryInfo(productNftId, treasuryInfo);
-    }
-
-    function createBundle(
-        address owner, 
-        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,
-            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 _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
-            );
-        }
-    }
-}