@gnosis-guild/zodiac 4.0.3

package/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                      Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+  a) under this License, provided that you make a good faith effort to
+  ensure that, in the event an Application does not supply the
+  function or data, the facility still operates, and performs
+  whatever part of its purpose remains meaningful, or
+
+  b) under the GNU GPL, with none of the additional permissions of
+  this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+  a) Give prominent notice with each copy of the object code that the
+  Library is used in it and that the Library and its use are
+  covered by this License.
+
+  b) Accompany the object code with a copy of the GNU GPL and this license
+  document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+  a) Give prominent notice with each copy of the Combined Work that
+  the Library is used in it and that the Library and its use are
+  covered by this License.
+
+  b) Accompany the Combined Work with a copy of the GNU GPL and this license
+  document.
+
+  c) For a Combined Work that displays copyright notices during
+  execution, include the copyright notice for the Library among
+  these notices, as well as a reference directing the user to the
+  copies of the GNU GPL and this license document.
+
+  d) Do one of the following:
+
+      0) Convey the Minimal Corresponding Source under the terms of this
+      License, and the Corresponding Application Code in a form
+      suitable for, and under terms that permit, the user to
+      recombine or relink the Application with a modified version of
+      the Linked Version to produce a modified Combined Work, in the
+      manner specified by section 6 of the GNU GPL for conveying
+      Corresponding Source.
+
+      1) Use a suitable shared library mechanism for linking with the
+      Library.  A suitable mechanism is one that (a) uses at run time
+      a copy of the Library already present on the user's computer
+      system, and (b) will operate properly with a modified version
+      of the Library that is interface-compatible with the Linked
+      Version.
+
+  e) Provide Installation Information, but only if you would otherwise
+  be required to provide such information under section 6 of the
+  GNU GPL, and only to the extent that such information is
+  necessary to install and execute a modified version of the
+  Combined Work produced by recombining or relinking the
+  Application with a modified version of the Linked Version. (If
+  you use option 4d0, the Installation Information must accompany
+  the Minimal Corresponding Source and Corresponding Application
+  Code. If you use option 4d1, you must provide the Installation
+  Information in the manner specified by section 6 of the GNU GPL
+  for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+  a) Accompany the combined library with a copy of the same work based
+  on the Library, uncombined with any other library facilities,
+  conveyed under the terms of this License.
+
+  b) Give prominent notice with the combined library that part of it
+  is a work based on the Library, and explaining where to find the
+  accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,141 @@
+# Zodiac: The expansion pack for DAOs
+
+[![Build Status](https://github.com/gnosisguild/zodiac/workflows/zodiac/badge.svg?branch=master)](https://github.com/gnosisguild/zodiac/actions?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/gnosis/zodiac/badge.svg?branch=master)](https://coveralls.io/github/gnosisguild/zodiac?branch=master)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/gnosisguild/CODE_OF_CONDUCT)
+
+A composable design philosophy for DAOs, [Zodiac](https://gnosisguild.mirror.xyz/OuhG5s2X5uSVBx1EK4tKPhnUc91Wh9YM0fwSnC8UNcg) is a collection of tools built according to an open standard.
+
+![Zodiac Icons](https://images.mirror-media.xyz/nft/c8c9031b-06b1-4344-baf2-c1d2d24cfc4f.png)
+
+The Zodiac collection of tools can be accessed through the Zodiac App available on [Safe](https://safe.global/), as well as through the repositories below. If you have any questions about Zodiac, join the [Gnosis Guild Discord](https://discord.gnosisguild.org).
+
+This repository links to technical tutorials on how to configure each using the CLI. (For operator tutorials, visit [zodiac.wiki](https://zodiac.wiki/index.php?title=Category:Documentation).)
+
+Zodiac enables:
+
+- Flexible, module-based control of programmable accounts
+- Un-opinionated standards for programmable account interaction
+- Reusable implementations of core and factory logic
+
+The Zodiac open standard consists of Avatars, Modules, Modifiers, and Guards architecture:
+
+**1. Avatars** are programmable Ethereum accounts, like [Safe](https://safe.global/). Avatars are the address that holds balances, owns systems, executes transaction, is referenced externally, and ultimately represents your DAO. Avatars must expose an interface like `IAvatar.sol`.
+
+**2. Modules** are contracts enabled by an Avatar that implement some decision making logic. They should import `Module.sol`.
+
+**3. Modifiers** are contracts that sit between Modules and Avatars to modify the Module's behavior. For example, they might enforce a delay on all functions a Module attempts to execute. Modifiers should import `Modifier.sol` and must expose an interface like `IAvatar.sol`
+
+**4. Guards** are contracts that can be enabled on Modules and implement pre- or post-checks on each transaction that the Module executes. This allows Avatars to do things like limit the scope of addresses and functions that a module can call or ensure a certain state is never changed by a module. Guards should import `BaseGuard.sol`.
+
+## Overview
+
+### Installation
+
+```bash
+yarn add @gnosis-guild/zodiac
+```
+
+### Usage
+
+Once installed, you can use the contracts in the library by importing them to your contract:
+
+```solidity
+pragma solidity ^0.8.6;
+
+import "@gnosis-guild/zodiac/contracts/core/Module.sol";
+
+contract MyModule is Module {
+  /// insert your code here
+}
+
+```
+
+### Zodiac compliant tools
+
+#### Avatars
+
+- **[Safe](https://safe.global)**: The most trusted platform for managing digital assets on Ethereum. Zodiac embraces Safe as a powerful, extensible and programmable account standard. Safe is the reference implementation of the [IAvatar.sol](contracts/interfaces/IAvatar.sol) interface specified in this library. However, all Zodiac tools are framework agnostic, and they can be plugged into any programmable account that implements the IAvatar interface.
+
+#### Modules
+
+- **[Bridge](https://github.com/gnosisguild/zodiac-module-bridge)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This module allows an address on one chain to control an avatar on another chain using an Arbitrary Message Bridge (AMB). This enables a DAO on one chain to control assets and interact with systems like a Safe on a different chain.
+- **[Exit](https://github.com/gnosisguild/zodiac-module-exit)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This module allows users to redeem a designated token for a relative share of an avatar's assets, similar to MolochDAO's infamous rageQuit() function.
+- **[Governor](https://github.com/gnosisguild/zodiac-module-oz-governor/)** (Developed by [Gnosis Guild](https://twitter.com/gnosisguild)): An opinionated implementation of [OpenZeppelin's Governor contracts](https://docs.openzeppelin.com/contracts/4.x/api/governance) designed to be used in a Zodiac-style setup, allowing a Avatar (like a Safe) to controlled by on-chain governance similar to [Compound's Governor Alpha and Bravo](https://compound.finance/docs/governance).
+- **[Optimistic Governor](https://docs.outcome.finance/optimistic-governance/what-is-the-optimistic-governor)** (developed by [Outcome Finance](https://www.outcome.finance/): This module allows on-chain executions based on Snapshot proposal results. The module utilizes UMA's optimistic oracle to govern a Safe based on a set of rules defined off-chain.
+- **[Reality](https://github.com/gnosisguild/zodiac-module-reality)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This module allows on-chain execution based on the outcome of events reported by Reality.eth. While built initially to execute Safe transactions according to Snapshot proposals, this module is framework agnostic. It can enable proposal execution from just about anywhere. For example, it can bring Discord polls on-chain.
+- **[Safe Minion](https://github.com/HausDAO/MinionSummonerV2/blob/main/contracts/SafeMinion.sol)** (developed by [DAOHaus](https://daohaus.club)): This module allows Moloch DAOs to manage the assets in a Safe based on the outcome of v2 Moloch DAO proposals. Safe Minion enables Moloch DAOs to manage collections of NFTs, manage LP positions with AMMs, and initiate any other arbitrary interactions. It enables DAOs that start as a Safe to later delegate governance to a Moloch DAO.
+- **[Tellor](https://github.com/tellor-io/snapshot-zodiac-module)** (developed by [Tellor](https://tellor.io)): This module allows on-chain executions based on Snapshot proposal results, it uses the Tellor oracle to retrieve the data in a secure and decentralized manner.
+- **[Usul](https://github.com/SekerDAO/Usul)** (developed by [SekerDAO](https://github.com/SekerDAO)): This module allows avatars to operate with trustless tokenized DeGov, similar to Compound or Gitcoin, with a time-boxed proposal core that can register swappable voting contracts. This enables DAOs to choose from various on-chain voting methods that best suit their needs.
+
+#### Modifiers
+
+- **[Delay](https://github.com/gnosisguild/zodiac-modifier-delay)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This modifier allows avatars to enforce a time delay between when a module initiates a transaction and when it will be executed by an avatar.
+- **[Roles](https://github.com/gnosisguild/zodiac-modifier-roles)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This modifier allows for fine-grained, role-based, access control for enabled modules. Scopes for a given role include allowed addresses, and optionally include allowed functions on allowed addresses, allowed parameters on allowed functions, whether or not delegate calls are allowed to an allowed address, and whether or not value (ETH) can be sent to an allowed address.
+
+#### Guards
+
+- **[Meta](https://github.com/cardstack/cardstack-meta-guard)** (developed by [Cardstack](https://twitter.com/cardstack)): This guard allows an avatar to have multiple checking processes by registering multiple guards to this meta guard.
+- **[Scope](https://github.com/gnosisguild/zodiac-guard-scope)** (developed by [Gnosis Guild](https://twitter.com/gnosisguild)): This guard allows an avatar to limit the scope of the addressable functions with which its owners can interact. This enables the avatar to define granular permissions for different control mechanisms.
+
+## Support and Contributions
+
+Have you built something cool that belongs in this collection of Zodiac tools and want to add it to the list? Follow our [contribution guidelines](/CONTRIBUTING.md) to open a PR!
+
+If you have any questions about Zodiac, join the [Gnosis Guild Discord](https://discord.gnosisguild.org/). Follow [@GnosisGuild](https://twitter.com/gnosisguild) on Twitter for updates.
+
+The [Zodiac documentation](https://github.com/gnosisguild/zodiac) offers tutorials on how to use the Zodiac App, and detailed developer resources on how to build your own Zodiac module, modifier, or guard will be available soon.
+
+### Zodiac Banners and Badges
+
+Show your support for Zodiac by adding a badge or banner to your website or repository. Check out the preview images below, and select your preferred design for download. Please wrap the image with a hyperlink to [Zodiac](https://github.com/gnosisguild/zodiac).
+
+NOTE: To guarantee the most current design, copy the image URL and use the hosted version for embedding on your platform.
+
+Your support through these badges and banners is greatly appreciated!
+
+**Banners**
+
+![White on Black Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-black-white.svg)
+![Black on White Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-white-black.svg)
+
+![Light Gradient Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-gradient-light.svg)
+![Dark Gradient Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-gradient-dark.svg)
+
+**Badges**
+
+![White on Black Badge](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-black-white.svg)
+![Black on White Badge](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-white-black.svg)
+![Light Gradient Badge](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-gradient-light.svg)
+![Dark Gradient Badge](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-gradient-dark.svg)
+
+**Copy and paste markdown** (for README's)
+These snippets will render an image that links to this github repo.
+
+[![White on black banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-black-white.svg)](https://github.com/gnosisguild/zodiac)
+
+```
+[![White on black banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-badge-black-white.svg)](https://github.com/gnosisguild/zodiac)
+```
+
+[![Black on White Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-white-black.svg)](https://github.com/gnosisguild/zodiac)
+
+```
+[![Black on White Banner](https://raw.githubusercontent.com/gnosisguild/zodiac/master/branding/zodiac-banner-white-black.svg)](https://github.com/gnosisguild/zodiac)
+```
+
+### Audits
+
+Zodiac has been audited by the [G0 group](https://github.com/g0-group).
+
+All issues and notes of the audit have been addressed in the release candidate [v0.1.0](https://github.com/gnosisguild/zodiac/releases/tag/v0.1.0) with commit hash [8a77e7b224af8004bd9f2ff4e2919642e93ffd85](https://github.com/gnosisguild/zodiac/commit/8a77e7b224af8004bd9f2ff4e2919642e93ffd85) and the subsequent release [v1.0.0](https://github.com/gnosisguild/zodiac/releases/tag/v1.0.0).
+
+The audit results are available as a pdf [in this repo](./audits/GnosisZodiac2021Sep.pdf) or in the [g0-group's github repo](https://github.com/g0-group/Audits/blob/master/GnosisZodiac2021Sep.pdf).
+
+### Security and Liability
+
+All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+### License
+
+Zodiac is created under the [LGPL-3.0+ license](LICENSE).

package/contracts/core/GuardableModifier.sol

@@ -0,0 +1,96 @@
+// 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

@@ -0,0 +1,95 @@
+// 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);
+    }
+  }
+}