@etherisc/gif-next 0.0.2-f1f3b2c-994 → 0.0.2-f2273b3-211

package/contracts/registry/RegistryService.sol

@@ -18,8 +18,6 @@ contract RegistryService is
     Service,
     IRegistryService
 {
-    using NftIdLib for NftId;
-
     // TODO update to real hash when registry is stable
     bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
 
@@ -35,11 +33,11 @@ contract RegistryService is
         initializer()
     {
         (
-            address registryAddress,
-            address initialAuthority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, initialAuthority, owner);
+        __Service_init(authority, registry, owner);
         _registerInterface(type(IRegistryService).interfaceId);
     }
 
@@ -60,7 +58,7 @@ contract RegistryService is
     function registerInstance(IRegisterable instance, address owner)
         external
         virtual
-        restricted
+        restricted()
         returns(
             IRegistry.ObjectInfo memory info
         ) 
@@ -75,29 +73,33 @@ contract RegistryService is
         instance.linkToRegisteredNftId(); // asume safe
     }
 
-    // function registerProduct(IComponent product, address owner)
-    //     external
-    //     restricted
-    //     returns(
-    //         IRegistry.ObjectInfo memory info
-    //     ) 
-    // {
-    //     // CAN revert if no ERC165 support -> will revert with empty message 
-    //     if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
-    //         revert ErrorRegistryServiceNotProduct(address(product));
-    //     }
-
-    //     info = _getAndVerifyContractInfo(product, PRODUCT(), owner);
-    //     info.nftId = getRegistry().register(info);
-    // }
-
-    function registerComponent(
+    function registerProduct(
+        IComponent product, 
+        address initialOwner
+    )
+        external
+        virtual
+        restricted()
+        returns(
+            IRegistry.ObjectInfo memory info
+        ) 
+    {
+        if(!product.supportsInterface(type(IProductComponent).interfaceId)) {
+            revert ErrorRegistryServiceNotProduct(address(product));
+        }
+
+        info = _getAndVerifyContractInfo(product, PRODUCT(), initialOwner);
+        info.nftId = getRegistry().register(info);
+    }
+
+    function registerProductLinkedComponent(
         IComponent component, 
         ObjectType objectType,
         address initialOwner
     )
         external
-        restricted
+        virtual
+        restricted()
         returns(
             IRegistry.ObjectInfo memory info
         ) 
@@ -107,43 +109,18 @@ contract RegistryService is
             revert ErrorRegistryServiceNotComponent(address(component));
         }
 
+        if (!(objectType == DISTRIBUTION() || objectType == ORACLE() || objectType == POOL())) {
+            revert ErrorRegistryServiceNotProductLinkedComponent(address(component));
+        }
+
         info = _getAndVerifyContractInfo(component, objectType, initialOwner);
         info.nftId = getRegistry().register(info);
     }
 
-    // function registerPool(IComponent pool, address owner)
-    //     external
-    //     restricted
-    //     returns(
-    //         IRegistry.ObjectInfo memory info
-    //     ) 
-    // {
-    //     if(!pool.supportsInterface(type(IPoolComponent).interfaceId)) {
-    //         revert ErrorRegistryServiceNotPool(address(pool));
-    //     }
-
-    //     info = _getAndVerifyContractInfo(pool, POOL(), owner);
-    //     info.nftId = getRegistry().register(info);
-    // }
-
-    // function registerDistribution(IComponent distribution, address owner)
-    //     external
-    //     restricted
-    //     returns(
-    //         IRegistry.ObjectInfo memory info
-    //     ) 
-    // {
-    //     if(!distribution.supportsInterface(type(IDistributionComponent).interfaceId)) {
-    //         revert ErrorRegistryServiceNotDistribution(address(distribution));
-    //     }
-
-    //     info = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
-    //     info.nftId = getRegistry().register(info);
-    // }
-
     function registerDistributor(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, DISTRIBUTOR());
@@ -152,7 +129,8 @@ contract RegistryService is
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, POLICY());
@@ -161,7 +139,8 @@ contract RegistryService is
 
     function registerBundle(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, BUNDLE());
@@ -170,7 +149,8 @@ contract RegistryService is
 
     function registerStake(IRegistry.ObjectInfo memory info)
         external
-        restricted 
+        virtual
+        restricted()
         returns(NftId nftId) 
     {
         _verifyObjectInfo(info, STAKE());
@@ -185,6 +165,7 @@ contract RegistryService is
         address expectedOwner // assume can be 0 when given by other service
     )
         internal
+        virtual
         view
         returns(
             IRegistry.ObjectInfo memory info 
@@ -224,6 +205,7 @@ contract RegistryService is
         ObjectType expectedType
     )
         internal
