@etherisc/gif-next 0.0.2-f79a517-071 → 0.0.2-f7a5beb-202

package/contracts/registry/Registry.sol

@@ -1,180 +1,203 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IService} from "../instance/base/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 {NftId, toNftId, zeroNftId} from "../types/NftId.sol";
+import {VersionPart} 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";
 
 import {ERC165} from "../shared/ERC165.sol";
 
+import {ChainNft} from "./ChainNft.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {ReleaseManager} from "./ReleaseManager.sol";
 
 // IMPORTANT
 // Each NFT minted by registry is accosiated with:
 // 1) NFT owner
 // 2) registred contract OR object stored in registered (parent) contract
 // Four registration flows:
-// 1) non IRegisterable address by registryOwner (TOKEN)
-// 2) IRegisterable address by registryOwner (SERVICE)
-// 3) IRegisterable address by approved service (INSTANCE, COMPONENT)
-// 4) state object by approved service (POLICY, BUNDLE, STAKE)
+// 1) IService address by release manager (SERVICE of domain SERVICE aka registry service aka release creation)
+// 2) IService address by release manager (SERVICE of domain !SERVICE aka regular service)
+// 3) IRegisterable address by regular service (INSTANCE, PRODUCT, POOL, DISTRIBUTION, ORACLE)
+// 4) state object by regular service (POLICY, BUNDLE, STAKE)
 
 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;
     address public constant NFT_LOCK_ADDRESS = address(0x1);
-    uint256 public constant REGISTRY_SERVICE_TOKEN_SEQUENCE_ID = 3;
+    uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
     string public constant EMPTY_URI = "";
 
-    mapping(NftId nftId => ObjectInfo info) internal _info;
-    mapping(address object => NftId nftId) internal _nftIdByAddress;
+    mapping(NftId nftId => ObjectInfo info) private _info;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
 
-    mapping(NftId registrator => mapping(
-            ObjectType objectType => bool)) internal _isApproved;
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
 
-    mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidContractCombination;
+    mapping(ObjectType objectType => bool) private _coreTypes;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidObjectCombination;
+            ObjectType parentType => bool)) private _coreContractCombinations;
 
-    mapping(NftId nftId => string name) internal _string;
-    mapping(bytes32 serviceNameHash => mapping(
-            VersionPart majorVersion => address service)) internal _service;
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId internal _registryNftId;
-    NftId internal _serviceNftId; // set in stone upon registry creation
-    ChainNft internal _chainNft;
+    NftId private _registryNftId;
+    ChainNft private _chainNft;
 
+    ReleaseManager private _releaseManager;
 
