Compare commits

...

31 Commits

Author SHA1 Message Date
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
Drygin 5091c0998d TC-93-proposal-repo-example 2022-08-04 14:40:40 +03:00
Drygin 0b92bdf73f TC-95-coverage-to-CI 2022-08-03 14:33:46 +03:00
Drygin 68b42a2c52 TC-95-tests-coverage 2022-08-03 14:27:08 +03:00
Drygin 1904c9f9c5 TC-93-proposal-creation-manual 2022-08-03 14:10:32 +03:00
Drygin 9083416f44 add correct upgrade link 2022-03-15 11:21:22 +01:00
Drygin debbd60010 add V3 tests 2022-03-15 11:21:22 +01:00
Drygin 74f38d68b0 v1/v2 tests 2022-03-15 11:21:22 +01:00
Drygin 74b6021aa7 add gov v3 2022-03-15 11:21:22 +01:00
Drygin 1b50b703c2 clean v2 changes doc 2022-03-15 11:21:22 +01:00
Drygin 1bee8e29f6 gov v2 refactored 2022-03-15 11:21:22 +01:00
Alexey 3b80de8117
update CI 2021-11-19 18:16:36 +01:00
Alexey 64f09ba769
fix CI 2021-11-19 18:09:45 +01:00
Alexey Pertsev 88b7e9ffe1
Merge pull request #5 from tornadocash/temp
make it identical to mainnet; fix CI
2021-11-19 18:06:10 +01:00
Alexey df79557f77
make it identical to mainnet; fix CI 2021-11-19 17:57:43 +01:00
Alexey Pertsev c312c5fb43
Merge pull request #4 from Tisamenus/master
Upgrade to version 2. Proposal 9. https://tornadocash.eth.link/governance/9
2021-11-19 17:52:00 +01:00
Tisamenus 7297b60e93 remove double licenses 2021-11-15 17:49:46 +01:00
Tisamenus 63fc42bec6 remove environment 2021-11-13 20:46:53 +01:00
Tisamenus 98687b4c6d try with environment 2021-11-13 20:43:29 +01:00
Tisamenus 0ed3b41489 fix workflow 2021-11-13 20:38:56 +01:00
Tisamenus 077dbfd10d try with infura 2021-11-13 20:35:58 +01:00
Tisamenus f12ac4cf3e set back to bytes32 resolve, proposal threshold 1000, proper env 2021-11-13 20:25:31 +01:00
Tisamenus 8155cffb76 remove unnecessary env 2021-11-08 21:51:39 +01:00
Tisamenus f13858761c add version 2 2021-11-08 21:22:55 +01:00
Alexey 066f5e1dbf bump version 2021-10-05 21:14:36 +03:00
Alexey Pertsev 004f4c9b3a
Merge pull request #3 from h-ivor/master
Change visibility of lock, lockWithApproval, unlock to public
2021-10-05 21:13:23 +03:00
ivor 913c265aaf
Merge branch 'tornadocash:master' into master 2021-10-05 19:37:58 +02:00
h-ivor 6af010c5eb change visibility of (un)lock functions for simpler inheritance 2021-10-05 19:36:56 +02:00
poma 56957405c8
update version 2021-09-21 20:02:47 +03:00
Roman Semenov 72a13ed9aa
Merge pull request #2 from h-ivor/master
Add virtual keywords to lockWithApproval and lock
2021-09-21 20:00:31 +03:00
h-ivor 280bbbad55 add virtual keywords to lockWithApproval and lock 2021-09-16 19:50:30 +02:00
49 changed files with 61332 additions and 3453 deletions

View File

@ -7,4 +7,3 @@ end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
© 2020 GitHub, Inc.

3
.env.example Normal file
View File

@ -0,0 +1,3 @@
ETHERSCAN_KEY=
ALCHEMY_KEY=
use_latest_block=false

View File

@ -5,7 +5,7 @@
"es6": true,
"mocha": true
},
"extends": "eslint:recommended",
"extends": ["eslint:recommended", "plugin:prettier/recommended", "prettier"],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
@ -21,6 +21,7 @@
"semi": ["error", "never"],
"object-curly-spacing": ["error", "always"],
"comma-dangle": ["error", "always-multiline"],
"require-await": "error"
"require-await": "error",
"prettier/prettier": ["error", { "printWidth": 110 }]
}
}

View File

@ -9,15 +9,24 @@ on:
jobs:
build:
runs-on: ubuntu-latest
env:
ETHERSCAN_KEY: ${{ secrets.ETHERSCAN_KEY }}
ALCHEMY_KEY: ${{ secrets.ALCHEMY_KEY }}
steps:
- name: Checkout
uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
node-version: 14
- run: yarn install
- run: yarn test
- run: yarn hardhat compile
- run: yarn lint
- run: yarn coverage
- name: Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
- run: yarn hardhat test
- name: Telegram Failure Notification
uses: appleboy/telegram-action@0.0.7
if: failure()

36
.gitignore vendored
View File

@ -1,10 +1,3 @@
build
.vscode
/index.js
flats/*
# Created by .ignore support plugin (hsz.mobi)
### Node template
# Logs
logs
*.log
@ -60,6 +53,12 @@ typings/
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
@ -76,11 +75,18 @@ typings/
# parcel-bundler cache (https://parceljs.org/)
.cache
# next.js build output
# Next.js build output
.next
# nuxt.js build output
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
@ -94,6 +100,12 @@ typings/
# DynamoDB Local files
.dynamodb/
ERC20Tornado_flat.sol
ETHTornado_flat.sol
.env
# TernJS port file
.tern-port
artifacts
cache
coverage
coverage.json
.vscode

1
.nvmrc Normal file
View File

@ -0,0 +1 @@
14

View File

@ -1,3 +1,10 @@
.vscode
.idea
cache
artifacts
build
scripts
dist
README.md
contracts/v2-vault-and-gas/libraries/EtherSend.sol
coverage
coverage.json

3
.solcover.js Normal file
View File

@ -0,0 +1,3 @@
module.exports = {
skipFiles: [],
}

View File

@ -8,7 +8,8 @@
}
],
"quotes": ["error", "double"],
"indent": ["error", 2]
"indent": ["error", 2],
"compiler-version": ["error", "^0.6.0"]
},
"plugins": ["prettier"]
}

3
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,3 @@
{
"solidity.compileUsingRemoteVersion": "v0.6.12+commit.27d51765"
}

View File

@ -1,13 +1,49 @@
# Tornado.Cash Governance [![Build Status](https://github.com/tornadocash/tornado-governance/workflows/build/badge.svg)](https://github.com/tornadocash/tornado-governance/actions) [![npm](https://img.shields.io/npm/v/tornado-governance)](https://www.npmjs.com/package/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)
Usage:
## Description
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 (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
git clone https://github.com/tornadocash/tornado-governance.git
yarn
cp .env.example .env
yarn test
```
## How to upgrade implementation
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.
1. Make sure once you deploy new Governance implementation, call `initialize` methods right after it.
To run test scripts:
```bash
yarn test
```
To run tests coverage:
```bash
yarn coverage
```

6
config.js Normal file
View File

@ -0,0 +1,6 @@
module.exports = {
governance: '0x5efda50f22d34F262c29268506C5Fa42cB56A1Ce',
TORN: '0x77777FeDdddFfC19Ff86DB637967013e6C6A116C',
tornWhale: '0xF977814e90dA44bFA03b6295A0616a897441aceC',
forkBlockNumber: 14352372,
}

View File

@ -1,5 +0,0 @@
//SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;
import "torn-token/contracts/mocks/TORNMock.sol";

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
contract Configuration {
@ -20,7 +21,7 @@ contract Configuration {
/// @notice If the outcome of a proposal changes during CLOSING_PERIOD, the vote will be extended by VOTE_EXTEND_TIME (no more than once)
uint256 public VOTE_EXTEND_TIME;
modifier onlySelf {
modifier onlySelf() {
require(msg.sender == address(this), "Governance: unauthorized");
_;
}

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import "./Core.sol";

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;
@ -13,7 +14,15 @@ import "./Configuration.sol";
contract Governance is Initializable, Configuration, Delegation, EnsResolve {
using SafeMath for uint256;
/// @notice Possible states that a proposal may be in
enum ProposalState { Pending, Active, Defeated, Timelocked, AwaitingExecution, Executed, Expired }
enum ProposalState {
Pending,
Active,
Defeated,
Timelocked,
AwaitingExecution,
Executed,
Expired
}
struct Proposal {
// Creator of the proposal
@ -104,16 +113,16 @@ contract Governance is Initializable, Configuration, Delegation, EnsResolve {
uint8 v,
bytes32 r,
bytes32 s
) external {
) public virtual {
torn.permit(owner, address(this), amount, deadline, v, r, s);
_transferTokens(owner, amount);
}
function lockWithApproval(uint256 amount) external {
function lockWithApproval(uint256 amount) public virtual {
_transferTokens(msg.sender, amount);
}
function unlock(uint256 amount) external virtual {
function unlock(uint256 amount) public virtual {
require(getBlockTimestamp() > canWithdrawAfter[msg.sender], "Governance: tokens are locked");
lockedBalance[msg.sender] = lockedBalance[msg.sender].sub(amount, "Governance: insufficient balance");
require(torn.transfer(msg.sender, amount), "TORN: transfer failed");
@ -172,7 +181,7 @@ contract Governance is Initializable, Configuration, Delegation, EnsResolve {
return proposalId;
}
function execute(uint256 proposalId) external virtual payable {
function execute(uint256 proposalId) external payable virtual {
require(state(proposalId) == ProposalState.AwaitingExecution, "Governance::execute: invalid proposal state");
Proposal storage proposal = proposals[proposalId];
proposal.executed = true;
@ -274,7 +283,7 @@ contract Governance is Initializable, Configuration, Delegation, EnsResolve {
return proposals.length - 1;
}
function getBlockTimestamp() internal virtual view returns (uint256) {
function getBlockTimestamp() internal view virtual returns (uint256) {
// solium-disable-next-line security/no-block-members
return block.timestamp;
}

View File

@ -1,4 +1,5 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import "@openzeppelin/contracts/proxy/TransparentUpgradeableProxy.sol";
@ -12,11 +13,7 @@ contract LoopbackProxy is TransparentUpgradeableProxy, EnsResolve {
/**
* @dev Initializes an upgradeable proxy backed by the implementation at `_logic`.
*/
constructor(bytes32 _logic, bytes memory _data)
public
payable
TransparentUpgradeableProxy(resolve(_logic), address(this), _data)
{}
constructor(address _logic, bytes memory _data) public payable TransparentUpgradeableProxy(_logic, address(this), _data) {}
/**
* @dev Override to allow admin (itself) access the fallback function.

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
contract Dummy {

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;
@ -11,12 +12,16 @@ contract MockGovernance is Governance {
time = time_;
}
function getBlockTimestamp() internal override view returns (uint256) {
function getBlockTimestamp() internal view override returns (uint256) {
// solium-disable-next-line security/no-block-members
return time;
}
function resolve(bytes32 addr) public override view returns (address) {
function setTorn(address torna) external {
torn = TORN(torna);
}
function resolve(bytes32 addr) public view override returns (address) {
return address(uint160(uint256(addr) >> (12 * 8)));
}
}

View File

@ -1,12 +1,13 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import "../LoopbackProxy.sol";
contract MockProxy is LoopbackProxy {
constructor(bytes32 _logic, bytes memory _data) public payable LoopbackProxy(_logic, _data) {}
constructor(address _logic, bytes memory _data) public payable LoopbackProxy(_logic, _data) {}
function resolve(bytes32 addr) public override view returns (address) {
function resolve(bytes32 addr) public view override returns (address) {
return address(uint160(uint256(addr) >> (12 * 8)));
}
}

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
import "./Dummy.sol";

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
interface IGovernance {

View File

@ -1,4 +1,5 @@
//SPDX-License-Identifier: MIT
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;
@ -12,14 +13,20 @@ contract NewImplementation is MockGovernance {
uint256 public newVariable;
event Overriden(uint256 x);
function execute(uint256 proposalId) public override payable {
function execute(uint256 proposalId) public payable override {
newVariable = 999;
emit Overriden(proposalId);
}
}
contract ProposalUpgrade {
address public immutable newLogic;
constructor(address _newLogic) public {
newLogic = _newLogic;
}
function executeProposal() public {
IProxy(address(this)).upgradeTo(0xF7E3e47e06F1bDDecb1b2F3a7F60b6b25fd2e233);
IProxy(address(this)).upgradeTo(newLogic);
}
}

View File

@ -0,0 +1,32 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;
pragma experimental ABIEncoderV2;
import "torn-token/contracts/mocks/TORNMock.sol";
struct Recipient2 {
address to;
uint256 amount;
}
contract TORNMock2 is TORNMock {
constructor(
address _governance,
uint256 _pausePeriod,
Recipient2[] memory vesting
) public TORNMock(solve(_governance), _pausePeriod, solve2(vesting)) {}
function solve(address x) private returns (bytes32) {
return bytes32(uint256(x) << 96);
}
function solve2(Recipient2[] memory vesting) private returns (Recipient[] memory) {
Recipient[] memory realVesting = new Recipient[](vesting.length);
for (uint256 i = 0; i < vesting.length; i++) {
realVesting[i].to = solve(vesting[i].to);
realVesting[i].amount = vesting[i].amount;
}
return realVesting;
}
}

View File

@ -0,0 +1,58 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol";
interface IGasCompensationVault {
function compensateGas(address recipient, uint256 gasAmount) external;
function withdrawToGovernance(uint256 amount) external;
}
/**
* @notice This abstract contract is used to add gas compensation functionality to a contract.
* */
abstract contract GasCompensator {
using SafeMath for uint256;
/// @notice this vault is necessary for the gas compensation functionality to work
IGasCompensationVault public immutable gasCompensationVault;
constructor(address _gasCompensationVault) public {
gasCompensationVault = IGasCompensationVault(_gasCompensationVault);
}
/**
* @notice modifier which should compensate gas to account if eligible
* @dev Consider reentrancy, repeated calling of the function being compensated, eligibility.
* @param account address to be compensated
* @param eligible if the account is eligible for compensations or not
* @param extra extra amount in gas to be compensated, will be multiplied by basefee
* */
modifier gasCompensation(
address account,
bool eligible,
uint256 extra
) {
if (eligible) {
uint256 startGas = gasleft();
_;
uint256 gasToCompensate = startGas.sub(gasleft()).add(extra).add(10e3);
gasCompensationVault.compensateGas(account, gasToCompensate);
} else {
_;
}
}
/**
* @notice inheritable unimplemented function to withdraw ether from the vault
* */
function withdrawFromHelper(uint256 amount) external virtual;
/**
* @notice inheritable unimplemented function to deposit ether into the vault
* */
function setGasCompensations(uint256 _gasCompensationsLimit) external virtual;
}

