@etherisc/gif-next 0.0.2-7878646-744 → 0.0.2-788faba-168

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

@@ -1,62 +0,0 @@
-// 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)
-    {
-
-    }
-}

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

@@ -1,84 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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";
-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(
-        NftId productNftId,
-        TreasuryInfo memory info
-    ) 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);
-
-    function getComponentOwnerService() external view returns(IComponentOwnerService);
-}

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

@@ -1,48 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-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,131 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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, UFixedLib} 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;
-    
-    modifier onlyComponentOwnerService() virtual {
-        require(
-            msg.sender == address(this.getComponentOwnerService()),
-            "ERROR:CMP-001:NOT_COPONENT_OWNER_SERVICE"
-        );
-        _;
-    }
-
-    function _initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
-        //_initializeModuleBase(keyValueStore);
-        _initialize(keyValueStore);
-        _zeroFee = FeeLib.zeroFee();
-    }
-
-    function registerProductSetup(
-        NftId productNftId,
-        TreasuryInfo memory setup
-    ) 
-        external
-        onlyComponentOwnerService
-    {
-        NftId poolNftId = setup.poolNftId;
-        NftId distributionNftId = setup.distributionNftId;
-
-        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");
-
-        // 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;
-
-        _create(TREASURY(), productNftId, abi.encode(setup));
-    }
-
-    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 UFixedLib.toUFixed(a);
-    }
-
-    function getUFixed(
-        uint256 a, 
-        int8 exp
-    ) external pure returns (UFixed)
-    {
-        return UFixedLib.toUFixed(a, exp);
-    }
-}

package/contracts/instance/service/ComponentOwnerService.sol

@@ -1,315 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../IInstance.sol";
-
-import {ITreasury, 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 {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, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-import {ObjectType, TOKEN, 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 {UFixed, UFixedLib} from "../../types/UFixed.sol";
-
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {IService} from "../base/IService.sol";
-import {IComponentOwnerService} from "./IComponentOwnerService.sol";
-import {ServiceBase} from "../base/ServiceBase.sol";
-import {IPool, IPoolModule} from "../module/pool/IPoolModule.sol";
-
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-
-contract ComponentOwnerService is
-    ServiceBase,
-    IComponentOwnerService
-{
-    using NftIdLib for NftId;
-
-    error MissingTypeRole();
-    error WalletIsZero();
-    error InvalidToken();
-    error InvalidPool();
-    error InvalidDistribution();
-    error InvalidPoolsInstance();
-    error InvalidDistributionsInstance();
-
-    error CollateralizationLevelIsZero();
-
-    string public constant NAME = "ComponentOwnerService";
-
-    modifier onlyRegisteredComponent(IBaseComponent component) {
-        NftId nftId = getRegistry().getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId registryNftId,
-        address initialOwner
-    )
-    {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
-        _registerInterface(type(IComponentOwnerService).interfaceId);
-    }
-
-    function getName() public pure override(IService, ServiceBase) 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 == DISTRIBUTION()) {
-            return DISTRIBUTION_OWNER_ROLE();
-        }
-        if (cType == ORACLE()) {
-            return ORACLE_OWNER_ROLE();
-        }
-    }
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
-        return IRegistryService(service);
-    }
-
-    function registerProduct(	
-        IBaseComponent product
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerProduct(
-            product,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(PRODUCT());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-        
-        _registerProduct(
-                info.nftId, 
-                instanceNftId,
-                instance,
-                data
-        );
-    }
-
-    function registerPool(	
-        IBaseComponent pool
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerPool(
-            pool,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(POOL());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // } 
-
-        _registerPool(
-            info.nftId,
-            instanceNftId,
-            instance,
-            data
-        );
-    }
-
-    function registerDistribution(	
-        IBaseComponent distribution
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerDistribution(
-            distribution,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(DISTRIBUTION());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-    }
-
-    function lock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        instance.updateState(key, PAUSED());
-    }
-
-    function unlock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        instance.updateState(key, ACTIVE());
-    }
-
-    // Internals
-
-    function _registerProduct(
-        NftId nftId, 
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        (
-            ITreasury.TreasuryInfo memory info,
-            address wallet
-        )  = abi.decode(data, (ITreasury.TreasuryInfo, address));
-
-        IRegistry _registry = getRegistry();
-
-        if(wallet == address(0)) {
-            revert WalletIsZero();
-        }
-
-        IRegistry.ObjectInfo memory tokenInfo = _registry.getObjectInfo(address(info.token));
-
-        if(tokenInfo.objectType != TOKEN()) {
-            revert InvalidToken();
-        } 
-
-        IRegistry.ObjectInfo memory poolInfo = _registry.getObjectInfo(info.poolNftId);
-
-        if(poolInfo.objectType != POOL()) {
-            revert InvalidPool();
-        }
-
-        if(poolInfo.parentNftId != instanceNftId) {
-            revert InvalidPoolsInstance();
-        }
-        // TODO pool have the same token
-        //ITreasury.PoolSetup memory poolSetup = instance.getPoolSetup(info.poolNftId);
-        //require(tokenInfo.objectAddress == address(poolSetup.token), "ERROR:COS-018:PRODUCT_POOL_TOKEN_MISMATCH");
-        // TODO pool is not linked
-
-        IRegistry.ObjectInfo memory distributionInfo = _registry.getObjectInfo(info.distributionNftId);
-
-        if(distributionInfo.objectType != DISTRIBUTION()) {
-            revert  InvalidDistribution();
-        } 
-
-        if(distributionInfo.parentNftId != instanceNftId) {
-            revert InvalidDistributionsInstance();
-        }
-        // TODO distribution have the same token
-        // TODO distribution is not linked
-
-        // component module
-        instance.registerComponent(
-            nftId,
-            info.token,
-            wallet // TODO move wallet into TreasuryInfo?
-        );
-
-        // treasury module
-        instance.registerProductSetup(
-            nftId, 
-            info
-        );
-    }
-
-    function _registerPool(
-        NftId nftId,
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        (
-            IPool.PoolInfo memory info,
-            address wallet,
-            IERC20Metadata token,
-            /*poolFee*/,
-            /*stakingFee*/,
-            /*performanceFee*/
-        )  = abi.decode(data, (IPool.PoolInfo, address, IERC20Metadata, Fee, Fee, Fee));
-
-        IRegistry _registry = getRegistry();
-
-        if(wallet == address(0)) {
-            revert WalletIsZero();
-        }
-
-        ObjectType tokenType = _registry.getObjectInfo(address(token)).objectType;
-
-        if(tokenType != TOKEN()) {
-            revert InvalidToken();
-        } 
-
-        if(UFixedLib.eqz(info.collateralizationLevel)) { 
-            revert CollateralizationLevelIsZero();
-        }
-
-        // TODO add more validations
-
-        // component module
-        instance.registerComponent(
-            nftId,
-            token,
-            wallet
-        ); 
-
-        // pool module
-        instance.registerPool(
-            nftId, 
-            info
-        );
-    }
-}

package/contracts/instance/service/DistributionService.sol

@@ -1,54 +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 {IService} from "../base/IService.sol";
-import {ServiceBase} from "../base/ServiceBase.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,
-        address initialOwner
-    ) ComponentServiceBase(registry, registryNftId, initialOwner)
-    {
-        _registerInterface(type(IDistributionService).interfaceId);
-    }
-
-
-    function getName() public pure override(IService, ServiceBase) 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);
-    }
-}