@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd9539f-062

package/contracts/registry/IRegistry.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
@@ -25,18 +25,11 @@ interface IRegistry is IERC165 {
     // registerWithCustomTypes()
     error ErrorRegistryCoreTypeRegistration();
 
-    // setTokenRegistry()
-    error TokenRegistryZero();
-    error TokenRegistryAlreadySet(address tokenRegistry);
-
     // _register()
     error ErrorRegistryParentAddressZero();
     error ErrorRegistryTypesCombinationInvalid(ObjectType objectType, ObjectType parentType);
     error ErrorRegistryContractAlreadyRegistered(address objectAddress);
 
-    // _registerStaking()
-    error StakingAlreadyRegistered(address stakingAddress);
-
     struct ObjectInfo {
         NftId nftId;
         NftId parentNftId;
@@ -47,14 +40,20 @@ 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;
     }
 
     function registerService(
@@ -77,8 +76,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);
@@ -97,22 +94,31 @@ 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 getStakingAddress() external view returns (address staking);
+    function getProtocolNftId() external view returns (NftId protocolNftId);
 
-    function getTokenRegistryAddress() 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 getReleaseManagerAddress() external view returns (address);
 
     function getReleaseAccessManagerAddress(VersionPart version) external view returns (address);
 
-    function getChainNftAddress() external view returns (address);
+    function getStakingAddress() external view returns (address);
 
-    function getOwner() 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

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 // import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
@@ -33,6 +33,7 @@ interface IRegistryService is
      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);

package/contracts/registry/IServiceAuthorization.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.24;
+
+import {IAccessAdmin} from "../shared/IAccessAdmin.sol";
+import {ObjectType} from "../../contracts/type/ObjectType.sol";
+import {VersionPart} from "../../contracts/type/Version.sol";
+
+interface IServiceAuthorization {
+
+     /// @dev Returns the commit hash representing the deployed release
+     function getCommitHash()
+          external
+          view
+          returns(string memory commitHash);
+
+     /// @dev Returns the release (VersionPart) for which the service authorizations are defined by this contract.
+     function getRelease()
+          external
+          view
+          returns(VersionPart release, uint domainsCount);
+
+     /// @dev Returns the full list of service domains for this release.
+     /// Services need to be registered for the release in revers order of this list.
+     function getServiceDomains() external view returns(ObjectType[] memory serviceDomains);
+
+     /// @dev Returns the expected service address for the provided domain.
+     function getServiceAddress(ObjectType serviceDomain) external view returns(address service);
+
+     /// @dev Given the service domain this function returns the list of other service domains that are authorized to access this service.
+     function getAuthorizedDomains(ObjectType serviceDomain) external view returns(ObjectType[] memory authorizatedDomains);
+
+     /// @dev For the given service domain and authorized domain the function returns the list of authorized functions
+     function getAuthorizedFunctions(ObjectType serviceDomain, ObjectType authorizedDomain) external view returns(IAccessAdmin.Function[] memory authorizatedFunctions);
+}
+

