@etherisc/gif-next 0.0.2-9682fee-392 → 0.0.2-96b5b72-170

package/contracts/registry/ReleaseManager.sol

@@ -3,17 +3,19 @@ pragma solidity ^0.8.20;
 
 import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {RoleId} from "../types/RoleId.sol";
-import {ObjectType, ObjectTypeLib, zeroObjectType, REGISTRY, SERVICE} from "../types/ObjectType.sol";
-import {VersionPart, VersionPartLib} from "../types/Version.sol";
-import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
+import {NftId} from "../type/NftId.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {ObjectType, ObjectTypeLib, zeroObjectType, REGISTRY, SERVICE, STAKING} from "../type/ObjectType.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {IRegistryService} from "./IRegistryService.sol";
 import {IService} from "../shared/IService.sol";
+import {IStaking} from "../staking/IStaking.sol";
 
-import {IRegistry} from "./IRegistry.sol";
 import {Registry} from "./Registry.sol";
-import {IRegistryService} from "./IRegistryService.sol";
 import {RegistryAccessManager} from "./RegistryAccessManager.sol";
 
 
@@ -28,6 +30,9 @@ contract ReleaseManager is AccessManaged
     error NotRegistryService();
     error UnexpectedServiceAuthority(address expected, address found);
 
+    // register staking
+    error ErrorReleaseManagerStakingAlreadySet(address stakingAddress);
+
     // registerService
     error NotService();
 
@@ -36,8 +41,10 @@ contract ReleaseManager is AccessManaged
     error ReleaseRegistrationNotFinished();
 
     // _getAndVerifyContractInfo
+    error ErrorReleaseManagerUnexpectedRegisterableAddress(address expected, address actual);
+    error ErrorReleaseManagerIsInterceptorTrue();
     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
-    error NotRegisterableOwner(address notOwner);
+    error NotRegisterableOwner(address expectedOwner, address actualOwner);
     error SelfRegistration();
     error RegisterableOwnerIsRegistered();
 
@@ -51,27 +58,29 @@ contract ReleaseManager is AccessManaged
     error ConfigSelectorZero(uint configArrayIndex);
     error SelectorAlreadyExists(VersionPart releaseVersion, ObjectType serviceDomain);
 
-
     RegistryAccessManager private immutable _accessManager;
     IRegistry private immutable _registry;
+    IStaking private _staking;
 
-    VersionPart immutable _initial;// first active version    
-    VersionPart _latest;// latest active version
-    VersionPart _next;// version to create and activate 
+    VersionPart immutable _initial;// first active major version    
+    VersionPart _latest;// latest active major version
+    VersionPart _next;// major version to create and activate 
 
-    mapping(VersionPart version => IRegistry.ReleaseInfo info) _release;
+    mapping(VersionPart majorVersion => IRegistry.ReleaseInfo info) _release;
 
-    mapping(VersionPart version => mapping(ObjectType serviceDomain => bytes4[])) _selectors; // registry service function selector assigned to domain 
+    // registry service function selector assigned to domain 
+    mapping(VersionPart majorVersion => mapping(ObjectType serviceDomain => bytes4[])) _selectors; 
 
     uint _awaitingRegistration; // "services left to register" counter
 
     mapping(address registryService => bool isActive) _active;
 
-    mapping(VersionPart version => bool isValid) _valid; // TODO refactor to use _active only
+    mapping(VersionPart majorVersion => bool isValid) _valid; // TODO refactor to use _active only
 
     constructor(
         RegistryAccessManager accessManager, 
-        VersionPart initialVersion)
+        VersionPart initialVersion
+    )
         AccessManaged(accessManager.authority())
     {
         require(initialVersion.toInt() > 0, "ReleaseManager: initial version is 0");
@@ -80,17 +89,37 @@ contract ReleaseManager is AccessManaged
 
         _initial = initialVersion;
         _next = initialVersion;
-
         _registry = new Registry();
     }
 