View File

@ -0,0 +1,155 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
pragma experimental ABIEncoderV2;
import { GovernanceVaultUpgrade } from "./GovernanceVaultUpgrade.sol";
import { GasCompensator } from "./GasCompensator.sol";
import { Math } from "@openzeppelin/contracts/math/Math.sol";
/**
* @notice This contract should upgrade governance to be able to compensate gas for certain actions.
* These actions are set to castVote, castDelegatedVote in this contract.
* */
contract GovernanceGasUpgrade is GovernanceVaultUpgrade, GasCompensator {
/**
* @notice constructor
* @param _gasCompLogic gas compensation vault address
* @param _userVault tornado vault address
* */
constructor(address _gasCompLogic, address _userVault)
public
GovernanceVaultUpgrade(_userVault)
GasCompensator(_gasCompLogic)
{}
/// @notice check that msg.sender is multisig
modifier onlyMultisig() {
require(msg.sender == returnMultisigAddress(), "only multisig");
_;
}
/**
* @notice receive ether function, does nothing but receive ether
* */
receive() external payable {}
/**
* @notice function to add a certain amount of ether for gas compensations
* @dev send ether is used in the logic as we don't expect multisig to make a reentrancy attack on governance
* @param gasCompensationsLimit the amount of gas to be compensated
* */
function setGasCompensations(uint256 gasCompensationsLimit) external virtual override onlyMultisig {
require(payable(address(gasCompensationVault)).send(Math.min(gasCompensationsLimit, address(this).balance)));
}
/**
* @notice function to withdraw funds from the gas compensator
* @dev send ether is used in the logic as we don't expect multisig to make a reentrancy attack on governance
* @param amount the amount of ether to withdraw
* */
function withdrawFromHelper(uint256 amount) external virtual override onlyMultisig {
gasCompensationVault.withdrawToGovernance(amount);
}
/**
* @notice function to cast callers votes on a proposal
* @dev IMPORTANT: This function uses the gasCompensation modifier.
* as such this function can trigger a payable fallback.
It is not possible to vote without revert more than once,
without hasAccountVoted being true, eliminating gas refunds in this case.
Gas compensation is also using the low level send(), forwarding 23000 gas
as to disallow further logic execution above that threshold.
* @param proposalId id of proposal account is voting on
* @param support true if yes false if no
* */
function castVote(uint256 proposalId, bool support)
external
virtual
override
gasCompensation(
msg.sender,
!hasAccountVoted(proposalId, msg.sender) && !checkIfQuorumReached(proposalId),
(msg.sender == tx.origin ? 21e3 : 0)
)
{
_castVote(msg.sender, proposalId, support);
}
/**
* @notice function to cast callers votes and votes delegated to the caller
* @param from array of addresses that should have delegated to voter
* @param proposalId id of proposal account is voting on
* @param support true if yes false if no
* */
function castDelegatedVote(
address[] memory from,
uint256 proposalId,
bool support
) external virtual override {
require(from.length > 0, "Can not be empty");
_castDelegatedVote(from, proposalId, support, !hasAccountVoted(proposalId, msg.sender) && !checkIfQuorumReached(proposalId));
}
/// @notice checker for success on deployment
/// @return returns precise version of governance
function version() external pure virtual override returns (string memory) {
return "2.lottery-and-gas-upgrade";
}
/**
* @notice function to check if quorum has been reached on a given proposal
* @param proposalId id of proposal
* @return true if quorum has been reached
* */
function checkIfQuorumReached(uint256 proposalId) public view returns (bool) {
return (proposals[proposalId].forVotes + proposals[proposalId].againstVotes >= QUORUM_VOTES);
}
/**
* @notice function to check if account has voted on a proposal
* @param proposalId id of proposal account should have voted on
* @param account address of the account
* @return true if acc has voted
* */
function hasAccountVoted(uint256 proposalId, address account) public view returns (bool) {
return proposals[proposalId].receipts[account].hasVoted;
}
/**
* @notice function to retrieve the multisig address
* @dev reasoning: if multisig changes we need governance to approve the next multisig address,
* so simply inherit in a governance upgrade from this function and set the new address
* @return the multisig address
* */
function returnMultisigAddress() public pure virtual returns (address) {
return 0xb04E030140b30C27bcdfaafFFA98C57d80eDa7B4;
}
/**
* @notice This should handle the logic of the external function
* @dev IMPORTANT: This function uses the gasCompensation modifier.
* as such this function can trigger a payable fallback.
* It is not possible to vote without revert more than once,
* without hasAccountVoted being true, eliminating gas refunds in this case.
* Gas compensation is also using the low level send(), forwarding 23000 gas
* as to disallow further logic execution above that threshold.
* @param from array of addresses that should have delegated to voter
* @param proposalId id of proposal account is voting on
* @param support true if yes false if no
* @param gasCompensated true if gas should be compensated (given all internal checks pass)
* */
function _castDelegatedVote(
address[] memory from,
uint256 proposalId,
bool support,
bool gasCompensated
) internal gasCompensation(msg.sender, gasCompensated, (msg.sender == tx.origin ? 21e3 : 0)) {
for (uint256 i = 0; i < from.length; i++) {
address delegator = from[i];
require(delegatedTo[delegator] == msg.sender || delegator == msg.sender, "Governance: not authorized");
require(!gasCompensated || !hasAccountVoted(proposalId, delegator), "Governance: voted already");
_castVote(delegator, proposalId, support);
}
}
}

View File

@ -0,0 +1,43 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
pragma experimental ABIEncoderV2;
import { Governance } from "../v1/Governance.sol";
import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol";
import { ITornadoVault } from "./interfaces/ITornadoVault.sol";
/// @title Version 2 Governance contract of the tornado.cash governance
contract GovernanceVaultUpgrade is Governance {
using SafeMath for uint256;
// vault which stores user TORN
ITornadoVault public immutable userVault;
// call Governance v1 constructor
constructor(address _userVault) public Governance() {
userVault = ITornadoVault(_userVault);
}
/// @notice Withdraws TORN from governance if conditions permit
/// @param amount the amount of TORN to withdraw
function unlock(uint256 amount) public virtual override {
require(getBlockTimestamp() > canWithdrawAfter[msg.sender], "Governance: tokens are locked");
lockedBalance[msg.sender] = lockedBalance[msg.sender].sub(amount, "Governance: insufficient balance");
userVault.withdrawTorn(msg.sender, amount);
}
/// @notice checker for success on deployment
/// @return returns precise version of governance
function version() external pure virtual returns (string memory) {
return "2.vault-migration";
}
/// @notice transfers tokens from the contract to the vault, withdrawals are unlock()
/// @param owner account/contract which (this) spender will send to the user vault
/// @param amount amount which spender will send to the user vault
function _transferTokens(address owner, uint256 amount) internal virtual override {
require(torn.transferFrom(owner, address(userVault), amount), "TORN: transferFrom failed");
lockedBalance[owner] = lockedBalance[owner].add(amount);
}
}

View File

