@etherisc/gif-next 0.0.2-f2b0fa2-473 → 0.0.2-f5a74cc-201

package/contracts/registry/IRegistryService.sol

@@ -12,24 +12,39 @@ import {IBaseComponent} from "../components/IBaseComponent.sol";
 
 interface IRegistryService is IService {
 
-    function registerToken(address tokenAddress) external returns(NftId nftId);
+     error SelfRegistration();
+     error NotRegistryOwner();
 
-    function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     error NotService();
+     error NotInstance();
+     error NotProduct();
+     error NotPool();
+     error NotDistribution();
 
-    function registerInstance(IRegisterable instance)
-        external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
+     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
+     error NotRegisterableOwner(address expectedOwner);
+     error RegisterableOwnerIsZero();   
+     error RegisterableOwnerIsRegistered();
+     error InvalidInitialOwner(address initialOwner);
+     error InvalidAddress(address registerableAddress);
 
-    function registerProduct(IBaseComponent product, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerPool(IBaseComponent pool, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerDistribution(IBaseComponent distribution, address owner)
-         external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+     function registerInstance(IRegisterable instance)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data); 
 
-    function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
+     function registerProduct(IBaseComponent product, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
-    function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
+     function registerPool(IBaseComponent pool, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+     function registerDistribution(IBaseComponent distribution, address owner)
+          external returns(IRegistry.ObjectInfo memory info, bytes memory data);
+
+     function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId); // -> easy to upgrade
+
+     function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
 }
 

package/contracts/registry/Registry.sol

@@ -7,7 +7,7 @@ import {IService} from "../shared/IService.sol";
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
 import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
 import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
 import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
@@ -28,30 +28,17 @@ contract Registry is
     ERC165,
     IRegistry
 {
-    // register
-    error NotRegistryService();
-    error ZeroParentAddress();
-    error ContractAlreadyRegistered(address objectAddress);
-    error InvalidServiceVersion(VersionPart majorVersion);
-    error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
-            
-    // approve
-    error NotOwner();
-    error NotRegisteredContract(NftId registrarNftId);
-    error NotService(NftId registrarNftId);
-    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
-
-    uint256 public constant MAJOR_VERSION_MIN = 3;
+    uint256 public constant GIF_MAJOR_VERSION_AT_DEPLOYMENT = 3;
     address public constant NFT_LOCK_ADDRESS = address(0x1);
+    uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
     uint256 public constant REGISTRY_SERVICE_TOKEN_SEQUENCE_ID = 3;
     string public constant EMPTY_URI = "";
 
+    VersionPart internal _majorVersion;
+
     mapping(NftId nftId => ObjectInfo info) internal _info;
     mapping(address object => NftId nftId) internal _nftIdByAddress;
 
-    mapping(NftId registrator => mapping(
-            ObjectType objectType => bool)) internal _isApproved;
-
     mapping(ObjectType objectType => mapping(
             ObjectType parentType => bool)) internal _isValidContractCombination;
 
@@ -69,13 +56,12 @@ contract Registry is
 
     modifier onlyOwner() {
         if(msg.sender != getOwner()) {
-            revert NotOwner();
+            revert NotOwner(msg.sender);
         }
         _;
     }
 
     modifier onlyRegistryService() {
-        
         if(msg.sender != _info[_serviceNftId].objectAddress) {
             revert NotRegistryService();
         }
@@ -85,7 +71,10 @@ contract Registry is
     constructor(address registryOwner, VersionPart majorVersion)
     {
         require(registryOwner > address(0), "Registry: registry owner is 0");
-        require(majorVersion.toInt() == MAJOR_VERSION_MIN, "Registry: initial major version of registry service is not MAJOR_VERSION_MIN");
+
+        // major version at constructor time
+        _majorVersion = VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT);
+        emit LogInitialMajorVersionSet(_majorVersion);
 
         // deploy NFT 
         _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
@@ -101,6 +90,24 @@ contract Registry is
         _registerInterface(type(IRegistry).interfaceId);
     }
 
+    // from IRegistry
+
+    /// @dev latest GIF release version 
+    function setMajorVersion(VersionPart newMajorVersion)
+        external
+        onlyOwner
+    {
+        // ensure major version increments is one
+        uint256 oldMax = _majorVersion.toInt();
+        uint256 newMax = newMajorVersion.toInt();
+        if (newMax <= oldMax || newMax - oldMax != 1) {
+            revert MajorVersionMaxIncreaseInvalid(newMajorVersion, _majorVersion);
+        }
+
+        _majorVersion = newMajorVersion;
+        emit LogMajorVersionSet(_majorVersion);
+    }
+
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
     // TODO service registration means its approval for some type?
     // TODO registration of precompile addresses
@@ -168,13 +175,35 @@ contract Registry is
 
         emit LogRegistration(info);
     }
+    /// @dev earliest GIF major version 
+    function getMajorVersionMin() external view returns (VersionPart) {
+        return VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT);
+    }
+
+    // TODO make distinction between active an not yet active version
+    // need to be thought trough, not yet clear if necessary
+    // need to answer question: what is the latest version during the upgrade process?
+    // likely setting up a new gif version does not fit into a single tx
+    // in this case we might want to have a period where the latest version is
+    // in the process of being set up while the latest active version is 1 major release smaller
+    /// @dev latest GIF major version (might not yet be active)
+    function getMajorVersionMax() external view returns (VersionPart) {
+        return _majorVersion;
+    }
+
+    /// @dev latest active GIF release version 
+    function getMajorVersion() external view returns (VersionPart) { 
+        return _majorVersion;
+    }
 
-    // from IRegistry
     function getObjectCount() external view override returns (uint256) {
-        
         return _chainNft.totalSupply();
     }
 
+    function getNftId() external view returns (NftId nftId) {
+        return _registryNftId;
+    }
+
     function getNftId(address object) external view override returns (NftId id) {
         return _nftIdByAddress[object];
     }
@@ -184,7 +213,6 @@ contract Registry is
     }
 
     function ownerOf(address contractAddress) public view returns (address) {
-        
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
@@ -193,7 +221,6 @@ contract Registry is
     }
 
     function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
