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
45 Commits 2 Branches 6 Tags 1.2 MiB
JavaScript 64.5%
Solidity 35.5%
master
Go to file
Alexander Drygin 6464973b10
Merge pull request #7 from tornadocash/TC-74-proposal-architecture-docs 
TC-74 architecture docs + tests coverage
2022-08-04 14:50:56 +03:00
.github/workflows TC-95-coverage-to-CI 2022-08-03 14:33:46 +03:00
.vscode gov v2 refactored 2022-03-15 11:21:22 +01:00
contracts add correct upgrade link 2022-03-15 11:21:22 +01:00
resources add version 2 2021-11-08 21:22:55 +01:00
scripts add version 2 2021-11-08 21:22:55 +01:00
test add V3 tests 2022-03-15 11:21:22 +01:00
.editorconfig add version 2 2021-11-08 21:22:55 +01:00
.env.example make it identical to mainnet; fix CI 2021-11-19 17:57:43 +01:00
.eslintrc add version 2 2021-11-08 21:22:55 +01:00
.gitattributes initial 2020-12-15 18:07:50 +03:00
.gitignore v1/v2 tests 2022-03-15 11:21:22 +01:00
.nvmrc add version 2 2021-11-08 21:22:55 +01:00
.prettierignore TC-95-tests-coverage 2022-08-03 14:27:08 +03:00
.prettierrc initial 2020-12-15 18:07:50 +03:00
.solcover.js TC-95-tests-coverage 2022-08-03 14:27:08 +03:00
.solhint.json gov v2 refactored 2022-03-15 11:21:22 +01:00
config.js add V3 tests 2022-03-15 11:21:22 +01:00
hardhat.config.js TC-95-tests-coverage 2022-08-03 14:27:08 +03:00
LICENSE initial 2020-12-15 18:07:50 +03:00
package.json TC-95-tests-coverage 2022-08-03 14:27:08 +03:00
README.md TC-93-proposal-repo-example 2022-08-04 14:40:40 +03:00
yarn.lock TC-95-tests-coverage 2022-08-03 14:27:08 +03:00

README.md

Tornado governance build status Coverage Status

Description

This repository holds all the tornado.cash governance upgrades and original governance contracts.

Documentation

All high-level documentation can be find here.

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 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):
  • 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
  1. 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).
  2. Deploy proposal. The proposal must be smart contracts with verified code.
  3. Go to Tornado governance UI to start the proposal voting process.

Tests/Coverage

Setting up the repository:

git clone https://github.com/tornadocash/tornado-governance.git
yarn
cp .env.example .env

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:

    yarn test

To run tests coverage:

    yarn coverage