@etherisc/gif-next 0.0.2-743affe-003 → 0.0.2-7878646-744

package/contracts/registry/RegistryService.sol

@@ -1,13 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistry} from "./IRegistry.sol";
 import {IInstance} from "../instance/IInstance.sol";
 
-//import {ITreasury, ITreasuryModule} from "../../contracts/instance/module/treasury/ITreasury.sol";
-//import {TreasuryModule} from "../../contracts/instance/module/treasury/TreasuryModule.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";
@@ -25,44 +27,53 @@ 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 {UFixed, UFixedMathLib} from "../../contracts/types/UFixed.sol";
-
 
 import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
 import {IService} from "../../contracts/instance/base/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
+    AccessManagedUpgradeable,
     ServiceBase,
     IRegistryService
 {
     using NftIdLib for NftId;
 
+    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";
 
-    bytes32 public constant REGISTRY_CREATIONCODE_HASH = 0x7e569c7200a12c63728b648d78f84be7e32ef6804f9ee723e15363ce34d01251;
+    // 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
+    //      CAN NOT register IRegisterable address
+    //      CAN register ONLY valid object-parent types combinations for TOKEN
     // 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
@@ -71,29 +82,25 @@ contract RegistryService is
         external 
         returns(NftId nftId) 
     {
-        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;
-        }
+        if(msg.sender == tokenAddress) {
+            revert SelfRegistration();
+        }    
 
-        if(isRegisterable) {
+        // MUST not revert if no ERC165 support
+        if(tokenAddress.code.length == 0 ||
+            ERC165Checker.supportsInterface(tokenAddress, type(IRegisterable).interfaceId)) {
             revert NotToken();
-        } 
+        }
 
-        IRegistry registry = getRegistry();
+        NftId registryNftId = _registry.getNftId(address(_registry));
 
-        if(msg.sender != registry.ownerOf(address(registry))) {
+        if(msg.sender != _registry.ownerOf(registryNftId)) {
             revert NotRegistryOwner();
         }
 
         IRegistry.ObjectInfo memory info = IRegistry.ObjectInfo(
             zeroNftId(), // any value
-            registry.getNftId(address(registry)),
+            registryNftId, // parent nft id
             TOKEN(),
             false, // isInterceptor
             tokenAddress,
@@ -101,14 +108,14 @@ contract RegistryService is
             "" // any value
         );
 
-        nftId = registry.register(info);
+        nftId = _registry.register(info);
     }
 
     /// @dev 
     //  msg.sender - ONLY registry owner
+    //      CAN NOT register itself
     //      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)
         external
@@ -117,56 +124,83 @@ contract RegistryService is
             bytes memory data
         ) 
     {
-        if(service.supportsInterface(type(IService).interfaceId) == false) {
+
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!service.supportsInterface(type(IService).interfaceId)) {
             revert NotService();
-        } 
+        }
 
         (
             info, 
             data
         ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
 
-        IRegistry registry = getRegistry();
-
-        if(msg.sender != registry.ownerOf(address(registry))) {
+        if(msg.sender != _registry.getOwner()) {
             revert NotRegistryOwner();
         }
 
-        info.initialOwner = NFT_LOCK_ADDRESS;//registry.getLockAddress();
-        info.nftId = registry.register(info);
-
+        info.nftId = _registry.register(info);
+        service.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)
+    // 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(component.supportsInterface(type(IBaseComponent).interfaceId) == false) {
-            revert NotComponent();
+
+        if(!instance.supportsInterface(type(IInstance).interfaceId)) {
+            revert NotInstance();
         }
 
         (
             info, 
             data
-        ) = _getAndVerifyContractInfo(component, componentType, owner);
+        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
+
+        info.nftId = _registry.register(info);
+        instance.linkToRegisteredNftId(); // asume safe
+        
+        return (
+            info,
+            data            
+        );
+    }
 
-        IRegistry registry = getRegistry();
-        NftId serviceNftId = registry.getNftId(msg.sender);
+    function registerProduct(IBaseComponent product, address owner)
+        external
+        restricted
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory data
+        ) 
+    {
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
+            revert NotProduct();
+        }
+
+        (
+            info, 
+            data
+        ) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
 
-        if(registry.allowance(serviceNftId, componentType) == false) {
-            revert MissingAllowance();
-        }      
+        NftId serviceNftId = _registry.getNftId(msg.sender);
 
