@etherisc/gif-next 0.0.2-a196164-289 → 0.0.2-a25e4b8-781

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,26 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../../types/NftId.sol";
-import {RiskId} from "../../../types/RiskId.sol";
-import {StateId} from "../../../types/StateId.sol";
-
-interface IRisk {
-    struct RiskInfo {
-        NftId productNftId;
-        bytes data;
-    }
-}
-
-interface IRiskModule is IRisk {
-    function createRisk(
-        RiskId riskId,
-        NftId productNftId,
-        bytes memory data
-    ) external;
-
-    function setRiskInfo(RiskId riskId, RiskInfo memory info) external;
-    function updateRiskState(RiskId riskId, StateId state) external;
-
-    function getRiskInfo(RiskId riskId) external view returns (RiskInfo memory info);
-}

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,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/ComponentOwnerService.sol

@@ -1,157 +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 {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, 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 {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.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 == DISTRIBUTION()) {
-            return DISTRIBUTION_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,
-            token,
-            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");
-            IPoolComponent pool = IPoolComponent(_registry.getObjectInfo(poolNftId).objectAddress);
-
-            NftId distributionNftId = product.getDistributionNftId();
-            IDistributionComponent distribution = IDistributionComponent(_registry.getObjectInfo(distributionNftId).objectAddress);
-
-            // register with tresury
-            instance.registerProductSetup(
-                product,
-                pool,
-                distribution
-            );
-        } else if (component.getType() == POOL()) {
-            IPoolComponent pool = IPoolComponent(address(component));
-
-            // register with pool
-            instance.registerPool(
-                nftId,
-                pool.isVerifying(),
-                pool.getCollateralizationLevel());
-        }
-        // TODO add compensation
-    }
-
-    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());
-    }
-}

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/registry/IChainNft.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol";
-
-interface IChainNft is IERC721Enumerable {
-    function mint(
-        address to,
-        string memory uri
-    ) external returns (uint256 tokenId);
-
-    function burn(uint256 tokenId) external;
-
-    function setURI(uint256 tokenId, string memory uri) external;
-
-    function exists(uint256 tokenId) external view returns (bool);
-
-    function totalMinted() external view returns (uint256);
-
-    function getRegistryAddress() external view returns (address registry);
-}