@gnosis-guild/zodiac 4.2.1 → 5.0.0

package/contracts/guard/BaseGuard.sol

@@ -1,36 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.7.0 <0.9.0;
-
-import {Enum} from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-
-import {IGuard} from "../interfaces/IGuard.sol";
-
-abstract contract BaseGuard is IERC165 {
-  function supportsInterface(
-    bytes4 interfaceId
-  ) external pure override returns (bool) {
-    return
-      interfaceId == type(IGuard).interfaceId || // 0xe6d7a83a
-      interfaceId == type(IERC165).interfaceId; // 0x01ffc9a7
-  }
-
-  /// @dev Module transactions only use the first four parameters: to, value, data, and operation.
-  /// Module.sol hardcodes the remaining parameters as 0 since they are not used for module transactions.
-  /// @notice This interface is used to maintain compatibilty with Gnosis Safe transaction guards.
-  function checkTransaction(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation,
-    uint256 safeTxGas,
-    uint256 baseGas,
-    uint256 gasPrice,
-    address gasToken,
-    address payable refundReceiver,
-    bytes memory signatures,
-    address msgSender
-  ) external virtual;
-
-  function checkAfterExecution(bytes32 txHash, bool success) external virtual;
-}

package/contracts/guard/Guardable.sol

@@ -1,32 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.7.0 <0.9.0;
-
-import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
-
-import {BaseGuard} from "../guard/BaseGuard.sol";
-import {IGuard} from "../interfaces/IGuard.sol";
-
-/// @title Guardable - A contract that manages fallback calls made to this contract
-contract Guardable is OwnableUpgradeable {
-  address public guard;
-
-  event ChangedGuard(address guard);
-
-  /// `guard_` does not implement IERC165.
-  error NotIERC165Compliant(address guard_);
-
-  /// @dev Set a guard that checks transactions before execution.
-  /// @param _guard The address of the guard to be used or the 0 address to disable the guard.
-  function setGuard(address _guard) external onlyOwner {
-    if (_guard != address(0)) {
-      if (!BaseGuard(_guard).supportsInterface(type(IGuard).interfaceId))
-        revert NotIERC165Compliant(_guard);
-    }
-    guard = _guard;
-    emit ChangedGuard(guard);
-  }
-
-  function getGuard() external view returns (address _guard) {
-    return guard;
-  }
-}

package/contracts/interfaces/IAvatar.sol

@@ -1,71 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-
-/// @title Zodiac Avatar - A contract that manages modules that can execute transactions via this contract.
-pragma solidity >=0.7.0 <0.9.0;
-
-import {Enum} from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
-
-interface IAvatar {
-  event EnabledModule(address module);
-  event DisabledModule(address module);
-  event ExecutionFromModuleSuccess(address indexed module);
-  event ExecutionFromModuleFailure(address indexed module);
-
-  /// @dev Enables a module on the avatar.
-  /// @notice Can only be called by the avatar.
-  /// @notice Modules should be stored as a linked list.
-  /// @notice Must emit EnabledModule(address module) if successful.
-  /// @param module Module to be enabled.
-  function enableModule(address module) external;
-
-  /// @dev Disables a module on the avatar.
-  /// @notice Can only be called by the avatar.
-  /// @notice Must emit DisabledModule(address module) if successful.
-  /// @param prevModule Address that pointed to the module to be removed in the linked list
-  /// @param module Module to be removed.
-  function disableModule(address prevModule, address module) external;
-
-  /// @dev Allows a Module to execute a transaction.
-  /// @notice Can only be called by an enabled module.
-  /// @notice Must emit ExecutionFromModuleSuccess(address module) if successful.
-  /// @notice Must emit ExecutionFromModuleFailure(address module) if unsuccessful.
-  /// @param to Destination address of module transaction.
-  /// @param value Ether value of module transaction.
-  /// @param data Data payload of module transaction.
-  /// @param operation Operation type of module transaction: 0 == call, 1 == delegate call.
-  function execTransactionFromModule(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) external returns (bool success);
-
-  /// @dev Allows a Module to execute a transaction and return data
-  /// @notice Can only be called by an enabled module.
-  /// @notice Must emit ExecutionFromModuleSuccess(address module) if successful.
-  /// @notice Must emit ExecutionFromModuleFailure(address module) if unsuccessful.
-  /// @param to Destination address of module transaction.
-  /// @param value Ether value of module transaction.
-  /// @param data Data payload of module transaction.
-  /// @param operation Operation type of module transaction: 0 == call, 1 == delegate call.
-  function execTransactionFromModuleReturnData(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) external returns (bool success, bytes memory returnData);
-
-  /// @dev Returns if an module is enabled
-  /// @return True if the module is enabled
-  function isModuleEnabled(address module) external view returns (bool);
-
-  /// @dev Returns array of modules.
-  /// @param start Start of the page.
-  /// @param pageSize Maximum number of modules that should be returned.
-  /// @return array Array of modules.
-  /// @return next Start of the next page.
-  function getModulesPaginated(
-    address start,
-    uint256 pageSize
-  ) external view returns (address[] memory array, address next);
-}

