@etherisc/gif-next 0.0.2-c2a8d66-341 → 0.0.2-c2daf33-461

package/contracts/instance/InstanceAccessManager.sol

@@ -1,455 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
-
-import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE, INSTANCE_SERVICE_ROLE, INSTANCE_OWNER_ROLE} from "../types/RoleId.sol";
-import {TimestampLib} from "../types/Timestamp.sol";
-import {NftId} from "../types/NftId.sol";
-
-import {IAccess} from "./module/IAccess.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-
-contract InstanceAccessManager is
-    AccessManagedUpgradeable
-{
-    using RoleIdLib for RoleId;
-
-    string public constant ADMIN_ROLE_NAME = "AdminRole";
-    string public constant PUBLIC_ROLE_NAME = "PublicRole";
-
-    uint64 public constant CUSTOM_ROLE_ID_MIN = 10000;
-    uint32 public constant EXECUTION_DELAY = 0;
-
-    // role specific state
-    mapping(RoleId roleId => IAccess.RoleInfo info) internal _roleInfo;
-    mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
-    mapping(ShortString name => RoleId roleId) internal _roleIdForName;
-    RoleId [] internal _roleIds;
-    uint64 _idNext;
-
-    // target specific state
-    mapping(address target => IAccess.TargetInfo info) internal _targetInfo;
-    mapping(ShortString name => address target) internal _targetAddressForName;
-    address [] internal _targets;
-
-    AccessManager internal _accessManager;
-    IRegistry internal _registry;
-
-    modifier restrictedToRoleAdmin(RoleId roleId) {
-        RoleId admin = getRoleAdmin(roleId);
-        (bool inRole, uint32 executionDelay) = _accessManager.hasRole(admin.toInt(), _msgSender());
-        assert(executionDelay == 0); // to be sure no delayed execution functionality is used
-        if (!inRole) {
-            revert IAccess.ErrorIAccessCallerIsNotRoleAdmin(_msgSender(), roleId);
-        }
-        _;
-    }
-
-    function initialize(address initialAdmin, address registry) external initializer 
-    {
-        require(initialAdmin != address(0));
-        require(registry != address(0));
-
-        // if size of the contract gets too large, this can be externalized which will reduce the contract size considerably
-        _accessManager = new AccessManager(address(this));
-
-        __AccessManaged_init(address(_accessManager));
-
-        _registry = IRegistry(registry);
-        _idNext = CUSTOM_ROLE_ID_MIN;
-
-        _createRole(ADMIN_ROLE(), ADMIN_ROLE_NAME, IAccess.Type.Core);
-        _createRole(PUBLIC_ROLE(), PUBLIC_ROLE_NAME, IAccess.Type.Core);
-
-        // assume initialAdmin is instance service which requires admin rights to access manager during instance cloning
-        _accessManager.grantRole(ADMIN_ROLE().toInt(), initialAdmin, 0);
-
-        EnumerableSet.add(_roleMembers[ADMIN_ROLE()], address(this));
-        EnumerableSet.add(_roleMembers[ADMIN_ROLE()], initialAdmin);
-    }
-
-    //--- Role ------------------------------------------------------//
-    // INSTANCE_SERVICE_ROLE 
-    // assume core roles are never revoked or renounced -> core roles admin is never active after intialization
-    function createCoreRole(RoleId roleId, string memory name, RoleId admin) 
-        external
-        restricted()
-    {
-        _validateRoleParameters(roleId, name, IAccess.Type.Core);// TODO put inside _createRole
-        _createRole(roleId, name, IAccess.Type.Core);
-        setRoleAdmin(roleId, admin);
-    }
-    // INSTANCE_SERVICE_ROLE
-    // assume gif roles can be revoked or renounced
-    function createGifRole(RoleId roleId, string memory name, RoleId admin) 
-        external
-        restricted()
-    {
-        _validateRoleParameters(roleId, name, IAccess.Type.Gif);
-        _createRole(roleId, name, IAccess.Type.Gif);
-        setRoleAdmin(roleId, admin);
-    }
-
-    // INSTANCE_OWNER_ROLE
-    // creates custom roles only
-    // TODO INSTANCE_OWNER_ROLE as default admin
-    function createCustomRole(string memory name, RoleId admin) 
-        external
-        restricted()
-        returns(RoleId roleId)
-    {
-        RoleId roleId = _getNextCustomRoleId();
-        _validateRoleParameters(roleId, name, IAccess.Type.Custom);
-        _createRole(roleId, name, IAccess.Type.Custom);
-        setRoleAdmin(roleId, admin);
-    }
-
-    // TODO MUST always be restricted to ADMIN_ROLE? -> use onlyAdminRole or use similar _getAdminRestrictions()
-    function setRoleAdmin(RoleId roleId, RoleId admin) 
-        public 
-        restricted()
-    {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        if (!roleExists(admin)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(admin);
-        }        
-
-        _roleInfo[roleId].admin = admin;      
-    }
-
-    // TODO notify member?
-    // TODO granting/revoking can be `attached` to nft transfer?
-    function grantRole(RoleId roleId, address member) 
-        external 
-        restrictedToRoleAdmin(roleId) 
-        returns (bool granted) 
-    {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        granted = EnumerableSet.add(_roleMembers[roleId], member);
-        if(granted) {
-            _accessManager.grantRole(roleId.toInt(), member, EXECUTION_DELAY);
-        }    
-    }
-
-    function revokeRole(RoleId roleId, address member)
-        external 
-        restrictedToRoleAdmin(roleId) 
-        returns (bool) 
-    {
-        return _revokeRole(roleId, member);
-    }
-
-    /// @dev not restricted function by intention
-    /// the restriction to role members is already enforced by the call to the access manager
-    function renounceRole(RoleId roleId) 
-        external 
-        returns (bool) 
-    {
-        address member = msg.sender;
-        // cannot use accessManger.renounce as it directly checks against msg.sender
-        return _revokeRole(roleId, member);
-    }
-
-    function roleExists(RoleId roleId) public view returns (bool exists) {
-        return _roleInfo[roleId].createdAt.gtz();
-    }
-
-    function getRoleAdmin(RoleId roleId) public view returns(RoleId admin) {
-        return _roleInfo[roleId].admin;
-    }
-
-    function getRoleInfo(RoleId roleId) external view returns (IAccess.RoleInfo memory role) {
-        return _roleInfo[roleId];
-    }
-
-    function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers) {
-        return EnumerableSet.length(_roleMembers[roleId]);
-    }
-
-    function getRoleId(uint256 idx) external view returns (RoleId roleId) {
-        return _roleIds[idx];
-    }
-
-    function getRoleIdForName(string memory name) external view returns (RoleId roleId) {
-        return _roleIdForName[ShortStrings.toShortString(name)];
-    }
-
-    function roleMember(RoleId roleId, uint256 idx) external view returns (address roleMember) {
-        return EnumerableSet.at(_roleMembers[roleId], idx);
-    }
-
-    function hasRole(RoleId roleId, address account) external view returns (bool accountHasRole) {
-        (accountHasRole, ) = _accessManager.hasRole(roleId.toInt(), account);
-    }
-
-    function roles() external view returns (uint256 numberOfRoles) {
-        return _roleIds.length;
-    }
-
-    //--- Target ------------------------------------------------------//
-    // INSTANCE_SERVICE_ROLE
-    function createCoreTarget(address target, string memory name) external restricted() {
-        _createTarget(target, name, IAccess.Type.Core);
-    }
-    // INSTANCE_SERVICE_ROLE
-    function createGifTarget(address target, string memory name) external restricted() {
-        _createTarget(target, name, IAccess.Type.Gif);
-    }
-    // INSTANCE_OWNER_ROLE
-    function createCustomTarget(address target, string memory name) 
-        external 
-        restricted() 
-    {
-        // TODO custom targets can not be registered before this function, but possibly can after...
-        if(_registry.isRegistered(target)) {
-            revert IAccess.ErrorIAccessTargetIsRegistered(target);
-        }
-
-        _createTarget(target, name, IAccess.Type.Custom);
-    }
-    // INSTANCE_SERVICE_ROLE
-    function setTargetLocked(string memory targetName, bool locked) 
-        external 
-        restricted() 
-    {
-        ShortString nameShort = ShortStrings.toShortString(targetName);
-        address target = _targetAddressForName[nameShort];
-        
-        if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetDoesNotExist(nameShort);
-        }
-
-        if(_targetInfo[target].ttype == IAccess.Type.Core) {
-            revert IAccess.ErrorIAccessTargetTypeInvalid(nameShort, _targetInfo[target].ttype);
-        }
-        // TODO isLocked is redundant but makes getTargetInfo() faster
-        _targetInfo[target].isLocked = locked;
-        _accessManager.setTargetClosed(target, locked);
-    }
-
-    // allowed combinations of roles and targets:
-    //1) set core role for core target 
-    //2) set gif role for gif target  
-    //3) set custom role for gif target
-    //4) set custom role for custom target
-
-    // ADMIN_ROLE if used only during initialization, works with:
-    //      any roles for any targets
-    // INSTANCE_SERVICE_ROLE if used not only during initilization, works with:
-    //      core roles for core targets
-    //      gif roles for gif targets
-    // TODO taget admin example: 
-    // 1) INSTANCE_OWNER_ROLE is admin role for component target
-    // 2) ADMIN_ROLE is admin role for core targets
-    function setTargetFunctionRole(
-        string memory targetName,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) 
-        public 
-        virtual 
-        restricted()
-    {
-        ShortString nameShort = ShortStrings.toShortString(targetName);
-        address target = _targetAddressForName[nameShort];
-
-        // not custom target
-        if(_targetInfo[target].ttype == IAccess.Type.Custom) {
-            revert IAccess.ErrorIAccessTargetTypeInvalid(nameShort, _targetInfo[target].ttype);
-        }
-
-        // not custom role
-        if(_roleInfo[roleId].rtype == IAccess.Type.Custom) {
-            revert IAccess.ErrorIAccessRoleTypeInvalid(roleId, _roleInfo[roleId].rtype);
-        }
-
-        _setTargetFunctionRole(target, nameShort, selectors, roleId);
-    }
-
-    // INSTANCE_OWNER_ROLE
-    // custom role for gif target -> instance owner can mess with gif target (component) -> e.g. set custom role for function intendent to work with gif role
-    // custom role for custom target
-    function setTargetFunctionCustomRole(
-        string memory targetName,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) 
-        public 
-        virtual 
-        restricted() 
-    {
-        ShortString nameShort = ShortStrings.toShortString(targetName);
-        address target = _targetAddressForName[nameShort];
-
-        // not core target
-        if(_targetInfo[target].ttype == IAccess.Type.Core) {
-            revert IAccess.ErrorIAccessTargetTypeInvalid(nameShort, _targetInfo[target].ttype);
-        }
-
-        // target belongs to instance owned by caller
-        // TODO parent may be !instance
-        NftId instanceNftId = _registry.getObjectInfo(target).parentNftId;
-        address instanceAddress = _registry.getObjectInfo(instanceNftId).objectAddress;
-        if(_registry.ownerOf(instanceAddress) != msg.sender) {
-            revert IAccess.ErrorIAccessTargetInstanceMismatch(nameShort, instanceNftId);
-        }
-
-        // not core role
-        if(_roleInfo[roleId].rtype == IAccess.Type.Core) {
-            revert IAccess.ErrorIAccessRoleTypeInvalid(roleId, _roleInfo[roleId].rtype);
-        }
-
-        _setTargetFunctionRole(target, nameShort, selectors, roleId);
-    }
-
-    function isTargetLocked(address target) public view returns (bool locked) {
-        return _accessManager.isTargetClosed(target);
-    }
-
-    function targetExists(address target) public view returns (bool exists) {
-        return _targetInfo[target].createdAt.gtz();
-    }
-
-    function getTargetInfo(address target) public view returns (IAccess.TargetInfo memory) {
-        return _targetInfo[target];
-    }
-
-    //--- internal view/pure functions --------------------------------------//
-
-    function _createRole(RoleId roleId, string memory name, IAccess.Type rtype) 
-        internal
-    {
-        IAccess.RoleInfo memory role = IAccess.RoleInfo(
-            ShortStrings.toShortString(name), 
-            rtype,
-            ADMIN_ROLE(),
-            TimestampLib.blockTimestamp(),
-            TimestampLib.blockTimestamp());
-
-        _roleInfo[roleId] = role;
-        _roleIdForName[role.name] = roleId;
-        _roleIds.push(roleId);
-    }
-
-    function _validateRoleParameters(
-        RoleId roleId, 
-        string memory name, 
-        IAccess.Type rtype
-    )
-        internal
-        view 
-        returns (IAccess.RoleInfo memory existingRole)
-    {
-        if(roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdAlreadyExists(roleId);
-        }
-
-        uint roleIdInt = roleId.toInt();
-        if(rtype == IAccess.Type.Custom && roleIdInt < CUSTOM_ROLE_ID_MIN) {
-            revert IAccess.ErrorIAccessRoleIdTooSmall(roleId);
-        }
-
-        if(rtype != IAccess.Type.Custom && roleIdInt >= CUSTOM_ROLE_ID_MIN) {
-            revert IAccess.ErrorIAccessRoleIdTooBig(roleId);
-        }
-
-        // role name checks
-        ShortString nameShort = ShortStrings.toShortString(name);
-        if (ShortStrings.byteLength(nameShort) == 0) {
-            revert IAccess.ErrorIAccessRoleNameEmpty(roleId);
-        }
-
-        if (_roleIdForName[nameShort].gtz()) {
-            revert IAccess.ErrorIAccessRoleNameNotUnique(_roleIdForName[nameShort], nameShort);
-        }
-    }
-
-    function _revokeRole(RoleId roleId, address member) 
-        internal
-        returns(bool revoked)
-    {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        revoked = EnumerableSet.remove(_roleMembers[roleId], member);
-        if(revoked) {
-            _accessManager.revokeRole(roleId.toInt(), member);
-        }
-    }
-
-    function _getNextCustomRoleId() internal returns(RoleId) {
-        return RoleIdLib.toRoleId(_idNext++);
-    }
-
-    function _createTarget(address target, string memory name, IAccess.Type ttype) internal {
-        _validateTargetParameters(target, name);
-
-        IAccess.TargetInfo memory info = IAccess.TargetInfo(
-            ShortStrings.toShortString(name), 
-            ttype,
-            _accessManager.isTargetClosed(target), // sync with state in access manager
-            TimestampLib.blockTimestamp(),
-            TimestampLib.blockTimestamp());
-
-        _targetInfo[target] = info;
-        _targetAddressForName[info.name] = target;
-        _targets.push(target);
-    }
-
-    function _validateTargetParameters(address target, string memory name) internal view {
-        if (_targetInfo[target].createdAt.gtz()) {
-            revert IAccess.ErrorIAccessTargetAlreadyExists(target, _targetInfo[target].name);
-        }
-
-        ShortString nameShort = ShortStrings.toShortString(name);
-        if (ShortStrings.byteLength(nameShort) == 0) {
-            revert IAccess.ErrorIAccessTargetNameEmpty(target);
-        }
-
-        if (_targetAddressForName[nameShort] != address(0)) {
-            revert IAccess.ErrorIAccessTargetNameExists(
-                target, 
-                _targetAddressForName[nameShort], 
-                nameShort);
-        }
-    }
-
-    function _setTargetFunctionRole(
-        address target,
-        ShortString name,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) 
-        internal
-    {
-        if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetDoesNotExist(name);
-        }
-
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        uint64 roleIdInt = RoleId.unwrap(roleId);
-        _accessManager.setTargetFunctionRole(target, selectors, roleIdInt);
-    }
-
-    function canCall(
-        address caller,
-        address target,
-        bytes4 selector
-    ) public view virtual returns (bool immediate, uint32 delay) {
-        return _accessManager.canCall(caller, target, selector);
-    }
-}

