@etherisc/gif-next 0.0.2-f13c010-035 → 0.0.2-f13fd28-503

package/contracts/registry/TokenRegistry.sol

@@ -8,15 +8,13 @@ import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165C
 import {REGISTRY} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-
 import {IRegistry} from "./IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {ReleaseRegistry} from "./ReleaseRegistry.sol";
 import {RegistryAdmin} from "./RegistryAdmin.sol";
 
-
-/// @title contract to register token per GIF major release.
+/// @dev The TokenRegistry contract is used to whitelist/manage ERC-20 of tokens per major release.
+/// Only whitelisted tokens can be used as default tokens for products, distribution and pools components.
 contract TokenRegistry is
     AccessManaged,
     IRegistryLinked
@@ -68,7 +66,7 @@ contract TokenRegistry is
         setAuthority(authority);
         
         _registry = registry;
-        _dipToken = dipToken;
+        _dipToken = _verifyOnchainToken(address(dipToken));
 
         // register dip token
         uint256 chainId = block.chainid;
@@ -212,13 +210,13 @@ contract TokenRegistry is
         return _tokenInfo[chainId][token].chainId > 0;
     }
 
-    /// @dev returns true iff both the token is active for the specfied version and the global token state is active
-    function isActive(uint256 chainId, address token, VersionPart majorVersion) external view returns (bool) {
+    /// @dev returns true iff both the token is active for the specfied release and the global token state is active
+    function isActive(uint256 chainId, address token, VersionPart release) external view returns (bool) {
         if(!_tokenInfo[chainId][token].active) {
             return false;
         }
 
-        return _active[chainId][token][majorVersion];
+        return _active[chainId][token][release];
     }
 
     function getDipTokenAddress() external view returns (address) {

package/contracts/shared/Component.sol

@@ -1,22 +1,25 @@
 // 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 {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, PRODUCT} from "../type/ObjectType.sol";
+import {IComponentService} from "./IComponentService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRelease} from "../registry/IRelease.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ContractLib} from "./ContractLib.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, COMPONENT, STAKING} 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, VersionPart} from "../type/Version.sol";
+
 
 abstract contract Component is
-    AccessManagedUpgradeable,
     Registerable,
     IComponent
 {
@@ -26,9 +29,9 @@ abstract contract Component is
     struct ComponentStorage {
         string _name; // unique (per instance) component name
         IERC20Metadata _token; // token for this component
-        address _wallet;
         bool _isInterceptor;
         bytes _data;
+        IComponentService _componentService;
     }
 
 
@@ -39,12 +42,14 @@ abstract contract Component is
         _;
     }
 
+
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
             $.slot := COMPONENT_LOCATION_V1
         }
     }
 
+
     function _initializeComponent(
         address authority,
         address registry,
@@ -61,15 +66,26 @@ abstract contract Component is
         virtual
         onlyInitializing()
     {
-        if (token == address(0)) {
-            revert ErrorComponentTokenAddressZero();
+        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();
         }
 
-        _initializeRegisterable(
+        __Registerable_init(
+            authority,
             registry, 
             parentNftId, 
             componentType, 
@@ -77,100 +93,32 @@ abstract contract Component is
             initialOwner, 
             registryData);
 
-        __AccessManaged_init(authority);
-
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
         $._token = IERC20Metadata(token);
-        $._wallet = address(this);
         $._isInterceptor = isInterceptor;
         $._data = componentData;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
         _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IComponent).interfaceId);
     }
 
 
-    function approveTokenHandler(Amount spendingLimitAmount)
-        external
-        virtual
-        onlyOwner
-    {
-        approveTokenHandler(address(getToken()), spendingLimitAmount);
-    }
-
-    /// @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
-    {
-        if(getWallet() != address(this)) {
-            revert ErrorComponentWalletNotComponent();
-        }
-
-        uint256 spendingLimit = spendingLimitAmount.toInt();
-        bool isMaxAmount = false;
-        if (spendingLimitAmount == AmountLib.max()) {
-            spendingLimit = type(uint256).max;
-            isMaxAmount = true;
-        }
-
-        emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount, isMaxAmount);
-
-        IERC20Metadata(token).approve(
-            address(getTokenHandler()),
-            spendingLimit);
-    }
-
-    function setWallet(address newWallet)
-        external
-        virtual
-        override
-        onlyOwner
-    {
-        // checks
-        address currentWallet = getWallet();
-        uint256 currentBalance = getToken().balanceOf(currentWallet);
-
-        // effects
-        _setWallet(newWallet);
-
-        // temporaryly allow current wallet to transfer tokens to new wallet
-        getTokenHandler().addAllowedTarget(currentWallet);
-
-        // interactions
-        if (currentBalance > 0) {
-            // move tokens from old to new wallet 
-            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
-
-            if (currentWallet == address(this)) {
-                // transfer from the component requires an allowance
-                getTokenHandler().distributeTokens(currentWallet, newWallet, AmountLib.toAmount(currentBalance));
-            } else {
-                getTokenHandler().collectTokens(currentWallet, newWallet, AmountLib.toAmount(currentBalance));
-            }
-        }
-
-        // this breaks cei pattern, but not sure how to bet resolve this
-        getTokenHandler().removeAllowedTarget(currentWallet);
-    }
-
     /// @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
-        onlyChainNft
+        onlyChainNft()
     {
         _nftTransferFrom(from, to, tokenId, operator);
     }
 
 
     function getWallet() public view virtual returns (address walletAddress) {
-        return getComponentInfo().wallet;
+        return getTokenHandler().getWallet();
     }
 
     function getTokenHandler() public virtual view returns (TokenHandler tokenHandler) {
@@ -185,6 +133,10 @@ 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();
@@ -214,12 +166,18 @@ abstract contract Component is
     }
 
 
-    /// @dev internal function for nft transfers.
-    /// handling logic that deals with nft transfers need to overwrite this function
-    function _nftMint(address to, uint256 tokenId)
+    /// @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
@@ -231,21 +189,20 @@ abstract contract Component is
 
     /// @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 _setWallet(address newWallet) internal virtual {
-        ComponentStorage storage $ = _getComponentStorage();
-        address currentWallet = $._wallet;
-
-        if (newWallet == address(0)) {
-            revert ErrorComponentWalletAddressZero();
-        }
-
-        if (newWallet == currentWallet) {
-            revert ErrorComponentWalletAddressIsSameAsCurrent();
-        }
-
-        $._wallet = newWallet;
-        emit LogComponentWalletAddressChanged(currentWallet, newWallet);
+    function _setWallet(
+        address newWallet
+    )
+        internal
+        virtual
+    {
+        _getComponentStorage()._componentService.setWallet(newWallet);
+    }
 
+    function _setLocked(bool locked)
+        internal
+        virtual
+    {
+        _getComponentStorage()._componentService.setLockedFromComponent(address(this), locked);
     }
 
 
@@ -258,14 +215,13 @@ abstract contract Component is
             name: $._name,
             token: $._token,
             tokenHandler: TokenHandler(address(0)),
-            wallet: $._wallet, // initial wallet address
             data: $._data // user specific component data
         });
     }
 
-    function _approveTokenHandler(uint256 amount) internal {
-        ComponentStorage storage $ = _getComponentStorage();
-        $._token.approve(address(getComponentInfo().tokenHandler), amount);
+    /// @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());
     }
-
 }