package/contracts/interfaces/IGuard.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.7.0 <0.9.0;
-
-import {Enum} from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
-
-interface IGuard {
-  function checkTransaction(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation,
-    uint256 safeTxGas,
-    uint256 baseGas,
-    uint256 gasPrice,
-    address gasToken,
-    address payable refundReceiver,
-    bytes memory signatures,
-    address msgSender
-  ) external;
-
-  function checkAfterExecution(bytes32 txHash, bool success) external;
-}

package/contracts/signature/ExecutionTracker.sol

@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.8.0 <0.9.0;
-
-/// @title ExecutionTracker - A contract that keeps track of executed and invalidated hashes
-contract ExecutionTracker {
-  error HashAlreadyConsumed(bytes32);
-
-  event HashExecuted(bytes32);
-  event HashInvalidated(bytes32);
-
-  mapping(address => mapping(bytes32 => bool)) public consumed;
-
-  function invalidate(bytes32 hash) external {
-    consumed[msg.sender][hash] = true;
-    emit HashInvalidated(hash);
-  }
-}

package/contracts/signature/IERC1271.sol

@@ -1,19 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-/* solhint-disable one-contract-per-file */
-pragma solidity >=0.7.0 <0.9.0;
-
-interface IERC1271 {
-  /**
-   * @notice EIP1271 method to validate a signature.
-   * @param hash Hash of the data signed on the behalf of address(this).
-   * @param signature Signature byte array associated with _data.
-   *
-   * MUST return the bytes4 magic value 0x1626ba7e when function passes.
-   * MUST NOT modify state (using STATICCALL for solc < 0.5, view modifier for solc > 0.5)
-   * MUST allow external calls
-   */
-  function isValidSignature(
-    bytes32 hash,
-    bytes memory signature
-  ) external view returns (bytes4);
-}

package/contracts/signature/SignatureChecker.sol