@ -0,0 +1,29 @@
# Tornado Governance Changes
Governance proposal [repo](https://github.com/peppersec/tornado-vault-and-gas-proposal).
## 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 |

View File

@ -0,0 +1,8 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
pragma experimental ABIEncoderV2;
interface ITornadoVault {
function withdrawTorn(address recipient, uint256 amount) external;
}

View File

@ -0,0 +1,16 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
import "../../v1/Governance.sol";
contract MockProposal {
address public constant GovernanceAddress = 0x5efda50f22d34F262c29268506C5Fa42cB56A1Ce;
function executeProposal() external {
Governance gov = Governance(GovernanceAddress);
gov.setVotingPeriod(27000);
require(gov.VOTING_PERIOD() == 27000, "Voting period change failed!");
}
}

View File

@ -0,0 +1,61 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
pragma experimental ABIEncoderV2;
import { GovernanceGasUpgrade } from "../v2-vault-and-gas/GovernanceGasUpgrade.sol";
import { ITornadoStakingRewards } from "./interfaces/ITornadoStakingRewards.sol";
/**
* @notice The Governance staking upgrade. Adds modifier to any un/lock operation to update rewards
* @dev CONTRACT RISKS:
* - if updateRewards reverts (should not happen due to try/catch) locks/unlocks could be blocked
* - generally inherits risks from former governance upgrades
*/
contract GovernanceStakingUpgrade is GovernanceGasUpgrade {
ITornadoStakingRewards public immutable Staking;
event RewardUpdateSuccessful(address indexed account);
event RewardUpdateFailed(address indexed account, bytes indexed errorData);
constructor(
address stakingRewardsAddress,
address gasCompLogic,
address userVaultAddress
) public GovernanceGasUpgrade(gasCompLogic, userVaultAddress) {
Staking = ITornadoStakingRewards(stakingRewardsAddress);
}
/**
* @notice This modifier should make a call to Staking to update the rewards for account without impacting logic on revert
* @dev try / catch block to handle reverts
* @param account Account to update rewards for.
* */
modifier updateRewards(address account) {
try Staking.updateRewardsOnLockedBalanceChange(account, lockedBalance[account]) {
emit RewardUpdateSuccessful(account);
} catch (bytes memory errorData) {
emit RewardUpdateFailed(account, errorData);
}
_;
}
function lock(
address owner,
uint256 amount,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) public virtual override updateRewards(owner) {
super.lock(owner, amount, deadline, v, r, s);
}
function lockWithApproval(uint256 amount) public virtual override updateRewards(msg.sender) {
super.lockWithApproval(amount);
}
function unlock(uint256 amount) public virtual override updateRewards(msg.sender) {
super.unlock(amount);
}
}

View File

@ -0,0 +1,14 @@
# Tornado Relayer Registry
Governance proposal [repo](https://github.com/Rezan-vm/tornado-relayer-registry).
Governance upgrade which includes a registry for relayer registration and staking mechanisms for the TORN token.
## Overview
1. Anyone can become a relayer by staking TORN into Registry contract.
2. Minimum stake is governed by the Governance.
3. Each Pool has its own fee % which is also set by the Governance.
4. On every withdrawal via relayer, the relayer has to pay the Tornado Pool fee in TORN. The fee is deducted from his staked balance.
5. All collected fees are stored into StakingReward contract.
6. Any TORN holder can stake their TORN into Governance contract like they were before, but earning fees proportionately to their stake.

View File

@ -0,0 +1,7 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.12;
interface ITornadoStakingRewards {
function updateRewardsOnLockedBalanceChange(address account, uint256 amountLockedBeforehand) external;
}

View File

@ -1,3 +0,0 @@
#!/bin/bash
npx truffle-flattener contracts/Governance.sol > flats/Governance_flat.sol
npx truffle-flattener contracts/LoopbackProxy.sol > flats/MyProxy_flat.sol

56
hardhat.config.js Normal file
View File

@ -0,0 +1,56 @@
require('dotenv').config()
require('@nomiclabs/hardhat-ethers')
require('@nomiclabs/hardhat-etherscan')
require('@nomiclabs/hardhat-waffle')
require('hardhat-spdx-license-identifier')
require('hardhat-storage-layout')
require('hardhat-log-remover')
require('hardhat-contract-sizer')
require('solidity-coverage')
const config = require('./config')
/**
* @type import('hardhat/config').HardhatUserConfig
*/
module.exports = {
solidity: {
compilers: [
{
version: '0.6.12',
settings: {
optimizer: {
enabled: true,
runs: 1000,
},
},
},
],
},
networks: {
hardhat: {
forking: {
url: `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
blockNumber: config.forkBlockNumber,
},
initialBaseFeePerGas: 5,
},
localhost: {
url: 'http://localhost:8545',
timeout: 120000,
},
mainnet: {
url: `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
accounts: ['900e9f0e8ce24c022026649c48a059fb6ffa0a2523811d797b47d789bf106def'], // random pk off keys.lol
timeout: 2147483647,
},
},
mocha: { timeout: 9999999999 },
spdxLicenseIdentifier: {
overwrite: true,
runOnCompile: true,
},
etherscan: {
apiKey: `${process.env.ETHERSCAN_KEY}`,
},
}

View File

@ -1,43 +1,56 @@
{
"name": "tornado-governance",
"version": "1.0.1",
"version": "3.0.0",
"description": "",
"main": "index.js",
"files": [
"contracts/*"
],
"scripts": {
"compile": "truffle compile",
"test": "truffle test",
"test:stacktrace": "yarn test --stacktrace",
"eslint": "eslint --ext .js --ignore-path .gitignore .",
"prettier:check": "prettier --check . --config .prettierrc",
"prettier:fix": "prettier --write . --config .prettierrc",
"lint": "yarn eslint && yarn prettier:check"
"lint": "yarn eslint && yarn prettier:check",
"test:all": "yarn hardhat test",
"test": "yarn test:all",
"test:all:f": "yarn prettier:fix && yarn test && yarn lint",
"test:f": "yarn prettier:fix && yarn test",
"clean": "yarn prettier:fix && yarn lint",
"compile": "yarn prettier:fix && yarn hardhat compile",
"coverage": "yarn hardhat coverage"
},
"author": "Tornado.cash team <hello@tornado.cash>",
"license": "MIT",
"dependencies": {
"@openzeppelin/contracts": "^3.2.0-rc.0",
"@ethersproject/bignumber": "^5.5.0",
"@gnosis.pm/ido-contracts": "^0.5.0",
"@openzeppelin/contracts": "3.2.0-rc.0",
"@openzeppelin/upgrades-core": "^1.0.1",
"torn-token": "^1.0.0"
"torn-token": "^1.0.4",
"tornado-governance": "^1.0.3"
},
"devDependencies": {
"@openzeppelin/truffle-upgrades": "^1.0.2",
"@ethersproject/testcases": "^5.5.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
"@nomiclabs/hardhat-etherscan": "^2.1.6",
"@nomiclabs/hardhat-waffle": "^2.0.1",
"@ticket721/e712": "^0.4.1",
"babel-eslint": "^10.1.0",
"bignumber.js": "^9.0.0",
"bn-chai": "^1.0.1",
"bn.js": "^5.1.3",
"chai": "^4.2.0",
"chai-as-promised": "^7.1.1",
"eslint": "^7.8.1",
"prettier": "^2.1.1",
"prettier-plugin-solidity": "^1.0.0-alpha.57",
"chai": "^4.3.4",
"dotenv": "^10.0.0",
"eslint": "^7.32.0",
"eslint-config-prettier": "^8.3.0",
"eslint-plugin-prettier": "^3.4.0",
"ethereum-waffle": "^3.4.0",
"ethers": "^5.5.1",
"hardhat": "2.6.0",
"hardhat-contract-sizer": "^2.0.3",
"hardhat-log-remover": "^2.0.2",
"hardhat-spdx-license-identifier": "^2.0.3",
"hardhat-storage-layout": "^0.1.6",
"prettier": "^2.3.2",
"prettier-plugin-solidity": "^1.0.0-beta.17",
"solhint-plugin-prettier": "^0.0.5",
"solidity-coverage": "^0.7.10",
"truffle": "^5.1.43",
"truffle-flattener": "^1.4.4",
"truffle-hdwallet-provider": "^1.0.17"
"solidity-coverage": "^0.7.21"
}
}

8299
resources/accounts.json Normal file

File diff suppressed because it is too large Load Diff

44152
resources/hdnode.json Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,55 +0,0 @@
// This module is used only for tests
function send(method, params = []) {
return new Promise((resolve, reject) => {
// eslint-disable-next-line no-undef
web3.currentProvider.send(
{
jsonrpc: '2.0',
id: Date.now(),
method,
params,
},
(err, res) => {
return err ? reject(err) : resolve(res)
},
)
})
}
const takeSnapshot = async () => {
return await send('evm_snapshot')
}
const traceTransaction = async (tx) => {
return await send('debug_traceTransaction', [tx, {}])
}
const revertSnapshot = async (id) => {
await send('evm_revert', [id])
}
const mineBlock = async (timestamp) => {
await send('evm_mine', [timestamp])
}
const increaseTime = async (seconds) => {
await send('evm_increaseTime', [seconds])
}
const minerStop = async () => {
await send('miner_stop', [])
}
const minerStart = async () => {
await send('miner_start', [])
}
module.exports = {
takeSnapshot,
revertSnapshot,
mineBlock,
minerStop,
minerStart,
increaseTime,
traceTransaction,
}

View File

@ -0,0 +1,21 @@
require('dotenv').config()
const { ethers } = require('hardhat')
async function propose(proposalArgs) {
const proposer = proposalArgs[0]
const ProposalContract = proposalArgs[1]
let GovernanceContract = await ethers.getContractAt(
'contracts/v1/Governance.sol:Governance',
'0x5efda50f22d34F262c29268506C5Fa42cB56A1Ce',
)
GovernanceContract = await GovernanceContract.connect(proposer)
const response = await GovernanceContract.propose(ProposalContract.address, proposalArgs[2])
const id = await GovernanceContract.latestProposalIds(proposer.address)
const state = await GovernanceContract.state(id)
return [response, id, state]
}
module.exports.propose = propose

View File

@ -24,7 +24,8 @@ class PermitSigner extends EIP712Signer {
}
async getSignature(privateKey) {
const payload = this.getPayload()
let payload = this.getPayload()
payload.message.owner = payload.message.owner.address
const { hex, v, r, s } = await this.sign(privateKey, payload)
return {
hex,

View File

@ -1,722 +0,0 @@
/* global artifacts, web3, contract */
require('chai').use(require('bn-chai')(web3.utils.BN)).use(require('chai-as-promised')).should()
const util = require('ethereumjs-util')
const Governance = artifacts.require('./MockGovernance.sol')
const Dummy = artifacts.require('./Dummy.sol')
const Proposal = artifacts.require('./Proposal.sol')
const Torn = artifacts.require('./TORNMock.sol')
const TransparentUpgradeableProxy = artifacts.require('./MockProxy.sol')
const ProposalStateChangeGovernance = artifacts.require('./ProposalStateChangeGovernance.sol')
const NewImplementation = artifacts.require('./NewImplementation.sol')
const ProposalUpgrade = artifacts.require('./ProposalUpgrade.sol')
const { PermitSigner } = require('../lib/Permit')
const { toBN, toChecksumAddress } = require('web3-utils')
const { takeSnapshot, revertSnapshot } = require('../scripts/ganacheHelper')
const BN = require('bn.js')
const tornConfig = require('torn-token')
const RLP = require('rlp')
const ProposalState = {
Pending: 0,
Active: 1,
Defeated: 2,
Timelocked: 3,
AwaitingExecution: 4,
Executed: 5,
Expired: 6,
}
const duration = {
seconds: function (val) {
return val
},
minutes: function (val) {
return val * this.seconds(60)
},
hours: function (val) {
return val * this.minutes(60)
},
days: function (val) {
return val * this.hours(24)
},
weeks: function (val) {
return val * this.days(7)
},
years: function (val) {
return val * this.days(365)
},
}
async function getNextAddr(sender, offset = 0) {
const nonce = await web3.eth.getTransactionCount(sender)
return (
'0x' +
web3.utils
.sha3(RLP.encode([sender, Number(nonce) + Number(offset)]))
.slice(12)
.substring(14)
)
}
contract('Governance', (accounts) => {
let governance, dummy
let proposer = accounts[3]
let secondProposer = accounts[8]
let snapshotId
let timestamp = 1577836800 // 01/01/2020 00:00
let torn
let chainId
let domain
let votingDelay
let votingPeriod
let executionExpiration
let executionDelay
let extendTime
let proposalStartTime
let proposalEndTime
let lockingPeriod
let balanceProposer
const cap = toBN(tornConfig.torn.cap)
const tenThousandTorn = toBN(10).pow(toBN(18)).mul(toBN(10000))
const miningPrivateKey = '0xc87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3'
const miningPublicKey = toChecksumAddress(
'0x' + util.privateToAddress(Buffer.from(miningPrivateKey.slice(2), 'hex')).toString('hex'),
)
before(async () => {
chainId = await web3.eth.net.getId()
const governanceExpectedAddr = await getNextAddr(accounts[0], 2)
torn = await Torn.new(governanceExpectedAddr, duration.days(30), [
{ to: miningPublicKey, amount: cap.toString() },
])
const governanceImplementation = await Governance.new()
const calldata = governanceImplementation.contract.methods.initialize(torn.address).encodeABI()
const proxy = await TransparentUpgradeableProxy.new(governanceImplementation.address, calldata)
governance = await Governance.at(proxy.address)
dummy = await Dummy.new()
balanceProposer = cap.div(toBN(4))
await torn.transfer(secondProposer, balanceProposer.div(toBN(2)), { from: miningPublicKey })
await torn.transfer(proposer, balanceProposer, { from: miningPublicKey })
await torn.setChainId(chainId)
await governance.setTimestamp(timestamp)
votingDelay = await governance.VOTING_DELAY()
votingPeriod = await governance.VOTING_PERIOD()
executionExpiration = await governance.EXECUTION_EXPIRATION()
executionDelay = await governance.EXECUTION_DELAY()
extendTime = await governance.VOTE_EXTEND_TIME()
proposalStartTime = new BN(timestamp).add(votingDelay)
proposalEndTime = votingPeriod.add(toBN(proposalStartTime))
lockingPeriod = Number(extendTime) + Number(executionExpiration) + Number(executionDelay)
domain = {
name: await torn.name(),
version: '1',
chainId,
verifyingContract: torn.address,
}
snapshotId = await takeSnapshot()
})
beforeEach(async () => {
await torn.approve(governance.address, cap.div(toBN(4)), { from: proposer })
await governance.lockWithApproval(cap.div(toBN(4)), { from: proposer })
const balance = await governance.lockedBalance(proposer)
balance.should.be.eq.BN(cap.div(toBN(4)))
})
describe('#constructor', () => {
it('should work', async () => {
const proposalCount = await governance.proposalCount()
proposalCount.should.be.eq.BN(0)
const p = await governance.proposals(0)
p.proposer.should.be.equal(governance.address)
p.target.should.be.equal('0x000000000000000000000000000000000000dEaD')
p.endTime.should.be.eq.BN(toBN(0))
p.forVotes.should.be.eq.BN(toBN(0))
p.againstVotes.should.be.eq.BN(toBN(0))
p.executed.should.be.equal(true)
p.extended.should.be.equal(false)
})
})
describe('#propose', () => {
it('should work', async () => {
const { logs } = await governance.propose(dummy.address, 'dummy', { from: proposer })
const id = await governance.latestProposalIds(proposer)
const proposalCount = await governance.proposalCount()
proposalCount.should.be.eq.BN(1)
const proposal = await governance.proposals(id)
proposal.proposer.should.be.equal(proposer)
proposal.startTime.should.be.eq.BN(proposalStartTime)
proposal.endTime.should.be.eq.BN(proposalEndTime)
proposal.forVotes.should.be.eq.BN(0)
proposal.againstVotes.should.be.eq.BN(0)
proposal.executed.should.be.equal(false)
// emit ProposalCreated(newProposal.id, msg.sender, target, startBlock, endBlock, description);
logs[0].event.should.be.equal('ProposalCreated')
logs[0].args.id.should.be.eq.BN(id)
logs[0].args.proposer.should.be.eq.BN(proposer)
logs[0].args.target.should.be.eq.BN(dummy.address)
logs[0].args.description.should.be.eq.BN('dummy')
logs[0].args.startTime.should.be.eq.BN(proposalStartTime)
logs[0].args.endTime.should.be.eq.BN(votingPeriod.add(toBN(proposalStartTime)))
let state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Pending)
await governance.setTimestamp(proposalEndTime)
state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
const accountLock = await governance.canWithdrawAfter(proposer)
accountLock.should.be.eq.BN(proposalEndTime.add(toBN(lockingPeriod)))
})
it('fails if target is not a contract', async () => {
await governance
.propose(accounts[9], 'dummy', { from: proposer })
.should.be.rejectedWith('not a contract')
})
it('fails if proposer has already pending proposal', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
await governance
.propose(dummy.address, 'dummy', { from: proposer })
.should.be.rejectedWith(
'Governance::propose: one live proposal per proposer, found an already active proposal',
)
await governance.setTimestamp(proposalEndTime)
await governance
.propose(dummy.address, 'dummy', { from: proposer })
.should.be.rejectedWith(
'Governance::propose: one live proposal per proposer, found an already active proposal',
)
})
it('fails if proposer does not have voting power', async () => {
const voterBob = accounts[5]
const tenThousandTorn = toBN(10).pow(toBN(18)).mul(toBN(999))
await torn.transfer(voterBob, tenThousandTorn, { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterBob })
await governance.lockWithApproval(tenThousandTorn, { from: voterBob })
await governance
.propose(dummy.address, 'dummy', { from: voterBob })
.should.be.rejectedWith('Governance::propose: proposer votes below proposal threshold.')
})
})
describe('#castVote', () => {
it('should work if support is true', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
const { logs } = await governance.castVote(id, true, { from: proposer })
logs[0].event.should.be.equal('Voted')
logs[0].args.voter.should.be.equal(proposer)
logs[0].args.proposalId.should.be.eq.BN(id)
logs[0].args.support.should.be.equal(true)
logs[0].args.votes.should.be.eq.BN(votesCount)
await governance.getReceipt(id, proposer)
const proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(votesCount)
proposal.againstVotes.should.be.eq.BN(0)
})
it('should work if support is false', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
const { logs } = await governance.castVote(id, false, { from: proposer })
logs[0].event.should.be.equal('Voted')
logs[0].args.voter.should.be.equal(proposer)
logs[0].args.proposalId.should.be.eq.BN(id)
logs[0].args.support.should.be.equal(false)
logs[0].args.votes.should.be.eq.BN(votesCount)
const proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(0)
proposal.againstVotes.should.be.eq.BN(votesCount)
})
it('should be able to change the choice later if already voted before', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, false, { from: proposer })
await governance.castVote(id, true, { from: proposer })
const { logs } = await governance.castVote(id, false, { from: proposer })
logs[0].event.should.be.equal('Voted')
logs[0].args.voter.should.be.equal(proposer)
logs[0].args.proposalId.should.be.eq.BN(id)
logs[0].args.support.should.be.equal(false)
logs[0].args.votes.should.be.eq.BN(votesCount)
const proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(0)
proposal.againstVotes.should.be.eq.BN(votesCount)
})
it('should work if there are multiple voters', async () => {
const voterBob = accounts[5]
const voterAlice = accounts[7]
const tenThousandTorn = toBN(10).pow(toBN(18)).mul(toBN(10000)) // todo
await torn.transfer(voterBob, tenThousandTorn, { from: miningPublicKey })
await torn.transfer(voterAlice, tenThousandTorn.mul(toBN(2)), { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterBob })
await torn.approve(governance.address, tenThousandTorn.mul(toBN(2)), { from: voterAlice })
await governance.lockWithApproval(tenThousandTorn, { from: voterBob })
await governance.lockWithApproval(tenThousandTorn.mul(toBN(2)), { from: voterAlice })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, false, { from: proposer })
await governance.castVote(id, false, { from: voterBob })
await governance.castVote(id, true, { from: voterAlice })
const proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(tenThousandTorn.mul(toBN(2)))
proposal.againstVotes.should.be.eq.BN(votesCount.add(tenThousandTorn))
})
it('fails if voter does not have voting power', async () => {
const voterBob = accounts[5]
await governance.propose(dummy.address, 'dummy', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance
.castVote(id, false, { from: voterBob })
.should.be.rejectedWith('Governance: balance is 0')
})
it('should be able to update number of votes count if the same decision is chosen after more tokens are locked', async () => {
const voterBob = accounts[5]
const tenThousandTorn = toBN(10).pow(toBN(18)).mul(toBN(10000)) // todo
const fiveThousandTorn = tenThousandTorn.div(toBN(2))
await torn.transfer(voterBob, tenThousandTorn, { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterBob })
await governance.lockWithApproval(fiveThousandTorn, { from: voterBob })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, false, { from: proposer })
await governance.castVote(id, false, { from: voterBob })
let proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(toBN(0))
proposal.againstVotes.should.be.eq.BN(votesCount.add(fiveThousandTorn))
await governance.lockWithApproval(fiveThousandTorn, { from: voterBob })
await governance.castVote(id, false, { from: voterBob })
proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(toBN(0))
proposal.againstVotes.should.be.eq.BN(votesCount.add(tenThousandTorn))
})
it('extends time if the vote changes the outcome during the CLOSING_PERIOD', async () => {
const voterBob = accounts[5]
const voterAlice = accounts[7]
await torn.transfer(voterBob, tenThousandTorn, { from: miningPublicKey })
await torn.transfer(voterAlice, tenThousandTorn.mul(toBN(2)), { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterBob })
await torn.approve(governance.address, tenThousandTorn.mul(toBN(2)), { from: voterAlice })
await governance.lockWithApproval(tenThousandTorn, { from: voterBob })
await governance.lockWithApproval(tenThousandTorn.mul(toBN(2)), { from: voterAlice })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalStartTime.add(toBN(1)))
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, false, { from: voterBob })
await governance.castVote(id, true, { from: voterAlice })
let MAX_EXTENDED_TIME = await governance.VOTE_EXTEND_TIME()
let proposal = await governance.proposals(id)
proposal.endTime.should.be.eq.BN(proposalEndTime)
await governance.setTimestamp(proposalEndTime)
await governance.castVote(id, false, { from: proposer })
proposal = await governance.proposals(id)
proposal.endTime.should.be.eq.BN(proposalEndTime.add(MAX_EXTENDED_TIME))
await governance.setTimestamp(proposalEndTime.add(toBN(duration.hours(5))))
const stateAfter = await governance.state(id)
stateAfter.should.be.eq.BN(ProposalState.Active)
})
it('locks tokens after vote', async () => {
const voterAlice = accounts[7]
await torn.transfer(voterAlice, tenThousandTorn, { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterAlice })
await governance.lockWithApproval(tenThousandTorn, { from: voterAlice })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalStartTime.add(toBN(1)))
const state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
const lockBefore = await governance.canWithdrawAfter(voterAlice)
lockBefore.should.be.eq.BN(toBN(0))
await governance.castVote(id, true, { from: voterAlice })
const lockAfter = await governance.canWithdrawAfter(voterAlice)
lockAfter.should.be.eq.BN(proposalEndTime.add(toBN(lockingPeriod)))
})
it('does not reduce lock time', async () => {
const voterAlice = accounts[7]
await torn.transfer(voterAlice, tenThousandTorn, { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterAlice })
await governance.lockWithApproval(tenThousandTorn, { from: voterAlice })
await torn.approve(governance.address, balanceProposer.div(toBN(2)), { from: secondProposer })
await governance.lockWithApproval(balanceProposer.div(toBN(2)), { from: secondProposer })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const id1 = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime.sub(votingDelay).sub(toBN(1)))
await governance.propose(dummy.address, 'dummy2', { from: secondProposer })
const id2 = await governance.latestProposalIds(secondProposer)
await governance.setTimestamp(proposalEndTime)
const state1 = await governance.state(id1)
state1.should.be.eq.BN(ProposalState.Active)
const state2 = await governance.state(id2)
state2.should.be.eq.BN(ProposalState.Active)
const lockBefore = await governance.canWithdrawAfter(voterAlice)
lockBefore.should.be.eq.BN(toBN(0))
await governance.castVote(id2, true, { from: voterAlice })
const lockAfter1 = await governance.canWithdrawAfter(voterAlice)
await governance.castVote(id1, true, { from: voterAlice })
const lockAfter2 = await governance.canWithdrawAfter(voterAlice)
lockAfter1.should.be.eq.BN(lockAfter2)
})
})
describe('#execute', () => {
let proposal
before(async () => {
proposal = await Proposal.new()
})
it('should work', async () => {
await governance.propose(proposal.address, 'proposal', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalStartTime.add(toBN(1)))
let state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, true, { from: proposer })
await governance.setTimestamp(proposalEndTime.add(toBN(executionDelay).add(toBN(duration.days(1)))))
const receipt = await governance.execute(id)
const debugLog = receipt.receipt.rawLogs[0]
const decodedLog = web3.eth.abi.decodeLog(
[
{
type: 'address',
name: 'output',
},
],
debugLog.data,
debugLog.topics[0],
)
const newDummy = await Dummy.at(decodedLog.output)
const dummyText = await newDummy.text()
dummyText.should.be.equal('dummy')
receipt.logs[0].event.should.be.equal('ProposalExecuted')
})
})
describe('#lock', () => {
let owner = miningPublicKey
let tokensAmount = toBN(10).pow(toBN(21)).mul(toBN(1337))
it('permitClass works', async () => {
const args = {
owner,
spender: governance.address,
value: tokensAmount,
nonce: '0x00',
deadline: new BN('123123123123123'),
}
const permitSigner = new PermitSigner(domain, args)
permitSigner.getPayload()
// Generate the signature in place
const privateKey = '0x6370fd033278c143179d81c5526140625662b8daa446c22ee2d73db3707e620c'
const address = '0x22d491Bde2303f2f43325b2108D26f1eAbA1e32b'
const signature = await permitSigner.getSignature(privateKey)
const signer = await permitSigner.getSignerAddress(args, signature.hex)
address.should.be.equal(signer)
})
it('calls approve if signature is valid', async () => {
const chainIdFromContract = await torn.chainId()
chainIdFromContract.should.be.eq.BN(new BN(domain.chainId))
const args = {
owner,
spender: governance.address,
value: tokensAmount,
nonce: 0,
deadline: new BN('5609459200'),
}
const permitSigner = new PermitSigner(domain, args)
const signature = await permitSigner.getSignature(miningPrivateKey)
const signer = await permitSigner.getSignerAddress(args, signature.hex)
signer.should.be.equal(miningPublicKey)
const balanceBefore = await torn.balanceOf(governance.address)
const lockedBalanceBefore = await governance.lockedBalance(owner)
await governance.lock(
args.owner,
// args.spender,
args.value.toString(),
args.deadline.toString(),
signature.v,
signature.r,
signature.s,
{ from: owner },
)
const balanceAfter = await torn.balanceOf(governance.address)
const lockedBalanceAfter = await governance.lockedBalance(owner)
balanceAfter.should.be.eq.BN(balanceBefore.add(args.value))
lockedBalanceAfter.should.be.eq.BN(lockedBalanceBefore.add(args.value))
})
it('adds up tokens if already existing', async () => {
const voterBob = accounts[5]
const tenThousandTorn = toBN(10).pow(toBN(18)).mul(toBN(10000)) // todo
await torn.transfer(voterBob, tenThousandTorn, { from: miningPublicKey })
await torn.approve(governance.address, tenThousandTorn, { from: voterBob })
await governance.lockWithApproval(tenThousandTorn.div(toBN(2)), { from: voterBob })
await governance.lockWithApproval(tenThousandTorn.div(toBN(2)), { from: voterBob })
const balanceAfter = await torn.balanceOf(voterBob)
const lockedBalanceAfter = await governance.lockedBalance(voterBob)
balanceAfter.should.be.eq.BN(toBN(0))
lockedBalanceAfter.should.be.eq.BN(tenThousandTorn)
})
})
describe('#unlock', () => {
it('should work if there is no activity made', async () => {
const balanceBeforeTorn = await torn.balanceOf(proposer)
const balanceBefore = await governance.lockedBalance(proposer)
await governance.unlock(balanceProposer, { from: proposer })
const balanceAfterTorn = await torn.balanceOf(proposer)
const balanceAfter = await governance.lockedBalance(proposer)
balanceBefore.should.be.eq.BN(balanceAfter.add(balanceProposer))
balanceAfterTorn.should.be.eq.BN(balanceBeforeTorn.add(balanceProposer))
})
it('fails if asking more than balance', async () => {
await governance
.unlock(balanceProposer + 1, { from: proposer })
.should.be.rejectedWith('Governance: insufficient balance')
//todo check lockedBalance
})
it('fail if there is active proposal', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
await governance
.unlock(balanceProposer, { from: proposer })
.should.be.rejectedWith('Governance: tokens are locked')
})
it('unlock if there proposals expired', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
await governance.setTimestamp(proposalEndTime.add(toBN(lockingPeriod + duration.minutes(1))))
await governance.unlock(balanceProposer, { from: proposer })
})
})
describe('#undelegate', () => {
it('should work', async () => {
let delegatee = accounts[5]
await governance.delegate(delegatee, { from: proposer })
const { logs } = await governance.undelegate({ from: proposer })
logs[0].args.account.should.be.equal(proposer)
logs[0].args.from.should.be.equal(delegatee)
})
})
describe('#delegate', () => {
it('should work', async () => {
let delegatee = accounts[5]
let vp = await governance.delegatedTo(proposer)
vp.should.be.equal('0x0000000000000000000000000000000000000000')
await governance.delegate(delegatee, { from: proposer })
vp = await governance.delegatedTo(proposer)
vp.should.be.equal(delegatee)
})
it('emits undelegate event if delegate called with non empty delegateTo', async () => {
let delegatee = accounts[5]
let delegateeSecond = accounts[6]
const receipt = await governance.delegate(delegatee, { from: proposer })
receipt.logs.length.should.be.equal(1)
await governance
.delegate(delegatee, { from: proposer })
.should.be.rejectedWith('Governance: invalid delegatee')
const receiptTwo = await governance.delegate(delegateeSecond, { from: proposer })
receiptTwo.logs.length.should.be.equal(2)
receiptTwo.logs[0].event.should.be.equal('Undelegated')
receiptTwo.logs[0].args.account.should.be.equal(proposer)
receiptTwo.logs[0].args.from.should.be.equal(delegatee)
receiptTwo.logs[1].event.should.be.equal('Delegated')
receiptTwo.logs[1].args.account.should.be.equal(proposer)
receiptTwo.logs[1].args.to.should.be.equal(delegateeSecond)
const vp = await governance.delegatedTo(proposer)
vp.should.be.equal(delegateeSecond)
})
it('can propose with delegated votes', async () => {
let delegatee = accounts[5]
await governance.delegate(delegatee, { from: proposer })
await governance.proposeByDelegate(proposer, dummy.address, 'dummy', { from: delegatee })
const proposalCount = await governance.proposalCount()
proposalCount.should.be.eq.BN(1)
const latestProposalId = await governance.latestProposalIds(proposer)
latestProposalId.should.be.eq.BN(1)
const proposal = await governance.proposals(1)
proposal.proposer.should.be.equal(proposer)
})
it('can vote with delegated votes', async () => {
let delegatee = accounts[5]
await governance.delegate(delegatee, { from: proposer })
await governance.propose(dummy.address, 'dummy', { from: proposer })
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalEndTime)
await governance.castDelegatedVote([proposer], id, true, { from: delegatee })
await governance.getReceipt(id, proposer)
let proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(votesCount)
proposal.againstVotes.should.be.eq.BN(0)
await governance.castVote(id, false, { from: proposer })
await governance.getReceipt(id, proposer)
proposal = await governance.proposals(id)
proposal.forVotes.should.be.eq.BN(0)
proposal.againstVotes.should.be.eq.BN(votesCount)
})
})
describe.skip('#getAllProposals', () => {
it('fetches proposals', async () => {
await governance.propose(dummy.address, 'dummy', { from: proposer })
await governance.setTimestamp(proposalEndTime)
const proposals = await governance.getAllProposals(0, 0)
const proposal = proposals[0]
proposal.id.should.be.eq.BN(1)
proposal.proposer.should.be.equal(proposer)
proposal.startTime.should.be.eq.BN(proposalStartTime)
proposal.endTime.should.be.eq.BN(proposalEndTime)
proposal.forVotes.should.be.eq.BN(0)
proposal.againstVotes.should.be.eq.BN(0)
proposal.executed.should.be.equal(false)
proposal.state.should.be.eq.BN(ProposalState.Active)
})
})
describe.skip('#getBalances', () => {
it('fetches lockedBalance', async () => {
const lockedBalanceOne = await governance.getBalances([proposer, secondProposer])
lockedBalanceOne.should.be.eq.BN([balanceProposer, toBN('0')])
await torn.approve(governance.address, balanceProposer.div(toBN(2)), { from: secondProposer })
await governance.lockWithApproval(balanceProposer.div(toBN(2)), { from: secondProposer })
const lockedBalance = await governance.getBalances([proposer, secondProposer])
lockedBalance.should.be.eq.BN([balanceProposer, balanceProposer.div(toBN(2))])
})
})
describe('#upgrades', () => {
it('allows to change variable state', async () => {
const proposal = await ProposalStateChangeGovernance.new()
await governance.propose(proposal.address, 'proposal', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalStartTime.add(toBN(1)))
let state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, true, { from: proposer })
await governance.setTimestamp(proposalEndTime.add(toBN(executionDelay).add(toBN(duration.days(1)))))
const EXECUTION_DELAY_BEFORE = await governance.EXECUTION_DELAY()
EXECUTION_DELAY_BEFORE.should.be.eq.BN(duration.days(2))
const receipt = await governance.execute(id)
const EXECUTION_DELAY_AFTER = await governance.EXECUTION_DELAY()
EXECUTION_DELAY_AFTER.should.be.eq.BN(duration.days(3))
receipt.logs[0].event.should.be.equal('ProposalExecuted')
})
it('upgrades implementation with variables change', async () => {
await NewImplementation.new({ from: accounts[9] })
const proposal = await ProposalUpgrade.new()
// console.log(newImpl.address) // 0xF7E3e47e06F1bDDecb1b2F3a7F60b6b25fd2e233
await governance.propose(proposal.address, 'proposal', { from: proposer })
const id = await governance.latestProposalIds(proposer)
await governance.setTimestamp(proposalStartTime.add(toBN(1)))
let state = await governance.state(id)
state.should.be.eq.BN(ProposalState.Active)
await governance.castVote(id, true, { from: proposer })
await governance.setTimestamp(proposalEndTime.add(toBN(executionDelay).add(toBN(duration.days(1)))))
const newGovernance = await NewImplementation.at(governance.address)
const receipt = await governance.execute(id)
let newVariable = await newGovernance.newVariable()
newVariable.should.be.eq.BN(0)
const receiptExecute = await newGovernance.execute(123)
newVariable = await newGovernance.newVariable()
newVariable.should.be.eq.BN(999)
receipt.logs[0].event.should.be.equal('ProposalExecuted')
receiptExecute.logs[0].event.should.be.equal('Overriden')
})
it('cannot initialize implementation contract', async () => {
const impl = await NewImplementation.new({ from: accounts[9] })
await impl
.initialize(accounts[9])
.should.be.rejectedWith('Contract instance has already been initialized')
})
it('cannot destroy implementation contract')
})
afterEach(async () => {
await revertSnapshot(snapshotId.result)
// eslint-disable-next-line require-atomic-updates
snapshotId = await takeSnapshot()
})
})