+    function registerStaking(
+        address stakingAddress,
+        address stakingOwner
+    )
+        external
+        restricted // GIF_ADMIN_ROLE
+        returns(NftId nftId)
+    {
+        // verify staking contract
+        _getAndVerifyContractInfo(stakingAddress, STAKING(), stakingOwner);
+        _staking = IStaking(stakingAddress);
+
+        nftId = _registry.registerStaking(
+            stakingAddress,
+            stakingOwner);
+
+        _staking.linkToRegisteredNftId();
+    }
+
     /// @dev skips previous release if was not activated
     function createNextRelease()
         external
         restricted // GIF_ADMIN_ROLE
     {
         // allow to register new registry service for next version
+        // TODO check/test: assignment to _next likely missing ...
         VersionPartLib.toVersionPart(_next.toInt() + 1);
+
         // disallow registration of regular services for next version while registry service is not registered 
         _awaitingRegistration = 0;
 
@@ -124,9 +153,10 @@ contract ReleaseManager is AccessManaged
         emit LogReleaseActivation(version);
     }
 
-    // TODO deploy proxy and initialize with given implementation instead of using given proxy?
+    // TODO implement reliable way this function can only be called directly after createNextRelease()
     // IMPORTANT: MUST never be possible to create with access/release manager, token registry
-    // callable once per release after release creation, can not register regular services while registry service is not registered
+    // callable once per release after release creation
+    // can not register regular services
     function registerRegistryService(IRegistryService service)
         external
         restricted // GIF_MANAGER_ROLE
@@ -144,14 +174,14 @@ contract ReleaseManager is AccessManaged
                 serviceAuthority); 
         }
 
-        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(address(service), SERVICE(), msg.sender);
 
-        VersionPart version = _next;
+        VersionPart majorVersion = _next;
         ObjectType domain = REGISTRY();
-        _verifyService(service, version, domain);
+        _verifyService(service, majorVersion, domain);
         _createRelease(service.getFunctionConfigs());
         
-        nftId = _registry.registerService(info, version, domain);
+        nftId = _registry.registerService(info, majorVersion, domain);
 
         // external call
         service.linkToRegisteredNftId();
@@ -168,14 +198,14 @@ contract ReleaseManager is AccessManaged
             revert NotService();
         }
 
-        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
-        VersionPart version = getNextVersion();
-        ObjectType domain = _release[version].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
-        _verifyService(service, version, domain);
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(address(service), SERVICE(), msg.sender);
+        VersionPart majorVersion = getNextVersion();
+        ObjectType domain = _release[majorVersion].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
+        _verifyService(service, majorVersion, domain);
 
         // setup and grant unique role if service does registrations
