@etherisc/gif-next 0.0.2-f12cf4d-104 → 0.0.2-f13d67f-541

package/contracts/shared/Component.sol

@@ -1,23 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
+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 {VersionPartLib} from "../type/Version.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+
 
 abstract contract Component is
-    AccessManagedUpgradeable,
     Registerable,
     IComponent
 {
@@ -26,9 +24,7 @@ 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;
     }
 
@@ -40,37 +36,35 @@ abstract contract Component is
         _;
     }
 
+
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             $.slot := COMPONENT_LOCATION_V1
         }
     }
 
-    function _initializeComponent(
+
+    function __Component_init(
         address authority,
         address registry,
         NftId parentNftId,
         string memory name,
-        address token,
         ObjectType componentType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
-        bytes memory componentData // other component specific data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         internal
         virtual
         onlyInitializing()
     {
-        if (token == address(0)) {
-            revert ErrorComponentTokenAddressZero();
-        }
-
         if (bytes(name).length == 0) {
             revert ErrorComponentNameLengthZero();
         }
 
-        _initializeRegisterable(
+        __Registerable_init(
+            authority,
             registry, 
             parentNftId, 
             componentType, 
@@ -78,14 +72,10 @@ abstract contract Component is
             initialOwner, 
             registryData);
 
-        __AccessManaged_init(authority);
-
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
-        $._token = IERC20Metadata(token);
         $._isInterceptor = isInterceptor;
-        $._data = componentData;
         $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
         _registerInterface(type(IAccessManaged).interfaceId);
@@ -93,35 +83,6 @@ abstract contract Component is
     }
 
 
-    function approveTokenHandler(IERC20Metadata token, Amount amount)
-        public
-        onlyOwner()
-    {
-        _approveTokenHandler(token, amount);
-    }
-
-
-    // TODO cleanup
-    // /// @dev Approves the component's token hander to spend tokens up to the specified limit.
-    // /// When the spending limit amount equals AmountLib.max it is set to type(uint256).max.
-    // function approveTokenHandler(address token, Amount spendingLimitAmount)
-    //     public
-    //     virtual
-    //     onlyOwner
-    // {
-    //     _approveTokenHandler(token, spendingLimitAmount);
-    // }
-
-
-    // function setWallet(address newWallet)
-    //     external
-    //     virtual
-    //     override
-    //     onlyOwner
-    // {
-    //     _setWallet(newWallet);
-    // }
-
     /// @dev callback function for nft transfers
     /// may only be called by chain nft contract.
     /// override internal function _nftTransferFrom to implement custom behaviour
@@ -142,13 +103,17 @@ 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) {
         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();
@@ -178,10 +143,17 @@ abstract contract Component is
     }
 
 
+    /// @dev Approves token hanlder to spend up to the specified amount of tokens.
+    /// Reverts if component wallet is not token handler itself.
+    /// Only component owner (nft holder) is authorizes to call this function.
     function _approveTokenHandler(IERC20Metadata token, Amount amount)
         internal
         virtual
+        returns (Amount oldAllowanceAmount)
     {
+        oldAllowanceAmount = AmountLib.toAmount(
+            token.allowance(address(getTokenHandler()), address(this)));
+
         _getComponentStorage()._componentService.approveTokenHandler(
             token, 
             amount);
@@ -193,10 +165,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
@@ -207,6 +183,13 @@ abstract contract Component is
         _getComponentStorage()._componentService.setWallet(newWallet);
     }
 
+    function _setLocked(bool locked)
+        internal
+        virtual
+    {
+        _getComponentStorage()._componentService.setLocked(locked);
+    }
+
 
     /// @dev 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
@@ -215,9 +198,7 @@ abstract contract Component is
         
         return IComponents.ComponentInfo({
             name: $._name,
-            token: $._token,
-            tokenHandler: TokenHandler(address(0)),
-            data: $._data // user specific component data
+            tokenHandler: TokenHandler(address(0))
         });
     }