Merge pull request #44 from code-423n4/govUp

Deploy new governor contract, bump hardhat + etherscan verification

Author: HickupHH3

contracts/ArenaGovernor.sol

@@ -4,23 +4,28 @@ pragma solidity 0.8.10;
 import "@openzeppelin/contracts/governance/Governor.sol";
 import "@openzeppelin/contracts/governance/extensions/GovernorSettings.sol";
 import "@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol";
+import "@openzeppelin/contracts/governance/extensions/GovernorPreventLateQuorum.sol";
 import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol";
 import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol";
 
 contract ArenaGovernor is
     Governor,
     GovernorSettings,
     GovernorCompatibilityBravo,
+    GovernorPreventLateQuorum,
     GovernorVotes,
     GovernorTimelockControl
 {
-    constructor(ERC20Votes _token, TimelockController _timelock)
+    constructor(IVotes _token, TimelockController _timelock)
         Governor("ArenaGovernor")
         GovernorSettings(
             1, /* 1 block */
-            302400, /* 1 week */
+            216_000, /* 5 days */
             50_000e18 /* minimum proposal threshold of 50_000 tokens */
         )
+        GovernorPreventLateQuorum(
+            129_600 /* 3 days */
+        )
         GovernorVotes(_token)
         GovernorTimelockControl(_timelock)
     {}
@@ -57,6 +62,15 @@ contract ArenaGovernor is
         return super.state(proposalId);
     }
 
+    function proposalDeadline(uint256 proposalId)
+        public
+        view
+        override(Governor, IGovernor, GovernorPreventLateQuorum)
+        returns (uint256)
+    {
+        return super.proposalDeadline(proposalId);
+    }
+
     function propose(
         address[] memory targets,
         uint256[] memory values,
@@ -94,6 +108,15 @@ contract ArenaGovernor is
         return super._cancel(targets, values, calldatas, descriptionHash);
     }
 
+    function _castVote(
+        uint256 proposalId,
+        address account,
+        uint8 support,
+        string memory reason
+    ) internal override(Governor, GovernorPreventLateQuorum) returns (uint256) {
+        return super._castVote(proposalId, account, support, reason);
+    }
+
     function _executor()
         internal
         view

deployments/polygonAddresses.json

@@ -3,6 +3,7 @@
   "token": "0x6847D3A4c80a82e1fb26f1fC6F09F3Ad5BEB5222",
   "tokenLock": "0xB17828789280C77C17B02fc8E6F20Ddc5721f2C2",
   "timelock": "0xdFB26381aFBc37f0Fae4A77D385b91B90347aA12",
-  "governor": "0xc6eaDcC36aFcf1C430962506ad79145aD5140E58",
+  "governorV1": "0xc6eaDcC36aFcf1C430962506ad79145aD5140E58",
+  "governor": "0x4Db7E521942BDA8b1fB1B310280135ba4B9c2bee",
   "tokenSale": "0xD0e7d5a2220e32914540D97A6D0548658050180b"
 }

package.json

