@etherisc/gif-next 0.0.2-c0457ac-280 → 0.0.2-c0923b6-664

package/contracts/shared/ComponentVerifyingService.sol

@@ -1,117 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {Service} from "../shared/Service.sol";
-
-
-abstract contract ComponentVerifyingService is 
-    Service
-{
-
-    error ErrorComponentVerifyingServiceComponentTypeInvalid(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
-    error ErrorComponentVerifyingServiceComponentIsLocked(NftId componentNftId);
-
-    /// @dev based on the sender address returns the corresponding components nft id, info and instance.
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    /// - the component is locked
-    function _getAndVerifyActiveComponent(
-        ObjectType expectedType // assume always of `component` type
-    )
-        internal
-        view
-        returns(
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        )
-    {
-        componentNftId = getRegistry().getNftId(msg.sender);
-        (componentInfo, instance) = _getAndVerifyComponentInfo(
-            componentNftId, 
-            expectedType,
-            true); // only active
-    }
-
-
-    /// @dev returns the component info and instance contract reference given a component nft id
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    function _getAndVerifyComponentInfo(
-        NftId componentNftId,
-        ObjectType expectedType, // assume always of `component` type
-        bool onlyActive
-    )
-        internal
-        virtual
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        IRegistry registry = getRegistry();
-        info = registry.getObjectInfo(componentNftId);
-
-        // if not COMPONENT require exact match
-        if(expectedType != COMPONENT()) {
-            // ensure component is of expected type
-            if(info.objectType != expectedType) {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        } else {
-            if(!(info.objectType == PRODUCT()
-                || info.objectType == POOL()
-                || info.objectType == DISTRIBUTION()
-                || info.objectType == ORACLE()
-            ))
-            {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        }
-
-        instance = _getInstance(info.parentNftId);
-
-        // ensure component is not locked
-        if (onlyActive) {
-            if (instance.getInstanceAccessManager().isTargetClosed(info.objectAddress)) {
-                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-            }
-        }
-    }
-
-
-    /// @dev returns the linked product nft id for the specified component
-    function _getProductNftId(
-        InstanceReader instanceReader,
-        NftId componentNftId
-    )
-        internal
-        virtual
-        view
-        returns (NftId productNftId)
-    {
-        return instanceReader.getComponentInfo(componentNftId).productNftId;
-    }
-
-
-    /// @dev returns an IInstance contract reference for the specified instance nft id
-    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
-        return IInstance(
-            getRegistry().getObjectInfo(
-                instanceNftId).objectAddress);
-    }
-}

package/contracts/shared/IAccessAdmin.sol

@@ -1,168 +0,0 @@
-// SPDX-License-Identifier: UNLICENSED
-pragma solidity ^0.8.20;
-
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-
-import {RoleId} from "../type/RoleId.sol";
-import {Selector} from "../type/Selector.sol";
-import {Str} from "../type/String.sol";
-import {Timestamp} from "../type/Timestamp.sol";
-
-interface IAccessAdmin is 
-    IAccessManaged
-{
-
-    // roles
-    event LogRoleCreated(RoleId roleId, RoleId roleAdminId, string name);
-    event LogRoleDisabled(RoleId roleId, bool disabled, Timestamp disabledAtOld);
-    event LogTargetCreated(address target, string name);
-    event LogFunctionCreated(address target, Selector selector, string name);
-
-    // only deployer modifier
-    error ErrorNotDeployer();
-
-    // only role admin modifier
-    error ErrorNotAdminOfRole(RoleId adminRoleId);
-
-    // only role owner modifier
-    error ErrorNotRoleOwner(RoleId roleId);
-
-    // initialize authority
-    error ErrorAuthorityAlreadySet();
-    error ErrorAdminRoleMissing();
-
-    // create role
-    error ErrorRoleAlreadyCreated(RoleId roleId, string name);
-    error ErrorRoleAdminNotExisting(RoleId adminRoleId);
-    error ErrorRoleNameEmpty(RoleId roleId);
-    error ErrorRoleNameAlreadyExists(RoleId roleId, string name, RoleId existingRoleId);
-
-    // grant/revoke/renounce role
-    error ErrorRoleUnknown(RoleId roleId);
-    error ErrorRoleIsLocked(RoleId roleId);
-    error ErrorRoleIsDisabled(RoleId roleId);
-    error ErrorRoleMembersLimitReached(RoleId roleId, uint256 memberCountLimit);
-    error ErrorRoleRemovalDisabled(RoleId roleId);
-
-    // create target
-    error ErrorTargetAlreadyCreated(address target, string name);
-    error ErrorTargetNameEmpty(address target);
-    error ErrorTargetNameAlreadyExists(address target, string name, address existingTarget);
-    error ErrorTargetNotAccessManaged(address target);
-    error ErrorTargetAuthorityMismatch(address expectedAuthority, address actualAuthority);
-
-    // lock target
-    error ErrorTagetNotLockable();
-
-    // authorize target functions
-    error ErrorAuthorizeForAdminRoleInvalid(address target);
-
-    // check target
-    error ErrorTargetUnknown(address target);
-
-    struct RoleInfo {
-        RoleId adminRoleId;
-        Str name;
-        uint256 maxMemberCount;
-        bool memberRemovalDisabled;
-        Timestamp disabledAt;
-        bool exists;
-    }
-
-    struct RoleNameInfo {
-        RoleId roleId;
-        bool exists;
-    }
-
-    struct TargetInfo {
-        Str name;
-        Timestamp createdAt;
-    }
-
-    struct Function {
-        Selector selector; // function selector
-        Str name; // function name
-    }
-
-    /// @dev Create a new named role using the specified parameters.
-    /// The adminRoleId refers to the required role to grant/revoke the newly created role.
-    /// permissioned: the caller must have the manager role (getManagerRole).
-    function createRole(
-        RoleId roleId, 
-        RoleId adminRoleId, 
-        string memory name,
-        uint256 maxMemberCount,
-        bool memberRemovalDisabled
-    )
-        external;
-
-    /// @dev Set the disabled status of the speicified role.
-    /// Role disabling only prevents the role from being granted to new accounts.
-    /// Existing role members may still execute functions that are authorized for that role.
-    /// Permissioned: the caller must have the manager role (getManagerRole).
-    function setRoleDisabled(RoleId roleId, bool disabled) external;
-
-    /// @dev Grant the specified account the provided role.
-    /// Permissioned: the caller must have the roles admin role.
-    function grantRole(address account, RoleId roleId) external;
-
-    /// @dev Revoke the provided role from the specified account.
-    /// Permissioned: the caller must have the roles admin role.
-    function revokeRole(address account, RoleId roleId) external;
-
-    /// @dev Removes the provided role from the caller
-    function renounceRole(RoleId roleId) external;
-
-    /// @dev Create a new named target.
-    /// Permissioned: the caller must have the manager role (getManagerRole).
-    function createTarget(address target, string memory name) external;
-
-    /// @dev Set the locked status of the speicified contract.
-    /// IMPORTANT: using this function the AccessManager might itself be put into locked state from which it cannot be unlocked again.
-    /// Overwrite this function if a different use case specific behaviour is required.
-    /// Alternatively, add specific function to just unlock this contract without a restricted() modifier.
-    /// Permissioned: the caller must have the manager role (getManagerRole).
-    function setTargetLocked(address target, bool locked) external;
-
-    /// @dev Specifies which functions of the target can be accessed by the provided role.
-    /// Previously existing authorizations will be overwritten.
-    /// Authorizing the admin role is not allowed, use function unauthorizedFunctions for this.
-    /// Permissioned: the caller must have the manager role (getManagerRole).
-    function authorizeFunctions(address target, RoleId roleId, Function[] memory functions) external;
-
-    /// @dev Specifies for which functionss to remove any previous authorization
-    /// Permissioned: the caller must have the manager role (getManagerRole).
-    function unauthorizeFunctions(address target, Function[] memory functions) external;
-
-    //--- view functions ----------------------------------------------------//
-
-    function roles() external view returns (uint256 numberOfRoles);
-    function getRoleId(uint256 idx) external view returns (RoleId roleId);
-    function getAdminRole() external view returns (RoleId roleId);
-    function getManagerRole() external view returns (RoleId roleId);
-    function getPublicRole() external view returns (RoleId roleId);
-
-    function roleExists(RoleId roleId) external view returns (bool exists); 
-    function isRoleDisabled(RoleId roleId) external view returns (bool roleIsActive);
-    function getRoleInfo(RoleId roleId) external view returns (RoleInfo memory roleInfo);
-    function getRoleForName(Str name) external view returns (RoleNameInfo memory);
-
-    function hasRole(address account, RoleId roleId) external view returns (bool);
-    function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers);
-    function getRoleMember(RoleId roleId, uint256 idx) external view returns (address account);
-
-    function targetExists(address target) external view returns (bool exists);
-    function isTargetLocked(address target) external view returns (bool locked);
-    function targets() external view returns (uint256 numberOfTargets);
-    function getTargetAddress(uint256 idx) external view returns (address target);
-    function getTargetInfo(address target) external view returns (TargetInfo memory targetInfo);
-    function getTargetForName(Str name) external view returns (address target);
-
-    function authorizedFunctions(address target) external view returns (uint256 numberOfFunctions);
-    function getAuthorizedFunction(address target, uint256 idx) external view returns (Function memory func, RoleId roleId);
-    function canCall(address caller, address target, Selector selector) external view returns (bool can);
-
-    function toFunction(bytes4 selector, string memory name) external pure returns (Function memory);
-    function isAccessManaged(address target) external view returns (bool);
-    function deployer() external view returns (address);
-}

