init commit

.env.example

@@ -0,0 +1,8 @@
+# for kovan deployment
+KOVAN_RPC_URL='https://kovan.infura.io/v3/1234567890'
+# for rinkeby deployment
+RINKEBY_RPC_URL='https://alchemy.infura.io/v3/1234567890'
+PRIVATE_KEY='abcdefg'
+
+### Optional
+COINMARKETCAP_API_KEY="YOUR_KEY"

.gitignore

@@ -0,0 +1,14 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+cache
+artifacts
+proposals.json
+.notes.md
+typechain-types
+gas-report.txt
+deployments

.prettierignore

@@ -0,0 +1,13 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
+package.json
+img
+.env
+.*
+README.md
+coverage.json
+deployments
+typechain-types

.prettierrc

@@ -0,0 +1,8 @@
+{
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": false,
+    "printWidth": 100
+  }
+

.solhint.json

@@ -0,0 +1,9 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "prettier/prettier": "warning"
+  },
+  "plugins": ["prettier"]
+}

.solhintignore

@@ -0,0 +1,2 @@
+node_modules
+contracts/test

README.md

@@ -0,0 +1,251 @@
+# DAO Template
+
+<div id="top"></div>
+
+- [DAO Template](#dao-template)
+  - [About](#about)
+    - [How to DAO](#how-to-dao)
+    - [No Code Tools](#no-code-tools)
+- [Getting Started](#getting-started)
+  - [Requirements](#requirements)
+    - [Installation](#installation)
+  - [Usage](#usage)
+    - [On-Chain Governance Example](#on-chain-governance-example)
+    - [Off-Chain governance Example](#off-chain-governance-example)
+  - [Roadmap](#roadmap)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Contact](#contact)
+  - [Acknowledgments](#acknowledgments)
+
+[You can also see the python/brownie version of this here.](https://github.com/brownie-mix/dao-mix)
+
+<!-- ABOUT THE PROJECT -->
+## About
+
+### How to DAO
+
+This repo is meant to give you all the knowledge you need to start a DAO and do governance. Since what's the point of a DAO if you can't make any decisions! There are 2 main kinds of doing governance.
+
+| Feature    | On-Chain Governance | Hybrid Governance             |
+| ---------- | ------------------- | ----------------------------- |
+| Gas Costs  | More Expensive      | Cheaper                       |
+| Components | Just the blockchain | An oracle or trusted multisig |
+
+A typical on-chain governance structure might look like: 
+- ERC20 based voting happens on a project like [Tally](https://www.withtally.com/), but could hypothetically be done by users manually calling the vote functions. 
+- Anyone can execute a proposal once it has passed
+_Examples [Compound](https://compound.finance/governance)_
+
+On-chain governance can be much more expensive, but involves fewer parts, and the tooling is still being developed. 
+
+A typical hybrid governance with an oracle might look like:
+- ERC20 based voting happens on a project like [Snapshot](https://snapshot.org/#/)
+- An oracle like [Chainlink](https://chain.link/) is used to retreive and execute the answers in a decentralized manner. (hint hint, someone should build this. )
+
+A typical hybrid governance with a trusted multisig might looks like:
+- ERC20 based voting happens on a project like [Snapshot](https://snapshot.org/#/)
+- A trusted [gnosis multisig](https://gnosis-safe.io/) is used to exectue the results of snapshot.
+_Examples: [Snapsafe](https://blog.gnosis.pm/introducing-safesnap-the-first-in-a-decentralized-governance-tool-suite-for-the-gnosis-safe-ea67eb95c34f)_
+
+Hybrid governance is much cheaper, just as secure, but the tooling is still being developed. 
+
+Tools:
+- [Snapshot](https://snapshot.org/#/)
+  - UI for off-chain voting / sentiment analysis
+- [Tally](https://www.withtally.com/)
+  - UI for on-chain voting
+- [Gnosis Safe](https://gnosis-safe.io/)
+  - Multi-sig
+- [Openzeppelin](https://docs.openzeppelin.com/contracts/4.x/api/governance)
+  - DAO code tools
+- [Zodiac](https://github.com/gnosis/zodiac)
+  - More DAO code tools
+- [Openzeppelin Defender](https://openzeppelin.com/defender/)
+  - A tool to propose governance and other contract functions. 
+
+
+### No Code Tools
+
+The following have tools to help you start a DAO without having to deploy contracts yourself.
+
+- [DAO Stack](https://alchemy.daostack.io/daos/create)
+- [Aragon](https://www.youtube.com/watch?v=VIyG-PYJv9E)
+  - lol, just kidding. [Here is the real link.](https://aragon.org/)
+- [Colony](https://colony.io/)
+- [DAOHaus](https://app.daohaus.club/summon)
+- [DAO Leaderboard](https://deepdao.io/#/deepdao/dashboard)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+<!-- GETTING STARTED -->
+# Getting Started 
+
+It's recommended that you've gone through the [hardhat getting started documentation](https://hardhat.org/getting-started/) before proceeding here. 
+
+## Requirements
+
+- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+  - You'll know you did it right if you can run `git --version` and you see a response like `git version x.x.x`
+- [Nodejs](https://nodejs.org/en/)
+  - You'll know you've installed nodejs right if you can run:
+    - `node --version`and get an ouput like: `vx.x.x`
+- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) instead of `npm`
+  - You'll know you've installed yarn right if you can run:
+    - `yarn --version` And get an output like: `x.x.x`
+    - You might need to install it with npm
+
+### Installation
+
+1. Clone this repo:
+```
+git clone https://github.com/PatrickAlphaC/dao-template
+cd dao-template
+```
+2. Install dependencies
+```sh
+yarn
+```
+
+or 
+
+```
+npm i 
+```
+
+3. Run the test suite (which also has all the functionality)
+
+```
+yarn hardhat test
+```
+or
+```
+npx hardhat test
+```
+
+If you want to deploy to a testnet:
+4. Add a `.env` file with the same contents of `.env.example`, but replaced with your variables.
+![WARNING](https://via.placeholder.com/15/f03c15/000000?text=+) **WARNING** ![WARNING](https://via.placeholder.com/15/f03c15/000000?text=+)
+> DO NOT PUSH YOUR PRIVATE_KEY TO GITHUB
+
+
+<!-- USAGE EXAMPLES -->
+## Usage
+### On-Chain Governance Example
+
+Here is the rundown of what the test suite does. 
+
+1. We will deploy an ERC20 token that we will use to govern our DAO.
+2. We will deploy a Timelock contract that we will use to give a buffer between executing proposals.
+   1. Note: **The timelock is the contract that will handle all the money, ownerships, etc**
+3. We will deploy our Governence contract 
+   1. Note: **The Governance contract is in charge of proposals and such, but the Timelock executes!**
+4. We will deploy a simple Box contract, which will be owned by our governance process! (aka, our timelock contract).
+5. We will propose a new value to be added to our Box contract.
+6. We will then vote on that proposal.
+7. We will then queue the proposal to be executed.
+8. Then, we will execute it!
+
+
+Additionally, you can do it all manually on your own local network like so:
+
+1. Setup local blockchain 
+```
+yarn hardhat node
+```
+
+2. Propose a new value to be added to our Box contract
+
+In a second terminal (leave your blockchain running)
+```
+yarn hardhat run scripts/propose.ts --network localhost
+```
+
+3. Vote on that proposal
+
+```
+yarn hardhat run scripts/vote.ts --network localhost
+```
+
+4. Queue & Execute proposal!
+
+```
+yarn hardhat run scripts/queue-and-execute.ts --network localhost
+```
+
+
+You can also use the [Openzeppelin contract wizard](https://wizard.openzeppelin.com/#governor) to get other contracts to work with variations of this governance contract. 
+
+### Off-Chain governance Example
+
+> This sectoin is still being developed. 
+
+Deploy your ERC20 and [make proposals in snapshot](https://docs.snapshot.org/proposals/create). 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [] Add Upgradeability examples with the UUPS proxy pattern
+- [] Add Chainlink Oracle Integration with Snapsafe example
+
+See the [open issues](https://github.com/PatrickAlphaC/dao-template/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Hardhat - [@HardhatHQ](https://twitter.com/HardhatHQ)
+Patrick Collins - [@patrickalphac](https://twitter.com/patrickalphac)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+* [Openzeppelin Governance Walkthrough](https://docs.openzeppelin.com/contracts/4.x/governance)
+* [Openzeppelin Governance Github](https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts/governance)
+* [Vitalik on DAOs](https://blog.ethereum.org/2014/05/06/daos-dacs-das-and-more-an-incomplete-terminology-guide/)
+* [Vitalik on On-Chain Governance](https://vitalik.ca/general/2021/08/16/voting3.html)
+* [Vitalik on Governance in General](https://vitalik.ca/general/2017/12/17/voting.html)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+You can check out the [openzeppelin javascript tests](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/e6f26b46fc8015f1b9b09bb85297464069302125/test/governance/extensions/GovernorTimelockControl.test) for a full suite of an example of what is possible. 

contracts/Box.sol

@@ -0,0 +1,23 @@
+// contracts/Box.sol
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/access/Ownable.sol";
+
+contract Box is Ownable {
+  uint256 private value;
+
+  // Emitted when the stored value changes
+  event ValueChanged(uint256 newValue);
+
+  // Stores a new value in the contract
+  function store(uint256 newValue) public onlyOwner {
+    value = newValue;
+    emit ValueChanged(newValue);
+  }
+
+  // Reads the last stored value
+  function retrieve() public view returns (uint256) {
+    return value;
+  }
+}

contracts/GovernanceToken.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.9;
+
+import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";
+
+contract GovernanceToken is ERC20Votes {
+  uint256 public s_maxSupply = 1000000000000000000000000;
+
+  constructor() ERC20("GovernanceToken", "GT") ERC20Permit("GovernanceToken") {
+    _mint(msg.sender, s_maxSupply);
+  }
+
+  // The functions below are overrides required by Solidity.
+
+  function _afterTokenTransfer(
+    address from,
+    address to,
+    uint256 amount
+  ) internal override(ERC20Votes) {
+    super._afterTokenTransfer(from, to, amount);
+  }
+
+  function _mint(address to, uint256 amount) internal override(ERC20Votes) {
+    super._mint(to, amount);
+  }
+
+  function _burn(address account, uint256 amount) internal override(ERC20Votes) {
+    super._burn(account, amount);
+  }
+}