-        bytes4[] memory selectors = _selectors[version][domain];
-        address registryService = _registry.getServiceAddress(REGISTRY(), version);
+        bytes4[] memory selectors = _selectors[majorVersion][domain];
+        address registryService = _registry.getServiceAddress(REGISTRY(), majorVersion);
         if(selectors.length > 0) {
             _accessManager.setAndGrantUniqueRole(
                 address(service), 
@@ -185,7 +215,7 @@ contract ReleaseManager is AccessManaged
         
         _awaitingRegistration--;
 
-        nftId = _registry.registerService(info, version, domain);
+        nftId = _registry.registerService(info, majorVersion, domain);
 
         // external call
         service.linkToRegisteredNftId(); 
@@ -203,9 +233,9 @@ contract ReleaseManager is AccessManaged
         return _valid[version];
     }
 
-    function getRegistry() external view returns(address)
+    function getRegistryAddress() external view returns(address)
     {
-        return (address(_registry));
+        return address(_registry);
     }
 
     function getReleaseInfo(VersionPart version) external view returns(IRegistry.ReleaseInfo memory)
@@ -229,7 +259,7 @@ contract ReleaseManager is AccessManaged
     //--- private functions ----------------------------------------------------//
 
     function _getAndVerifyContractInfo(
-        IService service,
+        address registerableAddress,
         ObjectType expectedType,
         address expectedOwner // assume always valid, can not be 0
     )
@@ -239,9 +269,15 @@ contract ReleaseManager is AccessManaged
             IRegistry.ObjectInfo memory info
         )
     {
-        info = service.getInitialInfo();
-        info.objectAddress = address(service);
-        info.isInterceptor = false; // service is never interceptor, at least now
+        info = IRegisterable(registerableAddress).getInitialInfo();
+
+        if(info.objectAddress != registerableAddress) {
+            revert ErrorReleaseManagerUnexpectedRegisterableAddress(registerableAddress, info.objectAddress);
+        }
+
+        if(info.isInterceptor) {
+            revert ErrorReleaseManagerIsInterceptorTrue();
+        }
 
         if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
             revert UnexpectedRegisterableType(expectedType, info.objectType);
@@ -250,10 +286,10 @@ contract ReleaseManager is AccessManaged
         address owner = info.initialOwner;
 
         if(owner != expectedOwner) { // registerable owner protection
-            revert NotRegisterableOwner(expectedOwner); 
+            revert NotRegisterableOwner(expectedOwner, owner); 
         }
 
-        if(owner == address(service)) {
+        if(owner == address(registerableAddress)) {
             revert SelfRegistration();
         }
         
@@ -271,8 +307,10 @@ contract ReleaseManager is AccessManaged
         view
         returns(ObjectType)
     {
-        if(service.getMajorVersion() != expectedVersion) {
-            revert UnexpectedServiceVersion(expectedVersion, service.getMajorVersion());
+        Version version = service.getVersion();
+        VersionPart majorVersion = version.toMajorPart();
+        if(majorVersion != expectedVersion) {
+            revert UnexpectedServiceVersion(expectedVersion, majorVersion);
         }
 
         if(service.getDomain() != expectedDomain) {

package/contracts/registry/TokenRegistry.sol

@@ -6,8 +6,8 @@ import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165C
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "./IRegistry.sol";
-import {VersionPart} from "../types/Version.sol";
-import {REGISTRY} from "../types/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
+import {REGISTRY} from "../type/ObjectType.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 
 /// @title contract to register token per GIF major release.

package/contracts/shared/Component.sol

@@ -0,0 +1,177 @@
+// 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 {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 {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";
+
+abstract contract Component is
+    AccessManagedUpgradeable,
+    Registerable,
+    IComponent
+{
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Component.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant COMPONENT_LOCATION_V1 = 0xffe8d4462baed26a47154f4b8f6db497d2f772496965791d25bd456e342b7f00;
+
+    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)
+    }
+
+    function _getComponentStorage() private pure returns (ComponentStorage storage $) {
+        assembly {
+            $.slot := COMPONENT_LOCATION_V1
+        }
+    }
+
+    function initializeComponent(
+        address authority,
+        address registry,
+        NftId parentNftId,
+        string memory name,
+        address token,
+        ObjectType componentType,
+        bool isInterceptor,
+        address initialOwner,
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeRegisterable(registry, parentNftId, componentType, isInterceptor, initialOwner, registryData);
+        __AccessManaged_init(authority);
+
+        if (token == address(0)) {
+            revert ErrorComponentTokenAddressZero();
+        }
+
+        // set component state
+        ComponentStorage storage $ = _getComponentStorage();
+        $._name = name;
+        $._wallet = address(this);
+        $._token = IERC20Metadata(token);
+        $._tokenHandler = new TokenHandler(token);
+
+        registerInterface(type(IAccessManaged).interfaceId);
+        registerInterface(type(IComponent).interfaceId);
+    }
+
+    function approveTokenHandler(uint256 spendingLimitAmount)
+        external
+        virtual
+        onlyOwner
+    {
+        ComponentStorage storage $ = _getComponentStorage();
+        approveTokenHandler(address($._token), spendingLimitAmount);
+    }
+
+    function approveTokenHandler(address token, uint256 spendingLimitAmount)
+        public
+        virtual
+        onlyOwner
+    {
+        ComponentStorage storage $ = _getComponentStorage();
+
+        if($._wallet != address(this)) {
+            revert ErrorComponentWalletNotComponent();
+        }
+
+        IERC20Metadata(token).approve(
+            address($._tokenHandler),
+            spendingLimitAmount);
+
+        emit LogComponentTokenHandlerApproved(token, spendingLimitAmount);
+    }
+
+    function setWallet(address newWallet)
+        external
+        virtual
+        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();
+        }
+
+        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);
+                }
+            }
+        }
+
+        // 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 getWallet() public view virtual returns (address walletAddress)
+    {
+        return _getComponentStorage()._wallet;
+    }
+
+    function getToken() public view virtual returns (IERC20Metadata token) {
+        return _getComponentStorage()._token;
+    }
+
+    function getTokenHandler() public view virtual returns (TokenHandler tokenHandler) {
+        return _getComponentStorage()._tokenHandler;
+    }
+
+    function getName() public view override returns(string memory name) {
+        return _getComponentStorage()._name;
+    }
+
+    /// @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
+    { }
+}

