@etherisc/gif-next 0.0.2-7878646-744 → 0.0.2-788faba-168

package/contracts/registry/RegistryService.sol

@@ -1,441 +1,241 @@
 // 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 {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-
-import {IRegistry} from "./IRegistry.sol";
+import {IComponent} from "../../contracts/shared/IComponent.sol";
+import {IDistributionComponent} from "../../contracts/distribution/IDistributionComponent.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 {IVersionable} from "../../contracts/shared/IVersionable.sol";
-import {Versionable} from "../../contracts/shared/Versionable.sol";
+import {IPoolComponent} from "../../contracts/pool/IPoolComponent.sol";
+import {IProductComponent} from "../../contracts/product/IProductComponent.sol";
 import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
-
-import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
-import {ObjectType, REGISTRY, TOKEN, SERVICE, PRODUCT, ORACLE, POOL, TOKEN, 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 {IRegistry} from "./IRegistry.sol";
 import {IRegistryService} from "./IRegistryService.sol";
-import {Registry} from "./Registry.sol";
-import {ChainNft} from "./ChainNft.sol";
+
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE, STAKING, PRICE} from "../../contracts/type/ObjectType.sol";
+import {NftId, NftIdLib} from "../../contracts/type/NftId.sol";
+import {Service} from "../shared/Service.sol";
 
 contract RegistryService is
-    AccessManagedUpgradeable,
-    ServiceBase,
+    Service,
     IRegistryService
 {
-    using NftIdLib for NftId;
-
-    error SelfRegistration();
-    error NotRegistryOwner();
-
-    error NotToken();
-    error NotService();
-    error NotInstance();
-    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 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 public constant NFT_LOCK_ADDRESS = address(0x1);
-
-    /// @dev 
-    //  msg.sender - ONLY registry owner
-    //      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
-    // TODO: MUST prohibit registration of precompiles addresses
-    function registerToken(address tokenAddress)
-        external 
-        returns(NftId nftId) 
-    {
-        if(msg.sender == tokenAddress) {
-            revert SelfRegistration();
-        }    
-
-        // MUST not revert if no ERC165 support
-        if(tokenAddress.code.length == 0 ||
-            ERC165Checker.supportsInterface(tokenAddress, type(IRegisterable).interfaceId)) {
-            revert NotToken();
-        }
-
-        NftId registryNftId = _registry.getNftId(address(_registry));
+    // from Versionable
 
-        if(msg.sender != _registry.ownerOf(registryNftId)) {
-            revert NotRegistryOwner();
-        }
+    /// @dev top level initializer
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer()
+    {
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
 
-        IRegistry.ObjectInfo memory info = IRegistry.ObjectInfo(
-            zeroNftId(), // any value
-            registryNftId, // parent nft id
-            TOKEN(),
-            false, // isInterceptor
-            tokenAddress,
-            NFT_LOCK_ADDRESS,
-            "" // any value
-        );
-
-        nftId = _registry.register(info);
+        __Service_init(authority, registry, owner);
+        _registerInterface(type(IRegistryService).interfaceId);
     }
 
-    /// @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
-    // IMPORTANT: MUST NOT check owner before calling external contract
-    function registerService(IService service)
+
+    function registerStaking(IRegisterable staking, address owner)
         external
+        virtual
+        restricted()
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) 
+            IRegistry.ObjectInfo memory info
+        )
     {
-
-        // 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);
-
-        if(msg.sender != _registry.getOwner()) {
-            revert NotRegistryOwner();
-        }
-
-        info.nftId = _registry.register(info);
-        service.linkToRegisteredNftId();
-        return (
-            info,
-            data
-        );
+        info = _getAndVerifyContractInfo(staking, STAKING(), owner);
+        info.nftId = getRegistry().register(info);
     }
 
-    // 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)
+
+    function registerInstance(IRegisterable instance, address owner)
         external
+        virtual
+        restricted()
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
-
         if(!instance.supportsInterface(type(IInstance).interfaceId)) {
-            revert NotInstance();
+            revert ErrorRegistryServiceNotInstance(address(instance));
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(instance, INSTANCE(), msg.sender);
+        info = _getAndVerifyContractInfo(instance, INSTANCE(), owner);
+        info.nftId = getRegistry().register(info);
 
-        info.nftId = _registry.register(info);
         instance.linkToRegisteredNftId(); // asume safe
-        
-        return (
-            info,
-            data            
-        );
     }
 
-    function registerProduct(IBaseComponent product, address owner)
+    function registerProduct(
+        IComponent product, 
+        address initialOwner
+    )
         external
-        restricted
+        virtual
+        restricted()
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
-        // CAN revert if no ERC165 support -> will revert with empty message 
         if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
