@etherisc/gif-next 0.0.2-fbe8e04-715 → 0.0.2-fca9315-260

package/contracts/registry/ReleaseManager.sol

@@ -0,0 +1,332 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
+
+import {NftId} from "../types/NftId.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {ObjectType, ObjectTypeLib, zeroObjectType, REGISTRY, SERVICE} from "../types/ObjectType.sol";
+import {VersionPart, VersionPartLib} from "../types/Version.sol";
+import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
+
+import {IService} from "../shared/IService.sol";
+
+import {IRegistry} from "./IRegistry.sol";
+import {Registry} from "./Registry.sol";
+import {IRegistryService} from "./IRegistryService.sol";
+import {RegistryAccessManager} from "./RegistryAccessManager.sol";
+
+
+contract ReleaseManager is AccessManaged
+{
+    using ObjectTypeLib for ObjectType;
+
+    event LogReleaseCreation(VersionPart version); 
+    event LogReleaseActivation(VersionPart version);
+
+    // createNextRelease
+    error NotRegistryService();
+    error UnexpectedServiceAuthority(address expected, address found);
+
+    // registerService
+    error NotService();
+
+    // activateNextRelease
+    error ReleaseNotCreated();
+    error ReleaseRegistrationNotFinished();
+
+    // _getAndVerifyContractInfo
+    error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
+    error NotRegisterableOwner(address notOwner);
+    error SelfRegistration();
+    error RegisterableOwnerIsRegistered();
+
+    // _verifyServiceInfo
+    error UnexpectedServiceVersion(VersionPart expected, VersionPart found);
+    error UnexpectedServiceDomain(ObjectType expected, ObjectType found);
+    
+    // _verifyAndStoreConfig
+    error ConfigMissing();
+    error ConfigServiceDomainInvalid(uint configArrayIndex, ObjectType domain);
+    error ConfigSelectorZero(uint configArrayIndex);
+    error SelectorAlreadyExists(VersionPart releaseVersion, ObjectType serviceDomain);
+
+
+    RegistryAccessManager private immutable _accessManager;
+    IRegistry private immutable _registry;
+
+    VersionPart immutable _initial;// first active version    
+    VersionPart _latest;// latest active version
+    VersionPart _next;// version to create and activate 
+
+    mapping(VersionPart version => IRegistry.ReleaseInfo info) _release;
+
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => bytes4)) _selector; // registry service function selector assigned to domain 
+
+    uint _awaitingRegistration; // "services left to register" counter
+
+    mapping(address registryService => bool isActive) _active;
+
+    mapping(VersionPart version => bool isValid) _valid; // TODO refactor to use _active only
+
+    constructor(
+        RegistryAccessManager accessManager, 
+        VersionPart initialVersion)
+        AccessManaged(accessManager.authority())
+    {
+        require(initialVersion.toInt() > 0, "ReleaseManager: initial version is 0");
+
+        _accessManager = accessManager;
+
+        _initial = initialVersion;
+        _next = initialVersion;
+
+        _registry = new Registry();
+    }
+
+    /// @dev skips previous release if was not activated
+    function createNextRelease()
+        external
+        restricted // GIF_ADMIN_ROLE
+    {
+        // allow to register new registry service for next version
+        VersionPartLib.toVersionPart(_next.toInt() + 1);
+        // disallow registration of regular services for next version while registry service is not registered 
+        _awaitingRegistration = 0;
+
+        emit LogReleaseCreation(_next); 
+    }
+
+    function activateNextRelease() 
+        external 
+        restricted // GIF_ADMIN_ROLE
+    {
+        VersionPart version = _next;
+        address service = _registry.getServiceAddress(REGISTRY(), version);
+
+        // release was created
+        if(service == address(0)) {
+            revert ReleaseNotCreated();
+        }
+
+        // release fully deployed
+        if(_awaitingRegistration > 0) {
+            revert ReleaseRegistrationNotFinished();
+        }
+
+        //setTargetClosed(service, false);
+
+        _latest = version;
+
+        _active[service] = true;
+        _valid[version] = true;
+
+        emit LogReleaseActivation(version);
+    }
+
+    // TODO deploy proxy and initialize with given implementation instead of using given proxy?
+    // IMPORTANT: MUST never be possible to create with access/release manager, token registry
+    // callable once per release after release creation, can not register regular services while registry service is not registered
+    function registerRegistryService(IRegistryService service)
+        external
+        restricted // GIF_MANAGER_ROLE
+        returns(NftId nftId)
+    {
+        if(!service.supportsInterface(type(IRegistryService).interfaceId)) {
+            revert NotRegistryService();
+        }
+
+        // TODO unreliable! MUST guarantee the same authority -> how?
+        address serviceAuthority = service.authority();
+        if(serviceAuthority != authority()) {
+            revert UnexpectedServiceAuthority(
+                authority(), 
+                serviceAuthority); 
+        }
+
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+
+        VersionPart version = _next;
+        ObjectType domain = REGISTRY();
+        _verifyServiceInfo(info, version, domain);
+
+        // data: config bytes
+        _createRelease(service.getFunctionConfigs());
+
+        //setTargetClosed(service, true);
+        
+        nftId = _registry.registerService(info, version, domain);
+
+        // external call
+        service.linkToRegisteredNftId();
+    }
+
+    // TODO adding service to release -> synchronized with proxy upgrades or simple addServiceToRelease(service, version, selector)?
+    // TODO removing service from release? -> set _active to false forever, but keep all other records?
+    function registerService(IService service) 
+        external
+        restricted // GIF_MANAGER_ROLE
+        returns(NftId nftId)
+    {
+        if(!service.supportsInterface(type(IService).interfaceId)) {
+            revert NotService();
+        }
+
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+        VersionPart version = getNextVersion();
+        ObjectType domain = _release[version].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
+        _verifyServiceInfo(info, version, domain);
+
+        // setup and grant unique role if service does registrations
+        bytes4[] memory selector = new bytes4[](1);
+        selector[0] = _selector[version][domain];
+        address registryService = _registry.getServiceAddress(REGISTRY(), version);
+        if(selector[0] != 0) {
+            _accessManager.setAndGrantUniqueRole(
+                address(service), 
+                registryService, 
+                selector);
+        }
+        
+        _awaitingRegistration--;
+
+        nftId = _registry.registerService(info, version, domain);
+
+        // external call
+        service.linkToRegisteredNftId(); 
+    }
+
+    //--- view functions ----------------------------------------------------//
+
+    function isActiveRegistryService(address service) external view returns(bool)
+    {
+        return _active[service];
+    }
+
+    function isValidRelease(VersionPart version) external view returns(bool)
+    {
+        return _valid[version];
+    }
+
+    function getRegistry() external view returns(address)
+    {
+        return (address(_registry));
+    }
+
+    function getReleaseInfo(VersionPart version) external view returns(IRegistry.ReleaseInfo memory)
+    {
+        return _release[version];
+    }
+
+    function getNextVersion() public view returns(VersionPart) 
+    {
+        return _next;
+    }
+
+    function getLatestVersion() external view returns(VersionPart) {
+        return _latest;
+    }
+
+    function getInitialVersion() external view returns(VersionPart) {
+        return _initial;
+    }
+
+    //--- private functions ----------------------------------------------------//
+
+    function _getAndVerifyContractInfo(
+        IService service,
+        ObjectType expectedType,
+        address expectedOwner // assume always valid, can not be 0
+    )
+        internal
+        // view
+        returns(
+            IRegistry.ObjectInfo memory info
+        )
+    {
+        info = service.getInitialInfo();
+        info.objectAddress = address(service);
+        info.isInterceptor = false; // service is never interceptor, at least now
+
+        if(info.objectType != expectedType) {// type is checked in registry anyway...but service logic may depend on expected value
+            revert UnexpectedRegisterableType(expectedType, info.objectType);
+        }
+
+        address owner = info.initialOwner;
+
+        if(owner != expectedOwner) { // registerable owner protection
+            revert NotRegisterableOwner(expectedOwner); 
+        }
+
+        if(owner == address(service)) {
+            revert SelfRegistration();
+        }
+        
+        if(_registry.isRegistered(owner)) { 
+            revert RegisterableOwnerIsRegistered(); 
+        }
+    }
+
+    function _verifyServiceInfo(
+        IRegistry.ObjectInfo memory info,
+        VersionPart expectedVersion,
+        ObjectType expectedDomain
+    )
+        internal
+        view
+        returns(ObjectType)
+    {
+        (
+            ObjectType domain,
+            VersionPart version
+        ) = abi.decode(info.data, (ObjectType, VersionPart));
+
+        if(version != expectedVersion) {
+            revert UnexpectedServiceVersion(expectedVersion, version);
+        }
+
+        if(domain != expectedDomain) {
+            revert UnexpectedServiceDomain(expectedDomain, domain);
+        }
+
+        return domain;
+    }
+
+    // TODO check if registry supports types specified in the config array
+    function _createRelease(IRegistryService.FunctionConfig[] memory config)
+        internal
+    {
+        VersionPart version = getNextVersion();
+
+        if(config.length == 0) {
+            revert ConfigMissing();
+        }
+        // always in release
+        _release[version].domains.push(REGISTRY());
+        for(uint idx = 0; idx < config.length; idx++)
+        {
+            ObjectType domain = config[idx].serviceDomain;
+            bytes4 selector = config[idx].selector;
+
+            // not "registry service" / zero domain
+            if(
+                domain == REGISTRY() ||
+                domain.eqz()
+            ) { revert ConfigServiceDomainInvalid(idx, domain); } 
+
+            // TODO can be zero -> e.g. duplicate domain, first with zero selector, second with non zero selector -> need to check _release[version].domains.contains(domain) instead
+            // no overwrite
+            if(_selector[version][domain] > 0) {
+                revert SelectorAlreadyExists(version, domain); 
+            }
+            
+            _selector[version][domain] = selector;
+            _release[version].domains.push(domain);
+        }
+        // TODO set when activated?
+        _release[version].createdAt = TimestampLib.blockTimestamp();
+        //_release[version].updatedAt = TimestampLib.blockTimestamp();
+
+        _awaitingRegistration = config.length;
+    }
+}