package/contracts/shared/IAccessManagerExtended.sol

@@ -1,74 +0,0 @@
-// SPDX-License-Identifier: MIT
-// OpenZeppelin Contracts (last updated v5.0.0) (access/manager/IAccessManager.sol)
-
-pragma solidity ^0.8.20;
-
-import {IAccessManager} from "@openzeppelin/contracts/access/manager/IAccessManager.sol";
-
-import {Timestamp} from "../type/Timestamp.sol";
-
-interface IAccessManagerExtended is IAccessManager {
-    // Structure that stores the details for a target contract.
-    struct TargetInfo {
-        address taddress;
-        //IAccess.Type ttype;
-        string name;
-        Timestamp createdAt;
-        //Timestamp updatedAt;
-    }
-
-    // Structure that stores the details of a role.
-    struct RoleInfo {
-        uint64 id;
-        //IAccess.Type rtype;
-        string name;
-        Timestamp createdAt;
-    }
-
-    event LogRoleCreation(uint64 roleId, string name);// IAccess.Type rtype);
-    event LogTargetCreation(address target, string name);// IAccess.Type ttype);
-
-    error AccessManagerRoleIdNotExists(uint64 roleId);
-    error AccessManagerRoleIdAlreadyExists(uint64 roleId);
-    error AccessManagerRoleNameAlreadyExists(uint64 newRoleId, uint64 existingRoleId, string duplicateName);
-    error AccessManagerRoleIdZero();
-    error AccessManagerRoleNameEmpty(uint64 roleId);
-    error AccessManagerRoleIdTooBig(uint64 roleId);
-
-    error AccessManagerTargetAlreadyExists(address target);
-    error AccessManagerTargetNotExists(address target);
-    error AccessManagerTargetNameAlreadyExists(address newTarget, address existingTarget, string duplicateName);
-    error AccessManagerTargetAddressZero();
-    error AccessManagerTargetNameEmpty(address target);
-    error AccessManagerTargetAuthorityInvalid(address target, address targetAuthority);
-
-    function getRoleMembers(uint64 roleId) external view returns (uint256 numberOfMembers);
-
-    function getRoleMember(uint64 roleId, uint256 idx) external view returns (address member);
-
-    function getRoleId(uint256 idx) external view returns (uint64 roleId);
-
-    // TODO returns ADMIN_ROLE id for non existent name
-    function getRoleId(string memory name) external view returns (uint64 roleId);
-
-    function getRoles() external view returns (uint256 numberOfRoles);
-
-    function isRoleExists(uint64 roleId) external view returns (bool exists);
-
-    function getRoleInfo(uint64 roleId) external view returns (RoleInfo memory);
-
-    function isRoleNameExists(string memory name) external view returns (bool);
-
-    function isTargetExists(address target) external view returns (bool);
-
-    function isTargetNameExists(string memory name) external view returns (bool);
-    
-    function getTargetAddress(string memory name) external view returns(address targetAddress);
-
-    function getTargetInfo(address target) external view returns (TargetInfo memory);
-
-
-    function createRole(uint64 roleId, string memory roleName/*, IAccess.Type rtype*/) external;
-
-    function createTarget(address target, string memory name/*, IAccess.Type.Custom*/) external;
-}