-        
         return _info[_nftIdByAddress[object]];
     }
 
@@ -205,6 +232,10 @@ contract Registry is
         return _nftIdByAddress[object].gtz();
     }
 
+    function isRegisteredService(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
     function getServiceName(NftId nftId) external view returns (string memory) {
         return _string[nftId];
     }
@@ -238,14 +269,8 @@ contract Registry is
         ) = abi.decode(info.data, (string, VersionPart));
         bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
 
-        // TODO MUST guarantee consistency of service.getVersion() and majorVersion here
-        // TODO update _serviceNftId when registryService with new major version is registered? -> it is fixed in current setup -> can lock up
-        // TODO do not use names -> each object type is registered by corresponding service -> conflicting with approve()
-        if(
-            majorVersion.toInt() < MAJOR_VERSION_MIN ||
-            (majorVersion.toInt() > MAJOR_VERSION_MIN &&
-            _service[serviceNameHash][VersionLib.toVersionPart(majorVersion.toInt() - 1)] == address(0) )
-        ) {
+        // ensures consistency of service.getVersion() and majorVersion here
+        if(majorVersion != _majorVersion) {
             revert InvalidServiceVersion(majorVersion);
         }
         
@@ -312,7 +337,7 @@ contract Registry is
     function _registerRegistry(address registryOwner) 
         internal
     {
-        uint256 registryId = _chainNft.calculateTokenId(2);
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
         NftId registryNftId = toNftId(registryId);
 
         NftId parentNftId;
@@ -386,7 +411,7 @@ contract Registry is
 
         string memory serviceName = "RegistryService";
         bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-        _service[serviceNameHash][VersionLib.toVersionPart(MAJOR_VERSION_MIN)] = msg.sender;
+        _service[serviceNameHash][VersionLib.toVersionPart(GIF_MAJOR_VERSION_AT_DEPLOYMENT)] = msg.sender;
         _string[serviceNftId] = serviceName;
         _serviceNftId = serviceNftId;
     }

package/contracts/registry/RegistryService.sol

@@ -1,17 +1,13 @@
 // 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 {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";
@@ -22,7 +18,7 @@ import {Versionable} from "../../contracts/shared/Versionable.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 {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, POLICY, BUNDLE, STAKE} 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";
@@ -32,7 +28,6 @@ import {Service} from "../shared/Service.sol";
 import {IService} from "../shared/IService.sol";
 import {IRegistryService} from "./IRegistryService.sol";
 import {Registry} from "./Registry.sol";
-import {ChainNft} from "./ChainNft.sol";
 
 contract RegistryService is
     AccessManagedUpgradeable,
@@ -41,23 +36,6 @@ contract RegistryService is
 {
     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?
@@ -69,48 +47,6 @@ contract RegistryService is
 
     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));
-
-        if(msg.sender != _registry.ownerOf(registryNftId)) {
-            revert NotRegistryOwner();
-        }
-
-        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);
-    }
-
     /// @dev 
     //  msg.sender - ONLY registry owner
     //      CAN NOT register itself
@@ -119,9 +55,7 @@ contract RegistryService is
     // 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
-
+        restricted
         returns(
             IRegistry.ObjectInfo memory info,
             bytes memory data
@@ -140,17 +74,9 @@ contract RegistryService is
 
         info.nftId = _registry.register(info);
         service.linkToRegisteredNftId();
-        return (
-            info,
-            data
-        );
+        return (info, data);
     }
 
