@etherisc/gif-next 0.0.2-f626d92-602 → 0.0.2-f634e5c-828

package/contracts/registry/RegistryAccessManager.sol

@@ -1,216 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity ^0.8.20;
-
-import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
-import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
-
-import {RoleId, RoleIdLib,
-        GIF_MANAGER_ROLE,
-        GIF_ADMIN_ROLE,
-        RELEASE_MANAGER_ROLE} from "../types/RoleId.sol";
-
-import {TokenRegistry} from "./TokenRegistry.sol";
-import {ReleaseManager} from "./ReleaseManager.sol";
-
-/*
-    4 types of roles:
-    1) RELEASE_MANAGER_ROLE
-        - has only ReleaseManager as member
-        - responsible for setting and granting of REGISTRAR roles
-    1) REGISTRAR roles
-        - set and granted by RELEASE_MANAGER_ROLE
-        - each has 1 unique member (regular service ver.X) (subject to change)
-        - each set to 1 target (registry service ver.X) and 1 selector (function of registry service ver.X) (subject to change)
-    2) GIF_MANAGER_ROLE
-        - can have arbitrary number of members
-        - responsible for services registrations
-        - responsible for token registration and activation
-    3) GIF_ADMIN_ROLE
-        - admin of GIF_MANAGER_ROLE
-        - MUST have 1 member at any time
-        - granted/revoked ONLY in transferAdminRole() -> consider lock out situations!!!
-        - responsible for creation and activation of releases
-
-*/
-
-contract RegistryAccessManager is AccessManaged
-{
-    error NotInitialized();
-    error AlreadyInitialized();
-
-    uint64 public constant UNIQUE_ROLE_ID_MIN = 1000000;
-    
-    AccessManager private immutable _accessManager;
-    address private _releaseManager;
-    address private _tokenRegistry;
-
-    uint64 private _idNext; // role id
-    bool private _isInitialized;
-
-    modifier onlyOnce() {
-        if(_isInitialized) {
-            revert AlreadyInitialized();
-        } 
-        _;
-        _isInitialized = true;
-    }
-
-    modifier onlyInitialized() {
-        if(!_isInitialized) {
-            revert NotInitialized();
-        }
-        _;
-    }
-
-    constructor(address manager)
-        AccessManaged(msg.sender)
-    {
-        _accessManager = new AccessManager(address(this));
-        setAuthority(address(_accessManager));
-
-        _idNext = UNIQUE_ROLE_ID_MIN;
-
-        _configureAdminRoleInitial();
-
-        address admin = msg.sender;
-        _grantRole(GIF_ADMIN_ROLE(), admin, 0);
-        _grantRole(GIF_MANAGER_ROLE(), manager, 0);
-    }
-
-    function initialize(address releaseManager, address tokenRegistry)
-        external 
-        restricted // GIF_ADMIN_ROLE
-        onlyOnce
-    {
-        require(
-            ReleaseManager(releaseManager).authority() == address(_accessManager),
-            "RegistryAccessManager: release manager authority is invalid");
-        require(tokenRegistry > address(0), "RegistryAccessManager: token registry is 0");
-        //require(tokenRegistry.authority() == address(_accessManager));
-
-        _releaseManager = releaseManager;
-        _tokenRegistry = tokenRegistry;
-
-        _configureAdminRole();
-        _configureManagerRole();
-        _configureReleaseManagerRole();
-
-        _grantRole(RELEASE_MANAGER_ROLE(), releaseManager, 0);
-    }
-
-    // set unique role for target, role forever have 1 member and never revoked
-    function setAndGrantUniqueRole(
-        address account, 
-        address target, 
-        bytes4[] memory selector
-    )
-        external
-        restricted // RELEASE_MANAGER_ROLE
-        onlyInitialized
-        returns(RoleId)
-    {
-        // TODO questionable check...
-        // target is not part of `runtime`
-        //if(
-        //    target == address(this) ||
-        //    target == address(_accessManager) || 
-        //    target == _releaseManager || 
-        //    target == _tokenRegistry)
-        //{ return TargetInvalid(); }
-
-        RoleId roleId = _getNextRoleId();
-
-        _setTargetFunctionRole(target, selector, roleId);
-        _grantRole(roleId, account, 0);
-    }
-
-    /*function transferAdmin(address to)
-        external
-        restricted // only with GIF_ADMIN_ROLE or nft owner
-    {
-        _accessManager.revoke(GIF_ADMIN_ROLE, );
-        _accesssManager.grant(GIF_ADMIN_ROLE, to, 0);
-    }*/
-
-    //--- view functions ----------------------------------------------------//
-
-    function getAccessManager()
-        external
-        view
-        returns (AccessManager)
-    {
-        return _accessManager;
-    }
-
-    //--- private functions -------------------------------------------------//
-
-    function _configureAdminRoleInitial() private
-    {
-        bytes4[] memory functionSelector = new bytes4[](1);
-
-        functionSelector[0] = RegistryAccessManager.initialize.selector;
-        _setTargetFunctionRole(address(this), functionSelector, GIF_ADMIN_ROLE());
-    }
-
-    function _configureAdminRole() private
-    {
-        bytes4[] memory functionSelector = new bytes4[](1);
-
-        // for RegistryServiceProxyManager
-        // TODO upgrading with releaseManager.upgrade()->proxy.upgrade()???
-        //functionSelector[0] = RegistryServiceManager.upgrade.selector;
-        //_setTargetFunctionRole(address(this), functionSelector, GIF_ADMIN_ROLE());
-
-        // for TokenRegistry
-
-        // for ReleaseManager
-        functionSelector[0] = ReleaseManager.createNextRelease.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_ADMIN_ROLE());
-
-        functionSelector[0] = ReleaseManager.activateNextRelease.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_ADMIN_ROLE());
-    }
-    
-    function _configureManagerRole() private 
-    {
-        bytes4[] memory functionSelector = new bytes4[](1);
-
-        // for TokenRegistry
-        functionSelector[0] = TokenRegistry.setActive.selector;
-        _setTargetFunctionRole(address(_tokenRegistry), functionSelector, GIF_MANAGER_ROLE());
-
-        // for ReleaseManager
-        functionSelector[0] = ReleaseManager.registerService.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
-
-        functionSelector[0] = ReleaseManager.registerRegistryService.selector;
-        _setTargetFunctionRole(_releaseManager, functionSelector, GIF_MANAGER_ROLE());
-
-        // set admin
-        _setRoleAdmin(GIF_MANAGER_ROLE(), GIF_ADMIN_ROLE());
-    }
-
-    function _configureReleaseManagerRole() private
-    {
-        bytes4[] memory functionSelector = new bytes4[](1);
-
-        functionSelector[0] = RegistryAccessManager.setAndGrantUniqueRole.selector;
-        _setTargetFunctionRole(address(this), functionSelector, RELEASE_MANAGER_ROLE());
-    }
-
-    function _setTargetFunctionRole(address target, bytes4[] memory selectors, RoleId roleId) private {
-        _accessManager.setTargetFunctionRole(target, selectors, roleId.toInt());        
-    }
-
-    function _setRoleAdmin(RoleId roleId, RoleId adminRoleId) private {
-        _accessManager.setRoleAdmin(roleId.toInt(), adminRoleId.toInt());
-    }
-
-    function _grantRole(RoleId roleId, address account, uint32 executionDelay) private {
-            _accessManager.grantRole(roleId.toInt(), account, executionDelay);
-    }
-
-    function _getNextRoleId() private returns(RoleId roleId) {
-        roleId = RoleIdLib.toRoleId(_idNext++);
-    }
-}

