@etherisc/gif-next 0.0.2-cc4a5cb-898 → 0.0.2-cd89a0b-062

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

@@ -26,6 +26,16 @@ abstract contract PoolModule is
     // mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
     mapping(NftId poolNftId => LibNftIdSet.Set bundles) private _bundlesForPool;
 
+
+    // TODO try to keep 1 modifier in 1 place...
+    modifier onlyComponentOwnerService() virtual {
+        require(
+            msg.sender == address(this.getComponentOwnerService()),
+            "ERROR:CMP-001:NOT_COMPONENT_OWNER_SERVICE"
+        );
+        _;
+    }
+
     modifier poolServiceCallingPool() {
         require(
             msg.sender == address(this.getPoolService()),
@@ -40,17 +50,12 @@ abstract contract PoolModule is
 
     function registerPool(
         NftId nftId, 
-        bool isVerifying,
-        UFixed collateralizationRate
+        PoolInfo memory info
     )
         public
+        onlyComponentOwnerService
         override
     {
-        PoolInfo memory info  = PoolInfo(
-            isVerifying,
-            collateralizationRate
-        );
-
         _create(POOL(), nftId, abi.encode(info));
     }
 

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

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin5/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";
@@ -33,9 +34,8 @@ interface ITreasury {
 interface ITreasuryModule is ITreasury {
 
     function registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
+        NftId productNftId,
+        TreasuryInfo memory info
     ) external;
 
     function setTreasuryInfo(
@@ -79,4 +79,6 @@ interface ITreasuryModule is ITreasury {
         uint256 a, 
         int8 exp
     ) external pure returns (UFixed);
+
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
 }

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

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {NftId} from "../../../types/NftId.sol";
 

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

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
 import {IPoolComponent} from "../../../components/IPoolComponent.sol";
 import {IProductComponent} from "../../../components/IProductComponent.sol";
@@ -25,48 +25,41 @@ abstract contract TreasuryModule is
     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 {
+    function _initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        //_initializeModuleBase(keyValueStore);
         _initialize(keyValueStore);
         _zeroFee = FeeLib.zeroFee();
     }
 
     function registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
-    ) external override // TODO add authz (only component module)
+        NftId productNftId,
+        TreasuryInfo memory setup
+    ) 
+        external
+        onlyComponentOwnerService
     {
-        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");
+        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
-        IERC20Metadata token = product.getToken();
-        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(token));
+        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(setup.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));
+        _create(TREASURY(), productNftId, abi.encode(setup));
     }
 
     function setTreasuryInfo(

package/contracts/instance/service/ComponentOwnerService.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin5/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 {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";
@@ -16,18 +16,23 @@ 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 {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, UFixedMathLib} from "../../types/UFixed.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 {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,
@@ -35,32 +40,35 @@ contract ComponentOwnerService is
 {
     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 = _registry.getNftId(address(component));
+        NftId nftId = getRegistry().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)
+        NftId registryNftId,
+        address initialOwner
+    )
     {
-        return VersionLib.toVersion(3,0,0);
+        _initializeServiceBase(registry, registryNftId, initialOwner);
+        _registerInterface(type(IComponentOwnerService).interfaceId);
     }
 
-    function getName() external pure override returns(string memory name) {
+    function getName() public pure override(IService, ServiceBase) returns(string memory name) {
         return NAME;
     }
 
@@ -81,58 +89,49 @@ contract ComponentOwnerService is
         }
     }
 
-    function register(
-        IBaseComponent component
-    ) external override returns (NftId nftId) {
-        address initialOwner = component.getOwner();
-        require(
-            msg.sender == address(component),
-            "ERROR:COS-003:NOT_COMPONENT"
-        );
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
+        return IRegistryService(service);
+    }
 