+        virtual
         view
     {
         if(info.objectAddress > address(0)) {

package/contracts/registry/RegistryServiceManager.sol

@@ -31,7 +31,7 @@ contract RegistryServiceManager is
         }
         
         RegistryService srv = new RegistryService{ salt: salt }();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(srv), 

package/contracts/registry/ReleaseAdmin.sol

@@ -0,0 +1,245 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {IAccess} from "../authorization/IAccess.sol";
+import {IService} from "../shared/IService.sol";
+import {IServiceAuthorization} from "../authorization/IServiceAuthorization.sol";
+import {ObjectType, ObjectTypeLib, ALL} from "../type/ObjectType.sol";
+import {RoleId, RoleIdLib, ADMIN_ROLE, RELEASE_REGISTRY_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {VersionPart} from "../type/Version.sol";
+
+/// @dev The ReleaseAdmin contract implements the central authorization for the services of a specific release.
+/// There is one ReleaseAdmin contract per major GIF release.
+/// Locking/unlocking of all services of a release is implemented in function setReleaseLocked.
+contract ReleaseAdmin is
+    AccessAdmin
+{
+    event LogReleaseAdminReleaseLockChanged(VersionPart release, bool locked);
+    event LogReleaseAdminServiceLockChanged(VersionPart release, address service, bool locked);
+
+    error ErrorReleaseAdminCallerNotReleaseRegistry(address caller);
+    error ErrorReleaseAdminNotService(address notService);
+    error ErrorReleaseAdminReleaseLockAlreadySetTo(bool locked);
+
+    /// @dev release core roles
+    string public constant RELEASE_REGISTRY_ROLE_NAME = "ReleaseRegistryRole";
+
+    /// @dev release core targets
+    string public constant RELEASE_ADMIN_TARGET_NAME = "ReleaseAdmin";
+
+
+    modifier onlyReleaseRegistry() {
+        (bool isMember, ) = _authority.hasRole(RELEASE_REGISTRY_ROLE().toInt(), msg.sender);
+        if(!isMember) {
+            revert ErrorReleaseAdminCallerNotReleaseRegistry(msg.sender);
+        }
+        _;
+    }
+
+    /// @dev Only used for master release admin.
+    /// Contracts created via constructor come with disabled initializers.
+    constructor() {
+        initialize(new AccessManagerCloneable());
+        _disableInitializers();
+    }
+
+    function completeSetup(
+        address registry,
+        address releaseRegistry,
+        VersionPart release
+    )
+        external
+        reinitializer(uint64(release.toInt()))
+    {
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
+
+        _setupReleaseRegistry(releaseRegistry);
+    }
+
+    /// @dev Sets up authorizaion for specified service.
+    /// For all authorized services its authorized functions are enabled.
+    /// Permissioned function: Access is restricted to release registry.
+    function authorizeService(
+        IServiceAuthorization serviceAuthorization,
+        IService service,
+        ObjectType serviceDomain,
+        VersionPart releaseVersion
+    )
+        external
+        restricted()
+    {
+        _createServiceTargetAndRole(service, serviceDomain, releaseVersion);
+        _authorizeServiceFunctions(serviceAuthorization, service, serviceDomain, releaseVersion);
+    }
+
+    /// @dev Locks/unlocks all release targets.
+    /// For all authorized services of release its authorized functions are disabled/enabled.
+    /// Permissioned function: Access is restricted to release registry.
+    /// Note: onlyReleaseRegistry() modifier is used to prevent dead lock.
+    function setReleaseLocked(bool locked)
+        external
+        onlyReleaseRegistry()
+    {
+        // checks
+        AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+        if(accessManager.isLocked() == locked) {
+            revert ErrorReleaseAdminReleaseLockAlreadySetTo(locked);
+        }
+
+        // effects
+        accessManager.setLocked(locked);
+
+        emit LogReleaseAdminReleaseLockChanged(getRelease(), locked);
+    }
+
+    /// @dev Lock/unlock specific service of release.
+    /// Permissioned function: Access is restricted to release registry.
+    function setServiceLocked(IService service, bool locked)
+        external
+        restricted()
+    {
+        // assume all targets except release admin are services
+        // ensure release admin can not be locked
+        if(address(service) == address(this)) {
+            revert ErrorReleaseAdminNotService(address(service));
+        }
+
+        _setTargetClosed(address(service), locked);
+
+        emit LogReleaseAdminServiceLockChanged(service.getRelease(), address(service), locked);
+    }
+
+    //--- view functions ----------------------------------------------------//
+
+/*
+    function getReleaseAdminRole() external view returns (RoleId) {
+        return GIF_ADMIN_ROLE();
+    }
+*/
+    //--- private functions -------------------------------------------------//
+
+    function _createServiceTargetAndRole(
+        IService service, 
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    )
+        private
+    {
+        string memory baseName = ObjectTypeLib.toName(serviceDomain);
+        uint256 versionInt = releaseVersion.toInt();
+
+        // create service target
+        string memory serviceTargetName = ObjectTypeLib.toVersionedName(
+            baseName, "Service", versionInt);
+
+        _createTarget(
+            address(service), 
+            serviceTargetName,
+            true,
+            false);
+
+        // create service role
+        RoleId serviceRoleId = RoleIdLib.roleForTypeAndVersion(
+            serviceDomain, 
+            releaseVersion);
+
+        if(!roleExists(serviceRoleId)) {
+            _createRole(
+                serviceRoleId, 
+                toRole({
+                    adminRoleId: ADMIN_ROLE(),
+                    roleType: RoleType.Contract,
+                    maxMemberCount: 1,
+                    name: ObjectTypeLib.toVersionedName(
+                        baseName, 
+                        "ServiceRole", 
+                        versionInt)}));
+        }
+
+        _grantRoleToAccount( 
+            serviceRoleId,
+            address(service)); 
+    }
+
+
+    function _authorizeServiceFunctions(
+        IServiceAuthorization serviceAuthorization,
+        IService service,
+        ObjectType serviceDomain, 
+        VersionPart releaseVersion
+    )
+        private
+    {
+        ObjectType authorizedDomain;
+        RoleId authorizedRoleId;
+
+        ObjectType[] memory authorizedDomains = serviceAuthorization.getAuthorizedDomains(serviceDomain);
+
+        for (uint256 i = 0; i < authorizedDomains.length; i++) {
+            authorizedDomain = authorizedDomains[i];
+
+            // derive authorized role from authorized domain
+            if (authorizedDomain == ALL()) {
+                authorizedRoleId = PUBLIC_ROLE();
+            } else {
+                authorizedRoleId = RoleIdLib.roleForTypeAndVersion(
+                authorizedDomain, 
+                releaseVersion);
+            }
+
+            if(!roleExists(authorizedRoleId)) {
+                // create role for authorized domain
+                _createRole(
+                    authorizedRoleId, 
+                    toRole({
+                        adminRoleId: ADMIN_ROLE(),
+                        roleType: RoleType.Contract,
+                        maxMemberCount: 1,
+                        name: ObjectTypeLib.toVersionedName(
+                            ObjectTypeLib.toName(authorizedDomain), 
+                            "Role", 
+                            releaseVersion.toInt())}));
+            }
+
+            // get authorized functions for authorized domain
+            IAccess.FunctionInfo[] memory authorizatedFunctions = serviceAuthorization.getAuthorizedFunctions(
+                serviceDomain, 
+                authorizedDomain);
+
+            _authorizeTargetFunctions(
+                    address(service), 
+                    authorizedRoleId, 
+                    authorizatedFunctions);
+        }
+    }
+
+    //--- private initialization functions -------------------------------------------//
+
+    function _setupReleaseRegistry(address releaseRegistry)
+        private 
+        onlyInitializing()
+    {
+        _createTarget(address(this), RELEASE_ADMIN_TARGET_NAME, false, false);
+
+        _createRole(
+            RELEASE_REGISTRY_ROLE(), 
+            toRole({
+                adminRoleId: ADMIN_ROLE(),
+                roleType: RoleType.Contract,
+                maxMemberCount: 1,
+                name: RELEASE_REGISTRY_ROLE_NAME}));
+
+        FunctionInfo[] memory functions;
+        functions = new FunctionInfo[](2);
+        functions[0] = toFunction(ReleaseAdmin.authorizeService.selector, "authorizeService");
+        functions[1] = toFunction(ReleaseAdmin.setServiceLocked.selector, "setServiceLocked");
+        _authorizeTargetFunctions(address(this), RELEASE_REGISTRY_ROLE(), functions);
+
+        _grantRoleToAccount(RELEASE_REGISTRY_ROLE(), releaseRegistry);
+    }
+}

package/contracts/registry/ReleaseLifecycle.sol

@@ -5,6 +5,8 @@ import {RELEASE} from "../type/ObjectType.sol";
 import {SCHEDULED, DEPLOYING, DEPLOYED, SKIPPED, ACTIVE, PAUSED, CLOSED} from "../type/StateId.sol";
 import {Lifecycle} from "../shared/Lifecycle.sol";
 
+/// @dev Release lifeycle state machine.
+/// Helper contract for ReleaseRegistry.
 contract ReleaseLifecycle is
     Lifecycle
 {