@etherisc/gif-next 0.0.2-96b5b72-170 → 0.0.2-97aac30-275

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} 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} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
+import {NftId, NftIdLib} from "../type/NftId.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,10 +26,21 @@ 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)
+        TokenHandler _tokenHandler;
+        address _wallet;
+        bool _isInterceptor;
+        bytes _data;
     }
 
+
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert ErrorComponentNotChainNft(msg.sender);
+        }
+        _;
+    }
+
+
     function _getComponentStorage() private pure returns (ComponentStorage storage $) {
         assembly {
             $.slot := COMPONENT_LOCATION_V1
@@ -52,7 +56,8 @@ 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
         virtual
@@ -65,42 +70,46 @@ abstract contract Component is
             revert ErrorComponentTokenAddressZero();
         }
 
+        if (bytes(name).length == 0) {
+            revert ErrorComponentNameLengthZero();
+        }
+
         // set component state
         ComponentStorage storage $ = _getComponentStorage();
         $._name = name;
-        $._wallet = address(this);
         $._token = IERC20Metadata(token);
-        $._tokenHandler = new TokenHandler(token);
+        $._tokenHandler = TokenHandler(address(0));
+        $._wallet = address(this);
+        $._isInterceptor = isInterceptor;
+        $._data = componentData;
 
         registerInterface(type(IAccessManaged).interfaceId);
         registerInterface(type(IComponent).interfaceId);
     }
 
-    function approveTokenHandler(uint256 spendingLimitAmount)
+
+    function approveTokenHandler(Amount spendingLimitAmount)
         external
         virtual
         onlyOwner
     {
-        ComponentStorage storage $ = _getComponentStorage();
-        approveTokenHandler(address($._token), spendingLimitAmount);
+        approveTokenHandler(address(getToken()), spendingLimitAmount);
     }
 
-    function approveTokenHandler(address token, uint256 spendingLimitAmount)
+    function approveTokenHandler(address token, Amount spendingLimitAmount)
         public
         virtual
         onlyOwner
     {
-        ComponentStorage storage $ = _getComponentStorage();
-
-        if($._wallet != address(this)) {
+        if(getWallet() != address(this)) {
             revert ErrorComponentWalletNotComponent();
         }
 
         IERC20Metadata(token).approve(
-            address($._tokenHandler),
-            spendingLimitAmount);
+            address(getTokenHandler()),
+            spendingLimitAmount.toInt());
 
-        emit LogComponentTokenHandlerApproved(token, spendingLimitAmount);
+        emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount);
     }
 
     function setWallet(address newWallet)
@@ -109,25 +118,17 @@ abstract contract Component is
         override
         onlyOwner
     {
-        ComponentStorage storage $ = _getComponentStorage();
-        address currentWallet = $._wallet;
-        uint256 currentBalance = $._token.balanceOf(currentWallet);
-
         // checks
-        if (newWallet == address(0)) {
-            revert ErrorComponentWalletAddressZero();
-        }
-
-        if (newWallet == currentWallet) {
-            revert ErrorComponentWalletAddressIsSameAsCurrent();
-        }
+        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));
+                uint256 allowance = token.allowance(currentWallet, address(this));
                 if (allowance < currentBalance) {
                     revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
                 }
@@ -135,43 +136,146 @@ abstract contract Component is
         }
 
         // effects
-        $._wallet = newWallet;
-        emit LogComponentWalletAddressChanged(currentWallet, newWallet);
+        _setWallet(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);
+                token.approve(address(this), currentBalance);
             }
             
-            SafeERC20.safeTransferFrom($._token, currentWallet, newWallet, currentBalance);
+            SafeERC20.safeTransferFrom(token, currentWallet, newWallet, currentBalance);
             emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
         }
     }
 
-    function getWallet() public view virtual returns (address walletAddress)
+
+    /// @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
     {
-        return _getComponentStorage()._wallet;
+        _nftMint(to, tokenId);
     }
 
-    function getToken() public view virtual returns (IERC20Metadata token) {
-        return _getComponentStorage()._token;
+    /// @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)
+        external
+        onlyChainNft
+    {
+        _nftTransferFrom(from, to, tokenId);
+    }
+
+
+    function getWallet() public view virtual returns (address walletAddress) {
+        return getComponentInfo().wallet;
     }
 
-    function getTokenHandler() public view virtual returns (TokenHandler tokenHandler) {
-        return _getComponentStorage()._tokenHandler;
+    function getTokenHandler() public virtual view returns (TokenHandler tokenHandler) {
+        return getComponentInfo().tokenHandler;
+    }
+
+    function getToken() public view virtual returns (IERC20Metadata token) {
+        return getComponentInfo().token;
     }
 
     function getName() public view override returns(string memory name) {
-        return _getComponentStorage()._name;
+        return getComponentInfo().name;
+    }
+
+    function getComponentInfo() public virtual view returns (IComponents.ComponentInfo memory info) {
+        if (isRegistered()) {
+            return _getComponentInfo();
+        } else {
+            return getInitialComponentInfo();
+        }
+    }
+
+    /// @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();
     }
 
+
+    function isNftInterceptor() public virtual view returns(bool isInterceptor) {
+        if (isRegistered()) {
+            return getRegistry().getObjectInfo(address(this)).isInterceptor;
+        } else {
+            return _getComponentStorage()._isInterceptor;
+        }
+    }
+
+
+    function isRegistered() public virtual view returns (bool) {
+        return getRegistry().getNftId(address(this)).gtz();
+    }
+
+
+    /// @dev internal function for nft transfers.
+    /// handling logic that deals with nft transfers need to overwrite this function
+    function _nftMint(address to, uint256 tokenId)
+        internal
+        virtual
+    { }
+
     /// @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)
         internal
         virtual
     { }
+
+
+    /// @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);
+
+    }
+
+
+    /// @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,
+            wallet: $._wallet, // initial wallet address
+            data: $._data // user specific component data
+        });
+    }
+
 }