const { expectEvent, time } = require('@openzeppelin/test-helpers'); const { expect } = require('chai'); const Enums = require('../../helpers/enums'); const { GovernorHelper, proposalStatesToBitMap } = require('../../helpers/governance'); const { clock } = require('../../helpers/time'); const { expectRevertCustomError } = require('../../helpers/customError'); const Governor = artifacts.require('$GovernorMock'); const CallReceiver = artifacts.require('CallReceiverMock'); const TOKENS = [ { Token: artifacts.require('$ERC20Votes'), mode: 'blocknumber' }, { Token: artifacts.require('$ERC20VotesTimestampMock'), mode: 'timestamp' }, ]; contract('GovernorVotesQuorumFraction', function (accounts) { const [owner, voter1, voter2, voter3, voter4] = accounts; const name = 'OZ-Governor'; const version = '1'; const tokenName = 'MockToken'; const tokenSymbol = 'MTKN'; const tokenSupply = web3.utils.toBN(web3.utils.toWei('100')); const ratio = web3.utils.toBN(8); // percents const newRatio = web3.utils.toBN(6); // percents const votingDelay = web3.utils.toBN(4); const votingPeriod = web3.utils.toBN(16); const value = web3.utils.toWei('1'); for (const { mode, Token } of TOKENS) { describe(`using ${Token._json.contractName}`, function () { beforeEach(async function () { this.owner = owner; this.token = await Token.new(tokenName, tokenSymbol, tokenName, version); this.mock = await Governor.new(name, votingDelay, votingPeriod, 0, this.token.address, ratio); this.receiver = await CallReceiver.new(); this.helper = new GovernorHelper(this.mock, mode); await web3.eth.sendTransaction({ from: owner, to: this.mock.address, value }); await this.token.$_mint(owner, tokenSupply); await this.helper.delegate({ token: this.token, to: voter1, value: web3.utils.toWei('10') }, { from: owner }); await this.helper.delegate({ token: this.token, to: voter2, value: web3.utils.toWei('7') }, { from: owner }); await this.helper.delegate({ token: this.token, to: voter3, value: web3.utils.toWei('5') }, { from: owner }); await this.helper.delegate({ token: this.token, to: voter4, value: web3.utils.toWei('2') }, { from: owner }); // default proposal this.proposal = this.helper.setProposal( [ { target: this.receiver.address, value, data: this.receiver.contract.methods.mockFunction().encodeABI(), }, ], '', ); }); it('deployment check', async function () { expect(await this.mock.name()).to.be.equal(name); expect(await this.mock.token()).to.be.equal(this.token.address); expect(await this.mock.votingDelay()).to.be.bignumber.equal(votingDelay); expect(await this.mock.votingPeriod()).to.be.bignumber.equal(votingPeriod); expect(await this.mock.quorum(0)).to.be.bignumber.equal('0'); expect(await this.mock.quorumNumerator()).to.be.bignumber.equal(ratio); expect(await this.mock.quorumDenominator()).to.be.bignumber.equal('100'); expect(await clock[mode]().then(timepoint => this.mock.quorum(timepoint - 1))).to.be.bignumber.equal( tokenSupply.mul(ratio).divn(100), ); }); it('quroum reached', async function () { await this.helper.propose(); await this.helper.waitForSnapshot(); await this.helper.vote({ support: Enums.VoteType.For }, { from: voter1 }); await this.helper.waitForDeadline(); await this.helper.execute(); }); it('quroum not reached', async function () { await this.helper.propose(); await this.helper.waitForSnapshot(); await this.helper.vote({ support: Enums.VoteType.For }, { from: voter2 }); await this.helper.waitForDeadline(); await expectRevertCustomError(this.helper.execute(), 'GovernorUnexpectedProposalState', [ this.proposal.id, Enums.ProposalState.Defeated, proposalStatesToBitMap([Enums.ProposalState.Succeeded, Enums.ProposalState.Queued]), ]); }); describe('onlyGovernance updates', function () { it('updateQuorumNumerator is protected', async function () { await expectRevertCustomError( this.mock.updateQuorumNumerator(newRatio, { from: owner }), 'GovernorOnlyExecutor', [owner], ); }); it('can updateQuorumNumerator through governance', async function () { this.helper.setProposal( [ { target: this.mock.address, data: this.mock.contract.methods.updateQuorumNumerator(newRatio).encodeABI(), }, ], '', ); await this.helper.propose(); await this.helper.waitForSnapshot(); await this.helper.vote({ support: Enums.VoteType.For }, { from: voter1 }); await this.helper.waitForDeadline(); expectEvent(await this.helper.execute(), 'QuorumNumeratorUpdated', { oldQuorumNumerator: ratio, newQuorumNumerator: newRatio, }); expect(await this.mock.quorumNumerator()).to.be.bignumber.equal(newRatio); expect(await this.mock.quorumDenominator()).to.be.bignumber.equal('100'); // it takes one block for the new quorum to take effect expect(await clock[mode]().then(blockNumber => this.mock.quorum(blockNumber - 1))).to.be.bignumber.equal( tokenSupply.mul(ratio).divn(100), ); await time.advanceBlock(); expect(await clock[mode]().then(blockNumber => this.mock.quorum(blockNumber - 1))).to.be.bignumber.equal( tokenSupply.mul(newRatio).divn(100), ); }); it('cannot updateQuorumNumerator over the maximum', async function () { const quorumNumerator = 101; this.helper.setProposal( [ { target: this.mock.address, data: this.mock.contract.methods.updateQuorumNumerator(quorumNumerator).encodeABI(), }, ], '', ); await this.helper.propose(); await this.helper.waitForSnapshot(); await this.helper.vote({ support: Enums.VoteType.For }, { from: voter1 }); await this.helper.waitForDeadline(); const quorumDenominator = await this.mock.quorumDenominator(); await expectRevertCustomError(this.helper.execute(), 'GovernorInvalidQuorumFraction', [ quorumNumerator, quorumDenominator, ]); }); }); }); } });