@etherisc/gif-next 0.0.2-b28f7c7-340 → 0.0.2-b3a8633-027

package/contracts/registry/GlobalRegistry.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+
+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/MainnetId.sol";
+
+contract GlobalRegistry is
+    MainnetContract, 
+    Registry,
+    IGlobalRegistry
+{
+    using EnumerableSet for EnumerableSet.AddressSet;
+
+    error ErrorGlobalRegistryDeploymentNotOnMainnet(uint chainId);
+    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);
+        }
+        // redundant -> chainRegistryId is chainId dependent, chainNft will revert if chainRegistryId is already minted
+        if(_registryAddressByChainId[chainId] != address(0)) {
+            revert ErrorGlobalRegistryChainRegistryAlreadyRegistered(chainId, _registryAddressByChainId[chainId]);
+        }
+
+        // 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 already registered, register specifics only
+    function _registerRegistry() 
+        internal
+        virtual
+        override
+        returns (NftId)
+    {
+        _registryAddressByChainId[MAINNET_CHAIN_ID] = address(this);
+        return _globalRegistryNftId;
+    }
+}

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/MainnetId.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 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

@@ -3,31 +3,39 @@ pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
-import {VersionPart} from "../types/Version.sol";
-import {Timestamp} from "../types/Timestamp.sol";
-
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
+import {Timestamp} from "../type/Timestamp.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);
 
-    // registerService()
-    error CallerNotReleaseManager();
-    error ServiceAlreadyRegistered(address service);
+    // initialize
+    error ErrorRegistryCallerNotDeployer();
 
-    // register()
-    error CallerNotRegistryService();
-    error ServiceRegistration();
+    // registerService()
+    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);
 
     // registerWithCustomTypes()
-    error CoreTypeRegistration();
+    error ErrorRegistryCoreTypeRegistration();
 
     // _register()
-    error ZeroParentAddress();
-    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
-    error ContractAlreadyRegistered(address objectAddress);
+    error ErrorRegistryParentAddressZero();
+    error ErrorRegistryTypesCombinationInvalid(ObjectType objectType, ObjectType parentType);
+    error ErrorRegistryContractAlreadyRegistered(address objectAddress);
 
     struct ObjectInfo {
         NftId nftId;
@@ -37,23 +45,36 @@ interface IRegistry is IERC165 {
         address objectAddress;
         address initialOwner;
         bytes data;
-    }// TODO delete nftId and initialOwner(if not used) from struct
-    // TODO strong disagree, keep nftId there (lets keep get object info return object consistent)
+    }
 
     struct ReleaseInfo {
+        VersionPart version;
+        bytes32 salt;
+        address[] addresses;
+        string[] names;
         ObjectType[] domains;
-        Timestamp createdAt;
-        //Timestamp updatedAt;
+        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);
@@ -66,8 +87,6 @@ interface IRegistry is IERC165 {
 
     function getObjectCount() external view returns (uint256);
 
-    function getNftId() external view returns (NftId nftId);
-
     function getNftId(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
@@ -86,16 +105,29 @@ interface IRegistry is IERC165 {
 
     function isRegisteredComponent(address object) external view returns (bool);
 
-    function isValidRelease(VersionPart version) external view returns (bool);
+    function isActiveRelease(VersionPart version) external view returns (bool);
 
     function getServiceAddress(
         ObjectType serviceDomain, 
         VersionPart releaseVersion
     ) external view returns (address serviceAddress);
 
-    function getReleaseManagerAddress() external view returns (address);
+    function getProtocolNftId() external view returns (NftId protocolNftId);
 
-    function getChainNftAddress() external view returns (address);
+    function getNftId() external view returns (NftId nftId);
 
     function getOwner() external view returns (address);
+
+    // TODO refactor the address getters below to contract getters
+    function getChainNftAddress() external view returns (address);
+
+    function getReleaseRegistryAddress() external view returns (address);
+
+    function getStakingAddress() external view returns (address);
+
+    function getTokenRegistryAddress() external view returns (address);
+
+    function getRegistryAdminAddress() external view returns (address);
+
+    function getAuthority() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -3,66 +3,67 @@ pragma solidity ^0.8.20;
 
 // import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
-import {RoleId} from "../types/RoleId.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {IService} from "../shared/IService.sol";
 import {IRegistry} from "./IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IComponent} from "../components/IComponent.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
 
 interface IRegistryService is 
      IService
-     // TODO cleanup
-     // IAccessManaged 
 {
-     error SelfRegistration();
-     error NotRegistryOwner();
-
-     error NotService();
-     error NotInstance();
-     error NotProduct();
-     error NotPool();
-     error NotDistribution();
-
-     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
-     error NotRegisterableOwner(address expectedOwner);
-     error RegisterableOwnerIsZero();   
-     error RegisterableOwnerIsRegistered();
-     error InvalidInitialOwner(address initialOwner);
-     error InvalidAddress(address registerableAddress);
-
-     struct FunctionConfig
-     {
-          ObjectType serviceDomain;
-          bytes4[] selectors;
-     }
-
-     function getFunctionConfigs()
-          external
-          pure
-          returns(
-               FunctionConfig[] memory config
-          );
-
-     // TODO used by service -> add owner arg 
+     error ErrorRegistryServiceNotRegistryOwner();
+
+     error ErrorRegistryServiceNotService(address notService);
+     error ErrorRegistryServiceNotInstance(address notInstance);
+     error ErrorRegistryServiceNotComponent(address notComponent);
+     error ErrorRegistryServiceNotProduct(address notProduct);
+     error ErrorRegistryServiceNotPool(address notPool);
+     error ErrorRegistryServiceNotDistribution(address notDistribution);
+
+     error ErrorRegistryServiceRegisterableAddressInvalid(IRegisterable registerable, address found);
+     error ErrorRegistryServiceRegisterableTypeInvalid(IRegisterable registerable, ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceRegisterableOwnerInvalid(IRegisterable registerable, address expected, address found);
+     error ErrorRegistryServiceRegisterableOwnerZero(IRegisterable registerable);   
+     error ErrorRegistryServiceRegisterableOwnerRegistered(IRegisterable registerable, address owner);
+     error ErrorRegistryServiceRegisterableSelfRegistration(IRegisterable registerable);
+
+     error ErrorRegistryServiceObjectAddressNotZero(ObjectType objectType);
+     error ErrorRegistryServiceObjectTypeInvalid(ObjectType expected, ObjectType found);
+     error ErrorRegistryServiceObjectOwnerRegistered(ObjectType objectType, address owner);
+     error ErrorRegistryServiceObjectOwnerZero(ObjectType objectType);
+
+     error ErrorRegistryServiceInvalidInitialOwner(address initialOwner);
+     error ErrorRegistryServiceInvalidAddress(address registerableAddress);
+
+     function registerStake(IRegistry.ObjectInfo memory info)
+          external returns(NftId nftId); 
+
      function registerInstance(IRegisterable instance, address owner)
           external returns(IRegistry.ObjectInfo memory info); 
 
-     function registerProduct(IComponent product, address owner)
+     function registerComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerProduct(IComponent product, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerDistribution(IComponent distribution, 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 registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
+
 }