/* eslint-disable */ const { BN, constants, expectEvent, expectRevert, time } = require('@openzeppelin/test-helpers'); const { expect } = require('chai'); const { MAX_UINT256, ZERO_ADDRESS } = constants; const { fromRpcSig } = require('ethereumjs-util'); const ethSigUtil = require('eth-sig-util'); const Wallet = require('ethereumjs-wallet').default; const ERC20VotesComp = artifacts.require('$ERC20VotesComp'); const { batchInBlock } = require('../../../helpers/txpool'); const { EIP712Domain, domainSeparator } = require('../../../helpers/eip712'); const { getChainId } = require('../../../helpers/chainid'); const Delegation = [ { name: 'delegatee', type: 'address' }, { name: 'nonce', type: 'uint256' }, { name: 'expiry', type: 'uint256' }, ]; contract('ERC20VotesComp', function (accounts) { const [holder, recipient, holderDelegatee, other1, other2] = accounts; const name = 'My Token'; const symbol = 'MTKN'; const version = '1'; const supply = new BN('10000000000000000000000000'); beforeEach(async function () { this.chainId = await getChainId(); this.token = await ERC20VotesComp.new(name, symbol, name); }); it('initial nonce is 0', async function () { expect(await this.token.nonces(holder)).to.be.bignumber.equal('0'); }); it('domain separator', async function () { expect(await this.token.DOMAIN_SEPARATOR()).to.equal( await domainSeparator({ name, version, chainId: this.chainId, verifyingContract: this.token.address }), ); }); it('minting restriction', async function () { const amount = new BN('2').pow(new BN('96')); await expectRevert(this.token.$_mint(holder, amount), 'ERC20Votes: total supply risks overflowing votes'); }); describe('set delegation', function () { describe('call', function () { it('delegation with balance', async function () { await this.token.$_mint(holder, supply); expect(await this.token.delegates(holder)).to.be.equal(ZERO_ADDRESS); const { receipt } = await this.token.delegate(holder, { from: holder }); expectEvent(receipt, 'DelegateChanged', { delegator: holder, fromDelegate: ZERO_ADDRESS, toDelegate: holder, }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: holder, previousBalance: '0', newBalance: supply, }); expect(await this.token.delegates(holder)).to.be.equal(holder); expect(await this.token.getCurrentVotes(holder)).to.be.bignumber.equal(supply); expect(await this.token.getPriorVotes(holder, receipt.blockNumber - 1)).to.be.bignumber.equal('0'); await time.advanceBlock(); expect(await this.token.getPriorVotes(holder, receipt.blockNumber)).to.be.bignumber.equal(supply); }); it('delegation without balance', async function () { expect(await this.token.delegates(holder)).to.be.equal(ZERO_ADDRESS); const { receipt } = await this.token.delegate(holder, { from: holder }); expectEvent(receipt, 'DelegateChanged', { delegator: holder, fromDelegate: ZERO_ADDRESS, toDelegate: holder, }); expectEvent.notEmitted(receipt, 'DelegateVotesChanged'); expect(await this.token.delegates(holder)).to.be.equal(holder); }); }); describe('with signature', function () { const delegator = Wallet.generate(); const delegatorAddress = web3.utils.toChecksumAddress(delegator.getAddressString()); const nonce = 0; const buildData = (chainId, verifyingContract, message) => ({ data: { primaryType: 'Delegation', types: { EIP712Domain, Delegation }, domain: { name, version, chainId, verifyingContract }, message, }, }); beforeEach(async function () { await this.token.$_mint(delegatorAddress, supply); }); it('accept signed delegation', async function () { const { v, r, s } = fromRpcSig( ethSigUtil.signTypedMessage( delegator.getPrivateKey(), buildData(this.chainId, this.token.address, { delegatee: delegatorAddress, nonce, expiry: MAX_UINT256, }), ), ); expect(await this.token.delegates(delegatorAddress)).to.be.equal(ZERO_ADDRESS); const { receipt } = await this.token.delegateBySig(delegatorAddress, nonce, MAX_UINT256, v, r, s); expectEvent(receipt, 'DelegateChanged', { delegator: delegatorAddress, fromDelegate: ZERO_ADDRESS, toDelegate: delegatorAddress, }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: delegatorAddress, previousBalance: '0', newBalance: supply, }); expect(await this.token.delegates(delegatorAddress)).to.be.equal(delegatorAddress); expect(await this.token.getCurrentVotes(delegatorAddress)).to.be.bignumber.equal(supply); expect(await this.token.getPriorVotes(delegatorAddress, receipt.blockNumber - 1)).to.be.bignumber.equal('0'); await time.advanceBlock(); expect(await this.token.getPriorVotes(delegatorAddress, receipt.blockNumber)).to.be.bignumber.equal(supply); }); it('rejects reused signature', async function () { const { v, r, s } = fromRpcSig( ethSigUtil.signTypedMessage( delegator.getPrivateKey(), buildData(this.chainId, this.token.address, { delegatee: delegatorAddress, nonce, expiry: MAX_UINT256, }), ), ); await this.token.delegateBySig(delegatorAddress, nonce, MAX_UINT256, v, r, s); await expectRevert( this.token.delegateBySig(delegatorAddress, nonce, MAX_UINT256, v, r, s), 'ERC20Votes: invalid nonce', ); }); it('rejects bad delegatee', async function () { const { v, r, s } = fromRpcSig( ethSigUtil.signTypedMessage( delegator.getPrivateKey(), buildData(this.chainId, this.token.address, { delegatee: delegatorAddress, nonce, expiry: MAX_UINT256, }), ), ); const receipt = await this.token.delegateBySig(holderDelegatee, nonce, MAX_UINT256, v, r, s); const { args } = receipt.logs.find(({ event }) => event == 'DelegateChanged'); expect(args.delegator).to.not.be.equal(delegatorAddress); expect(args.fromDelegate).to.be.equal(ZERO_ADDRESS); expect(args.toDelegate).to.be.equal(holderDelegatee); }); it('rejects bad nonce', async function () { const { v, r, s } = fromRpcSig( ethSigUtil.signTypedMessage( delegator.getPrivateKey(), buildData(this.chainId, this.token.address, { delegatee: delegatorAddress, nonce, expiry: MAX_UINT256, }), ), ); await expectRevert( this.token.delegateBySig(delegatorAddress, nonce + 1, MAX_UINT256, v, r, s), 'ERC20Votes: invalid nonce', ); }); it('rejects expired permit', async function () { const expiry = (await time.latest()) - time.duration.weeks(1); const { v, r, s } = fromRpcSig( ethSigUtil.signTypedMessage( delegator.getPrivateKey(), buildData(this.chainId, this.token.address, { delegatee: delegatorAddress, nonce, expiry, }), ), ); await expectRevert( this.token.delegateBySig(delegatorAddress, nonce, expiry, v, r, s), 'ERC20Votes: signature expired', ); }); }); }); describe('change delegation', function () { beforeEach(async function () { await this.token.$_mint(holder, supply); await this.token.delegate(holder, { from: holder }); }); it('call', async function () { expect(await this.token.delegates(holder)).to.be.equal(holder); const { receipt } = await this.token.delegate(holderDelegatee, { from: holder }); expectEvent(receipt, 'DelegateChanged', { delegator: holder, fromDelegate: holder, toDelegate: holderDelegatee, }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: holder, previousBalance: supply, newBalance: '0', }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: holderDelegatee, previousBalance: '0', newBalance: supply, }); expect(await this.token.delegates(holder)).to.be.equal(holderDelegatee); expect(await this.token.getCurrentVotes(holder)).to.be.bignumber.equal('0'); expect(await this.token.getCurrentVotes(holderDelegatee)).to.be.bignumber.equal(supply); expect(await this.token.getPriorVotes(holder, receipt.blockNumber - 1)).to.be.bignumber.equal(supply); expect(await this.token.getPriorVotes(holderDelegatee, receipt.blockNumber - 1)).to.be.bignumber.equal('0'); await time.advanceBlock(); expect(await this.token.getPriorVotes(holder, receipt.blockNumber)).to.be.bignumber.equal('0'); expect(await this.token.getPriorVotes(holderDelegatee, receipt.blockNumber)).to.be.bignumber.equal(supply); }); }); describe('transfers', function () { beforeEach(async function () { await this.token.$_mint(holder, supply); }); it('no delegation', async function () { const { receipt } = await this.token.transfer(recipient, 1, { from: holder }); expectEvent(receipt, 'Transfer', { from: holder, to: recipient, value: '1' }); expectEvent.notEmitted(receipt, 'DelegateVotesChanged'); this.holderVotes = '0'; this.recipientVotes = '0'; }); it('sender delegation', async function () { await this.token.delegate(holder, { from: holder }); const { receipt } = await this.token.transfer(recipient, 1, { from: holder }); expectEvent(receipt, 'Transfer', { from: holder, to: recipient, value: '1' }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: holder, previousBalance: supply, newBalance: supply.subn(1), }); this.holderVotes = supply.subn(1); this.recipientVotes = '0'; }); it('receiver delegation', async function () { await this.token.delegate(recipient, { from: recipient }); const { receipt } = await this.token.transfer(recipient, 1, { from: holder }); expectEvent(receipt, 'Transfer', { from: holder, to: recipient, value: '1' }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: recipient, previousBalance: '0', newBalance: '1' }); this.holderVotes = '0'; this.recipientVotes = '1'; }); it('full delegation', async function () { await this.token.delegate(holder, { from: holder }); await this.token.delegate(recipient, { from: recipient }); const { receipt } = await this.token.transfer(recipient, 1, { from: holder }); expectEvent(receipt, 'Transfer', { from: holder, to: recipient, value: '1' }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: holder, previousBalance: supply, newBalance: supply.subn(1), }); expectEvent(receipt, 'DelegateVotesChanged', { delegate: recipient, previousBalance: '0', newBalance: '1' }); this.holderVotes = supply.subn(1); this.recipientVotes = '1'; }); afterEach(async function () { expect(await this.token.getCurrentVotes(holder)).to.be.bignumber.equal(this.holderVotes); expect(await this.token.getCurrentVotes(recipient)).to.be.bignumber.equal(this.recipientVotes); // need to advance 2 blocks to see the effect of a transfer on "getPriorVotes" const blockNumber = await time.latestBlock(); await time.advanceBlock(); expect(await this.token.getPriorVotes(holder, blockNumber)).to.be.bignumber.equal(this.holderVotes); expect(await this.token.getPriorVotes(recipient, blockNumber)).to.be.bignumber.equal(this.recipientVotes); }); }); // The following tests are a adaptation of https://github.com/compound-finance/compound-protocol/blob/master/tests/Governance/CompTest.js. describe('Compound test suite', function () { beforeEach(async function () { await this.token.$_mint(holder, supply); }); describe('balanceOf', function () { it('grants to initial account', async function () { expect(await this.token.balanceOf(holder)).to.be.bignumber.equal('10000000000000000000000000'); }); }); describe('numCheckpoints', function () { it('returns the number of checkpoints for a delegate', async function () { await this.token.transfer(recipient, '100', { from: holder }); //give an account a few tokens for readability expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('0'); const t1 = await this.token.delegate(other1, { from: recipient }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('1'); const t2 = await this.token.transfer(other2, 10, { from: recipient }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('2'); const t3 = await this.token.transfer(other2, 10, { from: recipient }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('3'); const t4 = await this.token.transfer(recipient, 20, { from: holder }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('4'); expect(await this.token.checkpoints(other1, 0)).to.be.deep.equal([t1.receipt.blockNumber.toString(), '100']); expect(await this.token.checkpoints(other1, 1)).to.be.deep.equal([t2.receipt.blockNumber.toString(), '90']); expect(await this.token.checkpoints(other1, 2)).to.be.deep.equal([t3.receipt.blockNumber.toString(), '80']); expect(await this.token.checkpoints(other1, 3)).to.be.deep.equal([t4.receipt.blockNumber.toString(), '100']); await time.advanceBlock(); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber)).to.be.bignumber.equal('100'); expect(await this.token.getPriorVotes(other1, t2.receipt.blockNumber)).to.be.bignumber.equal('90'); expect(await this.token.getPriorVotes(other1, t3.receipt.blockNumber)).to.be.bignumber.equal('80'); expect(await this.token.getPriorVotes(other1, t4.receipt.blockNumber)).to.be.bignumber.equal('100'); }); it('does not add more than one checkpoint in a block', async function () { await this.token.transfer(recipient, '100', { from: holder }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('0'); const [t1, t2, t3] = await batchInBlock([ () => this.token.delegate(other1, { from: recipient, gas: 100000 }), () => this.token.transfer(other2, 10, { from: recipient, gas: 100000 }), () => this.token.transfer(other2, 10, { from: recipient, gas: 100000 }), ]); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('1'); expect(await this.token.checkpoints(other1, 0)).to.be.deep.equal([t1.receipt.blockNumber.toString(), '80']); // expectReve(await this.token.checkpoints(other1, 1)).to.be.deep.equal([ '0', '0' ]); // Reverts due to array overflow check // expect(await this.token.checkpoints(other1, 2)).to.be.deep.equal([ '0', '0' ]); // Reverts due to array overflow check const t4 = await this.token.transfer(recipient, 20, { from: holder }); expect(await this.token.numCheckpoints(other1)).to.be.bignumber.equal('2'); expect(await this.token.checkpoints(other1, 1)).to.be.deep.equal([t4.receipt.blockNumber.toString(), '100']); }); }); describe('getPriorVotes', function () { it('reverts if block number >= current block', async function () { await expectRevert(this.token.getPriorVotes(other1, 5e10), 'ERC20Votes: block not yet mined'); }); it('returns 0 if there are no checkpoints', async function () { expect(await this.token.getPriorVotes(other1, 0)).to.be.bignumber.equal('0'); }); it('returns the latest block if >= last checkpoint block', async function () { const t1 = await this.token.delegate(other1, { from: holder }); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); }); it('returns zero if < first checkpoint block', async function () { await time.advanceBlock(); const t1 = await this.token.delegate(other1, { from: holder }); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber - 1)).to.be.bignumber.equal('0'); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); }); it('generally returns the voting balance at the appropriate checkpoint', async function () { const t1 = await this.token.delegate(other1, { from: holder }); await time.advanceBlock(); await time.advanceBlock(); const t2 = await this.token.transfer(other2, 10, { from: holder }); await time.advanceBlock(); await time.advanceBlock(); const t3 = await this.token.transfer(other2, 10, { from: holder }); await time.advanceBlock(); await time.advanceBlock(); const t4 = await this.token.transfer(holder, 20, { from: other2 }); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber - 1)).to.be.bignumber.equal('0'); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPriorVotes(other1, t1.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPriorVotes(other1, t2.receipt.blockNumber)).to.be.bignumber.equal( '9999999999999999999999990', ); expect(await this.token.getPriorVotes(other1, t2.receipt.blockNumber + 1)).to.be.bignumber.equal( '9999999999999999999999990', ); expect(await this.token.getPriorVotes(other1, t3.receipt.blockNumber)).to.be.bignumber.equal( '9999999999999999999999980', ); expect(await this.token.getPriorVotes(other1, t3.receipt.blockNumber + 1)).to.be.bignumber.equal( '9999999999999999999999980', ); expect(await this.token.getPriorVotes(other1, t4.receipt.blockNumber)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPriorVotes(other1, t4.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); }); }); }); describe('getPastTotalSupply', function () { beforeEach(async function () { await this.token.delegate(holder, { from: holder }); }); it('reverts if block number >= current block', async function () { await expectRevert(this.token.getPastTotalSupply(5e10), 'ERC20Votes: block not yet mined'); }); it('returns 0 if there are no checkpoints', async function () { expect(await this.token.getPastTotalSupply(0)).to.be.bignumber.equal('0'); }); it('returns the latest block if >= last checkpoint block', async function () { t1 = await this.token.$_mint(holder, supply); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber)).to.be.bignumber.equal(supply); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber + 1)).to.be.bignumber.equal(supply); }); it('returns zero if < first checkpoint block', async function () { await time.advanceBlock(); const t1 = await this.token.$_mint(holder, supply); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber - 1)).to.be.bignumber.equal('0'); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); }); it('generally returns the voting balance at the appropriate checkpoint', async function () { const t1 = await this.token.$_mint(holder, supply); await time.advanceBlock(); await time.advanceBlock(); const t2 = await this.token.$_burn(holder, 10); await time.advanceBlock(); await time.advanceBlock(); const t3 = await this.token.$_burn(holder, 10); await time.advanceBlock(); await time.advanceBlock(); const t4 = await this.token.$_mint(holder, 20); await time.advanceBlock(); await time.advanceBlock(); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber - 1)).to.be.bignumber.equal('0'); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPastTotalSupply(t1.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPastTotalSupply(t2.receipt.blockNumber)).to.be.bignumber.equal( '9999999999999999999999990', ); expect(await this.token.getPastTotalSupply(t2.receipt.blockNumber + 1)).to.be.bignumber.equal( '9999999999999999999999990', ); expect(await this.token.getPastTotalSupply(t3.receipt.blockNumber)).to.be.bignumber.equal( '9999999999999999999999980', ); expect(await this.token.getPastTotalSupply(t3.receipt.blockNumber + 1)).to.be.bignumber.equal( '9999999999999999999999980', ); expect(await this.token.getPastTotalSupply(t4.receipt.blockNumber)).to.be.bignumber.equal( '10000000000000000000000000', ); expect(await this.token.getPastTotalSupply(t4.receipt.blockNumber + 1)).to.be.bignumber.equal( '10000000000000000000000000', ); }); }); });