-    modifier onlyOwner() {
-        if(msg.sender != getOwner()) {
-            revert NotOwner();
+    modifier onlyRegistryService() {
+        if(!_releaseManager.isActiveRegistryService(msg.sender)) {
+            revert CallerNotRegistryService();
         }
         _;
     }
 
-    modifier onlyRegistryService() {
-        
-        if(msg.sender != _info[_serviceNftId].objectAddress) {
-            revert NotRegistryService();
+    modifier onlyReleaseManager() {
+        if(msg.sender != address(_releaseManager)) {
+            revert CallerNotReleaseManager();
         }
         _;
     }
 
-    constructor(address registryOwner, VersionPart majorVersion)
+    constructor()
     {
-        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");
+        _releaseManager = ReleaseManager(msg.sender);
 
         // deploy NFT 
-        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
+        _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _registerProtocol();
-        _registerRegistry(registryOwner);
-        _registerRegistryService(registryOwner);
+        _registerRegistry();
 
-        // set object parent relations
-        _setupValidObjectParentCombinations();
+        // set object types and object parent relations
+        _setupValidCoreTypesAndCombinations();
 
         _registerInterface(type(IRegistry).interfaceId);
     }
 
-    /// @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
+    function registerService(
+        ObjectInfo memory info, 
+        VersionPart version, 
+        ObjectType domain
+    )
+        external
+        onlyReleaseManager
+        returns(NftId nftId)
+    {
+        /* must be guaranteed by release manager
+        if(info.objectType != SERVICE()) {
+            revert();
+        }
+        if(info.parentType != REGISTRY()) {
+            revert();
+        }        
+        info.initialOwner == NFT_LOCK_ADDRESS <- if services are access managed
+        */
+
+        if(_service[version][domain] > address(0)) {
+            revert ServiceAlreadyRegistered(info.objectAddress);
+        }
+
+        _service[version][domain] = info.objectAddress; // nftId;
+
+        nftId = _register(info);
+
+        emit LogServiceRegistration(version, domain);
+    }
+
     function register(ObjectInfo memory info)
         external
         onlyRegistryService
         returns(NftId nftId)
     {
         ObjectType objectType = info.objectType;
-        NftId parentNftId = info.parentNftId;
-        ObjectInfo memory parentInfo = _info[parentNftId];
-        ObjectType parentType = parentInfo.objectType; // see function header
-        address parentAddress = parentInfo.objectAddress;
+        ObjectType parentType = _info[info.parentNftId].objectType;
 
-        // parent is contract -> need to check? -> check before minting
-        // special case: global registry nft as parent when not on mainnet -> global registry address is 0
-        // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
-        // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
-        if(parentAddress == address(0)) {
-            revert ZeroParentAddress();
+        // TODO do not need it here -> SERVICE is no longer part of _coreContractCombinations
+        // no service registrations
+        if(objectType == SERVICE()) {
+            revert ServiceRegistration();
         }
 
-        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
-
-        // TODO does external call
-        uint256 mintedTokenId = _chainNft.mint(
-            info.initialOwner,
-            interceptor,
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-
-        // TODO move nftId out of info struct
-        // getters by nftId -> return struct without nftId
-        // getters by address -> return nftId AND struct
-        info.nftId = nftId;
-        _info[nftId] = info;
-
-        if(info.objectAddress > address(0)) 
+        // only valid core types combinations
+        if(info.objectAddress == address(0)) 
         {
-            // TODO if need to add types latter -> at least call this check from registry service
-            // parent is registered + object-parent types are valid
-            if(_isValidContractCombination[objectType][parentType] == false) {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
                 revert InvalidTypesCombination(objectType, parentType);
             }
-
-            address contractAddress = info.objectAddress;
-
-            if(_nftIdByAddress[contractAddress].gtz()) { 
-                revert ContractAlreadyRegistered(contractAddress);
-            }
-
-            _nftIdByAddress[contractAddress] = nftId;
-
-            // special case
-            if(objectType == SERVICE()) {
-                _registerService(info);
-            }
         }
         else
         {
-            if(_isValidObjectCombination[objectType][parentType] == false) {
+            if(_coreContractCombinations[objectType][parentType] == false) {
                 revert InvalidTypesCombination(objectType, parentType);
             }
         }
 
-        emit LogRegistration(info);
+        nftId = _register(info);
+    }
+
+    function registerWithCustomType(ObjectInfo memory info)
+        external
+        onlyRegistryService
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        if(_coreTypes[objectType]) {
+            revert CoreTypeRegistration();
+        }
+
+        if(
+
+            parentType == PROTOCOL() ||
+            parentType == REGISTRY() ||
+            parentType == SERVICE()
+        ) {
+            revert InvalidTypesCombination(objectType, parentType);
+        }
+
+        _register(info);
+    }
+
+
+    /// @dev earliest GIF major version 
+    function getInitialVersion() external view returns (VersionPart) {
+        return _releaseManager.getInitialVersion();
+    }
+
+    // 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 getNextVersion() external view returns (VersionPart) {
+        return _releaseManager.getNextVersion();
+    }
+
+    /// @dev latest active GIF release version 
+    function getLatestVersion() external view returns (VersionPart) { 
+        return _releaseManager.getLatestVersion();
+    }
+
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
+        return _releaseManager.getReleaseInfo(version);
     }
 
-    // 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 +207,6 @@ contract Registry is
     }
 
     function ownerOf(address contractAddress) public view returns (address) {
-        
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
@@ -193,7 +215,6 @@ contract Registry is
     }
 
     function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
-        
         return _info[_nftIdByAddress[object]];
     }
 
@@ -205,18 +226,24 @@ contract Registry is
         return _nftIdByAddress[object].gtz();
     }
 
-    function getServiceName(NftId nftId) external view returns (string memory) {
-        return _string[nftId];
+    function isRegisteredService(address object) external view override returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
+    function isValidRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseManager.isValidRelease(version);
     }
 
-    // special case to retrive a gif service
     function getServiceAddress(
-        string memory serviceName, 
-        VersionPart majorVersion
-    ) external view returns (address)
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    ) external view returns (address service)
     {
-        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-        return _service[serviceNameHash][majorVersion];
+        // TODO how can I get service address while release is not validated/activated ?!! -> user will check validity of release on its own
+        //if(_releaseManager.isValidRelease(releaseVersion)) { 
+            service =  _service[releaseVersion][serviceDomain]; 
+        //}
     }
 
     function getChainNft() external view override returns (ChainNft) {
@@ -229,34 +256,54 @@ contract Registry is
 
     // Internals
 
-    function _registerService(ObjectInfo memory info)
+    /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
+    // TODO registration of precompile addresses
+    function _register(ObjectInfo memory info)
         internal
+        returns(NftId nftId)
     {
-        (
-            string memory serviceName,
-            VersionPart majorVersion
-        ) = 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) )
-        ) {
-            revert InvalidServiceVersion(majorVersion);
-        }
-        
-        if(_service[serviceNameHash][majorVersion] != address(0)) {
-            revert ServiceNameAlreadyRegistered(serviceName, majorVersion);
+        ObjectType objectType = info.objectType;
+        NftId parentNftId = info.parentNftId;
+        ObjectInfo memory parentInfo = _info[parentNftId];
+        ObjectType parentType = parentInfo.objectType; // see function header
+        address parentAddress = parentInfo.objectAddress;
+
+        // parent is contract -> need to check? -> check before minting
+        // special case: global registry nft as parent when not on mainnet -> global registry address is 0
+        // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
+        // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
+        if(parentAddress == address(0)) {
+            revert ZeroParentAddress();
         }
 
-        _string[info.nftId] = serviceName;
-        _service[serviceNameHash][majorVersion] = info.objectAddress;
+        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
 
-        emit LogServiceNameRegistration(serviceName, majorVersion); 
+        // TODO does external call
+        // compute next nftId, do all checks and stores, mint() at most end...
+        uint256 mintedTokenId = _chainNft.mint(
+            info.initialOwner,
+            interceptor,
+            EMPTY_URI);
+        nftId = toNftId(mintedTokenId);
+
+        // TODO move nftId out of info struct
+        // getters by nftId -> return struct without nftId
+        // getters by address -> return nftId AND struct
+        info.nftId = nftId;
+        _info[nftId] = info;
+
+        if(info.objectAddress > address(0)) 
+        {
+            address contractAddress = info.objectAddress;
+
+            if(_nftIdByAddress[contractAddress].gtz()) { 
+                revert ContractAlreadyRegistered(contractAddress);
+            }
+
+            _nftIdByAddress[contractAddress] = nftId;
+        }
+
+        emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
     }
 
     /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