-    // 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(
@@ -170,10 +96,7 @@ contract RegistryService is
         info.nftId = _registry.register(info);
         instance.linkToRegisteredNftId(); // asume safe
         
-        return (
-            info,
-            data            
-        );
+        return (info, data);
     }
 
     function registerProduct(IBaseComponent product, address owner)
@@ -194,16 +117,11 @@ contract RegistryService is
             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
-        );  
+        return (info, data);  
     }
 
     function registerPool(IBaseComponent pool, address owner)
@@ -223,15 +141,10 @@ contract RegistryService is
             data
         ) = _getAndVerifyContractInfo(pool, POOL(), owner);
 
-        NftId serviceNftId = _registry.getNftId(msg.sender);
-
         info.nftId = _registry.register(info);
         pool.linkToRegisteredNftId();
 
-        return (
-            info,
-            data
-        );  
+        return (info, data);  
     }
 
     function registerDistribution(IBaseComponent distribution, address owner)
@@ -251,15 +164,10 @@ contract RegistryService is
             data
         ) = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
 
-        NftId serviceNftId = _registry.getNftId(msg.sender);
-
         info.nftId = _registry.register(info); 
         distribution.linkToRegisteredNftId();
 
-        return (
-            info,
-            data
-        );  
+        return (info, data);  
     }
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
@@ -267,8 +175,6 @@ contract RegistryService is
         restricted 
         returns(NftId nftId) 
     {
-        NftId senderNftId = _registry.getNftId(msg.sender);
-
         _verifyObjectInfo(info, POLICY());
 
         nftId = _registry.register(info);
@@ -279,14 +185,20 @@ contract RegistryService is
         restricted 
         returns(NftId nftId) 
     {
-
-        NftId senderNftId = _registry.getNftId(msg.sender);
-
         _verifyObjectInfo(info, BUNDLE());
 
         nftId = _registry.register(info);
     }
 
+    function registerStake(IRegistry.ObjectInfo memory info)
+        external
+        restricted 
+        returns(NftId nftId) 
+    {
+        _verifyObjectInfo(info, STAKE());
+
+        nftId = _registry.register(info);
+    }
 
     // From IService
     function getName() public pure override(IService, Service) returns(string memory) {
@@ -341,7 +253,6 @@ contract RegistryService is
         _registerInterface(type(IRegistryService).interfaceId);
     }
 
-    // parent check done in registry because of approve()
     function _getAndVerifyContractInfo(
         IRegisterable registerable,
         ObjectType expectedType, // assume can be valid only
@@ -366,8 +277,13 @@ contract RegistryService is
 
         address owner = info.initialOwner;
 
-        if(owner != expectedOwner) { // registerable owner protection
-            revert NotRegisterableOwner(expectedOwner);
+        // 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(owner == address(registerable)) {
@@ -395,25 +311,28 @@ contract RegistryService is
         );
     }
 
-    // parent checks done in registry because of approve()
     function _verifyObjectInfo(
         IRegistry.ObjectInfo memory info,
-        ObjectType objectType
+        ObjectType expectedType
     )
         internal
         view
     {
-        if(info.objectAddress > address(0)) {
-            revert InvalidAddress(info.objectAddress);
+        // enforce instead of check
+        info.objectAddress = address(0);
+
+        if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
+            revert UnexpectedRegisterableType(expectedType, info.objectType);
+        }
+
+        address owner = info.initialOwner;
+
+        if(owner == address(0)) {
+            revert RegisterableOwnerIsZero();
         }
 
-        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(getRegistry().isRegistered(owner)) { 
+            revert RegisterableOwnerIsRegistered();
         }
 
         // can catch all 3 if check that initialOwner is not registered

package/contracts/registry/RegistryServiceManager.sol

@@ -9,6 +9,7 @@ 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
@@ -16,9 +17,9 @@ contract RegistryServiceManager is
 {
     bytes32 constant public ACCESS_MANAGER_CREATION_CODE_HASH = 0x0;
 
-    RegistryService private _registryService; 
-
     AccessManager private _accessManager;
+    RegistryService private _registryService; 
+    TokenRegistry private _tokenRegistry;
 
     /// @dev initializes proxy manager with registry service implementation and deploys registry
     constructor(
@@ -41,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
@@ -54,11 +70,11 @@ contract RegistryServiceManager is
         return _registryService;
     }
 
-    function getAccessManager()
+    function getTokenRegistry()
         external
         view
-        returns (AccessManager)
+        returns (TokenRegistry)
     {
-        return _accessManager;
+        return _tokenRegistry;
     }
 }