@etherisc/gif-next 0.0.2-d4eadee-930 → 0.0.2-d5522f6-712

package/contracts/registry/Registry.sol

@@ -1,381 +1,396 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IService} from "../instance/base/IService.sol";
 
-import {IChainNft} from "./IChainNft.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 {ERC165} from "../shared/ERC165.sol";
+
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
-import {NftId, toNftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {VersionPart} from "../types/Version.sol";
-import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.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) 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)
 
-// TODO make registry upgradable
 contract Registry is
-    IRegisterable,
+    ERC165,
     IRegistry
 {
-    using NftIdLib for NftId;
-
+    address public constant NFT_LOCK_ADDRESS = address(0x1);
+    uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
     string public constant EMPTY_URI = "";
 
-    mapping(NftId nftId => ObjectInfo info) private _info;
-    mapping(NftId nftId => address owner) private _owner;
-    mapping(address object => NftId nftId) private _nftIdByAddress;
-    mapping(ObjectType objectType => bool) private _isValidType;
-    mapping(ObjectType objectType => mapping(ObjectType objectParentType => bool)) private _isValidParentType;
-
-    mapping(NftId nftId => string stringValue) private _string;
-    mapping(bytes32 serviceNameHash => mapping(VersionPart majorVersion => address service)) _service;
-
-    NftId private _nftId;
-    IChainNft private _chainNft;
-    ChainNft private _chainNftInternal;
-    address private _initialOwner;
-
-    // @dev will own protocol nft and registry nft(s) minted during initialize
-    address private _protocolOwner;
-
-    // TODO refactor once registry becomes upgradable
-    // @Dev the protocol owner will get ownership of the
-    // protocol nft and the global registry nft minted in this 
-    // initializer function 
-    function initialize(
-        address chainNft, 
-        address protocolOwner
-    )
-        public 
-    {
-        require(
-            address(_chainNft) == address(0),
-            "ERROR:REG-001:ALREADY_INITIALIZED"
-        );
+    mapping(NftId nftId => ObjectInfo info) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
+
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) _service;
+
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) internal _isValidContractCombination;
 
-        _initialOwner = msg.sender;
-        _protocolOwner = protocolOwner;
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) internal _isValidObjectCombination;
 
-        _chainNft = IChainNft(chainNft);
-        _chainNftInternal = ChainNft(chainNft);
+    NftId internal _registryNftId;
+    ChainNft internal _chainNft;
+
+    ReleaseManager internal _releaseManager;
+
+    modifier onlyRegistryService() {
+        if(!_releaseManager.isActiveRegistryService(msg.sender)) {
+            revert CallerNotRegistryService();
+        }
+        _;
+    }
+
+    modifier onlyReleaseManager() {
+        if(msg.sender != address(_releaseManager)) {
+            revert CallerNotReleaseManager();
+        }
+        _;
+    }
+
+    constructor()
+    {
+        _releaseManager = ReleaseManager(msg.sender);
+
+        // deploy NFT 
+        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
 
         // initial registry setup
         _registerProtocol();
-        _nftId = _registerRegistry();
+        _registerRegistry();
 
-        // setup rules for further registrations
-        _setupValidTypes();
-        _setupValidParentTypes();
-    }
+        // set object parent relations
+        _setupValidObjectParentCombinations();
 
+        _registerInterface(type(IRegistry).interfaceId);
+    }
 
