@etherisc/gif-next 0.0.2-96b5b72-170 → 0.0.2-97a9fc1-165

package/contracts/shared/Component.sol

@@ -1,29 +1,24 @@
 // 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} from "../type/Amount.sol";
+import {ContractLib} from "./ContractLib.sol";
 import {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
-import {InstanceReader} from "../instance/InstanceReader.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, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
+import {ObjectType, COMPONENT, STAKING} from "../type/ObjectType.sol";
 import {Registerable} from "../shared/Registerable.sol";
-import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {VersionPart} from "../type/Version.sol";
+import {Version, VersionLib, VersionPart} from "../type/Version.sol";
+
 
 abstract contract Component is
-    AccessManagedUpgradeable,
     Registerable,
     IComponent
 {
@@ -33,17 +28,28 @@ abstract contract Component is
     struct ComponentStorage {
         string _name; // unique (per instance) component name
         IERC20Metadata _token; // token for this component
-        TokenHandler _tokenHandler; // token handler for this component
-        address _wallet; // wallet for this component (default = component contract itself)
+        bool _isInterceptor;
+        bytes _data;
+        IComponentService _componentService;
+    }
+
+
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert ErrorComponentNotChainNft(msg.sender);
+        }
+        _;
     }
 
+
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
             $.slot := COMPONENT_LOCATION_V1
         }
     }
 
-    function initializeComponent(
+
+    function _initializeComponent(
         address authority,
         address registry,
         NftId parentNftId,
@@ -52,126 +58,170 @@ abstract contract Component is
         ObjectType componentType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
+        bytes memory componentData // other component specific data
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegisterable(registry, parentNftId, componentType, isInterceptor, initialOwner, registryData);
-        __AccessManaged_init(authority);
+        address tokenRegistry = IRegistry(registry).getTokenRegistryAddress();
+        VersionPart release = IRelease(authority).getRelease();
 
-        if (token == address(0)) {
-            revert ErrorComponentTokenAddressZero();
+        // 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();
         }
 
+        __Registerable_init(
+            authority,
+            registry, 
+            parentNftId, 
+            componentType, 
+            isInterceptor, 
+            initialOwner, 
+            registryData);
+
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
-        $._wallet = address(this);
         $._token = IERC20Metadata(token);
-        $._tokenHandler = new TokenHandler(token);
+        $._isInterceptor = isInterceptor;
+        $._data = componentData;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IComponent).interfaceId);
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IComponent).interfaceId);
     }
 
-    function approveTokenHandler(uint256 spendingLimitAmount)
+
+    /// @dev callback function for nft transfers
+    /// may only be called by chain nft contract.
+    /// override internal function _nftTransferFrom to implement custom behaviour
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator)
         external
-        virtual
-        onlyOwner
+        onlyChainNft
     {
-        ComponentStorage storage $ = _getComponentStorage();
-        approveTokenHandler(address($._token), spendingLimitAmount);
+        _nftTransferFrom(from, to, tokenId, operator);
     }
 
