https://github.com/dappsar/dao-template
DAO Templates (hardhat, solidity)
https://github.com/dappsar/dao-template
blockchain dao hardhat solidity solidity-contracts typescript
Last synced: about 2 months ago
JSON representation
DAO Templates (hardhat, solidity)
- Host: GitHub
- URL: https://github.com/dappsar/dao-template
- Owner: dappsar
- Created: 2023-01-21T23:01:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-22T00:28:10.000Z (over 3 years ago)
- Last Synced: 2025-03-28T19:45:20.346Z (about 1 year ago)
- Topics: blockchain, dao, hardhat, solidity, solidity-contracts, typescript
- Language: TypeScript
- Homepage:
- Size: 168 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DAO Template
## Table of Content
- [Introduction](#introduction)
- [How to DAO](#how-to-dao)
- [No Code Tools](#no-code-tools)
- [Technology Stack and Tools](#technology-stack-and-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)
## Introduction
### 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://aragon.org/)
- [Colony](https://colony.io/)
- [DAOHaus](https://app.daohaus.club/summon)
- [DAO Leaderboard](https://deepdao.io/#/deepdao/dashboard)
### Technology Stack and Tools
- Visual Studio Code
- nvm / nodejs / npm / npx / yarn
- Typescript
- [Solidity](https://solidity-es.readthedocs.io/es/latest/) (Writing Smart Contracts & Tests)
- [Hardhat](https://hardhat.org/) (Development Framework)
- [Ethers.js](https://docs.ethers.io/v5/) (Blockchain Interaction)
- [QuickNode](https://www.quicknode.com/) (To deploy smart contracts)
# Getting Started
Work with this repo in the browser (optional)
[](https://gitpod.io/#https://github.com/dappsar/dao-template)
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/dappsar/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
```
4. Deploy to a testnet network
If you want to deploy to a testnet, add a `.env` file with the same contents of `.env.example`, but replaced with your variables.
 **WARNING** 
> DO NOT PUSH YOUR PRIVATE_KEY TO GITHUB
## 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).
## Roadmap
- [ ] Add Upgradeability examples with the UUPS proxy pattern
- [ ] Add Chainlink Oracle Integration with Snapsafe example
See the [open issues](https://github.com/dappsar/dao-template/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## 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)
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.