@etherisc/gif-next 0.0.2-78e428e-483 → 0.0.2-79292f9-089

package/contracts/registry/Registry.sol

@@ -3,12 +3,12 @@ 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 {InitializableCustom} from "../shared/InitializableCustom.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} from "../type/Version.sol";
-import {ObjectType, PROTOCOL, REGISTRY, SERVICE, INSTANCE, STAKE, STAKING, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../type/ObjectType.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";
@@ -17,30 +17,60 @@ import {ReleaseRegistry} from "./ReleaseRegistry.sol";
 import {TokenRegistry} from "./TokenRegistry.sol";
 import {RegistryAdmin} from "./RegistryAdmin.sol";
 
-// IMPORTANT
+/// @dev 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)
-
-/// @title Chain Registry contract implementing IRegistry.
-/// @notice See IRegistry for method details.
+// 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
-    InitializableCustom,
+    Initializable,
+    AccessManaged,
     IRegistry
 {
-    address public NFT_LOCK_ADDRESS = address(0x1);
+    /// @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 chanId => 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;
@@ -51,57 +81,46 @@ contract Registry is
     mapping(ObjectType objectType => mapping(
             ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    RegistryAdmin public immutable _admin;
-    ChainNft public immutable _chainNft;
-
-    NftId public immutable _protocolNftId;
-    NftId public immutable _registryNftId;
-    NftId public _stakingNftId;
-
-    address public _tokenRegistryAddress;
-    address public _stakingAddress;
-    ReleaseRegistry public _releaseRegistry;
-
-    // TODO 
-    // 1). Registry and ReleaseRegistry must be treated as whole single entity. 
-    //     But current limitations of EVM does not allow it -> require it to be splitted
-    // 2). Keep onlyReleaseRegistry modifier
-    // 3). Delete onlyRegistryService in favor of restricted
-    // 4). (For GlobalRegistry ONLY) make registerChainRegistry() restricted to GIF_ADMIN_ROLE
-    modifier onlyRegistryService() {
-        if(!_releaseRegistry.isActiveRegistryService(msg.sender)) {
-            revert ErrorRegistryCallerNotRegistryService();
-        }
-        _;
-    }
+    NftId private _stakingNftId;
 
+    ReleaseRegistry private _releaseRegistry;
+    address private _tokenRegistryAddress;
+    address private _stakingAddress;
 
-    modifier onlyReleaseRegistry() {
-        if(msg.sender != address(_releaseRegistry)) {
-            revert ErrorRegistryCallerNotReleaseRegistry();
+    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) 
-        InitializableCustom() 
+    constructor(RegistryAdmin admin, address globalRegistry)
+        AccessManaged(admin.authority())
     {
-        _admin = admin;
+        DEPLOYER = msg.sender;
+        ADMIN = admin;
+        GLOBAL_REGISTRY_ADDRESS = _getGlobalRegistryAddress(globalRegistry);
+
         // deploy NFT 
-        _chainNft = new ChainNft(address(this));
+        CHAIN_NFT = new ChainNft(address(this));
+        GLOBAL_REGISTRY_NFT_ID = NftIdLib.toNftId(
+            CHAIN_NFT.GLOBAL_REGISTRY_ID());
 
         // initial registry setup
-        _protocolNftId = _registerProtocol();
-        _registryNftId = _registerRegistry();
+        PROTOCOL_NFT_ID = _registerProtocol();
+        REGISTRY_NFT_ID = _registerRegistry();
 
         // set object types and object parent relations
         _setupValidCoreTypesAndCombinations();
     }
 
 
-    /// @dev Wires release registry and token to registry (this contract).
+    /// @dev Wires release registry, token registry and staking contract to this registry.
     /// MUST be called by release registry.
     function initialize(
         address releaseRegistry,
@@ -110,40 +129,69 @@ contract Registry is
     )
         external
         initializer()
+        onlyDeployer()
     {
+        // store links to supporting contracts
         _releaseRegistry = ReleaseRegistry(releaseRegistry);
         _tokenRegistryAddress = tokenRegistry;
         _stakingAddress = staking;
 
+        // register staking contract
         _stakingNftId = _registerStaking();
     }
 
     /// @inheritdoc IRegistry
-    function register(ObjectInfo memory info)
+    function registerRegistry(
+        NftId nftId,
+        uint256 chainId, 
+        address registryAddress
+    )
         external
-        onlyRegistryService
-        returns(NftId nftId)
+        restricted()
     {
-        ObjectType objectType = info.objectType;
-        ObjectType parentType = _info[info.parentNftId].objectType;
+        // registration of chain registries only allowed on mainnet
+        if (block.chainid != 1) {
+            revert ErrorRegistryNotOnMainnet(block.chainid);
+        }
 
-        // check type combinations for core objects
-        if(info.objectAddress == address(0)) {
-            if(_coreObjectCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
-            }
+        // registry chain id is not zero
+        if(chainId == 0) {
+            revert ErrorRegistryChainRegistryChainidZero(nftId);
         }
-        // check type combinations for contract objects
-        else {
-            if(_coreContractCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
-            }
+
+        // registry address is not zero
+        if (registryAddress == address(0)) {
+            revert ErrorRegistryChainRegistryAddressZero(nftId, chainId);
         }
 
-        nftId = _register(info);
-    }
+        // 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);
+        }
 
+        // registry is not already registered
+        if (isRegistered(nftId)) {
+            revert ErrorRegistryChainRegistryAlreadyRegistered(nftId, chainId);
+        }
+
+        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, 
@@ -151,51 +199,78 @@ contract Registry is
         ObjectType domain
     )
         external
-        onlyReleaseRegistry
+        restricted()
         returns(NftId nftId)
     {
-        // check service address is defined
+        // service address is defined
         address service = info.objectAddress;
         if(service == address(0)) {
             revert ErrorRegistryServiceAddressZero();
         }
 
-        // check version is defined
+        // version is defined
         if(version.eqz()) {
-            revert ErrorRegistryServiceVersionZero();
+            revert ErrorRegistryServiceVersionZero(service);
         }
-
-        // check domain is defined
+        // service domain is defined
         if(domain.eqz()) {
-            revert ErrorRegistryDomainZero(service);
-        }
-
-        // check contract has not already been registered
-        if(_service[version][domain] != address(0)) {
-            revert ErrorRegistryDomainAlreadyRegistered(service, version, domain);
+            revert ErrorRegistryServiceDomainZero(service, version);
         }
 
-        // check service has proper type
+        // service has proper type
         if(info.objectType != SERVICE()) {
             revert ErrorRegistryNotService(service, info.objectType);
         }
 
-        // check that parent has registry type
-        if(info.parentNftId != _registryNftId) {
-            revert ErrorRegistryServiceParentNotRegistry(info.parentNftId);
-        }        
+        // 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);
+        }
 
         _service[version][domain] = service;
-        nftId = _register(info);
 
         emit LogServiceRegistration(version, domain);
+
+        nftId = _register(info);
+    }
+
+
+    /// @inheritdoc IRegistry
+    function register(ObjectInfo memory info)
+        external
+        restricted()
+        returns(NftId nftId)
+    {
+        address objectAddress = info.objectAddress;
+        ObjectType objectType = info.objectType;
+        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
-        onlyRegistryService
+        restricted()
         returns(NftId nftId)
     {
         ObjectType objectType = info.objectType;
@@ -206,19 +281,21 @@ contract Registry is
         }
 
         if(
+            objectType == ObjectTypeLib.zero() ||
+            parentType == ObjectTypeLib.zero() ||
             parentType == PROTOCOL() ||
             parentType == SERVICE()
         ) {
-            revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+            revert ErrorRegistryTypesCombinationInvalid(info.objectAddress, objectType, parentType);
         }
 
-        _register(info);
+        nftId = _register(info);
     }
 
 
     /// @dev earliest GIF major version 
     function getInitialVersion() external view returns (VersionPart) {
-        return _releaseRegistry.getInitialVersion();
+        return VersionPartLib.toVersionPart(_releaseRegistry.INITIAL_GIF_VERSION());
     }
 
     /// @dev next GIF release version to be released
@@ -235,16 +312,28 @@ contract Registry is
         return _releaseRegistry.getReleaseInfo(version);
     }
 
+    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 _chainNft.totalSupply();
+        return CHAIN_NFT.totalSupply();
     }
 
     function getNftId() external view returns (NftId nftId) {
-        return _registryNftId;
+        return REGISTRY_NFT_ID;
     }
 
     function getProtocolNftId() external view returns (NftId nftId) {
-        return _protocolNftId;
+        return PROTOCOL_NFT_ID;
     }
 
     function getNftId(address object) external view returns (NftId id) {
@@ -252,11 +341,11 @@ contract Registry is
     }
 
     function ownerOf(NftId nftId) public view returns (address) {
-        return _chainNft.ownerOf(nftId.toInt());
+        return CHAIN_NFT.ownerOf(nftId.toInt());
     }
 
     function ownerOf(address contractAddress) public view returns (address) {
-        return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
+        return CHAIN_NFT.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
     function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
@@ -312,15 +401,15 @@ contract Registry is
     }
 
     function getChainNftAddress() external view override returns (address) {
-        return address(_chainNft);
+        return address(CHAIN_NFT);
     }
 
     function getRegistryAdminAddress() external view returns (address) {
-        return address(_admin);
+        return address(ADMIN);
     }
 
     function getAuthority() external view returns (address) {
-        return _admin.authority();
+        return ADMIN.authority();
     }
 
     function getOwner() public view returns (address owner) {
@@ -344,25 +433,33 @@ contract Registry is
         internal
         returns(NftId nftId)
     {
-        ObjectType objectType = info.objectType;
+        ObjectType objectType = info.objectType; // do not care here, never PROTOCOL(), REGISTRY()
         bool isInterceptor = info.isInterceptor;
-        address objectAddress = info.objectAddress;
-        address owner = info.initialOwner;
+        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;
+        NftId parentNftId = info.parentNftId; // do not care here, can not be 0
         ObjectInfo memory parentInfo = _info[parentNftId];
-        ObjectType parentType = parentInfo.objectType; // see function header
-        address parentAddress = parentInfo.objectAddress;
+        address parentAddress = parentInfo.objectAddress; // can be 0
 
         // parent is contract -> need to check? -> check before minting
         // special case: staking: to protocol possible as well
-        // 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(objectType != STAKE()) {
+        // 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);
+            }
         }
 
         address interceptorAddress = _getInterceptor(
@@ -372,23 +469,17 @@ contract Registry is
             parentInfo.isInterceptor, 
             parentAddress);
 
-        uint256 tokenId = _chainNft.getNextTokenId();
+        uint256 tokenId = CHAIN_NFT.getNextTokenId();
         nftId = NftIdLib.toNftId(tokenId);
         info.nftId = nftId;
-        _info[nftId] = info;
-
-        if(objectAddress > address(0)) {
-            if(_nftIdByAddress[objectAddress].gtz()) { 
-                revert ErrorRegistryContractAlreadyRegistered(objectAddress);
-            }
 
-            _nftIdByAddress[objectAddress] = nftId;
-        }
+        _info[nftId] = info;
+        _setAddressForNftId(nftId, objectAddress);
 
         emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
 
         // calls nft receiver(1) and interceptor(2)
-        uint256 mintedTokenId = _chainNft.mint(
+        uint256 mintedTokenId = CHAIN_NFT.mint(
             owner,
             interceptorAddress,
             EMPTY_URI);
@@ -437,105 +528,149 @@ contract Registry is
         private
         returns (NftId protocolNftId)
     {
-        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
+        uint256 protocolId = CHAIN_NFT.PROTOCOL_NFT_ID();
         protocolNftId = NftIdLib.toNftId(protocolId);
 
-        _info[protocolNftId] = ObjectInfo({
-            nftId: protocolNftId,
-            parentNftId: NftIdLib.zero(),
-            objectType: PROTOCOL(),
-            isInterceptor: false, 
-            objectAddress: address(0),
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: ""
-        });
-
-        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
+        _registerForNft(
+            ObjectInfo({
+                nftId: protocolNftId,
+                parentNftId: NftIdLib.zero(),
+                objectType: PROTOCOL(),
+                isInterceptor: false, 
+                objectAddress: address(0),
+                initialOwner: NFT_LOCK_ADDRESS,
+                data: ""}),
+            true);
     }
 
-    /// @dev registry registration
-    /// might also register the global registry when not on mainnet
+    /// @dev register this registry
     function _registerRegistry() 
-        private
+        internal 
+        virtual
         returns (NftId registryNftId)
     {
-        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
-        registryNftId = NftIdLib.toNftId(registryId);
-        NftId parentNftId;
-
-        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
-        {// we're not the global registry
-            _registerGlobalRegistry();
-            parentNftId = NftIdLib.toNftId(_chainNft.GLOBAL_REGISTRY_ID());
-        }
-        else 
-        {// we are global registry
-            parentNftId = _protocolNftId;
+        // 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);
         }
-
-        _info[registryNftId] = ObjectInfo({
-            nftId: registryNftId,
-            parentNftId: parentNftId,
-            objectType: REGISTRY(),
-            isInterceptor: false,
-            objectAddress: address(this), 
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: "" 
-        });
-
-        _nftIdByAddress[address(this)] = registryNftId;
-        _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
-    /// @dev global registry registration for non mainnet registries
-    function _registerGlobalRegistry() 
+    /// @dev staking registration
+    function _registerRegistryForNft(
+        uint256 chainId,
+        ObjectInfo memory info,
+        bool updateAddressLookup
+    )
         private
     {
-        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
-        NftId globalRegistryNftId = NftIdLib.toNftId(globalRegistryId);
-
-        _info[globalRegistryNftId] = ObjectInfo({
-            nftId: globalRegistryNftId,
-            parentNftId: NftIdLib.toNftId(_chainNft.PROTOCOL_NFT_ID()),
-            objectType: REGISTRY(),
-            isInterceptor: false,
-            objectAddress: address(0),
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: ""
-        });
-
-        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
-    }
-    // depends on _registryNftId and _stakingAddress
+        assert(_registryNftIdByChainId[chainId].eqz());
+
+        // 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 = _chainNft.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
+        uint256 stakingId = CHAIN_NFT.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
         stakingNftId = NftIdLib.toNftId(stakingId);
 
-        _info[stakingNftId] = ObjectInfo({
-            nftId: stakingNftId,
-            parentNftId: _registryNftId,
-            objectType: STAKING(),
-            isInterceptor: false,
-            objectAddress: _stakingAddress, 
-            initialOwner: stakingOwner,
-            data: "" 
-        });
+        _registerForNft( 
+            ObjectInfo({
+                nftId: stakingNftId,
+                parentNftId: REGISTRY_NFT_ID,
+                objectType: STAKING(),
+                isInterceptor: false,
+                objectAddress: _stakingAddress, 
+                initialOwner: stakingOwner,
+                data: ""}),
+            true); 
+    }
 
-        _nftIdByAddress[_stakingAddress] = stakingNftId;
+    /// @dev Register the provided object info for the specified NFT ID.
+    function _registerForNft(
+        ObjectInfo memory info, 
+        bool updateAddressLookup
+    )
+        internal
+    {
+        _info[info.nftId] = info;
 
-        // reverts if nftId was already minted
-        _chainNft.mint(stakingOwner, stakingId);
+        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 
+        private
     {
+        _coreTypes[PROTOCOL()] = true;
         _coreTypes[REGISTRY()] = true;
         _coreTypes[SERVICE()] = true;
         _coreTypes[INSTANCE()] = true;
@@ -549,13 +684,7 @@ contract Registry is
         _coreTypes[STAKING()] = true;
         _coreTypes[STAKE()] = true;
 
-        // only global registry allowed to register registry (after initialization)
-        if(block.chainid == 1) {
-            _coreContractCombinations[REGISTRY()][REGISTRY()] = true;
-        }
-
-        // contracts with registry parent
-        _coreContractCombinations[STAKING()][REGISTRY()] = true; // only for chain staking contract
+        // types combinations allowed to use with register() function ONLY
         _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
         // components with instance parent
@@ -564,7 +693,7 @@ contract Registry is
         _coreContractCombinations[ORACLE()][INSTANCE()] = true;
         _coreContractCombinations[POOL()][INSTANCE()] = true;
 
-        // objects with coponent parents
+        // objects with component parents
         _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
         _coreObjectCombinations[POLICY()][PRODUCT()] = true;
         _coreObjectCombinations[BUNDLE()][POOL()] = true;