-    function approveTokenHandler(address token, uint256 spendingLimitAmount)
-        public
-        virtual
-        onlyOwner
-    {
-        ComponentStorage storage $ = _getComponentStorage();
 
-        if($._wallet != address(this)) {
-            revert ErrorComponentWalletNotComponent();
-        }
+    function getWallet() public view virtual returns (address walletAddress) {
+        return getTokenHandler().getWallet();
+    }
 
-        IERC20Metadata(token).approve(
-            address($._tokenHandler),
-            spendingLimitAmount);
+    function getTokenHandler() public virtual view returns (TokenHandler tokenHandler) {
+        return getComponentInfo().tokenHandler;
+    }
 
-        emit LogComponentTokenHandlerApproved(token, spendingLimitAmount);
+    function getToken() public view virtual returns (IERC20Metadata token) {
+        return getComponentInfo().token;
     }
 
-    function setWallet(address newWallet)
-        external
-        virtual
-        override
-        onlyOwner
-    {
-        ComponentStorage storage $ = _getComponentStorage();
-        address currentWallet = $._wallet;
-        uint256 currentBalance = $._token.balanceOf(currentWallet);
+    function getName() public view override returns(string memory name) {
+        return getComponentInfo().name;
+    }
 
-        // checks
-        if (newWallet == address(0)) {
-            revert ErrorComponentWalletAddressZero();
-        }
+    function getVersion() public view virtual returns (Version version) {
+        return VersionLib.toVersion(1, 0, 0);
+    }
 
-        if (newWallet == currentWallet) {
-            revert ErrorComponentWalletAddressIsSameAsCurrent();
+    function getComponentInfo() public virtual view returns (IComponents.ComponentInfo memory info) {
+        if (isRegistered()) {
+            return _getComponentInfo();
+        } else {
+            return getInitialComponentInfo();
         }
+    }
 
-        if (currentBalance > 0) {
-            if (currentWallet == address(this)) {
-                // move tokens from component smart contract to external wallet
-            } else {
-                // move tokens from external wallet to component smart contract or another external wallet
-                uint256 allowance = $._token.allowance(currentWallet, address(this));
-                if (allowance < currentBalance) {
-                    revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
-                }
-            }
-        }
+    /// @dev defines initial component specification
+    /// overwrite this function according to your use case
+    function getInitialComponentInfo() public virtual view returns (IComponents.ComponentInfo memory info) {
+        return _getComponentInfo();
+    }
 
-        // effects
-        $._wallet = newWallet;
-        emit LogComponentWalletAddressChanged(currentWallet, newWallet);
 
-        // interactions
-        if (currentBalance > 0) {
-            // transfer tokens from current wallet to new wallet
-            if (currentWallet == address(this)) {
-                // transferFrom requires self allowance too
-                $._token.approve(address(this), currentBalance);
-            }
-            
-            SafeERC20.safeTransferFrom($._token, currentWallet, newWallet, currentBalance);
-            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
+    function isNftInterceptor() public virtual view returns(bool isInterceptor) {
+        if (isRegistered()) {
+            return getRegistry().getObjectInfo(address(this)).isInterceptor;
+        } else {
+            return _getComponentStorage()._isInterceptor;
         }
     }
 
-    function getWallet() public view virtual returns (address walletAddress)
-    {
-        return _getComponentStorage()._wallet;
-    }
 
-    function getToken() public view virtual returns (IERC20Metadata token) {
-        return _getComponentStorage()._token;
+    function isRegistered() public virtual view returns (bool) {
+        return getRegistry().getNftIdForAddress(address(this)).gtz();
     }
 
-    function getTokenHandler() public view virtual returns (TokenHandler tokenHandler) {
-        return _getComponentStorage()._tokenHandler;
-    }
 
-    function getName() public view override returns(string memory name) {
-        return _getComponentStorage()._name;
+    /// @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
+    {
+        _getComponentStorage()._componentService.approveTokenHandler(
+            token, 
+            amount);
     }
 
+
     /// @dev internal function for nft transfers.
     /// handling logic that deals with nft transfers need to overwrite this function
-    function _nftTransferFrom(address from, address to, uint256 tokenId)
+    function _nftTransferFrom(address from, address to, uint256 tokenId, address operator)
         internal
         virtual
     { }
+
+
+    /// @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
+    )
+        internal
+        virtual
+    {
+        _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
+    function _getComponentInfo() internal virtual view returns (IComponents.ComponentInfo memory info) {
+        ComponentStorage storage $ = _getComponentStorage();
+        
+        return IComponents.ComponentInfo({
+            name: $._name,
+            token: $._token,
+            tokenHandler: TokenHandler(address(0)),
+            data: $._data // user specific component data
+        });
+    }
+
+    /// @dev returns the service address for the specified domain
+    /// gets address via lookup from registry using the major version form the linked instance
+    function _getServiceAddress(ObjectType domain) internal view returns (address) {
+        return getRegistry().getServiceAddress(domain, getRelease());
+    }
 }