@@ -1,154 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.8.0 <0.9.0;
-
-import {IERC1271} from "./IERC1271.sol";
-
-/// @title SignatureChecker - A contract that retrieves and validates signatures appended to transaction calldata.
-/// @dev currently supports eip-712 and eip-1271 signatures
-abstract contract SignatureChecker {
-  /**
-   * @notice Searches for a signature, validates it, and returns the signer's address.
-   * @dev When signature not found or invalid, zero address is returned
-   * @return The address of the signer.
-   */
-  function moduleTxSignedBy() internal view returns (bytes32, address) {
-    bytes calldata data = msg.data;
-
-    /*
-     * The idea is to extend `onlyModule` and provide signature checking
-     * without code changes to inheriting contracts (Modifiers).
-     *
-     * Since it's a generic mechanism, there is no way to conclusively
-     * identify the trailing bytes as a signature. We simply slice those
-     * and recover signer.
-     *
-     * As a result, we impose a minimum calldata length equal to a function
-     * selector plus salt, plus a signature (i.e., 4 + 32 + 65 bytes), any
-     * shorter and calldata it guaranteed to not contain a signature.
-     */
-    if (data.length < 4 + 32 + 65) {
-      return (bytes32(0), address(0));
-    }
-
-    (uint8 v, bytes32 r, bytes32 s) = _splitSignature(data);
-
-    uint256 end = data.length - (32 + 65);
-    bytes32 salt = bytes32(data[end:]);
-
-    /*
-     * When handling contract signatures:
-     *  v - is zero
-     *  r - contains the signer
-     *  s - contains the offset within calldata where the signer specific
-     *      signature is located
-     *
-     * We detect contract signatures by checking:
-     *  1- `v` is zero
-     *  2- `s` points within the buffer, is after selector, is before
-     *      salt and delimits a non-zero length buffer
-     */
-    if (v == 0) {
-      uint256 start = uint256(s);
-      if (start < 4 || start > end) {
-        return (bytes32(0), address(0));
-      }
-      address signer = address(uint160(uint256(r)));
-
-      bytes32 hash = moduleTxHash(data[:start], salt);
-      return
-        _isValidContractSignature(signer, hash, data[start:end])
-          ? (hash, signer)
-          : (bytes32(0), address(0));
-    } else {
-      bytes32 hash = moduleTxHash(data[:end], salt);
-      return (hash, ecrecover(hash, v, r, s));
-    }
-  }
-
-  /**
-   * @notice Hashes the transaction EIP-712 data structure.
-   * @dev The produced hash is intended to be signed.
-   * @param data The current transaction's calldata.
-   * @param salt The salt value.
-   * @return The 32-byte hash that is to be signed.
-   */
-  function moduleTxHash(
-    bytes calldata data,
-    bytes32 salt
-  ) public view returns (bytes32) {
-    bytes32 domainSeparator = keccak256(
-      abi.encode(DOMAIN_SEPARATOR_TYPEHASH, block.chainid, this)
-    );
-    bytes memory moduleTxData = abi.encodePacked(
-      bytes1(0x19),
-      bytes1(0x01),
-      domainSeparator,
-      keccak256(abi.encode(MODULE_TX_TYPEHASH, keccak256(data), salt))
-    );
-    return keccak256(moduleTxData);
-  }
-
-  /**
-   * @dev Extracts signature from calldata, and divides it into `uint8 v, bytes32 r, bytes32 s`.
-   * @param data The current transaction's calldata.
-   * @return v The ECDSA v value
-   * @return r The ECDSA r value
-   * @return s The ECDSA s value
-   */
-  function _splitSignature(
-    bytes calldata data
-  ) private pure returns (uint8 v, bytes32 r, bytes32 s) {
-    v = uint8(bytes1(data[data.length - 1:]));
-    r = bytes32(data[data.length - 65:]);
-    s = bytes32(data[data.length - 33:]);
-  }
-
-  /**
-   * @dev Calls the signer contract, and validates the contract signature.
-   * @param signer The address of the signer contract.
-   * @param hash Hash of the data signed
-   * @param signature The contract signature.
-   * @return result Indicates whether the signature is valid.
-   */
-  function _isValidContractSignature(
-    address signer,
-    bytes32 hash,
-    bytes calldata signature
-  ) internal view returns (bool result) {
-    uint256 size;
-    // eslint-disable-line no-inline-assembly
-    assembly {
-      size := extcodesize(signer)
-    }
-    if (size == 0) {
-      return false;
-    }
-
-    (, bytes memory returnData) = signer.staticcall(
-      abi.encodeWithSelector(
-        IERC1271.isValidSignature.selector,
-        hash,
-        signature
-      )
-    );
-
-    return bytes4(returnData) == EIP1271_MAGIC_VALUE;
-  }
-
-  // keccak256(
-  //     "EIP712Domain(uint256 chainId,address verifyingContract)"
-  // );
-  bytes32 private constant DOMAIN_SEPARATOR_TYPEHASH =
-    0x47e79534a245952e8b16893a336b85a3d9ea9fa8c573f3d803afb92a79469218;
-
-  // keccak256(
-  //     "ModuleTx(bytes data,bytes32 salt)"
-  // );
-  bytes32 private constant MODULE_TX_TYPEHASH =
-    0x2939aeeda3ca260200c9f7b436b19e13207547ccc65cfedc857751c5ea6d91d4;
-
-  // bytes4(keccak256(
-  //     "isValidSignature(bytes32,bytes)"
-  // ));
-  bytes4 private constant EIP1271_MAGIC_VALUE = 0x1626ba7e;
-}