package/contracts/registry/TokenRegistry.sol

@@ -6,16 +6,14 @@ import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165C
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IRegistry} from "./IRegistry.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
+import {VersionPart} from "../types/Version.sol";
+import {REGISTRY} from "../types/ObjectType.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 
 /// @title contract to register token per GIF major release.
 contract TokenRegistry is
     NftOwnable
 {
-
-    string public constant REGISTRY_SERVICE_NAME = "RegistryService";
-
     event LogRegistered(address token, string symbol, uint256 decimals);
     event LogTokenStateSet(address token, VersionPart majorVersion, bool active);
 
@@ -34,12 +32,15 @@ contract TokenRegistry is
 
 
     /// @dev link ownership of token registry to nft owner of registry service
+    // TODO latter registry service will get new release, new address, new nft, TokenRegistry will not catch that -> use AccessManaged only for services
     function linkToNftOwnable(address registryAddress) 
         external
         onlyOwner
     {
         IRegistry registry = IRegistry(registryAddress);
-        address registryServiceAddress = registry.getServiceAddress(REGISTRY_SERVICE_NAME, registry.getMajorVersion());
+        // TODO use _latest instead of _initial -> but _latest is 0 before first release activation
+        address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getNextVersion());
+        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getInitialVersion());
 
         _linkToNftOwnable(registryAddress, registryServiceAddress);
     }
