@etherisc/gif-next 0.0.2-d96b9e1-825 → 0.0.2-d9bed37-033

package/contracts/registry/Registry.sol

@@ -1,381 +1,717 @@
 // 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 {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
+import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
+
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
+import {ObjectType, ObjectTypeLib, PROTOCOL, REGISTRY, SERVICE, INSTANCE, STAKE, STAKING, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../type/ObjectType.sol";
 
-import {IChainNft} from "./IChainNft.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";
-
-// TODO make registry upgradable
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ReleaseRegistry} from "./ReleaseRegistry.sol";
+import {TokenRegistry} from "./TokenRegistry.sol";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
+
+/// @dev IMPORTANT
+// Each NFT minted by registry is accosiated with:
+// 1) NFT owner
+// 2) registred contract OR object stored in registered (parent) contract
+// Five registration flows:
+// 1) registerService() -> registers IService address by ReleaseRegistry (ReleaseRegistry is set at deployment time)
+// 2) register() -> registers IRegisterable address by IService (INSTANCE, PRODUCT, POOL, DISTRIBUTION, ORACLE)
+// 3)            -> registers object by IService (POLICY, BUNDLE, STAKE)
+// 4) registerWithCustomType() -> registers IRegisterable address with custom type by IService
+// 5) registerRegistry() -> registers IRegistry address (from different chain) by GifAdmin. Works ONLY on mainnet. 
+//                          Note: getters by address MUST not be used with this address (will return 0 or data related to different object or even revert)
+
+/// @dev Chain Registry contract implementing IRegistry.
+/// IRegistry for method details.
 contract Registry is
-    IRegisterable,
+    Initializable,
+    AccessManaged,
     IRegistry
 {
-    using NftIdLib for NftId;
+    /// @dev Protocol NFT ID
+    NftId public immutable PROTOCOL_NFT_ID;
+
+    /// @dev Gobal registry NFT ID
+    NftId public immutable GLOBAL_REGISTRY_NFT_ID;
+
+    /// @dev Gobal registry address on mainnet.
+    address public immutable GLOBAL_REGISTRY_ADDRESS;
+
+    /// @dev Registry NFT ID
+    NftId public immutable REGISTRY_NFT_ID;
+
+    /// @dev Deployer address that authorizes the initializer of this contract.
+    address public immutable DEPLOYER;
+
+    /// @dev Registry admin contract for this registry.
+    RegistryAdmin public immutable ADMIN;
+
+    /// @dev Chain NFT contract that keeps track of the ownership of all registered objects.
+    ChainNft public immutable CHAIN_NFT;
 
+    address public constant NFT_LOCK_ADDRESS = address(0x1);
+    uint256 public constant REGISTRY_TOKEN_SEQUENCE_ID = 2;
+    uint256 public constant STAKING_TOKEN_SEQUENCE_ID = 3;
     string public constant EMPTY_URI = "";
 
+    /// @dev keep track of different registries on different chains
+    mapping(uint256 chainId => NftId registryNftId) private _registryNftIdByChainId;
+    uint256[] private _chainId;
+
+    /// @dev keep track of object info and address reverse lookup
     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;
+    /// @dev keep track of service addresses by version and domain
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
+
+    mapping(ObjectType objectType => bool) private _coreTypes;
+
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) private _coreContractCombinations;
+
+    mapping(ObjectType objectType => mapping(
+            ObjectType parentType => bool)) private _coreObjectCombinations;
+
+    NftId private _stakingNftId;
 
-    NftId private _nftId;
-    IChainNft private _chainNft;
-    ChainNft private _chainNftInternal;
-    address private _initialOwner;
+    ReleaseRegistry private _releaseRegistry;
+    address private _tokenRegistryAddress;
+    address private _stakingAddress;
 
