@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-cf68d0c-530

package/contracts/registry/RegistryService.sol

@@ -1,169 +1,187 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
-// import {IInstance} from "../instance/IInstance.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {IInstance} from "../instance/IInstance.sol";
 
 import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
 // import {IComponent, IComponentModule} from "../../contracts/instance/module/component/IComponent.sol";
 // import {IPool} from "../../contracts/instance/module/pool/IPoolModule.sol";
 import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
-// import {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
-// import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
-// import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
+import {IPoolComponent} from "../../contracts/components/IPoolComponent.sol";
+import {IProductComponent} from "../../contracts/components/IProductComponent.sol";
+import {IDistributionComponent} from "../../contracts/components/IDistributionComponent.sol";
 
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
 
-import {RoleId} from "../../contracts/types/RoleId.sol";
-import {ObjectType, REGISTRY, TOKEN, SERVICE, PRODUCT, ORACLE, POOL, TOKEN, INSTANCE, DISTRIBUTION, POLICY, BUNDLE} from "../../contracts/types/ObjectType.sol";
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, POLICY, BUNDLE} from "../../contracts/types/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
 import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
 import {Version, VersionPart, VersionLib} from "../../contracts/types/Version.sol";
 
-import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
-import {IService} from "../../contracts/instance/base/IService.sol";
+import {Service} from "../shared/Service.sol";
+import {IService} from "../shared/IService.sol";
 import {IRegistryService} from "./IRegistryService.sol";
-import {Registry} from "../registry/Registry.sol";
+import {Registry} from "./Registry.sol";
+import {ChainNft} from "./ChainNft.sol";
 
 contract RegistryService is
