@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd5f17a-625

package/contracts/registry/TokenRegistry.sol

@@ -1,19 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IRegistry} from "./IRegistry.sol";
-import {NftOwnable} from "../shared/NftOwnable.sol";
-import {ReleaseManager} from "./ReleaseManager.sol";
 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.
 contract TokenRegistry is
-    NftOwnable
+    AccessManaged,
+    IRegistryLinked
 {
     event LogTokenRegistryTokenRegistered(uint256 chainId, address token, uint256 decimals, string symbol);
     event LogTokenRegistryTokenGlobalStateSet(uint256 chainId, address token, bool active);
@@ -42,7 +48,8 @@ contract TokenRegistry is
     mapping(uint256 chainId => mapping(address token => mapping(VersionPart majorVersion => bool isActive))) internal _active;
     TokenInfo [] internal _token;
 
-    ReleaseManager internal _releaseManager;
+    IRegistry internal _registry;
+    ReleaseRegistry internal _releaseRegistry;
     IERC20Metadata internal _dipToken;
 
     /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
@@ -53,62 +60,23 @@ contract TokenRegistry is
         _;
     }
 
-    constructor(
-        address registry,
-        address dipToken
-    )
-    { 
-        initialize(registry, dipToken);
-    }
-
-    function initialize(
-        address registry,
-        address dipToken
-    )
-        public
-        initializer()
+    constructor(IRegistry registry, IERC20Metadata dipToken)
+        AccessManaged(msg.sender)
     {
-        initializeNftOwnable(msg.sender, registry);
-
-        // initialize release manager
-        _releaseManager = ReleaseManager(msg.sender);
-
-        // set dip token
-        _dipToken = IERC20Metadata(dipToken);
+        // set authority
+        address authority = RegistryAdmin(registry.getRegistryAdminAddress()).authority();
+        setAuthority(authority);
+        
+        _registry = registry;
+        _dipToken = dipToken;
 
         // register dip token
         uint256 chainId = block.chainid;
         _registerToken(
             chainId, 
-            dipToken, 
+            address(_dipToken), 
             _dipToken.decimals(), 
             _dipToken.symbol());
-
-        // activation of dip token needs to take place outside of the
-        // token registry constructor call
-    }
-
-
-    /// @dev link token registry ownership to nft owner of registry service and register dip token.
-    function linkToRegistryService() 
-        external
-    {
-        // link token registry ownership to registry service
-        address registryService = getRegistry().getServiceAddress(
-                REGISTRY(), 
-                _releaseManager.getInitialVersion());
-        _linkToNftOwnable(registryService);
-
-        // activate dip for initial gif version
-        // as token registry is created in constructor of release manager
-        // release manager can not yet be called in constructor of token registry
-        uint256 chainId = block.chainid;
-        address dipToken = address(_dipToken);
-        VersionPart majorVersion = _releaseManager.getInitialVersion();
-        bool active = true;
-        _active[chainId][dipToken][majorVersion] = active;
-
-        emit LogTokenRegistryTokenStateSet(chainId, dipToken, majorVersion, active);
     }
 
 
@@ -117,7 +85,7 @@ contract TokenRegistry is
     /// the non optional erc20 view functions.
     function registerToken(address tokenAddress)
         external
-        onlyOwner
+        restricted()
     {
         IERC20Metadata token = _verifyOnchainToken(tokenAddress);
         _registerToken(block.chainid, tokenAddress, token.decimals(), token.symbol());
@@ -133,7 +101,7 @@ contract TokenRegistry is
         string memory symbol
     )
         external
-        onlyOwner
+        restricted()
     {
         if (chainId == block.chainid) {
             revert ErrorTokenRegistryNotRemoteToken(chainId, token);
@@ -152,7 +120,7 @@ contract TokenRegistry is
         bool active
     )
         external
-        onlyOwner
+        restricted()
         onlyRegisteredToken(chainId, token)
     {
         _tokenInfo[chainId][token].active = active;
@@ -171,9 +139,11 @@ contract TokenRegistry is
         VersionPart majorVersion, 
         bool active
     )
-        public
+        external
+        restricted()
+        onlyRegisteredToken(chainId, token)
     {
-        setActiveWithVersionCheck(chainId, token, majorVersion, active, true);
+        _setActiveWithVersionCheck(chainId, token, majorVersion, active, true);
     }
 
 
@@ -187,14 +157,27 @@ contract TokenRegistry is
         bool active,
         bool enforceVersionCheck
     )
-        public
-        onlyOwner
+        external
+        restricted()
         onlyRegisteredToken(chainId, token)