37
test/utils.js Normal file
View File

@ -0,0 +1,37 @@
/* global ethers, network */
async function setTime(timestamp) {
await ethers.provider.send('evm_setNextBlockTimestamp', [timestamp])
}
async function takeSnapshot() {
return await ethers.provider.send('evm_snapshot', [])
}
async function revertSnapshot(id) {
await ethers.provider.send('evm_revert', [id])
}
async function advanceTime(sec) {
const now = (await ethers.provider.getBlock('latest')).timestamp
await setTime(now + sec)
}
async function getSignerFromAddress(address) {
await network.provider.request({
method: 'hardhat_impersonateAccount',
params: [address],
})
let signer = await ethers.provider.getSigner(address)
signer.address = signer._address
return signer
}
module.exports = {
setTime,
advanceTime,
takeSnapshot,
revertSnapshot,
getSignerFromAddress,
}

View File

@ -0,0 +1,943 @@
const { ethers } = require('hardhat')
const { expect } = require('chai')
const { BigNumber } = require('@ethersproject/bignumber')
const { PermitSigner } = require('../../scripts/v1/Permit.js')
const tornConfig = require('torn-token')
const config = require('../../config')
const ProposalState = {
Pending: 0,
Active: 1,
Defeated: 2,
Timelocked: 3,
AwaitingExecution: 4,
Executed: 5,
Expired: 6,
}
const duration = {
seconds: function (val) {
return val
},
minutes: function (val) {
return val * this.seconds(60)
},
hours: function (val) {
return val * this.minutes(60)
},
days: function (val) {
return val * this.hours(24)
},
weeks: function (val) {
return val * this.days(7)
},
years: function (val) {
return val * this.days(365)
},
}
describe('V1 governance tests', () => {
/// NETWORK && DOMAIN
let chainId
let domain
//// SIGNERS
let signerArray
let proposer // = accounts[3] #TODO: set this
let secondProposer // = accounts[8] #TODO: set this
let proxy
/// CONTRACTS
let governance, dummy
let snapshotId
let timestamp = 1577836800 // 01/01/2020 00:00
let torn
/// GOVERNANCE VARS
let votingDelay
let votingPeriod
let executionExpiration
let executionDelay
let extendTime
let proposalStartTime
let proposalEndTime
let lockingPeriod
/// ON-CHAIN
let balanceProposer
const cap = BigNumber.from(tornConfig.torn.cap)
const tenThousandTorn = BigNumber.from(10).pow(BigNumber.from(18)).mul(BigNumber.from(10000))
const miningPrivateKey = '0xc87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3'
let miningPublicKey = '0x' + ethers.utils.computeAddress(Buffer.from(miningPrivateKey.slice(2), 'hex'))
before(async function () {
signerArray = await ethers.getSigners()
proposer = signerArray[3]
secondProposer = signerArray[8]
chainId = (await signerArray[0].provider.getNetwork()).chainId
governance = await ethers.getContractFactory('MockGovernance')
governance = await governance.deploy()
torn = await ethers.getContractFactory('TORNMock2')
miningPublicKey = miningPublicKey.slice(2)
proxy = await ethers.getContractFactory('MockProxy')
proxy = await proxy.deploy(governance.address, [])
governance = await ethers.getContractAt('MockGovernance', proxy.address)
torn = await torn.deploy(proxy.address, duration.days(30), [
{ to: miningPublicKey, amount: cap.toString() },
])
await governance.initialize(torn.address + '000000000000000000000000')
expect(await governance.torn()).to.equal(torn.address)
dummy = await ethers.getContractFactory('Dummy')
dummy = await dummy.deploy()
balanceProposer = cap.div(BigNumber.from(4))
await ethers.provider.send('hardhat_impersonateAccount', [miningPublicKey])
miningPublicKey = await ethers.getSigner(miningPublicKey)
await signerArray[0].sendTransaction({ value: ethers.utils.parseEther('3'), to: miningPublicKey.address })
torn = await torn.connect(miningPublicKey)
await torn.transfer(secondProposer.address, balanceProposer.div(BigNumber.from(2)))
await torn.transfer(proposer.address, balanceProposer)
await torn.setChainId(chainId)
await governance.setTimestamp(timestamp)
votingDelay = await governance.VOTING_DELAY()
votingPeriod = await governance.VOTING_PERIOD()
executionExpiration = await governance.EXECUTION_EXPIRATION()
executionDelay = await governance.EXECUTION_DELAY()
extendTime = await governance.VOTE_EXTEND_TIME()
proposalStartTime = BigNumber.from(timestamp).add(votingDelay)
proposalEndTime = votingPeriod.add(BigNumber.from(proposalStartTime))
lockingPeriod = Number(extendTime) + Number(executionExpiration) + Number(executionDelay)
domain = {
name: await torn.name(),
version: '1',
chainId,
verifyingContract: torn.address,
}
snapshotId = await ethers.provider.send('evm_snapshot', [])
})
beforeEach(async function () {
torn = await torn.connect(proposer)
await torn.approve(governance.address, balanceProposer)
governance = await governance.connect(proposer)
await governance.lockWithApproval(balanceProposer)
const balance = await governance.lockedBalance(proposer.address)
expect(balance).to.equal(balanceProposer)
})
describe('#contructor', () => {
it('should work', async () => {
const proposalCount = await governance.proposalCount()
expect(proposalCount).to.equal(BigNumber.from(0))
const p = await governance.proposals(0)
expect(p.proposer).to.equal(governance.address)
expect(p.target).to.equal('0x000000000000000000000000000000000000dEaD')
expect(p.endTime).to.equal(BigNumber.from(0))
expect(p.forVotes).to.equal(BigNumber.from(0))
expect(p.againstVotes).to.equal(BigNumber.from(0))
expect(p.executed).to.equal(true)
expect(p.extended).to.equal(false)
})
})
describe('#propose', () => {
it('should work', async () => {
const response = await governance.propose(dummy.address, 'dummy')
const receipt = await response.wait()
const logs = receipt.events
const id = await governance.latestProposalIds(proposer.address)
const proposalCount = await governance.proposalCount()
expect(proposalCount).to.equal(1)
const proposal = await governance.proposals(id)
expect(proposal.proposer).to.equal(proposer.address)
expect(proposal.startTime).to.equal(proposalStartTime)
expect(proposal.endTime).to.equal(proposalEndTime)
expect(proposal.forVotes).to.equal(0)
expect(proposal.againstVotes).to.equal(0)
expect(proposal.executed).to.equal(false)
// emit ProposalCreated(newProposal.id, msg.sender, target, startBlock, endBlock, description);
expect(logs[0].event).to.equal('ProposalCreated')
expect(logs[0].args.id).to.equal(id)
expect(logs[0].args.proposer).to.equal(proposer.address)
expect(logs[0].args.target).to.equal(dummy.address)
expect(logs[0].args.description).to.equal('dummy')
expect(logs[0].args.startTime).to.equal(proposalStartTime)
expect(logs[0].args.endTime).to.equal(votingPeriod.add(BigNumber.from(proposalStartTime)))
let state = await governance.state(id)
expect(state).to.equal(ProposalState.Pending)
await governance.setTimestamp(proposalEndTime)
state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
const accountLock = await governance.canWithdrawAfter(proposer.address)
expect(accountLock).to.equal(proposalEndTime.add(BigNumber.from(lockingPeriod)))
})
it('fails if target is not a contract', async () => {
governance = await governance.connect(proposer)
await expect(governance.propose(signerArray[9].address, 'dummy')).to.be.revertedWith('not a contract')
})
it('fails if proposer has already pending proposal', async () => {
await governance.propose(dummy.address, 'dummy')
await expect(governance.propose(dummy.address, 'dummy')).to.be.revertedWith(
'Governance::propose: one live proposal per proposer, found an already active proposal',
)
await governance.setTimestamp(proposalEndTime)
await expect(governance.propose(dummy.address, 'dummy')).to.be.revertedWith(
'Governance::propose: one live proposal per proposer, found an already active proposal',
)
})
it('fails if proposer does not have voting power', async function () {
const voterBob = signerArray[5]
const oneThousandTorn = ethers.utils.parseEther('1000')
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterBob.address, oneThousandTorn)
torn = await torn.connect(voterBob)
await torn.approve(governance.address, oneThousandTorn)
expect(await governance.torn()).to.equal(torn.address)
governance = await governance.connect(voterBob)
await governance.lockWithApproval(oneThousandTorn.sub(1))
await expect(governance.propose(dummy.address, 'dummy')).to.be.revertedWith(
'Governance::propose: proposer votes below proposal threshold',
)
})
})
describe('#castVote', () => {
it('should work if support is true', async () => {
await governance.propose(dummy.address, 'dummy')
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
const response = await governance.castVote(id, true)
const receipt = await response.wait()
const logs = await receipt.events
expect(logs[0].event).to.equal('Voted')
expect(logs[0].args.voter).to.equal(proposer.address)
expect(logs[0].args.proposalId).to.equal(id)
expect(logs[0].args.support).to.equal(true)
expect(logs[0].args.votes).to.equal(votesCount)
await governance.getReceipt(id, proposer.address)
const proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(votesCount)
expect(proposal.againstVotes).to.equal(0)
})
it('should work if support is false', async () => {
await governance.propose(dummy.address, 'dummy')
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
const response = await governance.castVote(id, false)
const receipt = await response.wait()
const logs = await receipt.events
expect(logs[0].event).to.equal('Voted')
expect(logs[0].args.voter).to.equal(proposer.address)
expect(logs[0].args.proposalId).to.equal(id)
expect(logs[0].args.support).to.equal(false)
expect(logs[0].args.votes).to.equal(votesCount)
const proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(0)
expect(proposal.againstVotes).to.equal(votesCount)
})
it('should be able to change the choice later if already voted before', async () => {
await governance.propose(dummy.address, 'dummy')
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
await governance.castVote(id, false)
await governance.castVote(id, true)
const response = await governance.castVote(id, false)
const receipt = await response.wait()
const logs = await receipt.events
expect(logs[0].event).to.equal('Voted')
expect(logs[0].args.voter).to.equal(proposer.address)
expect(logs[0].args.proposalId).to.equal(id)
expect(logs[0].args.support).to.equal(false)
expect(logs[0].args.votes).to.equal(votesCount)
const proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(0)
expect(proposal.againstVotes).to.equal(votesCount)
})
it('should work if there are multiple voters', async () => {
const voterBob = signerArray[5]
const voterAlice = signerArray[7]
const tenThousandTorn = ethers.utils.parseEther('10000')
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterBob.address, tenThousandTorn)
await torn.transfer(voterAlice.address, tenThousandTorn.mul(BigNumber.from(2)))
torn = await torn.connect(voterBob)
await torn.approve(governance.address, tenThousandTorn)
torn = await torn.connect(voterAlice)
await torn.approve(governance.address, tenThousandTorn.mul(BigNumber.from(2)))
governance = await governance.connect(voterBob)
await governance.lockWithApproval(tenThousandTorn)
governance = await governance.connect(voterAlice)
await governance.lockWithApproval(tenThousandTorn.mul(BigNumber.from(2)))
governance = await governance.connect(proposer)
await expect(governance.propose(dummy.address, 'dummy')).to.not.be.reverted
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
await governance.castVote(id, false)
governance = await governance.connect(voterBob)
await governance.castVote(id, false)
governance = await governance.connect(voterAlice)
await governance.castVote(id, true)
const proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(tenThousandTorn.mul(BigNumber.from(2)))
expect(proposal.againstVotes).to.equal(votesCount.add(tenThousandTorn))
})
it('fails if voter does not have voting power', async () => {
const voterBob = signerArray[5]
governance = await governance.connect(proposer)
await governance.propose(dummy.address, 'dummy')
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
governance = await governance.connect(voterBob)
await expect(governance.castVote(id, false)).to.be.revertedWith('Governance: balance is 0')
})
it('should be able to update number of votes count if the same decision is chosen after more tokens are locked', async () => {
const voterBob = signerArray[5]
const tenThousandTorn = ethers.utils.parseEther('10000')
const fiveThousandTorn = tenThousandTorn.div(BigNumber.from(2))
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterBob.address, tenThousandTorn)
torn = await torn.connect(voterBob)
await torn.approve(governance.address, tenThousandTorn)
governance = await governance.connect(voterBob)
await governance.lockWithApproval(fiveThousandTorn)
governance = await governance.connect(proposer)
await governance.propose(dummy.address, 'dummy')
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
governance = await governance.connect(proposer)
await governance.castVote(id, false)
governance = await governance.connect(voterBob)
await governance.castVote(id, false)
let proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(BigNumber.from(0))
expect(proposal.againstVotes).to.equal(votesCount.add(fiveThousandTorn))
await governance.lockWithApproval(fiveThousandTorn)
await governance.castVote(id, false)
proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(BigNumber.from(0))
expect(proposal.againstVotes).to.equal(votesCount.add(tenThousandTorn))
})
it('extends time if the vote changes the outcome during the CLOSING_PERIOD', async () => {
const voterBob = signerArray[5]
const voterAlice = signerArray[7]
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterBob.address, tenThousandTorn)
await torn.transfer(voterAlice.address, tenThousandTorn.mul(BigNumber.from(2)))
torn = await torn.connect(voterBob)
await torn.approve(governance.address, tenThousandTorn)
torn = await torn.connect(voterAlice)
await torn.approve(governance.address, tenThousandTorn.mul(BigNumber.from(2)))
governance = await governance.connect(voterBob)
await governance.lockWithApproval(tenThousandTorn)
governance = await governance.connect(voterAlice)
await governance.lockWithApproval(tenThousandTorn.mul(BigNumber.from(2)))
governance = await governance.connect(proposer)
await governance.propose(dummy.address, 'dummy')
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalStartTime.add(BigNumber.from(1)))
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
governance = await governance.connect(voterBob)
await governance.castVote(id, false)
governance = await governance.connect(voterAlice)
await governance.castVote(id, true)
let MAX_EXTENDED_TIME = await governance.VOTE_EXTEND_TIME()
let proposal = await governance.proposals(id)
expect(proposal.endTime).to.equal(proposalEndTime)
await governance.setTimestamp(proposalEndTime)
governance = await governance.connect(proposer)
await governance.castVote(id, false)
proposal = await governance.proposals(id)
expect(proposal.endTime).to.equal(proposalEndTime.add(MAX_EXTENDED_TIME))
await governance.setTimestamp(proposalEndTime.add(BigNumber.from(duration.hours(5))))
const stateAfter = await governance.state(id)
expect(stateAfter).to.equal(ProposalState.Active)
})
it('locks tokens after vote', async () => {
const voterAlice = signerArray[7]
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterAlice.address, tenThousandTorn)
torn = await torn.connect(voterAlice)
await torn.approve(governance.address, tenThousandTorn)
governance = await governance.connect(voterAlice)
await governance.lockWithApproval(tenThousandTorn)
governance = await governance.connect(proposer)
await governance.propose(dummy.address, 'dummy')
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalStartTime.add(BigNumber.from(1)))
const state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
const lockBefore = await governance.canWithdrawAfter(voterAlice.address)
expect(lockBefore).to.equal(BigNumber.from(0))
governance = await governance.connect(voterAlice)
await governance.castVote(id, true)
const lockAfter = await governance.canWithdrawAfter(voterAlice.address)
expect(lockAfter).to.equal(proposalEndTime.add(BigNumber.from(lockingPeriod)))
})
it('does not reduce lock time', async () => {
const voterAlice = signerArray[7]
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterAlice.address, tenThousandTorn)
torn = await torn.connect(voterAlice)
await torn.approve(governance.address, tenThousandTorn)
governance = await governance.connect(voterAlice)
await governance.lockWithApproval(tenThousandTorn)
torn = await torn.connect(secondProposer)
await torn.approve(governance.address, balanceProposer.div(BigNumber.from(2)))
governance = await governance.connect(secondProposer)
await governance.lockWithApproval(balanceProposer.div(BigNumber.from(2)))
governance = await governance.connect(proposer)
await governance.propose(dummy.address, 'dummy')
const id1 = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime.sub(votingDelay).sub(BigNumber.from(1)))
governance = await governance.connect(secondProposer)
await governance.propose(dummy.address, 'dummy2')
const id2 = await governance.latestProposalIds(secondProposer.address)
await governance.setTimestamp(proposalEndTime)
const state1 = await governance.state(id1)
expect(state1).to.equal(ProposalState.Active)
const state2 = await governance.state(id2)
expect(state2).to.equal(ProposalState.Active)
const lockBefore = await governance.canWithdrawAfter(voterAlice.address)
expect(lockBefore).to.equal(BigNumber.from(0))
governance = await governance.connect(voterAlice)
await governance.castVote(id2, true)
const lockAfter1 = await governance.canWithdrawAfter(voterAlice.address)
await governance.castVote(id1, true)
const lockAfter2 = await governance.canWithdrawAfter(voterAlice.address)
expect(lockAfter1).to.equal(lockAfter2)
})
})
describe('#lock', () => {
let owner = miningPublicKey
let tokensAmount = BigNumber.from(10).pow(BigNumber.from(21)).mul(BigNumber.from(1337))
it('permitClass works', async () => {
owner = owner.slice(2)
owner = await ethers.getSigner(owner)
const args = {
owner,
spender: governance.address,
value: tokensAmount,
nonce: '0x00',
deadline: BigNumber.from('123123123123123'),
}
const permitSigner = new PermitSigner(domain, args)
permitSigner.getPayload()
// Generate the signature in place
const privateKey = '0x6370fd033278c143179d81c5526140625662b8daa446c22ee2d73db3707e620c'
const address = '0x22d491Bde2303f2f43325b2108D26f1eAbA1e32b'
const signature = await permitSigner.getSignature(privateKey)
const signer = await permitSigner.getSignerAddress(args, signature.hex)
expect(address).to.equal(signer)
})
it('calls approve if signature is valid', async () => {
const chainIdFromContract = await torn.chainId()
expect(chainIdFromContract).to.equal(new BigNumber.from(domain.chainId))
const args = {
owner,
spender: governance.address,
value: tokensAmount,
nonce: 0,
deadline: BigNumber.from('5609459200'),
}
const permitSigner = new PermitSigner(domain, args)
const signature = await permitSigner.getSignature(miningPrivateKey)
const signer = await permitSigner.getSignerAddress(args, signature.hex)
expect(signer).to.equal(miningPublicKey.address)
const balanceBefore = await torn.balanceOf(governance.address)
const lockedBalanceBefore = await governance.lockedBalance(owner.address)
governance = await governance.connect(owner)
await governance.lock(
args.owner,
// args.spender,
args.value.toString(),
args.deadline.toString(),
signature.v,
signature.r,
signature.s,
)
const balanceAfter = await torn.balanceOf(governance.address)
const lockedBalanceAfter = await governance.lockedBalance(owner.address)
expect(balanceAfter).to.equal(balanceBefore.add(args.value))
expect(lockedBalanceAfter).to.equal(lockedBalanceBefore.add(args.value))
})
it('adds up tokens if already existing', async () => {
const voterBob = signerArray[5]
const tenThousandTorn = ethers.utils.parseEther('10000')
torn = await torn.connect(miningPublicKey)
await torn.transfer(voterBob.address, tenThousandTorn)
torn = await torn.connect(voterBob)
await torn.approve(governance.address, tenThousandTorn)
governance = await governance.connect(voterBob)
await governance.lockWithApproval(tenThousandTorn.div(BigNumber.from(2)))
await governance.lockWithApproval(tenThousandTorn.div(BigNumber.from(2)))
const balanceAfter = await torn.balanceOf(voterBob.address)
const lockedBalanceAfter = await governance.lockedBalance(voterBob.address)
expect(balanceAfter).to.equal(BigNumber.from(0))
expect(lockedBalanceAfter).to.equal(tenThousandTorn)
})
})
describe('#unlock', () => {
it('should work if there is no activity made', async () => {
const balanceBeforeTorn = await torn.balanceOf(proposer.address)
const balanceBefore = await governance.lockedBalance(proposer.address)
governance = await governance.connect(proposer)
await governance.unlock(balanceProposer)
const balanceAfterTorn = await torn.balanceOf(proposer.address)
const balanceAfter = await governance.lockedBalance(proposer.address)
expect(balanceBefore).to.equal(balanceAfter.add(balanceProposer))
expect(balanceAfterTorn).to.equal(balanceBeforeTorn.add(balanceProposer))
})
it('fails if asking more than balance', async () => {
governance = await governance.connect(proposer)
await expect(governance.unlock(balanceProposer + 1)).to.be.revertedWith(
'Governance: insufficient balance',
)
})
it('fail if there is active proposal', async () => {
await governance.propose(dummy.address, 'dummy')
await expect(governance.unlock(balanceProposer)).to.be.revertedWith('Governance: tokens are locked')
})
it('unlock if there proposals expired', async () => {
await governance.propose(dummy.address, 'dummy')
await governance.setTimestamp(proposalEndTime.add(BigNumber.from(lockingPeriod + duration.minutes(1))))
await governance.unlock(balanceProposer)
})
})
describe('#undelegate', () => {
it('should work', async () => {
let delegatee = signerArray[5]
await governance.delegate(delegatee.address)
const response = await governance.undelegate()
const receipt = await response.wait()
const logs = receipt.events
expect(logs[0].args.account).to.equal(proposer.address)
expect(logs[0].args[1]).to.equal(delegatee.address)
})
})
describe('#delegate', () => {
it('should work', async () => {
let delegatee = signerArray[5]
let vp = await governance.delegatedTo(proposer.address)
expect(String(vp)).to.equal('0x0000000000000000000000000000000000000000')
await governance.delegate(delegatee.address)
vp = await governance.delegatedTo(proposer.address)
expect(String(vp)).to.equal(delegatee.address)
})
it('emits undelegate event if delegate called with non empty delegateTo', async () => {
let delegatee = signerArray[5]
let delegateeSecond = signerArray[6]
const response = await governance.delegate(delegatee.address)
const receipt = await response.wait()
expect(receipt.logs.length).to.equal(1)
await expect(governance.delegate(delegatee.address)).to.be.revertedWith('Governance: invalid delegatee')
const responseTwo = await governance.delegate(delegateeSecond.address)
let receiptTwo = await responseTwo.wait()
receiptTwo.logs = receiptTwo.events
expect(receiptTwo.logs.length).to.equal(2)
expect(receiptTwo.logs[0].event).to.equal('Undelegated')
expect(receiptTwo.logs[0].args.account).to.equal(proposer.address)
expect(receiptTwo.logs[0].args.from).to.equal(delegatee.address)
expect(receiptTwo.logs[1].event).to.equal('Delegated')
expect(receiptTwo.logs[1].args.account).to.equal(proposer.address)
expect(receiptTwo.logs[1].args[1]).to.equal(delegateeSecond.address)
const vp = await governance.delegatedTo(proposer.address)
expect(vp).to.equal(delegateeSecond.address)
})
it('can propose with delegated votes', async () => {
let delegatee = signerArray[5]
await governance.delegate(delegatee.address)
governance = await governance.connect(delegatee)
await governance.proposeByDelegate(proposer.address, dummy.address, 'dummy')
const proposalCount = await governance.proposalCount()
expect(proposalCount).to.equal(1)
const latestProposalId = await governance.latestProposalIds(proposer.address)
expect(latestProposalId).to.equal(1)
const proposal = await governance.proposals(1)
expect(proposal.proposer).to.equal(proposer.address)
})
it('can vote with delegated votes', async () => {
let delegatee = signerArray[5]
governance = await governance.connect(proposer)
await governance.delegate(delegatee.address)
await governance.propose(dummy.address, 'dummy')
const votesCount = balanceProposer
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalEndTime)
governance = await governance.connect(delegatee)
await governance.castDelegatedVote([proposer.address], id, true)
await governance.getReceipt(id, proposer.address)
let proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(votesCount)
expect(proposal.againstVotes).to.equal(0)
governance = await governance.connect(proposer)
await governance.castVote(id, false)
await governance.getReceipt(id, proposer.address)
proposal = await governance.proposals(id)
expect(proposal.forVotes).to.equal(0)
expect(proposal.againstVotes).to.equal(votesCount)
})
})
describe.skip('#getAllProposals', () => {
it('fetches proposals', async () => {
await governance.propose(dummy.address, 'dummy')
await governance.setTimestamp(proposalEndTime)
const proposals = await governance.getAllProposals(0, 0)
const proposal = proposals[0]
expect(proposal.id).to.equal(1)
expect(proposal.proposer).to.equal(proposer.address)
expect(proposal.startTime).to.equal(proposalStartTime)
expect(proposal.endTime).to.equal(proposalEndTime)
expect(proposal.forVotes).to.equal(0)
expect(proposal.againstVotes).to.equal(0)
expect(proposal.executed).to.equal(false)
expect(proposal.state).to.equal(ProposalState.Active)
})
})
describe.skip('#getBalances', () => {
it('fetches lockedBalance', async () => {
const lockedBalanceOne = await governance.getBalances([proposer.address, secondProposer.address])
lockedBalanceOne.to.equal([balanceProposer, BigNumber.from('0')])
torn = await torn.connect(secondProposer)
await torn.approve(governance.address, balanceProposer.div(BigNumber.from(2)))
governance = await governance.connect(secondProposer)
await governance.lockWithApproval(balanceProposer.div(BigNumber.from(2)))
const lockedBalance = await governance.getBalances([proposer.address, secondProposer.address])
expect(lockedBalance).to.equal([balanceProposer, balanceProposer.div(BigNumber.from(2))])
})
})
describe('#upgrades', () => {
it('allows to change variable state', async () => {
let proposal = await ethers.getContractFactory('ProposalStateChangeGovernance')
proposal = await proposal.deploy()
governance = await governance.connect(proposer)
await governance.propose(proposal.address, 'proposal')
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalStartTime.add(BigNumber.from(1)))
let state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
await governance.castVote(id, true)
await governance.setTimestamp(
proposalEndTime.add(BigNumber.from(executionDelay).add(BigNumber.from(duration.days(1)))),
)
const EXECUTION_DELAY_BEFORE = await governance.EXECUTION_DELAY()
expect(EXECUTION_DELAY_BEFORE).to.equal(duration.days(2))
const response = await governance.execute(id)
let receipt = await response.wait()
receipt.logs = receipt.events
const EXECUTION_DELAY_AFTER = await governance.EXECUTION_DELAY()
expect(EXECUTION_DELAY_AFTER).to.equal(duration.days(3))
expect(receipt.logs[0].event).to.equal('ProposalExecuted')
})
it('upgrades implementation with variables change', async () => {
let NewImplementation = await ethers.getContractFactory('NewImplementation')
NewImplementation = await NewImplementation.deploy()
let proposal = await ethers.getContractFactory('ProposalUpgrade')
proposal = await proposal.deploy(NewImplementation.address)
governance = await governance.connect(proposer)
await governance.propose(proposal.address, 'proposal')
const id = await governance.latestProposalIds(proposer.address)
await governance.setTimestamp(proposalStartTime.add(BigNumber.from(1)))
let state = await governance.state(id)
expect(state).to.equal(ProposalState.Active)
governance = await governance.connect(proposer)
await governance.castVote(id, true)
await governance.setTimestamp(
proposalEndTime.add(BigNumber.from(executionDelay).add(BigNumber.from(duration.days(1)))),
)
const newGovernance = await ethers.getContractAt('NewImplementation', governance.address)
const response = await governance.execute(id)
let receipt = await response.wait()
receipt.logs = receipt.events
let newVariable = await newGovernance.newVariable()
expect(newVariable).to.equal(0)
const responseExecute = await newGovernance.execute(123)
let receiptExecute = await responseExecute.wait()
receiptExecute.logs = receiptExecute.events
newVariable = await newGovernance.newVariable()
expect(newVariable).to.equal(999)
expect(receipt.logs[1].event).to.equal('ProposalExecuted')
expect(receiptExecute.logs[0].event).to.equal('Overriden')
})
it('cannot initialize implementation contract', async () => {
const impl = await (await ethers.getContractFactory('NewImplementation')).deploy()
await expect(impl.initialize(signerArray[0].address + '000000000000000000000000')).to.be.revertedWith(
'Contract instance has already been initialized',
)
})
})
afterEach(async () => {
await ethers.provider.send('evm_revert', [snapshotId])
snapshotId = await ethers.provider.send('evm_snapshot', [])
})
after(async function () {
await ethers.provider.send('hardhat_reset', [
{
forking: {
jsonRpcUrl: `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
blockNumber: process.env.use_latest_block == 'true' ? undefined : config.forkBlockNumber,
},
},
])
})
})

View File

@ -0,0 +1,496 @@
const { expect } = require('chai')
const { ethers } = require('hardhat')
const { BigNumber } = require('@ethersproject/bignumber')
const { propose } = require('../../scripts/helper/propose_proposal.js')
const testcases = require('@ethersproject/testcases')
const seedbase = require('../../resources/hdnode.json')
const accountList = require('../../resources/accounts.json')
const config = require('../../config')
describe('V2 governance tests', () => {
///// ON-CHAIN CONSTANTS
let proxy_address = '0x5efda50f22d34F262c29268506C5Fa42cB56A1Ce'
let quorumVotes
///////////////////////////// CONTRACTS
let GovernanceContract
let TornToken
//////////////////// IMPERSONATED
let tornadoMultisig
//////////////////////////////// MOCK
let MockProposalFactory
/////// GOV PARAMS
const ProposalState = {
Pending: 0,
Active: 1,
Defeated: 2,
Timelocked: 3,
AwaitingExecution: 4,
Executed: 5,
Expired: 6,
}
///// ACCOUNTS
let dore
let whale
let signerArray = []
let whales = []
//////////////////////////////////// TESTING & UTILITY
let randN = Math.floor(Math.random() * 1023)
let testseed = seedbase[randN].seed
let minewait = async (time) => {
await ethers.provider.send('evm_increaseTime', [time])
await ethers.provider.send('evm_mine', [])
}
let sendr = async (method, params) => {
return await ethers.provider.send(method, params)
}
let clog = (...x) => {
console.log(x)
}
let pE = (x) => {
return ethers.utils.parseEther(`${x}`)
}
let rand = (l, u) => {
return testcases.randomNumber(testseed, l, u)
}
let snapshotIdArray = []
///////////////////////////////////////////////////////////////////////////7
before(async function () {
signerArray = await ethers.getSigners()
dore = signerArray[0]
MockProposalFactory = await ethers.getContractFactory('MockProposal')
GovernanceContract = await ethers.getContractAt('GovernanceGasUpgrade', proxy_address)
TornToken = await ethers.getContractAt(
'@openzeppelin/contracts/token/ERC20/IERC20.sol:IERC20',
'0x77777FeDdddFfC19Ff86DB637967013e6C6A116C',
)
quorumVotes = await GovernanceContract.QUORUM_VOTES()
})
describe('#imitation block', () => {
it('Should successfully imitate tornado multisig', async function () {
await sendr('hardhat_impersonateAccount', ['0xb04E030140b30C27bcdfaafFFA98C57d80eDa7B4'])
tornadoMultisig = await ethers.getSigner('0xb04E030140b30C27bcdfaafFFA98C57d80eDa7B4')
})
it('Should successfully imitate whale', async function () {
await sendr('hardhat_impersonateAccount', ['0xA2b2fBCaC668d86265C45f62dA80aAf3Fd1dEde3'])
whale = await ethers.getSigner('0xA2b2fBCaC668d86265C45f62dA80aAf3Fd1dEde3')
GovernanceContract = await GovernanceContract.connect(whale)
let balance = await TornToken.balanceOf(whale.address)
TornToken = await TornToken.connect(whale)
await TornToken.approve(GovernanceContract.address, ethers.utils.parseEther('8000000000'))
await expect(GovernanceContract.lockWithApproval(balance)).to.not.be.reverted
expect((await GovernanceContract.lockedBalance(whale.address)).toString()).to.equal(balance.toString())
snapshotIdArray[0] = await sendr('evm_snapshot', [])
})
})
describe('#mock rewards + proposal distribution with multiple accounts', () => {
let addrArray = []
let signerArmy = []
let delegatedSignerArmy = []
let votingAddressArray = []
const numberOfVoters = 80
const numberOfDelegators = 30
it('Should create empty address array', () => {
for (let i = 0; i < 10; i++) {
votingAddressArray[i] = new Array(numberOfDelegators / 10 + 1)
}
})
it('Should impersonate and fund 80 accounts', async function () {
////////// WRITE WHALE ADDRESSES AND PREPARE FOR TRANSFERS
addrArray = [
'0x6cC5F688a315f3dC28A7781717a9A798a59fDA7b',
'0xF977814e90dA44bFA03b6295A0616a897441aceC',
'0xA2b2fBCaC668d86265C45f62dA80aAf3Fd1dEde3',
'0x055AD5E56c11c0eF55818155c69ed9BA2f4b3e90',
]
for (let i = 0; i < 4; i++) {
await sendr('hardhat_impersonateAccount', [addrArray[i]])
whales[i] = await ethers.getSigner(addrArray[i])
}
for (let i = 1; i < 4; i++) {
//last test really unnecessary
const torn = await TornToken.connect(whales[i])
const whaleBalance = await torn.balanceOf(whales[i].address)
await torn.approve(addrArray[0], whaleBalance)
await expect(() => torn.transfer(addrArray[0], whaleBalance)).to.changeTokenBalance(
torn,
whales[0],
whaleBalance,
)
}
const whale0Balance = await TornToken.balanceOf(whales[0].address)
const toTransfer = whale0Balance.sub(pE(10000)).div(numberOfVoters * 3)
let torn0 = await TornToken.connect(whales[0])
const oldBalance = await TornToken.balanceOf(await GovernanceContract.userVault())
let lockedSum = BigNumber.from(0)
////////// TRANSFER TO 50 ACCOUNTS + DELEGATION TO 10
for (let i = 0; i < numberOfVoters; i++) {
/// PREPARE ACCOUNTS
const accAddress = accountList[i + 7].checksumAddress
await sendr('hardhat_impersonateAccount', [accAddress])
signerArmy[i] = await ethers.getSigner(accAddress)
const tx = { to: signerArmy[i].address, value: pE(1) }
await signerArray[0].sendTransaction(tx)
/// FILL WITH GAS FOR LATER
await expect(() => torn0.transfer(signerArmy[i].address, toTransfer)).to.changeTokenBalance(
torn0,
signerArmy[i],
toTransfer,
)
let torn = await torn0.connect(signerArmy[i])
/// APPROVE TO GOVERNANCE FOR LOCK
await expect(torn.approve(GovernanceContract.address, toTransfer)).to.not.be.reverted
const gov = await GovernanceContract.connect(signerArmy[i])
///// LOCK
if (i > numberOfVoters / 2) {
await expect(() => gov.lockWithApproval(toTransfer.div(i))).to.changeTokenBalance(
torn,
signerArmy[i],
BigNumber.from(0).sub(toTransfer.div(i)),
)
lockedSum = lockedSum.add(toTransfer.div(i))
} else {
await expect(() => gov.lockWithApproval(toTransfer)).to.changeTokenBalance(
torn,
signerArmy[i],
BigNumber.from(0).sub(toTransfer),
)
lockedSum = lockedSum.add(toTransfer)
}
if (i > numberOfVoters - numberOfDelegators - 1) {
delegatedSignerArmy[i - (numberOfVoters - numberOfDelegators)] = signerArmy[i]
}
if (i < 10) {
votingAddressArray[i][0] = signerArmy[i].address
}
const restBalance = await torn.balanceOf(signerArmy[i].address)
await torn.transfer(whale.address, restBalance)
}
for (let i = 0; i < numberOfDelegators; i++) {
const gov = await GovernanceContract.connect(delegatedSignerArmy[i])
/// DELEGATE TO 10 FIRST SIGNERS
await expect(gov.delegate(signerArmy[i % 10].address)).to.emit(gov, 'Delegated')
votingAddressArray[i % 10][Math.floor(i / 10) + 1] = delegatedSignerArmy[i].address
}
const TornVault = await GovernanceContract.userVault()
expect(await TornToken.balanceOf(TornVault)).to.equal(lockedSum.add(oldBalance))
const gov = await GovernanceContract.connect(whales[0])
await expect(torn0.approve(GovernanceContract.address, pE(10000))).to.not.be.reverted
await expect(() => gov.lockWithApproval(toTransfer)).to.changeTokenBalance(
torn0,
whales[0],
BigNumber.from(0).sub(toTransfer),
)
snapshotIdArray[1] = await sendr('evm_snapshot', [])
})
it('Test multiple accounts proposal', async function () {
let checkIfQuorumFulfilled = async function (proposalId) {
const proposalData = await GovernanceContract.proposals(proposalId)
const allVotes = proposalData[4].add(proposalData[5])
return allVotes.gte(quorumVotes)
}
const ProposalContract = await MockProposalFactory.deploy()
clog(
'Torn balance of governance contract: ',
(await TornToken.balanceOf(GovernanceContract.address)).toString(),
)
////////////// STANDARD PROPOSAL ARGS TEST //////////////////////
let response, id, state
;[response, id, state] = await propose([whales[0], ProposalContract, 'LotteryUpgrade'])
const { events } = await response.wait()
const args = events.find(({ event }) => event == 'ProposalCreated').args
expect(args.id).to.be.equal(id)
expect(args.target).to.be.equal(ProposalContract.address)
expect(args.description).to.be.equal('LotteryUpgrade')
expect(state).to.be.equal(ProposalState.Pending)
////////////////////////INCREMENT TO VOTING TIME////////////////////////
await minewait((await GovernanceContract.VOTING_DELAY()).add(1).toNumber())
/////////////////// PREPARE MULTISIG AND COMPENSATIONS
let multiGov = await GovernanceContract.connect(tornadoMultisig)
await dore.sendTransaction({ to: tornadoMultisig.address, value: pE(1) })
await expect(multiGov.setGasCompensations(pE(500))).to.not.be.reverted
///////////////////////////// VOTE ////////////////////////////
const overrides = {
gasPrice: BigNumber.from(5),
}
let signerArmyBalanceInitial = []
let signerArmyBalanceDiff = []
let gasUsedArray = []
snapshotIdArray[2] = await sendr('evm_snapshot', [])
for (let i = 0; i < 10; i++) {
let gov = await GovernanceContract.connect(signerArmy[i])
let randN = rand(i * 5, i * 6)
randN = randN % 2
let response
signerArmyBalanceInitial[i] = await signerArmy[i].getBalance()
if (randN > 0) {
response = await gov.castDelegatedVote(votingAddressArray[i], id, true, overrides)
} else {
response = await gov.castDelegatedVote(votingAddressArray[i], id, false, overrides)
}
signerArmyBalanceDiff[i] = !(await checkIfQuorumFulfilled(id))
? signerArmyBalanceInitial[i].sub(await signerArmy[i].getBalance())
: signerArmyBalanceDiff[i - 1]
const receipt = await response.wait()
gasUsedArray[i] = receipt.cumulativeGasUsed
}
for (let i = 10; i < numberOfVoters - numberOfDelegators; i++) {
let gov = await GovernanceContract.connect(signerArmy[i])
let randN = rand(i * 5, i * 6)
randN = randN % 2
let response
signerArmyBalanceInitial[i] = await signerArmy[i].getBalance()
if (randN > 0) {
response = await gov.castVote(id, true, overrides)
} else {
response = await gov.castVote(id, false, overrides)
}
signerArmyBalanceDiff[i] = !(await checkIfQuorumFulfilled(id))
? signerArmyBalanceInitial[i].sub(await signerArmy[i].getBalance())
: signerArmyBalanceDiff[i - 1]
const receipt = await response.wait()
gasUsedArray[i] = receipt.cumulativeGasUsed
}
//////////////////////////////// GET STATE ///////////////////////////////
state = await GovernanceContract.state(id)
expect(state).to.be.equal(ProposalState.Active)
///////////////////////////// VOTER INFO ///////////////////////////////////
// (uncomment for more data)
/*
for (i = 0; i < numberOfVoters; i+=5) {
const j = BigNumber.from(i);
console.log(
`Voter ${i} sqrt: `,
((await GovernanceLottery.lotteryUserData(id,j))[0]).toString(),
`Voter ${i+1} sqrt: `,
((await GovernanceLottery.lotteryUserData(id,j.add(1)))[0]).toString(),
`Voter ${i+2} sqrt: `,
((await GovernanceLottery.lotteryUserData(id,j.add(2)))[0]).toString(),
`Voter ${i+3} sqrt: `,
((await GovernanceLottery.lotteryUserData(id,j.add(3)))[0]).toString(),
`Voter ${i+4} sqrt: `,
((await GovernanceLottery.lotteryUserData(id,j.add(4)))[0]).toString(),
"\n",
)
}
for (i = 0; i < numberOfVoters; i+=5) {
console.log(
`Voter ${i} ether used: `,
gasUsedArray[i],
`Voter ${i+1} ether used: `,
gasUsedArray[i+1],
`Voter ${i+2} ether used: `,
gasUsedArray[i+2],
`Voter ${i+3} ether used: `,
gasUsedArray[i+3],
`Voter ${i+4} ether used: `,
gasUsedArray[i+4],
"\n",
)
}
*/
await sendr('evm_revert', [snapshotIdArray[2]])
///////////////////////////////// VOTE WITHOUT COMPENSATION //////////////////////////////////////
let gasUsedWithoutCompensation = []
await multiGov.setGasCompensations(pE(100000))
for (let i = 0; i < 10; i++) {
let gov = await GovernanceContract.connect(signerArmy[i])
let randN = rand(i * 5, i * 6)
randN = randN % 2
let response
if (randN > 0) {
response = await gov.castDelegatedVote(votingAddressArray[i], id, true, overrides)
} else {
response = await gov.castDelegatedVote(votingAddressArray[i], id, false, overrides)
}
const receipt = await response.wait()
gasUsedWithoutCompensation[i] = receipt.cumulativeGasUsed
}
for (let i = 10; i < numberOfVoters - numberOfDelegators; i++) {
let gov = await GovernanceContract.connect(signerArmy[i])
let randN = rand(i * 5, i * 6)
randN = randN % 2
let response
if (randN > 0) {
response = await gov.castVote(id, true, overrides)
} else {
response = await gov.castVote(id, false, overrides)
}
const receipt = await response.wait()
gasUsedWithoutCompensation[i] = receipt.cumulativeGasUsed
}
await multiGov.setGasCompensations(pE(100))
//////////////////////////////// GET STATE ///////////////////////////////
state = await GovernanceContract.state(id)
expect(state).to.be.equal(ProposalState.Active)
///////////////////////////// VOTING GAS INFO ///////////////////////////////////
let gasUsedSumNoComp = BigNumber.from(0)
let gasUsedSum = BigNumber.from(0)
let gasSumDiff = BigNumber.from(0)
let gasUsedSumNoCompDel = BigNumber.from(0)
let gasUsedSumDel = BigNumber.from(0)
let gasSumDiffDel = BigNumber.from(0)
for (let i = 0; i < 10; i++) {
gasUsedSumDel = gasUsedSumDel.add(gasUsedArray[i])
gasUsedSumNoCompDel = gasUsedSumNoCompDel.add(gasUsedWithoutCompensation[i])
gasSumDiffDel = gasSumDiffDel.add(signerArmyBalanceDiff[i])
}
for (let i = 10; i < numberOfVoters - numberOfDelegators; i++) {
gasUsedSum = gasUsedSum.add(gasUsedArray[i])
gasUsedSumNoComp = gasUsedSumNoComp.add(gasUsedWithoutCompensation[i])
gasSumDiff = gasSumDiff.add(signerArmyBalanceDiff[i])
}
const gasUsedAverageNoCompDel = gasUsedSumNoCompDel.div(10)
const gasUsedAverageDel = gasUsedSumDel.div(10)
const gasSumAverageDiffDel = gasSumDiffDel.div(10)
const gasUsedAverageNoComp = gasUsedSumNoComp.div(numberOfVoters - 10)
const gasUsedAverage = gasUsedSum.div(numberOfVoters - 10)
const gasSumAverageDiff = gasSumDiff.div(numberOfVoters - 10)
console.log(
'\n',
'----------------------------CAST VOTE INFO------------------------',
'\n',
'Gas use average: ',
gasUsedAverage.toString(),
'\n',
'Gas use without compensation average: ',
gasUsedAverageNoComp.toString(),
'\n',
'Gas diff average: ',
gasSumAverageDiff.toString(),
'\n',
'Gas compensated in average: ',
gasUsedAverage.sub(gasSumAverageDiff).toString(),
'\n',
'--------------------------------------------------------------------',
'\n',
)
console.log(
'\n',
'----------------------------CAST DELEGATED VOTE INFO------------------------',
'\n',
'Gas use average: ',
gasUsedAverageDel.toString(),
'\n',
'Gas use without compensation average: ',
gasUsedAverageNoCompDel.toString(),
'\n',
'Gas diff average: ',
gasSumAverageDiffDel.toString(),
'\n',
'Gas compensated in average: ',
gasUsedAverageDel.sub(gasSumAverageDiffDel).toString(),
'\n',
'--------------------------------------------------------------------',
'\n',
)
/////////////////////////////// INCREMENT AGAIN //////////////////////////////////
await minewait(
(
await GovernanceContract.VOTING_PERIOD()
)
.add(await GovernanceContract.EXECUTION_DELAY())
.add(10000)
.toNumber(),
)
////////////// EXECUTE
if (BigNumber.from(await GovernanceContract.state(id)).eq(ProposalState.Defeated)) {
await expect(GovernanceContract.execute(id)).to.be.reverted
} else {
await expect(GovernanceContract.execute(id)).to.not.be.reverted
}
})
})
after(async function () {
await ethers.provider.send('hardhat_reset', [
{
forking: {
jsonRpcUrl: `https://eth-mainnet.alchemyapi.io/v2/${process.env.ALCHEMY_KEY}`,
blockNumber: process.env.use_latest_block == 'true' ? undefined : config.forkBlockNumber,
},
},
])
})
})