-    ServiceBase,
+    AccessManagedUpgradeable,
+    Service,
     IRegistryService
 {
     using NftIdLib for NftId;
 
+    // TODO move errors to interface contract
+    error SelfRegistration();
     error NotRegistryOwner();
-    error MissingAllowance();
 
-    error NotToken();
     error NotService();
-    error NotComponent();
     error NotInstance();
-
-    error InvalidAddress(address registerableAddress);
+    error NotProduct();
+    error NotPool();
+    error NotDistribution();
+
+    error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
+    error NotRegisterableOwner(address expectedOwner);
+    error RegisterableOwnerIsZero();   
+    error RegisterableOwnerIsRegistered();
     error InvalidInitialOwner(address initialOwner);
-    error SelfRegistration();
-    error InvalidType(ObjectType objectType);
+    error InvalidAddress(address registerableAddress);
 
+    // Initial value for constant variable has to be compile-time constant
+    // TODO define types as constants?
+    //ObjectType public constant SERVICE_TYPE = REGISTRY(); 
     string public constant NAME = "RegistryService";
 
     // TODO update to real hash when registry is stable
     bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
 
-    address constant public NFT_LOCK_ADDRESS = address(0x1);
+    address public constant NFT_LOCK_ADDRESS = address(0x1);
 
     /// @dev 
     //  msg.sender - ONLY registry owner
-    //      CAN register ANY non IRegisterable address
-    //      CAN register ONLY valid object-parent types combinations for TOKEN
     //      CAN NOT register itself
-    // IMPORTANT: MUST NOT call untrusted contract inbetween calls to registry/instance (trusted contracts)
-    // motivation: registry/instance state may change during external call
-    // TODO it may be usefull to have transferable token nft in order to delist token, make it invalid for new beginings
-    // TODO: MUST prohibit registration of precompiles addresses
-    function registerToken(address tokenAddress)
-        external 
-        returns(NftId nftId) 
+    //      CAN register ONLY valid object-parent types combinations for SERVICE
+    //      CAN register ONLY IRegisterable address he owns
+    // IMPORTANT: MUST NOT check owner before calling external contract
+    function registerService(IService service)
+        external
+        // TODO restrict access - registryService.registerService must use accessmanager for checking permissions as 
+        // services are not always owned by registry owner - actually only registry service is owned by registry owner
+
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
     {
-        IRegisterable registerable = IRegisterable(tokenAddress);
-        bool isRegisterable;
-
-        // registryOwner can not register IRegisterable as TOKEN
-        try registerable.supportsInterface(type(IRegisterable).interfaceId) returns(bool result) {
-            isRegisterable = result;
-        } catch {
-            isRegisterable = false;
+
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!service.supportsInterface(type(IService).interfaceId)) {
+            revert NotService();
         }
 
-        if(isRegisterable) {
-            revert NotToken();
-        } 
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+
+        info.nftId = _registry.register(info);
+        service.linkToRegisteredNftId();
+        return (
+            info,
+            data
+        );
+    }
 
-        NftId registryNftId = _registry.getNftId(address(_registry));
-        if(msg.sender != _registry.ownerOf(registryNftId)) {
-            revert NotRegistryOwner();
+    // If msg.sender is approved service: 
+    // 1) add owner arg (service MUST pass it's msg.sender as owner)
+    // 2) check service allowance 
+    // 3) comment self registrstion check
+    //function registerInstance(IRegisterable instance, address owner)
+    function registerInstance(IRegisterable instance)
+        external
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
+    {
+        if(!instance.supportsInterface(type(IInstance).interfaceId)) {
+            revert NotInstance();
         }
 
-        IRegistry.ObjectInfo memory info = IRegistry.ObjectInfo(
-            zeroNftId(), // any value
-            registryNftId, // parent nft id
-            TOKEN(),
-            false, // isInterceptor
-            tokenAddress,
-            NFT_LOCK_ADDRESS,
-            "" // any value
-        );
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
 
-        nftId = _registry.register(info);
+        info.nftId = _registry.register(info);
+        instance.linkToRegisteredNftId(); // asume safe
+        
+        return (
+            info,
+            data            
+        );
     }
 
-    /// @dev 
-    //  msg.sender - ONLY registry owner
-    //      CAN register ONLY valid object-parent types combinations for SERVICE
-    //      CAN register ONLY IRegisterable address he owns
-    //      CAN NOT register itself
-    // IMPORTANT: MUST NOT check owner before calling external contract
-    function registerService(IService service)
+    function registerProduct(IBaseComponent product, address owner)
         external
+        restricted
         returns(
             IRegistry.ObjectInfo memory info,
             bytes memory data
         ) 
     {
-        if(service.supportsInterface(type(IService).interfaceId) == false) {
-            revert NotService();
-        } 
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
+            revert NotProduct();
+        }
 
         (
             info, 
             data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+        ) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
 
-        NftId registryNftId = _registry.getNftId(address(_registry));
-        if(msg.sender != _registry.ownerOf(registryNftId)) {
-            revert NotRegistryOwner();
-        }
+        NftId serviceNftId = _registry.getNftId(msg.sender);
 
-        info.initialOwner = NFT_LOCK_ADDRESS;//registry.getLockAddress();
         info.nftId = _registry.register(info);
-        service.linkToRegisteredNftId();
+        // TODO unsafe, let component or its owner derive nftId latter, when state assumptions and modifications of GIF contracts are finished  
+        product.linkToRegisteredNftId();
 
         return (
             info,
             data
-        );
+        );  
     }
 
-    // anybody can register component if instance gives a corresponding role
-    //function registerComponent(IBaseComponent component, ObjectType componentType)
-    function registerComponent(IBaseComponent component, ObjectType componentType, address owner)
+    function registerPool(IBaseComponent pool, address owner)
         external
+        restricted
         returns(
             IRegistry.ObjectInfo memory info,
             bytes memory data
         ) 
     {
-        if(!component.supportsInterface(type(IBaseComponent).interfaceId)) {
-            revert NotComponent();
+        if(!pool.supportsInterface(type(IPoolComponent).interfaceId)) {
+            revert NotPool();
         }
 
         (
             info, 
             data
-        ) = _getAndVerifyContractInfo(component, componentType, owner);
+        ) = _getAndVerifyContractInfo(pool, POOL(), owner);
 
         NftId serviceNftId = _registry.getNftId(msg.sender);
 
-        if(!_registry.allowance(serviceNftId, componentType)) {
-            revert MissingAllowance();
-        }      
-
         info.nftId = _registry.register(info);
-        component.linkToRegisteredNftId();
+        pool.linkToRegisteredNftId();
 
         return (
             info,
@@ -171,58 +189,53 @@ contract RegistryService is
         );  
     }
 
