refactor(poll): put verifier and vkRegistry into extContracts

contracts/contracts/MACI.sol

@@ -205,15 +205,19 @@ contract MACI is IMACI, DomainObjs, Params, Utilities {
     // the owner of the message processor and tally contract will be the msg.sender
     address _msgSender = msg.sender;
 
+    ExtContracts memory extContracts = ExtContracts({
+      maci: IMACI(address(this)),
+      verifier: IVerifier(_verifier),
+      vkRegistry: IVkRegistry(_vkRegistry)
+    });
+
     address p = pollFactory.deploy(
-      _verifier,
-      _vkRegistry,
       _duration,
       maxVoteOptions,
       _treeDepths,
       _messageBatchSize,
       _coordinatorPubKey,
-      address(this)
+      extContracts
     );
 
     address mp = messageProcessorFactory.deploy(_verifier, _vkRegistry, p, _msgSender, _mode);

contracts/contracts/MessageProcessor.sol

@@ -145,7 +145,7 @@ contract MessageProcessor is Ownable, SnarkCommon, Hasher, CommonUtilities, IMes
     // get the message batch size from the message tree subdepth
     // get the number of signups
     (uint256 numSignUps, uint256 numMessages) = poll.numSignUpsAndMessages();
-    IMACI maci = poll.extContracts();
+    IMACI maci = poll.getMaciContract();
 
     // Calculate the public input hash (a SHA256 hash of several values)
     uint256 publicInputHash = genProcessMessagesPublicInputHash(

contracts/contracts/Poll.sol

@@ -6,6 +6,7 @@ import { Params } from "./utilities/Params.sol";
 import { SnarkCommon } from "./crypto/SnarkCommon.sol";
 import { EmptyBallotRoots } from "./trees/EmptyBallotRoots.sol";
 import { LazyIMTData, InternalLazyIMT } from "./trees/LazyIMT.sol";
+import { IMACI } from "./interfaces/IMACI.sol";
 import { IPoll } from "./interfaces/IPoll.sol";
 import { IVerifier } from "./interfaces/IVerifier.sol";
 import { IVkRegistry } from "./interfaces/IVkRegistry.sol";
@@ -71,11 +72,6 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
   /// @notice The contracts used by the Poll
   ExtContracts public extContracts;
 
-  /// @notice The verifier
-  IVerifier public immutable verifier;
-  /// @notice The verification registry
-  IVkRegistry public immutable vkRegistry;
-
   /// @notice The array for chain hash checkpoints
   uint256[] public batchHashes;
 
@@ -127,8 +123,6 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
   /// @param _extContracts The external contracts
 
   constructor(
-    address _verifier,
-    address _vkRegistry,
     uint256 _duration,
     uint256 _maxVoteOptions,
     TreeDepths memory _treeDepths,
@@ -141,10 +135,6 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
       revert InvalidPubKey();
     }
 
-    // store verifier
-    verifier = IVerifier(_verifier);
-    // store vkRegistry
-    vkRegistry = IVkRegistry(_vkRegistry);
     // store the pub key as object then calculate the hash
     coordinatorPubKey = _coordinatorPubKey;
     // we hash it ourselves to ensure we store the correct value
@@ -325,7 +315,10 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
     uint256[8] memory _proof
   ) internal returns (bool isValid) {
     // Get the verifying key from the VkRegistry
-    VerifyingKey memory vk = vkRegistry.getPollVk(extContracts.maci.stateTreeDepth(), treeDepths.voteOptionTreeDepth);
+    VerifyingKey memory vk = extContracts.vkRegistry.getPollVk(
+      extContracts.maci.stateTreeDepth(),
+      treeDepths.voteOptionTreeDepth
+    );
 
     // Generate the circuit public input
     uint256[] memory input = new uint256[](5);
@@ -336,7 +329,7 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
     input[4] = _pubKey.y;
     uint256 publicInputHash = sha256Hash(input);
 
-    isValid = verifier.verify(_proof, vk, publicInputHash);
+    isValid = extContracts.verifier.verify(_proof, vk, publicInputHash);
   }
 
   /// @inheritdoc IPoll
@@ -384,4 +377,9 @@ contract Poll is Params, Utilities, SnarkCommon, EmptyBallotRoots, IPoll {
     numSUps = numSignups;
     numMsgs = numMessages;
   }
+
+  /// @inheritdoc IPoll
+  function getMaciContract() public view returns (IMACI maci) {
+    return extContracts.maci;
+  }
 }

