38 lines
3.5 KiB
Markdown
38 lines
3.5 KiB
Markdown
|
# Tornado Governance Changes Documentation
|
||
|
|
|
||
|
|
`LotteryAndVaultProposal.sol`, if executed, modifies the tornado.cash governance contract in multiple ways.
|
||
|
|
|
||
|
|
This serves as documentation for all functions which are being added or modified and which have relevant functionality:
|
||
|
|
|
||
|
|
## Governance (Governance.sol)
|
||
|
|
|
||
|
|
The `Governance` contract available in the `tornado-governance` repository modifies the original Governance source code to enable overriding functions via inheritance. This has been submitted via PR.
|
||
|
|
|
||
|
|
This is a non issue, as logic and memory slots are left unaffected and properly referenced to. `tornado-governance` is being imported as a package.
|
||
|
|
|
||
|
|
## Governance Vault Upgrade (GovernanceVaultUpgrade.sol)
|
||
|
|
|
||
|
|
`GovernanceVaultUpgrade` is the first major upgrade to tornado governance. This upgrade introduces new logic which is used to communicate with `TornVault` from the governance contract. The motivation behind this upgrade:
|
||
|
|
|
||
|
|
- split DAO member locked TORN from vesting locked TORN.
|
||
|
|
- block Governance from being able to interact with user TORN.
|
||
|
|
|
||
|
|
To solve point 1 of the formerly stated problems, and to reduce the logic bloat of the lock and unlock functionalities, we have opted for calculating the amount of user TORN locked in the governance contract. The calculations and explanations may be found [here](https://github.com/h-ivor/tornado-lottery-period/blob/final_with_auction/scripts/balance_estimation.md).
|
||
|
|
|
||
|
|
### Additions and changes
|
||
|
|
|
||
|
|
| Function/variable signature | is addition or change? | describe significance |
|
||
|
|
| ---------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
|
|
| `_transferTokens(address,uint256)` | change | instead of transferring to the governance contract, funds are now transferred to the torn vault with a `transferFrom` call, this has an effect on both the `lock` and `lockWithApproval` function |
|
||
|
|
| `unlock(uint256)` | change | unlock now triggers `withdrawTorn(address,uint256)` within the vault which reverts on an unsuccessful transfer (safeTransfer) |
|
||
|
|
| `version` | addition | tells current version of governance contract |
|
||
|
|
| `address immutable userVault` | addition | address of the deployed vault |
|
||
|
|
|
||
|
|
### Tornado Vault (TornadoVault.sol)
|
||
|
|
|
||
|
|
The compliment to the above upgrade. Stores user TORN, does not keep records of it. Serves exclusively for deposits and withdrawals. Works in effect as personal store of TORN for a user with the balance being user for voting. Locking mechanisms are still in effect.
|
||
|
|
|
||
|
|
| Function/variable signature | describe significance |
|
||
|
|
| ------------------------------- | --------------------------------------------------- |
|
||
|
|
| `withdrawTorn(address,uint256)` | used for withdrawing TORN balance to users' account |
|