-    // TODO: when called by approved service: add owner arg (service must pass it's msg.sender as owner) & check service allowance
-    //function registerInstance(IRegisterable instance, address owner)
-    function registerInstance(IRegisterable instance)
-        external 
+    function registerDistribution(IBaseComponent distribution, address owner)
+        external
+        restricted
         returns(
             IRegistry.ObjectInfo memory info,
             bytes memory data
         ) 
     {
-        // TODO reactivate later
-        // if(instance.supportsInterface(type(IInstance).interfaceId) == false) {
-        //     revert NotInstance();
-        // }
-
-        // (
-        //     info, 
-        //     data
-        // ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);// owner);
-
-        // info.nftId = _registry.register(info);
-        // instance.linkToRegisteredNftId();
-        
-        // return (
-        //     info,
-        //     data            
-        // );
+        if(!distribution.supportsInterface(type(IDistributionComponent).interfaceId)) {
+            revert NotDistribution();
+        }
+
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
+
+        NftId serviceNftId = _registry.getNftId(msg.sender);
+
+        info.nftId = _registry.register(info); 
+        distribution.linkToRegisteredNftId();
+
+        return (
+            info,
+            data
+        );  
     }
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
-        external 
+        external
+        restricted 
         returns(NftId nftId) 
     {
         NftId senderNftId = _registry.getNftId(msg.sender);
 
-        if(_registry.allowance(senderNftId, POLICY()) == false) {
-            revert MissingAllowance();
-        }
-
         _verifyObjectInfo(info, POLICY());
 
         nftId = _registry.register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
-        external 
+        external
+        restricted 
         returns(NftId nftId) 
     {
-        NftId senderNftId = _registry.getNftId(msg.sender);
 
-        if(_registry.allowance(senderNftId, BUNDLE()) == false) {
-            revert MissingAllowance();
-        }
+        NftId senderNftId = _registry.getNftId(msg.sender);
 
         _verifyObjectInfo(info, BUNDLE());
 
@@ -231,9 +244,12 @@ contract RegistryService is
 
 
     // From IService
-    function getName() public pure override(IService, ServiceBase) returns(string memory) {
+    function getName() public pure override(IService, Service) returns(string memory) {
         return NAME;
     }
+    //function getType() public pure override(IService, ServiceBase) returns(ObjectType serviceType) {
+    //    return SERVICE_TYPE;
+    //}
 
 
     // from Versionable
@@ -245,12 +261,19 @@ contract RegistryService is
     // registry is getting instantiated and locked to registry service address forever
     function _initialize(
         address owner, 
-        bytes memory registryByteCodeWithInitCode
+        bytes memory data
     )
         internal
         initializer
         virtual override
     {
+        (
+            address initialAuthority,
+            bytes memory registryByteCodeWithInitCode
+        ) = abi.decode(data, (address, bytes));
+
+        __AccessManaged_init(initialAuthority);
+
         bytes memory encodedConstructorArguments = abi.encode(
             owner,
             getMajorVersion());
@@ -259,26 +282,28 @@ contract RegistryService is
             registryByteCodeWithInitCode,
             encodedConstructorArguments);
 
-        address registryAddress = ContractDeployerLib.deploy(
+        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
             registryCreationCode,
-            REGISTRY_CREATION_CODE_HASH);
+            REGISTRY_CREATION_CODE_HASH));
 
-        IRegistry registry = IRegistry(registryAddress);
-        NftId registryNftId = registry.getNftId(registryAddress);
+        NftId registryNftId = registry.getNftId(address(registry));
 
-        _initializeServiceBase(registryAddress, registryNftId, owner);
-        linkToRegisteredNftId();
+        _initializeService(address(registry), owner);
 
+        // TODO why do registry service proxy need to keep its nftId??? -> no registryServiceNftId checks in implementation
+        // if they are -> use registry address to obtain owner of registry service nft (works the same with any registerable and(or) implementation)
+        linkToRegisteredNftId(); 
         _registerInterface(type(IRegistryService).interfaceId);
     }
 
     // parent check done in registry because of approve()
     function _getAndVerifyContractInfo(
         IRegisterable registerable,
-        ObjectType objectType,
-        address owner
+        ObjectType expectedType, // assume can be valid only
+        address expectedOwner // assume can be 0
     )
         internal
