@etherisc/gif-next 0.0.2-95b223b-528 → 0.0.2-95f0eec-843

package/contracts/shared/ComponentServiceManager.sol

@@ -17,7 +17,7 @@ contract ComponentServiceManager is ProxyManager {
     )
     {
         ComponentService svc = new ComponentService();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/shared/ContractLib.sol

@@ -2,12 +2,16 @@
 pragma solidity ^0.8.20;
 
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+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 {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 {
     function isTargetLocked(address target) external view returns (bool);
@@ -17,43 +21,20 @@ interface IInstanceAdminHelper {
     function getInstanceAdmin() external view returns (ITargetHelper);
 }
 
+interface ITokenRegistryHelper {
+    function isActive(uint256 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,
         NftId componentNftId,
@@ -67,34 +48,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
@@ -104,21 +93,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);
     }
 
 
@@ -130,17 +106,78 @@ library ContractLib {
         view
         returns (address instance)
     {
-        NftId productNftId = registry.getObjectInfo(componentNftId).parentNftId;
-        NftId instanceNftId = registry.getObjectInfo(productNftId).parentNftId;
+        NftId productNftId = registry.getParentNftId(componentNftId);
+        NftId instanceNftId = registry.getParentNftId(productNftId);
         return registry.getObjectInfo(instanceNftId).objectAddress;
     }
 
 
+    function isActiveToken(
+        address tokenRegistryAddress,
+        address token,
+        uint256 chainId, 
+        VersionPart release
+    )
+        external 
+        view 
+        returns (bool)
+    {
+        return ITokenRegistryHelper(
+            tokenRegistryAddress).isActive(
+                chainId, token, release);
+    }
+
+
     function isPolicyHolder(address target) external view returns (bool) {
         return ERC165Checker.supportsInterface(target, type(IPolicyHolder).interfaceId);
     }
 
 
+    function isAuthority(address authority) public view returns (bool) {
+        if (!isContract(authority)) {
+            return false;
+        }
+
+        return supportsInterface(authority, type(IAccessManager).interfaceId);
+    }
+
+
+    function isAccessManaged(address target)
+        public
+        view
+        returns (bool)
+    {
+        if (!isContract(target)) {
+            return false;
+        }
+
+        (bool success, ) = target.staticcall(
+            abi.encodeWithSelector(
+                IAccessManaged.authority.selector));
+
+        return success;
+    }
+
+
+    function isRegistered(address registry, address caller, ObjectType expectedType) public view returns (bool) {
+        NftId nftId = IRegistry(registry).getNftIdForAddress(caller);
+        if (nftId.eqz()) {
+            return false;
+        }
+
+        return IRegistry(registry).getObjectInfo(nftId).objectType == expectedType;
+    }
+
+
+    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;
@@ -167,6 +204,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, 
@@ -187,36 +255,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

@@ -1,7 +1,6 @@
 // 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 {Amount} from "../type/Amount.sol";
@@ -13,7 +12,6 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 /// @dev component base class
 /// component examples are staking, product, distribution, pool and oracle
 interface IComponent is 
-    IAccessManaged,
     IRegisterable,
     ITransferInterceptor
 {
@@ -23,8 +21,6 @@ interface IComponent is
 
     error ErrorComponentNotChainNft(address caller);
 
-    error ErrorComponentTokenAddressNonzero();
-    error ErrorComponentTokenAddressZero();
     error ErrorComponentWalletAddressZero();
     error ErrorComponentWalletAddressIsSameAsCurrent();
     error ErrorComponentWalletNotComponent();
@@ -44,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,20 +16,20 @@ import {VersionPart} from "../type/Version.sol";
 interface IComponentService is 
     IService
 {
-    error ErrorComponentServiceNotInstanceLinkedComponent(address component);
-    error ErrorComponentServiceSenderNotRegistered(address sender);
+    // registerProduct
+    error ErrorComponentServiceCallerNotInstance(address caller);
+    error ErrorComponentServiceNotProduct(address product);
+    error ErrorComponentServiceTokenInvalid(address token);
+
+    // 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);
@@ -45,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);
@@ -56,9 +57,9 @@ interface IComponentService is
         NftId nftId, 
         string feeName, 
         UFixed previousFractionalFee, 
-        uint256 previousFixedFee,
+        Amount previousFixedFee,
         UFixed newFractionalFee, 
-        uint256 newFixedFee
+        Amount newFixedFee
     );
     
     //-------- component ----------------------------------------------------//
@@ -67,18 +68,12 @@ interface IComponentService is
     /// Reverts if the component's token handler wallet is not the token handler itself.
     function approveTokenHandler(IERC20Metadata token, Amount amount) external;
 
-    /// @dev Approves the staking token handler.
-    /// Reverts if the staking token handler wallet is not the token handler itself.
-    function approveStakingTokenHandler(IERC20Metadata token, Amount amount) external;
-
-    /// @dev Sets the components associated wallet address
+    /// @dev Sets the components associated wallet address.
+    /// To set the wallet to the token handler contract, use address(0) as the new wallet adress.
     function setWallet(address newWallet) external;
 
-    /// @dev Locks/Unlocks the given component - call from instanceService
-    function setLockedFromInstance(address componentAddress, bool locked) external;
-
-    /// @dev Locks/Unlocks the given component - call from component
-    function setLockedFromComponent(address componentAddress, bool locked) external;
+    /// @dev Locks/Unlocks the calling component.
+    function setLocked(bool locked) external;
 
     /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
     /// @param withdrawAmount the amount to withdraw
@@ -91,7 +86,7 @@ interface IComponentService is
     //-------- product ------------------------------------------------------//
 
     /// @dev Registers the specified product component for the instance (sender)
-    function registerProduct(address product) external returns (NftId productNftId);
+    function registerProduct(address product, address token) external returns (NftId productNftId);
 
     function setProductFees(
         Fee memory productFee, // product fee on net premium

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

@@ -1,19 +1,29 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
 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.
 /// 
 interface IRegisterable is
-    INftOwnable
+    IAccessManaged,
+    INftOwnable,
+    IRelease
 {
-    /// @dev retuns the GIF release version for this contract.
-    /// This 
-    function getRelease() external pure returns (VersionPart release);
+    // __Registerable_init
+    error ErrorAuthorityInvalid(address authority);
+
+    // onlyActive()
+    error ErrorRegisterableNotActive();
+
+    /// @dev Returns true iff this contract managed by its authority is active.
+    /// Queries the IAccessManaged.authority().
+    function isActive() external view returns (bool active);
 
     /// @dev retuns the object info relevant for registering for this contract 
     /// IMPORTANT information returned by this function may only be used

package/contracts/shared/IService.sol

@@ -9,17 +9,15 @@ import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
+    IAccessManaged,
     IRegisterable,
-    IVersionable,
-    IAccessManaged
+    IVersionable
 {
-    error ErrorServiceNotImplemented();
-
     /// @dev returns the domain for this service.
     /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
 
     /// @dev returns the GIF release specific role id.
     /// These role ids are used to authorize service to service communication.
-    function getRoleId() external pure returns(RoleId serviceRoleId);
+    function getRoleId() external view returns(RoleId serviceRoleId);
 }

package/contracts/shared/InitializableERC165.sol

@@ -11,13 +11,21 @@ contract InitializableERC165 is
     mapping(bytes4 => bool) private _isSupported;
 
     // @dev initializes with support for ERC165
-    function _initializeERC165() internal onlyInitializing() {
+    function __ERC165_init() internal onlyInitializing() {
+        _initializeERC165();
+    }
+
+    function _initializeERC165() internal {
         _isSupported[type(IERC165).interfaceId] = true;
     }
 
     // @dev register support for provided interfaceId
     // includes initialization for ERC165_ID if not yet done
     function _registerInterface(bytes4 interfaceId) internal onlyInitializing() {
+        _registerInterfaceNotInitializing(interfaceId);
+    }
+
+    function _registerInterfaceNotInitializing(bytes4 interfaceId) internal{
         _isSupported[interfaceId] = true;
     }
 

package/contracts/shared/InstanceLinkedComponent.sol

@@ -20,7 +20,7 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType, COMPONENT, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPart} from "../type/Version.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;
     }
 
@@ -71,7 +71,6 @@ abstract contract InstanceLinkedComponent is
         address registry,
         NftId parentNftId,
         string memory name,
-        address token,
         ObjectType componentType,
         IAuthorization authorization,
         bool isInterceptor,
@@ -99,7 +98,6 @@ abstract contract InstanceLinkedComponent is
             registry, 
             parentNftId, 
             name, 
-            token,
             componentType, 
             isInterceptor, 
             initialOwner, 
@@ -112,7 +110,6 @@ abstract contract InstanceLinkedComponent is
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
         // register interfaces
-        _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
@@ -134,7 +131,7 @@ abstract contract InstanceLinkedComponent is
 
         // if not product parent is product, and parent of product is instance
         IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
-        return registry.getObjectInfo(parentNftId).parentNftId;
+        return registry.getParentNftId(parentNftId);
     }
 
     /// @dev checks the and gets registry.

package/contracts/shared/NftOwnable.sol

@@ -41,15 +41,15 @@ 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);
         }
     }
 
 
-    /// @dev initialization for upgradable contracts
-    // used in _initializeRegisterable
-    function _initializeNftOwnable(
+    /// @dev Initialization for upgradable contracts.
+    // used in __Registerable_init, ProxyManager._preDeployChecksAndSetup
+    function __NftOwnable_init(
         address registry,
         address initialOwner
     )
@@ -57,8 +57,8 @@ contract NftOwnable is
         virtual
         onlyInitializing()
     {
-        _initializeRegistryLinked(registry);
-        _initializeERC165();
+        __ERC165_init();
+        __RegistryLinked_init(registry);
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -114,6 +114,8 @@ contract NftOwnable is
 
         $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
+        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+
         return $._nftId;
     }