package/contracts/shared/IAccessManagerExtendedWithDisable.sol

@@ -1,18 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.20;
-
-import {IAccessManagerExtended} from "./IAccessManagerExtended.sol";
-
-import {Timestamp} from "../type/Timestamp.sol";
-import {VersionPart} from "../type/Version.sol";
-import {Seconds} from "../type/Seconds.sol";
-
-interface IAccessManagerExtendedWithDisable is IAccessManagerExtended {
-
-    error AccessManagerDisabled();
-
-    function disable(Seconds delay) external;
-    function enable() external;
-    function getVersion() external view returns (VersionPart version);
-}

package/contracts/shared/IKeyValueStore.sol

@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId} from "../type/StateId.sol";
-
-import {ILifecycle} from "./ILifecycle.sol";
-
-interface IKeyValueStore is ILifecycle {
-
-    error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
-    error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
-    error ErrorKeyValueStoreStateZero(Key32 key);
-    error ErrorKeyValueStoreNotExisting(Key32 key);
-
-    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-
-    struct Value {
-        Metadata metadata;
-        bytes data;
-    }
-
-    struct Metadata {
-        ObjectType objectType;
-        StateId state;
-        // TODO updatedBy needs concept that says what value should go here
-        // eg account outside gif objects that initiated the tx
-        // implies the caller needs to be propagated through all calls up to key values store itself
-        // to always have the instance address there doesn't seem to make sense
-        // address updatedBy;
-        Blocknumber updatedIn;
-        Blocknumber createdIn;
-    }
-
-    // generic state changing functions
-    // function create(Key32 key, bytes memory data) external;
-    // function update(Key32 key, bytes memory data, StateId state) external;
-    // function updateData(Key32 key, bytes memory data) external;
-    // function updateState(Key32 key, StateId state) external;
-
-    function exists(Key32 key) external view returns (bool);
-    function get(Key32 key) external view returns (Value memory value);
-    function getData(Key32 key) external view returns (bytes memory data);
-    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
-    function getState(Key32 key) external view returns (StateId state);
-
-    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
-}