+        view
         returns(
             IRegistry.ObjectInfo memory info, 
             bytes memory data
@@ -288,23 +313,33 @@ contract RegistryService is
             info, 
             data
         ) = registerable.getInitialInfo();
+        info.objectAddress = address(registerable);
 
-        if(info.objectAddress != address(registerable)) {
-            revert InvalidAddress(info.objectAddress);
+        if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
+            revert UnexpectedRegisterableType(expectedType, info.objectType);
         }
 
-        if(
-            getRegistry().isRegistered(owner) ||
-            info.initialOwner != owner) { // contract owner protection
-            revert InvalidInitialOwner(info.initialOwner);
+        address owner = info.initialOwner;
+
+        // solhint-disable-next-line 
+        if(expectedType == INSTANCE()) { 
+            // any address may create a new instance via instance service
+        } else {
+            if(owner != expectedOwner) { // registerable owner protection
+                revert NotRegisterableOwner(expectedOwner);
+            }
         }
 
-        if(msg.sender == address(registerable)) {
+        if(owner == address(registerable)) {
             revert SelfRegistration();
         }
+
+        if(owner == address(0)) {
+            revert RegisterableOwnerIsZero();
+        }
         
-        if(info.objectType != objectType) {
-            revert InvalidType(info.objectType);
+        if(getRegistry().isRegistered(owner)) { 
+            revert RegisterableOwnerIsRegistered();
         }
 
         /*NftId parentNftId = info.parentNftId;
@@ -354,11 +389,6 @@ contract RegistryService is
             revert InitialOwnerIsRegistry();
         }*/
 
-        
-        if(info.objectType != objectType) {
-            revert InvalidType(info.objectType);
-        }
-
         /*NftId parentNftId = info.parentNftId;
         IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
 
@@ -366,4 +396,4 @@ contract RegistryService is
             revert InvalidParent(parentNftId);
         }*/        
     }
-}
+}

package/contracts/registry/RegistryServiceManager.sol

@@ -1,25 +1,39 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
+import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
+
+import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
+
 import {Registry} from "./Registry.sol";
 import {IVersionable} from "../shared/IVersionable.sol";
 import {ProxyManager} from "../shared/ProxyManager.sol";
 import {RegistryService} from "./RegistryService.sol";
+import {TokenRegistry} from "./TokenRegistry.sol";
 
 
 contract RegistryServiceManager is
     ProxyManager
 {
-    RegistryService private _registryService;
+    bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
+
+    AccessManager private _accessManager;
+    RegistryService private _registryService; 
+    TokenRegistry private _tokenRegistry;
 
     /// @dev initializes proxy manager with registry service implementation and deploys registry
     constructor(
+        address accessManager
     )
         ProxyManager()
     {
+        _accessManager = AccessManager(accessManager);
+
+        bytes memory initializationData = abi.encode(accessManager, type(Registry).creationCode);
+
         IVersionable versionable = deploy(
             address(new RegistryService()), 
-            type(Registry).creationCode);
+            initializationData);
 
         _registryService = RegistryService(address(versionable));
 
@@ -28,11 +42,26 @@ contract RegistryServiceManager is
             address(_registryService.getRegistry()),
             address(_registryService));
 
