@etherisc/gif-next 0.0.2-a733491-751 → 0.0.2-a755cba-454

package/contracts/registry/Registry.sol

@@ -2,35 +2,76 @@
 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, toNftId, zeroNftId} from "../types/NftId.sol";
-import {VersionPart} from "../types/Version.sol";
-import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.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 {ReleaseManager} from "./ReleaseManager.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";
 
-// 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)
-
+// 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;
+
+    /// @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(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;
@@ -41,179 +82,292 @@ contract Registry is
     mapping(ObjectType objectType => mapping(
             ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId private _registryNftId;
-    ChainNft private _chainNft;
+    NftId private _stakingNftId;
 
-    ReleaseManager private _releaseManager;
+    ReleaseRegistry private _releaseRegistry;
+    address private _tokenRegistryAddress;
+    address private _stakingAddress;
 
-    modifier onlyRegistryService() {
-        if(!_releaseManager.isActiveRegistryService(msg.sender)) {
-            revert CallerNotRegistryService();
+    modifier onlyDeployer() {
+        if (msg.sender != DEPLOYER) {
+            revert ErrorRegistryCallerNotDeployer();
         }
         _;
     }
 
-    modifier onlyReleaseManager() {
-        if(msg.sender != address(_releaseManager)) {
-            revert CallerNotReleaseManager();
-        }
-        _;
-    }
-
-    constructor()
+    // 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())
     {
-        _releaseManager = ReleaseManager(msg.sender);
+        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
-        _registerProtocol();
-        _registerRegistry();
+        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;
+
+        // register staking contract
+        _stakingNftId = _registerStaking();
+    }
+
+    /// @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);
+        }
+
+        // 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 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
     )
         external
-        onlyReleaseManager
+        restricted()
         returns(NftId nftId)
     {
-        /* must be guaranteed by release manager
+        // 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();
+            revert ErrorRegistryNotService(service, info.objectType);
         }
-        if(info.parentType != REGISTRY()) {
-            revert();
-        }        
-        info.initialOwner == NFT_LOCK_ADDRESS <- if services are access managed
-        */
-
-        if(_service[version][domain] > address(0)) {
-            revert ServiceAlreadyRegistered(info.objectAddress);
+
+        // service parent has registry type
+        if(info.parentNftId != REGISTRY_NFT_ID) {
+            revert ErrorRegistryServiceParentNotRegistry(service, version, info.parentNftId);
         }
 
-        _service[version][domain] = info.objectAddress; // nftId;
+        // service has not already been registered
+        if(_service[version][domain] != address(0)) {
+            revert ErrorRegistryServiceDomainAlreadyRegistered(service, version, domain);
+        }
 
-        nftId = _register(info);
+        _service[version][domain] = service;
 
         emit LogServiceRegistration(version, domain);
+
+        nftId = _register(info);
     }
 
+
+    /// @inheritdoc IRegistry
     function register(ObjectInfo memory info)
         external
-        onlyRegistryService
+        restricted()
         returns(NftId nftId)
     {
+        address objectAddress = info.objectAddress;
         ObjectType objectType = info.objectType;
-        ObjectType parentType = _info[info.parentNftId].objectType;
 
-        // TODO do not need it here -> SERVICE is no longer part of _coreContractCombinations
-        // no service registrations
-        if(objectType == SERVICE()) {
-            revert ServiceRegistration();
-        }
+        // 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;
 
-        // only valid core types combinations
-        if(info.objectAddress == address(0)) 
-        {
+        // check type combinations for core objects
+        if(objectAddress == address(0)) {
             if(_coreObjectCombinations[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
+                revert ErrorRegistryTypesCombinationInvalid(objectAddress, objectType, parentType);
             }
         }
-        else
-        {
+        // check type combinations for contract objects
+        else {
             if(_coreContractCombinations[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
+                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;
         ObjectType parentType = _info[info.parentNftId].objectType;
 
         if(_coreTypes[objectType]) {
-            revert CoreTypeRegistration();
+            revert ErrorRegistryCoreTypeRegistration();
         }
 
         if(
-
+            objectType == ObjectTypeLib.zero() ||
+            parentType == ObjectTypeLib.zero() ||
             parentType == PROTOCOL() ||
-            parentType == REGISTRY() ||
             parentType == SERVICE()
         ) {
-            revert InvalidTypesCombination(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 _releaseManager.getInitialVersion();
+        return VersionPartLib.toVersionPart(_releaseRegistry.INITIAL_GIF_VERSION());
     }
 
-    // TODO make distinction between active an not yet active version
-    // need to be thought trough, not yet clear if necessary
-    // need to answer question: what is the latest version during the upgrade process?
-    // likely setting up a new gif version does not fit into a single tx
-    // in this case we might want to have a period where the latest version is
-    // in the process of being set up while the latest active version is 1 major release smaller
-    /// @dev latest GIF major version (might not yet be active)
+    /// @dev next GIF release version to be released
     function getNextVersion() external view returns (VersionPart) {
-        return _releaseManager.getNextVersion();
+        return _releaseRegistry.getNextVersion();
     }
 
     /// @dev latest active GIF release version 
     function getLatestVersion() external view returns (VersionPart) { 
-        return _releaseManager.getLatestVersion();
+        return _releaseRegistry.getLatestVersion();
     }
 
     function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
-        return _releaseManager.getReleaseInfo(version);
+        return _releaseRegistry.getReleaseInfo(version);
     }
 
-    function getObjectCount() external view returns (uint256) {
-        return _chainNft.totalSupply();
+    function chainIds() public view returns (uint256) {
+        return _chainId.length;
     }
 
-    function getReleaseManagerAddress() external view returns (address) {
-        return address(_releaseManager);
+    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 _registryNftId;
+        return REGISTRY_NFT_ID;
     }
 
-    function getNftId(address object) external view returns (NftId 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 ownerOf(NftId nftId) public view returns (address) {
-        return _chainNft.ownerOf(nftId.toInt());
+        return CHAIN_NFT.ownerOf(nftId.toInt());
+    }
+
+    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 _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
+        return CHAIN_NFT.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
     function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
+    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]];
     }
@@ -235,9 +389,17 @@ contract Registry is
         return _info[objectParentNftId].objectType == INSTANCE();
     }
 
-    function isValidRelease(VersionPart version) external view returns (bool)
+    function isActiveRelease(VersionPart version) external view returns (bool)
     {
-        return _releaseManager.isValidRelease(version);
+        return _releaseRegistry.isActiveRelease(version);
+    }
+
+    function getStakingAddress() external view returns (address staking) {
+        return _stakingAddress;
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return _tokenRegistryAddress;
     }
 
     function getServiceAddress(
@@ -245,14 +407,23 @@ contract Registry is
         VersionPart releaseVersion
     ) external view returns (address service)
     {
-        // TODO how can I get service address while release is not validated/activated ?!! -> user will check validity of release on its own
-        //if(_releaseManager.isValidRelease(releaseVersion)) { 
-            service =  _service[releaseVersion][serviceDomain]; 
-        //}
+        service =  _service[releaseVersion][serviceDomain]; 
+    }
+
+    function getReleaseRegistryAddress() external view returns (address) {
+        return address(_releaseRegistry);
     }
 
     function getChainNftAddress() external view override returns (address) {
-        return address(_chainNft);
+        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) {
@@ -272,66 +443,83 @@ contract Registry is
     // Internals
 
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
-    // TODO registration of precompile addresses
     function _register(ObjectInfo memory info)
         internal
         returns(NftId nftId)
     {
-        ObjectType objectType = info.objectType;
-        NftId parentNftId = info.parentNftId;
+        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];
-        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: global registry nft as parent when not on mainnet -> global registry address is 0
-        // special case: when parentNftId == _chainNft.mint(), check for zero parent address before mint
-        // special case: when parentNftId == _chainNft.mint() && objectAddress == initialOwner
-        if(parentAddress == address(0)) {
-            revert ZeroParentAddress();
+        // 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);
+            }
         }
 
-        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
-
-        // TODO does external call
-        // compute next nftId, do all checks and stores, mint() at most end...
-        uint256 mintedTokenId = _chainNft.mint(
-            info.initialOwner,
-            interceptor,
-            EMPTY_URI);
-        nftId = toNftId(mintedTokenId);
+        address interceptorAddress = _getInterceptor(
+            isInterceptor, 
+            objectType, 
+            objectAddress, 
+            parentInfo.isInterceptor, 
+            parentAddress);
 
-        // TODO move nftId out of info struct
-        // getters by nftId -> return struct without nftId
-        // getters by address -> return nftId AND struct
+        uint256 tokenId = CHAIN_NFT.getNextTokenId();
+        nftId = NftIdLib.toNftId(tokenId);
         info.nftId = nftId;
-        _info[nftId] = info;
 
-        if(info.objectAddress > address(0)) 
-        {
-            address contractAddress = info.objectAddress;
+        _info[nftId] = info;
+        _setAddressForNftId(nftId, objectAddress);
 
-            if(_nftIdByAddress[contractAddress].gtz()) { 
-                revert ContractAlreadyRegistered(contractAddress);
-            }
+        emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
 
-            _nftIdByAddress[contractAddress] = nftId;
-        }
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = CHAIN_NFT.mint(
+            owner,
+            interceptorAddress,
+            EMPTY_URI);
 
-        emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
+        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 
-        view 
+        pure 
         returns (address interceptor) 
     {
+        // no intercepting calls for stakes
+        if (objectType == STAKE()) {
+            return address(0);
+        }
+
         if (objectAddress == address(0)) {
             if (parentIsInterceptor) {
                 return parentObjectAddress;
@@ -352,118 +540,186 @@ contract Registry is
     /// @dev protocol registration used to anchor the dip ecosystem relations
     function _registerProtocol() 
         private
+        returns (NftId protocolNftId)
     {
-        uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
-        NftId protocolNftId = toNftId(protocolId);
-
-        _info[protocolNftId] = ObjectInfo({
-            nftId: protocolNftId,
-            parentNftId: zeroNftId(),
-            objectType: PROTOCOL(),
-            isInterceptor: false, 
-            objectAddress: address(0),
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: ""
-        });
-
-        _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
+        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 registry registration
-    /// might also register the global registry when not on mainnet
-    function _registerRegistry() 
+    /// @dev staking registration
+    function _registerRegistryForNft(
+        uint256 chainId,
+        ObjectInfo memory info,
+        bool updateAddressLookup
+    )
         private
     {
-        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
-        NftId registryNftId = toNftId(registryId);
-        NftId parentNftId;
-
-        if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
-        {// we're not the global registry
-            _registerGlobalRegistry();
-            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
-        }
-        else 
-        {// we are global registry
-            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
+        if (!_registryNftIdByChainId[chainId].eqz()) {
+            revert ErrorRegistryChainRegistryAlreadyRegistered(info.nftId, chainId);
         }
 
-        _info[registryNftId] = ObjectInfo({
-            nftId: registryNftId,
-            parentNftId: parentNftId,
-            objectType: REGISTRY(),
-            isInterceptor: false,
-            objectAddress: address(this), 
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: "" 
-        });
-        _nftIdByAddress[address(this)] = registryNftId;
-        _registryNftId = registryNftId;
+        // update registry lookup variables
+        _registryNftIdByChainId[chainId] = info.nftId;
+        _chainId.push(chainId);
 
-        _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
+        // register the registry info
+        _registerForNft(
+            info,
+            updateAddressLookup); 
     }
 
-    /// @dev global registry registration for non mainnet registries
-    function _registerGlobalRegistry() 
+    /// @dev staking registration
+    function _registerStaking()
         private
+        returns (NftId stakingNftId)
     {
-        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
-        NftId globalRegistryNftId = toNftId(globalRegistryId);
+        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();
+    }
+
+    /// @dev Register the provided object info for the specified NFT ID.
+    function _registerForNft(
+        ObjectInfo memory info, 
+        bool updateAddressLookup
+    )
+        internal
+    {
+        _info[info.nftId] = info;
 
-        _info[globalRegistryNftId] = ObjectInfo({
-            nftId: globalRegistryNftId,
-            parentNftId: toNftId(_chainNft.PROTOCOL_NFT_ID()),
-            objectType: REGISTRY(),
-            isInterceptor: false,
-            objectAddress: address(0),
-            initialOwner: NFT_LOCK_ADDRESS,
-            data: ""
-        });
+        if (updateAddressLookup) {
+            _setAddressForNftId(info.nftId, info.objectAddress);
+        }
 
-        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
+        // 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
-    // IMPORTANT: 
-    // 1) EACH object type MUST have only one parent type across ALL mappings
-    // 2) DO NOT use object type (e.g. POLCY, BUNDLE, STAKE) as parent type
-    // 3) DO NOT use REGISTRY as object type
-    // 2) DO NOT use PROTOCOL and "zeroObjectType"
+    /// 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[TOKEN()] = 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;
-        
-        // registry as parent, ONLY registry owner
-        //_coreContractCombinations[REGISTRY()][REGISTRY()] = true; // only for global regstry
-        _coreContractCombinations[TOKEN()][REGISTRY()] = true;
-        //_coreContractCombinations[SERVICE()][REGISTRY()] = true;// do not need it here -> registerService() registers exactly this combination
 
-        // registry as parent, ONLY approved
+        // types combinations allowed to use with register() function ONLY
         _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
-        // instance as parent, ONLY approved
+        // components with instance parent
         _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
-        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
-        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
-        _coreContractCombinations[POOL()][INSTANCE()] = true;
 
-        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
+        // components with product parent
+        _coreContractCombinations[DISTRIBUTION()][PRODUCT()] = true;
+        _coreContractCombinations[ORACLE()][PRODUCT()] = true;
+        _coreContractCombinations[POOL()][PRODUCT()] = true;
 
-        // product as parent, ONLY approved
+        // objects with component parents
         _coreObjectCombinations[POLICY()][PRODUCT()] = true;
-
-        // pool as parent, ONLY approved
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
         _coreObjectCombinations[BUNDLE()][POOL()] = true;
-        _coreObjectCombinations[STAKE()][POOL()] = true;
+
+        // staking
+        _coreObjectCombinations[STAKE()][PROTOCOL()] = true;
+        _coreObjectCombinations[STAKE()][INSTANCE()] = true;
     }
 }