feat(contracts): return clone addresses from factories on deploy

ctrlc03 · ctrlc03 · commit 1a49a6849842 · 2025-04-11T11:20:42.000+01:00
diff --git a/packages/contracts/contracts/extensions/anonAadhaar/AnonAadhaarCheckerFactory.sol b/packages/contracts/contracts/extensions/anonAadhaar/AnonAadhaarCheckerFactory.sol
@@ -14,9 +14,11 @@ contract AnonAadhaarCheckerFactory is Factory {
     /// @notice Deploys a new AnonAadhaarChecker clone.
     /// @param anonAadhaarVerifier The address of the anonAadhaar contract
     /// @param nullifierSeed The nullifier seed specific to the app
-    function deploy(address anonAadhaarVerifier, uint256 nullifierSeed) public {
+    /// @return clone The address of the newly deployed AnonAadhaarChecker clone.
+    function deploy(address anonAadhaarVerifier, uint256 nullifierSeed) public returns (address clone) {
         bytes memory data = abi.encode(anonAadhaarVerifier, nullifierSeed);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         AnonAadhaarChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/anonAadhaar/AnonAadhaarPolicyFactory.sol b/packages/contracts/contracts/extensions/anonAadhaar/AnonAadhaarPolicyFactory.sol
@@ -14,10 +14,11 @@ contract AnonAadhaarPolicyFactory is Factory {
     /// @notice Deploys a new AnonAadhaarPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed AnonAadhaarPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         AnonAadhaarPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/eas/EASCheckerFactory.sol b/packages/contracts/contracts/extensions/eas/EASCheckerFactory.sol
@@ -15,9 +15,11 @@ contract EASCheckerFactory is Factory {
     /// @param eas The EAS contract
     /// @param attester The trusted attester
     /// @param schema The schema UID
-    function deploy(address eas, address attester, bytes32 schema) public {
+    /// @return clone The address of the newly deployed EASChecker clone.
+    function deploy(address eas, address attester, bytes32 schema) public returns (address clone) {
         bytes memory data = abi.encode(eas, attester, schema);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         EASChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/eas/EASPolicyFactory.sol b/packages/contracts/contracts/extensions/eas/EASPolicyFactory.sol
@@ -14,10 +14,11 @@ contract EASPolicyFactory is Factory {
     /// @notice Deploys a new EASPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed EASPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         EASPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/erc20/ERC20CheckerFactory.sol b/packages/contracts/contracts/extensions/erc20/ERC20CheckerFactory.sol
@@ -12,9 +12,11 @@ contract ERC20CheckerFactory is Factory {
     constructor() Factory(address(new ERC20Checker())) {}
 
     /// @notice Deploys a new ERC20VotesChecker clone.
-    function deploy(address _token, uint256 _threshold) public {
+    /// @return clone The address of the newly deployed ERC20VotesChecker clone.
+    function deploy(address _token, uint256 _threshold) public returns (address clone) {
         bytes memory data = abi.encode(_token, _threshold);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         ERC20Checker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/erc20/ERC20PolicyFactory.sol b/packages/contracts/contracts/extensions/erc20/ERC20PolicyFactory.sol
@@ -14,10 +14,11 @@ contract ERC20PolicyFactory is Factory {
     /// @notice Deploys a new ERC20Policy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param _checkerAddress Address of the checker to use for validation.
-    function deploy(address _checkerAddress) public {
+    /// @return clone The address of the newly deployed ERC20Policy clone.
+    function deploy(address _checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, _checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         ERC20Policy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/erc20votes/ERC20VotesCheckerFactory.sol b/packages/contracts/contracts/extensions/erc20votes/ERC20VotesCheckerFactory.sol
@@ -12,9 +12,11 @@ contract ERC20VotesCheckerFactory is Factory {
     constructor() Factory(address(new ERC20VotesChecker())) {}
 
     /// @notice Deploys a new ERC20VotesChecker clone.
-    function deploy(address _token, uint256 _snapshotBlock, uint256 _threshold) public {
+    /// @return clone The address of the newly deployed ERC20VotesChecker clone.
+    function deploy(address _token, uint256 _snapshotBlock, uint256 _threshold) public returns (address clone) {
         bytes memory data = abi.encode(_token, _snapshotBlock, _threshold);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         ERC20VotesChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/erc20votes/ERC20VotesPolicyFactory.sol b/packages/contracts/contracts/extensions/erc20votes/ERC20VotesPolicyFactory.sol
@@ -14,10 +14,11 @@ contract ERC20VotesPolicyFactory is Factory {
     /// @notice Deploys a new ERC20VotesPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param _checkerAddress Address of the checker to use for validation.
-    function deploy(address _checkerAddress) public {
+    /// @return clone The address of the newly deployed ERC20VotesPolicy clone.
+    function deploy(address _checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, _checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         ERC20VotesPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/freeForAll/FreeForAllCheckerFactory.sol b/packages/contracts/contracts/extensions/freeForAll/FreeForAllCheckerFactory.sol
@@ -12,9 +12,11 @@ contract FreeForAllCheckerFactory is Factory {
     constructor() Factory(address(new FreeForAllChecker())) {}
 
     /// @notice Deploys a new FreeForAllChecker clone.
-    function deploy() public {
+    /// @return clone The address of the newly deployed FreeForAllChecker clone.
+    function deploy() public returns (address clone) {
         bytes memory data = abi.encode();
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         FreeForAllChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/freeForAll/FreeForAllPolicyFactory.sol b/packages/contracts/contracts/extensions/freeForAll/FreeForAllPolicyFactory.sol
@@ -14,10 +14,11 @@ contract FreeForAllPolicyFactory is Factory {
     /// @notice Deploys a new FreeForAllPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param _checkerAddress Address of the checker to use for validation.
-    function deploy(address _checkerAddress) public {
+    /// @return clone The address of the newly deployed FreeForAllPolicy clone.
+    function deploy(address _checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, _checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         FreeForAllPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/gitcoin/GitcoinPassportCheckerFactory.sol b/packages/contracts/contracts/extensions/gitcoin/GitcoinPassportCheckerFactory.sol
@@ -14,9 +14,11 @@ contract GitcoinPassportCheckerFactory is Factory {
     /// @notice Deploys a new GitcoinPassportChecker clone.
     /// @param passportDecoder The GitcoinPassportDecoder contract
     /// @param thresholdScore The threshold score to be considered human
-    function deploy(address passportDecoder, uint256 thresholdScore) public {
+    /// @return clone The address of the newly deployed GitcoinPassportChecker clone.
+    function deploy(address passportDecoder, uint256 thresholdScore) public returns (address clone) {
         bytes memory data = abi.encode(passportDecoder, thresholdScore);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         GitcoinPassportChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/gitcoin/GitcoinPassportPolicyFactory.sol b/packages/contracts/contracts/extensions/gitcoin/GitcoinPassportPolicyFactory.sol
@@ -14,10 +14,11 @@ contract GitcoinPassportPolicyFactory is Factory {
     /// @notice Deploys a new GitcoinPassportPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed GitcoinPassportPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         GitcoinPassportPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/hats/HatsCheckerFactory.sol b/packages/contracts/contracts/extensions/hats/HatsCheckerFactory.sol
@@ -14,9 +14,11 @@ contract HatsCheckerFactory is Factory {
     /// @notice Deploys a new HatsChecker clone.
     /// @param hats The Hats Protocol contract
     /// @param criterionHats Array of accepted criterion hats
-    function deploy(address hats, uint256[] calldata criterionHats) public {
+    /// @return clone The address of the newly deployed HatsChecker clone.
+    function deploy(address hats, uint256[] calldata criterionHats) public returns (address clone) {
         bytes memory data = abi.encode(hats, criterionHats);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         HatsChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/hats/HatsPolicyFactory.sol b/packages/contracts/contracts/extensions/hats/HatsPolicyFactory.sol
@@ -14,10 +14,11 @@ contract HatsPolicyFactory is Factory {
     /// @notice Deploys a new HatsPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed HatsPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         HatsPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/merkle/MerkleProofCheckerFactory.sol b/packages/contracts/contracts/extensions/merkle/MerkleProofCheckerFactory.sol
@@ -13,9 +13,11 @@ contract MerkleProofCheckerFactory is Factory {
 
     /// @notice Deploys a new MerkleProofChecker clone.
     /// @param root The tree root
-    function deploy(bytes32 root) public {
+    /// @return clone The address of the newly deployed MerkleProofChecker clone.
+    function deploy(bytes32 root) public returns (address clone) {
         bytes memory data = abi.encode(root);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         MerkleProofChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/merkle/MerkleProofPolicyFactory.sol b/packages/contracts/contracts/extensions/merkle/MerkleProofPolicyFactory.sol
@@ -14,10 +14,11 @@ contract MerkleProofPolicyFactory is Factory {
     /// @notice Deploys a new MerkleProofPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed MerkleProofPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         MerkleProofPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/semaphore/SemaphoreCheckerFactory.sol b/packages/contracts/contracts/extensions/semaphore/SemaphoreCheckerFactory.sol
@@ -16,9 +16,11 @@ contract SemaphoreCheckerFactory is Factory {
     /// @dev Encodes the Semaphore contract address and group ID as initialization data for the clone.
     /// @param semaphore Address of the Semaphore contract.
     /// @param groupId Unique identifier of the Semaphore group.
-    function deploy(address semaphore, uint256 groupId) public {
+    /// @return clone The address of the newly deployed SemaphoreChecker clone.
+    function deploy(address semaphore, uint256 groupId) public returns (address clone) {
         bytes memory data = abi.encode(semaphore, groupId);
-        address clone = super._deploy(data);
+
+        clone = super._deploy(data);
 
         SemaphoreChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/semaphore/SemaphorePolicyFactory.sol b/packages/contracts/contracts/extensions/semaphore/SemaphorePolicyFactory.sol
@@ -14,10 +14,11 @@ contract SemaphorePolicyFactory is Factory {
     /// @notice Deploys a new SemaphorePolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed SemaphorePolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         SemaphorePolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/token/TokenCheckerFactory.sol b/packages/contracts/contracts/extensions/token/TokenCheckerFactory.sol
@@ -15,9 +15,10 @@ contract TokenCheckerFactory is Factory {
     /// @notice Deploys a new TokenChecker clone with the specified ERC721 token contract.
     /// @dev Encodes the ERC721 token contract address as initialization data for the clone.
     /// @param token Address of the ERC721 token contract.
-    function deploy(address token) public {
+    /// @return clone The address of the newly deployed TokenChecker clone.
+    function deploy(address token) public returns (address clone) {
         bytes memory data = abi.encode(token);
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         TokenChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/token/TokenPolicyFactory.sol b/packages/contracts/contracts/extensions/token/TokenPolicyFactory.sol
@@ -14,10 +14,11 @@ contract TokenPolicyFactory is Factory {
     /// @notice Deploys a new TokenPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param checkerAddress Address of the checker to use for validation.
-    function deploy(address checkerAddress) public {
+    /// @return clone The address of the newly deployed TokenPolicy clone.
+    function deploy(address checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         TokenPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/zupass/ZupassCheckerFactory.sol b/packages/contracts/contracts/extensions/zupass/ZupassCheckerFactory.sol
@@ -16,9 +16,15 @@ contract ZupassCheckerFactory is Factory {
     /// @param signer1 Zupass event signer[0] converted to bigint
     /// @param signer2 Zupass event signer[1] converted to bigint
     /// @param verifier The ZupassGroth16Verifier contract address
-    function deploy(uint256 eventId, uint256 signer1, uint256 signer2, address verifier) public {
+    /// @return clone The address of the newly deployed ZupassChecker clone.
+    function deploy(
+        uint256 eventId,
+        uint256 signer1,
+        uint256 signer2,
+        address verifier
+    ) public returns (address clone) {
         bytes memory data = abi.encode(eventId, signer1, signer2, verifier);
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         ZupassChecker(clone).initialize();
     }
diff --git a/packages/contracts/contracts/extensions/zupass/ZupassPolicyFactory.sol b/packages/contracts/contracts/extensions/zupass/ZupassPolicyFactory.sol
@@ -14,10 +14,11 @@ contract ZupassPolicyFactory is Factory {
     /// @notice Deploys a new ZupassPolicy clone with the specified checker address.
     /// @dev Encodes the checker address and caller as configuration data for the clone.
     /// @param _checkerAddress Address of the checker to use for validation.
-    function deploy(address _checkerAddress) public {
+    /// @return clone The address of the newly deployed ZupassPolicy clone.
+    function deploy(address _checkerAddress) public returns (address clone) {
         bytes memory data = abi.encode(msg.sender, _checkerAddress);
 
-        address clone = super._deploy(data);
+        clone = super._deploy(data);
 
         ZupassPolicy(clone).initialize();
     }
diff --git a/packages/contracts/contracts/interfaces/IPolicyFactory.sol b/packages/contracts/contracts/interfaces/IPolicyFactory.sol
@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+/// @title IPolicyFactory
+/// @notice Interface for policy factory instances.
+/// @dev Provides methods for deploying new policy clones.
+interface IPolicyFactory {
+    /// @notice Deploys a new policy clone.
+    /// @param checkerAddress The address of the checker to use for validation.
+    /// @return clone The address of the newly deployed policy clone.
+    function deploy(address checkerAddress) external returns (address clone);
+}
