@etherisc/gif-next 0.0.2-b3a8633-027 → 0.0.2-b3a9c97-695

package/contracts/registry/ChainNft.sol

@@ -13,13 +13,14 @@ contract ChainNft is ERC721Enumerable {
     string public constant SYMBOL = "DIPNFT";
 
     uint256 public constant PROTOCOL_NFT_ID = 1101;
-    uint256 public constant GLOBAL_REGISTRY_ID = 2101; //TODO make dependent of MAINNET_CHAIN_ID constant?
+    uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
+    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
     // custom errors
-    error ErrorChainNftCallerNotRegistry(address caller);
-    error ErrorChainNftRegistryAddressZero();
-    error ErrorChainNftUriEmpty();
-    error ErrorChainNftUriAlreadySet();
+    error CallerNotRegistry(address caller);
+    error RegistryAddressZero();
+    error NftUriEmpty();
+    error NftUriAlreadySet();
 
     // contract state
 
@@ -33,18 +34,32 @@ contract ChainNft is ERC721Enumerable {
     address private _registry;
 
     // only used for _getNextTokenId
+    uint256 internal _chainIdInt;
+    uint256 internal _chainIdDigits;
+    uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
+        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
         _;
     }
 
     constructor(address registry) ERC721(NAME, SYMBOL) {
-        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
+        if (registry == address(0)) { revert RegistryAddressZero(); }
 
         _registry = registry;
+        _chainIdInt = block.chainid;
+        _chainIdDigits = 0;
+
+        // count digis
+        uint256 num = _chainIdInt;
+        while (num != 0) {
+            _chainIdDigits++;
+            num /= 10;
+        }
+
+        _chainIdMultiplier = 10 ** _chainIdDigits;
 
         // the first object registered through normal registration starts with id 4
         // 1 -> protocol
@@ -117,8 +132,8 @@ contract ChainNft is ERC721Enumerable {
         uint256 tokenId,
         string memory uri
     ) external onlyRegistry {
-        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
-        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
+        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
@@ -184,17 +199,11 @@ contract ChainNft is ERC721Enumerable {
     * (42 * 10 ** 10 + 9876543210) * 100 + 10
     * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
     */
-    // TODO consider situation when chainId = 2^256
-    function calculateTokenId(uint256 idIndex, uint chainId) public view returns (uint256 id) {
-        uint256 chainIdDigits = _chainIdDigits(chainId);
+    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
         id =
-            (idIndex * (10 ** chainIdDigits) + chainId) *
+            (idIndex * _chainIdMultiplier + _chainIdInt) *
             100 +
-            chainIdDigits;
-    }
-
-    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
-        id = calculateTokenId(idIndex, block.chainid);
+            _chainIdDigits;
     }
 
     function getNextTokenId() external view returns (uint256) {
@@ -205,14 +214,4 @@ contract ChainNft is ERC721Enumerable {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
-
-    function _chainIdDigits(uint chainId) internal view returns (uint256) {
-        uint256 num = chainId;
-        uint256 digits = 0;
-        while (num != 0) {
-            digits++;
-            num /= 10;
-        }
-        return digits;
-    }
 }

package/contracts/registry/IRegistry.sol

@@ -17,8 +17,9 @@ interface IRegistry is IERC165 {
     event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
     event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
 
-    // initialize
-    error ErrorRegistryCallerNotDeployer();
+    // register()
+    error ErrorRegistryCallerNotRegistryService();
+    error ErrorRegistryService(address service);
 
     // registerService()
     error ErrorRegistryCallerNotReleaseRegistry();

package/contracts/registry/Registry.sol

@@ -3,8 +3,8 @@ 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 {InitializableCustom} from "../shared/InitializableCustom.sol";
 
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -16,38 +16,30 @@ import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ReleaseRegistry} from "./ReleaseRegistry.sol";
 import {TokenRegistry} from "./TokenRegistry.sol";
 import {RegistryAdmin} from "./RegistryAdmin.sol";
-import {SidenetContract} from "../shared/MainnetId.sol";
 
-/// @dev IMPORTANT
+// IMPORTANT
 // Each NFT minted by registry is accosiated with:
 // 1) NFT owner
 // 2) registred contract OR object stored in registered (parent) contract
-// 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)
+// 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)
 
 /// @title Chain Registry contract implementing IRegistry.
 /// @notice See IRegistry for method details.
 contract Registry is
-    SidenetContract,
-    Initializable,
-    AccessManaged,
+    InitializableCustom,
     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 = "";
 
-    /// @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(NftId nftId => ObjectInfo info) private _info;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
 
     mapping(VersionPart version => mapping(ObjectType serviceDomain => address)) private _service;
 
@@ -63,7 +55,6 @@ contract Registry is
     ChainNft public immutable _chainNft;
 
     NftId public immutable _protocolNftId;
-    NftId public immutable _globalRegistryNftId;
     NftId public immutable _registryNftId;
     NftId public _stakingNftId;
 
@@ -71,13 +62,20 @@ contract Registry is
     address public _stakingAddress;
     ReleaseRegistry public _releaseRegistry;
 
-    modifier onlyDeployer() {
-        if (msg.sender != _deployer) {
-            revert ErrorRegistryCallerNotDeployer();
+    // 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(!_releaseRegistry.isActiveRegistryService(msg.sender)) {
+            revert ErrorRegistryCallerNotRegistryService();
         }
         _;
     }
 
+
     modifier onlyReleaseRegistry() {
         if(msg.sender != address(_releaseRegistry)) {
             revert ErrorRegistryCallerNotReleaseRegistry();
@@ -87,18 +85,15 @@ contract Registry is
 
     /// @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())
+    constructor(RegistryAdmin admin) 
+        InitializableCustom() 
     {
-        _deployer = msg.sender;
         _admin = admin;
         // deploy NFT 
         _chainNft = new ChainNft(address(this));
 
         // initial registry setup
         _protocolNftId = _registerProtocol();
-        _globalRegistryNftId = _registerGlobalRegistry(globalRegistry);
         _registryNftId = _registerRegistry();
 
         // set object types and object parent relations
@@ -115,7 +110,6 @@ contract Registry is
     )
         external
         initializer()
-        onlyDeployer()
     {
         _releaseRegistry = ReleaseRegistry(releaseRegistry);
         _tokenRegistryAddress = tokenRegistry;
@@ -127,7 +121,7 @@ contract Registry is
     /// @inheritdoc IRegistry
     function register(ObjectInfo memory info)
         external
-        restricted
+        onlyRegistryService
         returns(NftId nftId)
     {
         ObjectType objectType = info.objectType;
@@ -201,7 +195,7 @@ contract Registry is
     /// @inheritdoc IRegistry
     function registerWithCustomType(ObjectInfo memory info)
         external
-        restricted
+        onlyRegistryService
         returns(NftId nftId)
     {
         ObjectType objectType = info.objectType;
@@ -218,7 +212,7 @@ contract Registry is
             revert ErrorRegistryTypesCombinationInvalid(objectType, parentType);
         }
 
-        nftId = _register(info);
+        _register(info);
     }
 
 
@@ -459,40 +453,29 @@ contract Registry is
         _chainNft.mint(NFT_LOCK_ADDRESS, protocolId);
     }
 
-    /// @dev global registry registration
-    function _registerGlobalRegistry(address globalRegistry)
-        internal
-        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
+    /// might also register the global registry when not on mainnet
     function _registerRegistry() 
-        internal 
-        virtual
+        private
         returns (NftId registryNftId)
     {
         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: _globalRegistryNftId,
+            parentNftId: parentNftId,
             objectType: REGISTRY(),
             isInterceptor: false,
             objectAddress: address(this), 
@@ -504,10 +487,28 @@ contract Registry is
         _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
-    /// @dev staking registration
+    /// @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
     function _registerStaking()
         private
-        onlyInitializing()
         returns (NftId stakingNftId)
     {
         address stakingOwner = IRegisterable(_stakingAddress).getOwner();
@@ -525,13 +526,15 @@ 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
     /// EACH object type MUST have only one parent type across ALL mappings
     function _setupValidCoreTypesAndCombinations() 
-        private
+        private 
     {
         _coreTypes[REGISTRY()] = true;
         _coreTypes[SERVICE()] = true;
@@ -546,6 +549,12 @@ contract Registry is
         _coreTypes[STAKING()] = true;
         _coreTypes[STAKE()] = true;
 
+        // 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;