@etherisc/gif-next 0.0.2-f62dcdf-553 → 0.0.2-f634e5c-828

package/contracts/shared/ComponentService.sol

@@ -3,10 +3,12 @@ pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {ContractLib} from "../shared/ContractLib.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
+import {IComponent} from "../shared/IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
 import {IInstance} from "../instance/IInstance.sol";
@@ -15,22 +17,28 @@ import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IProductComponent} from "../product/IProductComponent.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, REGISTRY, BUNDLE, COMPONENT, DISTRIBUTION, DISTRIBUTOR, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId} from "../type/RoleId.sol";
+import {ObjectType, REGISTRY, BUNDLE, COMPONENT, DISTRIBUTION, DISTRIBUTOR, INSTANCE, ORACLE, POOL, PRODUCT, STAKING} from "../type/ObjectType.sol";
+import {Service} from "../shared/Service.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
+import {VersionPart} from "../type/Version.sol";
+
 
 contract ComponentService is
-    ComponentVerifyingService,
+    Service,
     IComponentService
 {
-
     bool private constant INCREASE = true;
     bool private constant DECREASE = false;
 
@@ -38,9 +46,26 @@ contract ComponentService is
     IInstanceService private _instanceService;
 
     modifier onlyComponent(address component) {
-        if (!ContractLib.supportsInterface(component, type(IInstanceLinkedComponent).interfaceId)) {
-            revert ErrorComponentServiceNotInstanceLinkedComponent(component);
+        _checkSupportsInterface(component);
+        _;
+    }
+
+    modifier onlyInstance() {        
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        if (instanceNftId.eqz()) {
+            revert ErrorComponentServiceNotRegistered(msg.sender);
         }
+
+        ObjectType objectType = getRegistry().getObjectInfo(instanceNftId).objectType;
+        if (objectType != INSTANCE()) {
+            revert ErrorComponentServiceNotInstance(msg.sender, objectType);
+        }
+
+        VersionPart instanceVersion = IInstance(msg.sender).getRelease();
+        if (instanceVersion != getVersion().toMajorPart()) {
+            revert ErrorComponentServiceInstanceVersionMismatch(msg.sender, instanceVersion);
+        }
+
         _;
     }
 
@@ -90,43 +115,84 @@ contract ComponentService is
         revert ErrorComponentServiceTypeNotSupported(component, componentType);
     }
 
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+    {
+        // checks
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        TokenHandler tokenHandler = instance.getInstanceReader().getComponentInfo(
+            componentNftId).tokenHandler;
 
-    function setWallet(address newWallet) external virtual {
-        (NftId componentNftId,, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
-        IComponents.ComponentInfo memory info = instance.getInstanceReader().getComponentInfo(componentNftId);
-        address currentWallet = info.wallet;
+        // effects
+        tokenHandler.approve(token, amount);
+    }
 
-        if (newWallet == address(0)) {
-            revert ErrorComponentServiceNewWalletAddressZero();
-        }
 
-        if (currentWallet == address(0)) {
-            revert ErrorComponentServiceWalletAddressZero();
-        }
+    function approveStakingTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+    {
+        // checks
+        ContractLib.getAndVerifyStaking(
+            getRegistry(),
+            msg.sender); // only active
 
-        if (newWallet == currentWallet) {
-            revert ErrorComponentServiceWalletAddressIsSameAsCurrent();
-        }
+        // effects
+        TokenHandler tokenHandler = IComponent(msg.sender).getTokenHandler();
+        tokenHandler.approve(token, amount);
+    }
 
-        info.wallet = newWallet;
-        instance.getInstanceStore().updateComponent(componentNftId, info, KEEP_STATE());
-        emit LogComponentServiceWalletAddressChanged(componentNftId, currentWallet, newWallet);
+
+    function setWallet(address newWallet)
+        external
+        virtual
+    {
+        // checks
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        TokenHandler tokenHandler = instance.getInstanceReader().getComponentInfo(
+            componentNftId).tokenHandler;
+
+        // effects
+        tokenHandler.setWallet(newWallet);
     }
 
-    // TODO implement
-    function lock() external virtual {}
+    /// @inheritdoc IComponentService
+    function setLockedFromInstance(address componentAddress, bool locked) 
+        external 
+        virtual
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        // NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        IInstance instance = IInstance(instanceAddress);
+        _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
+    }
 
-    // TODO implement
-    function unlock() external virtual {}
+    /// @inheritdoc IComponentService
+    function setLockedFromComponent(address componentAddress, bool locked) 
+        external
+        virtual
+        onlyComponent(msg.sender)
+    {
+        (, IInstance instance) = _getAndVerifyComponent(COMPONENT(), false);
+        _setLocked(instance.getInstanceAdmin(), componentAddress, locked);
+    }
 
     function withdrawFees(Amount amount)
         external
         virtual
         returns (Amount withdrawnAmount)
     {
-        (NftId componentNftId,, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        (NftId componentNftId, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
         IComponents.ComponentInfo memory info = instance.getInstanceReader().getComponentInfo(componentNftId);
-        address componentWallet = info.wallet;
+        address componentWallet = info.tokenHandler.getWallet();
 
         // determine withdrawn amount
         withdrawnAmount = amount;
@@ -156,6 +222,7 @@ contract ComponentService is
     function registerProduct(address productAddress)
         external
         virtual
+        nonReentrant()
         onlyComponent(productAddress)
         returns (NftId productNftId)
     {
@@ -185,8 +252,9 @@ contract ComponentService is
     )
         external
         virtual
+        nonReentrant()
     {
-        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         IComponents.ProductInfo memory productInfo = instance.getInstanceReader().getProductInfo(productNftId);
         bool feesChanged = false;
 
@@ -241,6 +309,7 @@ contract ComponentService is
     function _registerDistribution(address distributioAddress)
         internal
         virtual
+        nonReentrant()
         returns (NftId distributionNftId)
     {
         // register/create component info
@@ -278,7 +347,7 @@ contract ComponentService is
         external
         virtual
     {
-        (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
+        (NftId distributionNftId, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
         (NftId productNftId, IComponents.ProductInfo memory productInfo) = _getLinkedProductInfo(
             instance.getInstanceReader(), distributionNftId);
         bool feesChanged = false;
@@ -379,7 +448,7 @@ contract ComponentService is
         InstanceStore instanceStore;
         NftId productNftId;
 
-        (instanceReader, instanceAdmin, instanceStore, productNftId, oracleNftId) =_register(
+        (instanceReader, instanceAdmin, instanceStore, productNftId, oracleNftId) = _register(
             oracleAddress,
             ORACLE());
 
@@ -415,7 +484,7 @@ contract ComponentService is
         InstanceStore instanceStore;
         NftId productNftId;
 
-        (instanceReader, instanceAdmin, instanceStore, productNftId, poolNftId) =_register(
+        (instanceReader, instanceAdmin, instanceStore, productNftId, poolNftId) = _register(
             poolAddress,
             POOL());
 
@@ -448,7 +517,8 @@ contract ComponentService is
         external
         virtual
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+
         (NftId productNftId, IComponents.ProductInfo memory productInfo) = _getLinkedProductInfo(
             instance.getInstanceReader(), poolNftId);
         bool feesChanged = false;
@@ -615,8 +685,13 @@ contract ComponentService is
         IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
         IERC20Metadata token = componentInfo.token;
         componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(getRegistry()),
+            address(component), // initially, component is its own wallet
             address(token), 
             address(instanceAdmin.authority()));
+        
+        // set token handler allowance to max
+        // componentInfo.tokenHandler.approve(token, AmountLib.max());
 
         // register component with instance
         instanceStore.createComponent(
@@ -656,7 +731,7 @@ contract ComponentService is
             IComponents.ProductInfo memory info
         )
     {
-        productNftId = _getProductNftId(componentNftId);
+        productNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
         info = instanceReader.getProductInfo(productNftId);
     }
 
@@ -735,11 +810,60 @@ contract ComponentService is
 
         // get initial owner and instance
         initialOwner = info.initialOwner;
-        instance = _getInstance(registry, instanceNftId);
+        instance = IInstance(registry.getObjectAddress(instanceNftId));
+    }
+
+    function _setLocked(InstanceAdmin instanceAdmin, address componentAddress, bool locked) internal {
+        instanceAdmin.setTargetLocked(componentAddress, locked);
+    }
+
+    function _getAndVerifyActiveComponent(ObjectType expectedType) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        return _getAndVerifyComponent(expectedType, true); // only active
     }
 
+    function _getAndVerifyComponent(ObjectType expectedType, bool isActive) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        IRegistry.ObjectInfo memory info;
+        address instanceAddress;
+
+        if (expectedType != COMPONENT()) {
+            (info, instanceAddress) = ContractLib.getAndVerifyComponent(
+                getRegistry(),
+                msg.sender, // caller
+                expectedType,
+                isActive); 
+        } else {
+            (info, instanceAddress) = ContractLib.getAndVerifyAnyComponent(
+                getRegistry(),
+                msg.sender,
+                isActive); 
+        }
+
+        // get component nft id and instance
+        componentNftId = info.nftId;
+        instance = IInstance(instanceAddress);
+    }
 
     function _getDomain() internal pure virtual override returns(ObjectType) {
         return COMPONENT();
     }
+
+    function _checkSupportsInterface(address component) internal view {
+        if (!ContractLib.supportsInterface(component, type(IInstanceLinkedComponent).interfaceId)) {
+            revert ErrorComponentServiceNotInstanceLinkedComponent(component);
+        }
+    }
 }

package/contracts/shared/ComponentVerifyingService.sol

@@ -5,7 +5,7 @@ import {IInstance} from "../instance/IInstance.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT, STAKING} from "../type/ObjectType.sol";
 import {Service} from "../shared/Service.sol";
 
 
@@ -27,12 +27,12 @@ abstract contract ComponentVerifyingService is
         view
         returns(
             NftId componentNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
+            IRegistry.ObjectInfo memory objectInfo, 
             IInstance instance
         )
     {
         componentNftId = getRegistry().getNftIdForAddress(msg.sender);
-        (componentInfo, instance) = _getAndVerifyComponentInfo(
+        (objectInfo, instance) = _getAndVerifyComponentInfo(
             componentNftId, 
             expectedType,
             true); // only active
@@ -82,7 +82,15 @@ abstract contract ComponentVerifyingService is
             }
         }
 
-        instance = _getInstanceForComponent(registry, info);
+        if (info.objectType == STAKING()) {
+            return (info, instance);
+        }
+        
+        if (info.objectType == PRODUCT()) {
+            instance = _getInstance(registry, info.parentNftId);
+        } else {
+            instance = _getInstanceForComponent(registry, info.parentNftId);
+        }
 
         // ensure component is not locked
         if (onlyActive) {
@@ -93,21 +101,15 @@ abstract contract ComponentVerifyingService is
     }
 
 
-    function _getInstanceForComponent(IRegistry registry, IRegistry.ObjectInfo memory componentInfo)
+    function _getInstanceForComponent(IRegistry registry, NftId productNftId)
         internal
         view
         returns (IInstance instance)
     {
-        // parent of product is instance
-        if (componentInfo.objectType == PRODUCT()) {
-            instance = _getInstance(registry, componentInfo.parentNftId);
-        // parent of other types is product
-        } else {
-            instance = _getInstance(
+        return _getInstance(
                 registry,
                 registry.getObjectInfo(
-                    componentInfo.parentNftId).parentNftId);
-        }
+                    productNftId).parentNftId);
     }
 
 

package/contracts/shared/ContractLib.sol

@@ -2,29 +2,159 @@
 pragma solidity ^0.8.20;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {IPolicyHolder} from "./IPolicyHolder.sol";
+// import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, PRODUCT, DISTRIBUTION, ORACLE, POOL, STAKING} from "../type/ObjectType.sol";
+
+interface ITargetHelper {
+    function isTargetLocked(address target) external view returns (bool);
+}
+
+interface IInstanceAdminHelper {
+    function getInstanceAdmin() external view returns (ITargetHelper);
+}
 
 library ContractLib {
 
+    error ErrorContractLibNotRegistered(address target);
+    error ErrorContractLibNotComponent(NftId componentNftId, ObjectType objectType);
+    error ErrorContractLibNotStaking(NftId componentNftId, ObjectType objectType);
+    error ErrorContractLibComponentTypeMismatch(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
+    error ErrorContractLibComponentInactive(NftId componentNftId);
+
+
+    function getAndVerifyComponent(
+        IRegistry registry, 
+        address target,
+        ObjectType expectedType,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info, 
+            address instance
+        )
+    {
+        // check target is component
+        info = _getObjectInfo(registry, target);
+        if(info.objectType != expectedType) {
+            revert ErrorContractLibComponentTypeMismatch(
+                info.nftId,
+                expectedType,
+                info.objectType);
+        }
+
+        // get instance and check component is active
+        instance = _getInstance(registry, info);
+        _checkComponentActive(instance, target, info.nftId, onlyActive);
+    }
+
+
+    function getInfoAndInstance(
+        IRegistry registry,
+        NftId componentNftId,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info, 
+            address instance
+        )
+    {
+        info = registry.getObjectInfo(componentNftId);
+        instance = _getInstance(registry, info);
+        _checkComponentActive(instance, info.objectAddress, info.nftId, onlyActive);
+    }
+
+
+    function getAndVerifyStaking(
+        IRegistry registry, 
+        address target
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info
+        )
+    {
+        // check target is component
+        info = _getObjectInfo(registry, target);
+        if(info.objectType != STAKING()) {
+            revert ErrorContractLibNotStaking(
+                info.nftId,
+                info.objectType);
+        }
+    }
+
+
+    function getAndVerifyAnyComponent(
+        IRegistry registry, 
+        address target,
+        bool onlyActive
+    )
+        external
+        view
+        returns (
+            IRegistry.ObjectInfo memory info, 
+            address instance
+        )
+    {
+        // check target is component
+        info = _getObjectInfo(registry, target);
+        if(!(info.objectType == PRODUCT()
+            || info.objectType == POOL()
+            || info.objectType == DISTRIBUTION()
+            || info.objectType == ORACLE())
+        ) {
+            revert ErrorContractLibNotComponent(
+                info.nftId,
+                info.objectType);
+        }
+
+        // get instance and check component is active
+        instance = _getInstance(registry, info);
+        _checkComponentActive(instance, target, info.nftId, onlyActive);
+    }
+
+
+    function getInstanceForComponent(
+        IRegistry registry, 
+        NftId componentNftId
+    )
+        public
+        view
+        returns (address instance)
+    {
+        NftId productNftId = registry.getObjectInfo(componentNftId).parentNftId;
+        NftId instanceNftId = registry.getObjectInfo(productNftId).parentNftId;
+        return registry.getObjectInfo(instanceNftId).objectAddress;
+    }
+
+
     function isPolicyHolder(address target) external view returns (bool) {
         return ERC165Checker.supportsInterface(target, type(IPolicyHolder).interfaceId);
     }
 
-    function isAccessManaged(address target) external view returns (bool) {
-        if (!isContract(target)) {
+
+    function isRegistry(address registry) public view returns (bool) {
+        if (!isContract(registry)) {
             return false;
         }
 
-        (bool success, ) = target.staticcall(
-            abi.encodeWithSelector(
-                IAccessManaged.authority.selector));
-
-        return success;
+        return supportsInterface(registry, type(IRegistry).interfaceId);
     }
 
+
     function isContract(address target) public view returns (bool) {
+        if (target == address(0)) {
+            return false;
+        }
+
         uint256 size;
         assembly {
             size := extcodesize(target)
@@ -32,7 +162,63 @@ library ContractLib {
         return size > 0;
     }
 
-    function supportsInterface(address target, bytes4 interfaceId)  external view returns (bool) {
+    function supportsInterface(address target, bytes4 interfaceId)  public view returns (bool) {
         return ERC165Checker.supportsInterface(target, interfaceId);
     }
+
+
+    function _checkComponentActive(
+        address instance, 
+        address target, 
+        NftId componentNftId, 
+        bool onlyActive
+    )
+        internal
+        view
+    {
+        if (onlyActive) {
+            if (IInstanceAdminHelper(
+                instance).getInstanceAdmin().isTargetLocked(
+                    target)
+            ) {
+                revert ErrorContractLibComponentInactive(componentNftId);
+            }
+        }
+    }
+
+
+    function _getInstance(
+        IRegistry registry,
+        IRegistry.ObjectInfo memory info
+    )
+        internal
+        view
+        returns (address instance)
+    {
+        if (info.objectType == PRODUCT()) {
+            return registry.getObjectAddress(
+                info.parentNftId);
+        } 
+        
+        return registry.getObjectAddress(
+                registry.getObjectInfo(
+                    info.parentNftId).parentNftId);
+    }
+
+
+    function _getObjectInfo(
+        IRegistry registry, 
+        address target
+    )
+        internal
+        view
+        returns (IRegistry.ObjectInfo memory info)
+    {
+        NftId componentNftId = registry.getNftIdForAddress(target);
+        if (componentNftId.eqz()) {
+            revert ErrorContractLibNotRegistered(target);
+        }
+
+        info = registry.getObjectInfo(componentNftId);
+    }
 }

package/contracts/shared/IComponent.sol

@@ -31,19 +31,12 @@ interface IComponent is
 
     event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
-    event LogComponentTokenHandlerApproved(address token, Amount limit, bool isMaxAmount);
+    event LogComponentTokenHandlerApproved(address tokenHandler, address token, Amount limit, bool isMaxAmount);
 
-    /// @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(Amount 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 to the tokenhandler of the component that 
-    /// covers the current component balance must exist
-    function setWallet(address walletAddress) external;
+    /// @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 spendingLimitAmount) 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