Delegate override vote (#5192)

Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com>
This commit is contained in:
Hadrien Croubois
2024-10-18 14:17:20 +02:00
committed by GitHub
parent 0034c30224
commit 378914ceab
15 changed files with 924 additions and 22 deletions

View File

@ -0,0 +1,344 @@
const { ethers } = require('hardhat');
const { expect } = require('chai');
const { loadFixture, mine } = require('@nomicfoundation/hardhat-network-helpers');
const { GovernorHelper } = require('../../helpers/governance');
const { getDomain, OverrideBallot } = require('../../helpers/eip712');
const { VoteType } = require('../../helpers/enums');
const TOKENS = [
{ Token: '$ERC20VotesExtendedMock', mode: 'blocknumber' },
// { Token: '$ERC20VotesExtendedTimestampMock', mode: 'timestamp' },
];
const name = 'Override Governor';
const version = '1';
const tokenName = 'MockToken';
const tokenSymbol = 'MTKN';
const tokenSupply = ethers.parseEther('100');
const votingDelay = 4n;
const votingPeriod = 16n;
const value = ethers.parseEther('1');
const signBallot = account => (contract, message) =>
getDomain(contract).then(domain => account.signTypedData(domain, { OverrideBallot }, message));
describe('GovernorCountingOverridable', function () {
for (const { Token, mode } of TOKENS) {
const fixture = async () => {
const [owner, proposer, voter1, voter2, voter3, voter4, other] = await ethers.getSigners();
const receiver = await ethers.deployContract('CallReceiverMock');
const token = await ethers.deployContract(Token, [tokenName, tokenSymbol, tokenName, version]);
const mock = await ethers.deployContract('$GovernorCountingOverridableMock', [
name, // name
votingDelay, // initialVotingDelay
votingPeriod, // initialVotingPeriod
0n, // initialProposalThreshold
token, // tokenAddress
10n, // quorumNumeratorValue
]);
await owner.sendTransaction({ to: mock, value });
await token.$_mint(owner, tokenSupply);
const helper = new GovernorHelper(mock, mode);
await helper.connect(owner).delegate({ token, to: voter1, value: ethers.parseEther('10') });
await helper.connect(owner).delegate({ token, to: voter2, value: ethers.parseEther('7') });
await helper.connect(owner).delegate({ token, to: voter3, value: ethers.parseEther('5') });
await helper.connect(owner).delegate({ token, to: voter4, value: ethers.parseEther('2') });
return { owner, proposer, voter1, voter2, voter3, voter4, other, receiver, token, mock, helper };
};
describe(`using ${Token}`, function () {
beforeEach(async function () {
Object.assign(this, await loadFixture(fixture));
// default proposal
this.proposal = this.helper.setProposal(
[
{
target: this.receiver.target,
value,
data: this.receiver.interface.encodeFunctionData('mockFunction'),
},
],
'<proposal description>',
);
});
it('deployment check', async function () {
expect(await this.mock.name()).to.equal(name);
expect(await this.mock.token()).to.equal(this.token);
expect(await this.mock.votingDelay()).to.equal(votingDelay);
expect(await this.mock.votingPeriod()).to.equal(votingPeriod);
expect(await this.mock.COUNTING_MODE()).to.equal('support=bravo,override&quorum=for,abstain&overridable=true');
});
it('nominal is unaffected', async function () {
await this.helper.connect(this.proposer).propose();
await this.helper.waitForSnapshot();
await this.helper.connect(this.voter1).vote({ support: VoteType.For, reason: 'This is nice' });
await this.helper.connect(this.voter2).vote({ support: VoteType.For });
await this.helper.connect(this.voter3).vote({ support: VoteType.Against });
await this.helper.connect(this.voter4).vote({ support: VoteType.Abstain });
await this.helper.waitForDeadline();
await this.helper.execute();
expect(await this.mock.hasVoted(this.proposal.id, this.owner)).to.be.false;
expect(await this.mock.hasVoted(this.proposal.id, this.voter1)).to.be.true;
expect(await this.mock.hasVoted(this.proposal.id, this.voter2)).to.be.true;
expect(await ethers.provider.getBalance(this.mock)).to.equal(0n);
expect(await ethers.provider.getBalance(this.receiver)).to.equal(value);
});
describe('cast override vote', async function () {
beforeEach(async function () {
// user 1 -(delegate 10 tokens)-> user 2
// user 2 -(delegate 7 tokens)-> user 2
// user 3 -(delegate 5 tokens)-> user 1
// user 4 -(delegate 2 tokens)-> user 2
await this.token.connect(this.voter1).delegate(this.voter2);
await this.token.connect(this.voter3).delegate(this.voter1);
await this.token.connect(this.voter4).delegate(this.voter2);
await mine();
await this.helper.connect(this.proposer).propose();
await this.helper.waitForSnapshot();
});
it('override after delegate vote', async function () {
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter4)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter4)).to.be.false;
// user 2 votes
await expect(this.helper.connect(this.voter2).vote({ support: VoteType.For }))
.to.emit(this.mock, 'VoteCast')
.withArgs(this.voter2, this.helper.id, VoteType.For, ethers.parseEther('19'), ''); // 10 + 7 + 2
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[0, 19, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.true;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
// user 1 overrides after user 2 votes
const reason = "disagree with user 2's decision";
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Against, reason))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.Against, ethers.parseEther('10'), reason)
.to.emit(this.mock, 'VoteReduced')
.withArgs(this.voter2, this.helper.id, VoteType.For, ethers.parseEther('10'));
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 9, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.true;
});
it('override before delegate vote', async function () {
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter4)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter4)).to.be.false;
// user 1 overrides before user 2 votes
const reason = 'voter 2 is not voting';
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Against, reason))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.Against, ethers.parseEther('10'), reason)
.to.not.emit(this.mock, 'VoteReduced');
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 0, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.true;
// user 2 votes
await expect(this.helper.connect(this.voter2).vote({ support: VoteType.For }))
.to.emit(this.mock, 'VoteCast')
.withArgs(this.voter2, this.helper.id, VoteType.For, ethers.parseEther('9'), ''); // 7 + 2
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 9, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.true;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
});
it('override before and after delegate vote', async function () {
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVoted(this.helper.id, this.voter4)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter3)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter4)).to.be.false;
// user 1 overrides before user 2 votes
const reason = 'voter 2 is not voting';
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Against, reason))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.Against, ethers.parseEther('10'), reason)
.to.not.emit(this.mock, 'VoteReduced');
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 0, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.true;
// user 2 votes
await expect(this.helper.connect(this.voter2).vote({ support: VoteType.For }))
.to.emit(this.mock, 'VoteCast')
.withArgs(this.voter2, this.helper.id, VoteType.For, ethers.parseEther('9'), ''); // 7 + 2
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 9, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter2)).to.be.true;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter2)).to.be.false;
// User 4 overrides after user 2 votes
const reason2 = "disagree with user 2's decision";
await expect(this.mock.connect(this.voter4).castOverrideVote(this.helper.id, VoteType.Abstain, reason2))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter4, this.helper.id, VoteType.Abstain, ethers.parseEther('2'), reason2)
.to.emit(this.mock, 'VoteReduced')
.withArgs(this.voter2, this.helper.id, VoteType.For, ethers.parseEther('2'));
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 7, 2].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter4)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter4)).to.be.true;
});
it('vote (with delegated balance) and override (with self balance) are independent', async function () {
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[0, 0, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.false;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.false;
// user 1 votes with delegated weight from user 3
await expect(this.mock.connect(this.voter1).castVote(this.helper.id, VoteType.For))
.to.emit(this.mock, 'VoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.For, ethers.parseEther('5'), '');
// user 1 cast an override vote with its own balance (delegated to user 2)
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Against, ''))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.Against, ethers.parseEther('10'), '');
expect(await this.mock.proposalVotes(this.helper.id)).to.deep.eq(
[10, 5, 0].map(x => ethers.parseEther(x.toString())),
);
expect(await this.mock.hasVoted(this.helper.id, this.voter1)).to.be.true;
expect(await this.mock.hasVotedOverride(this.helper.id, this.voter1)).to.be.true;
});
it('can not override vote twice', async function () {
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Against, ''))
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.Against, ethers.parseEther('10'), '');
await expect(this.mock.connect(this.voter1).castOverrideVote(this.helper.id, VoteType.Abstain, ''))
.to.be.revertedWithCustomError(this.mock, 'GovernorAlreadyOverridenVote')
.withArgs(this.voter1.address);
});
it('can not vote twice', async function () {
await expect(this.mock.connect(this.voter1).castVote(this.helper.id, VoteType.Against));
await expect(this.mock.connect(this.voter1).castVote(this.helper.id, VoteType.Abstain))
.to.be.revertedWithCustomError(this.mock, 'GovernorAlreadyCastVote')
.withArgs(this.voter1.address);
});
describe('invalid vote type', function () {
it('override vote', async function () {
await expect(
this.mock.connect(this.voter1).castOverrideVote(this.helper.id, 3, ''),
).to.be.revertedWithCustomError(this.mock, 'GovernorInvalidVoteType');
});
it('traditional vote', async function () {
await expect(this.mock.connect(this.voter1).castVote(this.helper.id, 3)).to.be.revertedWithCustomError(
this.mock,
'GovernorInvalidVoteType',
);
});
});
describe('by signature', function () {
it('EOA signature', async function () {
const nonce = await this.mock.nonces(this.voter1);
await expect(
this.helper.overrideVote({
support: VoteType.For,
voter: this.voter1.address,
nonce,
signature: signBallot(this.voter1),
}),
)
.to.emit(this.mock, 'OverrideVoteCast')
.withArgs(this.voter1, this.helper.id, VoteType.For, ethers.parseEther('10'), '');
expect(await this.mock.hasVotedOverride(this.proposal.id, this.voter1)).to.be.true;
});
it('revert if signature does not match signer', async function () {
const nonce = await this.mock.nonces(this.voter1);
const voteParams = {
support: VoteType.For,
voter: this.voter2.address,
nonce,
signature: signBallot(this.voter1),
};
await expect(this.helper.overrideVote(voteParams))
.to.be.revertedWithCustomError(this.mock, 'GovernorInvalidSignature')
.withArgs(voteParams.voter);
});
it('revert if vote nonce is incorrect', async function () {
const nonce = await this.mock.nonces(this.voter1);
const voteParams = {
support: VoteType.For,
voter: this.voter1.address,
nonce: nonce + 1n,
signature: signBallot(this.voter1),
};
await expect(this.helper.overrideVote(voteParams))
.to.be.revertedWithCustomError(this.mock, 'GovernorInvalidSignature')
.withArgs(voteParams.voter);
});
});
});
});
}
});

