@etherisc/gif-next 0.0.2-d3ee0cc-268 → 0.0.2-d442a8c-073

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

@@ -1,152 +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 {Fee, FeeLib} from "../../../types/Fee.sol";
-import {UFixed, UFixedMathLib} from "../../../types/UFixed.sol";
-import {TokenHandler} from "./TokenHandler.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
-        );
-
-        // 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,
-            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 getTokenHandler(
-        NftId componentNftId
-    ) external view override returns (TokenHandler tokenHandler) {
-        return _tokenHandler[componentNftId];
-    }
-
-    function getProductSetup(
-        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];
-    }
-
-    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 pure override returns (Fee memory fee) {
-        return FeeLib.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/ComponentOwnerService.sol

@@ -1,170 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../IInstance.sol";
-
-import {ITreasuryModule} from "../module/treasury/ITreasury.sol";
-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 {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 {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {ServiceBase} from "../base/ServiceBase.sol";
-import {IComponentOwnerService} from "./IComponentOwnerService.sol";
-
-contract ComponentOwnerService is
-    ServiceBase,
-    IComponentOwnerService
-{
-    using NftIdLib for NftId;
-
-    string public constant NAME = "ComponentOwnerService";
-
-    modifier onlyRegisteredComponent(IBaseComponent component) {
-        NftId nftId = _registry.getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    ) ServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
-    {
-
-    }
-
-    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 getRoleForType(
-        ObjectType cType
-    ) public pure override returns (RoleId role) {
-        if (cType == PRODUCT()) {
-            return PRODUCT_OWNER_ROLE();
-        }
-        if (cType == POOL()) {
-            return POOL_OWNER_ROLE();
-        }
-        if (cType == ORACLE()) {
-            return ORACLE_OWNER_ROLE();
-        }
-    }
-
-    function register(
-        IBaseComponent component
-    ) external override returns (NftId nftId) {
-        address initialOwner = component.getOwner();
-        require(
-            msg.sender == address(component),
-            "ERROR:COS-003:NOT_COMPONENT"
-        );
-
-        IInstance instance = component.getInstance();
-        ObjectType objectType = component.getType();
-        RoleId typeRole = getRoleForType(objectType);
-        require(
-            instance.hasRole(typeRole, initialOwner),
-            "ERROR:CMP-004:TYPE_ROLE_MISSING"
-        );
-
-        nftId = _registry.register(address(component));
-        IERC20Metadata token = component.getToken();
-
-        instance.registerComponent(
-            nftId,
-            objectType,
-            token);
-
-        address wallet = 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
-
-            // register with tresury
-            // implement and add validation
-            NftId distributorNftId = zeroNftId();
-            instance.registerProduct(
-                nftId,
-                distributorNftId,
-                poolNftId,
-                token,
-                wallet,
-                product.getPolicyFee(),
-                product.getProcessingFee()
-            );
-        } else if (component.getType() == POOL()) {
-            IPoolComponent pool = IPoolComponent(address(component));
-
-            // register with pool
-            instance.registerPool(
-                nftId,
-                pool.isVerifying(),
-                pool.getCollateralizationLevel());
-
-            // register with tresury
-            instance.registerPool(
-                nftId,
-                wallet,
-                pool.getStakingFee(),
-                pool.getPerformanceFee());
-        }
-        // TODO add distribution
-    }
-
-    function lock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        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);
-    }
-
-    function unlock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        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);
-    }
-}

package/contracts/instance/service/IComponentOwnerService.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {RoleId} from "../../types/RoleId.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IService} from "../base/IService.sol";
-
-// TODO rename to registry service
-interface IComponentOwnerService is IService {
-
-    function register(IBaseComponent component) external returns(NftId componentNftId);
-
-    // TODO move to product/pool services
-    function lock(IBaseComponent component) external;
-
-    // TODO move to product/pool services
-    function unlock(IBaseComponent component) external;
-
-    function getRoleForType(ObjectType cType) external pure returns (RoleId role);
-}

package/contracts/instance/service/IPoolService.sol

@@ -1,30 +0,0 @@
-// 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 IPoolService is IService {
-    function setFees(
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    function createBundle(
-        address owner,
-        uint256 amount,
-        uint256 lifetime, 
-        bytes calldata filter
-    ) external returns(NftId bundleNftId);
-
-    // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
-
-    // function lockBundle(NftId bundleNftId) external;
-
-    // function unlockBundle(NftId bundleNftId) external;
-
-    // function closeBundle(NftId bundleNftId) external;
-}

package/contracts/instance/service/IProductService.sol

@@ -1,58 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.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(
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-
-    function createApplication(
-        address applicationOwner,
-        uint256 sumInsuredAmount,
-        uint256 premiumAmount,
-        uint256 lifetime,
-        NftId bundleNftId
-    ) external returns (NftId nftId);
-
-    // function revoke(unit256 nftId) external;
-
-    /**
-     * @dev underwrites the policy represented by {policyNftId}.
-     * optionally collects premiums and activates the policy.
-     * - premium payment is only attempted if requirePremiumPayment is set to true
-     * - activation is only done if activateAt is a non-zero timestamp
-     */
-    function underwrite(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    ) external;
-
-    // function decline(uint256 nftId) external;
-    // function expire(uint256 nftId) external;
-
-    function collectPremium(NftId nftId, Timestamp activateAt) external;
-
-    function activate(NftId nftId, Timestamp activateAt) external;
-
-
-    function close(NftId nftId) external;
-
-    // function createClaim(uint256 nftId, uint256 claimAmount) external;
-    // function confirmClaim(uint256 nftId, uint256 claimId, uint256 claimAmount) external;
-    // function declineClaim(uint256 nftId, uint256 claimId) external;
-    // function closeClaim(uint256 nftId, uint256 claimId) external;
-
-    function calculateRequiredCollateral(
-        UFixed collateralizationLevel, 
-        uint256 sumInsuredAmount
-    ) external pure returns(uint256 collateralAmount);
-
-}

package/contracts/instance/service/PoolService.sol

@@ -1,123 +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 info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        instance.setPoolFees(info.nftId, stakingFee, performanceFee);
-    }
-
-    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) {
-            TokenHandler tokenHandler = instance.getTokenHandler(poolNftId);
-            address bundleOwner = _registry.getOwner(bundleNftId);
-            address poolWallet = instance.getPoolSetup(poolNftId).wallet;
-
-            tokenHandler.transfer(
-                bundleOwner,
-                poolWallet,
-                stakingAmount
-            );
-        }
-    }
-}