+    {
+        _setActiveWithVersionCheck(chainId, token, majorVersion, active, enforceVersionCheck);
+    }
+
+
+    function _setActiveWithVersionCheck(
+        uint256 chainId, 
+        address token, 
+        VersionPart majorVersion, 
+        bool active,
+        bool enforceVersionCheck
+    )
+        internal
     {
         // verify valid major version
         if(enforceVersionCheck) {
             uint256 version = majorVersion.toInt();
-            if (!getRegistry().isValidRelease(majorVersion)) {
+            if (!getRegistry().isActiveRelease(majorVersion)) {
                 revert ErrorTokenRegistryMajorVersionInvalid(majorVersion);
             }
         }
@@ -238,6 +221,19 @@ contract TokenRegistry is
         return _active[chainId][token][majorVersion];
     }
 
+    function getDipTokenAddress() external view returns (address) {
+        return address(_dipToken);
+    }
+
+    //--- IRegistryLinked --------------------------------------------------//
+
+    /// @dev returns the dip token for this chain
+    function getRegistry() public view returns (IRegistry) {
+        return _registry;
+    }
+
+    //--- internal functions ------------------------------------------------//
+
 
     /// @dev checks if provided token address refers to a smart contract that implements 
     /// erc20 functionality (via its non-optional functions)

package/contracts/shared/Component.sol

@@ -6,21 +6,14 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 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 {IInstanceService} from "../instance/IInstanceService.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
+import {ObjectType} 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 {VersionPartLib} from "../type/Version.sol";
 
 abstract contract Component is
     AccessManagedUpgradeable,
@@ -33,7 +26,6 @@ abstract contract Component is
     struct ComponentStorage {
         string _name; // unique (per instance) component name
         IERC20Metadata _token; // token for this component
-        TokenHandler _tokenHandler;
         address _wallet;
         bool _isInterceptor;
         bytes _data;
@@ -47,6 +39,12 @@ abstract contract Component is
         _;
     }
 
+    modifier onlyNftOwner(NftId nftId) {
+        if(msg.sender != getRegistry().ownerOf(nftId)) {
+            revert ErrorNftOwnableNotOwner(msg.sender);
+        }
+        _;
+    }
 
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
@@ -54,7 +52,7 @@ abstract contract Component is
         }
     }
 
-    function initializeComponent(
+    function _initializeComponent(
         address authority,
         address registry,
         NftId parentNftId,
@@ -66,11 +64,11 @@ abstract contract Component is
         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);
+        _initializeRegisterable(registry, parentNftId, componentType, isInterceptor, initialOwner, registryData);
         __AccessManaged_init(authority);
 
         if (token == address(0)) {
@@ -85,17 +83,16 @@ abstract contract Component is
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
         $._token = IERC20Metadata(token);
-        $._tokenHandler = TokenHandler(address(0));
         $._wallet = address(this);
         $._isInterceptor = isInterceptor;
         $._data = componentData;
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IComponent).interfaceId);
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IComponent).interfaceId);
     }
 
 
-    function approveTokenHandler(uint256 spendingLimitAmount)
+    function approveTokenHandler(Amount spendingLimitAmount)
         external
         virtual
         onlyOwner
@@ -103,7 +100,7 @@ abstract contract Component is
         approveTokenHandler(address(getToken()), spendingLimitAmount);
     }
 
-    function approveTokenHandler(address token, uint256 spendingLimitAmount)
+    function approveTokenHandler(address token, Amount spendingLimitAmount)
         public
         virtual
         onlyOwner
@@ -112,11 +109,11 @@ abstract contract Component is
             revert ErrorComponentWalletNotComponent();
         }
 
+        emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount);
+
         IERC20Metadata(token).approve(
             address(getTokenHandler()),
-            spendingLimitAmount);
-
-        emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount);
+            spendingLimitAmount.toInt());
     }
 
     function setWallet(address newWallet)
@@ -127,34 +124,22 @@ abstract contract Component is
     {
         // checks
         address currentWallet = getWallet();
-        IERC20Metadata token = getToken();
-        uint256 currentBalance = token.balanceOf(currentWallet);
-
-        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);
-                }
-            }
-        }
+        uint256 currentBalance = getToken().balanceOf(currentWallet);
 
         // effects
         _setWallet(newWallet);
 
         // interactions
         if (currentBalance > 0) {
-            // transfer tokens from current wallet to new wallet
+            // move tokens from old to new wallet 
+            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
+
             if (currentWallet == address(this)) {
-                // transferFrom requires self allowance too
-                token.approve(address(this), currentBalance);
+                // transfer from the component requires an allowance
+                getTokenHandler().distributeTokens(currentWallet, newWallet, AmountLib.toAmount(currentBalance));
+            } else {
+                getTokenHandler().collectTokens(currentWallet, newWallet, AmountLib.toAmount(currentBalance));
             }
-            
-            SafeERC20.safeTransferFrom(token, currentWallet, newWallet, currentBalance);
-            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
         }
     }
 
@@ -221,7 +206,7 @@ abstract contract Component is
 
 
     function isRegistered() public virtual view returns (bool) {
-        return getRegistry().getNftId(address(this)).gtz();
+        return getRegistry().getNftIdForAddress(address(this)).gtz();
     }
 
 
@@ -259,28 +244,25 @@ abstract contract Component is
 
     }
 
-    /// @dev for component contracts that hold its own component information 
-    /// this function creates and sets a token hanlder for the components tokens
-    function _createAndSetTokenHandler()
-        internal
-    {
-        ComponentStorage storage $ = _getComponentStorage();
-        $._tokenHandler = new TokenHandler(address($._token));
-    }
 
     /// @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,
             productNftId: NftIdLib.zero(),
             token: $._token,
-            tokenHandler: $._tokenHandler,
+            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);
+    }
+
 }