Merge pull request #5719 from ethereum-optimism/harry/update-faucet-contract

feat(ctp): Change the type on the auth id field of the Faucet contract to bytes32

.changeset/strange-bugs-talk.md

+---
+'@eth-optimism/contracts-periphery': patch
+---
+
+Change type for auth id on Faucet contracts from bytes to bytes32

packages/contracts-periphery/contracts/foundry-tests/AdminFaucetAuthModule.t.sol

@@ -80,7 +80,7 @@ contract AdminFaucetAuthModuleTest is Test {
         uint256 _eip712Chainid,
         address _eip712VerifyingContract,
         address recipient,
-        bytes memory id,
+        bytes32 id,
         bytes32 nonce
     ) internal view returns (bytes memory) {
         AdminFaucetAuthModule.Proof memory proof = AdminFaucetAuthModule.Proof(
@@ -114,7 +114,7 @@ contract AdminFaucetAuthModuleTest is Test {
             block.chainid,
             address(adminFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -122,7 +122,7 @@ contract AdminFaucetAuthModuleTest is Test {
         assertEq(
             adminFam.verify(
                 Faucet.DripParameters(payable(fundsReceiver), nonce),
-                abi.encodePacked(fundsReceiver),
+                keccak256(abi.encodePacked(fundsReceiver)),
                 proof
             ),
             true
@@ -142,7 +142,7 @@ contract AdminFaucetAuthModuleTest is Test {
             block.chainid,
             address(adminFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -150,7 +150,7 @@ contract AdminFaucetAuthModuleTest is Test {
         assertEq(
             adminFam.verify(
                 Faucet.DripParameters(payable(fundsReceiver), nonce),
-                abi.encodePacked(fundsReceiver),
+                keccak256(abi.encodePacked(fundsReceiver)),
                 proof
             ),
             false
@@ -172,7 +172,7 @@ contract AdminFaucetAuthModuleTest is Test {
             block.chainid,
             address(adminFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -180,7 +180,7 @@ contract AdminFaucetAuthModuleTest is Test {
         assertEq(
             adminFam.verify(
                 Faucet.DripParameters(payable(fundsReceiver), nonce),
-                abi.encodePacked(randomAddress),
+                keccak256(abi.encodePacked(randomAddress)),
                 proof
             ),
             false

packages/contracts-periphery/contracts/foundry-tests/Faucet.t.sol

@@ -9,7 +9,7 @@ import { FaucetHelper } from "../testing/helpers/FaucetHelper.sol";
 contract Faucet_Initializer is Test {
     event Drip(
         string indexed authModule,
-        bytes indexed userId,
+        bytes32 indexed userId,
         uint256 amount,
         address indexed recipient
     );
@@ -103,7 +103,7 @@ contract Faucet_Initializer is Test {
         uint256 _eip712Chainid,
         address _eip712VerifyingContract,
         address recipient,
-        bytes memory id,
+        bytes32 id,
         bytes32 nonce
     ) internal view returns (bytes memory) {
         AdminFaucetAuthModule.Proof memory proof = AdminFaucetAuthModule.Proof(
@@ -140,14 +140,18 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(optimistNftFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
         vm.prank(nonAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(optimistNftFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(
+                optimistNftFam,
+                keccak256(abi.encodePacked(fundsReceiver)),
+                signature
+            )
         );
     }
 
@@ -161,7 +165,7 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(optimistNftFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -169,7 +173,11 @@ contract FaucetTest is Faucet_Initializer {
         vm.expectRevert("Faucet: drip parameters could not be verified by security module");
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(optimistNftFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(
+                optimistNftFam,
+                keccak256(abi.encodePacked(fundsReceiver)),
+                signature
+            )
         );
     }
 
@@ -183,7 +191,7 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(optimistNftFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -191,7 +199,11 @@ contract FaucetTest is Faucet_Initializer {
         vm.prank(nonAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(optimistNftFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(
+                optimistNftFam,
+                keccak256(abi.encodePacked(fundsReceiver)),
+                signature
+            )
         );
         uint256 recipientBalanceAfter = address(fundsReceiver).balance;
         assertEq(
@@ -211,7 +223,7 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
@@ -219,7 +231,7 @@ contract FaucetTest is Faucet_Initializer {
         vm.prank(nonAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
         uint256 recipientBalanceAfter = address(fundsReceiver).balance;
         assertEq(
@@ -239,17 +251,22 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
         vm.expectEmit(true, true, true, true, address(faucet));
-        emit Drip("GithubModule", abi.encodePacked(fundsReceiver), .05 ether, fundsReceiver);
+        emit Drip(
+            "GithubModule",
+            keccak256(abi.encodePacked(fundsReceiver)),
+            .05 ether,
+            fundsReceiver
+        );
 
         vm.prank(nonAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
     }
 
@@ -263,14 +280,14 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
         vm.startPrank(faucetContractAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
 
         faucet.configure(githubFam, Faucet.ModuleConfig("GithubModule", false, 1 days, .05 ether));
@@ -278,7 +295,7 @@ contract FaucetTest is Faucet_Initializer {
         vm.expectRevert("Faucet: provided auth module is not supported by this faucet");
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
         vm.stopPrank();
     }
@@ -293,20 +310,20 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce
         );
 
         vm.startPrank(faucetContractAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
 
         vm.expectRevert("Faucet: nonce has already been used");
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature)
         );
         vm.stopPrank();
     }
@@ -321,14 +338,14 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce0
         );
 
         vm.startPrank(faucetContractAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce0),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature0)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature0)
         );
 
         bytes32 nonce1 = faucetHelper.consumeNonce();
@@ -339,14 +356,14 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce1
         );
 
         vm.expectRevert("Faucet: auth cannot be used yet because timeout has not elapsed");
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce1),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature1)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature1)
         );
         vm.stopPrank();
     }
@@ -361,14 +378,14 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce0
         );
 
         vm.startPrank(faucetContractAdmin);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce0),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature0)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature0)
         );
 
         bytes32 nonce1 = faucetHelper.consumeNonce();
@@ -379,14 +396,14 @@ contract FaucetTest is Faucet_Initializer {
             block.chainid,
             address(githubFam),
             fundsReceiver,
-            abi.encodePacked(fundsReceiver),
+            keccak256(abi.encodePacked(fundsReceiver)),
             nonce1
         );
 
         vm.warp(startingTimestamp + 1 days + 1 seconds);
         faucet.drip(
             Faucet.DripParameters(payable(fundsReceiver), nonce1),
-            Faucet.AuthParameters(githubFam, abi.encodePacked(fundsReceiver), signature1)
+            Faucet.AuthParameters(githubFam, keccak256(abi.encodePacked(fundsReceiver)), signature1)
         );
         vm.stopPrank();
     }

packages/contracts-periphery/contracts/testing/helpers/FaucetHelper.sol

@@ -16,7 +16,7 @@ contract FaucetHelper {
      * @notice EIP712 typehash for the Proof type.
      */
     bytes32 public constant PROOF_TYPEHASH =
-        keccak256("Proof(address recipient,bytes32 nonce,bytes id)");
+        keccak256("Proof(address recipient,bytes32 nonce,bytes32 id)");
 
     /**
      * @notice EIP712 typehash for the EIP712Domain type that is included as part of the signature.

packages/contracts-periphery/contracts/universal/faucet/Faucet.sol

@@ -31,7 +31,7 @@ contract Faucet {
      */
     event Drip(
         string indexed authModule,
-        bytes indexed userId,
+        bytes32 indexed userId,
         uint256 amount,
         address indexed recipient
     );
@@ -49,7 +49,7 @@ contract Faucet {
      */
     struct AuthParameters {
         IFaucetAuthModule module;
-        bytes id;
+        bytes32 id;
         bytes proof;
     }
 
@@ -76,12 +76,12 @@ contract Faucet {
     /**
      * @notice Mapping of authentication IDs to the next timestamp at which they can be used.
      */
-    mapping(IFaucetAuthModule => mapping(bytes => uint256)) public timeouts;
+    mapping(IFaucetAuthModule => mapping(bytes32 => uint256)) public timeouts;
 
     /**
      * @notice Maps from id to nonces to whether or not they have been used.
      */
-    mapping(bytes => mapping(bytes32 => bool)) public nonces;
+    mapping(bytes32 => mapping(bytes32 => bool)) public nonces;
 
     /**
      * @notice Modifier that makes a function admin priviledged.

packages/contracts-periphery/contracts/universal/faucet/authmodules/AdminFaucetAuthModule.sol

@@ -21,7 +21,7 @@ contract AdminFaucetAuthModule is IFaucetAuthModule, EIP712 {
      * @notice EIP712 typehash for the Proof type.
      */
     bytes32 public constant PROOF_TYPEHASH =
-        keccak256("Proof(address recipient,bytes32 nonce,bytes id)");
+        keccak256("Proof(address recipient,bytes32 nonce,bytes32 id)");
 
     /**
      * @notice Struct that represents a proof that verifies the admin.
@@ -33,7 +33,7 @@ contract AdminFaucetAuthModule is IFaucetAuthModule, EIP712 {
     struct Proof {
         address recipient;
         bytes32 nonce;
-        bytes id;
+        bytes32 id;
     }
 
     /**
@@ -54,7 +54,7 @@ contract AdminFaucetAuthModule is IFaucetAuthModule, EIP712 {
      */
     function verify(
         Faucet.DripParameters memory _params,
-        bytes memory _id,
+        bytes32 _id,
         bytes memory _proof
     ) external view returns (bool) {
         // Generate a EIP712 typed data hash to compare against the proof.

packages/contracts-periphery/contracts/universal/faucet/authmodules/IFaucetAuthModule.sol

@@ -17,7 +17,7 @@ interface IFaucetAuthModule {
      */
     function verify(
         Faucet.DripParameters memory _params,
-        bytes memory _id,
+        bytes32 _id,
         bytes memory _proof
     ) external view returns (bool);
 }