-        IInstance instance = component.getInstance();
-        ObjectType objectType = component.getType();
-        RoleId typeRole = getRoleForType(objectType);
-        require(
-            instance.hasRole(typeRole, initialOwner),
-            "ERROR:CMP-004:TYPE_ROLE_MISSING"
-        );
+    // TODO if user passes type BUNDLE??? -> registerComponent() must catch this
+    function register(	
+        IBaseComponent component,
+        ObjectType componentType 	
+    ) external returns (NftId nftId) {	
 
-        nftId = _registry.register(address(component));
-        IERC20Metadata token = component.getToken();
+        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
+        (
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) = getRegistryService().registerComponent(component, componentType, msg.sender);	
 
-        instance.registerComponent(
-            nftId,
-            token,
-            component.getWallet()); 
-
-        // component type specific registration actions
-        if (component.getType() == PRODUCT()) {
-            IProductComponent product = IProductComponent(address(component));
+        NftId instanceNftId = info.parentNftId;
+        address instancAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        IInstance instance = IInstance(instancAddress);
 
-            NftId poolNftId = product.getPoolNftId();
-            require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
-            IPoolComponent pool = IPoolComponent(_registry.getObjectInfo(poolNftId).objectAddress);
+        RoleId typeRole = getRoleForType(componentType);
+        if(instance.hasRole(typeRole, msg.sender) == false) {
+            revert MissingTypeRole();
+        } 
 
-            NftId distributionNftId = product.getDistributionNftId();
-            IDistributionComponent distribution = IDistributionComponent(_registry.getObjectInfo(distributionNftId).objectAddress);
-
-            // register with tresury
-            instance.registerProductSetup(
-                product,
-                pool,
-                distribution
+        // component type specific registration actions	
+        if (componentType == PRODUCT()) {	
+            _registerProduct(
+                    info.nftId, 
+                    instanceNftId,
+                    instance,
+                    data
             );
-        } else if (component.getType() == POOL()) {
-            IPoolComponent pool = IPoolComponent(address(component));
-
-            // register with pool
-            instance.registerPool(
-                nftId,
-                pool.isVerifying(),
-                pool.getCollateralizationLevel());
-        }
-        // TODO add compensation
+        } else if (componentType == POOL()) {	
+            _registerPool(
+                info.nftId,
+                instanceNftId,
+                instance,
+                data
+            );
+        }	
+        // TODO add distribution and oracle	
     }
 
     function lock(
@@ -154,4 +153,120 @@ contract ComponentOwnerService is
         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(UFixedMathLib.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

@@ -13,6 +13,8 @@ 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";
 
@@ -24,22 +26,15 @@ contract DistributionService is
 
     constructor(
         address registry,
-        NftId registryNftId
-    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+        NftId registryNftId,
+        address initialOwner
+    ) ComponentServiceBase(registry, registryNftId, initialOwner)
     {
         _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) {
+    function getName() public pure override(IService, ServiceBase) returns(string memory name) {
         return NAME;
     }
 

package/contracts/instance/service/IComponentOwnerService.sol

@@ -10,8 +10,6 @@ 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;
 

package/contracts/instance/service/PoolService.sol

@@ -9,11 +9,13 @@ import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/tr
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {Versionable} from "../../shared/Versionable.sol";
 
-import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {NftId, NftIdLib, zeroNftId} 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 {IService} from "../base/IService.sol";
+import {ServiceBase} from "../base/ServiceBase.sol";
 import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
 import {IPoolService} from "./IPoolService.sol";
 
@@ -25,22 +27,14 @@ contract PoolService is ComponentServiceBase, IPoolService {
 
     constructor(
         address registry,
-        NftId registryNftId
-    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+        NftId registryNftId,
+        address initialOwner
+    ) ComponentServiceBase(registry, registryNftId, initialOwner)
     {
         _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) {
+    function getName() public pure override(IService, ServiceBase) returns(string memory name) {
         return NAME;
     }
 
@@ -77,11 +71,17 @@ contract PoolService is ComponentServiceBase, IPoolService {
 
         // register bundle with registry
         NftId poolNftId = info.nftId;
-        bundleNftId = _registry.registerObjectForInstance(
-            poolNftId, 
-            BUNDLE(), 
-            owner,
-            "");
+        bundleNftId = getRegistryService().registerBundle(
+            IRegistry.ObjectInfo(
+                zeroNftId(),
+                poolNftId,
+                BUNDLE(),
+                false, // intercepting property for bundles is defined on pool
+                address(0),
+                owner,
+                ""
+            )
+        );
 
         // create bundle info in instance
         instance.createBundleInfo(
@@ -136,7 +136,7 @@ contract PoolService is ComponentServiceBase, IPoolService {
         if(stakingAmount > 0) {
             NftId productNftId = instance.getProductNftId(poolNftId);
             TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
-            address bundleOwner = _registry.getOwner(bundleNftId);
+            address bundleOwner = getRegistry().ownerOf(bundleNftId);
             address poolWallet = instance.getComponentWallet(poolNftId);
 
             tokenHandler.transfer(