@etherisc/gif-next 3.0.0-9a6ca4b-922 → 3.0.0-a511887-523

package/contracts/shared/Component.sol

@@ -12,7 +12,7 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType, COMPONENT} from "../type/ObjectType.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {Version, VersionPart, VersionLib} from "../type/Version.sol";
 
 
 abstract contract Component is
@@ -23,9 +23,12 @@ abstract contract Component is
     bytes32 public constant COMPONENT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
 
     struct ComponentStorage {
-        string _name; // unique (per instance) component name
-        bool _isInterceptor;
+        // slot 0
         IComponentService _componentService;
+        // slot 1
+        string _name; // unique (per instance) component name -> make pure to save gas?
+        // slot 2
+        bytes _data;
     }
 
 
@@ -44,7 +47,7 @@ abstract contract Component is
         }
     }
 
-
+    /// @dev requires component parent to be registered 
     function __Component_init(
         address authority,
         address registry,
@@ -75,7 +78,6 @@ abstract contract Component is
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
-        $._isInterceptor = isInterceptor;
         $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
         _registerInterface(type(IAccessManaged).interfaceId);
@@ -93,6 +95,17 @@ abstract contract Component is
         _nftTransferFrom(from, to, tokenId, operator);
     }
 
+    /// @inheritdoc IComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
+    }
+
 
     function getWallet() public view virtual returns (address walletAddress) {
         return getTokenHandler().getWallet();
@@ -110,10 +123,6 @@ abstract contract Component is
         return getComponentInfo().name;
     }
 
-    function getVersion() public view virtual returns (Version version) {
-        return VersionLib.toVersion(1, 0, 0);
-    }
-
     function getComponentInfo() public virtual view returns (IComponents.ComponentInfo memory info) {
         if (isRegistered()) {
             return _getComponentInfo();
@@ -129,14 +138,6 @@ abstract contract Component is
     }
 
 
-    function isNftInterceptor() public virtual view returns(bool isInterceptor) {
-        if (isRegistered()) {
-            return getRegistry().getObjectInfo(address(this)).isInterceptor;
-        } else {
-            return _getComponentStorage()._isInterceptor;
-        }
-    }
-
 
     function isRegistered() public virtual view returns (bool) {
         return getRegistry().getNftIdForAddress(address(this)).gtz();
@@ -170,6 +171,12 @@ abstract contract Component is
         // empty default implementation
     }
 
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getComponentStorage()._componentService.withdrawFees(amount);
+    }
 
     /// @dev Sets the components wallet to the specified address.
     /// Depending on the source of the component information this function needs to be overwritten. 

package/contracts/shared/ComponentService.sol

@@ -49,7 +49,7 @@ contract ComponentService is
     )
         internal
         virtual override
