@gnosis-guild/zodiac 4.2.1 → 5.0.0

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@gnosis-guild/zodiac",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "description": "Zodiac is a composable design philosophy and collection of standards for building DAO ecosystem tooling.",
   "author": "Auryn Macmillan <auryn@gnosisguild.org>",
   "license": "LGPL-3.0+",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -18,84 +20,37 @@
     "package.json",
     "LICENSE",
     "README.md",
-    "dist",
-    "contracts"
+    "dist"
   ],
   "scripts": {
-    "build": "hardhat compile",
-    "build:sdk": "rimraf dist && yarn generate:types && tsdown",
-    "clean": "rimraf dist build typechain-types",
-    "deploy:factory": "hardhat singleton-deployment --network",
-    "deploy": "hardhat deploy-replay --network",
-    "test:sdk": "hardhat test ./sdk/factory/__tests__/index.spec.ts",
-    "test": "hardhat test && yarn test:sdk",
-    "coverage": "hardhat coverage",
-    "lint": "yarn lint:sol && yarn lint:ts",
-    "lint:sol": "solhint ./contracts/**/*.sol",
-    "lint:ts": "eslint --max-warnings 0 .",
-    "format": "yarn format:sol && yarn format:ts",
-    "format:sol": "prettier --write --plugin=prettier-plugin-solidity ./contracts/**/*.sol",
-    "format:ts": "prettier --write ./sdk/**/*.ts ./test/**/*.ts ./*.ts",
-    "generate:types": "patch-package && rimraf src/types && typechain --target ethers-v6 --out-dir sdk/types './sdk/abi/*.json'",
-    "prepare": "yarn generate:types && yarn build",
-    "prerelease": "yarn clean && yarn build && yarn build:sdk",
-    "release": "yarn publish --access public",
-    "verify": "yarn hardhat verify --network"
-  },
-  "directories": {
-    "test": "test"
+    "clean": "rm -rf dist",
+    "build": "yarn clean && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json",
+    "postbuild": "node postbuild.mjs",
+    "cli": "tsx src/cli.ts",
+    "extract": "tsx src/cli.ts extract",
+    "deploy": "tsx src/cli.ts deploy",
+    "deploy:list": "tsx src/cli.ts deploy list",
+    "verify": "tsx src/cli.ts verify",
+    "verify:list": "tsx src/cli.ts verify list",
+    "format": "prettier --write ./src/**/*.ts ./commands/**/*.ts",
+    "release": "yarn build && yarn publish --access public"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/gnosis/zodiac.git"
   },
   "devDependencies": {
-    "@nomicfoundation/hardhat-chai-matchers": "^2.0.3",
-    "@nomicfoundation/hardhat-ethers": "^3.0.0",
-    "@nomicfoundation/hardhat-network-helpers": "^1.0.7",
-    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
-    "@nomicfoundation/hardhat-verify": "^2.0.0",
-    "@nomiclabs/hardhat-ethers": "^2.2.3",
-    "@nomiclabs/hardhat-etherscan": "3.1.7",
-    "@typechain/ethers-v6": "^0.5.1",
-    "@typechain/hardhat": "^9.1.0",
-    "@types/chai": "^4.3.3",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^18.8.5",
-    "@types/yargs": "^17.0.13",
-    "@typescript-eslint/eslint-plugin": "^6.9.1",
-    "@typescript-eslint/parser": "^6.9.1",
-    "chai": "^4.3.7",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.25.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-no-only-tests": "^3.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "hardhat": "^2.14.0",
-    "hardhat-change-network": "^0.0.7",
-    "hardhat-deploy": "^0.11.28",
-    "hardhat-gas-reporter": "^1.0.9",
-    "husky": "^8.0.1",
-    "patch-package": "^8.0.0",
-    "prettier": "^3.0.3",
-    "prettier-plugin-solidity": "^1.1.3",
-    "rimraf": "^6.0.1",
-    "solhint": "^4.0.0",
-    "solhint-plugin-prettier": "^0.1.0",
-    "solidity-coverage": "^0.8.4",
-    "ts-node": "^10.9.1",
-    "tsdown": "^0.14.1",
-    "typechain": "^8.3.2",
-    "typescript": "^5.2.2",
-    "yargs": "^17.6.0"
+    "@types/semver": "^7.7.1",
+    "prettier": "^3.8.4",
+    "tsx": "^4.19.0",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@gnosis.pm/mock-contract": "^4.0.0",
-    "@gnosis.pm/safe-contracts": "1.3.0",
-    "@openzeppelin/contracts": "^5.0.0",
-    "@openzeppelin/contracts-upgradeable": "^5.0.0",
-    "ethers": "^6.9.2"
+    "@gnosis-guild/zodiac-core": "4.1.0",
+    "dotenv": "^17.4.2",
+    "eth-provider": "^0.13.7",
+    "ethers": "^6.17.0",
+    "semver": "^7.7.3"
   },
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/contracts/core/GuardableModifier.sol

