https://github.com/gitcoinco/alpha-governor-upgrade
https://github.com/gitcoinco/alpha-governor-upgrade
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gitcoinco/alpha-governor-upgrade
- Owner: gitcoinco
- License: other
- Created: 2022-10-25T17:20:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-11T14:56:22.000Z (almost 3 years ago)
- Last Synced: 2024-04-15T13:43:14.110Z (about 2 years ago)
- Language: Solidity
- Size: 121 KB
- Stars: 13
- Watchers: 13
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitcoin Governor Bravo
An upgrade to a "Bravo" compatible Governor for the GitcoinDAO, built using the OpenZeppelin implementation and [Flexible Voting](https://github.com/ScopeLift/flexible-voting).
## Development
### Foundry
This project uses [Foundry](https://github.com/foundry-rs/foundry). Follow [these instructions](https://github.com/foundry-rs/foundry#installation) to install it.
#### Getting started
Clone the repo
```bash
git clone git@github.com:gitcoinco/2022-Governor-upgrade.git
cd 2022-Governor-upgrade
```
Copy the `.env.template` file and populate it with values
```bash
cp .env.template .env
# Open the .env file and add your values
```
```bash
forge install
forge build
forge test
```
### Formatting
Formatting is done via [scopelint](https://github.com/ScopeLift/scopelint). To install scopelint, run:
```bash
cargo install scopelint
```
#### Apply formatting
```bash
scopelint fmt
```
#### Check formatting
```bash
scopelint check
```
## Scripts
* `script/Deploy.s.sol` - Deploys the GitcoinGovernor contract
* `script/Propose.s.sol` - Submits a proposal to the existing Gitcoin Governor Alpha proposing migration to the GitcoinGovernor. Must be executed by someone with sufficient GTC delegation.
To test these scripts locally, start a local fork with anvil:
```bash
anvil --fork-url YOUR_RPC_URL --fork-block-number 15980096
```
Then execute the deploy script.
_NOTE_: You must populate the `DEPLOYER_PRIVATE_KEY` in your `.env` file for this to work.
```bash
forge script script/Deploy.s.sol --tc DeployScript --rpc-url http://localhost:8545 --broadcast
```
Pull the contract address for the new Governor from the deploy script address, then execute the Proposal script.
_NOTE_: You must populate the `PROPOSER_PRIVATE_KEY` in your `.env` file for this to work. Additionally, the
private key must correspond to the `proposer` address defined in the `Proposal.s.sol` script. You can update this
variable to an address you control, however the proposal itself will still revert in this case, unless you provide
the private key of an address that has sufficient GTC Token delegation to have the right to submit a proposal.
```bash
forge script script/Propose.s.sol --sig "run(address)" NEW_GOVERNOR_ADDRESS --rpc-url http://localhost:8545 --broadcast
```
## Dependencies
The Gitcoin Bravo governor inherits from `GovernorCountingFractional`, which is
defined in the [Flexible Voting](https://github.com/ScopeLift/flexible-voting)
project. This is done to enable:
* partial voting (voting with less than full weight)
* rolling voting (voting multiple times on the same proposal with partial weight)
* split voting (splitting vote weight across against/for/abstain options)
We use the `v1.0.0` tag of Flexible Voting because this was the version audited by
Open Zeppelin.
Additionally, this project depends on [Open Zeppelin's contracts
library](https://github.com/OpenZeppelin/openzeppelin-contracts/). However,
because of [an open issue in foundry](https://github.com/foundry-rs/foundry/issues/1855),
we are currently sourcing the OZ library from within the Flexible Voting dependency.
Flexible Voting [uses
OZ](https://github.com/ScopeLift/flexible-voting/tree/4399694c1a70d9e236c4c072802bfbe8e4951bf0/lib)
tagged at [v4.8.0](https://github.com/OpenZeppelin/openzeppelin-contracts/releases/tag/v4.8.0). (Note that an alternative solution would be to install OZ in this repo like normal, and just reference it with relative paths instead of absolute paths).
At the time of writing (March 28 2023) [there are no
changes](https://github.com/OpenZeppelin/openzeppelin-contracts/compare/49c0e43...d00acef) to any of the OZ
contracts used by this repository between v4.8.0 and the [latest
release, v4.8.2](https://github.com/OpenZeppelin/openzeppelin-contracts/releases/tag/v4.8.2).
## License
The code in this repository is licensed under the [GNU Affero General Public License](LICENSE) unless otherwise indicated.
Copyright (C) 2023 Gitcoin Core