@etherisc/gif-next 0.0.2-fe88ad7-208 → 0.0.2-ff282a4-523

package/contracts/registry/Registry.sol

@@ -1,12 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+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, toNftId, zeroNftId} 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";
@@ -23,28 +22,31 @@ import {ReleaseManager} from "./ReleaseManager.sol";
 // 4) state object by regular service (POLICY, BUNDLE, STAKE)
 
 contract Registry is
-    ERC165,
     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;
 
-    NftId internal _registryNftId;
-    ChainNft internal _chainNft;
+    NftId private _registryNftId;
+    ChainNft private _chainNft;
 
-    ReleaseManager internal _releaseManager;
+    ReleaseManager private _releaseManager;
+    address private _stakingAddress;
 
     modifier onlyRegistryService() {
         if(!_releaseManager.isActiveRegistryService(msg.sender)) {
@@ -60,21 +62,50 @@ contract Registry is
         _;
     }
 
-    constructor()
-    {
+    constructor() {
         _releaseManager = ReleaseManager(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();
+    }
+
 
-        _registerInterface(type(IRegistry).interfaceId);
+    function registerStaking(
+        address stakingAddress,
+        address stakingOwner
+    )
+        external
+        onlyReleaseManager
+        returns(NftId stakingNftId)
+    {
+        // staking contract for same chain may only be registered once
+        if (_stakingAddress != address(0)) {
+            revert StakingAlreadyRegistered(_stakingAddress);
+        }
+
+        _stakingAddress = stakingAddress;
+        uint256 stakingId = _chainNft.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
+        stakingNftId = toNftId(stakingId);
+
+        _nftIdByAddress[_stakingAddress] = stakingNftId;
+        _info[stakingNftId] = ObjectInfo({
+            nftId: stakingNftId,
+            parentNftId: _registryNftId,
+            objectType: STAKING(),
+            isInterceptor: false,
+            objectAddress: _stakingAddress, 
+            initialOwner: stakingOwner,
+            data: "" 
+        });
+
+        _chainNft.mint(stakingOwner, stakingId);
     }
 
     function registerService(
@@ -90,7 +121,10 @@ contract Registry is
         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)) {
@@ -109,16 +143,58 @@ contract Registry is
         onlyRegistryService
         returns(NftId nftId)
     {
+        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(info.objectType == SERVICE()) {
+        if(objectType == SERVICE()) {
             revert ServiceRegistration();
         }
 
+        // only valid core types combinations
+        if(info.objectAddress == address(0)) 
+        {
+            if(_coreObjectCombinations[objectType][parentType] == false) {
+                revert InvalidTypesCombination(objectType, parentType);
+            }
+        }
+        else
+        {
+            if(_coreContractCombinations[objectType][parentType] == false) {
+                revert InvalidTypesCombination(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 CoreTypeRegistration();
+        }
+
+        if(
+            parentType == PROTOCOL() ||
+            parentType == REGISTRY() ||
+            parentType == SERVICE()
+        ) {
+            revert InvalidTypesCombination(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,33 +205,36 @@ 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();
     }
 
+    function getReleaseManagerAddress() external view returns (address) {
+        return address(_releaseManager);
+    }
+
     function getNftId() external view returns (NftId nftId) {
         return _registryNftId;
     }
 
-    function getNftId(address object) external view override returns (NftId id) {
+    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 +242,69 @@ 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 getServiceAddress(
         ObjectType serviceDomain, 
         VersionPart releaseVersion
-    ) external view returns (address)
+    ) external view returns (address service)
     {
-        return _service[releaseVersion][serviceDomain];
+        // 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]; 
+        //}
     }
 
-    function getChainNft() external view override returns (ChainNft) {
-        return _chainNft;
+    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
@@ -222,28 +328,14 @@ contract Registry is
         }
 
         address interceptor = _getInterceptor(info.isInterceptor, info.objectAddress, parentInfo.isInterceptor, parentAddress);
+        uint256 tokenId = _chainNft.getNextTokenId();
+        nftId = toNftId(tokenId);
 
-        // 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
         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);
-            }
-
             address contractAddress = info.objectAddress;
 
             if(_nftIdByAddress[contractAddress].gtz()) { 
@@ -252,14 +344,16 @@ contract Registry is
 
             _nftIdByAddress[contractAddress] = nftId;
         }
-        else
-        {
-            if(_isValidObjectCombination[objectType][parentType] == false) {
-                revert InvalidTypesCombination(objectType, parentType);
-            }
-        }
 
         emit LogRegistration(nftId, parentNftId, objectType, info.isInterceptor, info.objectAddress, info.initialOwner);
+
+        // calls nft receiver(1) and interceptor(2)
+        uint256 mintedTokenId = _chainNft.mint(
+            info.initialOwner,
+            interceptor,
+            EMPTY_URI);
+        assert(mintedTokenId == tokenId);
+        
     }
 
     /// @dev obtain interceptor address for this nft if applicable, address(0) otherwise
@@ -370,27 +464,42 @@ 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;
+        _coreTypes[REGISTRY()] = true;
+        _coreTypes[SERVICE()] = true;
+        _coreTypes[TOKEN()] = true;
+        _coreTypes[INSTANCE()] = true;
+        _coreTypes[PRODUCT()] = true;
+        _coreTypes[POOL()] = true;
+        _coreTypes[DISTRIBUTION()] = true;
+        _coreTypes[POLICY()] = true;
+        _coreTypes[BUNDLE()] = true;
+        _coreTypes[STAKING()] = true;
+        _coreTypes[STAKE()] = true;
+        
+        _coreContractCombinations[REGISTRY()][REGISTRY()] = true; // only for global regstry
+        _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
 
         // registry as parent, ONLY approved
-        _isValidContractCombination[INSTANCE()][REGISTRY()] = true;
+        _coreContractCombinations[INSTANCE()][REGISTRY()] = true;
 
         // instance as parent, ONLY approved
-        _isValidContractCombination[PRODUCT()][INSTANCE()] = true;
-        _isValidContractCombination[DISTRIBUTION()][INSTANCE()] = true;
-        _isValidContractCombination[ORACLE()][INSTANCE()] = true;
-        _isValidContractCombination[POOL()][INSTANCE()] = true;
+        _coreContractCombinations[PRODUCT()][INSTANCE()] = true;
+        _coreContractCombinations[DISTRIBUTION()][INSTANCE()] = true;
+        _coreContractCombinations[ORACLE()][INSTANCE()] = true;
+        _coreContractCombinations[POOL()][INSTANCE()] = true;
+
+        _coreObjectCombinations[DISTRIBUTOR()][DISTRIBUTION()] = true;
 
         // product as parent, ONLY approved
-        _isValidObjectCombination[POLICY()][PRODUCT()] = true;
+        _coreObjectCombinations[POLICY()][PRODUCT()] = true;
 
         // pool as parent, ONLY approved
-        _isValidObjectCombination[BUNDLE()][POOL()] = true;
-        _isValidObjectCombination[STAKE()][POOL()] = true;
+        _coreObjectCombinations[BUNDLE()][POOL()] = true;
+        _coreObjectCombinations[STAKE()][POOL()] = true;
     }
-}
+}

package/contracts/registry/RegistryAccessManager.sol

@@ -5,29 +5,31 @@ import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManage
 import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 
 import {RoleId, RoleIdLib,
-        REGISTRY_SERVICE_MANAGER_ROLE,
-        REGISTRY_SERVICE_ADMIN_ROLE,
-        RELEASE_MANAGER_ROLE} from "../types/RoleId.sol";
+        GIF_MANAGER_ROLE,
+        GIF_ADMIN_ROLE,
+        RELEASE_MANAGER_ROLE} from "../type/RoleId.sol";
 
 import {TokenRegistry} from "./TokenRegistry.sol";
 import {ReleaseManager} from "./ReleaseManager.sol";
 
 /*
-    3 types of roles: 
-    1) REGISTRAR roles 
-        - each one is unique
-        - always have 1 member
-        - one role is set for each function of each version of registry service
-    2) REGISTRY_SERVICE_MANAGER_ROLE aka GIF_MANAGER_ROLE
+    4 types of roles:
+    1) RELEASE_MANAGER_ROLE
+        - has only ReleaseManager as member
+        - responsible for setting and granting of REGISTRAR roles
+    1) REGISTRAR roles
+        - set and granted by RELEASE_MANAGER_ROLE
+        - for each service and major version X there is 1 unique member (the service with version X itself) (subject to change)
+        - each set to 1 target (registry service ver.X) and 1 selector (function of registry service ver.X) (subject to change)
+    2) GIF_MANAGER_ROLE
         - can have arbitrary number of members
         - responsible for services registrations
         - responsible for token registration and activation
-    3) REGISTRY_SERVICE_ADMIN_ROLE aka GIF_ADMIN_ROLE
-        - admin of REGISTRY_SERVICE_MANAGER_ROLE
+    3) GIF_ADMIN_ROLE
+        - admin of GIF_MANAGER_ROLE
         - MUST have 1 member at any time
         - granted/revoked ONLY in transferAdminRole() -> consider lock out situations!!!
-        - responsible for release manager initialization
-        - responsible for creation and activation of each release
+        - responsible for creation and activation of releases
 
 */
 
@@ -71,8 +73,8 @@ contract RegistryAccessManager is AccessManaged
         _configureAdminRoleInitial();
 
         address admin = msg.sender;
-        _grantRole(REGISTRY_SERVICE_ADMIN_ROLE(), admin, 0);
-        _grantRole(REGISTRY_SERVICE_MANAGER_ROLE(), manager, 0);
+        _grantRole(GIF_ADMIN_ROLE(), admin, 0);
+        _grantRole(GIF_MANAGER_ROLE(), manager, 0);
     }
 
     function initialize(address releaseManager, address tokenRegistry)
