@etherisc/gif-next 0.0.2-a307d03-692 → 0.0.2-a33f6f4-689

package/contracts/shared/Component.sol

@@ -5,17 +5,14 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {Amount} from "../type/Amount.sol";
-import {ContractLib} from "./ContractLib.sol";
 import {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRelease} from "../registry/IRelease.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, STAKING} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT} from "../type/ObjectType.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {Version, VersionLib, VersionPart} from "../type/Version.sol";
+import {Version, VersionLib} from "../type/Version.sol";
 
 
 abstract contract Component is
@@ -27,7 +24,6 @@ abstract contract Component is
 
     struct ComponentStorage {
         string _name; // unique (per instance) component name
-        IERC20Metadata _token; // token for this component
         bool _isInterceptor;
         bytes _data;
         IComponentService _componentService;
@@ -43,6 +39,7 @@ abstract contract Component is
 
 
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             $.slot := COMPONENT_LOCATION_V1
         }
@@ -54,7 +51,6 @@ abstract contract Component is
         address registry,
         NftId parentNftId,
         string memory name,
-        address token,
         ObjectType componentType,
         bool isInterceptor,
         address initialOwner,
@@ -65,20 +61,6 @@ abstract contract Component is
         virtual
         onlyInitializing()
     {
-        address tokenRegistry = IRegistry(registry).getTokenRegistryAddress();
-        VersionPart release = IRelease(authority).getRelease();
-
-        // special case for staking: component intitialization happens before
-        // GIF core contract setup is complete. at that time token registry 
-        // is not yet available. therefore we skip the check for staking.
-        if (componentType != STAKING()) {
-
-            // check if provided token is whitelisted and active
-            if (!ContractLib.isActiveToken(tokenRegistry, token, block.chainid, release)) {
-                revert ErrorComponentTokenInvalid(token);
-            }
-        }
-
         if (bytes(name).length == 0) {
             revert ErrorComponentNameLengthZero();
         }
@@ -95,7 +77,6 @@ abstract contract Component is
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
-        $._token = IERC20Metadata(token);
         $._isInterceptor = isInterceptor;
         $._data = componentData;
         $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
@@ -125,7 +106,7 @@ abstract contract Component is
     }
 
     function getToken() public view virtual returns (IERC20Metadata token) {
-        return getComponentInfo().token;
+        return getTokenHandler().TOKEN();
     }
 
     function getName() public view override returns(string memory name) {
@@ -183,10 +164,14 @@ abstract contract Component is
     function _nftTransferFrom(address from, address to, uint256 tokenId, address operator)
         internal
         virtual
-    { }
+    // solhint-disable-next-line no-empty-blocks
+    { 
+        // empty default implementation
+    }
 
 
-    /// @dev depending on the source of the component information this function needs to be overwritten. 
+    /// @dev Sets the components wallet to the specified address.
+    /// Depending on the source of the component information this function needs to be overwritten. 
     /// eg for instance linked components that externally store this information with the instance store contract
     function _setWallet(
         address newWallet
@@ -201,7 +186,7 @@ abstract contract Component is
         internal
         virtual
     {
-        _getComponentStorage()._componentService.setComponentLocked(address(this), locked);
+        _getComponentStorage()._componentService.setLocked(locked);
     }
 
 
@@ -212,7 +197,6 @@ abstract contract Component is
         
         return IComponents.ComponentInfo({
             name: $._name,
-            token: $._token,
             tokenHandler: TokenHandler(address(0)),
             data: $._data // user specific component data
         });

package/contracts/shared/ComponentService.sol

@@ -19,6 +19,7 @@ import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
 
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {ContractLib} from "../shared/ContractLib.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
@@ -42,6 +43,31 @@ contract ComponentService is
     IRegistryService private _registryService;
     IInstanceService private _instanceService;
 
+    modifier onlyComponent(address component) {
+        _checkSupportsInterface(component);
+        _;
+    }
+
+    modifier onlyInstance() {        
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        if (instanceNftId.eqz()) {
+            revert ErrorComponentServiceNotRegistered(msg.sender);
+        }
+
+        ObjectType objectType = getRegistry().getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorComponentServiceNotInstance(msg.sender, objectType);
+        }
+
+        VersionPart instanceVersion = IInstance(msg.sender).getRelease();
+        if (instanceVersion != getVersion().toMajorPart()) {
+            revert ErrorComponentServiceInstanceVersionMismatch(msg.sender, instanceVersion);
+        }
+
+        _;
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
@@ -66,46 +92,37 @@ contract ComponentService is
 
     //-------- component ----------------------------------------------------//
 
-    /// @inheritdoc IComponentService
-    function registerComponent(address componentAddress)
+    function registerComponent(address component)
         external
         virtual
-        restricted()
+        onlyComponent(component)
         returns (NftId componentNftId)
     {
-        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
-
-        (
-            IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory componentInfo // initial component info
-        ) = _getAndVerifyRegisterableComponent(
-            componentAddress,
-            productNftId);
-        ObjectType componentType = componentInfo.objectType;
+        // type specific registration
+        IRegistry.ObjectInfo memory componentObjectInfo = IInstanceLinkedComponent(component).getInitialInfo();
+        ObjectType componentType = componentObjectInfo.objectType;        
+        IComponent productComponent = IComponent(getRegistry().getObjectAddress(componentObjectInfo.parentNftId));
 
         if (componentType == POOL()) {
-            IPoolComponent pool = IPoolComponent(componentAddress);
-            return _registerPool(instance, productNftId, pool, componentInfo);
+            return _registerPool(component, address(productComponent.getToken()));
         }
         if (componentType == DISTRIBUTION()) {
-            return _registerDistribution(instance, productNftId, component, componentInfo);
+            return _registerDistribution(component, address(productComponent.getToken()));
         }
         if (componentType == ORACLE()) {
-            return _registerOracle(instance, productNftId, component, componentInfo);
+            return _registerOracle(component, address(productComponent.getToken()));
         }
 
         // fail
-        revert ErrorComponentServiceComponentTypeNotSupported(componentAddress, componentType);
+        revert ErrorComponentServiceTypeNotSupported(component, componentType);
     }
 
-    /// @inheritdoc IComponentService
     function approveTokenHandler(
         IERC20Metadata token,
         Amount amount
     )
         external
         virtual
-        restricted()
     {
         // checks
         (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
@@ -116,11 +133,10 @@ contract ComponentService is
         tokenHandler.approve(token, amount);
     }
 
-    /// @inheritdoc IComponentService
+
     function setWallet(address newWallet)
         external
         virtual
-        restricted()
     {
         // checks
         (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
@@ -132,14 +148,17 @@ contract ComponentService is
     }
 
     /// @inheritdoc IComponentService
-    function setComponentLocked(address componentAddress, bool locked) 
+    function setLocked(bool locked) 
         external 
         virtual
         restricted()
     {
-        // TODO inactive component can lock/unlock other components?
         (, IInstance instance) = _getAndVerifyComponent(COMPONENT(), false);
-        instance.setLockedFromService(componentAddress, locked);
+
+        address component = msg.sender;
+        instance.getInstanceAdmin().setComponentLocked(
+            component, 
+            locked);
     }
 
     /// @inheritdoc IComponentService
@@ -195,37 +214,24 @@ contract ComponentService is
 
     //-------- product ------------------------------------------------------//
 
-    function registerProduct(address productAddress)
+    function registerProduct(address productAddress, address token)
         external
         virtual
-        restricted()
         nonReentrant()
+        onlyComponent(productAddress)
         returns (NftId productNftId)
     {
-        // TODO proper instance verification, will be done in next PR
-        //(NftId instanceNftId,, IInstance instance) = _getAndVerifyCallingInstance();
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
-        IInstance instance = IInstance(msg.sender);
-
-        (
-            ,
-            IRegistry.ObjectInfo memory productInfo // initial product info
-        ) = _getAndVerifyRegisterableComponent(
+        // register/create component setup
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        (, instanceAdmin, instanceStore,, productNftId) = _register(
             productAddress,
-            instanceNftId);
+            PRODUCT(),
+            token);
 
-        if(productInfo.objectType != PRODUCT()) {
-            revert ErrorComponentServiceComponentTypeNotSupported(productAddress, productInfo.objectType);
-        }
-
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
-
-        // register/create component info
+        // get product
         IProductComponent product = IProductComponent(productAddress);
-        productNftId = _register(instanceAdmin, instanceStore, product, productInfo);
-
-        // create product in instance instanceStore
+        
         IComponents.ProductInfo memory initialProductInfo = product.getInitialProductInfo();
         // force initialization of linked components with empty values to 
         // ensure no components are linked upon initialization of the product
@@ -250,7 +256,6 @@ contract ComponentService is
     )
         external
         virtual
-        restricted()
         nonReentrant()
     {
         (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -280,26 +285,24 @@ contract ComponentService is
     //-------- distribution -------------------------------------------------//
 
     /// @dev registers the sending component as a distribution component
-    function _registerDistribution(
-        IInstance instance,
-        NftId productNftId,
-        IInstanceLinkedComponent distribution,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerDistribution(address distributioAddress, address token)
         internal
         virtual
         nonReentrant()
         returns (NftId distributionNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
-
         // register/create component info
-        distributionNftId = _register(instanceAdmin, instanceStore, distribution, info);
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
+        (instanceReader, instanceAdmin, instanceStore, productNftId, distributionNftId) = _register(
+            distributioAddress,
+            DISTRIBUTION(),
+            token);
 
         // check product is still expecting a distribution registration
-        IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (!productInfo.hasDistribution) {
             revert ErrorProductServiceNoDistributionExpected(productNftId);
         }
@@ -319,7 +322,6 @@ contract ComponentService is
     )
         external
         virtual
-        restricted()
     {
         (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
         (NftId productNftId, IComponents.FeeInfo memory feeInfo) = _getLinkedFeeInfo(
@@ -348,25 +350,24 @@ contract ComponentService is
 
     //-------- oracle -------------------------------------------------------//
 
-    function _registerOracle(
-        IInstance instance,
-        NftId productNftId,
-        IInstanceLinkedComponent oracle,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerOracle(address oracleAddress, address token)
         internal
         virtual
         returns (NftId oracleNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
+        // register/create component setup
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
 
-        // register/create component info
-        oracleNftId = _register(instanceAdmin, instanceStore, oracle, info);
+        (instanceReader, instanceAdmin, instanceStore, productNftId, oracleNftId) = _register(
+            oracleAddress,
+            ORACLE(),
+            token);
 
         // check product is still expecting an oracle registration
-        IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (productInfo.expectedNumberOfOracles == 0) {
             revert ErrorProductServiceNoOraclesExpected(productNftId);
         }
@@ -382,30 +383,30 @@ contract ComponentService is
 
     //-------- pool ---------------------------------------------------------//
 
-    function _registerPool(
-        IInstance instance,
-        NftId productNftId,
-        IPoolComponent pool,
-        IRegistry.ObjectInfo memory info
-    )
+    function _registerPool(address poolAddress, address token)
         internal
         virtual
         returns (NftId poolNftId)
     {
-        InstanceReader reader = instance.getInstanceReader();
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        InstanceStore instanceStore = instance.getInstanceStore();
+        // register/create component setup
+        InstanceReader instanceReader;
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        NftId productNftId;
 
-        // register/create component info
-        poolNftId = _register(instanceAdmin, instanceStore, pool, info);
+        (instanceReader, instanceAdmin, instanceStore, productNftId, poolNftId) = _register(
+            poolAddress,
+            POOL(),
+            token);
 
         // check product is still expecting a pool registration
-        IComponents.ProductInfo memory productInfo = reader.getProductInfo(productNftId);
+        IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
         if (productInfo.poolNftId.gtz()) {
             revert ErrorProductServicePoolAlreadyRegistered(productNftId, productInfo.poolNftId);
         }
 
         // create info
+        IPoolComponent pool = IPoolComponent(poolAddress);
         instanceStore.createPool(
             poolNftId, 
             pool.getInitialPoolInfo());
@@ -422,7 +423,6 @@ contract ComponentService is
         Fee memory performanceFee // pool fee on profits from capital investors
     )
         external
-        restricted()
         virtual
     {
         (NftId poolNftId, IInstance instance) = _getAndVerifyActiveComponent(POOL());
@@ -460,48 +460,84 @@ contract ComponentService is
 
     /// @dev Registers the component represented by the provided address.
     function _register(
-        InstanceAdmin instanceAdmin,
-        InstanceStore instanceStore,
-        IInstanceLinkedComponent component,
-        IRegistry.ObjectInfo memory info
+        address componentAddress, // address of component to register
+        ObjectType requiredType, // required type for component for registration
+        address token
     )
         internal
         virtual
-        returns (NftId componentNftId)
+        returns (
+            InstanceReader instanceReader, 
+            InstanceAdmin instanceAdmin, 
+            InstanceStore instanceStore, 
+            NftId parentNftId,
+            NftId componentNftId
+        )
     {
-        // register component with registry
-        componentNftId =
-            info.objectType == PRODUCT() ?
-            _registryService.registerProduct(component, info.initialOwner).nftId :
-            _registryService.registerProductLinkedComponent(component, info.objectType, info.initialOwner).nftId;
+        NftId instanceNftId;
+        IInstance instance;
+        IInstanceLinkedComponent component;
+        address initialOwner;
+
+        (
+            instanceNftId, 
+            instance, 
+            parentNftId, 
+            component, 
+            initialOwner
+        ) = _getAndVerifyRegisterableComponent(
+            getRegistry(),
+            componentAddress,
+            requiredType);
+
+        if (! instance.isTokenRegistryDisabled()) {
+            // check if provided token is whitelisted and active
+            if (!ContractLib.isActiveToken(
+                getRegistry().getTokenRegistryAddress(), 
+                token, 
+                block.chainid, 
+                AccessManagerCloneable(authority()).getRelease())
+            ) {
+                revert ErrorComponentServiceTokenInvalid(token);
+            }
+        }
+
+        // get instance supporting contracts (as function return values)
+        instanceReader = instance.getInstanceReader();
+        instanceAdmin = instance.getInstanceAdmin();
+        instanceStore = instance.getInstanceStore();
+
+        // register with registry
+        if (requiredType == PRODUCT()) {
+            componentNftId = _registryService.registerProduct(
+                component, initialOwner).nftId;
+        } else {
+            componentNftId = _registryService.registerProductLinkedComponent(
+                component, requiredType, initialOwner).nftId;
+        }
 
         // deploy and wire token handler
-        // TODO deploy token handler in instance contract ?!
-        IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
-        IERC20Metadata token = componentInfo.token;
-        componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
-            address(getRegistry()),
-            address(component), // initially, component is its own wallet
-            address(token), 
-            address(instanceAdmin.authority()));
-        
-        // register component with instance
-        instanceStore.createComponent(
-            componentNftId, 
-            componentInfo);
+        {
+            IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
+            componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+                address(getRegistry()),
+                componentAddress, // initially, component is its own wallet
+                token, 
+                address(instanceAdmin.authority()));
+            
+            // register component with instance
+            instanceStore.createComponent(
+                componentNftId, 
+                componentInfo);
+        }
 
         // link component contract to nft id
         component.linkToRegisteredNftId();
 
         // authorize
-        instanceAdmin.initializeComponentAuthorization(component);
+        instanceAdmin.initializeComponentAuthorization(componentAddress, requiredType);
 
-        emit LogComponentServiceRegistered(
-            componentNftId, 
-            info.objectType, 
-            address(component), 
-            address(token), 
-            info.initialOwner);
+        emit LogComponentServiceRegistered(instanceNftId, componentNftId, requiredType, componentAddress, token, initialOwner);
     }
 
 
@@ -535,47 +571,89 @@ contract ComponentService is
         info = instanceReader.getFeeInfo(productNftId);
     }
 
+
     /// @dev Based on the provided component address required type the component 
     /// and related instance contract this function reverts iff:
+    /// - the sender is not registered
     /// - the component contract does not support IInstanceLinkedComponent
-    /// - the component parent does not match with the required parent
-    /// - the component version does not match with the service release
+    /// - the component type does not match with the required type
     /// - the component has already been registered
     function _getAndVerifyRegisterableComponent(
+        IRegistry registry,
         address componentAddress,
-        NftId requiredParent
+        ObjectType requiredType
     )
         internal
         view
         returns (
+            NftId instanceNftId,
+            IInstance instance,
+            NftId parentNftId,
             IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory info
+            address initialOwner
         )
     {
-        // check component interface
-        if (!ContractLib.supportsInterface(componentAddress, type(IInstanceLinkedComponent).interfaceId)) {
-            revert ErrorComponentServiceNotInstanceLinkedComponent(componentAddress);
+        // check sender (instance or product) is registered
+        IRegistry.ObjectInfo memory senderInfo = registry.getObjectInfo(msg.sender);
+        if (senderInfo.nftId.eqz()) {
+            revert ErrorComponentServiceSenderNotRegistered(msg.sender);
         }
 
+        // the sender is the parent of the component to be registered
+        // an instance caller wanting to register a product - or -
+        // a product caller wantint go register a distribution, oracle or pool
+        parentNftId = senderInfo.nftId;
+
+        // check component is of required type
         component = IInstanceLinkedComponent(componentAddress);
-        info = component.getInitialInfo();
+        IRegistry.ObjectInfo memory info = component.getInitialInfo();
+        if(info.objectType != requiredType) {
+            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, info.objectType);
+        }
 
-        // check component parent
-        if(info.parentNftId != requiredParent) {
-            revert ErrorComponentServiceComponentParentInvalid(componentAddress, requiredParent, info.parentNftId);
+        // check component has not already been registered
+        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
         }
 
-        // check component release
-        // TODO check version with registry
-        //if(info.version != getRelease()) {
-        if(component.getRelease() != getRelease()) {
-            revert ErrorComponentServiceComponentReleaseMismatch(componentAddress, getRelease(), component.getRelease());
+        // component release matches servie release
+        address parentAddress = registry.getObjectAddress(parentNftId);
+        if (component.getRelease() != getRelease()) {
+            revert ErrorComponentServiceReleaseMismatch(componentAddress, component.getRelease(), getRelease());
+        // component release matches parent release
+        } else if (component.getRelease() != IRegisterable(parentAddress).getRelease()){
+            revert ErrorComponentServiceReleaseMismatch(componentAddress, component.getRelease(), IRegisterable(parentAddress).getRelease());
         }
 
-        // check component has not already been registered
-        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
-            revert ErrorComponentServiceComponentAlreadyRegistered(componentAddress);
+        // check component belongs to same product cluster 
+        // parent of product must be instance, parent of other componet types must be product
+        if (info.parentNftId != senderInfo.nftId) {
+            revert ErrorComponentServiceSenderNotComponentParent(senderInfo.nftId, info.parentNftId);
         }
+
+        // verify parent is registered instance
+        if (requiredType == PRODUCT()) {
+            if (senderInfo.objectType != INSTANCE()) {
+                revert ErrorComponentServiceParentNotInstance(senderInfo.nftId, senderInfo.objectType);
+            }
+
+            instanceNftId = senderInfo.nftId;
+        // verify parent is registered product
+        } else {
+            if (senderInfo.objectType != PRODUCT()) {
+                revert ErrorComponentServiceParentNotProduct(senderInfo.nftId, senderInfo.objectType);
+            }
+
+            instanceNftId = senderInfo.parentNftId;
+        }
+
+        // get initial owner and instance
+        initialOwner = info.initialOwner;
+        instance = IInstance(registry.getObjectAddress(instanceNftId));
+    }
+
+    function _setLocked(InstanceAdmin instanceAdmin, address componentAddress, bool locked) internal {
+        instanceAdmin.setTargetLocked(componentAddress, locked);
     }
 
     function _getAndVerifyActiveComponent(ObjectType expectedType) 
@@ -621,4 +699,10 @@ contract ComponentService is
     function _getDomain() internal pure virtual override returns(ObjectType) {
         return COMPONENT();
     }
+
+    function _checkSupportsInterface(address component) internal view {
+        if (!ContractLib.supportsInterface(component, type(IInstanceLinkedComponent).interfaceId)) {
+            revert ErrorComponentServiceNotInstanceLinkedComponent(component);
+        }
+    }
 }