-    function register(
-        address objectAddress
+    function registerService(
+        ObjectInfo memory info, 
+        VersionPart version, 
+        ObjectType domain
     )
-    // TODO add authz (only services may register components etc)
-    // we have to check how we do authz for registring services (just restrict to protocol owner/registry owner)
-    external override returns (NftId nftId) {
-        require(
-            _nftIdByAddress[objectAddress].eqz(),
-            "ERROR:REG-002:ALREADY_REGISTERED"
-        );
-
-        IRegisterable registerable = IRegisterable(objectAddress);
-        require(
-            registerable.supportsInterface(type(IRegisterable).interfaceId),
-            "ERROR:REG-003:NOT_REGISTERABLE"
-        );
-
-        ObjectType objectType = registerable.getType();
-        require(
-            _isValidType[objectType],
-            "ERROR:REG-004:TYPE_INVALID"
-        );
-
-        NftId parentNftId = registerable.getParentNftId();
-        require(
-            isRegistered(parentNftId),
-            "ERROR:REG-005:PARENT_NOT_REGISTERED"
-        );
-
-        require(
-            _isValidParentType[objectType][_info[parentNftId].objectType],
-            "ERROR:REG-006:PARENT_TYPE_INVALID"
-        );
-
-        // also check that nftId and parentNFtId are on the same chain if applicable
-
-        // nft minting
-        uint256 mintedTokenId = _chainNft.mint(
-            registerable.getOwner(),
-            EMPTY_URI
-        );
-
-        nftId = toNftId(mintedTokenId);
+        external
+        onlyReleaseManager
+        returns(NftId nftId)
+    {
+        /* must be guaranteed by release manager
+        if(info.objectType != SERVICE()) {
+            revert();
+        }
+        info.initialOwner = NFT_LOCK_ADDRESS <- if services are access managed
+        */
 
-        // special case services
-        if(registerable.getType() == SERVICE()) {
-            IService service = IService(objectAddress);
-            require(
-                service.supportsInterface(type(IService).interfaceId),
-                "ERROR:REG-007:NOT_SERVICE"
-            );
-
-            string memory serviceName = service.getName();
-            VersionPart majorVersion = service.getMajorVersion();
-            bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-
-            // service specific state
-            _string[nftId] = serviceName;
-
-            require(
-                _service[serviceNameHash][majorVersion] == address(0),
-                "ERROR:REG-008:ALREADY_REGISTERED"
-            );
-            _service[serviceNameHash][majorVersion] = objectAddress;
+        if(_service[version][domain] > address(0)) {
+            revert ServiceAlreadyRegistered(info.objectAddress);
         }
 
-        // create object info and link nft id with it
-        _registerObjectInfo(registerable, nftId);
-    }
+        _service[version][domain] = info.objectAddress; // nftId;
 
+        nftId = _register(info);
 
-    function registerObjectForInstance(
-        NftId parentNftId,
-        ObjectType objectType,
-        address initialOwner,
-        bytes memory data
-    )
+        emit LogServiceRegistration(version, domain);
+    }
+
+    function register(ObjectInfo memory info)
         external
-        override
-        returns (
-            // TODO add onlyRegisteredInstance
-            NftId nftId
-        )
+        onlyRegistryService
+        returns(NftId nftId)
     {
-        // TODO add more validation
-        require(
-            objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-010:TYPE_INVALID"
-        );
+        // no service registrations
+        if(info.objectType == SERVICE()) {
+            revert ServiceRegistration();
+        }
 
-        uint256 mintedTokenId = _chainNft.mint(initialOwner, EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
+        nftId = _register(info);
+    }
 
-        ObjectInfo memory info = ObjectInfo(
-            nftId,
-            parentNftId,
-            objectType,
-            address(0),
-            initialOwner,
-            data
-        );
+    /// @dev earliest GIF major version 
+    function getMajorVersionMin() external view returns (VersionPart) {
+        return _releaseManager.getInitialVersion();
+    }
 
-        _info[nftId] = info;
+    // 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 _releaseManager.getNextVersion();
+    }
 
-        // add logging
+    /// @dev latest active GIF release version 
+    function getMajorVersion() external view returns (VersionPart) { 
+        return _releaseManager.getLatestVersion();
+    }
+
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory)
+    {
+        return _releaseManager.getReleaseInfo(version);
     }
 
     function getObjectCount() external view override returns (uint256) {
         return _chainNft.totalSupply();
     }
 
-    function getNftId(
-        address object
-    ) external view override returns (NftId id) {
+    function getNftId() external view returns (NftId nftId) {
+        return _registryNftId;
+    }
+
+    function getNftId(address object) external view override returns (NftId id) {
         return _nftIdByAddress[object];
     }
 
-    function isRegistered(
-        NftId nftId
-    ) public view override returns (bool) {
-        return _info[nftId].objectType.gtz();
+    function ownerOf(NftId nftId) public view override returns (address) {
+        return _chainNft.ownerOf(nftId.toInt());
     }
 
-    function isRegistered(
-        address object
-    ) external view override returns (bool) {
-        return _nftIdByAddress[object].gtz();
+    function ownerOf(address contractAddress) public view returns (address) {
+        return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
-    function getObjectInfo(
-        NftId nftId
-    ) external view override returns (ObjectInfo memory info) {
+    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
-    function getName(
-        NftId nftId
-    ) external view returns (string memory name) {
-        return _string[nftId];
+    function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
+        return _info[_nftIdByAddress[object]];
     }
 
-    function getOwner(NftId nftId) external view override returns (address) {
-        return _chainNft.ownerOf(nftId.toInt());
+    function isRegistered(NftId nftId) public view override returns (bool) {
+        return _info[nftId].objectType.gtz();
     }
 
-    function getChainNft() external view override returns (IChainNft) {
-        return _chainNft;
+    function isRegistered(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz();
     }
 
-    // special case to retrive a gif service
-    function getServiceAddress(string memory serviceName, VersionPart majorVersion) external view override returns (address serviceAddress) {
-        bytes32 serviceNameHash = keccak256(abi.encode(serviceName));
-        return _service[serviceNameHash][majorVersion];
+    function isRegisteredService(address object) external view override returns (bool) {
+        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
     }
 
-    // from IERC165
-    function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
-        return interfaceId == type(IRegistry).interfaceId;
+    function getServiceAddress(
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    ) external view returns (address)
+    {
+        return _service[releaseVersion][serviceDomain];
     }
 
-    // from IRegistryLinked
-    function getRegistry() external view override returns (IRegistry registry) {
-        return this;
+    function getChainNft() external view override returns (ChainNft) {
+        return _chainNft;
     }
 
-    // from IRegisterable
-    function register() external pure override returns (NftId nftId) {
-        return zeroNftId();
+    function getOwner() public view returns (address owner) {
+        return ownerOf(address(this));
     }
 
-    function getType() external pure override returns (ObjectType objectType) {
-        return REGISTRY();
-    }
+    // Internals
 
+    /// @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)
+    {
+        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();
+        }
 
-    function getOwner() public view override returns (address owner) {
-        return _nftId.gtz() ? this.getOwner(_nftId) : _initialOwner;
-    }
+        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
 
-    function getNftId() external view override (IRegisterable, IRegistry) returns (NftId nftId) {
-        return _nftId;
-    }
+        // 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)) 
+        {
+            // parent is registered + object-parent types are valid
+            if(_isValidContractCombination[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
+
+            address contractAddress = info.objectAddress;
 
-    function getParentNftId() external view returns (NftId nftId) {
-        // we're the global registry
-        if(block.chainid == 1) {
-            return toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
+            if(_nftIdByAddress[contractAddress].gtz()) { 
+                revert ContractAlreadyRegistered(contractAddress);
+            }
+
+            _nftIdByAddress[contractAddress] = nftId;
         }
-        else {
-            return toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
+        else
+        {
+            if(_isValidObjectCombination[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
         }
-    }
 
-    function getData() external pure returns (bytes memory data) {
-        return "";
+        emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
     }
 
-    // registry specific functions
-    function getProtocolOwner() external view override returns (address) {
-        return _protocolOwner;
-    }
+    /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
+    function _getInterceptor(
+        bool isInterceptor, 
+        address objectAddress,
+        bool parentIsInterceptor,
+        address parentObjectAddress
+    )
+        internal 
+        view 
+        returns (address interceptor) 
+    {
+        if (objectAddress == address(0)) {
+            if (parentIsInterceptor) {
+                return parentObjectAddress;
+            } else {
+                return address(0);
+            }
+        }
 
-    /// @dev defines which types are allowed to register
-    function _setupValidTypes() internal {
-        _isValidType[REGISTRY()] = true; // only for global registry 
-        _isValidType[TOKEN()] = true;
-        _isValidType[SERVICE()] = true;
-        _isValidType[INSTANCE()] = true;
-        _isValidType[STAKE()] = true;
-        _isValidType[PRODUCT()] = true;
-        _isValidType[ORACLE()] = true;
-        _isValidType[POOL()] = true;
-        _isValidType[POLICY()] = true;
-        _isValidType[BUNDLE()] = true;
-    }
+        if (isInterceptor) {
+            return objectAddress;
+        }
 
-    /// @dev defines which types - parent type relations are allowed to register
-    function _setupValidParentTypes() internal {
-        // registry as parent
-        _isValidParentType[TOKEN()][REGISTRY()] = true;
-        _isValidParentType[SERVICE()][REGISTRY()] = true;
-        _isValidParentType[INSTANCE()][REGISTRY()] = true;
-
-        // instance as parent
-        _isValidParentType[PRODUCT()][INSTANCE()] = true;
-        _isValidParentType[DISTRIBUTOR()][INSTANCE()] = true;
-        _isValidParentType[ORACLE()][INSTANCE()] = true;
-        _isValidParentType[POOL()][INSTANCE()] = true;
-
-        // product as parent
-        _isValidParentType[POLICY()][PRODUCT()] = true;
-
-        // pool as parent
-        _isValidParentType[BUNDLE()][POOL()] = true;
-        _isValidParentType[STAKE()][POOL()] = true;
+        return address(0);
     }
 
+    // Internals called only in constructor
+
     /// @dev protocol registration used to anchor the dip ecosystem relations
-    function _registerProtocol() virtual internal {
-        uint256 protocolId = _chainNftInternal.PROTOCOL_NFT_ID();
-        _chainNftInternal.mint(_protocolOwner, protocolId);
-
-        NftId protocolNftid = toNftId(protocolId);
-        ObjectInfo memory protocolInfo = ObjectInfo(
-            protocolNftid,
-            zeroNftId(), // parent nft id
-            PROTOCOL(),
-            address(0), // contract address
-            _protocolOwner,
-            "" // data
-        );
-
-        _info[protocolNftid] = protocolInfo;
+    function _registerProtocol() 
+        private
+    {
+        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
+        NftId protocolNftId = toNftId(protocolId);
+
+        _info[protocolNftId] = ObjectInfo({
+            nftId: protocolNftId,
+            parentNftId: zeroNftId(),
+            objectType: PROTOCOL(),
+            isInterceptor: false, 
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
     }
 
     /// @dev registry registration
     /// might also register the global registry when not on mainnet
-    function _registerRegistry() virtual internal returns (NftId registryNftId) {
-        uint256 registryId = _chainNftInternal.calculateTokenId(2);
-        registryNftId = toNftId(registryId);
+    function _registerRegistry() 
+        private
+    {
+        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
+        NftId registryNftId = toNftId(registryId);
+        NftId parentNftId;
 
-        // we're not the global registry
-        if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) {
+        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
+        {// we're not the global registry
             _registerGlobalRegistry();
+            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
+        }
+        else 
+        {// we are global registry
+            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
         }
 
-        _chainNftInternal.mint(_protocolOwner, registryId);
-        _registerObjectInfo(this, registryNftId);
+        _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() virtual internal {
-        uint256 globalRegistryId = _chainNftInternal.GLOBAL_REGISTRY_ID();
-        _chainNftInternal.mint(_protocolOwner, globalRegistryId);
-
+    function _registerGlobalRegistry() 
+        private
+    {
+        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
         NftId globalRegistryNftId = toNftId(globalRegistryId);
-        ObjectInfo memory globalRegistryInfo = ObjectInfo(
-            globalRegistryNftId,
-            toNftId(_chainNftInternal.PROTOCOL_NFT_ID()),
-            REGISTRY(),
-            address(0), // contract address
-            _protocolOwner,
-            "" // data
-        );
-
-        _info[globalRegistryNftId] = globalRegistryInfo;
+
+        _info[globalRegistryNftId] = ObjectInfo({
+            nftId: globalRegistryNftId,
+            parentNftId: toNftId(_chainNft.PROTOCOL_NFT_ID()),
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: address(0),
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
     }
 
+    /// @dev defines which object - parent types relations are allowed to register
+    // IMPORTANT: 
+    // 1) EACH object type MUST have only one parent type across ALL mappings
+    // 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() 
+        private 
+    {
+        // registry as parent, ONLY registry owner
+        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
+        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
 
-    function _registerObjectInfo(
-        IRegisterable registerable,
-        NftId nftId
-    ) internal virtual {
-        address objectAddress = address(registerable);
-        ObjectInfo memory info = ObjectInfo(
-            nftId,
-            registerable.getParentNftId(),
-            registerable.getType(),
-            objectAddress,
-            registerable.getOwner(),
-            registerable.getData()
-        );
+        // registry as parent, ONLY approved
+        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
 
-        _info[nftId] = info;
-        _nftIdByAddress[objectAddress] = nftId;
+        // instance as parent, ONLY approved
+        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
+        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
+        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
+        _isValidContractCombination[POOL()][INSTANCE()] = true;
 
-        // add logging
-    }
+        // product as parent, ONLY approved
+        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
 
-}
+        // pool as parent, ONLY approved
+        _isValidObjectCombination[BUNDLE()][POOL()] = true;
+        _isValidObjectCombination[STAKE()][POOL()] = true;
+    }
+}