@@ -124,10 +126,10 @@ contract RegistryAccessManager is AccessManaged
 
     /*function transferAdmin(address to)
         external
-        restricted // only with REGISTRY_SERVICE_ADMIN_ROLE or nft owner
+        restricted // only with GIF_ADMIN_ROLE or nft owner
     {
-        _accessManager.revoke(REGISTRY_SERVICE_ADMIN_ROLE, );
-        _accesssManager.grant(REGISTRY_SERVICE_ADMIN_ROLE, to, 0);
+        _accessManager.revoke(GIF_ADMIN_ROLE, );
+        _accesssManager.grant(GIF_ADMIN_ROLE, to, 0);
     }*/
 
     //--- view functions ----------------------------------------------------//
@@ -147,25 +149,17 @@ contract RegistryAccessManager is AccessManaged
         bytes4[] memory functionSelector = new bytes4[](1);
 
         functionSelector[0] = RegistryAccessManager.initialize.selector;
-        _setTargetFunctionRole(address(this), functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+        _setTargetFunctionRole(address(this), functionSelector, GIF_ADMIN_ROLE());
     }
 
     function _configureAdminRole() private
     {
-        bytes4[] memory functionSelector = new bytes4[](1);
-
-        // for RegistryServiceProxyManager
-        // TODO upgrading with releaseManager.upgrade()->proxy.upgrade()???
-        //functionSelector[0] = RegistryServiceManager.upgrade.selector;
-        //_setTargetFunctionRole(address(this), functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
-
-        // for TokenRegistry
-
         // for ReleaseManager
-        functionSelector[0] = ReleaseManager.createNextRelease.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
-        //functionSelector[0] = ReleaseManager.activateNextRelease.selector;
-        //_setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_ADMIN_ROLE());
+        bytes4[] memory functionSelector = new bytes4[](3);
+        functionSelector[0] = ReleaseManager.registerStaking.selector;
+        functionSelector[1] = ReleaseManager.createNextRelease.selector;
+        functionSelector[2] = ReleaseManager.activateNextRelease.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_ADMIN_ROLE());
     }
     
     function _configureManagerRole() private 
@@ -174,14 +168,17 @@ contract RegistryAccessManager is AccessManaged
 
         // for TokenRegistry
         functionSelector[0] = TokenRegistry.setActive.selector;
-        _setTargetFunctionRole(address(_tokenRegistry), functionSelector, REGISTRY_SERVICE_MANAGER_ROLE());
+        _setTargetFunctionRole(address(_tokenRegistry), functionSelector, GIF_MANAGER_ROLE());
 
         // for ReleaseManager
         functionSelector[0] = ReleaseManager.registerService.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, REGISTRY_SERVICE_MANAGER_ROLE());
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
+
+        functionSelector[0] = ReleaseManager.registerRegistryService.selector;
+        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
 
         // set admin
-        _setRoleAdmin(REGISTRY_SERVICE_MANAGER_ROLE(), REGISTRY_SERVICE_ADMIN_ROLE());
+        _setRoleAdmin(GIF_MANAGER_ROLE(), GIF_ADMIN_ROLE());
     }
 
     function _configureReleaseManagerRole() private