package/contracts/instance/base/ComponentService.sol

@@ -1,134 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IComponent} from "../../components/IComponent.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IAccess} from "../module/IAccess.sol";
-import {ObjectType, INSTANCE, REGISTRY} from "../../types/ObjectType.sol";
-import {NftId} from "../../types/NftId.sol";
-import {RoleId} from "../../types/RoleId.sol";
-
-import {Service} from "../../shared/Service.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceAccessManager} from "../InstanceAccessManager.sol";
-
-abstract contract ComponentService is Service {
-
-    error ErrorComponentServiceAlreadyRegistered(address component, NftId nftId);
-    error ErrorComponentServiceNotComponent(address component);
-    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
-    error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
-    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
-    error ErrorComponentServiceComponentLocked(address component);
-
-    /// @dev modifier to check if caller is a registered service
-    modifier onlyService() {
-        address caller = msg.sender;
-        require(getRegistry().isRegisteredService(caller), "ERROR_NOT_SERVICE");
-        _;
-    }
-
-    // view functions
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
-        return IRegistryService(service);
-    }
-
-    function getInstanceService() public view returns (InstanceService) {
-        address service = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
-        return InstanceService(service);
-    }
-
-    // internal functions
-    function _checkComponentForRegistration(
-        address componentAddress,
-        ObjectType requiredType,
-        RoleId requiredRole
-    )
-        internal
-        view
-        returns (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        )
-    {
-        // component may only be registerd by initial owner of component
-        owner = msg.sender;
-
-        // check component has not already been registerd
-        NftId compoentNftId = _registry.getNftId(componentAddress);
-        if(compoentNftId.gtz()) {
-            revert ErrorComponentServiceAlreadyRegistered(componentAddress, compoentNftId);
-        }
-
-        // check this is a component
-        component = IComponent(componentAddress);
-        if(!component.supportsInterface(type(IComponent).interfaceId)) {
-            revert ErrorComponentServiceNotComponent(componentAddress);
-        }
-
-        // check component is of required type
-        IRegistry.ObjectInfo memory componentInfo = component.getInitialInfo();
-        if(componentInfo.objectType != requiredType) {
-            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, componentInfo.objectType);
-        }
-
-        // check msg.sender is component owner
-        address initialOwner = componentInfo.initialOwner;
-        if(owner != initialOwner) {
-            revert ErrorComponentServiceSenderNotOwner(componentAddress, componentInfo.initialOwner, owner);
-        }
-
-        // check instance has assigned required role to owner
-        instanceNftId = componentInfo.parentNftId;
-        instance = _getInstance(instanceNftId);
-        bool hasRole = getInstanceService().hasRole(
-            owner, 
-            requiredRole, 
-            address(instance));
-
-        if(!hasRole) {
-            revert ErrorComponentServiceExpectedRoleMissing(instanceNftId, requiredRole, owner);
-        }
-    }
-
-    // internal view functions
-
-    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        return IInstance(instanceInfo.objectAddress);
-    }
-
-    function _getAndVerifyComponentInfoAndInstance(
-        //address component,
-        ObjectType expectedType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        IRegistry registry = getRegistry();
-        //TODO redundant check -> just check type
-        //NftId componentNftId = registry.getNftId(component); 
-        //require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = registry.getObjectInfo(msg.sender);
-        require(info.objectType == expectedType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-
-        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
-        if (accessManager.isTargetLocked(info.objectAddress)) {
-            revert IAccess.ErrorIAccessTargetLocked(info.objectAddress);
-        }
-    }
-}