-        info.nftId = registry.register(info);
+        info.nftId = _registry.register(info);
+        // TODO unsafe, let component or its owner derive nftId latter, when state assumptions and modifications of GIF contracts are finished  
+        product.linkToRegisteredNftId();
 
         return (
             info,
@@ -174,68 +208,85 @@ 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 registerPool(IBaseComponent pool, address owner)
+        external
+        restricted
         returns(
             IRegistry.ObjectInfo memory info,
             bytes memory data
         ) 
     {
-        if(instance.supportsInterface(type(IInstance).interfaceId) == false) {
-            revert NotInstance();
+        if(!pool.supportsInterface(type(IPoolComponent).interfaceId)) {
+            revert NotPool();
         }
 
         (
             info, 
             data
-        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);// owner);
+        ) = _getAndVerifyContractInfo(pool, POOL(), owner);
 
-        IRegistry registry = getRegistry();
+        NftId serviceNftId = _registry.getNftId(msg.sender);
 
-        //if(registry.allowance(registry.getNftId(msg.sender), INSTANCE()) == false) {
-        //    revert MissingAllowance();
-        //}
+        info.nftId = _registry.register(info);
+        pool.linkToRegisteredNftId();
 
-        info.nftId = registry.register(info);     
-        
         return (
             info,
-            data            
-        );
+            data
+        );  
+    }
+
+    function registerDistribution(IBaseComponent distribution, address owner)
+        external
+        restricted
+        returns(
+            IRegistry.ObjectInfo memory info,
+            bytes memory 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) 
     {
-        IRegistry registry = getRegistry();
-        NftId senderNftId = registry.getNftId(msg.sender);
-
-        if(registry.allowance(senderNftId, POLICY()) == false) {
-            revert MissingAllowance();
-        }
+        NftId senderNftId = _registry.getNftId(msg.sender);
 
         _verifyObjectInfo(info, POLICY());
 
-        nftId = registry.register(info);
+        nftId = _registry.register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
-        external 
+        external
+        restricted 
         returns(NftId nftId) 
     {
-        IRegistry registry = getRegistry();
-        NftId senderNftId = registry.getNftId(msg.sender);
 
-        if(registry.allowance(senderNftId, BUNDLE()) == false) {
-            revert MissingAllowance();
-        }
+        NftId senderNftId = _registry.getNftId(msg.sender);
 
         _verifyObjectInfo(info, BUNDLE());
 
-        nftId = registry.register(info);
+        nftId = _registry.register(info);
     }
 
 
@@ -243,6 +294,9 @@ contract RegistryService is
     function getName() public pure override(IService, ServiceBase) returns(string memory) {
         return NAME;
     }
+    //function getType() public pure override(IService, ServiceBase) returns(ObjectType serviceType) {
+    //    return SERVICE_TYPE;
+    //}
 
 
     // from Versionable
@@ -252,47 +306,51 @@ contract RegistryService is
     // 2) deploy registry service first -> from its initialization func it is easier to deploy registry then vice versa
     // 3) deploy registry -> pass registry service address as constructor argument
     // registry is getting instantiated and locked to registry service address forever
-    function _initialize(address protocolOwner, bytes memory registryCreationCode)
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
         internal
         initializer
         virtual override
     {
-        // TODO check when stable
-        //require(keccak256(registryCreationCode) == REGISTRY_CREATIONCODE_HASH, "INVALID_REGISTRY_CREATIONCODE");
-
-        bytes memory bytecode = abi.encodePacked(
-            registryCreationCode, 
-            abi.encode(
-                protocolOwner,
-                getMajorVersion()
-            )
-        );
+        (
+            address initialAuthority,
+            bytes memory registryByteCodeWithInitCode
+        ) = abi.decode(data, (address, bytes));
 
-        address registryAddress;
+        __AccessManaged_init(initialAuthority);
 
-        assembly {
-            registryAddress := create(0, add(bytecode, 0x20), mload(bytecode))  
+        bytes memory encodedConstructorArguments = abi.encode(
+            owner,
+            getMajorVersion());
 
-            if iszero(extcodesize(registryAddress)) {
-                revert(0, 0)
-            }
-        }
+        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
+            registryByteCodeWithInitCode,
+            encodedConstructorArguments);
+
+        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
+            registryCreationCode,
+            REGISTRY_CREATION_CODE_HASH));
 