View File

@ -0,0 +1,152 @@
const { ethers } = require('hardhat');
const { expect } = require('chai');
const { loadFixture, mine } = require('@nomicfoundation/hardhat-network-helpers');
const { sum } = require('../../helpers/math');
const { zip } = require('../../helpers/iterate');
const time = require('../../helpers/time');
const { shouldBehaveLikeVotes } = require('./Votes.behavior');
const MODES = {
blocknumber: '$VotesExtendedMock',
timestamp: '$VotesExtendedTimestampMock',
};
const AMOUNTS = [ethers.parseEther('10000000'), 10n, 20n];
describe('VotesExtended', function () {
for (const [mode, artifact] of Object.entries(MODES)) {
const fixture = async () => {
const accounts = await ethers.getSigners();
const amounts = Object.fromEntries(
zip(
accounts.slice(0, AMOUNTS.length).map(({ address }) => address),
AMOUNTS,
),
);
const name = 'Override Votes';
const version = '1';
const votes = await ethers.deployContract(artifact, [name, version]);
return { accounts, amounts, votes, name, version };
};
describe(`vote with ${mode}`, function () {
beforeEach(async function () {
Object.assign(this, await loadFixture(fixture));
});
shouldBehaveLikeVotes(AMOUNTS, { mode, fungible: true });
it('starts with zero votes', async function () {
expect(await this.votes.getTotalSupply()).to.equal(0n);
});
describe('performs voting operations', function () {
beforeEach(async function () {
this.txs = [];
for (const [account, amount] of Object.entries(this.amounts)) {
this.txs.push(await this.votes.$_mint(account, amount));
}
});
it('reverts if block number >= current block', async function () {
const lastTxTimepoint = await time.clockFromReceipt[mode](this.txs.at(-1));
const clock = await this.votes.clock();
await expect(this.votes.getPastTotalSupply(lastTxTimepoint))
.to.be.revertedWithCustomError(this.votes, 'ERC5805FutureLookup')
.withArgs(lastTxTimepoint, clock);
});
it('delegates', async function () {
expect(await this.votes.getVotes(this.accounts[0])).to.equal(0n);
expect(await this.votes.getVotes(this.accounts[1])).to.equal(0n);
expect(await this.votes.delegates(this.accounts[0])).to.equal(ethers.ZeroAddress);
expect(await this.votes.delegates(this.accounts[1])).to.equal(ethers.ZeroAddress);
await this.votes.delegate(this.accounts[0], ethers.Typed.address(this.accounts[0]));
expect(await this.votes.getVotes(this.accounts[0])).to.equal(this.amounts[this.accounts[0].address]);
expect(await this.votes.getVotes(this.accounts[1])).to.equal(0n);
expect(await this.votes.delegates(this.accounts[0])).to.equal(this.accounts[0]);
expect(await this.votes.delegates(this.accounts[1])).to.equal(ethers.ZeroAddress);
await this.votes.delegate(this.accounts[1], ethers.Typed.address(this.accounts[0]));
expect(await this.votes.getVotes(this.accounts[0])).to.equal(
this.amounts[this.accounts[0].address] + this.amounts[this.accounts[1].address],
);
expect(await this.votes.getVotes(this.accounts[1])).to.equal(0n);
expect(await this.votes.delegates(this.accounts[0])).to.equal(this.accounts[0]);
expect(await this.votes.delegates(this.accounts[1])).to.equal(this.accounts[0]);
});
it('cross delegates', async function () {
await this.votes.delegate(this.accounts[0], ethers.Typed.address(this.accounts[1]));
await this.votes.delegate(this.accounts[1], ethers.Typed.address(this.accounts[0]));
expect(await this.votes.getVotes(this.accounts[0])).to.equal(this.amounts[this.accounts[1].address]);
expect(await this.votes.getVotes(this.accounts[1])).to.equal(this.amounts[this.accounts[0].address]);
});
it('returns total amount of votes', async function () {
const totalSupply = sum(...Object.values(this.amounts));
expect(await this.votes.getTotalSupply()).to.equal(totalSupply);
});
});
});
describe(`checkpoint delegates with ${mode}`, function () {
beforeEach(async function () {
Object.assign(this, await loadFixture(fixture));
});
it('checkpoint delegates', async function () {
const tx = await this.votes.delegate(this.accounts[0], ethers.Typed.address(this.accounts[1]));
const timepoint = await time.clockFromReceipt[mode](tx);
await mine(2);
expect(await this.votes.getPastDelegate(this.accounts[0], timepoint - 1n)).to.equal(ethers.ZeroAddress);
expect(await this.votes.getPastDelegate(this.accounts[0], timepoint)).to.equal(this.accounts[1].address);
expect(await this.votes.getPastDelegate(this.accounts[0], timepoint + 1n)).to.equal(this.accounts[1].address);
});
it('reverts if current timepoint <= timepoint', async function () {
const tx = await this.votes.delegate(this.accounts[0], ethers.Typed.address(this.accounts[1]));
const timepoint = await time.clockFromReceipt[mode](tx);
await expect(this.votes.getPastDelegate(this.accounts[0], timepoint + 1n))
.to.be.revertedWithCustomError(this.votes, 'ERC5805FutureLookup')
.withArgs(timepoint + 1n, timepoint);
});
});
describe(`checkpoint balances with ${mode}`, function () {
beforeEach(async function () {
Object.assign(this, await loadFixture(fixture));
});
it('checkpoint balances', async function () {
const tx = await this.votes.$_mint(this.accounts[0].address, 100n);
const timepoint = await time.clockFromReceipt[mode](tx);
await mine(2);
expect(await this.votes.getPastBalanceOf(this.accounts[0].address, timepoint - 1n)).to.equal(0n);
expect(await this.votes.getPastBalanceOf(this.accounts[0].address, timepoint)).to.equal(100n);
expect(await this.votes.getPastBalanceOf(this.accounts[0].address, timepoint + 1n)).to.equal(100n);
});
it('reverts if current timepoint <= timepoint', async function () {
const tx = await this.votes.$_mint(this.accounts[0].address, 100n);
const timepoint = await time.clockFromReceipt[mode](tx);
await expect(this.votes.getPastBalanceOf(this.accounts[0], timepoint + 1n))
.to.be.revertedWithCustomError(this.votes, 'ERC5805FutureLookup')
.withArgs(timepoint + 1n, timepoint);
});
});
}
});

View File

@ -32,6 +32,13 @@ module.exports = mapValues(
reason: 'string',
params: 'bytes',
},
OverrideBallot: {
proposalId: 'uint256',
support: 'uint8',
voter: 'address',
nonce: 'uint256',
reason: 'string',
},
Delegation: {
delegatee: 'address',
nonce: 'uint256',

View File

@ -128,6 +128,23 @@ class GovernorHelper {
return await this.governor[method](...args);
}
async overrideVote(vote = {}) {
let method = 'castOverrideVote';
let args = [this.id, vote.support];
vote.reason = vote.reason ?? '';
if (vote.signature) {
let message = this.forgeMessage(vote);
message.reason = message.reason ?? '';
const sign = await vote.signature(this.governor, message);
method = 'castOverrideVoteBySig';
args.push(vote.voter, vote.reason ?? '', sign);
}
return await this.governor[method](...args);
}
/// Clock helpers
async waitForSnapshot(offset = 0n) {
const timepoint = await this.governor.proposalSnapshot(this.id);