package/contracts/registry/ReleaseManager.sol

@@ -1,324 +0,0 @@
-// 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 {Version, VersionLib, 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();
-
-    // _verifyService
-    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 major version    
-    VersionPart _latest;// latest active major version
-    VersionPart _next;// major version to create and activate 
-
-    mapping(VersionPart majorVersion => IRegistry.ReleaseInfo info) _release;
-
-    mapping(VersionPart majorVersion => mapping(ObjectType serviceDomain => bytes4[])) _selectors; // registry service function selector assigned to domain 
-
-    uint _awaitingRegistration; // "services left to register" counter
-
-    mapping(address registryService => bool isActive) _active;
-
-    mapping(VersionPart majorVersion => 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 majorVersion = _next;
-        ObjectType domain = REGISTRY();
-        _verifyService(service, majorVersion, domain);
-        _createRelease(service.getFunctionConfigs());
-        
-        nftId = _registry.registerService(info, majorVersion, 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 majorVersion = getNextVersion();
-        ObjectType domain = _release[majorVersion].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
-        _verifyService(service, majorVersion, domain);
-
-        // setup and grant unique role if service does registrations
-        bytes4[] memory selectors = _selectors[majorVersion][domain];
-        address registryService = _registry.getServiceAddress(REGISTRY(), majorVersion);
-        if(selectors.length > 0) {
-            _accessManager.setAndGrantUniqueRole(
-                address(service), 
-                registryService, 
-                selectors);
-        }
-        
-        _awaitingRegistration--;
-
-        nftId = _registry.registerService(info, majorVersion, 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 _verifyService(
-        IService service,
-        VersionPart expectedVersion,
-        ObjectType expectedDomain
-    )
-        internal
-        view
-        returns(ObjectType)
-    {
-        Version version = service.getVersion();
-        VersionPart majorVersion = version.toMajorPart();
-        if(majorVersion != expectedVersion) {
-            revert UnexpectedServiceVersion(expectedVersion, majorVersion);
-        }
-
-        if(service.getDomain() != expectedDomain) {
-            revert UnexpectedServiceDomain(expectedDomain, service.getDomain());
-        }
-
-        return expectedDomain;
-    }
-
-    // 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;
-            // not "registry service" / zero domain
-            if(
-                domain == REGISTRY() ||
-                domain.eqz()
-            ) { revert ConfigServiceDomainInvalid(idx, domain); } 
-
-            bytes4[] memory selectors = config[idx].selectors;
-
-            // 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(_selectors[version][domain].length > 0) {
-                revert SelectorAlreadyExists(version, domain); 
-            }
-            
-            _selectors[version][domain] = selectors;
-            _release[version].domains.push(domain);
-        }
-        // TODO set when activated?
-        _release[version].createdAt = TimestampLib.blockTimestamp();
-        //_release[version].updatedAt = TimestampLib.blockTimestamp();
-
-        _awaitingRegistration = config.length;
-    }
-}

