@etherisc/gif-next 0.0.2-e1f23dc-329 → 0.0.2-e2a57af-971

package/contracts/instance/IAccessManagerSimple.sol

@@ -1,391 +0,0 @@
-// SPDX-License-Identifier: MIT
-// OpenZeppelin Contracts (last updated v5.0.0) (access/manager/IAccessManager.sol)
-
-pragma solidity ^0.8.20;
-
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-
-interface IAccessManagerSimple {
-    /**
-     * @dev A delayed operation was scheduled.
-     */
-    event OperationScheduled(
-        bytes32 indexed operationId,
-        uint32 indexed nonce,
-        uint48 schedule,
-        address caller,
-        address target,
-        bytes data
-    );
-
-    /**
-     * @dev A scheduled operation was executed.
-     */
-    event OperationExecuted(bytes32 indexed operationId, uint32 indexed nonce);
-
-    /**
-     * @dev A scheduled operation was canceled.
-     */
-    event OperationCanceled(bytes32 indexed operationId, uint32 indexed nonce);
-
-    /**
-     * @dev Informational labelling for a roleId.
-     */
-    event RoleLabel(uint64 indexed roleId, string label);
-
-    /**
-     * @dev Emitted when `account` is granted `roleId`.
-     *
-     * NOTE: The meaning of the `since` argument depends on the `newMember` argument.
-     * If the role is granted to a new member, the `since` argument indicates when the account becomes a member of the role,
-     * otherwise it indicates the execution delay for this account and roleId is updated.
-     */
-    event RoleGranted(uint64 indexed roleId, address indexed account, uint32 delay, uint48 since, bool newMember);
-
-    /**
-     * @dev Emitted when `account` membership or `roleId` is revoked. Unlike granting, revoking is instantaneous.
-     */
-    event RoleRevoked(uint64 indexed roleId, address indexed account);
-
-    /**
-     * @dev Role acting as admin over a given `roleId` is updated.
-     */
-    event RoleAdminChanged(uint64 indexed roleId, uint64 indexed admin);
-
-    /**
-     * @dev Role acting as guardian over a given `roleId` is updated.
-     */
-    event RoleGuardianChanged(uint64 indexed roleId, uint64 indexed guardian);
-
-    /**
-     * @dev Grant delay for a given `roleId` will be updated to `delay` when `since` is reached.
-     */
-    event RoleGrantDelayChanged(uint64 indexed roleId, uint32 delay, uint48 since);
-
-    /**
-     * @dev Target mode is updated (true = closed, false = open).
-     */
-    event TargetClosed(address indexed target, bool closed);
-
-    /**
-     * @dev Role required to invoke `selector` on `target` is updated to `roleId`.
-     */
-    event TargetFunctionRoleUpdated(address indexed target, bytes4 selector, uint64 indexed roleId);
-
-    /**
-     * @dev Admin delay for a given `target` will be updated to `delay` when `since` is reached.
-     */
-    event TargetAdminDelayUpdated(address indexed target, uint32 delay, uint48 since);
-
-    error AccessManagerAlreadyScheduled(bytes32 operationId);
-    error AccessManagerNotScheduled(bytes32 operationId);
-    error AccessManagerNotReady(bytes32 operationId);
-    error AccessManagerExpired(bytes32 operationId);
-    error AccessManagerLockedAccount(address account);
-    error AccessManagerLockedRole(uint64 roleId);
-    error AccessManagerBadConfirmation();
-    error AccessManagerUnauthorizedAccount(address msgsender, uint64 roleId);
-    error AccessManagerUnauthorizedCall(address caller, address target, bytes4 selector);
-    error AccessManagerUnauthorizedConsume(address target);
-    error AccessManagerUnauthorizedCancel(address msgsender, address caller, address target, bytes4 selector);
-    error AccessManagerInvalidInitialAdmin(address initialAdmin);
-
-    /**
-     * @dev Check if an address (`caller`) is authorised to call a given function on a given contract directly (with
-     * no restriction). Additionally, it returns the delay needed to perform the call indirectly through the {schedule}
-     * & {execute} workflow.
-     *
-     * This function is usually called by the targeted contract to control immediate execution of restricted functions.
-     * Therefore we only return true if the call can be performed without any delay. If the call is subject to a
-     * previously set delay (not zero), then the function should return false and the caller should schedule the operation
-     * for future execution.
-     *
-     * If `immediate` is true, the delay can be disregarded and the operation can be immediately executed, otherwise
-     * the operation can be executed if and only if delay is greater than 0.
-     *
-     * NOTE: The IAuthority interface does not include the `uint32` delay. This is an extension of that interface that
-     * is backward compatible. Some contracts may thus ignore the second return argument. In that case they will fail
-     * to identify the indirect workflow, and will consider calls that require a delay to be forbidden.
-     *
-     * NOTE: This function does not report the permissions of this manager itself. These are defined by the
-     * {_canCallSelf} function instead.
-     */
-    function canCall(
-        address caller,
-        address target,
-        bytes4 selector
-    ) external view returns (bool allowed, uint32 delay);
-
-    /**
-     * @dev Expiration delay for scheduled proposals. Defaults to 1 week.
-     *
-     * IMPORTANT: Avoid overriding the expiration with 0. Otherwise every contract proposal will be expired immediately,
-     * disabling any scheduling usage.
-     */
-    function expiration() external view returns (uint32);
-
-    /**
-     * @dev Minimum setback for all delay updates, with the exception of execution delays. It
-     * can be increased without setback (and reset via {revokeRole} in the case event of an
-     * accidental increase). Defaults to 5 days.
-     */
-    function minSetback() external view returns (uint32);
-
-    /**
-     * @dev Get whether the contract is closed disabling any access. Otherwise role permissions are applied.
-     */
-    function isTargetClosed(address target) external view returns (bool);
-
-    /**
-     * @dev Get the role required to call a function.
-     */
-    function getTargetFunctionRole(address target, bytes4 selector) external view returns (uint64);
-
-    /**
-     * @dev Get the admin delay for a target contract. Changes to contract configuration are subject to this delay.
-     */
-    function getTargetAdminDelay(address target) external view returns (uint32);
-
-    /**
-     * @dev Get the id of the role that acts as an admin for the given role.
-     *
-     * The admin permission is required to grant the role, revoke the role and update the execution delay to execute
-     * an operation that is restricted to this role.
-     */
-    function getRoleAdmin(uint64 roleId) external view returns (uint64);
-
-    /**
-     * @dev Get the role that acts as a guardian for a given role.
-     *
-     * The guardian permission allows canceling operations that have been scheduled under the role.
-     */
-    function getRoleGuardian(uint64 roleId) external view returns (uint64);
-
-    /**
-     * @dev Get the role current grant delay.
-     *
-     * Its value may change at any point without an event emitted following a call to {setGrantDelay}.
-     * Changes to this value, including effect timepoint are notified in advance by the {RoleGrantDelayChanged} event.
-     */
-    function getRoleGrantDelay(uint64 roleId) external view returns (uint32);
-
-    /**
-     * @dev Get the access details for a given account for a given role. These details include the timepoint at which
-     * membership becomes active, and the delay applied to all operation by this user that requires this permission
-     * level.
-     *
-     * Returns:
-     * [0] Timestamp at which the account membership becomes valid. 0 means role is not granted.
-     * [1] Current execution delay for the account.
-     * [2] Pending execution delay for the account.
-     * [3] Timestamp at which the pending execution delay will become active. 0 means no delay update is scheduled.
-     */
-    function getAccess(uint64 roleId, address account) external view returns (uint48, uint32, uint32, uint48);
-
-    /**
-     * @dev Check if a given account currently has the permission level corresponding to a given role. Note that this
-     * permission might be associated with an execution delay. {getAccess} can provide more details.
-     */
-    function hasRole(uint64 roleId, address account) external view returns (bool, uint32);
-
-    /**
-     * @dev Give a label to a role, for improved role discoverability by UIs.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {RoleLabel} event.
-     */
-    function labelRole(uint64 roleId, string calldata label) external;
-
-    /**
-     * @dev Add `account` to `roleId`, or change its execution delay.
-     *
-     * This gives the account the authorization to call any function that is restricted to this role. An optional
-     * execution delay (in seconds) can be set. If that delay is non 0, the user is required to schedule any operation
-     * that is restricted to members of this role. The user will only be able to execute the operation after the delay has
-     * passed, before it has expired. During this period, admin and guardians can cancel the operation (see {cancel}).
-     *
-     * If the account has already been granted this role, the execution delay will be updated. This update is not
-     * immediate and follows the delay rules. For example, if a user currently has a delay of 3 hours, and this is
-     * called to reduce that delay to 1 hour, the new delay will take some time to take effect, enforcing that any
-     * operation executed in the 3 hours that follows this update was indeed scheduled before this update.
-     *
-     * Requirements:
-     *
-     * - the caller must be an admin for the role (see {getRoleAdmin})
-     * - granted role must not be the `PUBLIC_ROLE`
-     *
-     * Emits a {RoleGranted} event.
-     */
-    function grantRole(uint64 roleId, address account, uint32 executionDelay) external;
-
-    /**
-     * @dev Remove an account from a role, with immediate effect. If the account does not have the role, this call has
-     * no effect.
-     *
-     * Requirements:
-     *
-     * - the caller must be an admin for the role (see {getRoleAdmin})
-     * - revoked role must not be the `PUBLIC_ROLE`
-     *
-     * Emits a {RoleRevoked} event if the account had the role.
-     */
-    function revokeRole(uint64 roleId, address account) external;
-
-    /**
-     * @dev Renounce role permissions for the calling account with immediate effect. If the sender is not in
-     * the role this call has no effect.
-     *
-     * Requirements:
-     *
-     * - the caller must be `callerConfirmation`.
-     *
-     * Emits a {RoleRevoked} event if the account had the role.
-     */
-    function renounceRole(uint64 roleId, address callerConfirmation) external;
-
-    /**
-     * @dev Change admin role for a given role.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {RoleAdminChanged} event
-     */
-    function setRoleAdmin(uint64 roleId, uint64 admin) external;
-
-    /**
-     * @dev Change guardian role for a given role.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {RoleGuardianChanged} event
-     */
-    function setRoleGuardian(uint64 roleId, uint64 guardian) external;
-
-    /**
-     * @dev Update the delay for granting a `roleId`.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {RoleGrantDelayChanged} event.
-     */
-    function setGrantDelay(uint64 roleId, uint32 newDelay) external;
-
-    /**
-     * @dev Set the role required to call functions identified by the `selectors` in the `target` contract.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {TargetFunctionRoleUpdated} event per selector.
-     */
-    function setTargetFunctionRole(address target, bytes4[] calldata selectors, uint64 roleId) external;
-
-    /**
-     * @dev Set the delay for changing the configuration of a given target contract.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {TargetAdminDelayUpdated} event.
-     */
-    function setTargetAdminDelay(address target, uint32 newDelay) external;
-
-    /**
-     * @dev Set the closed flag for a contract.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     *
-     * Emits a {TargetClosed} event.
-     */
-    function setTargetClosed(address target, bool closed) external;
-
-    /**
-     * @dev Return the timepoint at which a scheduled operation will be ready for execution. This returns 0 if the
-     * operation is not yet scheduled, has expired, was executed, or was canceled.
-     */
-    function getSchedule(bytes32 id) external view returns (uint48);
-
-    /**
-     * @dev Return the nonce for the latest scheduled operation with a given id. Returns 0 if the operation has never
-     * been scheduled.
-     */
-    function getNonce(bytes32 id) external view returns (uint32);
-
-    /**
-     * @dev Schedule a delayed operation for future execution, and return the operation identifier. It is possible to
-     * choose the timestamp at which the operation becomes executable as long as it satisfies the execution delays
-     * required for the caller. The special value zero will automatically set the earliest possible time.
-     *
-     * Returns the `operationId` that was scheduled. Since this value is a hash of the parameters, it can reoccur when
-     * the same parameters are used; if this is relevant, the returned `nonce` can be used to uniquely identify this
-     * scheduled operation from other occurrences of the same `operationId` in invocations of {execute} and {cancel}.
-     *
-     * Emits a {OperationScheduled} event.
-     *
-     * NOTE: It is not possible to concurrently schedule more than one operation with the same `target` and `data`. If
-     * this is necessary, a random byte can be appended to `data` to act as a salt that will be ignored by the target
-     * contract if it is using standard Solidity ABI encoding.
-     */
-    function schedule(address target, bytes calldata data, uint48 when) external returns (bytes32, uint32);
-
-    /**
-     * @dev Execute a function that is delay restricted, provided it was properly scheduled beforehand, or the
-     * execution delay is 0.
-     *
-     * Returns the nonce that identifies the previously scheduled operation that is executed, or 0 if the
-     * operation wasn't previously scheduled (if the caller doesn't have an execution delay).
-     *
-     * Emits an {OperationExecuted} event only if the call was scheduled and delayed.
-     */
-    function execute(address target, bytes calldata data) external payable returns (uint32);
-
-    /**
-     * @dev Cancel a scheduled (delayed) operation. Returns the nonce that identifies the previously scheduled
-     * operation that is cancelled.
-     *
-     * Requirements:
-     *
-     * - the caller must be the proposer, a guardian of the targeted function, or a global admin
-     *
-     * Emits a {OperationCanceled} event.
-     */
-    function cancel(address caller, address target, bytes calldata data) external returns (uint32);
-
-    /**
-     * @dev Consume a scheduled operation targeting the caller. If such an operation exists, mark it as consumed
-     * (emit an {OperationExecuted} event and clean the state). Otherwise, throw an error.
-     *
-     * This is useful for contract that want to enforce that calls targeting them were scheduled on the manager,
-     * with all the verifications that it implies.
-     *
-     * Emit a {OperationExecuted} event.
-     */
-    function consumeScheduledOp(address caller, bytes calldata data) external;
-
-    /**
-     * @dev Hashing function for delayed operations.
-     */
-    function hashOperation(address caller, address target, bytes calldata data) external view returns (bytes32);
-
-    /**
-     * @dev Changes the authority of a target managed by this manager instance.
-     *
-     * Requirements:
-     *
-     * - the caller must be a global admin
-     */
-    function updateAuthority(address target, address newAuthority) external;
-}