@@ -24,14 +24,14 @@
   },
   "homepage": "https://github.com/code-423n4/genesis#readme",
   "dependencies": {
-    "hardhat": "2.8.3",
+    "hardhat": "2.9.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.0.4",
-    "@nomiclabs/hardhat-etherscan": "3.0.0",
+    "@nomiclabs/hardhat-etherscan": "3.0.3",
     "@nomiclabs/hardhat-waffle": "^2.0.0",
-    "@openzeppelin/contracts": "^4.4.0",
+    "@openzeppelin/contracts": "^4.5.0",
     "@typechain/ethers-v5": "^9.0.0",
     "@typechain/hardhat": "^4.0.0",
     "@types/chai": "^4.2.21",

shared/Constants.ts

@@ -9,4 +9,4 @@ export const MAX_UINT = constants.MaxUint256;
 export const ONE_HOUR = 60 * 60;
 export const ONE_DAY = 24 * ONE_HOUR;
 export const ONE_YEAR = 365 * ONE_DAY;
-export const POLYGON_AVERAGE_BLOCK_TIME = 2.2;
+export const POLYGON_AVERAGE_BLOCK_TIME = '0x2';

shared/Forking.ts

@@ -13,6 +13,7 @@ import {
 } from '../typechain';
 
 export type DeployedContracts = {
+  governorV1: ArenaGovernor,
   governor: ArenaGovernor;
   timeLock: TimelockController;
   tokenLock: TokenLock;
@@ -23,12 +24,14 @@ export const getPolygonContracts = (signer: Signer): DeployedContracts => {
   if (!fs.existsSync(deploymentFilePath)) throw new Error(`File '${path.resolve(deploymentFilePath)}' does not exist.`);
 
   const contents = fs.readFileSync(deploymentFilePath, `utf8`);
+  let governorV1Address;
   let governorAddress;
   let arenaAddress;
   let timelockAddress;
   let tokenLockAddress;
   try {
     ({
+      governorV1: governorV1Address,
       governor: governorAddress,
       token: arenaAddress,
       tokenLock: tokenLockAddress,
@@ -43,6 +46,7 @@ export const getPolygonContracts = (signer: Signer): DeployedContracts => {
   if (!tokenLockAddress) throw new Error(`Deployment file did not include tokenLock address '${deploymentFilePath}'.`);
 
   return {
+    governorV1: ArenaGovernor__factory.connect(governorV1Address, signer),
     governor: ArenaGovernor__factory.connect(governorAddress, signer),
     arenaToken: ArenaToken__factory.connect(arenaAddress, signer),
     timeLock: TimelockController__factory.connect(timelockAddress, signer),

shared/Governance.ts

@@ -2,7 +2,6 @@ import {Signer} from 'ethers';
 import {ethers} from 'hardhat';
 import {impersonateAccountWithFunds, stopImpersonateAccount} from './AccountManipulation';
 import {increaseNextBlockTime, setNextBlockNumber} from './TimeManipulation';
-import {POLYGON_AVERAGE_BLOCK_TIME} from './Constants';
 import {DeployedContracts} from './Forking';
 import {getABIFromPolygonscan} from './Polygonscan';
 
@@ -20,21 +19,14 @@ export const createAndExecuteProposal = async ({
   values: string[];
   calldatas: string[];
 } & DeployedContracts) => {
-  // 0. set voting delay & duration to 2 blocks, otherwise need to simulate 302,400 blocks
   const timeLockSigner = await impersonateAccountWithFunds(timeLock.address);
-  let originalVotingDelay = await governor.votingDelay();
-  let originalVotingPeriod = await governor.votingPeriod();
-  console.log('setting voting delay and duration to 2 blocks...');
-  await governor.connect(timeLockSigner).setVotingDelay(`2`);
-  await governor.connect(timeLockSigner).setVotingPeriod(`2`);
 
   // 1. borrow some treasury tokens to user as we need signer with min. proposalThreshold tokens to propose
   const quorumAmount = await governor.quorumVotes();
   // careful, this sends ETH to timelock which might break real-world simulation for proposals involving Timelock ETH
   console.log('transferring tokens to user for proposal creation...');
   await arenaToken.connect(timeLockSigner).transfer(await user.getAddress(), quorumAmount);
   await arenaToken.connect(user).delegate(await user.getAddress());
-  const descriptionHash = ethers.utils.keccak256([]); // keccak(``)
   console.log('creating proposal...');
   let tx = await governor.connect(user)['propose(address[],uint256[],bytes[],string)'](targets, values, calldatas, ``);
   let {events} = await tx.wait();
@@ -43,9 +35,8 @@ export const createAndExecuteProposal = async ({
 
   // 2. advance time past voting delay and vote on proposal
   const voteStartBlock = await governor.proposalSnapshot(proposalId);
-  // simulate elapsed time close to original voting delay
-  await increaseNextBlockTime(Math.floor(POLYGON_AVERAGE_BLOCK_TIME * originalVotingDelay.toNumber()));
-  await setNextBlockNumber(voteStartBlock.toNumber() + 1); // is a blocknumber which fits in Number
+  // simulate to voteStartBlock
+  await setNextBlockNumber(voteStartBlock.toNumber());
   console.log('casting vote...');
   tx = await governor.connect(user)['castVote'](proposalId, `1`);
 
@@ -54,17 +45,12 @@ export const createAndExecuteProposal = async ({
 
   // 4. advance time past voting period and queue proposal calls to Timelock via GovernorTimelockControl.queue
   const voteEndBlock = await governor.proposalDeadline(proposalId);
-  // simulate elapsed time close to original voting delay
-  await increaseNextBlockTime(Math.floor(POLYGON_AVERAGE_BLOCK_TIME * originalVotingPeriod.toNumber()));
-  await setNextBlockNumber(voteEndBlock.toNumber() + 1); // is a blocknumber which fits in Number
+  // simulate to voteEndBlock + 1
+  await setNextBlockNumber(voteEndBlock.toNumber() + 1);
   console.log('queueing proposal...');
   tx = await governor.connect(user)['queue(uint256)'](proposalId);
   await tx.wait();
 
-  // can revert Governor changes now
-  console.log('resetting voting delay and period...');
-  await governor.connect(timeLockSigner).setVotingDelay(originalVotingDelay);
-  await governor.connect(timeLockSigner).setVotingPeriod(originalVotingPeriod);
   await stopImpersonateAccount(timeLock.address);
 
   // 5. advance time past timelock delay and then execute

shared/TimeManipulation.ts

@@ -16,17 +16,19 @@ export const increaseNextBlockTime = async (seconds: number) => {
 
 export const setNextBlockNumber = async (blockNumber: number) => {
   let currentBlock = await getHeadBlockNumber();
-  for (; currentBlock < blockNumber; currentBlock++) {
-    await hre.network.provider.send('evm_increaseTime', [Math.round(POLYGON_AVERAGE_BLOCK_TIME)]);
-    await hre.network.provider.send('evm_mine', []);
-  }
+  await hre.network.provider.send("hardhat_mine", ['0x' + (blockNumber - currentBlock).toString(16), POLYGON_AVERAGE_BLOCK_TIME]);
 };
 
 export const mineBlockAt = async (timestamp: number) => {
   await hre.network.provider.send('evm_setNextBlockTimestamp', [timestamp]);
   return hre.network.provider.send('evm_mine', []);
 };
 
+// default 2s per block
+export const mineBlocks = async (numBlocks: string, interval: string = POLYGON_AVERAGE_BLOCK_TIME) => {
+  await hre.network.provider.send("hardhat_mine", [numBlocks, interval]);
+}
+
 export const resetNetwork = async () => {
   return hre.network.provider.request({
     method: 'hardhat_reset',

test/GovernanceSim.spec.ts

@@ -10,8 +10,8 @@ chai.use(solidity);
 // can simulate poylgon mainnet governance proposals here, enable fork object in hardhat.config.ts
 describe.skip('Governance - Polygon mainnet proposal simulations', async () => {
   const [user] = waffle.provider.getWallets();
-  const deployment = getPolygonContracts(user);
-  const {arenaToken, timeLock} = deployment;
+  let deployment = getPolygonContracts(user);
+  const {governorV1, governor, arenaToken, timeLock} = deployment;
 
   it('should allow governance to move tokens in timeLock contract', async () => {
     const treasuryAmount = await arenaToken.balanceOf(timeLock.address);
@@ -24,4 +24,34 @@ describe.skip('Governance - Polygon mainnet proposal simulations', async () => {
 
     expect(await arenaToken.balanceOf(timeLock.address)).to.eq(ZERO);
   });
+
+  it('should migrate to new governor', async () => {
+    // set to current existing governor for proposal creation
+    deployment.governor = governorV1;
+    const PROPOSER_ROLE = '0xb09aa5aeb3702cfd50b6b62bc4532604938f21248a27a1d5ca736082b6819cc1';
+    let targets: string[] = [timeLock.address, timeLock.address];
+    let values: string[] = [`0`, `0`];
+    let calldatas: string[] = [
+      timeLock.interface.encodeFunctionData('grantRole', [PROPOSER_ROLE, governor.address]),
+      timeLock.interface.encodeFunctionData('revokeRole', [PROPOSER_ROLE, governorV1.address]),
+    ];
+    await createAndExecuteProposal({targets, values, calldatas, user, ...deployment});
+
+    const treasuryAmount = await arenaToken.balanceOf(timeLock.address);
+    targets = [arenaToken.address];
+    values = [`0`];
+    calldatas = [arenaToken.interface.encodeFunctionData('transfer', [user.address, treasuryAmount])];
+
+    // attempt to move funds through old governor, will fail
+    try {
+      await createAndExecuteProposal({targets, values, calldatas, user, ...deployment});
+    } catch (e) {
+      console.log(e);
+    }
+
+    // attempt to move funds through new governor, should be successful
+    deployment.governor = governor;
+    await createAndExecuteProposal({targets, values, calldatas, user, ...deployment});
+    expect(await arenaToken.balanceOf(timeLock.address)).to.eq(ZERO);
+  });
 });

test/RevokableTokenLock.spec.ts

@@ -1,7 +1,7 @@
 import {expect} from 'chai';
 import {BigNumber} from 'ethers';
 import {ethers, waffle} from 'hardhat';
-import {IERC20, RevokableTokenLock} from '../typechain';
+import {TestERC20, RevokableTokenLock} from '../typechain';
 import {ZERO_ADDRESS, ONE_HOUR} from '../shared/Constants';
 import {setNextBlockTimeStamp, mineBlockAt} from '../shared/TimeManipulation';
 

test/TokenLock.spec.ts

@@ -1,7 +1,7 @@
 import {expect} from 'chai';
 import chai from 'chai';
-import hre, {ethers, waffle} from 'hardhat';
-import {IERC20, TokenLock} from '../typechain';
+import {ethers, waffle} from 'hardhat';
+import {TestERC20, TokenLock} from '../typechain';
 import {MAX_UINT, ONE, ONE_DAY, ONE_YEAR, ONE_18, ZERO, ZERO_ADDRESS} from '../shared/Constants';
 import {mineBlockAt, resetNetwork, setNextBlockTimeStamp} from '../shared/TimeManipulation';
 
@@ -122,12 +122,13 @@ describe('TokenLock', async () => {
     });
 
     it('should revert if lock() is called without sufficient balance or allowance', async () => {
+      await expect(tokenLock.connect(admin).lock(user.address, ONE)).to.be.revertedWith(
+        'ERC20: insufficient allowance'
+      );
+      await token.connect(user).approve(tokenLock.address, ONE);
       await expect(tokenLock.connect(user).lock(user.address, ONE)).to.be.revertedWith(
         'ERC20: transfer amount exceeds balance'
       );
-      await expect(tokenLock.connect(admin).lock(user.address, ONE)).to.be.revertedWith(
-        'ERC20: transfer amount exceeds allowance'
-      );
     });
 
     describe('successful lock', async () => {

test/TokenSale.spec.ts

@@ -2,7 +2,7 @@ import {expect} from 'chai';
 import chai from 'chai';
 import {ethers, waffle} from 'hardhat';
 import {BigNumber as BN} from 'ethers';
-import {IERC20, RevokableTokenLock, TokenSale} from '../typechain';
+import {TestERC20, RevokableTokenLock, TokenSale} from '../typechain';
 import {ONE_DAY, ONE_18, MAX_UINT, ONE_YEAR} from '../shared/Constants';
 import {setNextBlockTimeStamp, resetNetwork} from '../shared/TimeManipulation';