-        initializer()
+        onlyInitializing()
     {
         (
             address authority,
@@ -74,26 +74,21 @@ contract ComponentService is
         restricted()
         returns (NftId componentNftId)
     {
-        // checks
         // check sender is registered product
         IRegistry registry = getRegistry();
-        if (!registry.isObjectType(msg.sender, PRODUCT())) {
+        if (!registry.isObjectType(msg.sender, PRODUCT(), getRelease())) {
             revert ErrorComponentServiceCallerNotProduct(msg.sender);
         }
 
-        // check provided address is product contract
-        if (!_isInstanceLinkedComponent(componentAddress)) {
-            revert ErrorComponentServiceNotComponent(componentAddress);
-        }
-
         NftId productNftId = registry.getNftIdForAddress(msg.sender);
         IInstance instance = IInstance(
             registry.getObjectAddress(
                 registry.getParentNftId(productNftId)));
 
-        componentNftId = _verifyAndRegister(
+        componentNftId = _register(
             instance, 
-            componentAddress, 
+            componentAddress,
+            COMPONENT(),
             productNftId, // product is parent of component to be registered
             address(0)); // token will be inhereited from product
     }
@@ -210,23 +205,18 @@ contract ComponentService is
         nonReentrant()
         returns (NftId productNftId)
     {
-        // checks
         // check sender is registered instance
         IRegistry registry = getRegistry();
-        if (!registry.isObjectType(msg.sender, INSTANCE())) {
+        if (!registry.isObjectType(msg.sender, INSTANCE(), getRelease())) {
             revert ErrorComponentServiceCallerNotInstance(msg.sender);
         }
 
-        // check provided address is product contract
-        if (!_isProduct(productAddress)) {
-            revert ErrorComponentServiceNotProduct(productAddress);
-        }
-
         IInstance instance = IInstance(msg.sender);
         NftId instanceNftId = registry.getNftIdForAddress(msg.sender);
-        productNftId = _verifyAndRegister(
+        productNftId = _register(
             instance, 
             productAddress, 
+            PRODUCT(),
             instanceNftId, // instance is parent of product to be registered 
             token);
 
@@ -236,25 +226,6 @@ contract ComponentService is
             token);
     }
 
-
-    function _isProduct(address target) internal view virtual returns (bool) {
-        if (!_isInstanceLinkedComponent(target)) {
-            return false;
-        }
-
-        return IInstanceLinkedComponent(target).getInitialInfo().objectType == PRODUCT();
-    }
-
-
-    function _isInstanceLinkedComponent(address target) internal view virtual returns (bool) {
-        if (!ContractLib.isContract(target)) {
-            return false;
-        }
-
-        return ContractLib.supportsInterface(target, type(IInstanceLinkedComponent).interfaceId);
-    }
-
-
     /// @inheritdoc IComponentService
     function setProductFees(
         Fee memory productFee, // product fee on net premium
@@ -478,9 +449,10 @@ contract ComponentService is
 
     /// @dev Registers the component represented by the provided address.
     /// The caller must ensure componentAddress is IInstanceLinkedComponent.
-    function _verifyAndRegister(
+    function _register(
         IInstance instance,
         address componentAddress,
+        ObjectType componentType,
         NftId parentNftId,
         address token
     )
@@ -488,36 +460,27 @@ contract ComponentService is
         virtual
         returns (NftId componentNftId)
     {
-        (
-            IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory objectInfo // initial component info
-        ) = _getAndVerifyRegisterableComponent(
-            componentAddress,
-            parentNftId);
+        IInstanceLinkedComponent component = IInstanceLinkedComponent(componentAddress);
+        IRegistry.ObjectInfo memory info = _registryService.registerComponent(
+            component,
+            parentNftId,
+            componentType,
+            address(0)); // component owner have no importance here
+
+        componentType = info.objectType;
+        componentNftId = info.nftId;
 
         InstanceStore instanceStore = instance.getInstanceStore();
-        ObjectType componentType = objectInfo.objectType;
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         if(componentType == PRODUCT()) {
-            // register product with registry
-            componentNftId = _registryService.registerProduct(
-                component, 
-                objectInfo.initialOwner).nftId;
-
             // create product info in instance store
             _createProduct(instance.getProductStore(), componentNftId, componentAddress);
         } else {
-            // register non product component with registry
-            componentNftId = _registryService.registerProductLinkedComponent(
-                component, 
-                objectInfo.objectType, 
-                objectInfo.initialOwner).nftId;
-
-            InstanceReader instanceReader = instance.getInstanceReader();
-
             // create non product component info in instance store
-            NftId productNftId = parentNftId;
+            NftId productNftId = info.parentNftId;
             IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
+
             if(componentType == POOL()) {
                 _createPool(instanceStore, instance.getProductStore(), productNftId, componentNftId, componentAddress, productInfo);
             } else if(componentType == DISTRIBUTION()) {
@@ -529,7 +492,7 @@ contract ComponentService is
             }
 
             // get product's token
-            token = address(instanceReader.getTokenHandler(productNftId).TOKEN());
+            token = address(instanceReader.getToken(productNftId));
         }
 
         _checkToken(instance, token);
@@ -537,10 +500,11 @@ contract ComponentService is
         InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
         
         // deploy and wire token handler
+        IRegistry registry = getRegistry();
         IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
         componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
-            address(getRegistry()),
-            address(component), // initially, component is its own wallet
+            address(registry),
+            componentAddress, // initially, component is its own wallet
             token, 
             instanceAdmin.authority());
         
@@ -559,9 +523,9 @@ contract ComponentService is
             instance.getNftId(),
             componentNftId, 
             componentType, 
-            address(component), 
+            componentAddress, 
             token, 
-            objectInfo.initialOwner);
+            registry.ownerOf(componentNftId));
     }
 
 
@@ -613,43 +577,6 @@ 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 component parent does not match with the required parent
-    /// - the component release does not match with the service release
-    /// - the component has already been registered
-    function _getAndVerifyRegisterableComponent(
-        address componentAddress,
-        NftId requiredParent
-    )
-        internal
-        view
-        returns (
-            IInstanceLinkedComponent component,
-            IRegistry.ObjectInfo memory info
-        )
-    {
-        component = IInstanceLinkedComponent(componentAddress);
-        info = component.getInitialInfo();
-
-        // check component parent
-        if(info.parentNftId != requiredParent) {
-            revert ErrorComponentServiceComponentParentInvalid(componentAddress, requiredParent, info.parentNftId);
-        }
-
-        // check component release (must match with service release)
-        if(component.getRelease() != getRelease()) {
-            revert ErrorComponentServiceComponentReleaseMismatch(componentAddress, getRelease(), component.getRelease());
-        }
-
-        // check component has not already been registered
-        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
-            revert ErrorComponentServiceComponentAlreadyRegistered(componentAddress);
-        }
-    }
-
-
     function _setLocked(InstanceAdmin instanceAdmin, address componentAddress, bool locked) internal {
         instanceAdmin.setTargetLocked(componentAddress, locked);
     }

package/contracts/shared/ComponentServiceManager.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {ComponentService} from "./ComponentService.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 
 contract ComponentServiceManager is ProxyManager {
@@ -18,13 +18,13 @@ contract ComponentServiceManager is ProxyManager {
     {
         ComponentService svc = new ComponentService();
         bytes memory data = abi.encode(authority, registry);
-        IVersionable versionable = initialize(
+        IUpgradeable upgradeable = initialize(
             registry,
             address(svc), 
             data,
             salt);
 
-        _componentService = ComponentService(address(versionable));
+        _componentService = ComponentService(address(upgradeable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/shared/IComponent.sol

@@ -29,6 +29,11 @@ interface IComponent is
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
     event LogComponentTokenHandlerApproved(address tokenHandler, address token, Amount limit, bool isMaxAmount);
 
+    /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
+    /// @param amount the amount to withdraw
+    /// @return withdrawnAmount the amount that was actually withdrawn
+    function withdrawFees(Amount amount) external returns (Amount withdrawnAmount);
+
     /// @dev returns the name of this component
     /// to successfully register the component with an instance the name MUST be unique in the linked instance
     function getName() external view returns (string memory name);
@@ -43,9 +48,6 @@ interface IComponent is
     /// the default address is the token handler address
     function getWallet() external view returns (address walletAddress);
 
-    /// @dev returns true iff this compoent intercepts nft minting and transfers for objects registered by this component
-    function isNftInterceptor() external view returns(bool isInterceptor);
-
     /// @dev returns true iff this component is registered with the registry
     function isRegistered() external view returns (bool);
 

package/contracts/shared/IComponentService.sol

@@ -18,18 +18,11 @@ interface IComponentService is
 {
     // registerProduct
     error ErrorComponentServiceCallerNotInstance(address caller);
-    error ErrorComponentServiceNotProduct(address product);
     error ErrorComponentServiceTokenInvalid(address token);
 
     // registerComponent
     error ErrorComponentServiceCallerNotProduct(address caller);
-    error ErrorComponentServiceNotComponent(address component);
-
-    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
     error ErrorComponentServiceComponentTypeNotSupported(address component, ObjectType invalid);
-    error ErrorComponentServiceComponentParentInvalid(address component, NftId required, NftId actual);
-    error ErrorComponentServiceComponentReleaseMismatch(address component, VersionPart serviceRelease, VersionPart componentRelease);
-    error ErrorComponentServiceComponentAlreadyRegistered(address component);
     
     error ErrorProductServiceNoDistributionExpected(NftId productNftId);
     error ErrorProductServiceDistributionAlreadyRegistered(NftId productNftId, NftId distributionNftId);
@@ -37,18 +30,11 @@ interface IComponentService is
     error ErrorProductServiceOraclesAlreadyRegistered(NftId productNftId, uint8 expectedOracles);
     error ErrorProductServicePoolAlreadyRegistered(NftId productNftId, NftId poolNftId);
 
-    error ErrorComponentServiceNewWalletAddressZero();
-    error ErrorComponentServiceWalletAddressZero();
-    error ErrorComponentServiceWalletAddressIsSameAsCurrent();
-
     error ErrorComponentServiceWithdrawAmountIsZero();
     error ErrorComponentServiceWithdrawAmountExceedsLimit(Amount withdrawnAmount, Amount withdrawLimit);
-    error ErrorComponentServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
 
     event LogComponentServiceComponentLocked(address component, bool locked);
     event LogComponentServiceRegistered(NftId instanceNftId, NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
-    event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
-    event LogComponentServiceWalletTokensTransferred(NftId componentNftId, address currentWallet, address newWallet, uint256 currentBalance);
     event LogComponentServiceComponentFeesWithdrawn(NftId componentNftId, address recipient, address token, Amount withdrawnAmount);
     event LogComponentServiceProductFeesUpdated(NftId productNftId);
     event LogComponentServiceDistributionFeesUpdated(NftId distributionNftId);

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -7,23 +7,20 @@ import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
 
 /// @dev component base class
 /// component examples are product, distribution, pool and oracle
 interface IInstanceLinkedComponent is 
     IComponent
 {
-    error ErrorInstanceLinkedComponentTypeMismatch(ObjectType requiredType, ObjectType objectType);
-    error ErrorInstanceLinkedComponentNotProduct(NftId nftId, ObjectType objectType);
-
-    /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
-    /// @param amount the amount to withdraw
-    /// @return withdrawnAmount the amount that was actually withdrawn
-    function withdrawFees(Amount amount) external returns (Amount withdrawnAmount);
+    error ErrorInstanceLinkedComponentInstanceInvalid();
+    error ErrorInstanceLinkedComponentInstanceMismatch(VersionPart instanceRelease, VersionPart componentRelease);
 
     /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);
 
+    // TODO consider moving to Registerable -> it works with authority
     /// @dev returns the initial component authorization specification.
     function getAuthorization() external view returns (IAuthorization authorization);
 

package/contracts/shared/IRegisterable.sol

@@ -4,8 +4,8 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {INftOwnable} from "./INftOwnable.sol";
-import {IRelease} from "../registry/IRelease.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
+import {IVersionable} from "./IVersionable.sol";
 
 /// @title IRegisterable
 /// @dev Marks contracts that are intended to be registered in the registry.
@@ -13,7 +13,7 @@ import {IRegistry} from "../registry/IRegistry.sol";
 interface IRegisterable is
     IAccessManaged,
     INftOwnable,
-    IRelease
+    IVersionable
 {
     // __Registerable_init
     error ErrorAuthorityInvalid(address authority);
@@ -32,5 +32,10 @@ interface IRegisterable is
     function getInitialInfo() 
         external 
         view
-        returns (IRegistry.ObjectInfo memory);
+        returns (IRegistry.ObjectInfo memory info);
+
+    function getInitialData() 
+        external 
+        view
+        returns (bytes memory data);
 }

package/contracts/shared/IRegistryLinked.sol

@@ -5,7 +5,9 @@ import {IRegistry} from "../registry/IRegistry.sol";
 
 interface IRegistryLinked {
 
-    error ErrorNotRegistry(address registryAddress);
+    error ErrorRegistryLinkedRegistryAlreadyInitialized(address target, address registry);
+    error ErrorRegistryLinkedNotRegistry(address target, address notRegistry);
+    error ErrorRegistryLinkedRegistryMismatch(address target, address givenRegistry, address pureRegistry);
 
     function getRegistry() external view returns (IRegistry);
 }

package/contracts/shared/IService.sol

@@ -4,14 +4,14 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IAccessManaged,
     IRegisterable,
-    IVersionable
+    IUpgradeable
 {
     /// @dev returns the domain for this service.
     /// In any GIF release only one service for any given domain may be deployed.

package/contracts/shared/IVersionable.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Version, VersionPart} from "../type/Version.sol";
+
+interface IVersionable {
+
+    error ErrorVersionableReleaseInvalid(address target, VersionPart invalidRelease);
+    error ErrorVersionableReleaseMismatch(address target, VersionPart expected, VersionPart actual);
+
+    /**
+     * @dev returns version of this contract
+     * implementation MUST define version in this function
+     * version number MUST increase 
+     */
+    function getVersion() external pure returns(Version);
+
+    function getRelease() external pure returns(VersionPart);
+}