-    // @dev will own protocol nft and registry nft(s) minted during initialize
-    address private _protocolOwner;
+    modifier onlyDeployer() {
+        if (msg.sender != DEPLOYER) {
+            revert ErrorRegistryCallerNotDeployer();
+        }
+        _;
+    }
+
+    // TODO when create2 strategy is added to ignition:
+    // 1. move globalRegistry arg out from constructor into initialize()
+    // 2. add testRegistry_deployChainRegistryAtGlobalRegistryAddress
+    /// @dev Creates the registry contract and populates it with the protocol and registry objects.
+    /// Internally deploys the ChainNft contract.
+    constructor(RegistryAdmin admin, address globalRegistry)
+        AccessManaged(admin.authority())
+    {
+        DEPLOYER = msg.sender;
+        ADMIN = admin;
+        GLOBAL_REGISTRY_ADDRESS = _getGlobalRegistryAddress(globalRegistry);
 
-    // 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 
+        // deploy NFT 
+        CHAIN_NFT = new ChainNft(address(this));
+        GLOBAL_REGISTRY_NFT_ID = NftIdLib.toNftId(
+            CHAIN_NFT.GLOBAL_REGISTRY_ID());
+
+        // initial registry setup
+        PROTOCOL_NFT_ID = _registerProtocol();
+        REGISTRY_NFT_ID = _registerRegistry();
+
+        // set object types and object parent relations
+        _setupValidCoreTypesAndCombinations();
+    }
+
+
+    /// @dev Wires release registry, token registry and staking contract to this registry.
+    /// MUST be called by release registry.
     function initialize(
-        address chainNft, 
-        address protocolOwner
+        address releaseRegistry,
+        address tokenRegistry,
+        address staking
     )
-        public 
+        external
+        initializer()
+        onlyDeployer()
     {
-        require(
-            address(_chainNft) == address(0),
-            "ERROR:REG-001:ALREADY_INITIALIZED"
-        );
+        // store links to supporting contracts
+        _releaseRegistry = ReleaseRegistry(releaseRegistry);
+        _tokenRegistryAddress = tokenRegistry;
+        _stakingAddress = staking;
 
-        _initialOwner = msg.sender;
-        _protocolOwner = protocolOwner;
+        // register staking contract
+        _stakingNftId = _registerStaking();
+    }
 
-        _chainNft = IChainNft(chainNft);
-        _chainNftInternal = ChainNft(chainNft);
+    /// @inheritdoc IRegistry
+    function registerRegistry(
+        NftId nftId,
+        uint256 chainId, 
+        address registryAddress
+    )
+        external
+        restricted()
+    {
+        // registration of chain registries only allowed on mainnet
+        if (block.chainid != 1) {
+            revert ErrorRegistryNotOnMainnet(block.chainid);
+        }
 
-        // initial registry setup
-        _registerProtocol();
-        _nftId = _registerRegistry();
+        // registry chain id is not zero
+        if(chainId == 0) {
+            revert ErrorRegistryChainRegistryChainIdZero(nftId);
+        }
 
-        // setup rules for further registrations
-        _setupValidTypes();
-        _setupValidParentTypes();
-    }
+        // registry address is not zero
+        if (registryAddress == address(0)) {
+            revert ErrorRegistryChainRegistryAddressZero(nftId, chainId);
+        }
 
+        // registry nft id matches registry chain id
+        uint256 expectedRegistryId = CHAIN_NFT.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID, chainId);
+        if (nftId != NftIdLib.toNftId(expectedRegistryId)) {
+            revert ErrorRegistryChainRegistryNftIdInvalid(nftId, chainId);
+        }
 