-            revert NotProduct();
+            revert ErrorRegistryServiceNotProduct(address(product));
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(product, PRODUCT(), owner);
-
-        NftId serviceNftId = _registry.getNftId(msg.sender);
-
-        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,
-            data
-        );  
+        info = _getAndVerifyContractInfo(product, PRODUCT(), initialOwner);
+        info.nftId = getRegistry().register(info);
     }
 
-    function registerPool(IBaseComponent pool, address owner)
+    function registerProductLinkedComponent(
+        IComponent component, 
+        ObjectType objectType,
+        address initialOwner
+    )
         external
-        restricted
+        virtual
+        restricted()
         returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         ) 
     {
-        if(!pool.supportsInterface(type(IPoolComponent).interfaceId)) {
-            revert NotPool();
+        // CAN revert if no ERC165 support -> will revert with empty message 
+        if(!component.supportsInterface(type(IComponent).interfaceId)) {
+            revert ErrorRegistryServiceNotComponent(address(component));
         }
 
-        (
-            info, 
-            data
-        ) = _getAndVerifyContractInfo(pool, POOL(), owner);
-
-        NftId serviceNftId = _registry.getNftId(msg.sender);
-
-        info.nftId = _registry.register(info);
-        pool.linkToRegisteredNftId();
+        if (!(objectType == DISTRIBUTION() || objectType == ORACLE() || objectType == POOL())) {
+            revert ErrorRegistryServiceNotProductLinkedComponent(address(component));
+        }
 
-        return (
-            info,
-            data
-        );  
+        info = _getAndVerifyContractInfo(component, objectType, initialOwner);
+        info.nftId = getRegistry().register(info);
     }
 
-    function registerDistribution(IBaseComponent distribution, address owner)
+    function registerDistributor(IRegistry.ObjectInfo memory info)
         external
-        restricted
-        returns(
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) 
+        virtual
+        restricted()
+        returns(NftId nftId) 
     {
-        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
-        );  
+        _verifyObjectInfo(info, DISTRIBUTOR());
+        nftId = getRegistry().register(info);
     }
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
-        NftId senderNftId = _registry.getNftId(msg.sender);
-
         _verifyObjectInfo(info, POLICY());
-
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
-
-        NftId senderNftId = _registry.getNftId(msg.sender);
-
         _verifyObjectInfo(info, BUNDLE());
-
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
-
-    // From IService
-    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
-
-    /// @dev top level initializer
-    // 1) registry is non upgradeable -> don't need a proxy and uses constructor !
-    // 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 owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
+    function registerStake(IRegistry.ObjectInfo memory info)
+        external
+        virtual
+        restricted()
+        returns(NftId nftId) 
     {
-        (
-            address initialAuthority,
-            bytes memory registryByteCodeWithInitCode
-        ) = abi.decode(data, (address, bytes));
-
-        __AccessManaged_init(initialAuthority);
-
-        bytes memory encodedConstructorArguments = abi.encode(
-            owner,
-            getMajorVersion());
-
-        bytes memory registryCreationCode = ContractDeployerLib.getCreationCode(
-            registryByteCodeWithInitCode,
-            encodedConstructorArguments);
-
-        IRegistry registry = IRegistry(ContractDeployerLib.deploy(
-            registryCreationCode,
-            REGISTRY_CREATION_CODE_HASH));
-
-        NftId registryNftId = registry.getNftId(address(registry));
-
-        _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);
+        _verifyObjectInfo(info, STAKE());
+        nftId = getRegistry().register(info);
     }
 
-    // parent check done in registry because of approve()
+    // Internal
+
     function _getAndVerifyContractInfo(
         IRegisterable registerable,
         ObjectType expectedType, // assume can be valid only
-        address expectedOwner // assume can be 0
+        address expectedOwner // assume can be 0 when given by other service
     )
         internal
+        virtual
         view
         returns(
-            IRegistry.ObjectInfo memory info, 
-            bytes memory data
+            IRegistry.ObjectInfo memory info 
         )
     {
-        (
-            info, 
-            data
-        ) = registerable.getInitialInfo();
-        info.objectAddress = address(registerable);
+        info = registerable.getInitialInfo();
+
+        if(info.objectAddress != address(registerable)) {
+            revert ErrorRegistryServiceRegisterableAddressInvalid(registerable, 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);
+            revert ErrorRegistryServiceRegisterableTypeInvalid(registerable, expectedType, info.objectType);
         }
 
         address owner = info.initialOwner;
 
         if(owner != expectedOwner) { // registerable owner protection
-            revert NotRegisterableOwner(expectedOwner);
+            revert ErrorRegistryServiceRegisterableOwnerInvalid(registerable, expectedOwner, owner);
         }
 
         if(owner == address(registerable)) {
-            revert SelfRegistration();
+            revert ErrorRegistryServiceRegisterableSelfRegistration(registerable);
         }
 
         if(owner == address(0)) {
-            revert RegisterableOwnerIsZero();
+            revert ErrorRegistryServiceRegisterableOwnerZero(registerable);
         }
         
         if(getRegistry().isRegistered(owner)) { 
-            revert RegisterableOwnerIsRegistered();
+            revert ErrorRegistryServiceRegisterableOwnerRegistered(registerable, owner);
         }
-
-        /*NftId parentNftId = info.parentNftId;
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
-
-        if(parentInfo.objectType != parentType) { // parent registration + type
-            revert InvalidParent(parentNftId);
-        }*/
-
-        return(
-            info,
-            data
-        );
     }
 
