tornadocash/tornado-governance
1
0
Fork 0
mirror of https://github.com/tornadocash/tornado-governance synced 2024-02-02 14:53:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

TC-93-proposal-creation-manual

Browse Source
This commit is contained in:
Drygin 2022-08-03 14:10:32 +03:00
parent 9083416f44
commit 1904c9f9c5
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -3,6 +3,27 @@
## Description ## Description
This repository holds all the tornado.cash governance upgrades and original governance contracts. This repository holds all the tornado.cash governance upgrades and original governance contracts.
## Documentation
All high-level documentation can be find [here](https://docs.tornado.cash/general/governance).
## Code architecture
Tornado governance infrastructure consists of two types of repository:
1. **Governance repository** (this one) - contains the original governance contracts and parts of proposals that upgrade governance itself via loopback proxy. So here you can compile the actual version of the governance contract.
2. **Proposal repository** - a separate repository for each governance proposal. It contains the full codebase of a proposal.
### Loopback proxy
[Loopback proxy](https://github.com/tornadocash/tornado-governance/blob/master/contracts/v1/LoopbackProxy.sol) is a special type of proxy contract that is used to add the ability to upgrade the proxy itself. This way governance proposals can upgrade governance implementation.
### Proposal creation manual
To create your custom governance proposal you need to:
1. Create a proposal repository:
- a proposal is executed from the governance contract using delegatecall of __executeProposal()__ method
- as a proposal is executed using delegatecall, it should not store any storage variables - use constants and immutable variables instead
2. If your proposal is upgrading governance itself, you need to create a pull request to the governance repository. PR should add folder with governance contract upgrade (separate folder in contracts folder - for [example](https://github.com/tornadocash/tornado-governance/pull/6/commits/5f36d5744a9f279a58e9ba1f0e0cd9d493af41c7)).
3. Deploy proposal. The proposal must be smart contracts with verified code.
4. Go to Tornado governance [UI](https://tornadocash.eth.limo/governance) to start the proposal voting process.
## Tests ## Tests
```bash ```bash
@ -10,4 +31,6 @@ git clone https://github.com/tornadocash/tornado-governance.git
yarn yarn
cp .env.example .env # you must enter your details into .env cp .env.example .env # you must enter your details into .env
yarn test yarn test
``` ```
## Coverage