package/contracts/shared/ContractDeployerLib.sol

@@ -1,72 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-library ContractDeployerLib {
-
-    event LogContractDeployed(address contractAddress);
-
-    error ErrorCreationCodeHashMismatch(bytes32 expectedHash, bytes32 actualHash);
-
-    /// @dev deploys a new contract using the provided creation code
-    function deploy(
-        bytes memory creationCode,
-        bytes32 expectedCreationCodeHash
-    ) 
-        public
-        returns (address contractAdress)
-    {
-        // check against expected hash, if provided
-        if (expectedCreationCodeHash != bytes32(0)) {
-            bytes32 creationCodeHash = getHash(creationCode);
-            if (creationCodeHash != expectedCreationCodeHash) {
-                revert ErrorCreationCodeHashMismatch(expectedCreationCodeHash, creationCodeHash);
-            }
-        }
-
-        // solhint-disable no-inline-assembly
-        assembly {
-            contractAdress := create(0, add(creationCode, 0x20), mload(creationCode))  
-
-            if iszero(extcodesize(contractAdress)) {
-                revert(0, 0)
-            }
-        }
-        // solhint enable
-
-        emit LogContractDeployed(contractAdress);
-    }
-
-    /// @dev gets the creation code for the new contract
-    // for terminology see eg https://www.rareskills.io/post/ethereum-contract-creation-code
-    function getCreationCode(
-        bytes memory byteCodeWithInitCode, // what you get with type(<Contract>).creationCode
-        bytes memory encodedConstructorArguments // what you get with 
-    )
-        public
-        pure
-        returns (bytes memory creationCode)
-    {
-        return abi.encodePacked(byteCodeWithInitCode, encodedConstructorArguments);
-    }
-
-
-    function matchesWithHash(
-        bytes memory creationCode,
-        bytes32 expectedHash
-    )
-        public
-        pure
-        returns (bool isMatching)
-    {
-        return getHash(creationCode) == expectedHash;
-    }
-
-
-    function getHash(bytes memory creationCode)
-        public
-        pure
-        returns (bytes32 hash)
-    {
-        return keccak256(creationCode);
-    }
-}

package/contracts/test/TestFee.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {UFixed, UFixedLib} from "../types/UFixed.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-
-contract TestFee {
-
-    function createFee(
-        uint256 fractionalValue,
-        int8 exponent,
-        uint256 fixedValue
-    )
-        external 
-        pure 
-        returns(Fee memory fee)
-    {
-        return FeeLib.toFee(UFixedLib.toUFixed(fractionalValue, exponent), fixedValue);
-    }
-
-    function getZeroFee() external pure returns(Fee memory fee) {
-        return FeeLib.zeroFee();
-    }
-
-}

package/contracts/test/TestRegisterable.sol

@@ -1,18 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType, TOKEN} from "../../contracts/types/ObjectType.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
-import {Registerable} from "../../contracts/shared/Registerable.sol";
-
-contract TestRegisterable is Registerable {
-
-    constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
-        //Registerable(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        bytes memory data = "";
-        initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
-    }
-}

package/contracts/test/TestRoleId.sol

@@ -1,14 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {RoleId, RoleIdLib, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
-
-contract TestRoleId {
-    function getRole(uint256 roleNum) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleNum); }
-
-    function getProductOwnerRoleName() external pure returns (string memory) { return PRODUCT_OWNER_ROLE_NAME(); }
-    function getProductOwnerRole() external pure returns (RoleId) { return PRODUCT_OWNER_ROLE(); } 
-
-    function getPoolOwnerRoleName() external pure returns (string memory) { return POOL_OWNER_ROLE_NAME(); }
-    function getPoolOwnerRole() external pure returns (RoleId) { return POOL_OWNER_ROLE(); } 
-}

package/contracts/test/TestService.sol

@@ -1,25 +0,0 @@
-// 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";
-
-import {IVersionable} from "../../contracts/shared/IVersionable.sol";
-import {Versionable} from "../../contracts/shared/Versionable.sol";
-
-contract TestService is Service {
-
-    string public constant NAME = "TestService";
-
-    constructor(address registry, NftId registryNftId, address initialOwner)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        initializeService(registry, address(0), initialOwner);
-    }
-
-    function getDomain() public pure override returns(ObjectType) {
-        return PRODUCT();
-    }
-}