@etherisc/gif-next 0.0.2-d5522f6-712 → 0.0.2-d59d51e-694

package/contracts/registry/Registry.sol

@@ -1,16 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.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, ORACLE, POOL, POLICY, BUNDLE} from "../types/ObjectType.sol";
-
-import {ERC165} from "../shared/ERC165.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 {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ReleaseManager} from "./ReleaseManager.sol";
+import {TokenRegistry} from "./TokenRegistry.sol";
 
 // IMPORTANT
 // Each NFT minted by registry is accosiated with:
@@ -23,60 +25,120 @@ import {ReleaseManager} from "./ReleaseManager.sol";
 // 4) state object by regular service (POLICY, BUNDLE, STAKE)
 
 contract Registry is
-    ERC165,
+    Initializable,
     IRegistry
 {
     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 = "";
 
-    mapping(NftId nftId => ObjectInfo info) internal _info;
-    mapping(address object => NftId nftId) internal _nftIdByAddress;
+    mapping(NftId nftId => ObjectInfo info) private _info;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
+
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
 
-    mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) _service;
+    mapping(ObjectType objectType => bool) private _coreTypes;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidContractCombination;
+            ObjectType parentType => bool)) private _coreContractCombinations;
 
     mapping(ObjectType objectType => mapping(
-            ObjectType parentType => bool)) internal _isValidObjectCombination;
+            ObjectType parentType => bool)) private _coreObjectCombinations;
+
+    ChainNft private _chainNft;
+
+    address private _initializeOwner;
+    address private _tokenRegistryAddress;
+    address private _stakingAddress;
+    ReleaseManager private _releaseManager;
 
-    NftId internal _registryNftId;
-    ChainNft internal _chainNft;
+    NftId private _protocolNftId;
+    NftId private _registryNftId;
 
-    ReleaseManager internal _releaseManager;
 
     modifier onlyRegistryService() {
         if(!_releaseManager.isActiveRegistryService(msg.sender)) {
-            revert CallerNotRegistryService();
+            revert ErrorRegistryCallerNotRegistryService();
         }
         _;
     }
 
+
     modifier onlyReleaseManager() {
         if(msg.sender != address(_releaseManager)) {
-            revert CallerNotReleaseManager();
+            revert ErrorRegistryCallerNotReleaseManager();
         }
         _;
     }
 
