Giters

withtally / gov_deployer

A deployer for governor contracts that are compatible with Tally (tally.xyz)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

contractsdaodeployhardhatjssoliditytally

This REPO is the old version of the deployer, to use the newer one, please go to github.com/withtally/gov-deployer

Theme image for repository DAO Contracts Deployer

A tool to deploy governance and related contracts supported by Tally via CLI.

All the contracts disclosed here are opinionated versions of it and you can always redesign and modify if they stick to the overall pattern.

Gov Deployer

About

Gov deployer is dev tool created by developers in tally, in special Arthur. Its main purpose is to deploy the contracts that tally support in their products with a single line of command.

To skip reading too much and go directly to the commands click here and to go to the table of content click here.

Which Governance should I use ?

Are you still unsure on what governance to use, let's us help you!

The more usual governances are Alpha and Bravo, from the compound governance, we could say that they created the initial pattern and following it we have OpenZeppelin governance contract. Tally recommends you to use Openzeppelin contract, because it will be the one with more support and less chance of being deprecated, and it is too the contracts with more longevity, maintenance and support as well as have more functionalities and features in Tally.

Look up this comparison chart below, to see which one is the best for you.

α Governor Alpha β Governor Bravo ℥ Governor OpenZeppelin
🛑 Non-upgradable contract. 🛠️ Built in upgradability. 🧰 Built in upgradability and more customization.
🔀 Parameter changes require contract migration. 🔁 Parameter changes uses static contract address, no migrations needed. 🔁 Parameter changes uses static contract address, no migrations needed.
☑️ Yes and No vote options. 🗳️ Yes, no and abstain vote options. 🗳️ Yes, no and abstain vote options.
❓ No additional context recorded with vote. 📝 option to add text comment to on-chain vote. 📝 option to add text comment to on-chain vote.
♻️ Each upgrade resets proposal number schema 📈 Continuous proposal numbers regardless of upgrades 📈 Continuous proposal numbers regardless of upgrades
📍 Supported, was the first governance version. Easier deploy system. 🔩 Supported too since it is an upgrade to the Alpha version. 🔮 Widely Supported, as a contract from open zeppelin. With more features and upgrades.
❌ Does not support off-chain proposal signatures. ❌ Does not support off-chain proposal signatures. ⛓️ Supports Off-chain proposal signatures.

With this deployer you will be able to see how to build tasks to deploy governances, and deploy Open Zepellins contracts.

Table of content

Pre-Requisites

  • Npm and Node.
  • Git.

Installation

git clone https://github.com/afa7789/gov_deployer.git && cd gov_deployer
yarn install
# copy and replace values on .env
cp .env.example .env
# you will need to get node rpcs to make it work, probably public rpc are enough, since it's just deployment.

Deployments

In this section we are going to cover all the tasks and deployment possible to be made with gov_deployer.

We are going to list commands to call and their variables to deploy.

By doing so you will now what to call in order to get the scenario and governance that you want.

The network name based in --network option, have to follow the network name in the hardhat.config.js file.

In all tasks the variable --network lower_case_name will be optional with default:localhost

First of all run both of this.

npx hardhat compile
npx hardhat node # if you're running it locally

OpenZepellin

⚠️⚠️ WORKING ON IT ⚠️⚠️

OZ GOV Deployment from ZERO

    npx hardhat oz_dao \
        --name "Dave DAO" \
        --token "DAVE TT" \
        --symbol "DTT" \
        --delay 172800
        --network goerli

with optional parameters:

    npx hardhat oz_dao \
        --name "Dave DAO" \
        --token "DAVE TT" \
        --symbol "DTT" \
        --delay 172800 \
        --executors 0x123_ADRESS_1...,0x123_ADRESS_2... \ # if single address just add 1 without comma
        --proposers 0x123_ADRESS_1...,0x123_ADRESS_2... \ # executors and proposers are optional the deployer is always added to it.
        --vdelay NUMBER_OF_BLOCKS_AFTER_CREATING_PROPOSAL_YOU_CAN_VOTE \
        --period PERIOD_YOU_CAN_VOTE \
        --fraction QUORUM_FRACTION_LESS_THAN_100_NUMERATOR \
        --threshold MINIMUM_TOKEN_TO_PROPOSE
    # default values:
    # vdelay is 100 blocks
    # period is 45818 blocks
    # fraction is 60
    # threshold is 100 ( I recommend putting a threshold in accord to your business)

Deploy the following contracts:

ERC20 Token Votes and Mintable

You can find the token contract code here: ERC20Comp.sol

npx hardhat votes_token \
    --name TOKEN_NAME \
    --symbol TKN \
    --owner 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS #Optional, default value is the deployer address
# you will have to mint tokens, this is not decided by Tally how you should deal with it, due to legal reasons.

# you will need to mint the tokens as owner
# after minted and distributed you can set the owner of the contract as the Governance.

Timelock contract deployment

You can find the timelock contract code here: TimelockControllerOZ.sol

npx hardhat oz_timelock \
    --delay time_in_seconds_172800 #48 hours
    --executors 0x123_ADRESS_1...,0x123_ADRESS_2...
    --proposers 0x123_ADRESS_1...,0x123_ADRESS_2...
    # if single address just add 1 without comma
    # executors and proposers are optional the deployer is always added to it.

Governance contract deployment

You can find the timelock contract code here: OZGovernor.sol

npx hardhat oz_governance \
    --name DAO_NAME \
    --token 0x123_ADRESS_1_token \
    --timelock 0x123_ADRESS_2_timelock

