@etherisc/gif-next 0.0.2-bb1081a-994 → 0.0.2-bb3faee-097

package/contracts/registry/ReleaseManager.sol

@@ -1,332 +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 {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/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/shared/ERC165.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-
-contract ERC165 is IERC165 {
-    mapping(bytes4 => bool) private _isSupported;
-
-    constructor() {
-        _initializeERC165();
-    }
-
-    function supportsInterface(bytes4 interfaceId) external view override returns (bool) {
-        return _isSupported[interfaceId];
-    }
-
-    // @dev register support for ERC165 itself
-    function _initializeERC165() internal {
-        _isSupported[type(IERC165).interfaceId] = true;
-    }
-
-    function _registerInterface(bytes4 interfaceId) internal {
-        _isSupported[interfaceId] = true;
-    }
-}

package/contracts/shared/ProxyManager.sol

@@ -1,94 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
-import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-import {NftOwnable} from "./NftOwnable.sol";
-import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-
-/// @dev manages proxy deployments for upgradable contracs of type IVersionable
-contract ProxyManager is
-    NftOwnable
-{
-
-    event LogProxyDeployed(address indexed proxy, address initialImplementation);
-    event LogProxyDeployedWithSalt(address indexed proxy, address initialImplementation);
-    event LogProxyUpgraded(address indexed proxy, address upgradedImplementation);
-
-    error ErrorAlreadyDeployed();
-    error ErrorAlreadyDeployedWithSalt();
-    error ErrorNotYetDeployed();
-
-    UpgradableProxyWithAdmin internal _proxy;
-    bool internal _isDeployed;
-
-    /// @dev only used to capture proxy owner
-    constructor()
-        NftOwnable()
-    { }
-
-    /// @dev deploy initial contract
-    function deploy(address initialImplementation, bytes memory initializationData)
-        public
-        virtual
-        onlyOwner()
-        returns (IVersionable versionable)
-    {
-        if (_isDeployed) { revert ErrorAlreadyDeployed(); }
-        _isDeployed = true;
-
-        address currentProxyOwner = getOwner(); // used by implementation
-        address initialProxyAdminOwner = address(this); // used by proxy
-        bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
-        
-        _proxy = new UpgradableProxyWithAdmin(
-            initialImplementation,
-            initialProxyAdminOwner,
-            data
-        );
-
-        versionable = IVersionable(address(_proxy));
-
-        emit LogProxyDeployed(address(_proxy), initialImplementation);
-    }
-
-    /// @dev upgrade existing contract
-    function upgrade(address newImplementation, bytes memory upgradeData)
-        public
-        virtual
-        onlyOwner()
-        returns (IVersionable versionable)
-    {
-        if (!_isDeployed) { revert ErrorNotYetDeployed(); }
-
-        address currentProxyOwner = getOwner();
-        ProxyAdmin proxyAdmin = getProxy().getProxyAdmin();
-        ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
-        bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
-
-        proxyAdmin.upgradeAndCall(
-            proxy,
-            newImplementation, 
-            data);
-
-        versionable = IVersionable(address(_proxy));
-
-        emit LogProxyUpgraded(address(_proxy), newImplementation);
-
-    }
-
-    function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
-        return abi.encodeWithSelector(IVersionable.initialize.selector, implementation, proxyOwner, deployData);
-    }
-
-    function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
-        return abi.encodeWithSelector(IVersionable.upgrade.selector, implementation, proxyOwner, upgradeData);
-    }
-
-    function getProxy() public returns (UpgradableProxyWithAdmin) {
-        return _proxy;
-    }
-}

package/contracts/shared/UpgradableProxyWithAdmin.sol

@@ -1,16 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
-import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-
-contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
-
-    constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
-        TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
-    {}
-
-    function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
-}

package/contracts/shared/Versionable.sol

@@ -1,147 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
-
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-
-
-
-abstract contract Versionable is 
-    Initializable,
-    IVersionable 
-{
-    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant VERSIONABLE_LOCATION_V1 = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
-
-
-    /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
-    struct VersionableStorage {
-        mapping(Version version => VersionInfo info) _versionHistory;
-        Version [] _versions;
-        Version _v1;
-    }
-
-
-    constructor() {
-        _disableInitializers();
-    }
-    // TODO write test where new version of private _updateVersionHistory is added and used... 
-    function initialize(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        public
-        initializer
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _initialize(activatedBy, data);
-    }
-
-    // TODO activatedBy MUST ALWAYS be an owner?
-    function upgrade(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        external
-        reinitializer(VersionLib.toUint64(getVersion()))
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _upgrade(data);
-    }
-
-    function isInitialized(Version _version) public override view returns(bool) {
-        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
-    }
-
-    function getVersion() public pure virtual returns(Version);
-
-    function getVersionCount() public view override returns(uint256) {
-        return _getVersionableStorage()._versions.length;
-    }
-
-    function getVersion(uint256 idx) public view override returns(Version) {
-        return _getVersionableStorage()._versions[idx];
-    }
-
-    function getVersionInfo(Version _version) public override view returns(VersionInfo memory) {
-        return _getVersionableStorage()._versionHistory[_version];
-    }
-
-    function getInitializedVersion() public view returns(uint64) {
-        return _getInitializedVersion();
-    }
-
-
-
-    // IMPORTANT each version must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    // each implementation MUST call intializers of all base contracts...
-    function _initialize(address owner, bytes memory data) 
-        internal
-        onlyInitializing
-        virtual 
-    {
-        revert();
-    }
-
-
-    // IMPORTANT each version except version "1" must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    function _upgrade(bytes memory data)
-        internal
-        onlyInitializing
-        virtual
-    {
-        revert();
-    }
-
-    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
-        assembly {
-            $.slot := VERSIONABLE_LOCATION_V1
-        }
-    }
-
-    // can only be called once per contract
-    // needs to be called inside the proxy upgrade tx
-    // TODO run reinitializer(version().toUint64()) modifier after "version()" is checked, 
-    function _updateVersionHistory(
-        address implementation,
-        address activatedBy
-    )
-        private
-        onlyInitializing
-    {
-        VersionableStorage storage $ = _getVersionableStorage();
-
-        uint64 version = _getInitializedVersion();
-
-        Version thisVersion = getVersion();
-
-        if(version == 1) {
-            // thisVersion is alias to version "1"
-            $._v1 = thisVersion;
-        }
-        else {
-            require(thisVersion > $._v1, "INVALID VERSION");
-        }
-
-        // update version history
-        $._versions.push(thisVersion);
-        $._versionHistory[thisVersion] = VersionInfo(
-            thisVersion,
-            implementation,
-            activatedBy,
-            TimestampLib.blockTimestamp(),
-            blockNumber()
-        );
-
-        emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
-    }
-}