@etherisc/gif-next 0.0.2-bca28f1-161 → 0.0.2-bcecc4c-647

package/contracts/experiment/inheritance/B.sol

@@ -1,28 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-
-abstract contract B is ISharedA, IB {
-    // names of private variables can be re-used in inheritance
-    uint256 private _x;
-
-    constructor() {
-        _x = 1;
-    }
-
-    // access own state
-    function getB() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setB(uint256 newB) external override {
-        _x = newB;
-    }
-
-    // access state from parent contract A
-    function getAfromB() external view override returns (uint256) {
-        return this.getA();
-    }
-}

package/contracts/experiment/inheritance/C.sol

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-abstract contract C is ISharedA, IC {
-    uint256 private _x;
-
-    constructor() {
-        _x = 2;
-    }
-
-    // access own state
-    function getC() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setC(uint256 newC) external override {
-        _x = newC;
-    }
-
-    // access state from parent contract A
-    function getAfromC() external view override returns (uint256) {
-        return this.getA();
-    }
-
-    // access state from other module B
-    function getBfromC() external view override returns (uint256) {
-        IB b = IB(address(this));
-        return b.getB();
-    }
-}

package/contracts/experiment/inheritance/IA.sol

@@ -1,13 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-interface ISharedA {
-    function getA() external view returns (uint256);
-
-    function setA(uint256 newA) external;
-}
-
-interface IA is ISharedA, IB, IC {}

package/contracts/experiment/inheritance/IB.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IB {
-    function getAfromB() external view returns (uint256);
-
-    function getB() external view returns (uint256);
-
-    function setB(uint256 newA) external;
-}

package/contracts/experiment/inheritance/IC.sol

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IC {
-    function getAfromC() external view returns (uint256);
-
-    function getBfromC() external view returns (uint256);
-
-    function getC() external view returns (uint256);
-
-    function setC(uint256 newA) external;
-}

package/contracts/experiment/statemachine/Dummy.sol

@@ -1,27 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-
-contract LifeCycleModule {
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    function getInitialState(
-        ObjectType objectType
-    ) external view returns (StateId) {
-        return _initialState[objectType];
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) external view returns (bool) {
-        return _isValidTransition[objectType][fromId][toId];
-    }
-}

package/contracts/experiment/statemachine/ISM.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId} from "../../types/StateId.sol";
-
-interface ISMEE {
-    error ErrorInitialStateUndefined();
-    error ErrorStartStateUndefined();
-    error ErrorNextStateUndefined();
-    error ErrorStateChangeInvalid(StateId currentStateId, StateId newStateId);
-
-    event LogInitialStateSet(StateId initialStateId);
-    event LogStateChanged(StateId oldStateId, StateId newStateId);
-}
-
-interface ISM is ISMEE {
-    function changeToState(StateId newStateId) external;
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view returns (bool isValid);
-
-    function getState() external view returns (StateId currentStateId);
-}

package/contracts/experiment/statemachine/SM.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-import {ISM} from "./ISM.sol";
-
-contract SM is ISM {
-    mapping(StateId currentState => mapping(StateId newState => bool isValid))
-        private _isValidTransition;
-
-    StateId internal _state;
-
-    function setInitialState(StateId initialStateId) internal {
-        if (initialStateId == zeroStateId()) {
-            revert ErrorInitialStateUndefined();
-        }
-
-        _state = initialStateId;
-    }
-
-    function addTransition(
-        StateId currentStateId,
-        StateId nextStateId
-    ) internal {
-        if (currentStateId == zeroStateId()) {
-            revert ErrorStartStateUndefined();
-        }
-
-        if (nextStateId == zeroStateId()) {
-            revert ErrorNextStateUndefined();
-        }
-
-        _isValidTransition[currentStateId][nextStateId] = true;
-    }
-
-    function changeToState(StateId newStateId) external override {
-        if (!_isValidTransition[_state][newStateId]) {
-            revert ErrorStateChangeInvalid(_state, newStateId);
-        }
-
-        StateId stateOld = _state;
-        _state = newStateId;
-
-        emit LogStateChanged(stateOld, _state);
-    }
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view override returns (bool isValid) {
-        return _isValidTransition[currentStateId][newStateId];
-    }
-
-    function getState() external view override returns (StateId state) {
-        return _state;
-    }
-}