with optional parameters:

#everything after timelock is optional
npx hardhat oz_governance \
    --name DAO_NAME \
    --token 0x123_ADRESS_1_token \
    --timelock 0x123_ADRESS_2_timelock \
    --delay NUMBER_OF_BLOCKS_AFTER_CREATING_PROPOSAL_YOU_CAN_VOTE \
    --period PERIOD_YOU_CAN_VOTE \
    --fraction QUORUM_FRACTION_LESS_THAN_100_NUMERATOR \
    --threshold MINIMUM_TOKEN_TO_PROPOSE
# default values:
# delay is 100 blocks
# period is 45818 blocks
# fraction is 60
# threshold is 100 ( I recommend putting a threshold in accord to your business)

Compound

⚠️⚠️ GIVE PRIORITY TO OZ STYLE ⚠️⚠️

The following section contains the scripts which will deploy the Compound Alpha version of the governance contracts.

Compound is DAO that created two patterns of Governance contracts Alpha and Bravo.

The compound contracts were tinkered with the proposal of allowing us to set their names and symbols during deployment time. So if you need to change some of the variables it's recommended to change in contract and run npx hardhat compile to update the contract.

Alpha Deployment

Deploy in one go all the contracts to create an Alpha Compound style governance.

The contracts are deployed in the following order 1st the token, 2nd the timelock, 3rd the governance.

npx hardhat alpha_dao \
    --name DAO_NAME \
    --token TOKEN_NAME \
    --symbol TKN \
    --delay time_in_seconds_between_172800_2592000
    --owner 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS #Optional, default value is the deployer address
    --guardian 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS # Optional default as the deployer address.

ERC20 Token

You can find the token contract code here: ERC20Comp.sol

npx hardhat comp_token \
    --name TOKEN_NAME \
    --symbol TKN \
    --owner 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS #Optional, default value is the deployer address

Timelock contract deployment

You can find the timelock contract code here: TimeLock.sol

npx hardhat comp_timelock \
    --delay time_in_seconds_between_172800_2592000

You should deploy the governance contract right after deploying the Timelock one.

Alpha Governance

You can find the dao contract code here: AlphaGovernor.sol

npx hardhat alpha_governance \
    --name DAO_NAME \
    --timelock 0x_ADDRESS_OF_TIMELOCK_CONTRACT \
    --token 0x_ADDRESS_OF_TOKEN_CONTRACT \
    --guardian 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS # Optional default as the deployer.

Bravo Deployment

Deploy in a single command all the contracts needed to create a Bravo Compound style governance.

To deploy bravo you need to deploy 1st the token, 2nd the timelock, 3rd the delegate and 4th delegator. Delegator is the main governance contract and delegate is the governance contract used as a proxy to the delegator.

npx hardhat bravo_dao \
    --name DAO_NAME \
    --token TOKEN_NAME \
    --symbol TKN \
    --delay time_in_seconds_between_172800_2592000
    --owner 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS #Optional, default value is the deployer address
    --guardian 0x_ADDRESS_OF_OWNER_OF_TOTAL_TOKENS # Optional default as the deployer address.

Bravo Governance

Bravo governance delegator is the main contract which points to the other contracts and should be the admin of the timelock.

Bravo governance delegate is the logic for the governance contract. It is used by delegator with the proxy approach. This can be redeployed when they want to upgrade the governance.

Delegate

You can find the dao contract code here: BravoGovernorDelegate.sol

The delegate contract is changed to not block Bravo DAO's which does not have a previous Alpha.

npx hardhat bravo_delegate \
    --name DAO_NAME
Delegator

When the bravo delegator is deployed the governance is initialized. This is the last contract you deploy in the Bravo schema. You can find the dao contract code here: GovernorBravoDelegator.sol

npx hardhat bravo_delegator \
    --timelock 0x_ADDRESS_OF_TIMELOCK_CONTRACT \
    --token 0x_ADDRESS_OF_TOKEN_CONTRACT \
    --admin 0x_ADDRESS_OF_ADMIN \ # Optional
    --governance 0xADDRESS_OF_BRAVO_GOVERNOR_CONTRACT \
    --delay time_in_seconds \ # optional
    --threshold time_in_seconds \ #optional
    --period time_in_seconds \ #optional

Future planning:

  • Add a plugin usage to add it to the Tally website.

This repository is incomplete as I'm still ⚠️⚠️ WORKING ON IT ⚠️⚠️. If you have any suggestions or tips in improving it please mail me: arthur@withtally.com or call in my git.

Example printscreen

Networks that Tally support

Following we have the block explorers and the networks that are supported currently by Tally app.

Ethereum

Polygon

Avalanche

Optimism

Arbitrum

Localhost

To add funds to other accounts you can add the chain to your metamask: - Name: Hardhat - URL/RPC: http://121.0.0.1:8545 - Chain ID: 31337 - Currency: ETH

Run npx hardhat node , it will start the node and print the private_keys and pub_keys, add one of them to your metamask, so you can send funds from that account to others.

If you ever reset the node, the configurations such as block nounce, and other configs in metamask have to be reset. To do so follow these steps: SETTINGS >> ADVANCED >> scroll down >> RESET ACCOUNTS (this will reset the state of them in the networks), and you can use again with localhost.

About

A deployer for governor contracts that are compatible with Tally (tally.xyz)

contractsdaodeployhardhatjssoliditytally

License:MIT License

Languages

Language:Solidity 55.8%Language:JavaScript 44.2%