package/contracts/test/TestAvatar.sol

@@ -1,64 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.8.0;
-
-contract Enum {
-  enum Operation {
-    Call,
-    DelegateCall
-  }
-}
-
-contract TestAvatar {
-  address public module;
-
-  receive() external payable {}
-
-  function enableModule(address _module) external {
-    module = _module;
-  }
-
-  function disableModule(address, address) external {
-    module = address(0);
-  }
-
-  function isModuleEnabled(address _module) external view returns (bool) {
-    if (module == _module) {
-      return true;
-    } else {
-      return false;
-    }
-  }
-
-  function execTransactionFromModule(
-    address payable to,
-    uint256 value,
-    bytes calldata data,
-    uint8 operation
-  ) external returns (bool success) {
-    require(msg.sender == module, "Not authorized");
-    if (operation == 1) (success, ) = to.delegatecall(data);
-    else (success, ) = to.call{value: value}(data);
-  }
-
-  function execTransactionFromModuleReturnData(
-    address payable to,
-    uint256 value,
-    bytes calldata data,
-    uint8 operation
-  ) external returns (bool success, bytes memory returnData) {
-    require(msg.sender == module, "Not authorized");
-    if (operation == 1) (success, ) = to.delegatecall(data);
-    else (success, returnData) = to.call{value: value}(data);
-  }
-
-  function getModulesPaginated(
-    address,
-    uint256 pageSize
-  ) external view returns (address[] memory array, address next) {
-    // Init array with max page size
-    array = new address[](pageSize);
-
-    array[0] = module;
-    next = module;
-  }
-}

package/contracts/test/TestGuard.sol

@@ -1,82 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.7.0 <0.9.0;
-
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-
-import {BaseGuard} from "../guard/BaseGuard.sol";
-import {Enum} from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
-import {FactoryFriendly} from "../factory/FactoryFriendly.sol";
-import {GuardableModule} from "../core/GuardableModule.sol";
-
-/* solhint-disable */
-
-contract TestGuard is FactoryFriendly, BaseGuard {
-  event PreChecked(address sender);
-  event PostChecked(bool checked);
-
-  address public module;
-
-  constructor(address _module) {
-    bytes memory initParams = abi.encode(_module);
-    setUp(initParams);
-  }
-
-  function setModule(address _module) public {
-    module = _module;
-  }
-
-  function checkTransaction(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation,
-    uint256,
-    uint256,
-    uint256,
-    address,
-    address payable,
-    bytes memory,
-    address sender
-  ) public override {
-    require(to != address(0), "Cannot send to zero address");
-    require(value != 1337, "Cannot send 1337");
-    require(bytes3(data) != bytes3(0xbaddad), "Cannot call 0xbaddad");
-    require(operation != Enum.Operation(1), "No delegate calls");
-    emit PreChecked(sender);
-  }
-
-  function checkAfterExecution(bytes32, bool) public override {
-    require(
-      GuardableModule(module).guard() == address(this),
-      "Module cannot remove its own guard."
-    );
-    emit PostChecked(true);
-  }
-
-  function setUp(bytes memory initializeParams) public override initializer {
-    address _module = abi.decode(initializeParams, (address));
-    module = _module;
-  }
-}
-
-contract TestNonCompliantGuard is IERC165 {
-  function supportsInterface(bytes4) external pure returns (bool) {
-    return false;
-  }
-
-  function checkTransaction(
-    address,
-    uint256,
-    bytes memory,
-    Enum.Operation,
-    uint256,
-    uint256,
-    uint256,
-    address,
-    address,
-    bytes memory,
-    address
-  ) public {}
-
-  function checkAfterExecution(bytes32, bool) public {}
-}

package/contracts/test/TestGuardableModifier.sol