package/contracts/experiment/statemachine/SimpleStateMachine.sol

@@ -1,31 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId} from "../../types/StateId.sol";
-import {SM} from "./SM.sol";
-
-contract SimpleStateMachine is SM {
-    uint8 public constant STATE_ACTIVE = 10;
-    uint8 public constant STATE_PAUSED = 20;
-    uint8 public constant STATE_ARCHIVED = 30;
-
-    constructor() {
-        addTransition(ACTIVE(), PAUSED());
-        addTransition(PAUSED(), ACTIVE());
-        addTransition(PAUSED(), ARCHIVED());
-
-        setInitialState(ACTIVE());
-    }
-
-    function ACTIVE() public pure returns (StateId stateId) {
-        return toStateId(STATE_ACTIVE);
-    }
-
-    function PAUSED() public pure returns (StateId stateId) {
-        return toStateId(STATE_PAUSED);
-    }
-
-    function ARCHIVED() public pure returns (StateId stateId) {
-        return toStateId(STATE_ARCHIVED);
-    }
-}

package/contracts/experiment/types/TypeA.sol

@@ -1,47 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-/*
-# chisel session for user defined types
-
-import {TypeA, toTypeA} from "./contracts/experiment/types/TypeA.sol";
-TypeA a = toTypeA(1);
-TypeA b = toTypeA(2);
-uint(a.toInt())
-uint(b.toInt())
-a == b
-a != b
-
-import {TypeB, toTypeB} from "./contracts/experiment/types/TypeB.sol";
-TypeB x = toTypeB(33);
-uint(x.toInt())
-a == x; // -> error
-a.toInt() == x.toInt() // -> no error
- */
-
-// bytes5 allows for chain ids up to 13 digits
-type TypeA is uint248;
-
-// type bindings
-using {eqTypeA as ==, neTypeA as !=, TypeALib.toInt} for TypeA global;
-
-// general pure free functions
-function toTypeA(uint256 typeA) pure returns (TypeA) {
-    return TypeA.wrap(uint248(typeA));
-}
-
-// pure free functions for operators
-function eqTypeA(TypeA a, TypeA b) pure returns (bool isSame) {
-    return TypeA.unwrap(a) == TypeA.unwrap(b);
-}
-
-function neTypeA(TypeA a, TypeA b) pure returns (bool isDifferent) {
-    return TypeA.unwrap(a) != TypeA.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library TypeALib {
-    function toInt(TypeA typeA) internal pure returns (uint256) {
-        return uint256(TypeA.unwrap(typeA));
-    }
-}

package/contracts/experiment/types/TypeB.sol

@@ -1,29 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// bytes5 allows for chain ids up to 13 digits
-type TypeB is uint248;
-
-// type bindings
-using {eqTypeB as ==, addTypeB as +, TypeBLib.toInt} for TypeB global;
-
-// general pure free functions
-function toTypeB(uint256 x) pure returns (TypeB) {
-    return TypeB.wrap(uint248(x));
-}
-
-// pure free functions for operators
-function eqTypeB(TypeB a, TypeB b) pure returns (bool isSame) {
-    return TypeB.unwrap(a) == TypeB.unwrap(b);
-}
-
-function addTypeB(TypeB a, TypeB b) pure returns (TypeB sum) {
-    return TypeB.wrap(TypeB.unwrap(a) + TypeB.unwrap(b));
-}
-
-// library functions that operate on user defined type
-library TypeBLib {
-    function toInt(TypeB b) internal pure returns (uint256) {
-        return uint256(TypeB.unwrap(b));
-    }
-}

package/contracts/instance/InstanceAccessManager.sol

@@ -1,297 +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 } from "../types/RoleId.sol";
-import {TimestampLib} from "../types/Timestamp.sol";
-import {IAccess} from "./module/IAccess.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 _role;
-    mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
-    mapping(ShortString name => RoleId roleId) internal _roleForName;
-    RoleId [] internal _roles;
-
-    // target specific state
-    mapping(address target => IAccess.TargetInfo info) internal _target;
-    mapping(ShortString name => address target) internal _targetForName;
-    address [] internal _targets;
-
-    AccessManager internal _accessManager;
-
-    function initialize(address initialAdmin) external initializer
-    {
-        // if size of the contract gets too large, this can be externalized which will reduce the contract size considerably
-        _accessManager = new AccessManager(address(this));
-        // this service required admin rights to access manager to be able to grant/revoke roles
-        _accessManager.grantRole(_accessManager.ADMIN_ROLE(), initialAdmin, 0);
-
-        __AccessManaged_init(address(_accessManager));
-
-        _createRole(RoleIdLib.toRoleId(_accessManager.ADMIN_ROLE()), ADMIN_ROLE_NAME, false, false);
-        _createRole(RoleIdLib.toRoleId(_accessManager.PUBLIC_ROLE()), PUBLIC_ROLE_NAME, false, false);
-    }
-
-    //--- Role ------------------------------------------------------//
-    function createGifRole(RoleId roleId, string memory name) external restricted() {
-        _createRole(roleId, name, false, true);
-    }
-
-    function createRole(RoleId roleId, string memory name) external restricted() {
-        _createRole(roleId, name, true, true);
-    }
-
-    function setRoleLocked(RoleId roleId, bool locked) external restricted() {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        _role[roleId].isLocked = locked;
-        _role[roleId].updatedAt = TimestampLib.blockTimestamp();
-    }
-
-    function roleExists(RoleId roleId) public view returns (bool exists) {
-        return _role[roleId].createdAt.gtz();
-    }
-
-    function grantRole(RoleId roleId, address member) external restricted() returns (bool granted) {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-
-        if (_role[roleId].isLocked) {
-            revert IAccess.ErrorIAccessRoleIdNotActive(roleId);
-        }
-
-        if (!EnumerableSet.contains(_roleMembers[roleId], member)) {
-            _accessManager.grantRole(roleId.toInt(), member, EXECUTION_DELAY);
-            EnumerableSet.add(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    function revokeRole(RoleId roleId, address member) external restricted() returns (bool revoked) {
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRevokeNonexstentRole(roleId);
-        }
-
-        if (EnumerableSet.contains(_roleMembers[roleId], member)) {
-            _accessManager.revokeRole(roleId.toInt(), member);
-            EnumerableSet.remove(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    /// @dev not restricted function by intention
-    /// the restriction to role members is already enforced by the call to the access manger
-    function renounceRole(RoleId roleId) external returns (bool revoked) {
-        address member = msg.sender;
-
-        if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRenounceNonexstentRole(roleId);
-        }
-
-        if (EnumerableSet.contains(_roleMembers[roleId], member)) {
-            // cannot use accessManger.renounce as it directly checks against msg.sender
-            _accessManager.revokeRole(roleId.toInt(), member);
-            EnumerableSet.remove(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    function roles() external view returns (uint256 numberOfRoles) {
-        return _roles.length;
-    }
-
-    function getRoleId(uint256 idx) external view returns (RoleId roleId) {
-        return _roles[idx];
-    }
-
-    function getRoleIdForName(string memory name) external view returns (RoleId roleId) {
-        return _roleForName[ShortStrings.toShortString(name)];
-    }
-
-    function getRole(RoleId roleId) external view returns (IAccess.RoleInfo memory role) {
-        return _role[roleId];
-    }
-
-    function hasRole(RoleId roleId, address account) external view returns (bool accountHasRole) {
-        (accountHasRole, ) = _accessManager.hasRole(roleId.toInt(), account);
-    }
-
-    function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers) {
-        return EnumerableSet.length(_roleMembers[roleId]);
-    }
-
-    function getRoleMember(RoleId roleId, uint256 idx) external view returns (address roleMember) {
-        return EnumerableSet.at(_roleMembers[roleId], idx);
-    }
-
-    //--- Target ------------------------------------------------------//
-    function createGifTarget(address target, string memory name) external restricted() {
-        _createTarget(target, name, false, true);
-    }
-
-    function createTarget(address target, string memory name) external restricted() {
-        _createTarget(target, name, true, true);
-    }
-
-    function setTargetLocked(string memory targetName, bool locked) external restricted() {
-        address target = _targetForName[ShortStrings.toShortString(targetName)];
-        
-        if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
-        }
-
-        _target[target].isLocked = locked;
-        _accessManager.setTargetClosed(target, locked);
-    }
-
-    function targetExists(address target) public view returns (bool exists) {
-        return _target[target].createdAt.gtz();
-    }
-
-    //--- internal view/pure functions --------------------------------------//
-
-    function _createRole(RoleId roleId, string memory name, bool isCustom, bool validateParameters) internal {
-        if (validateParameters) {
-            _validateRoleParameters(roleId, name, isCustom);
-        }
-
-        IAccess.RoleInfo memory role = IAccess.RoleInfo(
-            ShortStrings.toShortString(name), 
-            isCustom,
-            false, // role un-locked,
-            TimestampLib.blockTimestamp(),
-            TimestampLib.blockTimestamp());
-
-        _role[roleId] = role;
-        _roleForName[role.name] = roleId;
-        _roles.push(roleId);
-    }
-
-    function _validateRoleParameters(
-        RoleId roleId, 
-        string memory name, 
-        bool isCustom
-    )
-        internal
-        view 
-        returns (IAccess.RoleInfo memory existingRole)
-    {
-        // check role id
-        uint64 roleIdInt = RoleId.unwrap(roleId);
-        if(roleIdInt == _accessManager.ADMIN_ROLE() || roleIdInt == _accessManager.PUBLIC_ROLE()) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId); 
-        }
-
-        // prevent changing isCustom for existing roles
-        existingRole = _role[roleId];
-
-        if (existingRole.createdAt.gtz() && isCustom != existingRole.isCustom) {
-            revert IAccess.ErrorIAccessRoleIsCustomIsImmutable(roleId, isCustom, existingRole.isCustom); 
-        }
-
-        if (isCustom && roleIdInt < CUSTOM_ROLE_ID_MIN) {
-            revert IAccess.ErrorIAccessRoleIdTooSmall(roleId); 
-        } else if (!isCustom && 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 (_roleForName[nameShort] != RoleIdLib.zero() && _roleForName[nameShort] != roleId) {
-            revert IAccess.ErrorIAccessRoleNameNotUnique(_roleForName[nameShort], nameShort);
-        }
-    }
-
-    function _createTarget(address target, string memory name, bool isCustom, bool validateParameters) internal {
-        if (validateParameters) {
-            _validateTargetParameters(target, name, isCustom);
-        }
-
-        if (_target[target].createdAt.gtz()) {
-            revert IAccess.ErrorIAccessTargetExists(target, _target[target].name);
-        }
-        if (_targetForName[ShortStrings.toShortString(name)] != address(0)) {
-            revert IAccess.ErrorIAccessTargetNameExists(target, _targetForName[ShortStrings.toShortString(name)], ShortStrings.toShortString(name));
-        }
-
-        IAccess.TargetInfo memory info = IAccess.TargetInfo(
-            ShortStrings.toShortString(name), 
-            isCustom,
-            _accessManager.isTargetClosed(target), // sync with state in access manager
-            TimestampLib.blockTimestamp(),
-            TimestampLib.blockTimestamp());
-
-        _target[target] = info;
-        _targetForName[info.name] = target;
-        _targets.push(target);
-    }
-
-    function _validateTargetParameters(address target, string memory name, bool isCustom) internal view {
-        // TODO: implement
-    }
-
-    function setTargetFunctionRole(
-        string memory targetName,
-        bytes4[] calldata selectors,
-        RoleId roleId
-    ) public virtual restricted() {
-        address target = _targetForName[ShortStrings.toShortString(targetName)];
-        
-        if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
-        }
-        if (! roleExists(roleId)) {
-            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
-        }
-        uint64 roleIdInt = RoleId.unwrap(roleId);
-        _accessManager.setTargetFunctionRole(target, selectors, roleIdInt);
-    }
-
-    function setTargetClosed(string memory targetName, bool closed) public restricted() {
-        address target = _targetForName[ShortStrings.toShortString(targetName)];
-        if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
-        }
-        _accessManager.setTargetClosed(target, closed);
-    }
-
-    function isTargetLocked(address target) public view returns (bool locked) {
-        return _accessManager.isTargetClosed(target);
-    }
-
-    function canCall(
-        address caller,
-        address target,
-        bytes4 selector
-    ) public view virtual returns (bool immediate, uint32 delay) {
-        return _accessManager.canCall(caller, target, selector);
-    }
-}