@@ -59,7 +60,7 @@ contract TokenRegistry is
         // verify valid major version
         // ensure major version increments is one
         uint256 version = majorVersion.toInt();
-        if (version < _registry.getMajorVersionMin().toInt() || version > _registry.getMajorVersionMax().toInt()) {
+        if (!_registry.isValidRelease(majorVersion)) {
             revert TokenMajorVersionInvalid(majorVersion);
         }
 
@@ -80,7 +81,7 @@ contract TokenRegistry is
         return _registered[token];
     }
 
-     function isActive(address token, VersionPart majorVersion) external view returns (bool) {
+    function isActive(address token, VersionPart majorVersion) external view returns (bool) {
         return _active[token][majorVersion];
     }
 

package/contracts/shared/IRegisterable.sol

@@ -5,13 +5,11 @@ import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
 
 interface IRegisterable is IERC165, INftOwnable {
 
     function getInitialInfo() 
         external 
         view
-        returns (IRegistry.ObjectInfo memory, bytes memory data);
+        returns (IRegistry.ObjectInfo memory);
 }

package/contracts/shared/IService.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.19;
 
 import {VersionPart} from "../types/Version.sol";
+import {ObjectType} from "../types/ObjectType.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
@@ -10,6 +11,6 @@ interface IService is
     IRegisterable,
     IVersionable
 {
-    function getName() external pure returns(string memory name);
+    function getDomain() external pure returns(ObjectType serviceDomain);
     function getMajorVersion() external view returns(VersionPart majorVersion);
 }

package/contracts/shared/NftOwnable.sol

@@ -5,8 +5,10 @@ import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId, zeroNftId} from "../types/NftId.sol";
 