@@ -289,32 +336,31 @@ contract Registry is
 
     /// @dev protocol registration used to anchor the dip ecosystem relations
     function _registerProtocol() 
-        internal
+        private
     {
         uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
         NftId protocolNftId = toNftId(protocolId);
 
-        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
+        _info[protocolNftId] = ObjectInfo({
+            nftId: protocolNftId,
+            parentNftId: zeroNftId(),
+            objectType: PROTOCOL(),
+            isInterceptor: false, 
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
 
-        _info[protocolNftId] = ObjectInfo(
-            protocolNftId,
-            zeroNftId(), // parent
-            PROTOCOL(),
-            false, // isInterceptor
-            address(0), // objectAddress
-            NFT_LOCK_ADDRESS,// initialOwner
-            ""
-        );
+        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
     }
 
     /// @dev registry registration
     /// might also register the global registry when not on mainnet
-    function _registerRegistry(address registryOwner) 
-        internal
+    function _registerRegistry() 
+        private
     {
-        uint256 registryId = _chainNft.calculateTokenId(2);
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
         NftId registryNftId = toNftId(registryId);
-
         NftId parentNftId;
 
         if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
@@ -327,68 +373,39 @@ contract Registry is
             parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
         }
 
-        _chainNft.mint(registryOwner, registryId);
-
-        _info[registryNftId] = ObjectInfo(
-            registryNftId,
-            parentNftId,
-            REGISTRY(),
-            false, // isInterceptor
-            address(this), 
-            registryOwner,
-            "" 
-        );
+        _info[registryNftId] = ObjectInfo({
+            nftId: registryNftId,
+            parentNftId: parentNftId,
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: address(this), 
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: "" 
+        });
         _nftIdByAddress[address(this)] = registryNftId;
         _registryNftId = registryNftId;
-    }
 
+        _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
+    }
 
     /// @dev global registry registration for non mainnet registries
     function _registerGlobalRegistry() 