@@ -1,96 +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 {Guardable} from "../guard/Guardable.sol";
-import {IAvatar} from "../interfaces/IAvatar.sol";
-import {IGuard} from "../interfaces/IGuard.sol";
-import {Modifier} from "./Modifier.sol";
-import {Module} from "./Module.sol";
-
-abstract contract GuardableModifier is Module, Guardable, Modifier {
-  /// @dev Passes a transaction to be executed by the avatar.
-  /// @notice Can only be called by this contract.
-  /// @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 exec(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal virtual override returns (bool success) {
-    address currentGuard = guard;
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkTransaction(
-        /// Transaction info used by module transactions.
-        to,
-        value,
-        data,
-        operation,
-        /// Zero out the redundant transaction information only used for Safe multisig transctions.
-        0,
-        0,
-        0,
-        address(0),
-        payable(0),
-        "",
-        sentOrSignedByModule()
-      );
-    }
-    success = IAvatar(target).execTransactionFromModule(
-      to,
-      value,
-      data,
-      operation
-    );
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkAfterExecution(bytes32(0), success);
-    }
-  }
-
-  /// @dev Passes a transaction to be executed by the target and returns data.
-  /// @notice Can only be called by this contract.
-  /// @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 execAndReturnData(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal virtual override returns (bool success, bytes memory returnData) {
-    address currentGuard = guard;
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkTransaction(
-        /// Transaction info used by module transactions.
-        to,
-        value,
-        data,
-        operation,
-        /// Zero out the redundant transaction information only used for Safe multisig transctions.
-        0,
-        0,
-        0,
-        address(0),
-        payable(0),
-        "",
-        sentOrSignedByModule()
-      );
-    }
-
-    (success, returnData) = IAvatar(target).execTransactionFromModuleReturnData(
-      to,
-      value,
-      data,
-      operation
-    );
-
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkAfterExecution(bytes32(0), success);
-    }
-  }
-}

package/contracts/core/GuardableModule.sol

