@etherisc/gif-next 0.0.2-d4eadee-930 → 0.0.2-d551b5e-892

package/contracts/instance/service/ComponentOwnerService.sol

@@ -1,63 +1,74 @@
 // 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 {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 {ITreasury} from "../module/ITreasury.sol";
+// import {TreasuryModule} from "../module/TreasuryModule.sol";
+import {ISetup} from "../module/ISetup.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, UFixedLib} 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 "../../shared/IService.sol";
 import {IComponentOwnerService} from "./IComponentOwnerService.sol";
+import {Service} from "../../shared/Service.sol";
+// import {IPool, IPoolModule} from "../module/IPoolModule.sol";
+
+import {IRegistryService} from "../../registry/IRegistryService.sol";
 
 contract ComponentOwnerService is
-    ServiceBase,
+    Service,
     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 = _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
+        NftId registryNftId,
+        address initialOwner
+    )
     {
-
+        _initializeService(registry, initialOwner);
+        _registerInterface(type(IComponentOwnerService).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, Service) returns(string memory name) {
         return NAME;
     }
 
@@ -70,101 +81,237 @@ 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);
+    }
+
+    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
         );
+    }
 
-        IInstance instance = component.getInstance();
-        ObjectType objectType = component.getType();
-        RoleId typeRole = getRoleForType(objectType);
-        require(
-            instance.hasRole(typeRole, initialOwner),
-            "ERROR:CMP-004:TYPE_ROLE_MISSING"
+    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
         );
+    }
 
-        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 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();
-        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
+    {
+        // TODO change treasury info to product setup info
+        (ISetup.ProductSetupInfo memory info) = abi.decode(data, (ISetup.ProductSetupInfo));
+        // (
+        //     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.createProductSetup(
+            nftId, 
+            info
         );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
+    }
+
+    function _registerPool(
+        NftId nftId,
+        NftId instanceNftId,
+        IInstance instance,
+        bytes memory data
+    )
+        internal
+    {
+        (
+            ISetup.PoolSetupInfo memory info,
+            address wallet,
+            IERC20Metadata token,
+            /*poolFee*/,
+            /*stakingFee*/,
+            /*performanceFee*/
+        )  = abi.decode(data, (ISetup.PoolSetupInfo, address, IERC20Metadata, Fee, Fee, Fee));
+
+        IRegistry _registry = getRegistry();
+
+        if(wallet == address(0)) {
+            revert WalletIsZero();
+        }
 
-        info.state = ACTIVE();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
+        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.createPoolSetup(
+            nftId, 
+            info
+        );
     }
-}
+}

package/contracts/instance/service/DistributionService.sol

@@ -0,0 +1,118 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {InstanceReader} from "../../instance/InstanceReader.sol";
+import {ISetup} from "../../instance/module/ISetup.sol";
+import {ITreasury} from "../../instance/module/ITreasury.sol";
+
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
+import {KEEP_STATE} from "../../types/StateId.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 "../../shared/IService.sol";
+import {Service} from "../../shared/Service.sol";
+import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {IDistributionService} from "./IDistributionService.sol";
+import {Distribution} from "../../components/Distribution.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {Instance} from "../Instance.sol";
+import {INftOwnable} from "../../shared/INftOwnable.sol";
+import {IBaseComponent} from "../../components/IBaseComponent.sol";
+
+string constant DISTRIBUTION_SERVICE_NAME = "DistributionService";
+
+contract DistributionService is
+    ComponentServiceBase,
+    IDistributionService
+{
+    using NftIdLib for NftId;
+
+    string public constant NAME = "DistributionService";
+
+    address internal _registryAddress;
+    
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        address initialOwner;
+        address registryAddress;
+        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+        // TODO while DistributionService is not deployed in DistributionServiceManager constructor
+        //      owner is DistributionServiceManager deployer
+        _initializeService(registryAddress, owner);
+
+        _registerInterface(type(IDistributionService).interfaceId);
+    }
+
+
+    function getName() public pure override(IService, Service) returns(string memory name) {
+        return NAME;
+    }
+
+    function register(address distributionAddress) 
+        external
+        returns(NftId distributionNftId)
+    {
+        address distributionOwner = msg.sender;
+        IBaseComponent distribution = IBaseComponent(distributionAddress);
+
+        IRegistry.ObjectInfo memory info;
+        bytes memory data;
+        (info, data) = getRegistryService().registerDistribution(distribution, distributionOwner);
+
+        IInstance instance = _getInstance(info);
+
+        bool hasRole = getInstanceService().hasRole(
+            distributionOwner, 
+            DISTRIBUTION_OWNER_ROLE(), 
+            address(instance));
+
+        if(!hasRole) {
+            revert ExpectedRoleMissing(DISTRIBUTION_OWNER_ROLE(), distributionOwner);
+        }
+
+        distributionNftId = info.nftId;
+        ISetup.DistributionSetupInfo memory initialSetup = _decodeAndVerifyDistributionSetup(data);
+        instance.createDistributionSetup(distributionNftId, initialSetup);
+    }
+
+    function _decodeAndVerifyDistributionSetup(bytes memory data) internal returns(ISetup.DistributionSetupInfo memory setup)
+    {
+        setup = abi.decode(
+            data,
+            (ISetup.DistributionSetupInfo)
+        );
+
+        // TODO add checks if applicable 
+    }
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId distributionNftId = info.nftId;
+
+        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
+        distSetupInfo.distributionFee = distributionFee;
+        
+        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
+    }
+}

package/contracts/instance/service/DistributionServiceManager.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {ProxyManager} from "../../shared/ProxyManager.sol";
+import {DistributionService} from "./DistributionService.sol";
+import {Registry} from "../../registry/Registry.sol";
+import {RegistryService} from "../../registry/RegistryService.sol";
+import {VersionLib} from "../../types/Version.sol";
+
+contract DistributionServiceManager is ProxyManager {
+
+    DistributionService private _distributionService;
+
+    /// @dev initializes proxy manager with distribution service implementation and deploys instance
+    constructor(
+        address registryAddress
+    )
+        ProxyManager()
+    {
+        DistributionService distSrv = new DistributionService();
+        bytes memory data = abi.encode(registryAddress, address(this));
+        IVersionable versionable = deploy(
+            address(distSrv), 
+            data);
+
+        _distributionService = DistributionService(address(versionable));
+
+        Registry registry = Registry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+        // TODO this must have a role or own nft to register service
+        //registryService.registerService(_distributionService);
+        
+        // TODO no nft to link yet
+        // link ownership of instance service manager ot nft owner of instance service
+        //_linkToNftOwnable(
+        //    address(registryAddress),
+        //    address(_distributionService));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getDistributionService()
+        external
+        view
+        returns (DistributionService distributionService)
+    {
+        return _distributionService;
+    }
+
+}

package/contracts/instance/service/IComponentOwnerService.sol

@@ -5,13 +5,11 @@ 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";
+import {IService} from "../../shared/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 "../../shared/IService.sol";
+
+interface IDistributionService is IService {
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+}