-        IRegistry registry = IRegistry(registryAddress);
-        NftId registryNftId = registry.getNftId(registryAddress);
+        NftId registryNftId = registry.getNftId(address(registry));
 
-        _initializeServiceBase(registryAddress, registryNftId, protocolOwner);
+        _initializeServiceBase(address(registry), registryNftId, 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
@@ -302,23 +360,28 @@ 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;
+
+        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;
@@ -368,11 +431,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);
 
@@ -380,4 +438,4 @@ contract RegistryService is
             revert InvalidParent(parentNftId);
         }*/        
     }
-}
+}

package/contracts/registry/RegistryServiceManager.sol

@@ -0,0 +1,64 @@
+// 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";
+
+
+contract RegistryServiceManager is
+    ProxyManager
+{
+    bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
+
+    RegistryService private _registryService; 
+
+    AccessManager private _accessManager;
+
+    /// @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()), 
+            initializationData);
+
+        _registryService = RegistryService(address(versionable));
+
+        // link ownership of registry service manager ot nft owner of registry service
+        _linkToNftOwnable(
+            address(_registryService.getRegistry()),
+            address(_registryService));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getRegistryService()
+        external
+        view
+        returns (RegistryService registryService)
+    {
+        return _registryService;
+    }
+
+    function getAccessManager()
+        external
+        view
+        returns (AccessManager)
+    {
+        return _accessManager;
+    }
+}

package/contracts/shared/ContractDeployerLib.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+library ContractDeployerLib {
+
+    event LogContractDeployed(address contractAddress);
+
+    error ErrorCreationCodeHashMismatch(bytes32 expectedHash, bytes32 actualHash);
+
+    /// @dev deploys a new contract using the provided creation code
+    function deploy(
+        bytes memory creationCode,
+        bytes32 expectedCreationCodeHash
+    ) 
+        public
+        returns (address contractAdress)
+    {
+        // check against expected hash, if provided
+        if (expectedCreationCodeHash != bytes32(0)) {
+            bytes32 creationCodeHash = getHash(creationCode);
+            if (creationCodeHash != expectedCreationCodeHash) {
+                revert ErrorCreationCodeHashMismatch(expectedCreationCodeHash, creationCodeHash);
+            }
+        }
+
+        // solhint-disable no-inline-assembly
+        assembly {
+            contractAdress := create(0, add(creationCode, 0x20), mload(creationCode))  
+
+            if iszero(extcodesize(contractAdress)) {
+                revert(0, 0)
+            }
+        }
+        // solhint enable
+
+        emit LogContractDeployed(contractAdress);
+    }
+
+    /// @dev gets the creation code for the new contract
+    // for terminology see eg https://www.rareskills.io/post/ethereum-contract-creation-code
+    function getCreationCode(
+        bytes memory byteCodeWithInitCode, // what you get with type(<Contract>).creationCode
+        bytes memory encodedConstructorArguments // what you get with 
+    )
+        public
+        pure
+        returns (bytes memory creationCode)
+    {
+        return abi.encodePacked(byteCodeWithInitCode, encodedConstructorArguments);
+    }
+
+
+    function matchesWithHash(
+        bytes memory creationCode,
+        bytes32 expectedHash
+    )
+        public
+        pure
+        returns (bool isMatching)
+    {
+        return getHash(creationCode) == expectedHash;
+    }
+
+
+    function getHash(bytes memory creationCode)
+        public
+        pure
+        returns (bytes32 hash)
+    {
+        return keccak256(creationCode);
+    }
+}

package/contracts/shared/ERC165.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 contract ERC165 is IERC165 {
     mapping(bytes4 => bool) private _isSupported;

package/contracts/shared/INftOwnable.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface INftOwnable {
+    error ErrorNotOwner(address account);
+
+    error ErrorAlreadyLinked(address registry, NftId nftId);
+    error ErrorRegistryAlreadyInitialized(address registry);
+    error ErrorRegistryNotInitialized();
+    error ErrorRegistryAddressZero();
+    error ErrorNotRegistry(address registryAddress);
+    error ErrorContractNotRegistered(address contractAddress);
+
+    function linkToRegisteredNftId() external;
+
+    function getRegistry() external view returns (IRegistry);
+    function getNftId() external view returns (NftId);
+    function getOwner() external view returns (address);
+}