Merge pull request #7 from tornadocash/TC-74-proposal-architecture-docs
TC-74 architecture docs + tests coverage
This commit is contained in:
commit
6464973b10
|
@ -21,6 +21,11 @@ jobs:
|
||||||
- run: yarn install
|
- run: yarn install
|
||||||
- run: yarn hardhat compile
|
- run: yarn hardhat compile
|
||||||
- run: yarn lint
|
- run: yarn lint
|
||||||
|
- run: yarn coverage
|
||||||
|
- name: Coveralls
|
||||||
|
uses: coverallsapp/github-action@master
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- run: yarn hardhat test
|
- run: yarn hardhat test
|
||||||
- name: Telegram Failure Notification
|
- name: Telegram Failure Notification
|
||||||
uses: appleboy/telegram-action@0.0.7
|
uses: appleboy/telegram-action@0.0.7
|
||||||
|
|
|
@ -5,4 +5,6 @@ artifacts
|
||||||
build
|
build
|
||||||
dist
|
dist
|
||||||
README.md
|
README.md
|
||||||
contracts/v2-vault-and-gas/libraries/EtherSend.sol
|
contracts/v2-vault-and-gas/libraries/EtherSend.sol
|
||||||
|
coverage
|
||||||
|
coverage.json
|
|
@ -0,0 +1,3 @@
|
||||||
|
module.exports = {
|
||||||
|
skipFiles: [],
|
||||||
|
}
|
44
README.md
44
README.md
|
@ -1,13 +1,49 @@
|
||||||
# Tornado governance
|
# Tornado governance [![build status](https://github.com/tornadocash/tornado-governance/actions/workflows/build.yml/badge.svg)](https://github.com/tornadocash/tornado-governance/actions/workflows/build.yml) [![Coverage Status](https://coveralls.io/repos/github/tornadocash/tornado-governance/badge.svg?branch=master)](https://coveralls.io/github/tornadocash/tornado-governance?branch=master)
|
||||||
|
|
||||||
## 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.
|
||||||
|
|
||||||
## Tests
|
## 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 (for [example](https://github.com/Rezan-vm/tornado-relayer-registry)):
|
||||||
|
- 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/Coverage
|
||||||
|
|
||||||
|
Setting up the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/tornadocash/tornado-governance.git
|
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
|
||||||
yarn test
|
```
|
||||||
|
|
||||||
|
Please fill out .env according to the template provided in it. Please ensure that all of the example values are set to the correct addresses.
|
||||||
|
|
||||||
|
To run test scripts:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn test
|
||||||
|
```
|
||||||
|
|
||||||
|
To run tests coverage:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn coverage
|
||||||
```
|
```
|
|
@ -6,6 +6,7 @@ require('hardhat-spdx-license-identifier')
|
||||||
require('hardhat-storage-layout')
|
require('hardhat-storage-layout')
|
||||||
require('hardhat-log-remover')
|
require('hardhat-log-remover')
|
||||||
require('hardhat-contract-sizer')
|
require('hardhat-contract-sizer')
|
||||||
|
require('solidity-coverage')
|
||||||
|
|
||||||
const config = require('./config')
|
const config = require('./config')
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,8 @@
|
||||||
"test:all:f": "yarn prettier:fix && yarn test && yarn lint",
|
"test:all:f": "yarn prettier:fix && yarn test && yarn lint",
|
||||||
"test:f": "yarn prettier:fix && yarn test",
|
"test:f": "yarn prettier:fix && yarn test",
|
||||||
"clean": "yarn prettier:fix && yarn lint",
|
"clean": "yarn prettier:fix && yarn lint",
|
||||||
"compile": "yarn prettier:fix && yarn hardhat compile"
|
"compile": "yarn prettier:fix && yarn hardhat compile",
|
||||||
|
"coverage": "yarn hardhat coverage"
|
||||||
},
|
},
|
||||||
"author": "Tornado.cash team <hello@tornado.cash>",
|
"author": "Tornado.cash team <hello@tornado.cash>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
@ -49,6 +50,7 @@
|
||||||
"hardhat-storage-layout": "^0.1.6",
|
"hardhat-storage-layout": "^0.1.6",
|
||||||
"prettier": "^2.3.2",
|
"prettier": "^2.3.2",
|
||||||
"prettier-plugin-solidity": "^1.0.0-beta.17",
|
"prettier-plugin-solidity": "^1.0.0-beta.17",
|
||||||
"solhint-plugin-prettier": "^0.0.5"
|
"solhint-plugin-prettier": "^0.0.5",
|
||||||
|
"solidity-coverage": "^0.7.21"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue