@etherisc/gif-next 0.0.2-f509abc-684 → 0.0.2-f575800-040

package/contracts/registry/Registry.sol

@@ -2,14 +2,20 @@
 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 {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 {InitializableCustom} from "../shared/InitializableCustom.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 {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
-import {ReleaseManager} from "./ReleaseManager.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ReleaseRegistry} from "./ReleaseRegistry.sol";
+import {TokenRegistry} from "./TokenRegistry.sol";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
 
 // IMPORTANT
 // Each NFT minted by registry is accosiated with:
@@ -21,11 +27,15 @@ import {ReleaseManager} from "./ReleaseManager.sol";
 // 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.
 contract Registry is
+    InitializableCustom,
     IRegistry
 {
-    address public constant NFT_LOCK_ADDRESS = address(0x1);
+    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;
@@ -41,70 +51,74 @@ contract Registry is
     mapping(ObjectType objectType => mapping(
             ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId private _registryNftId;
-    ChainNft private _chainNft;
+    RegistryAdmin public immutable _admin;
+    ChainNft public immutable _chainNft;
+
+    NftId public immutable _protocolNftId;
+    NftId public immutable _registryNftId;
+    NftId public _stakingNftId;
 
-    ReleaseManager private _releaseManager;
+    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(!_releaseManager.isActiveRegistryService(msg.sender)) {
-            revert CallerNotRegistryService();
+        if(!_releaseRegistry.isActiveRegistryService(msg.sender)) {
+            revert ErrorRegistryCallerNotRegistryService();
         }
         _;
     }
 
-    modifier onlyReleaseManager() {
-        if(msg.sender != address(_releaseManager)) {
-            revert CallerNotReleaseManager();
+
+    modifier onlyReleaseRegistry() {
+        if(msg.sender != address(_releaseRegistry)) {
+            revert ErrorRegistryCallerNotReleaseRegistry();
         }
         _;
     }
 
-    constructor()
+    /// @dev Creates the registry contract and populates it with the protocol and registry objects.
+    /// Internally deploys the ChainNft contract.
+    constructor(RegistryAdmin admin) 
+        InitializableCustom() 
     {
-        _releaseManager = ReleaseManager(msg.sender);
-
+        _admin = admin;
         // deploy NFT 
         _chainNft = new ChainNft(address(this));
 
         // initial registry setup
-        _registerProtocol();
-        _registerRegistry();
+        _protocolNftId = _registerProtocol();
+        _registryNftId = _registerRegistry();
 
         // set object types and object parent relations
         _setupValidCoreTypesAndCombinations();
     }
 
-    function registerService(
-        ObjectInfo memory info, 
-        VersionPart version, 
-        ObjectType domain
+
+    /// @dev Wires release registry and token to registry (this contract).
+    /// MUST be called by release registry.
+    function initialize(
+        address releaseRegistry,
+        address tokenRegistry,
+        address staking
     )
         external
-        onlyReleaseManager
-        returns(NftId nftId)
+        initializer()
     {
-        /* must be guaranteed by release manager
-        if(info.objectType != SERVICE()) {
-            revert();
-        }
-        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[version][domain] = info.objectAddress; // nftId;
+        _releaseRegistry = ReleaseRegistry(releaseRegistry);
+        _tokenRegistryAddress = tokenRegistry;
+        _stakingAddress = staking;
 
-        nftId = _register(info);
-
-        emit LogServiceRegistration(version, domain);
+        _stakingNftId = _registerStaking();
     }
 
+    /// @inheritdoc IRegistry
     function register(ObjectInfo memory info)
         external
         onlyRegistryService
@@ -113,29 +127,72 @@ contract Registry is
         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();
-        }
-
-        // only valid core types combinations
-        if(info.objectAddress == address(0)) 
-        {
+        // check type combinations for core objects
+        if(info.objectAddress == address(0)) {
             if(_coreObjectCombinations[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
             }
         }
-        else
-        {
+        // check type combinations for contract objects
+        else {
             if(_coreContractCombinations[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
+                revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
             }
         }
 
         nftId = _register(info);
     }
 
+
+    /// @inheritdoc IRegistry
+    function registerService(
+        ObjectInfo memory info, 
+        VersionPart version, 
+        ObjectType domain
+    )
+        external
+        onlyReleaseRegistry
+        returns(NftId nftId)
+    {
+        // check service address is defined
+        address service = info.objectAddress;
+        if(service == address(0)) {
+            revert ErrorRegistryServiceAddressZero();
+        }
+
+        // check version is defined
+        if(version.eqz()) {
+            revert ErrorRegistryServiceVersionZero();
+        }
+
+        // check 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);
+        }
+
+        // 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);
+    }
+
+
+    /// @inheritdoc IRegistry
     function registerWithCustomType(ObjectInfo memory info)
         external
         onlyRegistryService
@@ -145,15 +202,14 @@ contract Registry is
         ObjectType parentType = _info[info.parentNftId].objectType;
 
         if(_coreTypes[objectType]) {
-            revert CoreTypeRegistration();
+            revert ErrorRegistryCoreTypeRegistration();
         }
 
         if(
             parentType == PROTOCOL() ||
-            parentType == REGISTRY() ||
             parentType == SERVICE()
         ) {
-            revert InvalidTypesCombination(objectType, parentType);
+            revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
         }
 
         _register(info);
@@ -162,41 +218,35 @@ contract Registry is
 
     /// @dev earliest GIF major version 
     function getInitialVersion() external view returns (VersionPart) {
-        return _releaseManager.getInitialVersion();
+        return _releaseRegistry.getInitialVersion();
     }
 
-    // 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 getReleaseManagerAddress() external view returns (address) {
-        return address(_releaseManager);
-    }
-
     function getNftId() external view returns (NftId nftId) {
         return _registryNftId;
     }
 
+    function getProtocolNftId() external view returns (NftId nftId) {
+        return _protocolNftId;
+    }
+
     function getNftId(address object) external view returns (NftId id) {
         return _nftIdByAddress[object];
     }
@@ -234,9 +284,19 @@ 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 getObjectInfo(_stakingNftId).objectAddress;
+        //return _info[_stakingNftId].objectAddress;
+        return _stakingAddress;
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return _tokenRegistryAddress;
     }
 
     function getServiceAddress(
@@ -244,16 +304,25 @@ 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);
     }
 
+    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));
     }
@@ -271,65 +340,81 @@ 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;
+        bool isInterceptor = info.isInterceptor;
+        address objectAddress = info.objectAddress;
+        address owner = info.initialOwner;
+
         NftId parentNftId = info.parentNftId;
         ObjectInfo memory parentInfo = _info[parentNftId];
         ObjectType parentType = parentInfo.objectType; // see function header
         address parentAddress = parentInfo.objectAddress;
 
         // 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(parentAddress == address(0)) {
-            revert ZeroParentAddress();
+        if(objectType != STAKE()) {
+            if(parentAddress == address(0)) {
+                revert ErrorRegistryParentAddressZero();
+            }
         }
 
-        address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
-        uint256 tokenId = _chainNft.getNextTokenId();
-        nftId = toNftId(tokenId);
+        address interceptorAddress = _getInterceptor(
+            isInterceptor, 
+            objectType, 
+            objectAddress, 
+            parentInfo.isInterceptor, 
+            parentAddress);
 
+        uint256 tokenId = _chainNft.getNextTokenId();
+        nftId = NftIdLib.toNftId(tokenId);
         info.nftId = nftId;
         _info[nftId] = info;
 
-        if(info.objectAddress > address(0)) 
-        {
-            address contractAddress = info.objectAddress;
-
-            if(_nftIdByAddress[contractAddress].gtz()) { 
-                revert ContractAlreadyRegistered(contractAddress);
+        if(objectAddress > address(0)) {
+            if(_nftIdByAddress[objectAddress].gtz()) { 
+                revert ErrorRegistryContractAlreadyRegistered(objectAddress);
             }
 
-            _nftIdByAddress[contractAddress] = nftId;
+            _nftIdByAddress[objectAddress] = nftId;
         }
 
-        emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
+        emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
 
         // calls nft receiver(1) and interceptor(2)
         uint256 mintedTokenId = _chainNft.mint(
-            info.initialOwner,
-            interceptor,
+            owner,
+            interceptorAddress,
             EMPTY_URI);
-        assert(mintedTokenId == tokenId);
-        
+
+        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;
@@ -350,13 +435,14 @@ 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);
+        protocolNftId = NftIdLib.toNftId(protocolId);
 
         _info[protocolNftId] = ObjectInfo({
             nftId: protocolNftId,
-            parentNftId: zeroNftId(),
+            parentNftId: NftIdLib.zero(),
             objectType: PROTOCOL(),
             isInterceptor: false, 
             objectAddress: address(0),
@@ -371,19 +457,20 @@ contract Registry is
     /// might also register the global registry when not on mainnet
     function _registerRegistry() 
         private
+        returns (NftId registryNftId)
     {
         uint256 registryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID);
-        NftId registryNftId = toNftId(registryId);
+        registryNftId = NftIdLib.toNftId(registryId);
         NftId parentNftId;
 
         if(registryId != _chainNft.GLOBAL_REGISTRY_ID()) 
         {// we're not the global registry
             _registerGlobalRegistry();
-            parentNftId = toNftId(_chainNft.GLOBAL_REGISTRY_ID());
+            parentNftId = NftIdLib.toNftId(_chainNft.GLOBAL_REGISTRY_ID());
         }
         else 
         {// we are global registry
-            parentNftId = toNftId(_chainNft.PROTOCOL_NFT_ID());
+            parentNftId = _protocolNftId;
         }
 
         _info[registryNftId] = ObjectInfo({
@@ -395,9 +482,8 @@ contract Registry is
             initialOwner: NFT_LOCK_ADDRESS,
             data: "" 
         });
-        _nftIdByAddress[address(this)] = registryNftId;
-        _registryNftId = registryNftId;
 
+        _nftIdByAddress[address(this)] = registryNftId;
         _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
@@ -406,11 +492,11 @@ contract Registry is
         private
     {
         uint256 globalRegistryId = _chainNft.GLOBAL_REGISTRY_ID();
-        NftId globalRegistryNftId = toNftId(globalRegistryId);
+        NftId globalRegistryNftId = NftIdLib.toNftId(globalRegistryId);
 
         _info[globalRegistryNftId] = ObjectInfo({
             nftId: globalRegistryNftId,
-            parentNftId: toNftId(_chainNft.PROTOCOL_NFT_ID()),
+            parentNftId: NftIdLib.toNftId(_chainNft.PROTOCOL_NFT_ID()),
             objectType: REGISTRY(),
             isInterceptor: false,
             objectAddress: address(0),
@@ -420,48 +506,71 @@ contract Registry is
 
         _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
     }
+    // depends on _registryNftId and _stakingAddress
+    function _registerStaking()
+        private
+        returns (NftId stakingNftId)
+    {
+        address stakingOwner = IRegisterable(_stakingAddress).getOwner();
+        uint256 stakingId = _chainNft.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: "" 
+        });
+
+        _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 "zeroObjectType"
+    /// EACH object type MUST have only one parent type across ALL mappings
     function _setupValidCoreTypesAndCombinations() 
         private 
     {
         _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
+        // 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
         _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;
 
+        // objects with coponent parents
         _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
-
-        // product as parent, ONLY approved
         _coreObjectCombinations[POLICY()][PRODUCT()] = true;
-
-        // pool as parent, ONLY approved
         _coreObjectCombinations[BUNDLE()][POOL()] = true;
-        _coreObjectCombinations[STAKE()][POOL()] = true;
+
+        // staking
+        _coreObjectCombinations[STAKE()][PROTOCOL()] = true;
+        _coreObjectCombinations[STAKE()][INSTANCE()] = true;
     }
 }