package/contracts/shared/ComponentService.sol

@@ -0,0 +1,150 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IAccess} from "../instance/module/IAccess.sol";
+import {ObjectType, INSTANCE, REGISTRY} from "../type/ObjectType.sol";
+import {NftId} from "../type/NftId.sol";
+import {RoleId} from "../type/RoleId.sol";
+
+import {Service} from "../shared/Service.sol";
+import {InstanceService} from "../instance/InstanceService.sol";
+import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
+
+abstract contract ComponentService is
+    Service
+{
+
+    error ErrorComponentServiceNotComponent(address component);
+    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
+    error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
+    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
+    error ErrorComponentServiceComponentLocked(address component);
+    error ErrorComponentServiceSenderNotService(address sender);
+    error ErrorComponentServiceComponentTypeInvalid(address component, ObjectType expectedType, ObjectType foundType);
+
+    /// @dev modifier to check if caller is a registered service
+    modifier onlyService() {
+        address caller = msg.sender;
+        if(!getRegistry().isRegisteredService(caller)) {
+            revert ErrorComponentServiceSenderNotService(caller);
+        }
+        _;
+    }
+
+    // view functions
+
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        return IRegistryService(_getServiceAddress(REGISTRY()));
+    }
+
+    function getInstanceService() public view returns (InstanceService) {
+        return InstanceService(_getServiceAddress(INSTANCE()));
+    }
+
+    // internal functions
+    function _checkComponentForRegistration(
+        address componentAddress,
+        ObjectType requiredType,
+        RoleId requiredRole
+    )
+        internal
+        view
+        returns (
+            IInstanceLinkedComponent component,
+            address owner,
+            IInstance instance,
+            NftId instanceNftId
+        )
+    {
+        // component may only be registerd by initial owner of component
+        owner = msg.sender;
+
+        // check this is a component
+        component = IInstanceLinkedComponent(componentAddress);
+        if(!component.supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
+            revert ErrorComponentServiceNotComponent(componentAddress);
+        }
+
+        // check component is of required type
+        IRegistry.ObjectInfo memory componentInfo = component.getInitialInfo();
+        if(componentInfo.objectType != requiredType) {
+            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, componentInfo.objectType);
+        }
+
+        // check msg.sender is component owner
+        address initialOwner = componentInfo.initialOwner;
+        if(owner != initialOwner) {
+            revert ErrorComponentServiceSenderNotOwner(componentAddress, componentInfo.initialOwner, owner);
+        }
+
+        // check instance has assigned required role to owner
+        instanceNftId = componentInfo.parentNftId;
+        instance = _getInstance(instanceNftId);
+        if(!instance.getInstanceAccessManager().hasRole(requiredRole, owner)) {
+            revert ErrorComponentServiceExpectedRoleMissing(instanceNftId, requiredRole, owner);
+        }
+    }
+
+    // internal view functions
+    function _getAndVerifyCallingComponentAndInstance(
+        ObjectType expectedType // assume always of `component` type
+    )
+        internal
+        view
+        returns(
+            NftId componentNftId,
+            IRegistry.ObjectInfo memory componentInfo, 
+            IInstance instance
+        )
+    {
+        componentNftId = getRegistry().getNftId(msg.sender);
+        (componentInfo, instance) = _getAndVerifyComponentInfoAndInstance(componentNftId, expectedType);
+
+        // locked component can not call services
+        if (instance.getInstanceAccessManager().isTargetLocked(componentInfo.objectAddress)) {
+            revert IAccess.ErrorIAccessTargetLocked(componentInfo.objectAddress);
+        }
+    }
+
+    function _getAndVerifyComponentInfoAndInstance(
+        NftId componentNftId,
+        ObjectType expectedType // assume always of `component` type
+    )
+        internal
+        view
+        returns(
+            IRegistry.ObjectInfo memory componentInfo, 
+            IInstance instance
+        )
+    {
+        componentInfo = getRegistry().getObjectInfo(componentNftId);
+        if(componentInfo.objectType != expectedType) {
+            revert ErrorComponentServiceComponentTypeInvalid(
+                componentInfo.objectAddress, 
+                expectedType, 
+                componentInfo.objectType);
+        }
+
+        instance = _getInstance(componentInfo.parentNftId);
+    }
+    // assume componentNftId is always of `instance` type
+    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
+        return IInstance(
+            getRegistry().getObjectInfo(
+                instanceNftId).objectAddress);
+    }
+    // assume componentNftId is always of `component` type
+    /*function _getInstanceForComponent(NftId componentNftId) internal view returns (IInstance) {
+        NftId instanceNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
+        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
+        return IInstance(instanceAddress);
+    }*/
+
+    function _getServiceAddress(ObjectType domain) internal view returns (address) {
+        return getRegistry().getServiceAddress(domain, getVersion().toMajorPart());
+    }
+}

