@etherisc/gif-next 0.0.2-ffba655 → 3.0.0-06d5e8b-738

package/contracts/registry/Registry.sol

@@ -1,182 +1,736 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
+
+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 {ChainNft} from "./ChainNft.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {IRelease} from "./IRelease.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IStaking} from "../staking/IStaking.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
+    Initializable,
+    AccessManaged,
+    IRegistry
+{
+    /// @dev Protocol NFT ID
+    NftId public immutable PROTOCOL_NFT_ID;
 
-import {IChainNft} from "./IChainNft.sol";
-import {IRegistry, IRegistryLinked, IRegisterable} from "./IRegistry.sol";
-import {NftId, toNftId} from "../types/NftId.sol";
-import {NftIdLib} from "../types/NftId.sol";
+    /// @dev Gobal registry NFT ID
+    NftId public immutable GLOBAL_REGISTRY_NFT_ID;
 
-contract RegistryLinked is IRegistryLinked {
+    /// @dev Gobal registry address on mainnet.
+    address public immutable GLOBAL_REGISTRY_ADDRESS;
 
-    IRegistry internal _registry;
-    
-    constructor(address registry) {
-        _registry = IRegistry(registry);
+    /// @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(address object => NftId nftId) private _nftIdByAddress;
+
+    /// @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;
+
+    ReleaseRegistry private _releaseRegistry;
+    address private _tokenRegistryAddress;
+    address private _stakingAddress;
+
+    modifier onlyDeployer() {
+        if (msg.sender != DEPLOYER) {
+            revert ErrorRegistryCallerNotDeployer();
+        }
+        _;
     }
 
-    function getRegistry() external view override returns(IRegistry registry) {
-        return _registry;
+    // 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);
+
+        // 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 releaseRegistry,
+        address tokenRegistry,
+        address staking
+    )
+        external
+        initializer()
+        onlyDeployer()
+    {
+        // store links to supporting contracts
+        _releaseRegistry = ReleaseRegistry(releaseRegistry);
+        _tokenRegistryAddress = tokenRegistry;
+        _stakingAddress = staking;
 
-abstract contract Registerable is 
-    RegistryLinked,
-    IRegisterable
-{
-    using NftIdLib for NftId;
+        // register staking contract
+        _stakingNftId = _registerStaking();
+    }
 
-    address private _initialOwner;
-    
-    constructor(address registry)
-        RegistryLinked(registry)
+    /// @inheritdoc IRegistry
+    function registerRegistry(
+        NftId nftId,
+        uint256 chainId, 
+        address registryAddress
+    )
+        external
+        restricted()
     {
-        _initialOwner = msg.sender;
+        // registration of chain registries only allowed on mainnet
+        if (block.chainid != 1) {
+            revert ErrorRegistryNotOnMainnet(block.chainid);
+        }
+
+        // registry chain id is not zero
+        if(chainId == 0) {
+            revert ErrorRegistryChainRegistryChainIdZero(nftId);
+        }
+
+        // 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);
+        }
+
+        emit LogRegistryChainRegistryRegistered(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
     }
 
-    // getType, getData and register need to be implemented by concrete contract
+    // TODO limit service owner to registry admin?
+    /// @inheritdoc IRegistry
+    function registerService(
+        ObjectInfo memory info, 
+        VersionPart version, 
+        ObjectType domain
+    )
+        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);
+        }
 
-    function isRegisterable() external pure override returns(bool) {
-        return true;
+        _service[version][domain] = service;
+
+        emit LogRegistryServiceRegistered(version, domain);
+
+        nftId = _register(info);
     }
 
-    function getInitialOwner() public view override returns(address deployer) {
-        return _initialOwner;
+
+    /// @inheritdoc IRegistry
+    function register(ObjectInfo memory info)
+        external
+        restricted()
+        returns(NftId nftId)
+    {
+        address objectAddress = info.objectAddress;
+        ObjectType objectType = info.objectType;
+
+        // specialized functions have to be used to register registries and services
+        if(objectType == REGISTRY() || objectType == STAKING() || objectType == SERVICE()) {
+            revert ErrorRegistryObjectTypeNotSupported(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 ErrorRegistryTypeCombinationInvalid(objectAddress, objectType, parentType);
+            }
+        }
+        // check type combinations for contract objects
+        else {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypeCombinationInvalid(objectAddress, objectType, parentType);
+            }
+        }
+
+        nftId = _register(info);
     }
 
-    function isRegistered() public view override returns(bool) {
-        NftId nftId = _registry.getNftId(address(this));
-        return nftId.gtz();
+
+    /// @inheritdoc IRegistry
+    function registerWithCustomType(ObjectInfo memory info)
+        external
+        restricted()
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        if(_coreTypes[objectType]) {
+            revert ErrorRegistryCoreTypeRegistration();
+        }
+
+        if(
+            objectType == ObjectTypeLib.zero() ||
+            parentType == ObjectTypeLib.zero() ||
+            parentType == PROTOCOL() ||
+            parentType == STAKING() ||
+            parentType == SERVICE()
+        ) {
+            revert ErrorRegistryTypeCombinationInvalid(info.objectAddress, objectType, parentType);
+        }
+
+        nftId = _register(info);
     }
 
-    function getNftId() public view override returns(NftId nftId) {
-        return _registry.getNftId(address(this));
+
+    /// @dev earliest GIF major version 
+    function getInitialRelease() external view returns (VersionPart) {
+        return VersionPartLib.toVersionPart(_releaseRegistry.INITIAL_GIF_VERSION());
     }
 
-    function getOwner() public view override returns(address owner) {
-        NftId id = _registry.getNftId(address(this));
-        owner = _registry.getOwner(id);
-        return owner != address(0) ? owner : _initialOwner;
+    /// @dev next GIF release version to be released
+    function getNextRelease() external view returns (VersionPart) {
+        return _releaseRegistry.getNextVersion();
     }
 
-}
+    /// @dev latest active GIF release version 
+    function getLatestRelease() external view returns (VersionPart) { 
+        return _releaseRegistry.getLatestVersion();
+    }
 
-contract Registry is IRegistry {
-    using NftIdLib for NftId;
-    string public constant EMPTY_URI = "";
+    function getReleaseInfo(VersionPart release) external view returns (IRelease.ReleaseInfo memory) {
+        return _releaseRegistry.getReleaseInfo(release);
+    }
 
-    mapping(NftId nftId => RegistryInfo info) private _info;
-    mapping(NftId nftId => address owner) private _owner;
-    mapping(address object => NftId nftId) private _nftIdByAddress;
+    function chainIds() public view returns (uint256) {
+        return _chainId.length;
+    }
 
-    IChainNft private _chainNft;
+    function getChainId(uint256 idx) public view returns (uint256) {
+        return _chainId[idx];
+    }
 
-    function initialize(address chainNft) external {
-        require(address(_chainNft) == address(0), "ERROR:REG-001:ALREADY_INITIALIZED");
-        _chainNft = IChainNft(chainNft);
+    function getRegistryNftId(uint256 chainId) public view returns (NftId nftId) {
+        return _registryNftIdByChainId[chainId];
     }
 
-    function TOKEN() public pure override returns(uint256) { return 30; }
-    function INSTANCE() public pure override returns(uint256) { return 40; }
-    function PRODUCT() public pure override returns(uint256) { return 50; }
-    function ORACLE() public pure override returns(uint256) { return 60; }
-    function POOL() public pure override returns(uint256) { return 70; }
-    function POLICY() public pure override returns(uint256) { return 80; }
-    function BUNDLE() public pure override returns(uint256) { return 90; }
+    function getObjectCount() external view returns (uint256) {
+        return CHAIN_NFT.totalSupply();
+    }
 
-    function register(address objectAddress) external override returns(NftId nftId) {
-        require(_nftIdByAddress[objectAddress].eqz(), "ERROR:REG-002:ALREADY_REGISTERED");
+    function getNftId() external view returns (NftId nftId) {
+        return REGISTRY_NFT_ID;
+    }
 
-        IRegisterable registerable = IRegisterable(objectAddress);
-        require(registerable.isRegisterable(), "ERROR:REG-003:NOT_REGISTERABLE");
+    function getProtocolNftId() external view returns (NftId nftId) {
+        return PROTOCOL_NFT_ID;
+    }
 
-        // check parent exists (for objects not instances)
-        if(registerable.getType() != INSTANCE()) {
-            RegistryInfo memory parentInfo = _info[registerable.getParentNftId()];
-            require(parentInfo.nftId.gtz(), "ERROR:REG-004:PARENT_NOT_FOUND");
-            // check validity of parent relation, valid relations are
-            // policy -> product, bundle -> pool, product -> instance, pool -> instance
-        }
+    function getNftIdForAddress(address object) external view returns (NftId id) {
+        return _nftIdByAddress[object];
+    }
 
-        uint256 mintedTokenId = _chainNft.mint(
-            registerable.getInitialOwner(), 
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
-    
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            registerable.getParentNftId(),
-            registerable.getType(),
-            objectAddress,
-            registerable.getInitialOwner()
-        );
+    function ownerOf(NftId nftId) public view returns (address) {
+        return CHAIN_NFT.ownerOf(nftId.toInt());
+    }
 
-        _info[nftId] = info;
-        _nftIdByAddress[objectAddress] = nftId;
+    function isOwnerOf(NftId nftId, address expectedOwner) public view returns (bool) {
+        return CHAIN_NFT.ownerOf(nftId.toInt()) == expectedOwner;
+    }
+
+    function ownerOf(address contractAddress) public view returns (address) {
+        return CHAIN_NFT.ownerOf(_nftIdByAddress[contractAddress].toInt());
+    }
 
-        // add logging
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
+        return _info[nftId];
     }
 
+    function getParentNftId(NftId nftId) external view returns (NftId parentNftId) {
+        return _info[nftId].parentNftId;
+    }
 
-    function registerObjectForInstance(
-        NftId parentNftId,
-        uint256 objectType,
-        address initialOwner
-    )
-        external 
-        override
-        // TODO add onlyRegisteredInstance
+    function isObjectType(address contractAddress, ObjectType expectedObjectType) external view returns (bool) {
+        NftId nftId = _nftIdByAddress[contractAddress];
+        return isObjectType(nftId, expectedObjectType);
+    }
+
+    function isObjectType(NftId nftId, ObjectType expectedObjectType) public view returns (bool) {
+        return _info[nftId].objectType == expectedObjectType;
+    }
+
+    function getObjectAddress(NftId nftId) external view returns (address) {
+        return _info[nftId].objectAddress;
+    }
+
+    function getObjectInfo(address object) external view returns (ObjectInfo memory) {
+        return _info[_nftIdByAddress[object]];
+    }
+
+    function isRegistered(NftId nftId) public view returns (bool) {
+        return _info[nftId].objectType.gtz();
+    }
+
+    function isRegistered(address object) external view returns (bool) {
+        return _nftIdByAddress[object].gtz();
+    }
+
+    function isRegisteredService(address object) external view returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
+    function isRegisteredComponent(address object) external view returns (bool) {
+        NftId objectParentNftId = _info[_nftIdByAddress[object]].parentNftId;
+        return _info[objectParentNftId].objectType == INSTANCE();
+    }
+
+    function isActiveRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseRegistry.isActiveRelease(version);
+    }
+
+    function getStakingAddress() external view returns (address staking) {
+        return _stakingAddress;
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return _tokenRegistryAddress;
+    }
+
+    function getServiceAddress(
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    ) external view returns (address service)
+    {
+        service =  _service[releaseVersion][serviceDomain]; 
+    }
+
+    function getReleaseRegistryAddress() external view returns (address) {
+        return address(_releaseRegistry);
+    }
+
+    function getChainNftAddress() external view override returns (address) {
+        return address(CHAIN_NFT);
+    }
+
+    function getRegistryAdminAddress() external view returns (address) {
+        return address(ADMIN);
+    }
+
+    function getAuthority() external view returns (address) {
+        return ADMIN.authority();
+    }
+
+    function getOwner() public view returns (address owner) {
+        return ownerOf(address(this));
+    }
+
+    // IERC165
+
+    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+        if(interfaceId == type(IERC165).interfaceId || interfaceId == type(IRegistry).interfaceId) {
+            return true;
+        }
+
+        return false;
+    }
+
+    // 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)
     {
-        // TODO add more validation
-        require(
-            objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-005:TYPE_INVALID");
+        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);
+            }
+        }
 
-        uint256 mintedTokenId = _chainNft.mint(
-            initialOwner,
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
+        address interceptorAddress = _getInterceptor(
+            isInterceptor, 
+            objectType, 
+            objectAddress, 
+            parentInfo.isInterceptor, 
+            parentAddress);
 
-        RegistryInfo memory info = RegistryInfo(
-            nftId,
-            parentNftId,
-            objectType,
-            address(0),
-            initialOwner
-        );
+        uint256 tokenId = CHAIN_NFT.getNextTokenId();
+        nftId = NftIdLib.toNftId(tokenId);
+        info.nftId = nftId;
 
         _info[nftId] = info;
+        _setAddressForNftId(nftId, objectAddress);
+
+        emit LogRegistryObjectRegistered(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
+
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = CHAIN_NFT.mint(
+            owner,
+            interceptorAddress,
+            EMPTY_URI);
 
-        // add logging
+        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);
+        }
 
-    function getObjectCount() external view override returns(uint256) {
-        return _chainNft.totalSupply();
+        if (objectAddress == address(0)) {
+            if (parentIsInterceptor) {
+                return parentObjectAddress;
+            } else {
+                return address(0);
+            }
+        }
+
+        if (isInterceptor) {
+            return objectAddress;
+        }
+
+        return address(0);
     }
 
+    // Internals called only in constructor
 
-    function getNftId(address object) external view override returns(NftId id) {
-        return _nftIdByAddress[object];
+    /// @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);
+    }
+
+    /// @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);
+        }
 
-    function isRegistered(address object) external view override returns(bool) {
-        return _nftIdByAddress[object].gtz();
+        // update registry lookup variables
+        _registryNftIdByChainId[chainId] = info.nftId;
+        _chainId.push(chainId);
+
+        // register the registry info
+        _registerForNft(
+            info,
+            updateAddressLookup); 
     }
 
+    /// @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); 
+
+        IStaking(_stakingAddress).initializeTokenHandler();
+    }
 
-    function getInfo(NftId nftId) external view override returns(RegistryInfo memory info) {
-        return _info[nftId];
+    /// @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 getOwner(NftId nftId) external view override returns(address) {
-        return _chainNft.ownerOf(nftId.toInt());
+    function _setAddressForNftId(NftId nftId, address objectAddress)
+        internal
+    {
+        if (objectAddress != address(0)) {
+            if (_nftIdByAddress[objectAddress].gtz()) { 
+                revert ErrorRegistryContractAlreadyRegistered(objectAddress);
+            }
+
+            _nftIdByAddress[objectAddress] = nftId;
+        }
     }
 
-    function getNftAddress() external view override returns(address nft) {
-        return address(_chainNft);
+    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;
     }
 }