contracts/contracts/PollFactory.sol

@@ -20,14 +20,12 @@ contract PollFactory is Params, DomainObjs, IPollFactory {
 
   /// @inheritdoc IPollFactory
   function deploy(
-    address _verifier,
-    address _vkRegistry,
     uint256 _duration,
     uint256 _maxVoteOptions,
     TreeDepths calldata _treeDepths,
     uint8 _messageBatchSize,
     PubKey calldata _coordinatorPubKey,
-    address _maci
+    ExtContracts calldata _extContracts
   ) public virtual returns (address pollAddr) {
     /// @notice Validate _maxVoteOptions
     /// maxVoteOptions must be less than 2 ** 50 due to circuit limitations;
@@ -37,20 +35,8 @@ contract PollFactory is Params, DomainObjs, IPollFactory {
       revert InvalidMaxVoteOptions();
     }
 
-    /// @notice the smart contracts that a Poll would interact with
-    ExtContracts memory extContracts = ExtContracts({ maci: IMACI(_maci) });
-
     // deploy the poll
-    Poll poll = new Poll(
-      _verifier,
-      _vkRegistry,
-      _duration,
-      _maxVoteOptions,
-      _treeDepths,
-      _messageBatchSize,
-      _coordinatorPubKey,
-      extContracts
-    );
+    Poll poll = new Poll(_duration, _maxVoteOptions, _treeDepths, _messageBatchSize, _coordinatorPubKey, _extContracts);
 
     // init Poll
     poll.init();

contracts/contracts/Tally.sol

@@ -192,7 +192,7 @@ contract Tally is Ownable, SnarkCommon, CommonUtilities, Hasher, DomainObjs {
   ) public view returns (bool isValid) {
     (uint8 intStateTreeDepth, uint8 voteOptionTreeDepth) = poll.treeDepths();
 
-    IMACI maci = poll.extContracts();
+    IMACI maci = poll.getMaciContract();
 
     // Get the verifying key
     VerifyingKey memory vk = vkRegistry.getTallyVk(maci.stateTreeDepth(), intStateTreeDepth, voteOptionTreeDepth, mode);

contracts/contracts/interfaces/IPoll.sol

@@ -83,5 +83,5 @@ interface IPoll {
 
   /// @notice Get the external contracts
   /// @return maci The IMACI contract
-  function extContracts() external view returns (IMACI maci);
+  function getMaciContract() external view returns (IMACI maci);
 }

contracts/contracts/interfaces/IPollFactory.sol

@@ -8,23 +8,19 @@ import { DomainObjs } from "../utilities/DomainObjs.sol";
 /// @notice PollFactory interface
 interface IPollFactory {
   /// @notice Deploy a new Poll contract
-  /// @param _verifier Verifier contract
-  /// @param _vkRegistry VkRegistry contract
   /// @param _duration The duration of the poll
   /// @param _maxVoteOptions The max vote options for the poll
   /// @param _treeDepths The depths of the merkle trees
   /// @param _messageBatchSize The size of message batch
   /// @param _coordinatorPubKey The coordinator's public key
-  /// @param _maci The MACI contract interface reference
+  /// @param _extContract The external contract interface references
   /// @return The deployed Poll contract
   function deploy(
-    address _verifier,
-    address _vkRegistry,
     uint256 _duration,
     uint256 _maxVoteOptions,
     Params.TreeDepths memory _treeDepths,
     uint8 _messageBatchSize,
     DomainObjs.PubKey memory _coordinatorPubKey,
-    address _maci
+    Params.ExtContracts calldata _extContract
   ) external returns (address);
 }

contracts/contracts/utilities/Params.sol

@@ -2,6 +2,8 @@
 pragma solidity ^0.8.20;
 
 import { IMACI } from "../interfaces/IMACI.sol";
+import { IVerifier } from "../interfaces/IVerifier.sol";
+import { IVkRegistry } from "../interfaces/IVkRegistry.sol";
 
 /// @title Params
 /// @notice This contracts contains a number of structures
@@ -20,5 +22,7 @@ contract Params {
   /// deployment
   struct ExtContracts {
     IMACI maci;
+    IVerifier verifier;
+    IVkRegistry vkRegistry;
   }
 }

contracts/hardhat.config.ts

@@ -53,7 +53,6 @@ const config: HardhatUserConfig = {
         enabled: true,
         runs: 200,
       },
-      viaIR: true,
     },
   },
   defaultNetwork: "localhost",

contracts/tests/PollFactory.test.ts

@@ -5,13 +5,21 @@ import { Keypair } from "maci-domainobjs";
 import { deployPollFactory, getDefaultSigner } from "../ts";
 import { MACI, PollFactory, Verifier, VkRegistry } from "../typechain-types";
 
-import { messageBatchSize, initialVoiceCreditBalance, maxVoteOptions, STATE_TREE_DEPTH, treeDepths } from "./constants";
+import {
+  messageBatchSize,
+  initialVoiceCreditBalance,
+  maxVoteOptions,
+  STATE_TREE_DEPTH,
+  treeDepths,
+  ExtContractsStruct,
+} from "./constants";
 import { deployTestContracts } from "./utils";
 
 describe("pollFactory", () => {
   let maciContract: MACI;
   let verifierContract: Verifier;
   let vkRegistryContract: VkRegistry;
+  let extContracts: ExtContractsStruct;
   let pollFactory: PollFactory;
   let signer: Signer;
 
@@ -23,21 +31,20 @@ describe("pollFactory", () => {
     maciContract = r.maciContract;
     verifierContract = r.mockVerifierContract as Verifier;
     vkRegistryContract = r.vkRegistryContract;
+    extContracts = { maci: maciContract, verifier: verifierContract, vkRegistry: vkRegistryContract };
 
     pollFactory = (await deployPollFactory(signer, true)) as BaseContract as PollFactory;
   });
 
   describe("deployment", () => {
     it("should allow anyone to deploy a new poll", async () => {
       const tx = await pollFactory.deploy(
-        verifierContract,
-        vkRegistryContract,
         "100",
         maxVoteOptions,
         treeDepths,
         messageBatchSize,
         coordinatorPubKey.asContractParam(),
-        maciContract,
+        extContracts,
       );
       const receipt = await tx.wait();
       expect(receipt?.status).to.eq(1);
@@ -47,14 +54,12 @@ describe("pollFactory", () => {
       const maxVoteOptionsInvalid = 2 ** 50;
       await expect(
         pollFactory.deploy(
-          verifierContract,
-          vkRegistryContract,
           "100",
           maxVoteOptionsInvalid,
           treeDepths,
           messageBatchSize,
           coordinatorPubKey.asContractParam(),
-          maciContract,
+          extContracts,
         ),
       ).to.be.revertedWithCustomError(pollFactory, "InvalidMaxVoteOptions");
     });

contracts/tests/constants.ts

@@ -1,7 +1,14 @@
+import { AddressLike } from "ethers";
 import { TreeDepths, STATE_TREE_ARITY } from "maci-core";
 import { G1Point, G2Point } from "maci-crypto";
 import { VerifyingKey } from "maci-domainobjs";
 
+export interface ExtContractsStruct {
+  maci: AddressLike;
+  verifier: AddressLike;
+  vkRegistry: AddressLike;
+}
+
 export const duration = 2_000;
 
 export const STATE_TREE_DEPTH = 10;