-    function register(
-        address objectAddress
+        emit LogChainRegistryRegistration(nftId, chainId, registryAddress);
+
+        _registerRegistryForNft(
+            chainId,
+            ObjectInfo({
+                nftId: nftId,
+                parentNftId: REGISTRY_NFT_ID,
+                objectType: REGISTRY(),
+                isInterceptor: false,
+                objectAddress: registryAddress,
+                initialOwner: NFT_LOCK_ADDRESS,
+                data: ""  
+            }),
+            false); // do not update address lookup for objects on a different chain
+    }
+
+    // TODO limit service owner to registry admin?
+    /// @inheritdoc IRegistry
+    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);
-
-        // 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;
+        external
+        restricted()
+        returns(NftId nftId)
+    {
+        // service address is defined
+        address service = info.objectAddress;
+        if(service == address(0)) {
+            revert ErrorRegistryServiceAddressZero();
+        }
+
+        // version is defined
+        if(version.eqz()) {
+            revert ErrorRegistryServiceVersionZero(service);
+        }
+        // service domain is defined
+        if(domain.eqz()) {
+            revert ErrorRegistryServiceDomainZero(service, version);
+        }
+
+        // service has proper type
+        if(info.objectType != SERVICE()) {
+            revert ErrorRegistryNotService(service, info.objectType);
+        }
+
+        // service parent has registry type
+        if(info.parentNftId != REGISTRY_NFT_ID) {
+            revert ErrorRegistryServiceParentNotRegistry(service, version, info.parentNftId);
+        }
+
+        // service has not already been registered
+        if(_service[version][domain] != address(0)) {
+            revert ErrorRegistryServiceDomainAlreadyRegistered(service, version, domain);
         }
 
-        // create object info and link nft id with it
-        _registerObjectInfo(registerable, nftId);
+        _service[version][domain] = service;
+
+        emit LogServiceRegistration(version, domain);
+
+        nftId = _register(info);
     }
 
 
-    function registerObjectForInstance(
-        NftId parentNftId,
-        ObjectType objectType,
-        address initialOwner,
-        bytes memory data
-    )
+    /// @inheritdoc IRegistry
+    function register(ObjectInfo memory info)
+        external
+        restricted()
+        returns(NftId nftId)
+    {
+        address objectAddress = info.objectAddress;
+        ObjectType objectType = info.objectType;
+
+        // this indidirectly enforces that the parent is registered
+        // parentType would be zero for a non-registered parent which is never a valid type combination
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        // check type combinations for core objects
+        if(objectAddress == address(0)) {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectAddress, objectType, parentType);
+            }
+        }
+        // check type combinations for contract objects
+        else {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectAddress, objectType, parentType);
+            }
+        }
+
+        nftId = _register(info);
+    }
+
+
+    /// @inheritdoc IRegistry
+    function registerWithCustomType(ObjectInfo memory info)
         external