package/contracts/shared/IComponent.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IComponents} from "../instance/module/IComponents.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IProductService} from "../product/IProductService.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+/// @dev component base class
+/// component examples are staking, product, distribution, pool and oracle
+interface IComponent is 
+    IRegisterable,
+    IAccessManaged
+{
+    error ErrorComponentNotChainNft(address caller);
+    error ErrorComponentTokenAddressZero();
+    error ErrorComponentWalletAddressZero();
+    error ErrorComponentWalletAddressIsSameAsCurrent();
+    error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
+    error ErrorComponentWalletNotComponent();
+
+    event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
+    event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
+    event LogComponentTokenHandlerApproved(address token, uint256 limit);
+
+    /// @dev approves token hanlder to spend up to the specified amount of tokens
+    /// reverts if component wallet is not component itself
+    /// only component owner (nft holder) is authorizes to call this function
+    function approveTokenHandler(uint256 spendingLimitAmount) external;
+
+    /// @dev sets the wallet address for the component
+    /// if the current wallet has tokens, these will be transferred
+    /// if the new wallet address is externally owned, an approval from the 
+    /// owner of the external wallet for the component to move all tokens must exist
+    function setWallet(address walletAddress) external;
+
+    /// @dev returns the name of this component
+    /// to successfully register the component with an instance the name MUST be unique in the linked instance
+    function getName() external view returns (string memory name);
+
+    /// @dev defines which ERC20 token is used by this component
+    function getToken() external view returns (IERC20Metadata token);
+
+    /// @dev returns token handler for this component
+    function getTokenHandler() external view returns (TokenHandler tokenHandler);
+
+    /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
+    /// the default address is the component token address
+    function getWallet() external view returns (address walletAddress);
+}