@etherisc/gif-next 0.0.2-fd2113c-488 → 0.0.2-fd41099-706

package/contracts/registry/Registry.sol

@@ -3,41 +3,49 @@ 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, TOKEN, SERVICE, INSTANCE, STAKE, STAKING, PRODUCT, DISTRIBUTION, DISTRIBUTOR, ORACLE, POOL, POLICY, BUNDLE} from "../type/ObjectType.sol";
+import {ObjectType, 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 {IRegisterable} from "../shared/IRegisterable.sol";
-import {ReleaseManager} from "./ReleaseManager.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)
+// Three 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)
 
+/// @title Chain Registry contract implementing IRegistry.
+/// @notice See IRegistry for method details.
 contract Registry is
-    InitializableCustom,
+    Initializable,
+    AccessManaged,
     IRegistry
 {
+    using NftIdLib for NftId;
+
     address public 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 = "";
 
-    mapping(NftId nftId => ObjectInfo info) private _info;
-    mapping(address object => NftId nftId) private _nftIdByAddress;
+    /// @dev stores the deployer address and allows to create initializers
+    /// that are restricted to the deployer address.
+    address public immutable _deployer;
+
+    mapping(NftId nftId => ObjectInfo info) internal _info;
+    mapping(address object => NftId nftId) internal _nftIdByAddress;
 
     mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
 
@@ -58,134 +66,138 @@ contract Registry is
 
     address public _tokenRegistryAddress;
     address public _stakingAddress;
-    ReleaseManager public _releaseManager;
-
-    // TODO 
-    // 1). Registry and ReleaseManager must be treated as whole single entity. 
-    //     But current limitations of EVM does not allow it -> require it to be splitted
-    // 2). Keep onlyReleaseManager modifier
-    // 3). Delete onlyRegistryService in favor of restricted, introduce aditional "domain role", REGISTRY_SERVICE_ROLE
-    // 4). (For GlobalRegistry ONLY) make registerChainRegistry() restricted to GIF_ADMIN_ROLE
-    modifier onlyRegistryService() {
-        if(!_releaseManager.isActiveRegistryService(msg.sender)) {
-            revert ErrorRegistryCallerNotRegistryService();
+    ReleaseRegistry public _releaseRegistry;
+
+    modifier onlyDeployer() {
+        if (msg.sender != _deployer) {
+            revert ErrorRegistryCallerNotDeployer();
         }
         _;
     }
 
-
-    modifier onlyReleaseManager() {
-        if(msg.sender != address(_releaseManager)) {
-            revert ErrorRegistryCallerNotReleaseManager();
+    modifier onlyReleaseRegistry() {
+        if(msg.sender != address(_releaseRegistry)) {
+            revert ErrorRegistryCallerNotReleaseRegistry();
         }
         _;
     }
 
-
-    constructor(RegistryAdmin admin) 
-        InitializableCustom() 
+    /// @dev Creates the registry contract and populates it with the protocol and registry objects.
+    /// Internally deploys the ChainNft contract.
+    // TODO consider storing global registry address as constant
+    constructor(RegistryAdmin admin, address globalRegistry)
+        AccessManaged(admin.authority())
     {
+        _deployer = msg.sender;
         _admin = admin;
         // deploy NFT 
         _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _protocolNftId = _registerProtocol();
-        _registryNftId = _registerRegistry();
+        _registryNftId = _registerRegistry(globalRegistry);
 
         // set object types and object parent relations
         _setupValidCoreTypesAndCombinations();
     }
 
 
-    /// @dev wires release manager and token to registry (this contract).
-    /// MUST be called by release manager.
+    /// @dev Wires release registry and token to registry (this contract).
+    /// MUST be called by release registry.
     function initialize(
-        address releaseManager,
+        address releaseRegistry,
         address tokenRegistry,
         address staking
     )
         external
         initializer()
+        onlyDeployer()
     {
-        _releaseManager = ReleaseManager(releaseManager);
+        _releaseRegistry = ReleaseRegistry(releaseRegistry);
         _tokenRegistryAddress = tokenRegistry;
         _stakingAddress = staking;
 
         _stakingNftId = _registerStaking();
     }
 
+    /// @inheritdoc IRegistry
+    function register(ObjectInfo memory info)
+        external
+        restricted
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        // check type combinations for core objects
+        if(info.objectAddress == address(0)) {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+            }
+        }
+        // check type combinations for contract objects
+        else {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+            }
+        }
+
+        nftId = _register(info);
+    }
+
+
+    /// @inheritdoc IRegistry
     function registerService(
         ObjectInfo memory info, 
         VersionPart version, 
         ObjectType domain
     )
         external
-        onlyReleaseManager
+        onlyReleaseRegistry
         returns(NftId nftId)
     {
+        // check service address is defined
         address service = info.objectAddress;
-        /* must be guaranteed by release manager
         if(service == address(0)) {
-            revert();
+            revert ErrorRegistryServiceAddressZero();
         }
 
+        // check version is defined
         if(version.eqz()) {
-            revert();
-        }
-
-        if(info.objectType != SERVICE()) {
-            revert();
+            revert ErrorRegistryServiceVersionZero();
         }
-        if(info.parentType != REGISTRY()) {
-            revert();
-        }        
-        info.initialOwner == NFT_LOCK_ADDRESS <- if services are access managed
-        */
 
+        // check domain is defined
         if(domain.eqz()) {
             revert ErrorRegistryDomainZero(service);
         }
 
-        if(_service[version][domain] > address(0)) {
+        // check contract has not already been registered
+        if(_service[version][domain] != address(0)) {
             revert ErrorRegistryDomainAlreadyRegistered(service, version, domain);
         }
-        
-        _service[version][domain] = service;
 
+        // check 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[version][domain] = service;
         nftId = _register(info);
 
         emit LogServiceRegistration(version, domain);
     }
 
-    function register(ObjectInfo memory info)
-        external
-        onlyRegistryService
-        returns(NftId nftId)
-    {
-        ObjectType objectType = info.objectType;
-        ObjectType parentType = _info[info.parentNftId].objectType;
-
-        // only valid core types combinations
-        if(info.objectAddress == address(0)) 
-        {
-            if(_coreObjectCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
-            }
-        }
-        else
-        {
-            if(_coreContractCombinations[objectType][parentType] == false) {
-                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
-            }
-        }
-
-        nftId = _register(info);
-    }
 
+    /// @inheritdoc IRegistry
     function registerWithCustomType(ObjectInfo memory info)
         external
-        onlyRegistryService
+        restricted
         returns(NftId nftId)
     {
         ObjectType objectType = info.objectType;
@@ -197,33 +209,32 @@ contract Registry is
 
         if(
             parentType == PROTOCOL() ||
-            parentType == REGISTRY() ||
             parentType == SERVICE()
         ) {
             revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
         }
 
-        _register(info);
+        nftId = _register(info);
     }
 
 
     /// @dev earliest GIF major version 
     function getInitialVersion() external view returns (VersionPart) {
-        return _releaseManager.getInitialVersion();
+        return _releaseRegistry.getInitialVersion();
     }
 
     /// @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) {
@@ -277,7 +288,7 @@ contract Registry is
 
     function isActiveRelease(VersionPart version) external view returns (bool)
     {
-        return _releaseManager.isActiveRelease(version);
+        return _releaseRegistry.isActiveRelease(version);
     }
 
     function getStakingAddress() external view returns (address staking) {
@@ -298,12 +309,8 @@ contract Registry is
         service =  _service[releaseVersion][serviceDomain]; 
     }
 
-    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address) {
-        return address(_releaseManager.getReleaseAccessManager(version));
-    }
-
-    function getReleaseManagerAddress() external view returns (address) {
-        return address(_releaseManager);
+    function getReleaseRegistryAddress() external view returns (address) {
+        return address(_releaseRegistry);
     }
 
     function getChainNftAddress() external view override returns (address) {
@@ -335,7 +342,6 @@ 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)
@@ -449,29 +455,42 @@ contract Registry is
         _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
     }
 
-    /// @dev registry registration
-    /// might also register the global registry when not on mainnet
-    function _registerRegistry() 
+    /// @dev global registry registration
+    function _registerGlobalRegistry(address globalRegistry)
         private
+        returns (NftId globalRegistryNftId)
+    {
+        uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
+        globalRegistryNftId = NftIdLib.toNftId(globalRegistryId);
+
+        _info[globalRegistryNftId] = ObjectInfo({
+            nftId: globalRegistryNftId,
+            parentNftId: _protocolNftId,
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: globalRegistry,
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""
+        });
+
+        _nftIdByAddress[address(this)] = globalRegistryNftId;
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
+    }
+
+    /// @dev registry registration
+    function _registerRegistry(address globalRegistry) 
+        internal 
+        virtual
         returns (NftId registryNftId)
     {
+        NftId globalRegistryNftId = _registerGlobalRegistry(globalRegistry);
+
         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;
-        }
 
         _info[registryNftId] = ObjectInfo({
             nftId: registryNftId,
-            parentNftId: parentNftId,
+            parentNftId: globalRegistryNftId,
             objectType: REGISTRY(),
             isInterceptor: false,
             objectAddress: address(this), 
@@ -483,28 +502,10 @@ contract Registry is
         _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
-    /// @dev global registry registration for non mainnet registries
-    function _registerGlobalRegistry() 
-        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
+    /// @dev staking registration
     function _registerStaking()
         private
+        onlyInitializing()
         returns (NftId stakingNftId)
     {
         address stakingOwner = IRegisterable(_stakingAddress).getOwner();
@@ -522,22 +523,16 @@ contract Registry is
         });
 
         _nftIdByAddress[_stakingAddress] = stakingNftId;
-        // reverts if nftId was already minted
         _chainNft.mint(stakingOwner, stakingId);
     }
 
     /// @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 "ObjectTypeLib.zero"
+    /// EACH object type MUST have only one parent type across ALL mappings
     function _setupValidCoreTypesAndCombinations() 
-        private 
+        private
     {
         _coreTypes[REGISTRY()] = true;
         _coreTypes[SERVICE()] = true;
-        _coreTypes[TOKEN()] = true;
         _coreTypes[INSTANCE()] = true;
         _coreTypes[PRODUCT()] = true;
         _coreTypes[POOL()] = true;
@@ -549,28 +544,16 @@ contract Registry is
         _coreTypes[STAKING()] = true;
         _coreTypes[STAKE()] = true;
 
-        uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
-        if(registryId == _chainNft.GLOBAL_REGISTRY_ID()) {
-            // we are global registry
-            // object is registry from different chain
-            // parent is global registry, this contract
-            _coreContractCombinations[REGISTRY()][REGISTRY()] = true; // only for global regstry
-            //_coreObjectCombinations[REGISTRY()][REGISTRY()] = true;
-        } else {
-            // we are not global registry
-            // object is local registry, this contract
-            // parent is global registry, object with 0 address or registry from mainnet???
-        }
         _coreContractCombinations[STAKING()][REGISTRY()] = true; // only for chain staking contract
-        _coreContractCombinations[TOKEN()][REGISTRY()] = true;
-        //_coreContractCombinations[SERVICE()][REGISTRY()] = true;// do not need it here -> registerService() registers exactly this combination
         _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
+        // components with instance parent
         _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
         _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
         _coreContractCombinations[ORACLE()][INSTANCE()] = true;
         _coreContractCombinations[POOL()][INSTANCE()] = true;
 
+        // objects with coponent parents
         _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
         _coreObjectCombinations[POLICY()][PRODUCT()] = true;
         _coreObjectCombinations[BUNDLE()][POOL()] = true;