-    // parent checks done in registry because of approve()
     function _verifyObjectInfo(
         IRegistry.ObjectInfo memory info,
-        ObjectType objectType
+        ObjectType expectedType
     )
         internal
+        virtual
         view
     {
         if(info.objectAddress > address(0)) {
-            revert InvalidAddress(info.objectAddress);
+            revert ErrorRegistryServiceObjectAddressNotZero(info.objectType);
         }
 
-        if(
-            getRegistry().isRegistered(info.initialOwner) ||
-            info.initialOwner == address(0)) {
-            // TODO non registered address can register object(e.g. POLICY()) and then transfer associated nft to registered contract
-            // what are motivations to do so?
-            // at least registered contract can not register objects by itself, SERVICE, 
-            revert InvalidInitialOwner(info.initialOwner); 
+        if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
+            revert ErrorRegistryServiceObjectTypeInvalid(expectedType, info.objectType);
         }
 
-        // can catch all 3 if check that initialOwner is not registered
-        /*if(info.initialOwner == msg.sender) {
-            revert InitialOwnerIsParent();
-        }
+        address owner = info.initialOwner;
 
-        if(info.initialOwner == address(this)) {
-            revert InitialOwnerIsService();
+        if(owner == address(0)) {
+            revert ErrorRegistryServiceObjectOwnerZero(info.objectType);
         }
 
-        if(info.initialOwner == address(getRegistry())) {
-            revert InitialOwnerIsRegistry();
-        }*/
+        if(owner == msg.sender) {
+            revert ErrorRegistryServiceInvalidInitialOwner(owner);
+        }
 
-        /*NftId parentNftId = info.parentNftId;
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
+        if(getRegistry().isRegistered(owner)) {
+            ObjectType ownerType = getRegistry().getObjectInfo(owner).objectType;
+            if(ownerType == REGISTRY() || ownerType == STAKING() || ownerType == SERVICE() || ownerType == INSTANCE()) {
+                revert ErrorRegistryServiceObjectOwnerRegistered(info.objectType, owner);
+            }
+        }
+    }
 
-        if(parentInfo.objectType != parentType) { // parent registration + type
-            revert InvalidParent(parentNftId);
-        }*/        
+    // From IService
+    function _getDomain() internal override pure returns(ObjectType serviceDomain) {
+        return REGISTRY(); 
     }
-}
+}

package/contracts/registry/RegistryServiceManager.sol

@@ -1,51 +1,48 @@
-// SPDX-License-Identifier: UNLICENSED
+// SPDX-License-Identifier: Apache-2.0
 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 {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {RegistryService} from "./RegistryService.sol";
 
-
 contract RegistryServiceManager is
     ProxyManager
 {
-    bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
+    error ErrorRegistryAccessManagerAuthorityZero();
+    error ErrorRegistryAccessManagerRegistryZero();
 
-    RegistryService private _registryService; 
+    bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
 
-    AccessManager private _accessManager;
+    RegistryService private immutable _registryService;
 
     /// @dev initializes proxy manager with registry service implementation and deploys registry
     constructor(
-        address accessManager
-    )
-        ProxyManager()
+        address authority, // used by implementation 
+        address registry, // used by implementation 
+        bytes32 salt
+    ) 
     {
-        _accessManager = AccessManager(accessManager);
-
-        bytes memory initializationData = abi.encode(accessManager, type(Registry).creationCode);
-
-        IVersionable versionable = deploy(
-            address(new RegistryService()), 
-            initializationData);
+        if(authority == address(0)) {
+            revert ErrorRegistryAccessManagerAuthorityZero();
+        }
+
+        if(registry == address(0)) {
+            revert ErrorRegistryAccessManagerRegistryZero();
+        }
+        
+        RegistryService srv = new RegistryService{ salt: salt }();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
+            address(srv), 
+            data,
+            salt);
 
         _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
@@ -53,12 +50,4 @@ contract RegistryServiceManager is
     {
         return _registryService;
     }
-
-    function getAccessManager()
-        external
-        view
-        returns (AccessManager)
-    {
-        return _accessManager;
-    }
 }