@etherisc/gif-next 0.0.2-c0dadcd-773 → 0.0.2-c16a73d-798

package/contracts/shared/Component.sol

@@ -6,11 +6,11 @@ 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} from "../type/Amount.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} from "../type/ObjectType.sol";
+import {ObjectType, PRODUCT} from "../type/ObjectType.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPartLib} from "../type/Version.sol";
@@ -26,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;
@@ -40,14 +39,13 @@ abstract contract Component is
         _;
     }
 
-
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
             $.slot := COMPONENT_LOCATION_V1
         }
     }
 
-    function initializeComponent(
+    function _initializeComponent(
         address authority,
         address registry,
         NftId parentNftId,
@@ -59,13 +57,10 @@ 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);
-        __AccessManaged_init(authority);
-
         if (token == address(0)) {
             revert ErrorComponentTokenAddressZero();
         }
@@ -74,17 +69,26 @@ abstract contract Component is
             revert ErrorComponentNameLengthZero();
         }
 
+        _initializeRegisterable(
+            registry, 
+            parentNftId, 
+            componentType, 
+            isInterceptor, 
+            initialOwner, 
+            registryData);
+
+        __AccessManaged_init(authority);
+
         // set component state
         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);
     }
 
 
@@ -96,6 +100,8 @@ abstract contract Component is
         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
@@ -105,11 +111,18 @@ abstract contract Component is
             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()),
-            spendingLimitAmount.toInt());
-
-        emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount);
+            spendingLimit);
     }
 
     function setWallet(address newWallet)
@@ -120,56 +133,33 @@ 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);
         }
     }
 
-
-    /// @dev callback function for nft mints
-    /// may only be called by chain nft contract.
-    /// override internal function _nftMint to implement custom behaviour
-    function nftMint(address to, uint256 tokenId) 
-        external 
-        onlyChainNft
-    {
-        _nftMint(to, tokenId);
-    }
-
     /// @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)
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator)
         external
         onlyChainNft
     {
-        _nftTransferFrom(from, to, tokenId);
+        _nftTransferFrom(from, to, tokenId, operator);
     }
 
 
@@ -214,7 +204,7 @@ abstract contract Component is
 
 
     function isRegistered() public virtual view returns (bool) {
-        return getRegistry().getNftId(address(this)).gtz();
+        return getRegistry().getNftIdForAddress(address(this)).gtz();
     }
 
 
@@ -227,7 +217,7 @@ abstract contract Component is
 
     /// @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
     { }
@@ -253,29 +243,23 @@ 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);
+    }
+
 }