Add GovernorSequentialProposalId extension for sequential numbers on proposals (#5290)

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Ernesto García <ernestognw@gmail.com>

test/governance/Governor.test.js

@@ -96,7 +96,7 @@ describe('Governor', function () {
         );
       });
 
-      shouldSupportInterfaces(['ERC1155Receiver', 'Governor']);
+      shouldSupportInterfaces(['ERC1155Receiver', 'Governor', 'Governor_5_3']);
       shouldBehaveLikeERC6372(mode);
 
       it('deployment check', async function () {

test/governance/extensions/GovernorSequentialProposalId.test.js

@@ -0,0 +1,202 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+const { anyValue } = require('@nomicfoundation/hardhat-chai-matchers/withArgs');
+
+const { GovernorHelper } = require('../../helpers/governance');
+const { VoteType } = require('../../helpers/enums');
+const iterate = require('../../helpers/iterate');
+
+const TOKENS = [
+  { Token: '$ERC20Votes', mode: 'blocknumber' },
+  { Token: '$ERC20VotesTimestampMock', mode: 'timestamp' },
+];
+
+const name = 'OZ-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');
+
+async function deployToken(contractName) {
+  try {
+    return await ethers.deployContract(contractName, [tokenName, tokenSymbol, tokenName, version]);
+  } catch (error) {
+    if (error.message == 'incorrect number of arguments to constructor') {
+      // ERC20VotesLegacyMock has a different construction that uses version='1' by default.
+      return ethers.deployContract(contractName, [tokenName, tokenSymbol, tokenName]);
+    }
+    throw error;
+  }
+}
+
+describe('GovernorSequentialProposalId', function () {
+  for (const { Token, mode } of TOKENS) {
+    const fixture = async () => {
+      const [owner, proposer, voter1, voter2, voter3, voter4, userEOA] = await ethers.getSigners();
+      const receiver = await ethers.deployContract('CallReceiverMock');
+
+      const token = await deployToken(Token, [tokenName, tokenSymbol, version]);
+      const mock = await ethers.deployContract('$GovernorSequentialProposalIdMock', [
+        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: token, to: voter1, value: ethers.parseEther('10') });
+      await helper.connect(owner).delegate({ token: token, to: voter2, value: ethers.parseEther('7') });
+      await helper.connect(owner).delegate({ token: token, to: voter3, value: ethers.parseEther('5') });
+      await helper.connect(owner).delegate({ token: token, to: voter4, value: ethers.parseEther('2') });
+
+      return {
+        owner,
+        proposer,
+        voter1,
+        voter2,
+        voter3,
+        voter4,
+        userEOA,
+        receiver,
+        token,
+        mock,
+        helper,
+      };
+    };
+
+    describe(`using ${Token}`, function () {
+      beforeEach(async function () {
+        Object.assign(this, await loadFixture(fixture));
+
+        this.proposal = this.helper.setProposal(
+          [
+            {
+              target: this.receiver.target,
+              data: this.receiver.interface.encodeFunctionData('mockFunction'),
+              value,
+            },
+          ],
+          '<proposal description>',
+        );
+      });
+
+      it('sequential proposal ids', async function () {
+        for (const i of iterate.range(1, 10)) {
+          this.proposal.description = `<proposal description #${i}>`;
+
+          expect(this.mock.hashProposal(...this.proposal.shortProposal)).to.eventually.equal(this.proposal.hash);
+          await expect(this.mock.getProposalId(...this.proposal.shortProposal)).revertedWithCustomError(
+            this.mock,
+            'GovernorNonexistentProposal',
+          );
+          expect(this.mock.latestProposalId()).to.eventually.equal(i - 1);
+
+          await expect(this.helper.connect(this.proposer).propose())
+            .to.emit(this.mock, 'ProposalCreated')
+            .withArgs(
+              i,
+              this.proposer,
+              this.proposal.targets,
+              this.proposal.values,
+              this.proposal.signatures,
+              this.proposal.data,
+              anyValue,
+              anyValue,
+              this.proposal.description,
+            );
+
+          expect(this.mock.hashProposal(...this.proposal.shortProposal)).to.eventually.equal(this.proposal.hash);
+          expect(this.mock.getProposalId(...this.proposal.shortProposal)).to.eventually.equal(i);
+          expect(this.mock.latestProposalId()).to.eventually.equal(i);
+        }
+      });
+
+      it('sequential proposal ids with offset start', async function () {
+        const offset = 69420;
+        await this.mock.$_initializeLatestProposalId(offset);
+
+        for (const i of iterate.range(offset + 1, offset + 10)) {
+          this.proposal.description = `<proposal description #${i}>`;
+
+          expect(this.mock.hashProposal(...this.proposal.shortProposal)).to.eventually.equal(this.proposal.hash);
+          await expect(this.mock.getProposalId(...this.proposal.shortProposal)).revertedWithCustomError(
+            this.mock,
+            'GovernorNonexistentProposal',
+          );
+          expect(this.mock.latestProposalId()).to.eventually.equal(i - 1);
+
+          await expect(this.helper.connect(this.proposer).propose())
+            .to.emit(this.mock, 'ProposalCreated')
+            .withArgs(
+              i,
+              this.proposer,
+              this.proposal.targets,
+              this.proposal.values,
+              this.proposal.signatures,
+              this.proposal.data,
+              anyValue,
+              anyValue,
+              this.proposal.description,
+            );
+
+          expect(this.mock.hashProposal(...this.proposal.shortProposal)).to.eventually.equal(this.proposal.hash);
+          expect(this.mock.getProposalId(...this.proposal.shortProposal)).to.eventually.equal(i);
+          expect(this.mock.latestProposalId()).to.eventually.equal(i);
+        }
+      });
+
+      it('can only initialize latest proposal id from 0', async function () {
+        await this.helper.propose();
+        expect(this.mock.latestProposalId()).to.eventually.equal(1);
+        await expect(this.mock.$_initializeLatestProposalId(2)).to.be.revertedWithCustomError(
+          this.mock,
+          'GovernorAlreadyInitializedLatestProposalId',
+        );
+      });
+
+      it('cannot repropose same proposal', async function () {
+        await this.helper.connect(this.proposer).propose();
+        await expect(this.helper.connect(this.proposer).propose())
+          .to.be.revertedWithCustomError(this.mock, 'GovernorUnexpectedProposalState')
+          .withArgs(await this.proposal.id, 0, ethers.ZeroHash);
+      });
+
+      it('nominal workflow', async function () {
+        await this.helper.connect(this.proposer).propose();
+        await this.helper.waitForSnapshot();
+
+        await expect(this.mock.connect(this.voter1).castVote(1, VoteType.For))
+          .to.emit(this.mock, 'VoteCast')
+          .withArgs(this.voter1, 1, VoteType.For, ethers.parseEther('10'), '');
+
+        await expect(this.mock.connect(this.voter2).castVote(1, VoteType.For))
+          .to.emit(this.mock, 'VoteCast')
+          .withArgs(this.voter2, 1, VoteType.For, ethers.parseEther('7'), '');
+
+        await expect(this.mock.connect(this.voter3).castVote(1, VoteType.For))
+          .to.emit(this.mock, 'VoteCast')
+          .withArgs(this.voter3, 1, VoteType.For, ethers.parseEther('5'), '');
+
+        await expect(this.mock.connect(this.voter4).castVote(1, VoteType.Abstain))
+          .to.emit(this.mock, 'VoteCast')
+          .withArgs(this.voter4, 1, VoteType.Abstain, ethers.parseEther('2'), '');
+
+        await this.helper.waitForDeadline();
+
+        expect(this.helper.execute())
+          .to.eventually.emit(this.mock, 'ProposalExecuted')
+          .withArgs(1)
+          .emit(this.receiver, 'MockFunctionCalled');
+      });
+    });
+  }
+});