+        // deploy token registry
+
+        // _tokenRegistry = new TokenRegistry(
+        //     address(_registryService.getRegistry()),
+        //     address(_registryService));
+
         // implies that after this constructor call only upgrade functionality is available
         _isDeployed = true;
     }
 
     //--- view functions ----------------------------------------------------//
+
+    function getAccessManager()
+        external
+        view
+        returns (AccessManager)
+    {
+        return _accessManager;
+    }
+
     function getRegistryService()
         external
         view
@@ -40,4 +69,12 @@ contract RegistryServiceManager is
     {
         return _registryService;
     }
+
+    function getTokenRegistry()
+        external
+        view
+        returns (TokenRegistry)
+    {
+        return _tokenRegistry;
+    }
 }

package/contracts/registry/TokenRegistry.sol

@@ -0,0 +1,111 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
+import {NftOwnable} from "../shared/NftOwnable.sol";
+
+/// @title contract to register token per GIF major release.
+contract TokenRegistry is
+    NftOwnable
+{
+
+    string public constant REGISTRY_SERVICE_NAME = "RegistryService";
+
+    event LogRegistered(address token, string symbol, uint256 decimals);
+    event LogTokenStateSet(address token, VersionPart majorVersion, bool active);
+
+    error NotContract(address account);
+    error NotToken(address account);
+    error TokenDecimalsZero();
+    error TokenMajorVersionInvalid(VersionPart majorVersion);
+
+    address [] internal _token;
+    mapping(address token => bool registered) internal _registered;
+    mapping(address token => mapping(VersionPart majorVersion => bool isActive)) internal _active;
+
+    constructor()
+        NftOwnable()
+    { }
+
+
+    /// @dev link ownership of token registry to nft owner of registry service
+    function linkToNftOwnable(address registryAddress) 
+        external
+        onlyOwner
+    {
+        IRegistry registry = IRegistry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress(REGISTRY_SERVICE_NAME, registry.getMajorVersion());
+
+        _linkToNftOwnable(registryAddress, registryServiceAddress);
+    }
+
+    /// @dev token state is informative, registry have no clue about used tokens
+    // component owner is responsible for token selection and operations
+    // service MUST deny registration of component with inactive token 
+    function setActive(address token, VersionPart majorVersion, bool active)
+        external
+        onlyOwner
+    {
+        // verify that token is registered
+        if (!_registered[token]) {
+            _registerToken(token);
+        }
+
+        // verify valid major version
+        // ensure major version increments is one
+        uint256 version = majorVersion.toInt();
+        if (version < _registry.getMajorVersionMin().toInt() || version > _registry.getMajorVersionMax().toInt()) {
+            revert TokenMajorVersionInvalid(majorVersion);
+        }
+
+        _active[token][majorVersion] = active;
+
+        emit LogTokenStateSet(token, majorVersion, active);
+    }
+
+    function tokens() external view returns (uint256) {
+        return _token.length;
+    }
+
+    function getToken(uint256 idx) external view returns (IERC20Metadata token) {
+        return IERC20Metadata(_token[idx]);
+    }
+
+    function isRegistered(address token) external view returns (bool) {
+        return _registered[token];
+    }
+
+     function isActive(address token, VersionPart majorVersion) external view returns (bool) {
+        return _active[token][majorVersion];
+    }
+
+    /// @dev some sanity checks to prevent unintended registration
+    function _registerToken(address token) internal {
+
+        // MUST be contract
+        if(token.code.length == 0) {
+            revert NotContract(token);
+        }
+
+        // MUST not be GIF registerable
+        if(ERC165Checker.supportsInterface(token, type(IRegisterable).interfaceId)) {
+            revert NotToken(token);
+        }
+
+        // MUST have decimals > 0
+        IERC20Metadata erc20 = IERC20Metadata(token);
+        if(erc20.decimals() == 0) {
+            revert TokenDecimalsZero();
+        }
+
+        _registered[token] = true;
+        _token.push(token);
+
+        emit LogRegistered(token, erc20.symbol(), erc20.decimals());
+    }
+}