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

package/contracts/registry/ChainNft.sol

@@ -13,14 +13,13 @@ contract ChainNft is ERC721Enumerable {
     string public constant SYMBOL = "DIPNFT";
 
     uint256 public constant PROTOCOL_NFT_ID = 1101;
-    uint256 public constant GLOBAL_REGISTRY_ID = 2101;
+    uint256 public constant GLOBAL_REGISTRY_ID = 2101; //TODO make dependent of MAINNET_CHAIN_ID constant?
 
-    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
     // custom errors
-    error CallerNotRegistry(address caller);
-    error RegistryAddressZero();
-    error NftUriEmpty();
-    error NftUriAlreadySet();
+    error ErrorChainNftCallerNotRegistry(address caller);
+    error ErrorChainNftRegistryAddressZero();
+    error ErrorChainNftUriEmpty();
+    error ErrorChainNftUriAlreadySet();
 
     // contract state
 
@@ -34,31 +33,22 @@ 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 CallerNotRegistry(msg.sender); }
+        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
         _;
     }
 
     constructor(address registry) ERC721(NAME, SYMBOL) {
-        if (registry == address(0)) { revert RegistryAddressZero(); }
+        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
 
         _registry = registry;
-        _chainIdInt = block.chainid;
-        _chainIdDigits = 0;
-
-        // count digis
-        uint256 num = _chainIdInt;
-        while (num != 0) {
-            _chainIdDigits++;
-            num /= 10;
-        }
 
+        _chainIdDigits = _calculateChainIdDigits(block.chainid);
         _chainIdMultiplier = 10 ** _chainIdDigits;
 
         // the first object registered through normal registration starts with id 4
@@ -132,8 +122,8 @@ contract ChainNft is ERC721Enumerable {
         uint256 tokenId,
         string memory uri
     ) external onlyRegistry {
-        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
-        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
+        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
@@ -199,11 +189,25 @@ contract ChainNft is ERC721Enumerable {
     * (42 * 10 ** 10 + 9876543210) * 100 + 10
     * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
     */
-    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
+    function calculateTokenId(uint256 idIndex, uint chainId) public view returns (uint256 id) {
+        uint256 chainIdDigits;
+        uint256 chainIdMultiplier;
+        if(chainId == block.chainid) {
+            chainIdDigits = _chainIdDigits;
+            chainIdMultiplier = _chainIdMultiplier;
+        } else {
+            chainIdDigits = _calculateChainIdDigits(chainId);
+            chainIdMultiplier = 10 ** chainIdDigits;
+        }
+
         id =
-            (idIndex * _chainIdMultiplier + _chainIdInt) *
+            (idIndex * chainIdMultiplier + chainId) *
             100 +
-            _chainIdDigits;
+            chainIdDigits;
+    }
+
+    function calculateTokenId(uint256 idIndex) public view returns (uint256) {
+        return calculateTokenId(idIndex, block.chainid);
     }
 
     function getNextTokenId() external view returns (uint256) {
@@ -214,4 +218,14 @@ contract ChainNft is ERC721Enumerable {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
+
+    function _calculateChainIdDigits(uint chainId) internal view returns (uint256) {
+        uint256 num = chainId;
+        uint256 digits = 0;
+        while (num != 0) {
+            digits++;
+            num /= 10;
+        }
+        return digits;
+    }
 }

package/contracts/registry/GlobalRegistry.sol

@@ -0,0 +1,104 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {VersionPart} from "../type/Version.sol";
+import {ObjectType, REGISTRY} from "../type/ObjectType.sol";
+
+import {IGlobalRegistry} from "./IGlobalRegistry.sol";
+import {Registry} from "./Registry.sol";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
+import {MainnetContract} from "../shared/MainnetContract.sol";
+
+contract GlobalRegistry is
+    MainnetContract, 
+    Registry,
+    IGlobalRegistry
+{
+
+    error ErrorGlobalRegistryChainRegistryAlreadyRegistered(uint chainId, address chainRegistry);
+    error ErrorGlobalRegistryChainRegistryAddressInvalid(uint chainId, address chainRegistry);
+
+    mapping(uint chanId => address registry) _registryAddressByChainId;
+    uint256[] _chainId;
+
+    constructor(RegistryAdmin admin) Registry(admin, address(this)) 
+    {}
+
+    /// @dev registers a registry contract for a specified chain
+    //  only one chain registry per chain
+    //  each chain registry have unique address (sort of share same address space)
+    function registerChainRegistry(uint chainId, address chainRegistryAddress)
+        external
+        restricted
+        returns (NftId chainRegistryNftId)
+    {
+        // TODO allow for the same address to be registered on multiple chains
+        if(_nftIdByAddress[chainRegistryAddress] != NftIdLib.zero()) {
+            revert ErrorGlobalRegistryChainRegistryAddressInvalid(chainId, chainRegistryAddress);
+        }
+
+        // calculate chain registry token id
+        uint chainRegistryId = _chainNft.calculateTokenId(REGISTRY_TOKEN_SEQUENCE_ID, chainId);
+        chainRegistryNftId = NftIdLib.toNftId(chainRegistryId);
+
+        _info[chainRegistryNftId] = ObjectInfo({
+            nftId: chainRegistryNftId,
+            parentNftId: _registryNftId,
+            objectType: REGISTRY(),
+            isInterceptor: false,
+            objectAddress: chainRegistryAddress, // TODO consider "chainId:address" format
+            initialOwner: NFT_LOCK_ADDRESS,
+            data: ""  
+        });
+
+        _nftIdByAddress[chainRegistryAddress] = chainRegistryNftId;
+        _registryAddressByChainId[chainId] = chainRegistryAddress;
+        _chainId.push(chainId);
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, chainRegistryId);
+    }
+
+    //------------- public view functions -------------//
+    function getChainRegistryAddress(uint chainId) public view returns (address) {
+        return _registryAddressByChainId[chainId];
+    }
+
+    function getChainId(uint idx) public view returns (uint) {
+        return _chainId[idx];
+    }
+
+    function chainIds() public view returns (uint) {
+        return _chainId.length;
+    }
+
+    // Internals
+        /// @dev global registry registration
+    function _registerRegistry(address globalRegistry) 
+        internal
+        virtual
+        override
+        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;
+        // global registry specific
+        _registryAddressByChainId[MAINNET_CHAIN_ID] = address(this);
+        _chainId.push(MAINNET_CHAIN_ID);
+
+        _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
+    }
+
+}

package/contracts/registry/GlobalRegistryAdmin.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {GIF_ADMIN_ROLE} from "../type/RoleId.sol";
+
+import {IGlobalRegistry} from "./IGlobalRegistry.sol";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
+import {MainnetContract} from "../shared/MainnetContract.sol";
+
+
+contract GlobalRegistryAdmin is
+    MainnetContract,
+    RegistryAdmin
+{
+    error ErrorGlobalRegistryAdminDeploymentNotOnMainnet();
+
+    constructor() RegistryAdmin() 
+    { 
+        if(block.chainid != 1) {
+            revert ErrorGlobalRegistryAdminDeploymentNotOnMainnet();
+        }
+    }
+
+    function _setupRegistry()
+        internal
+        override
+        onlyInitializing()
+    {
+        super._setupRegistry();
+
+        // global registry function authorization for gif admin role
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](1);
+        functions[0] = toFunction(IGlobalRegistry.registerChainRegistry.selector, "registerChainRegistry");
+
+        _authorizeTargetFunctions(_registry, GIF_ADMIN_ROLE(), functions);
+    }
+}

package/contracts/registry/IGlobalRegistry.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../type/NftId.sol";
+
+import {IRegistry} from "./IRegistry.sol";
+
+interface IGlobalRegistry is IRegistry {
+    // function registerChainRegistry(uint chainId, address deployer, bytes32 initCodeHash, bytes32 salt);
+    function registerChainRegistry(uint chainId, address chainRegistryAddress) external returns (NftId chainRegistryNftId);
+
+    function getChainRegistryAddress(uint chainId) external returns (address); 
+
+    function getChainId(uint idx) external view returns (uint);
+
+    function chainIds() external view returns (uint);
+}

package/contracts/registry/IRegistry.sol

@@ -7,21 +7,28 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {RoleId} from "../type/RoleId.sol";
 
+/// @title Chain Registry interface.
+/// A chain registry holds all protocol relevant objects with basic metadata.
+/// Registered objects include services, instances, products, pools, policies, bundles, stakes and more.
+/// Registered objects are represented by NFTs.
 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();
+
     // registerService()
-    error ErrorRegistryCallerNotReleaseManager();
+    error ErrorRegistryCallerNotReleaseRegistry();
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(); 
+    error ErrorRegistryNotService(address service, ObjectType objectType);
+    error ErrorRegistryServiceParentNotRegistry(NftId parentNftId);
     error ErrorRegistryDomainZero(address service);
     error ErrorRegistryDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
 
-    // register()
-    error ErrorRegistryCallerNotRegistryService();
-
     // registerWithCustomTypes()
     error ErrorRegistryCoreTypeRegistration();
 
@@ -40,30 +47,34 @@ interface IRegistry is IERC165 {
         bytes data;
     }
 
-
     struct ReleaseInfo {
         VersionPart version;
         bytes32 salt;
         address[] addresses;
         string[] names;
-        RoleId[][] serviceRoles;
-        string[][] serviceRoleNames;
-        RoleId[][] functionRoles;
-        string[][] functionRoleNames;
-        bytes4[][][] selectors;
         ObjectType[] domains;
         Timestamp activatedAt;
         Timestamp disabledAt;
     }
 
+    /// @dev Register an object with a known core type.
+    /// The function returns a newly minted object NFT ID.
+    /// May not be used to register services.
+    function register(ObjectInfo memory info) external returns (NftId nftId);
+
+    /// @dev Register a service with using the provided domain and version.
+    /// The function returns a newly minted service NFT ID.
+    /// May only be used to register services.
     function registerService(
         ObjectInfo memory serviceInfo, 
         VersionPart serviceVersion, 
         ObjectType serviceDomain
     ) external returns(NftId nftId);
 
-    function register(ObjectInfo memory info) external returns (NftId nftId);
-
+    /// @dev Register an object with a custom type.
+    /// The function returns a newly minted object NFT ID.
+    /// This function is reserved for GIF releases > 3.
+    /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
     function getInitialVersion() external view returns (VersionPart);
@@ -110,9 +121,7 @@ interface IRegistry is IERC165 {
     // TODO refactor the address getters below to contract getters
     function getChainNftAddress() external view returns (address);
 
-    function getReleaseManagerAddress() external view returns (address);
-
-    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address);
+    function getReleaseRegistryAddress() external view returns (address);
 
     function getStakingAddress() external view returns (address);
 

package/contracts/registry/IRegistryService.sol

@@ -50,14 +50,14 @@ interface IRegistryService is
      function registerComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
-     function registerProduct(IComponent product, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerProduct(IComponent product, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerPool(IComponent pool, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerDistribution(IComponent distribution, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerDistribution(IComponent distribution, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
      function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);