package/contracts/registry/ITransferInterceptor.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 interface ITransferInterceptor {
     function nftMint(address to, uint256 tokenId) external;

package/contracts/registry/Registry.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {InitializableCustom} from "../shared/InitializableCustom.sol";
 
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -9,8 +12,10 @@ import {ObjectType, PROTOCOL, REGISTRY, TOKEN, SERVICE, INSTANCE, STAKE, STAKING
 
 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";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
 
 // IMPORTANT
 // Each NFT minted by registry is accosiated with:
@@ -23,9 +28,10 @@ import {TokenRegistry} from "./TokenRegistry.sol";
 // 4) state object by regular service (POLICY, BUNDLE, STAKE)
 
 contract Registry is
+    InitializableCustom,
     IRegistry
 {
-    address public constant NFT_LOCK_ADDRESS = address(0x1);
+    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 = "";
@@ -43,13 +49,23 @@ contract Registry is
     mapping(ObjectType objectType => mapping(
             ObjectType parentType => bool)) private _coreObjectCombinations;
 
-    NftId immutable _registryNftId;
-    ChainNft immutable _chainNft;
+    RegistryAdmin public immutable _admin;
+    ChainNft public immutable _chainNft;
+
+    NftId public immutable _protocolNftId;
+    NftId public immutable _registryNftId;
+    NftId public _stakingNftId;
 
-    ReleaseManager immutable _releaseManager;
-    address private _tokenRegistryAddress;
-    address private _stakingAddress;
+    address public _tokenRegistryAddress;
+    address public _stakingAddress;
+    ReleaseManager public _releaseManager;
 
+    // TODO 
+    // 1). Registry and ReleaseManager must be treated as whole single entity. 
+    //     But current limitations of EVM does not allow it -> require it to be splitted
+    // 2). Keep onlyReleaseManager modifier
+    // 3). Delete onlyRegistryService in favor of restricted, introduce aditional "domain role", REGISTRY_SERVICE_ROLE
+    // 4). (For GlobalRegistry ONLY) make registerChainRegistry() restricted to GIF_ADMIN_ROLE
     modifier onlyRegistryService() {
         if(!_releaseManager.isActiveRegistryService(msg.sender)) {
             revert ErrorRegistryCallerNotRegistryService();
@@ -57,6 +73,7 @@ contract Registry is
         _;
     }
 
+
     modifier onlyReleaseManager() {
         if(msg.sender != address(_releaseManager)) {
             revert ErrorRegistryCallerNotReleaseManager();
@@ -64,14 +81,16 @@ contract Registry is
         _;
     }
 
-    constructor() {
-        _releaseManager = ReleaseManager(msg.sender);
 
+    constructor(RegistryAdmin admin) 
+        InitializableCustom() 
+    {
+        _admin = admin;
         // deploy NFT 
         _chainNft = new ChainNft(address(this));
 
         // initial registry setup
-        _registerProtocol();
+        _protocolNftId = _registerProtocol();
         _registryNftId = _registerRegistry();
 
         // set object types and object parent relations
@@ -79,53 +98,21 @@ contract Registry is
     }
 
 
-    function setTokenRegistry(
-        address tokenRegistry
+    /// @dev wires release manager and token to registry (this contract).
+    /// MUST be called by release manager.
+    function initialize(
+        address releaseManager,
+        address tokenRegistry,
+        address staking
     )
         external
-        onlyReleaseManager
+        initializer()
     {
-        if (_tokenRegistryAddress != address(0)) {
-            revert TokenRegistryAlreadySet(tokenRegistry);
-        }
-
-        if (address(tokenRegistry) == address(0)) {
-            revert TokenRegistryZero();
-        }
-
+        _releaseManager = ReleaseManager(releaseManager);
         _tokenRegistryAddress = tokenRegistry;
-    }
-
-
-    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 = NftIdLib.toNftId(stakingId);
-
-        _nftIdByAddress[_stakingAddress] = stakingNftId;
-        _info[stakingNftId] = ObjectInfo({
-            nftId: stakingNftId,
-            parentNftId: _registryNftId,
-            objectType: STAKING(),
-            isInterceptor: false,
-            objectAddress: _stakingAddress, 
-            initialOwner: stakingOwner,
-            data: "" 
-        });
+        _stakingAddress = staking;
 
-        _chainNft.mint(stakingOwner, stakingId);
+        _stakingNftId = _registerStaking();
     }
 
     function registerService(
@@ -225,13 +212,7 @@ contract Registry is
         return _releaseManager.getInitialVersion();
     }
 
-    // TODO make distinction between active an not yet active version
-    // need to be thought trough, not yet clear if necessary
-    // need to answer question: what is the latest version during the upgrade process?
-    // likely setting up a new gif version does not fit into a single tx
-    // 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)
+    /// @dev next GIF release version to be released
     function getNextVersion() external view returns (VersionPart) {
         return _releaseManager.getNextVersion();
     }
@@ -253,6 +234,10 @@ contract Registry is
         return _registryNftId;
     }
 
+    function getProtocolNftId() external view returns (NftId nftId) {
+        return _protocolNftId;
+    }
+
     function getNftId(address object) external view returns (NftId id) {
         return _nftIdByAddress[object];
     }
@@ -290,12 +275,14 @@ contract Registry is
         return _info[objectParentNftId].objectType == INSTANCE();
     }
 
-    function isValidRelease(VersionPart version) external view returns (bool)
+    function isActiveRelease(VersionPart version) external view returns (bool)
     {
-        return _releaseManager.isValidRelease(version);
+        return _releaseManager.isActiveRelease(version);
     }
 
     function getStakingAddress() external view returns (address staking) {
+        //return getObjectInfo(_stakingNftId).objectAddress;
+        //return _info[_stakingNftId].objectAddress;
         return _stakingAddress;
     }
 
@@ -308,7 +295,7 @@ contract Registry is
         VersionPart releaseVersion
     ) external view returns (address service)
     {
-            service =  _service[releaseVersion][serviceDomain]; 
+        service =  _service[releaseVersion][serviceDomain]; 
     }
 
     function getReleaseAccessManagerAddress(VersionPart version) external view returns (address) {
@@ -323,6 +310,14 @@ contract Registry is
         return address(_chainNft);
     }
 
+    function getRegistryAdminAddress() external view returns (address) {
+        return address(_admin);
+    }
+
+    function getAuthority() external view returns (address) {
+        return _admin.authority();
+    }
+
     function getOwner() public view returns (address owner) {
         return ownerOf(address(this));
     }
@@ -408,7 +403,7 @@ contract Registry is
         address parentObjectAddress
     )
         internal 
-        view 
+        pure 
         returns (address interceptor) 
     {
         // no intercepting calls for stakes
@@ -436,9 +431,10 @@ contract Registry is
     /// @dev protocol registration used to anchor the dip ecosystem relations
     function _registerProtocol() 
         private
+        returns (NftId protocolNftId)
     {
         uint256 protocolId = _chainNft.PROTOCOL_NFT_ID();
-        NftId protocolNftId = NftIdLib.toNftId(protocolId);
+        protocolNftId = NftIdLib.toNftId(protocolId);
 
         _info[protocolNftId] = ObjectInfo({
             nftId: protocolNftId,
@@ -470,7 +466,7 @@ contract Registry is
         }
         else 
         {// we are global registry
-            parentNftId = NftIdLib.toNftId(_chainNft.PROTOCOL_NFT_ID());
+            parentNftId = _protocolNftId;
         }
 
         _info[registryNftId] = ObjectInfo({
@@ -482,8 +478,8 @@ contract Registry is
             initialOwner: NFT_LOCK_ADDRESS,
             data: "" 
         });
-        _nftIdByAddress[address(this)] = registryNftId;
 
+        _nftIdByAddress[address(this)] = registryNftId;
         _chainNft.mint(NFT_LOCK_ADDRESS, registryId);
     }
 
@@ -506,13 +502,36 @@ contract Registry is
 
         _chainNft.mint(NFT_LOCK_ADDRESS, globalRegistryId);
     }
+    // depends on _registryNftId and _stakingAddress
+    function _registerStaking()
+        private
+        returns (NftId stakingNftId)
+    {
+        address stakingOwner = IRegisterable(_stakingAddress).getOwner();
+        uint256 stakingId = _chainNft.calculateTokenId(STAKING_TOKEN_SEQUENCE_ID);
+        stakingNftId = NftIdLib.toNftId(stakingId);
+
+        _info[stakingNftId] = ObjectInfo({
+            nftId: stakingNftId,
+            parentNftId: _registryNftId,
+            objectType: STAKING(),
+            isInterceptor: false,
+            objectAddress: _stakingAddress, 
+            initialOwner: stakingOwner,
+            data: "" 
+        });
+
+        _nftIdByAddress[_stakingAddress] = stakingNftId;
+        // reverts if nftId was already minted
+        _chainNft.mint(stakingOwner, stakingId);
+    }
 
     /// @dev defines which object - parent types relations are allowed to register
     // IMPORTANT: 
     // 1) EACH object type MUST have only one parent type across ALL mappings
     // 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"
+    // 2) DO NOT use PROTOCOL and "ObjectTypeLib.zero"
     function _setupValidCoreTypesAndCombinations() 
         private 
     {