@@ -1,95 +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 {IGuard} from "../interfaces/IGuard.sol";
-import {Guardable} from "../guard/Guardable.sol";
-import {Module} from "./Module.sol";
-import {IAvatar} from "../interfaces/IAvatar.sol";
-
-/// @title GuardableModule  - A contract that can pass messages to a Module Manager contract if enabled by that contract.
-abstract contract GuardableModule is Module, Guardable {
-  /// @dev Passes a transaction to be executed by the avatar.
-  /// @notice Can only be called by this contract.
-  /// @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 exec(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal override returns (bool success) {
-    address currentGuard = guard;
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkTransaction(
-        /// Transaction info used by module transactions.
-        to,
-        value,
-        data,
-        operation,
-        /// Zero out the redundant transaction information only used for Safe multisig transctions.
-        0,
-        0,
-        0,
-        address(0),
-        payable(0),
-        "",
-        msg.sender
-      );
-    }
-    success = IAvatar(target).execTransactionFromModule(
-      to,
-      value,
-      data,
-      operation
-    );
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkAfterExecution(bytes32(0), success);
-    }
-  }
-
-  /// @dev Passes a transaction to be executed by the target and returns data.
-  /// @notice Can only be called by this contract.
-  /// @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 execAndReturnData(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal virtual override returns (bool success, bytes memory returnData) {
-    address currentGuard = guard;
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkTransaction(
-        /// Transaction info used by module transactions.
-        to,
-        value,
-        data,
-        operation,
-        /// Zero out the redundant transaction information only used for Safe multisig transctions.
-        0,
-        0,
-        0,
-        address(0),
-        payable(0),
-        "",
-        msg.sender
-      );
-    }
-
-    (success, returnData) = IAvatar(target).execTransactionFromModuleReturnData(
-      to,
-      value,
-      data,
-      operation
-    );
-
-    if (currentGuard != address(0)) {
-      IGuard(currentGuard).checkAfterExecution(bytes32(0), success);
-    }
-  }
-}

package/contracts/core/Modifier.sol