-        override
-        returns (
-            // TODO add onlyRegisteredInstance
-            NftId nftId
-        )
+        restricted()
+        returns(NftId nftId)
     {
-        // TODO add more validation
-        require(
-            objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-010:TYPE_INVALID"
-        );
-
-        uint256 mintedTokenId = _chainNft.mint(initialOwner, EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-
-        ObjectInfo memory info = ObjectInfo(
-            nftId,
-            parentNftId,
-            objectType,
-            address(0),
-            initialOwner,
-            data
-        );
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
 
-        _info[nftId] = info;
+        if(_coreTypes[objectType]) {
+            revert ErrorRegistryCoreTypeRegistration();
+        }
+
+        if(
+            objectType == ObjectTypeLib.zero() ||
+            parentType == ObjectTypeLib.zero() ||
+            parentType == PROTOCOL() ||
+            parentType == SERVICE()
+        ) {
+            revert ErrorRegistryTypesCombinationInvalid(info.objectAddress, objectType, parentType);
+        }
+
+        nftId = _register(info);
+    }
+
+
+    /// @dev earliest GIF major version 
+    function getInitialVersion() external view returns (VersionPart) {
+        return VersionPartLib.toVersionPart(_releaseRegistry.INITIAL_GIF_VERSION());
+    }
+
+    /// @dev next GIF release version to be released
+    function getNextVersion() external view returns (VersionPart) {
+        return _releaseRegistry.getNextVersion();
+    }
 
-        // add logging
+    /// @dev latest active GIF release version 
+    function getLatestVersion() external view returns (VersionPart) { 
+        return _releaseRegistry.getLatestVersion();
     }
 
-    function getObjectCount() external view override returns (uint256) {
-        return _chainNft.totalSupply();
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
+        return _releaseRegistry.getReleaseInfo(version);
     }
 
-    function getNftId(
-        address object
-    ) external view override returns (NftId id) {
+    function chainIds() public view returns (uint256) {
+        return _chainId.length;
+    }
+
+    function getChainId(uint256 idx) public view returns (uint256) {
+        return _chainId[idx];
+    }
+
+    function getRegistryNftId(uint256 chainId) public view returns (NftId nftId) {
+        return _registryNftIdByChainId[chainId];
+    }
+
+    function getObjectCount() external view returns (uint256) {
+        return CHAIN_NFT.totalSupply();
+    }
+
+    function getNftId() external view returns (NftId nftId) {
+        return REGISTRY_NFT_ID;
+    }
+
+    function getProtocolNftId() external view returns (NftId nftId) {
+        return PROTOCOL_NFT_ID;
+    }
+
+    function getNftIdForAddress(address object) external view 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 returns (address) {
+        return CHAIN_NFT.ownerOf(nftId.toInt());
     }
 
-    function isRegistered(
-        address object
-    ) external view override returns (bool) {
-        return _nftIdByAddress[object].gtz();
+    function isOwnerOf(NftId nftId, address expectedOwner) public view returns (bool) {
+        return CHAIN_NFT.ownerOf(nftId.toInt()) == expectedOwner;
     }
 
-    function getObjectInfo(
-        NftId nftId
-    ) external view override returns (ObjectInfo memory info) {
+    function ownerOf(address contractAddress) public view returns (address) {
+        return CHAIN_NFT.ownerOf(_nftIdByAddress[contractAddress].toInt());
+    }
+
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
-    function getName(
-        NftId nftId
-    ) external view returns (string memory name) {
-        return _string[nftId];
+    function isObjectType(NftId nftId, ObjectType expectedObjectType) external view returns (bool) {
+        return _info[nftId].objectType == expectedObjectType;
     }
 
-    function getOwner(NftId nftId) external view override returns (address) {
-        return _chainNft.ownerOf(nftId.toInt());
+    function getObjectAddress(NftId nftId) external view returns (address) {
+        return _info[nftId].objectAddress;
     }
 
-    function getChainNft() external view override returns (IChainNft) {
-        return _chainNft;
+    function getObjectInfo(address object) external view returns (ObjectInfo memory) {
+        return _info[_nftIdByAddress[object]];
     }
 
-    // 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 isRegistered(NftId nftId) public view returns (bool) {
+        return _info[nftId].objectType.gtz();
     }
 
-    // from IERC165
-    function supportsInterface(bytes4 interfaceId) external pure override returns (bool) {
-        return interfaceId == type(IRegistry).interfaceId;
+    function isRegistered(address object) external view returns (bool) {
+        return _nftIdByAddress[object].gtz();
     }
 
-    // from IRegistryLinked
-    function getRegistry() external view override returns (IRegistry registry) {
-        return this;
+    function isRegisteredService(address object) external view returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
     }
 
-    // from IRegisterable
-    function register() external pure override returns (NftId nftId) {
-        return zeroNftId();
+    function isRegisteredComponent(address object) external view returns (bool) {
+        NftId objectParentNftId = _info[_nftIdByAddress[object]].parentNftId;
+        return _info[objectParentNftId].objectType == INSTANCE();
     }
 
-    function getType() external pure override returns (ObjectType objectType) {
-        return REGISTRY();
+    function isActiveRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseRegistry.isActiveRelease(version);
     }
 
+    function getStakingAddress() external view returns (address staking) {
+        return _stakingAddress;
+    }
 
-    function getOwner() public view override returns (address owner) {
-        return _nftId.gtz() ? this.getOwner(_nftId) : _initialOwner;
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return _tokenRegistryAddress;
     }
 
-    function getNftId() external view override (IRegisterable, IRegistry) returns (NftId nftId) {
-        return _nftId;
+    function getServiceAddress(
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    ) external view returns (address service)
+    {
+        service =  _service[releaseVersion][serviceDomain]; 
     }
 
-    function getParentNftId() external view returns (NftId nftId) {
-        // we're the global registry
-        if(block.chainid == 1) {
-            return toNftId(_chainNftInternal.PROTOCOL_NFT_ID());
-        }
-        else {
-            return toNftId(_chainNftInternal.GLOBAL_REGISTRY_ID());
-        }
+    function getReleaseRegistryAddress() external view returns (address) {
+        return address(_releaseRegistry);
     }
 
-    function getData() external pure returns (bytes memory data) {
-        return "";
+    function getChainNftAddress() external view override returns (address) {
+        return address(CHAIN_NFT);
     }
 
-    // registry specific functions
-    function getProtocolOwner() external view override returns (address) {
-        return _protocolOwner;
+    function getRegistryAdminAddress() external view returns (address) {
+        return address(ADMIN);
     }
 
-    /// @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;
+    function getAuthority() external view returns (address) {
+        return ADMIN.authority();
     }
 
-    /// @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;
+    function getOwner() public view returns (address owner) {
+        return ownerOf(address(this));
+    }
 
-        // instance as parent
-        _isValidParentType[PRODUCT()][INSTANCE()] = true;
-        _isValidParentType[DISTRIBUTOR()][INSTANCE()] = true;
-        _isValidParentType[ORACLE()][INSTANCE()] = true;
-        _isValidParentType[POOL()][INSTANCE()] = true;
+    // IERC165
 
-        // product as parent
-        _isValidParentType[POLICY()][PRODUCT()] = true;
+    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+        if(interfaceId == type(IERC165).interfaceId || interfaceId == type(IRegistry).interfaceId) {
+            return true;
+        }
 
-        // pool as parent
-        _isValidParentType[BUNDLE()][POOL()] = true;
-        _isValidParentType[STAKE()][POOL()] = true;
+        return false;
     }
 
-    /// @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;
-    }
-
-    /// @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);
-
-        // we're not the global registry
-        if(registryId != _chainNftInternal.GLOBAL_REGISTRY_ID()) {
-            _registerGlobalRegistry();
+    // Internals
+
+    /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
+    function _register(ObjectInfo memory info)
+        internal
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType; // do not care here, never PROTOCOL(), REGISTRY()
+        bool isInterceptor = info.isInterceptor;
+        address objectAddress = info.objectAddress; // do not care here, can be 0
+        address owner = info.initialOwner; // do not care here, can be 0, can be equal info.objectAddress
+
+        NftId parentNftId = info.parentNftId; // do not care here, can not be 0
+        ObjectInfo memory parentInfo = _info[parentNftId];
+        address parentAddress = parentInfo.objectAddress; // can be 0
+
+        // parent is contract -> need to check? -> check before minting
+        // special case: staking: to protocol possible as well
+        // NO LONGER TRUE: special case: global registry nft as parent when not on mainnet -> global registry address is 0
+        // special case: when parentNftId == CHAIN_NFT.mint(), check for zero parent address before mint
+        // special case: when parentNftId == CHAIN_NFT.mint() && objectAddress == initialOwner
+        // Parent can have 0 address in case of STAKE for PROTOCOL / CUSTOM_TYPE for POLICY
+        // But it MUST be registered -> parentType != 0 && parentNftId != 0
+        /*if(objectType != STAKE()) {
+            if(parentAddress == address(0)) {
+                revert ErrorRegistryParentAddressZero();
+            }
+        }*/
+    
+        // global registry is never parent when not on mainnet
+        if(block.chainid != 1) {
+            if(parentNftId == GLOBAL_REGISTRY_NFT_ID) {
+                revert ErrorRegistryGlobalRegistryAsParent(objectAddress, objectType);
+            }
         }
 
-        _chainNftInternal.mint(_protocolOwner, registryId);
-        _registerObjectInfo(this, registryNftId);
+        address interceptorAddress = _getInterceptor(
+            isInterceptor, 
+            objectType, 
+            objectAddress, 
+            parentInfo.isInterceptor, 
+            parentAddress);
+
+        uint256 tokenId = CHAIN_NFT.getNextTokenId();
+        nftId = NftIdLib.toNftId(tokenId);
+        info.nftId = nftId;
+
+        _info[nftId] = info;
+        _setAddressForNftId(nftId, objectAddress);
+
+        emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
+
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = CHAIN_NFT.mint(
+            owner,
+            interceptorAddress,
+            EMPTY_URI);
+
+        assert(mintedTokenId == tokenId);        
     }
 
+    /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
+    /// special case: STAKES (parent may be any type) -> no intercept call
+    /// default case: 
+    function _getInterceptor(
+        bool isInterceptor, 
+        ObjectType objectType,
+        address objectAddress,
+        bool parentIsInterceptor,
+        address parentObjectAddress
+    )
+        internal 
+        pure 
+        returns (address interceptor) 
+    {
+        // no intercepting calls for stakes
+        if (objectType == STAKE()) {
+            return address(0);
+        }
 
-    /// @dev global registry registration for non mainnet registries
-    function _registerGlobalRegistry() virtual internal {
-        uint256 globalRegistryId = _chainNftInternal.GLOBAL_REGISTRY_ID();
-        _chainNftInternal.mint(_protocolOwner, globalRegistryId);
+        if (objectAddress == address(0)) {
+            if (parentIsInterceptor) {
+                return parentObjectAddress;
+            } else {
+                return address(0);
+            }
+        }
 
-        NftId globalRegistryNftId = toNftId(globalRegistryId);
-        ObjectInfo memory globalRegistryInfo = ObjectInfo(
-            globalRegistryNftId,
-            toNftId(_chainNftInternal.PROTOCOL_NFT_ID()),
-            REGISTRY(),
-            address(0), // contract address
-            _protocolOwner,
-            "" // data
-        );
+        if (isInterceptor) {
+            return objectAddress;
+        }
 
-        _info[globalRegistryNftId] = globalRegistryInfo;
+        return address(0);
     }
 
+    // Internals called only in constructor
 
-    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()
-        );
+    /// @dev protocol registration used to anchor the dip ecosystem relations
+    function _registerProtocol() 
+        private
+        returns (NftId protocolNftId)
+    {
+        uint256 protocolId = CHAIN_NFT.PROTOCOL_NFT_ID();
+        protocolNftId = NftIdLib.toNftId(protocolId);
+
+        _registerForNft(
+            ObjectInfo({
+                nftId: protocolNftId,
+                parentNftId: NftIdLib.zero(),
+                objectType: PROTOCOL(),
+                isInterceptor: false, 
+                objectAddress: address(0),
+                initialOwner: NFT_LOCK_ADDRESS,
+                data: ""}),
+            true);
+    }
 
-        _info[nftId] = info;
-        _nftIdByAddress[objectAddress] = nftId;
+    /// @dev register this registry
+    function _registerRegistry() 
+        internal 
+        virtual
+        returns (NftId registryNftId)
+    {
+        // initial assignment
+        registryNftId = GLOBAL_REGISTRY_NFT_ID;
+
+        // register global registry
+        _registerRegistryForNft(
+            1, // mainnet chain id
+            ObjectInfo({
+                nftId: GLOBAL_REGISTRY_NFT_ID,
+                parentNftId: PROTOCOL_NFT_ID,
+                objectType: REGISTRY(),
+                isInterceptor: false,
+                objectAddress: GLOBAL_REGISTRY_ADDRESS, 
+                initialOwner: NFT_LOCK_ADDRESS,
+                data: ""}),
+            block.chainid == 1);// update address lookup for global registry only on mainnet
+
+        // if not on mainnet: register this registry with global registry as parent
+        if (block.chainid != 1) {
+
+            // modify registry nft id to local registry when not on mainnet
+            registryNftId = NftIdLib.toNftId(
+                CHAIN_NFT.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID));
+
+            _registerRegistryForNft(
+                block.chainid, 
+                ObjectInfo({
+                    nftId: registryNftId,
+                    parentNftId: GLOBAL_REGISTRY_NFT_ID,
+                    objectType: REGISTRY(),
+                    isInterceptor: false,
+                    objectAddress: address(this),
+                    initialOwner: NFT_LOCK_ADDRESS,
+                    data: ""}),
+                true);
+        }
+    }
+
+    /// @dev staking registration
+    function _registerRegistryForNft(
+        uint256 chainId,
+        ObjectInfo memory info,
+        bool updateAddressLookup
+    )
+        private
+    {
+        if (!_registryNftIdByChainId[chainId].eqz()) {
+            revert ErrorRegistryChainRegistryAlreadyRegistered(info.nftId, chainId);
+        }
+
+        // update registry lookup variables
+        _registryNftIdByChainId[chainId] = info.nftId;
+        _chainId.push(chainId);
+
+        // register the registry info
+        _registerForNft(
+            info,
+            updateAddressLookup); 
+    }
 
-        // add logging
+    /// @dev staking registration
+    function _registerStaking()
+        private
+        returns (NftId stakingNftId)
+    {
+        address stakingOwner = IRegisterable(_stakingAddress).getOwner();
+        uint256 stakingId = CHAIN_NFT.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
+        stakingNftId = NftIdLib.toNftId(stakingId);
+
+        _registerForNft( 
+            ObjectInfo({
+                nftId: stakingNftId,
+                parentNftId: REGISTRY_NFT_ID,
+                objectType: STAKING(),
+                isInterceptor: false,
+                objectAddress: _stakingAddress, 
+                initialOwner: stakingOwner,
+                data: ""}),
+            true); 
+    }
+
+    /// @dev Register the provided object info for the specified NFT ID.
+    function _registerForNft(
+        ObjectInfo memory info, 
+        bool updateAddressLookup
+    )
+        internal
+    {
+        _info[info.nftId] = info;
+
+        if (updateAddressLookup) {
+            _setAddressForNftId(info.nftId, info.objectAddress);
+        }
+
+        // calls nft receiver
+        CHAIN_NFT.mint(info.initialOwner, info.nftId.toInt());
+    }
+
+    function _setAddressForNftId(NftId nftId, address objectAddress)
+        internal
+    {
+        if (objectAddress != address(0)) {
+            if (_nftIdByAddress[objectAddress].gtz()) { 
+                revert ErrorRegistryContractAlreadyRegistered(objectAddress);
+            }
+
+            _nftIdByAddress[objectAddress] = nftId;
+        }
     }
 
+    function _getGlobalRegistryAddress(address globalRegistry) internal view returns (address) {
+        if (block.chainid == 1) {
+            return address(this);
+        } else {
+            return globalRegistry;
+        }
+    }
+
+    /// @dev defines which object - parent types relations are allowed to register
+    /// EACH object type MUST have only one parent type across ALL mappings
+    // the only EXCEPTION is STAKE, can have any number of parent types
+    function _setupValidCoreTypesAndCombinations() 
+        private
+    {
+        _coreTypes[PROTOCOL()] = true;
+        _coreTypes[REGISTRY()] = true;
+        _coreTypes[SERVICE()] = true;
+        _coreTypes[INSTANCE()] = true;
+        _coreTypes[PRODUCT()] = true;
+        _coreTypes[POOL()] = true;
+        _coreTypes[DISTRIBUTION()] = true;
+        _coreTypes[DISTRIBUTOR()] = true;
+        _coreTypes[ORACLE()] = true;
+        _coreTypes[POLICY()] = true;
+        _coreTypes[BUNDLE()] = true;
+        _coreTypes[STAKING()] = true;
+        _coreTypes[STAKE()] = true;
+
+        // types combinations allowed to use with register() function ONLY
+        _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
+
+        // components with instance parent
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+
+        // components with product parent
+        _coreContractCombinations[DISTRIBUTION()][PRODUCT()] = true;
+        _coreContractCombinations[ORACLE()][PRODUCT()] = true;
+        _coreContractCombinations[POOL()][PRODUCT()] = true;
+
+        // objects with component parents
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+
+        // staking
+        _coreObjectCombinations[STAKE()][PROTOCOL()] = true;
+        _coreObjectCombinations[STAKE()][INSTANCE()] = true;
+    }
 }