@@ -1,82 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.7.0 <0.9.0;
-
-import "../core/GuardableModifier.sol";
-
-contract TestGuardableModifier is GuardableModifier {
-  event Executed(
-    address to,
-    uint256 value,
-    bytes data,
-    Enum.Operation operation,
-    bool success
-  );
-
-  event ExecutedAndReturnedData(
-    address to,
-    uint256 value,
-    bytes data,
-    Enum.Operation operation,
-    bytes returnData,
-    bool success
-  );
-
-  constructor(address _avatar, address _target) {
-    bytes memory initParams = abi.encode(_avatar, _target);
-    setUp(initParams);
-  }
-
-  /// @dev Passes a transaction to the modifier.
-  /// @param to Destination address of module transaction
-  /// @param value Ether value of module transaction
-  /// @param data Data payload of module transaction
-  /// @param operation Operation type of module transaction
-  /// @notice Can only be called by enabled modules
-  function execTransactionFromModule(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public override moduleOnly returns (bool success) {
-    success = exec(to, value, data, operation);
-    emit Executed(to, value, data, operation, success);
-  }
-
-  /// @dev Passes a transaction to the modifier, expects return data.
-  /// @param to Destination address of module transaction
-  /// @param value Ether value of module transaction
-  /// @param data Data payload of module transaction
-  /// @param operation Operation type of module transaction
-  /// @notice Can only be called by enabled modules
-  function execTransactionFromModuleReturnData(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public override moduleOnly returns (bool success, bytes memory returnData) {
-    (success, returnData) = execAndReturnData(to, value, data, operation);
-    emit ExecutedAndReturnedData(
-      to,
-      value,
-      data,
-      operation,
-      returnData,
-      success
-    );
-  }
-
-  function setUp(bytes memory initializeParams) public override initializer {
-    setupModules();
-    __Ownable_init(msg.sender);
-    (address _avatar, address _target) = abi.decode(
-      initializeParams,
-      (address, address)
-    );
-    avatar = _avatar;
-    target = _target;
-  }
-
-  function attemptToSetupModules() public {
-    setupModules();
-  }
-}

package/contracts/test/TestModifier.sol

@@ -1,88 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-
-/// @title Modifier Interface - A contract that sits between a Module and an Avatar and enforce some additional logic.
-pragma solidity >=0.7.0 <0.9.0;
-
-import "../core/Modifier.sol";
-
-contract TestModifier is Modifier {
-  event Executed(
-    address to,
-    uint256 value,
-    bytes data,
-    Enum.Operation operation,
-    bool success
-  );
-
-  event ExecutedAndReturnedData(
-    address to,
-    uint256 value,
-    bytes data,
-    Enum.Operation operation,
-    bytes returnData,
-    bool success
-  );
-
-  constructor(address _avatar, address _target) {
-    bytes memory initParams = abi.encode(_avatar, _target);
-    setUp(initParams);
-  }
-
-  /// @dev Passes a transaction to the modifier.
-  /// @param to Destination address of module transaction
-  /// @param value Ether value of module transaction
-  /// @param data Data payload of module transaction
-  /// @param operation Operation type of module transaction
-  /// @notice Can only be called by enabled modules
-  function execTransactionFromModule(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public override moduleOnly returns (bool success) {
-    success = exec(to, value, data, operation);
-    emit Executed(to, value, data, operation, success);
-  }
-
-  /// @dev Passes a transaction to the modifier, expects return data.
-  /// @param to Destination address of module transaction
-  /// @param value Ether value of module transaction
-  /// @param data Data payload of module transaction
-  /// @param operation Operation type of module transaction
-  /// @notice Can only be called by enabled modules
-  function execTransactionFromModuleReturnData(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public override moduleOnly returns (bool success, bytes memory returnData) {
-    (success, returnData) = execAndReturnData(to, value, data, operation);
-    emit ExecutedAndReturnedData(
-      to,
-      value,
-      data,
-      operation,
-      returnData,
-      success
-    );
-  }
-
-  function setUp(bytes memory initializeParams) public override initializer {
-    (address _avatar, address _target) = abi.decode(
-      initializeParams,
-      (address, address)
-    );
-    setupModules();
-    _transferOwnership(msg.sender);
-    avatar = _avatar;
-    target = _target;
-  }
-
-  function exposeSentOrSignedByModule() external view returns (address) {
-    return sentOrSignedByModule();
-  }
-
-  function attemptToSetupModules() public {
-    setupModules();
-  }
-}