@@ -1,204 +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 {ExecutionTracker} from "../signature/ExecutionTracker.sol";
-import {IAvatar} from "../interfaces/IAvatar.sol";
-import {Module} from "./Module.sol";
-import {SignatureChecker} from "../signature/SignatureChecker.sol";
-
-/// @title Modifier Interface - A contract that sits between a Module and an Avatar and enforce some additional logic.
-abstract contract Modifier is
-  Module,
-  ExecutionTracker,
-  SignatureChecker,
-  IAvatar
-{
-  address internal constant SENTINEL_MODULES = address(0x1);
-  /// Mapping of modules.
-  mapping(address => address) internal modules;
-
-  /// `sender` is not an authorized module.
-  /// @param sender The address of the sender.
-  error NotAuthorized(address sender);
-
-  /// `module` is invalid.
-  error InvalidModule(address module);
-
-  /// `pageSize` is invalid.
-  error InvalidPageSize();
-
-  /// `module` is already disabled.
-  error AlreadyDisabledModule(address module);
-
-  /// `module` is already enabled.
-  error AlreadyEnabledModule(address module);
-
-  /// @dev `setModules()` was already called.
-  error SetupModulesAlreadyCalled();
-
-  /*
-    --------------------------------------------------
-    You must override both of the following virtual functions,
-    execTransactionFromModule() and execTransactionFromModuleReturnData().
-    It is recommended that implementations of both functions make use the 
-    onlyModule modifier.
-    */
-
-  /// @dev Passes a transaction to the modifier.
-  /// @notice Can only be called by enabled modules.
-  /// @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.
-  function execTransactionFromModule(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public virtual returns (bool success);
-
-  /// @dev Passes a transaction to the modifier, expects return data.
-  /// @notice Can only be called by enabled modules.
-  /// @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.
-  function execTransactionFromModuleReturnData(
-    address to,
-    uint256 value,
-    bytes calldata data,
-    Enum.Operation operation
-  ) public virtual returns (bool success, bytes memory returnData);
-
-  /*
-    --------------------------------------------------
-    */
-
-  modifier moduleOnly() {
-    if (modules[msg.sender] == address(0)) {
-      (bytes32 hash, address signer) = moduleTxSignedBy();
-
-      // is the signer a module?
-      if (modules[signer] == address(0)) {
-        revert NotAuthorized(msg.sender);
-      }
-
-      // is the provided signature fresh?
-      if (consumed[signer][hash]) {
-        revert HashAlreadyConsumed(hash);
-      }
-
-      consumed[signer][hash] = true;
-      emit HashExecuted(hash);
-    }
-
-    _;
-  }
-
-  function sentOrSignedByModule() internal view returns (address) {
-    if (modules[msg.sender] != address(0)) {
-      return msg.sender;
-    }
-
-    (, address signer) = moduleTxSignedBy();
-    if (modules[signer] != address(0)) {
-      return signer;
-    }
-
-    return address(0);
-  }
-
-  /// @dev Disables a module on the modifier.
-  /// @notice This can only be called by the owner.
-  /// @param prevModule Module that pointed to the module to be removed in the linked list.
-  /// @param module Module to be removed.
-  function disableModule(
-    address prevModule,
-    address module
-  ) public override onlyOwner {
-    if (module == address(0) || module == SENTINEL_MODULES)
-      revert InvalidModule(module);
-    if (modules[prevModule] != module) revert AlreadyDisabledModule(module);
-    modules[prevModule] = modules[module];
-    modules[module] = address(0);
-    emit DisabledModule(module);
-  }
-
-  /// @dev Enables a module that can add transactions to the queue
-  /// @param module Address of the module to be enabled
-  /// @notice This can only be called by the owner
-  function enableModule(address module) public override onlyOwner {
-    if (module == address(0) || module == SENTINEL_MODULES)
-      revert InvalidModule(module);
-    if (modules[module] != address(0)) revert AlreadyEnabledModule(module);
-    modules[module] = modules[SENTINEL_MODULES];
-    modules[SENTINEL_MODULES] = module;
-    emit EnabledModule(module);
-  }
-
-  /// @dev Returns if an module is enabled
-  /// @return True if the module is enabled
-  function isModuleEnabled(
-    address _module
-  ) public view override returns (bool) {
-    return SENTINEL_MODULES != _module && modules[_module] != address(0);
-  }
-
-  /// @dev Returns array of modules.
-  ///      If all entries fit into a single page, the next pointer will be 0x1.
-  ///      If another page is present, next will be the last element of the returned array.
-  /// @param start Start of the page. Has to be a module or start pointer (0x1 address)
-  /// @param pageSize Maximum number of modules that should be returned. Has to be > 0
-  /// @return array Array of modules.
-  /// @return next Start of the next page.
-  function getModulesPaginated(
-    address start,
-    uint256 pageSize
-  ) external view override returns (address[] memory array, address next) {
-    if (start != SENTINEL_MODULES && !isModuleEnabled(start)) {
-      revert InvalidModule(start);
-    }
-    if (pageSize == 0) {
-      revert InvalidPageSize();
-    }
-
-    // Init array with max page size
-    array = new address[](pageSize);
-
-    // Populate return array
-    uint256 moduleCount = 0;
-    next = modules[start];
-    while (
-      next != address(0) && next != SENTINEL_MODULES && moduleCount < pageSize
-    ) {
-      array[moduleCount] = next;
-      next = modules[next];
-      moduleCount++;
-    }
-
-    // Because of the argument validation we can assume that
-    // the `currentModule` will always be either a module address
-    // or sentinel address (aka the end). If we haven't reached the end
-    // inside the loop, we need to set the next pointer to the last element
-    // because it skipped over to the next module which is neither included
-    // in the current page nor won't be included in the next one
-    // if you pass it as a start.
-    if (next != SENTINEL_MODULES) {
-      next = array[moduleCount - 1];
-    }
-    // Set correct size of returned array
-    // solhint-disable-next-line no-inline-assembly
-    assembly {
-      mstore(array, moduleCount)
-    }
-  }
-
-  /// @dev Initializes the modules linked list.
-  /// @notice Should be called as part of the `setUp` / initializing function and can only be called once.
-  function setupModules() internal {
-    if (modules[SENTINEL_MODULES] != address(0))
-      revert SetupModulesAlreadyCalled();
-    modules[SENTINEL_MODULES] = SENTINEL_MODULES;
-  }
-}

package/contracts/core/Module.sol

@@ -1,73 +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 {FactoryFriendly} from "../factory/FactoryFriendly.sol";
-import {IAvatar} from "../interfaces/IAvatar.sol";
-
-/// @title Module Interface - A contract that can pass messages to a Module Manager contract if enabled by that contract.
-abstract contract Module is FactoryFriendly {
-  /// @dev Address that will ultimately execute function calls.
-  address public avatar;
-  /// @dev Address that this module will pass transactions to.
-  address public target;
-
-  /// @dev Emitted each time the avatar is set.
-  event AvatarSet(address indexed previousAvatar, address indexed newAvatar);
-  /// @dev Emitted each time the Target is set.
-  event TargetSet(address indexed previousTarget, address indexed newTarget);
-
-  /// @dev Sets the avatar to a new avatar (`newAvatar`).
-  /// @notice Can only be called by the current owner.
-  function setAvatar(address _avatar) public onlyOwner {
-    address previousAvatar = avatar;
-    avatar = _avatar;
-    emit AvatarSet(previousAvatar, _avatar);
-  }
-
-  /// @dev Sets the target to a new target (`newTarget`).
-  /// @notice Can only be called by the current owner.
-  function setTarget(address _target) public onlyOwner {
-    address previousTarget = target;
-    target = _target;
-    emit TargetSet(previousTarget, _target);
-  }
-
-  /// @dev Passes a transaction to be executed by the avatar.
-  /// @notice Can only be called by this contract.
-  /// @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 exec(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal virtual returns (bool success) {
-    return
-      IAvatar(target).execTransactionFromModule(to, value, data, operation);
-  }
-
-  /// @dev Passes a transaction to be executed by the target and returns data.
-  /// @notice Can only be called by this contract.
-  /// @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 execAndReturnData(
-    address to,
-    uint256 value,
-    bytes memory data,
-    Enum.Operation operation
-  ) internal virtual returns (bool success, bytes memory returnData) {
-    return
-      IAvatar(target).execTransactionFromModuleReturnData(
-        to,
-        value,
-        data,
-        operation
-      );
-  }
-}