View File

@ -0,0 +1,71 @@
const { ethers } = require('hardhat')
const { expect } = require('chai')
const config = require('../../config')
const { getSignerFromAddress, takeSnapshot, revertSnapshot } = require('../utils')
describe('V3 governance tests', () => {
let snapshotId
//// CONTRACTS
let torn = config.TORN
let gov
//// IMPERSONATED ACCOUNTS
let tornWhale
//// HELPER FN
let getToken = async (tokenAddress) => {
return await ethers.getContractAt('@openzeppelin/contracts/token/ERC20/ERC20.sol:ERC20', tokenAddress)
}
before(async function () {
tornWhale = await getSignerFromAddress(config.tornWhale)
gov = (await ethers.getContractAt('GovernanceStakingUpgrade', config.governance)).connect(tornWhale)
snapshotId = await takeSnapshot()
})
describe('#lock functionality', () => {
it('should be able to lock/unlock torn in governance', async () => {
const [sender] = await ethers.getSigners()
const value = ethers.utils.parseEther('1000')
const tornToken = await (await getToken(torn)).connect(tornWhale)
await tornToken.transfer(sender.address, value)
await tornToken.connect(sender).approve(gov.address, value)
const ethBalanceBeforeLock = await ethers.provider.getBalance(sender.address)
const tokenBalanceBeforeLock = await tornToken.balanceOf(sender.address)
let tx = await gov.connect(sender).lockWithApproval(value)
let receipt = await tx.wait()
let txFee = receipt.cumulativeGasUsed.mul(receipt.effectiveGasPrice)
const ethBalanceAfterLock = await ethers.provider.getBalance(sender.address)
const tokenBalanceAfterLock = await tornToken.balanceOf(sender.address)
expect(ethBalanceAfterLock).to.be.equal(ethBalanceBeforeLock.sub(txFee))
expect(tokenBalanceAfterLock).to.be.equal(tokenBalanceBeforeLock.sub(value))
const lockedBalanceAfterLock = await gov.lockedBalance(sender.address)
expect(lockedBalanceAfterLock).to.be.equal(value)
tx = await gov.connect(sender).unlock(value)
receipt = await tx.wait()
txFee = receipt.cumulativeGasUsed.mul(receipt.effectiveGasPrice)
const ethBalanceAfterUnlock = await ethers.provider.getBalance(sender.address)
const tokenBalanceAfterUnlock = await tornToken.balanceOf(sender.address)
expect(ethBalanceAfterUnlock).to.be.equal(ethBalanceAfterLock.sub(txFee))
expect(tokenBalanceAfterUnlock).to.be.equal(tokenBalanceBeforeLock)
const lockedBalanceAfterUnlock = await gov.lockedBalance(sender.address)
expect(lockedBalanceAfterUnlock).to.be.equal(0)
})
})
afterEach(async () => {
await revertSnapshot(snapshotId)
snapshotId = await takeSnapshot()
})
})

View File

@ -1,35 +0,0 @@
module.exports = {
networks: {
// development: {
// // host: '127.0.0.1', // Localhost (default: none)
// // port: 8545, // Standard Ethereum port (default: none)
// network_id: '*', // Any network (default: none)
// accounts: 20,
// },
coverage: {
host: 'localhost',
network_id: '*',
port: 8554, // <-- If you change this, also set the port option in .solcover.js.
gas: 0xfffffffffff, // <-- Use this high gas value
gasPrice: 0x01, // <-- Use this low gas price
},
},
mocha: {
// timeout: 100000
},
compilers: {
solc: {
version: '0.6.12',
docker: false,
settings: {
optimizer: {
enabled: true,
runs: 200,
},
// evmVersion: "byzantium"
},
},
},
}

9199
yarn.lock

File diff suppressed because it is too large Load Diff