+// TODO make contract upgradeable
 contract NftOwnable is INftOwnable {
 
+    // TODO move vars to struct and add _getNftOwnableStorage
     IRegistry internal _registry;
     NftId private _nftId;
     address private _initialOwner; 
@@ -55,6 +57,9 @@ contract NftOwnable is INftOwnable {
         return _nftId;
     }
 
+    function getInitialOwner() public view returns (address) {
+        return _initialOwner;
+    }
 
     function getOwner() public view virtual override returns (address) {
         if (_nftId.gtz()) {

package/contracts/shared/ProxyManager.sol

@@ -38,6 +38,7 @@ contract ProxyManager is
         returns (IVersionable versionable)
     {
         if (_isDeployed) { revert ErrorAlreadyDeployed(); }
+        _isDeployed = true;
 
         address currentProxyOwner = getOwner(); // used by implementation
         address initialProxyAdminOwner = address(this); // used by proxy
@@ -49,7 +50,6 @@ contract ProxyManager is
             data
         );
 
-        _isDeployed = true;
         versionable = IVersionable(address(_proxy));
 
         emit LogProxyDeployed(address(_proxy), initialImplementation);

package/contracts/shared/Registerable.sol

@@ -71,20 +71,16 @@ contract Registerable is
         public 
         view 
         virtual 
-        returns (IRegistry.ObjectInfo memory, bytes memory data) 
+        returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage storage $ = _getRegisterableStorage();
-        return (
-            IRegistry.ObjectInfo(
-                getNftId(),
-                $._parentNftId,
-                $._objectType,
-                $._isInterceptor,
-                address(this), 
-                getOwner(),
-                $._data
-            ),
-            bytes("")
-        );
+        RegisterableStorage memory $ = _getRegisterableStorage();
+        info = IRegistry.ObjectInfo(
+            zeroNftId(),
+            $._parentNftId,
+            $._objectType,
+            $._isInterceptor,
+            address(this), 
+            getInitialOwner(),
+            $._data);
     }
 }

package/contracts/shared/Service.sol

@@ -1,21 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IService} from "./IService.sol";
-import {IVersionable} from "./IVersionable.sol";
+import {ObjectType, SERVICE} from "../types/ObjectType.sol";
 import {NftId, zeroNftId} from "../types/NftId.sol";
-import {RegisterableUpgradable} from "./RegisterableUpgradable.sol";
-import {SERVICE} from "../types/ObjectType.sol";
 import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+
+import {Versionable} from "./Versionable.sol";
+import {IService} from "./IService.sol";
+import {IVersionable} from "./IVersionable.sol";
 import {Versionable} from "./Versionable.sol";
+import {Registerable} from "./Registerable.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
 
 /// @dev service base contract
 abstract contract Service is 
-    RegisterableUpgradable,
+    Registerable,
+    Versionable,
     IService
 {
-    function getName() public pure virtual override returns(string memory name);
+    function getDomain() public pure virtual override returns(ObjectType);
 
     function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
         return getVersion().toMajorPart(); 
@@ -40,7 +45,7 @@ abstract contract Service is
         //onlyInitializing //TODO uncomment when "fully" upgradeable
     {
         // service must provide its name and version upon registration
-        bytes memory data = abi.encode(getName(), getMajorVersion());
+        bytes memory data = abi.encode(getDomain(), getMajorVersion());
         NftId registryNftId = _getRegistryNftId(registry); 
         bool isInterceptor = false;
 

package/contracts/test/TestService.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {ObjectType, PRODUCT} from "../../contracts/types/ObjectType.sol";
 import {NftId} from "../../contracts/types/NftId.sol";
 import {Version, VersionLib} from "../../contracts/types/Version.sol";
 import {Service} from "../../contracts/shared/Service.sol";
@@ -18,7 +19,7 @@ contract TestService is Service {
         _initializeService(registry, initialOwner);
     }
 
-    function getName() public pure override returns(string memory name) {
-        return NAME;
+    function getDomain() public pure override returns(ObjectType) {
+        return PRODUCT();
     }
 }

package/contracts/types/RoleId.sol

@@ -24,25 +24,23 @@ function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "Produc
 
 function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(0); }
 
-// TODO correct numbers (maybe they are already defined in RegistryService)
 function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(100); }
 function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(200); }
 function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(300); }
 function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(400); }
 
-function DISTRIBUTION_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1000); }
-function POLICY_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1100); }
-function BUNDLE_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1200); }
-function POOL_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1300); }
-function PRODUCT_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1400); }
 
-function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10000); }
-function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10100); }
-function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10200); }
-function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10300); }
-function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10400); }
+function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2000); }
+function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2100); }
+function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2200); }
+function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2300); }
+function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2400); }
+function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2500); }
 
-function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11000); }
+
+function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1500); } 
+function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1600); } 
+function RELEASE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); } 
 
 // @dev Returns true iff role ids a and b are identical
 function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-fbe8e04-715",
+  "version": "0.0.2-fca9315-260",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/components/BaseComponent.sol/BaseComponent.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/65b23548824c96d3a9cfdfbce93a388d.json"
-}

package/artifacts/contracts/components/IBaseComponent.sol/IBaseComponent.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/65b23548824c96d3a9cfdfbce93a388d.json"
-}

package/artifacts/contracts/instance/AccessManagerUpgradeableInitializeable.sol/AccessManagerUpgradeableInitializeable.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/65b23548824c96d3a9cfdfbce93a388d.json"
-}