package/contracts/instance/base/ComponentServiceBase.sol

@@ -1,134 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL, DISTRIBUTION, ORACLE} from "../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-
-import {BaseComponent} from "../../components/BaseComponent.sol";
-import {Product} from "../../components/Product.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
-import {Service} from "../../shared/Service.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
-
-abstract contract ComponentServiceBase is Service {
-
-    error ExpectedRoleMissing(RoleId expected, address caller);
-    error ComponentTypeInvalid(ObjectType componentType);
-
-    mapping (ObjectType => RoleId) internal _objectTypeToExpectedRole;
-
-    /// @dev modifier to check if caller has a role on the instance the component is registered in
-    modifier onlyComponentOwnerRole(address componentAddress) {
-        BaseComponent component = BaseComponent(componentAddress);
-        ObjectType objectType = _getObjectType(component);
-        RoleId expectedRole = _objectTypeToExpectedRole[objectType];
-
-        address componentOwner = msg.sender;
-        INftOwnable nftOwnable = INftOwnable(address(component.getInstance()));
-        if(! getInstanceService().hasRole(componentOwner, expectedRole, nftOwnable.getNftId())) {
-            revert ExpectedRoleMissing(expectedRole, componentOwner);
-        }
-        _;
-    }
-
-    /// @dev modifier to check if caller is a registered service
-    modifier onlyService() {
-        address caller = msg.sender;
-        require(getRegistry().isRegisteredService(caller), "ERROR_NOT_SERVICE");
-        _;
-    }
-
-    function _initializeService(
-        address registry, 
-        address initialOwner
-    )
-        internal
-        override
-    {
-        super._initializeService(registry, initialOwner);
-        _objectTypeToExpectedRole[PRODUCT()] = PRODUCT_OWNER_ROLE();
-        _objectTypeToExpectedRole[POOL()] = POOL_OWNER_ROLE();
-        _objectTypeToExpectedRole[DISTRIBUTION()] = DISTRIBUTION_OWNER_ROLE();
-        _objectTypeToExpectedRole[ORACLE()] = ORACLE_OWNER_ROLE();
-    }
-
-    function getInstanceService() public view returns (InstanceService) {
-        return InstanceService(getRegistry().getServiceAddress("InstanceService", getMajorVersion()));
-    }
-
-    function register(address componentAddress) 
-        external 
-        onlyComponentOwnerRole(componentAddress)
-        returns (NftId componentNftId)
-    {
-        address componentOwner = msg.sender;
-        BaseComponent component = BaseComponent(componentAddress);
-        ObjectType objectType = _getObjectType(component);
-        IRegistryService registryService = getRegistryService();
-
-        IRegistry.ObjectInfo memory objInfo;
-        bytes memory initialObjData;
-
-        if (objectType == DISTRIBUTION()) {
-            (objInfo, initialObjData) = registryService.registerDistribution(component, componentOwner);
-        } else if (objectType == PRODUCT()) {
-            (objInfo, initialObjData) = registryService.registerProduct(component, componentOwner);
-        } else if (objectType == POOL()) {
-            (objInfo, initialObjData) = registryService.registerPool(component, componentOwner);
-        // TODO: implement this for oracle - currently missing in registry
-        // } else if (objectType == ORACLE()) {
-        //     (objInfo, initialObjData) = registryService.registerOracle(component, componentOwner);
-        } else {
-            revert ComponentTypeInvalid(objectType);
-        }
-
-        componentNftId = objInfo.nftId;
-        {
-            IInstance instance = _getInstance(objInfo);
-            _finalizeComponentRegistration(componentNftId, initialObjData, instance);
-        }
-    }
-
-    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal virtual;
-
-    function _getObjectType(BaseComponent component) internal view returns (ObjectType) {
-        (IRegistry.ObjectInfo memory compInitialInfo, )  = component.getInitialInfo();
-        return compInitialInfo.objectType;
-    }
-    
-    function _getInstance(IRegistry.ObjectInfo memory compObjInfo) internal view returns (IInstance) {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(compObjInfo.parentNftId);
-        return IInstance(instanceInfo.objectAddress);
-    }
-
-    function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = getRegistry().getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = getRegistry().getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-    }
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
-        return IRegistryService(service);
-    }
-}

package/contracts/instance/base/IInstanceBase.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Key32} from "../../types/Key32.sol";
-import {StateId} from "../../types/StateId.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
-import {IDistributionService} from "../service/IDistributionService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.sol";
-
-interface IInstanceBase {
-    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
-    function updateState(Key32 key, StateId state) external;
-    function getState(Key32 key) external view returns (StateId state);
-
-    function getComponentOwnerService() external view returns(IComponentOwnerService);
-    function getDistributionService() external view returns(IDistributionService);
-    function getProductService() external view returns(IProductService service);
-    function getPoolService() external view returns(IPoolService service);
-}