package/contracts/factory/FactoryFriendly.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-
-/// @title Zodiac FactoryFriendly - A contract that allows other contracts to be initializable and pass bytes as arguments to define contract state
-pragma solidity >=0.7.0 <0.9.0;
-
-import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
-
-abstract contract FactoryFriendly is OwnableUpgradeable {
-  function setUp(bytes memory initializeParams) public virtual;
-}

package/contracts/factory/ModuleProxyFactory.sol

@@ -1,51 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-pragma solidity >=0.8.0;
-
-contract ModuleProxyFactory {
-  event ModuleProxyCreation(address indexed proxy, address indexed masterCopy);
-
-  /// `target` can not be zero.
-  error ZeroAddress(address target);
-
-  /// `target` has no code deployed.
-  error TargetHasNoCode(address target);
-
-  /// `address_` is already taken.
-  error TakenAddress(address address_);
-
-  /// @notice Initialization failed.
-  error FailedInitialization();
-
-  function createProxy(
-    address target,
-    bytes32 salt
-  ) internal returns (address result) {
-    if (address(target) == address(0)) revert ZeroAddress(target);
-    if (address(target).code.length == 0) revert TargetHasNoCode(target);
-    bytes memory deployment = abi.encodePacked(
-      hex"602d8060093d393df3363d3d373d3d3d363d73",
-      target,
-      hex"5af43d82803e903d91602b57fd5bf3"
-    );
-    // solhint-disable-next-line no-inline-assembly
-    assembly {
-      result := create2(0, add(deployment, 0x20), mload(deployment), salt)
-    }
-    if (result == address(0)) revert TakenAddress(result);
-  }
-
-  function deployModule(
-    address masterCopy,
-    bytes memory initializer,
-    uint256 saltNonce
-  ) public returns (address proxy) {
-    proxy = createProxy(
-      masterCopy,
-      keccak256(abi.encodePacked(keccak256(initializer), saltNonce))
-    );
-    (bool success, ) = proxy.call(initializer);
-    if (!success) revert FailedInitialization();
-
-    emit ModuleProxyCreation(proxy, masterCopy);
-  }
-}