@etherisc/gif-next 0.0.2-f1b01e0-214 → 0.0.2-f1e6957-384

package/contracts/shared/ContractLib.sol

@@ -5,11 +5,13 @@ import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165C
 import {IAccessManager} from "@openzeppelin/contracts/access/manager/IAccessManager.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-// import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
 import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IService} from "../shared/IService.sol";
+
+import {ChainId} from "../type/ChainId.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, PRODUCT, DISTRIBUTION, ORACLE, POOL, STAKING} from "../type/ObjectType.sol";
+import {ObjectType, INSTANCE, PRODUCT, DISTRIBUTION, ORACLE, POOL} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 
 interface ITargetHelper {
@@ -21,44 +23,18 @@ interface IInstanceAdminHelper {
 }
 
 interface ITokenRegistryHelper {
-    function isActive(uint256 chainId, address token, VersionPart release) external view returns (bool);
+    function isActive(ChainId chainId, address token, VersionPart release) external view returns (bool);
 }
 
 library ContractLib {
 
-    error ErrorContractLibNotRegistered(address target);
-    error ErrorContractLibNotComponent(NftId componentNftId, ObjectType objectType);
-    error ErrorContractLibNotStaking(NftId componentNftId, ObjectType objectType);
+    error ErrorContractLibCallerNotRegistered(address target);
+    error ErrorContractLibCallerNotComponent(NftId componentNftId, ObjectType objectType);
+    error ErrorContractLibParentNotInstance(NftId componentNftId, NftId parentNftId);
+    error ErrorContractLibParentNotProduct(NftId componentNftId, NftId parentNftId);
     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,
@@ -73,34 +49,42 @@ library ContractLib {
         )
     {
         info = registry.getObjectInfo(componentNftId);
-        instance = _getInstance(registry, info);
-        _checkComponentActive(instance, info.objectAddress, info.nftId, onlyActive);
+        return _getAndVerifyComponentAndInstance(registry, info, info.objectType, onlyActive);
     }
 
 
-    function getAndVerifyStaking(
+    function getAndVerifyAnyComponent(
         IRegistry registry, 
-        address target
+        address caller,
+        bool onlyActive
     )
         external
         view
         returns (
-            IRegistry.ObjectInfo memory info
+            IRegistry.ObjectInfo memory callerInfo, 
+            address instance
         )
     {
-        // check target is component
-        info = _getObjectInfo(registry, target);
-        if(info.objectType != STAKING()) {
-            revert ErrorContractLibNotStaking(
-                info.nftId,
-                info.objectType);
+        // check caller is component
+        callerInfo = _getAndVerifyObjectInfo(registry, caller);
+        if(!(callerInfo.objectType == PRODUCT()
+            || callerInfo.objectType == POOL()
+            || callerInfo.objectType == DISTRIBUTION()
+            || callerInfo.objectType == ORACLE())
+        ) {
+            revert ErrorContractLibCallerNotComponent(
+                callerInfo.nftId,
+                callerInfo.objectType);
         }
+
+        return _getAndVerifyComponentAndInstance(registry, callerInfo, callerInfo.objectType, onlyActive);
     }
 
 
-    function getAndVerifyAnyComponent(
+    function getAndVerifyComponent(
         IRegistry registry, 
-        address target,
+        address caller,
+        ObjectType expectedType,
         bool onlyActive
     )
         external
@@ -110,21 +94,8 @@ library ContractLib {
             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);
+        info = _getAndVerifyObjectInfo(registry, caller);
+        return _getAndVerifyComponentAndInstance(registry, info, expectedType, onlyActive);
     }
 
 
@@ -144,8 +115,8 @@ library ContractLib {
 
     function isActiveToken(
         address tokenRegistryAddress,
+        ChainId chainId, 
         address token,
-        uint256 chainId, 
         VersionPart release
     )
         external 
@@ -157,6 +128,7 @@ library ContractLib {
                 chainId, token, release);
     }
 
+
     function isPolicyHolder(address target) external view returns (bool) {
         return ERC165Checker.supportsInterface(target, type(IPolicyHolder).interfaceId);
     }
@@ -198,6 +170,15 @@ library ContractLib {
     }
 
 
+    function isService(address service) public view returns (bool) {
+        if (!isContract(service)) {
+            return false;
+        }
+
+        return supportsInterface(service, type(IService).interfaceId);
+    }
+
+
     function isRegistry(address registry) public view returns (bool) {
         if (!isContract(registry)) {
             return false;
@@ -224,6 +205,37 @@ library ContractLib {
     }
 
 
+    function _getAndVerifyComponentAndInstance(
+        IRegistry registry, 
+        IRegistry.ObjectInfo memory info,
+        ObjectType expectedType,
+        bool onlyActive
+    )
+        internal
+        view
+        returns (
+            IRegistry.ObjectInfo memory, 
+            address instance
+        )
+    {
+        if(info.objectType != expectedType) {
+            revert ErrorContractLibComponentTypeMismatch(
+                info.nftId,
+                expectedType,
+                info.objectType);
+        }
+
+        // get instance and check component is active
+        instance = getAndVerifyInstance(registry, info);
+        _checkComponentActive(instance, info.objectAddress, info.nftId, onlyActive);
+
+        return (
+            info,
+            instance
+        );
+    }
+
+
     function _checkComponentActive(
         address instance, 
         address target, 
@@ -244,36 +256,55 @@ library ContractLib {
     }
 
 
-    function _getInstance(
+    /// @dev Given an object info the function returns the instance address.
+    /// The info may represent a product or any other component.
+    /// If the parent of the provided info is not registered with the correct type, the function reverts.
+    function getAndVerifyInstance(
         IRegistry registry,
         IRegistry.ObjectInfo memory info
     )
-        internal
+        public
         view
         returns (address instance)
     {
+        // get instance for product case
         if (info.objectType == PRODUCT()) {
-            return registry.getObjectAddress(
+            // verify that parent of product is registered instance
+            IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(info.parentNftId);
+            if (instanceInfo.objectType != INSTANCE()) {
+                revert ErrorContractLibParentNotInstance(
+                    info.nftId,
+                    info.parentNftId);
+            }
+
+            // we have verified that parent object is a registerd instance -> we return the instance address
+            return instanceInfo.objectAddress;
+        }
+
+        // not product: verify parent is registered product
+        info = registry.getObjectInfo(info.parentNftId);
+        if (info.objectType != PRODUCT()) {
+            revert ErrorContractLibParentNotProduct(
+                info.nftId,
                 info.parentNftId);
-        } 
-        
-        return registry.getObjectAddress(
-                registry.getObjectInfo(
-                    info.parentNftId).parentNftId);
+        }
+
+        // we have verified that parent is registerd product -> we can rely on registry that its parent is an instance
+        return registry.getObjectAddress(info.parentNftId);
     }
 
 
-    function _getObjectInfo(
+    function _getAndVerifyObjectInfo(
         IRegistry registry, 
-        address target
+        address caller
     )
         internal
         view
         returns (IRegistry.ObjectInfo memory info)
     {
-        NftId componentNftId = registry.getNftIdForAddress(target);
+        NftId componentNftId = registry.getNftIdForAddress(caller);
         if (componentNftId.eqz()) {
-            revert ErrorContractLibNotRegistered(target);
+            revert ErrorContractLibCallerNotRegistered(caller);
         }
 
         info = registry.getObjectInfo(componentNftId);

package/contracts/shared/IComponent.sol

@@ -40,7 +40,7 @@ interface IComponent is
     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
+    /// the default address is the token handler address
     function getWallet() external view returns (address walletAddress);
 
     /// @dev returns true iff this compoent intercepts nft minting and transfers for objects registered by this component

package/contracts/shared/IComponentService.sol

@@ -16,22 +16,20 @@ import {VersionPart} from "../type/Version.sol";
 interface IComponentService is 
     IService
 {
+    // registerProduct
+    error ErrorComponentServiceCallerNotInstance(address caller);
+    error ErrorComponentServiceNotProduct(address product);
     error ErrorComponentServiceTokenInvalid(address token);
 
-    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
-    error ErrorComponentServiceSenderNotRegistered(address sender);
+    // registerComponent
+    error ErrorComponentServiceCallerNotProduct(address caller);
     error ErrorComponentServiceNotComponent(address component);
-    error ErrorComponentServiceTypeNotSupported(address component, ObjectType invalidType);
-    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
-    error ErrorComponentServiceAlreadyRegistered(address component);
-    error ErrorComponentServiceReleaseMismatch(address component, VersionPart componentRelease, VersionPart parentRelease);
-    error ErrorComponentServiceSenderNotComponentParent(NftId senderNftId, NftId compnentParentNftId);
-    error ErrorComponentServiceParentNotInstance(NftId nftId, ObjectType objectType);
-    error ErrorComponentServiceParentNotProduct(NftId nftId, ObjectType objectType);
-
-    error ErrorComponentServiceNotRegistered(address instanceAddress);
-    error ErrorComponentServiceNotInstance(address instanceAddress, ObjectType objectType);
-    error ErrorComponentServiceInstanceVersionMismatch(address instanceAddress, VersionPart instanceVersion);
+
+    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
+    error ErrorComponentServiceComponentTypeNotSupported(address component, ObjectType invalid);
+    error ErrorComponentServiceComponentParentInvalid(address component, NftId required, NftId actual);
+    error ErrorComponentServiceComponentReleaseMismatch(address component, VersionPart serviceRelease, VersionPart componentRelease);
+    error ErrorComponentServiceComponentAlreadyRegistered(address component);
     
     error ErrorProductServiceNoDistributionExpected(NftId productNftId);
     error ErrorProductServiceDistributionAlreadyRegistered(NftId productNftId, NftId distributionNftId);
@@ -47,6 +45,7 @@ interface IComponentService is
     error ErrorComponentServiceWithdrawAmountExceedsLimit(Amount withdrawnAmount, Amount withdrawLimit);
     error ErrorComponentServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
 
+    event LogComponentServiceComponentLocked(address component, bool locked);
     event LogComponentServiceRegistered(NftId instanceNftId, NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
     event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
     event LogComponentServiceWalletTokensTransferred(NftId componentNftId, address currentWallet, address newWallet, uint256 currentBalance);

package/contracts/shared/INftOwnable.sol

@@ -11,6 +11,8 @@ interface INftOwnable is
     IERC165,
     IRegistryLinked
 {
+    event LogNftOwnableNftLinkedToAddress(NftId nftId, address owner);
+    
     error ErrorNftOwnableInitialOwnerZero();
     error ErrorNftOwnableNotOwner(address account);
     error ErrorNftOwnableInvalidType(NftId nftId, ObjectType expectedObjectType);

package/contracts/shared/IRegisterable.sol

@@ -6,7 +6,6 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {INftOwnable} from "./INftOwnable.sol";
 import {IRelease} from "../registry/IRelease.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {VersionPart} from "../type/Version.sol";
 
 /// @title IRegisterable
 /// @dev Marks contracts that are intended to be registered in the registry.

package/contracts/shared/InstanceLinkedComponent.sol

@@ -52,12 +52,12 @@ abstract contract InstanceLinkedComponent is
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view override returns (IInstance instance) {
+    function getInstance() public view virtual override returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getAuthorization() external view returns (IAuthorization authorization) {
+    function getAuthorization() external view virtual returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
@@ -67,15 +67,14 @@ abstract contract InstanceLinkedComponent is
         }
     }
 
-    function _initializeInstanceLinkedComponent(
+    function __InstanceLinkedComponent_init(
         address registry,
         NftId parentNftId,
         string memory name,
         ObjectType componentType,
         IAuthorization authorization,
         bool isInterceptor,
-        address initialOwner,
-        bytes memory componentData // data that will saved with the component info in the instance store
+        address initialOwner
     )
         internal
         virtual
@@ -93,7 +92,7 @@ abstract contract InstanceLinkedComponent is
             IRegistry(registry).getObjectAddress(instanceNftId));
 
         // set component specific parameters
-        _initializeComponent(
+        __Component_init(
             $._instance.authority(), // instance linked components need to point to instance admin
             registry, 
             parentNftId, 
@@ -101,8 +100,7 @@ abstract contract InstanceLinkedComponent is
             componentType, 
             isInterceptor, 
             initialOwner, 
-            "", // registry data
-            componentData);
+            ""); // registry data
 
         // set instance linked specific parameters
         $._instanceReader = $._instance.getInstanceReader();
@@ -110,7 +108,6 @@ abstract contract InstanceLinkedComponent is
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
         // register interfaces
-        _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 

package/contracts/shared/NftOwnable.sol

@@ -41,7 +41,7 @@ contract NftOwnable is
     }
 
     function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
-        if(!getRegistry().isObjectType(nftId, expectedObjectType)) {
+        if(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType)) {
             revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
         }
     }
@@ -114,6 +114,8 @@ contract NftOwnable is
 
         $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
+        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+
         return $._nftId;
     }
 

package/contracts/shared/PolicyHolder.sol

@@ -3,12 +3,13 @@ pragma solidity ^0.8.20;
 
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
+import {IPolicyHolder} from "./IPolicyHolder.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {InitializableERC165} from "./InitializableERC165.sol";
-import {IPolicyHolder} from "./IPolicyHolder.sol";
 import {NftId} from "../type/NftId.sol";
-import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 

package/contracts/shared/Service.sol

@@ -1,16 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
 import {IVersionable} from "../upgradeability/IVersionable.sol";
-import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
+import {ObjectType, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Version, VersionLib} from "../type/Version.sol";
 import {Versionable} from "../upgradeability/Versionable.sol";
 
 
@@ -53,12 +52,15 @@ abstract contract Service is
         return VersionLib.toVersion(3, 0, 0);
     }
 
+
     function getRoleId() external virtual view returns(RoleId serviceRoleId) {
-        return RoleIdLib.roleForTypeAndVersion(_getDomain(), getRelease());
+        return RoleIdLib.toServiceRoleId(_getDomain(), getRelease());
     }
 
+    //--- internal functions --------------------------------------------------------//
     function _getDomain() internal virtual pure returns (ObjectType);
 
+
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
         return getRegistry().getServiceAddress(domain, getRelease());
     }