-        internal
+        private
     {
         uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
-
-        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
-
         NftId globalRegistryNftId = toNftId(globalRegistryId);
 
-        _info[globalRegistryNftId] = ObjectInfo(
-            globalRegistryNftId,
-            toNftId(_chainNft.PROTOCOL_NFT_ID()), // parent
-            REGISTRY(),
-            false, // isInterceptor
-            address(0), // objectAddress
-            NFT_LOCK_ADDRESS, // initialOwner
-            "" // data
-        );
-    }
+        _info[globalRegistryNftId] = ObjectInfo({
+            nftId: globalRegistryNftId,
+            parentNftId: toNftId(_chainNft.PROTOCOL_NFT_ID()),
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
 
-    function _registerRegistryService(address registryOwner)
-        internal
-    {
-        uint256 serviceId = _chainNft.calculateTokenId(REGISTRY_SERVICE_TOKEN_SEQUENCE_ID);
-        NftId serviceNftId = toNftId(serviceId);        
-
-        _chainNft.mint(registryOwner, serviceId);
-
-        _info[serviceNftId] = ObjectInfo(
-            serviceNftId,
-            _registryNftId,
-            SERVICE(),
-            false, // isInterceptor
-            msg.sender, // service deploys registry
-            registryOwner, // initialOwner,
-            "" 
-        );
-
-        _nftIdByAddress[msg.sender] = serviceNftId;
-
-        string memory serviceName = "RegistryService";
-        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-        _service[serviceNameHash][VersionLib.toVersionPart(MAJOR_VERSION_MIN)] = msg.sender;
-        _string[serviceNftId] = serviceName;
-        _serviceNftId = serviceNftId;
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
     }
 
     /// @dev defines which object - parent types relations are allowed to register
@@ -397,27 +414,39 @@ contract Registry is
     // 2) DO NOT use object type (e.g. POLCY, BUNDLE, STAKE) as parent type
     // 3) DO NOT use REGISTRY as object type
     // 2) DO NOT use PROTOCOL and "zeroObjectType"
-    function _setupValidObjectParentCombinations() 
-        internal 
+    function _setupValidCoreTypesAndCombinations() 
+        private 
     {
+        _coreTypes[REGISTRY()] = true;
+        _coreTypes[SERVICE()] = true;
+        _coreTypes[TOKEN()] = true;
+        _coreTypes[INSTANCE()] = true;
+        _coreTypes[PRODUCT()] = true;
+        _coreTypes[POOL()] = true;
+        _coreTypes[DISTRIBUTION()] = true;
+        _coreTypes[POLICY()] = true;
+        _coreTypes[BUNDLE()] = true;
+        _coreTypes[STAKE()] = true;
+        
         // registry as parent, ONLY registry owner
-        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
-        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
+        //_coreContractCombinations[REGISTRY()][REGISTRY()] = true; // only for global regstry
+        _coreContractCombinations[TOKEN()][REGISTRY()] = true;
+        //_coreContractCombinations[SERVICE()][REGISTRY()] = true;// do not need it here -> registerService() registers exactly this combination
 
         // registry as parent, ONLY approved
-        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
+        _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
         // instance as parent, ONLY approved
-        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
-        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
-        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
-        _isValidContractCombination[POOL()][INSTANCE()] = true;
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
+        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
+        _coreContractCombinations[POOL()][INSTANCE()] = true;
 
         // product as parent, ONLY approved
-        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
 
         // pool as parent, ONLY approved
-        _isValidObjectCombination[BUNDLE()][POOL()] = true;
-        _isValidObjectCombination[STAKE()][POOL()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+        _coreObjectCombinations[STAKE()][POOL()] = true;
     }
 }