-    constructor()
-    {
-        _releaseManager = ReleaseManager(msg.sender);
+
+    constructor() {
+        // register deployer
+        _initializeOwner = msg.sender;
 
         // deploy NFT 
-        _chainNft = new ChainNft(address(this));// adds 10kb to deployment size
+        _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _registerProtocol();
         _registerRegistry();
 
-        // set object parent relations
-        _setupValidObjectParentCombinations();
+        // set object types and object parent relations
+        _setupValidCoreTypesAndCombinations();
+    }
+
+
+    /// @dev wires release manager (as caller) and token to registry (this contract).
+    /// MUST be called by release manager.
+    function initialize(
+        address releaseManager,
+        address tokenRegistry
+    )
+        external
+        initializer()
+    {
+        if (msg.sender != _initializeOwner) {
+            revert ErrorRegistryCallerNotInitializeOwner(_initializeOwner, msg.sender);
+        }
+
+        _releaseManager = ReleaseManager(releaseManager);
+        _tokenRegistryAddress = tokenRegistry;
+    }
+
+
+    function registerStaking(
+        address stakingAddress
+    )
+        external
+        onlyReleaseManager()
+    {
+        // staking contract for same chain may only be registered once
+        if (_stakingAddress != address(0)) {
+            revert StakingAlreadyRegistered(_stakingAddress);
+        }
+
+        _stakingAddress = stakingAddress;
+
+        address stakingOwner = IRegisterable(stakingAddress).getOwner();
+        uint256 stakingId = _chainNft.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
+        NftId stakingNftId = NftIdLib.toNftId(stakingId);
+
+        _nftIdByAddress[_stakingAddress] = stakingNftId;
+        _info[stakingNftId] = ObjectInfo({
+            nftId: stakingNftId,
+            parentNftId: _registryNftId,
+            objectType: STAKING(),
+            isInterceptor: false,
+            objectAddress: _stakingAddress, 
+            initialOwner: stakingOwner,
+            data: "" 
+        });
 
-        _registerInterface(type(IRegistry).interfaceId);
+        _chainNft.mint(stakingOwner, stakingId);
     }
 
+
     function registerService(
         ObjectInfo memory info, 
         VersionPart version, 
@@ -86,18 +148,34 @@ contract Registry is
         onlyReleaseManager
         returns(NftId nftId)
     {
+        address service = info.objectAddress;
         /* must be guaranteed by release manager
+        if(service == address(0)) {
+            revert();
+        }
+
+        if(version.eqz()) {
+            revert();
+        }
+
         if(info.objectType != SERVICE()) {
             revert();
         }
-        info.initialOwner = NFT_LOCK_ADDRESS <- if services are access managed
+        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);
+        if(domain.eqz()) {
+            revert ErrorRegistryDomainZero(service);
         }
 
-        _service[version][domain] = info.objectAddress; // nftId;
+        if(_service[version][domain] > address(0)) {
+            revert ErrorRegistryDomainAlreadyRegistered(service, version, domain);
+        }
+        
+        _service[version][domain] = service;
 
         nftId = _register(info);
 
@@ -109,16 +187,52 @@ contract Registry is
         onlyRegistryService
         returns(NftId nftId)
     {
-        // no service registrations
-        if(info.objectType == SERVICE()) {
-            revert ServiceRegistration();
+        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);
     }
 
+    function registerWithCustomType(ObjectInfo memory info)
+        external
+        onlyRegistryService
+        returns(NftId nftId)
+    {
+        ObjectType objectType = info.objectType;
+        ObjectType parentType = _info[info.parentNftId].objectType;
+
+        if(_coreTypes[objectType]) {
+            revert ErrorRegistryCoreTypeRegistration();
+        }
+
+        if(
+            parentType == PROTOCOL() ||
+            parentType == REGISTRY() ||
+            parentType == SERVICE()
+        ) {
+            revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
+        }
+
+        _register(info);
+    }
+
+
     /// @dev earliest GIF major version 
-    function getMajorVersionMin() external view returns (VersionPart) {
+    function getInitialVersion() external view returns (VersionPart) {
         return _releaseManager.getInitialVersion();
     }
 
@@ -129,21 +243,20 @@ contract Registry is
     // 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)
-    function getMajorVersionMax() external view returns (VersionPart) {
+    function getNextVersion() external view returns (VersionPart) {
         return _releaseManager.getNextVersion();
     }
 
     /// @dev latest active GIF release version 
-    function getMajorVersion() external view returns (VersionPart) { 
+    function getLatestVersion() external view returns (VersionPart) { 
         return _releaseManager.getLatestVersion();
     }
 
-    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory)
-    {
+    function getReleaseInfo(VersionPart version) external view returns (ReleaseInfo memory) {
         return _releaseManager.getReleaseInfo(version);
     }
 
-    function getObjectCount() external view override returns (uint256) {
+    function getObjectCount() external view returns (uint256) {
         return _chainNft.totalSupply();
     }
 
@@ -151,11 +264,15 @@ contract Registry is
         return _registryNftId;
     }
 
-    function getNftId(address object) external view override returns (NftId id) {
+    function getProtocolNftId() external view returns (NftId nftId) {
+        return _protocolNftId;
+    }
+
+    function getNftId(address object) external view returns (NftId id) {
         return _nftIdByAddress[object];
     }
 
-    function ownerOf(NftId nftId) public view override returns (address) {
+    function ownerOf(NftId nftId) public view returns (address) {
         return _chainNft.ownerOf(nftId.toInt());
     }
 
@@ -163,42 +280,78 @@ contract Registry is
         return _chainNft.ownerOf(_nftIdByAddress[contractAddress].toInt());
     }
 
-    function getObjectInfo(NftId nftId) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory) {
         return _info[nftId];
     }
 
-    function getObjectInfo(address object) external view override returns (ObjectInfo memory) {
+    function getObjectInfo(address object) external view returns (ObjectInfo memory) {
         return _info[_nftIdByAddress[object]];
     }
 
-    function isRegistered(NftId nftId) public view override returns (bool) {
+    function isRegistered(NftId nftId) public view returns (bool) {
         return _info[nftId].objectType.gtz();
     }
 
-    function isRegistered(address object) external view override returns (bool) {
+    function isRegistered(address object) external view returns (bool) {
         return _nftIdByAddress[object].gtz();
     }
 
-    function isRegisteredService(address object) external view override returns (bool) {
-        return _nftIdByAddress[object].gtz() && _info[_nftIdByAddress[object]].objectType == SERVICE();
+    function isRegisteredService(address object) external view returns (bool) {
+        return _info[_nftIdByAddress[object]].objectType == SERVICE();
+    }
+
+    function isRegisteredComponent(address object) external view returns (bool) {
+        NftId objectParentNftId = _info[_nftIdByAddress[object]].parentNftId;
+        return _info[objectParentNftId].objectType == INSTANCE();
+    }
+
+    function isValidRelease(VersionPart version) external view returns (bool)
+    {
+        return _releaseManager.isValidRelease(version);
+    }
+
+    function getStakingAddress() external view returns (address staking) {
+        return _stakingAddress;
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return _tokenRegistryAddress;
     }
 
     function getServiceAddress(
         ObjectType serviceDomain, 
         VersionPart releaseVersion
-    ) external view returns (address)
+    ) external view returns (address service)
     {
-        return _service[releaseVersion][serviceDomain];
+            service =  _service[releaseVersion][serviceDomain]; 
     }
 
-    function getChainNft() external view override returns (ChainNft) {
-        return _chainNft;
+    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address) {
+        return address(_releaseManager.getReleaseAccessManager(version));
+    }
+
+    function getReleaseManagerAddress() external view returns (address) {
+        return address(_releaseManager);
+    }
+
+    function getChainNftAddress() external view override returns (address) {
+        return address(_chainNft);
     }
 
     function getOwner() public view returns (address owner) {
         return ownerOf(address(this));
     }
 
+    // IERC165
+
+    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
+        if(interfaceId == type(IERC165).interfaceId || interfaceId == type(IRegistry).interfaceId) {
+            return true;
+        }
+
+        return false;
+    }
+
     // Internals
 
     /// @dev registry protects only against tampering existing records, registering with invalid types pairs and 0 parent address
@@ -208,63 +361,63 @@ contract Registry is
         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);
+        address interceptorAddress = _getInterceptor(
+            isInterceptor, 
+            objectType, 
+            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);
-
-        // TODO move nftId out of info struct
-        // getters by nftId -> return struct without nftId
-        // getters by address -> return nftId AND struct
+        uint256 tokenId = _chainNft.getNextTokenId();
+        nftId = NftIdLib.toNftId(tokenId);
         info.nftId = nftId;
         _info[nftId] = info;
 
-        if(info.objectAddress > address(0)) 
-        {
-            // parent is registered + object-parent types are valid
-            if(_isValidContractCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
+        if(objectAddress > address(0)) {
+            if(_nftIdByAddress[objectAddress].gtz()) { 
+                revert ErrorRegistryContractAlreadyRegistered(objectAddress);
             }
 
-            address contractAddress = info.objectAddress;
+            _nftIdByAddress[objectAddress] = nftId;
+        }
 
-            if(_nftIdByAddress[contractAddress].gtz()) { 
-                revert ContractAlreadyRegistered(contractAddress);
-            }
+        emit LogRegistration(nftId, parentNftId, objectType, isInterceptor, objectAddress, owner);
 
-            _nftIdByAddress[contractAddress] = nftId;
-        }
-        else
-        {
-            if(_isValidObjectCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
-            }
-        }
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = _chainNft.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
@@ -273,6 +426,11 @@ contract Registry is
         view 
         returns (address interceptor) 
     {
+        // no intercepting calls for stakes
+        if (objectType == STAKE()) {
+            return address(0);
+        }
+
         if (objectAddress == address(0)) {
             if (parentIsInterceptor) {
                 return parentObjectAddress;
@@ -295,11 +453,11 @@ contract Registry is
         private
     {
         uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
-        NftId protocolNftId = toNftId(protocolId);
+        _protocolNftId = NftIdLib.toNftId(protocolId);
 
-        _info[protocolNftId] = ObjectInfo({
-            nftId: protocolNftId,
-            parentNftId: zeroNftId(),
+        _info[_protocolNftId] = ObjectInfo({
+            nftId: _protocolNftId,
+            parentNftId: NftIdLib.zero(),
             objectType: PROTOCOL(),
             isInterceptor: false, 
             objectAddress: address(0),
@@ -314,23 +472,24 @@ 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({
-            nftId: registryNftId,
+        _info[_registryNftId] = ObjectInfo({
+            nftId: _registryNftId,
             parentNftId: parentNftId,
             objectType: REGISTRY(),
             isInterceptor: false,
@@ -338,9 +497,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);
     }
 
@@ -349,11 +507,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),
@@ -370,27 +528,51 @@ contract Registry is
     // 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"
-    function _setupValidObjectParentCombinations() 
+    function _setupValidCoreTypesAndCombinations() 
         private 
     {
-        // registry as parent, ONLY registry owner
-        _isValidContractCombination[TOKEN()][REGISTRY()] = true;
-        _isValidContractCombination[SERVICE()][REGISTRY()] = true;
-
-        // registry as parent, ONLY approved
-        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
-
-        // instance as parent, ONLY approved
-        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
-        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
-        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
-        _isValidContractCombination[POOL()][INSTANCE()] = 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;
 
-        // product as parent, ONLY approved
-        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
-
-        // pool as parent, ONLY approved
-        _isValidObjectCombination[BUNDLE()][POOL()] = true;
-        _isValidObjectCombination[STAKE()][POOL()] = 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;
+
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
+        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
+        _coreContractCombinations[POOL()][INSTANCE()] = true;
+
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+
+        // staking
+        _coreObjectCombinations[STAKE()][PROTOCOL()] = true;
+        _coreObjectCombinations[STAKE()][INSTANCE()] = true;
     }
-}
+}