@etherisc/gif-next 0.0.2-f752d2a-551 → 0.0.2-f7b8c9f-436

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

@@ -1,103 +1,82 @@
 // 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 {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";
-
-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
+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"
         );
+        _;
+    }
 
-        // TODO add logging
+    function _initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        //_initializeModuleBase(keyValueStore);
+        _initialize(keyValueStore);
+        _zeroFee = FeeLib.zeroFee();
     }
 
-    function setProductFees(
+    function registerProductSetup(
         NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component owner service)
+        TreasuryInfo memory setup
+    ) 
+        external
+        onlyComponentOwnerService
     {
-        // TODO add validation
-
-        ProductSetup storage setup = _productSetup[productNftId];
-        setup.policyFee = policyFee;
-        setup.processingFee = processingFee;
-
-        // TODO add logging
-    }
+        NftId poolNftId = setup.poolNftId;
+        NftId distributionNftId = setup.distributionNftId;
 
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component module)
-    {
-        // TODO add validation
+        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");
 
-        _poolSetup[poolNftId] = PoolSetup(
-            poolNftId,
-            wallet,
-            stakingFee,
-            performanceFee
-        );
+        // 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;
 
-        // TODO add logging
+        _create(TREASURY(), productNftId, abi.encode(setup));
     }
 
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component owner service)
+    function setTreasuryInfo(
+        NftId productNftId,
+        TreasuryInfo memory info
+    )
+        external
+        // TODO add authz (only component module)
+        override
     {
-        // TODO add validation
-
-        PoolSetup storage setup = _poolSetup[poolNftId];
-        setup.stakingFee = stakingFee;
-        setup.performanceFee = performanceFee;
+        _updateData(TREASURY(), productNftId, abi.encode(info));
+    }
 
-        // TODO add logging
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId) {
+        return _productNft[componentNftId];
     }
 
     function getTokenHandler(
@@ -106,23 +85,23 @@ abstract contract TreasuryModule is ITreasuryModule {
         return _tokenHandler[componentNftId];
     }
 
-    function getProductSetup(
+    function hasTreasuryInfo(
         NftId productNftId
-    ) external view override returns (ProductSetup memory setup) {
-        return _productSetup[productNftId];
+    ) public view override returns (bool hasInfo) {
+        return _exists(TREASURY(), productNftId);
     }
 
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view override returns (PoolSetup memory setup) {
-        return _poolSetup[poolNftId];
+    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);
+        return FeeLib.calculateFee(fee, amount);
     }
 
     function getFee(
@@ -132,8 +111,8 @@ abstract contract TreasuryModule is ITreasuryModule {
         return FeeLib.toFee(fractionalFee, fixedFee);
     }
 
-    function getZeroFee() external pure override returns (Fee memory fee) {
-        return FeeLib.zeroFee();
+    function getZeroFee() external view override returns (Fee memory fee) {
+        return _zeroFee;
     }
 
     function getUFixed(

package/contracts/instance/service/ComponentOwnerService.sol

@@ -1,30 +1,38 @@
 // 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";
 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, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.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, 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,
@@ -32,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;
     }
 
@@ -70,101 +81,195 @@ contract ComponentOwnerService is
         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"
-        );
+    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,
-            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()
+        NftId instanceNftId = info.parentNftId;
+        address instancAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        IInstance instance = IInstance(instancAddress);
+
+        RoleId typeRole = getRoleForType(componentType);
+        if(instance.hasRole(typeRole, msg.sender) == false) {
+            revert MissingTypeRole();
+        } 
+
+        // 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());
-
-            // register with tresury
-            instance.registerPool(
-                nftId,
-                wallet,
-                pool.getStakingFee(),
-                pool.getPerformanceFee());
-        }
-        // TODO add distribution
+        } else if (componentType == POOL()) {	
+            _registerPool(
+                info.nftId,
+                instanceNftId,
+                instance,
+                data
+            );
+        }	
+        // TODO add distribution and oracle	
     }
 
     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();
-        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);
+        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();
-        IComponent.ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
+        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?
         );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
 
-        info.state = ACTIVE();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
+        // 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

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

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/IDistributionService.sol

@@ -0,0 +1,12 @@
+// 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 IDistributionService is IService {
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+}

package/contracts/instance/service/IPoolService.sol

@@ -7,17 +7,24 @@ import {IService} from "../base/IService.sol";
 
 interface IPoolService is IService {
     function setFees(
+        Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     ) external;
 
     function createBundle(
         address owner,
+        Fee memory fee, 
         uint256 amount,
         uint256 lifetime, 
         bytes calldata filter
     ) external returns(NftId bundleNftId);
 
+    function setBundleFee(
+        NftId bundleNftId,
+        Fee memory fee
+    ) external;
+
     // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
     // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);