package/contracts/shared/InitializableCustom.sol

@@ -1,177 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.20;
-
-/**
- * @dev This is copy of OpenZeppelin's Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
- * Changes:
- * 1. name is InitializableCustom
- * 2. no longer abstract
- * 3. have $._initializeOwner
- * 4. have constructor where sets _initializeOwner 
- * 5. initializer() in addition checks for _initializeOwner
- * 6. reinitializer() is deleted
- */
-abstract contract InitializableCustom {
-    /**
-     * @dev Storage of the initializable contract.
-     *
-     * It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
-     * when using with upgradeable contracts.
-     *
-     * @custom:storage-location erc7201:openzeppelin.storage.Initializable
-     */
-    struct InitializableCustomStorage {
-        /**
-         * @dev Indicates that the contract has been initialized.
-         */
-        uint64 _initialized;
-        /**
-         * @dev Indicates that the contract is in the process of being initialized.
-         */
-        bool _initializing;
-        /**
-         * @dev Indicates address that can call function with initializer() modifier.
-         */
-        address _initializeOwner;
-    }
-
-    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.InitializableCustom")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant INITIALIZABLE_CUSTOM_STORAGE = 0x46cd1d813423aaf613c34c7f348d15b2b5e71215e9145b09467e257ea2805a00;
-
-    /**
-     * @dev The contract is already initialized.
-     */
-    error InvalidInitialization();
-
-    /**
-     * @dev The contract initialization function caller is not authorized.
-     */
-    error InvalidInitializationCaller();
-
-    /**
-     * @dev The contract is not initializing.
-     */
-    error NotInitializing();
-
-    /**
-     * @dev Triggered when the contract has been initialized or reinitialized.
-     */
-    event Initialized(uint64 version);
-
-    /**
-     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
-     * `onlyInitializing` functions can be used to initialize parent contracts.
-     *
-     * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
-     * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
-     * production.
-     *
-     * Emits an {Initialized} event.
-     */
-    modifier initializer() virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if($._initializeOwner != msg.sender) {
-            revert InvalidInitializationCaller();
-        }
-
-        // Cache values to avoid duplicated sloads
-        bool isTopLevelCall = !$._initializing;
-        uint64 initialized = $._initialized;
-
-        // Allowed calls:
-        // - initialSetup: the contract is not in the initializing state and no previous version was
-        //                 initialized
-        // - construction: the contract is initialized at version 1 (no reininitialization) and the
-        //                 current contract is just being deployed
-        bool initialSetup = initialized == 0 && isTopLevelCall;
-        bool construction = initialized == 1 && address(this).code.length == 0;
-
-        if (!initialSetup && !construction) {
-            revert InvalidInitialization();
-        }
-        $._initialized = 1;
-        if (isTopLevelCall) {
-            $._initializing = true;
-        }
-        _;
-        if (isTopLevelCall) {
-            $._initializing = false;
-            emit Initialized(1);
-        }
-    }
-
-    /**
-     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
-     * {initializer} and {reinitializer} modifiers, directly or indirectly.
-     */
-    modifier onlyInitializing() {
-        _checkInitializing();
-        _;
-    }
-
-    /**
-     * @dev Constructor sets the caller of protected initializer function.
-    */
-    constructor() {
-        // solhint-disable-previous-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-        $._initializeOwner = msg.sender;
-    }
-
-    /**
-     * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
-     */
-    function _checkInitializing() internal view virtual {
-        if (!_isInitializing()) {
-            revert NotInitializing();
-        }
-    }
-
-    /**
-     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
-     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
-     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
-     * through proxies.
-     *
-     * Emits an {Initialized} event the first time it is successfully executed.
-     */
-    function _disableInitializers() internal virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if ($._initializing) {
-            revert InvalidInitialization();
-        }
-        if ($._initialized != type(uint64).max) {
-            $._initialized = type(uint64).max;
-            emit Initialized(type(uint64).max);
-        }
-    }
-
-    /**
-     * @dev Returns the highest version that has been initialized. See {reinitializer}.
-     */
-    function _getInitializedVersion() internal view returns (uint64) {
-        return _getInitializableCustomStorage()._initialized;
-    }
-
-    /**
-     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
-     */
-    function _isInitializing() internal view returns (bool) {
-        return _getInitializableCustomStorage()._initializing;
-    }
-
-    /**
-     * @dev Returns a pointer to the storage namespace.
-     */
-    // solhint-disable-next-line var-name-mixedcase
-    function _getInitializableCustomStorage() private pure returns (InitializableCustomStorage storage $) {
-        assembly {
-            $.slot := INITIALIZABLE_CUSTOM_STORAGE
-        }
-    }
-}