Merge pull request #19 from NaniDAO/cattin/immutable-variables

add immutable variables

.gas-snapshot

@@ -3,24 +3,24 @@ AccountTest:testCdFallback2() (gas: 1250652)
 AccountTest:testDelegateExecute() (gas: 405036)
 AccountTest:testDelegateExecute(uint256) (runs: 256, μ: 394834, ~: 384516)
 AccountTest:testDelegateExecuteRevertsIfOwnerSlotValueChanged() (gas: 360183)
-AccountTest:testDepositFunctions() (gas: 533677)
+AccountTest:testDepositFunctions() (gas: 533572)
 AccountTest:testDirectStorage() (gas: 70166)
 AccountTest:testDisableInitializerForImplementation() (gas: 1522237)
 AccountTest:testETHReceived() (gas: 16591)
-AccountTest:testExecute() (gas: 422663)
+AccountTest:testExecute() (gas: 422406)
 AccountTest:testExecuteBatch() (gas: 773653)
-AccountTest:testInitializer() (gas: 1804094)
-AccountTest:testIsValidSignature() (gas: 119393)
-AccountTest:testIsValidSignatureViaPlugin() (gas: 98455)
-AccountTest:testIsValidSignatureViaRPC() (gas: 1040431688)
-AccountTest:testIsValidSignatureWrapped() (gas: 452833)
-AccountTest:testOnERC1155BatchReceived() (gas: 1573496)
-AccountTest:testOnERC1155Received() (gas: 1570864)
-AccountTest:testOnERC721Received() (gas: 1693476)
-AccountTest:testOwnerRecovery() (gas: 516827)
-AccountTest:testSignaturePluginStorage() (gas: 86831)
-AccountTest:testValidateUserOp() (gas: 525722)
-AccountTest:test__codesize() (gas: 67295)
+AccountTest:testInitializer() (gas: 1803889)
+AccountTest:testIsValidSignature() (gas: 119314)
+AccountTest:testIsValidSignatureViaPlugin() (gas: 98376)
+AccountTest:testIsValidSignatureViaRPC() (gas: 1040431685)
+AccountTest:testIsValidSignatureWrapped() (gas: 452620)
+AccountTest:testOnERC1155BatchReceived() (gas: 1491113)
+AccountTest:testOnERC1155Received() (gas: 1490765)
+AccountTest:testOnERC721Received() (gas: 1509738)
+AccountTest:testOwnerRecovery() (gas: 516596)
+AccountTest:testSignaturePluginStorage() (gas: 86434)
+AccountTest:testValidateUserOp() (gas: 525509)
+AccountTest:test__codesize() (gas: 65412)
 AccountsTest:testDeploy() (gas: 1779383)
 AccountsTest:test__codesize() (gas: 10223)
 JointValidatorTest:testDeploy() (gas: 466944)
@@ -43,12 +43,12 @@ PaymentValidatorTest:testFailPaymentPlanInvalidAllowance() (gas: 185331)
 PaymentValidatorTest:testInstall() (gas: 171005)
 PermitValidatorTest:testAddressPermission(address) (runs: 256, μ: 23814, ~: 23814)
 PermitValidatorTest:testBoolPermission(bool) (runs: 256, μ: 22209, ~: 22209)
-PermitValidatorTest:testEnumPermission(uint256) (runs: 256, μ: 27311, ~: 27360)
-PermitValidatorTest:testInstall() (gas: 207712)
-PermitValidatorTest:testTransferPermission(address,uint256,uint256,uint256) (runs: 256, μ: 8652, ~: 3728)
-PermitValidatorTest:testUintPermission(uint256,uint256,uint256) (runs: 256, μ: 6214, ~: 3262)
+PermitValidatorTest:testEnumPermission(uint256) (runs: 256, μ: 27308, ~: 27360)
+PermitValidatorTest:testInstall() (gas: 206920)
+PermitValidatorTest:testTransferPermission(address,uint256,uint256,uint256) (runs: 256, μ: 8559, ~: 3728)
+PermitValidatorTest:testUintPermission(uint256,uint256,uint256) (runs: 256, μ: 6744, ~: 3262)
 PermitValidatorTest:testValuePermission(uint256,uint256) (runs: 256, μ: 20022, ~: 20023)
-PermitValidatorTest:test__codesize() (gas: 48488)
+PermitValidatorTest:test__codesize() (gas: 48102)
 PointsTest:testCheck(uint256) (runs: 256, μ: 31230, ~: 31230)
 PointsTest:testDeploy() (gas: 103095)
 RecoveryValidatorTest:testDeploy() (gas: 1421598)

src/paymasters/NEETH.sol

@@ -5,21 +5,21 @@ import "@solady/src/tokens/ERC20.sol";
 
 /// @notice Simple wrapped ERC4337 implementation with paymaster and yield functions.
 /// @author nani.eth (https://github.com/NaniDAO/accounts/blob/main/src/paymasters/NEETH.sol)
-/// @custom:version 1.1.1
+/// @custom:version 1.2.3
 contract NEETH is ERC20 {
     /// ========================= CONSTANTS ========================= ///
 
     /// @dev The governing DAO address.
     address internal constant DAO = 0xDa000000000000d2885F108500803dfBAaB2f2aA;
 
     /// @dev The Uniswap V3 pool on Arbitrum for swapping between WETH & stETH.
-    address internal constant POOL = 0x35218a1cbaC5Bbc3E57fd9Bd38219D37571b3537;
+    address internal immutable POOL;
 
     /// @dev The WETH contract for wrapping and unwrapping ETH on Arbitrum.
-    address internal constant WETH = 0x82aF49447D8a07e3bd95BD0d56f35241523fBab1;
+    address internal immutable WETH;
 
     /// @dev The yield token contract address (in V1, bridged wrapped stETH).
-    address internal constant YIELD = 0x5979D7b546E38E414F7E9822514be443A4800529;
+    address internal immutable YIELD;
 
     /// @dev A canonical ERC4337 EntryPoint contract for NEETH alpha (0.6).
     address internal constant EP06 = 0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789;
@@ -86,23 +86,25 @@ contract NEETH is ERC20 {
     /// @dev Requires that the caller is the DAO.
     modifier onlyDAO() virtual {
         assembly ("memory-safe") {
-            if iszero(eq(caller(), DAO)) { revert(codesize(), 0x00) }
+            if iszero(eq(caller(), DAO)) { revert(codesize(), codesize()) }
         }
         _;
     }
 
     /// @dev Requires that the caller is the EntryPoint (0.6).
     modifier onlyEntryPoint06() virtual {
+        address ep06 = EP06;
         assembly ("memory-safe") {
-            if iszero(eq(caller(), EP06)) { revert(codesize(), 0x00) }
+            if iszero(eq(caller(), ep06)) { revert(codesize(), codesize()) }
         }
         _;
     }
 
     /// @dev Requires that the caller is the EntryPoint (0.7).
     modifier onlyEntryPoint07() virtual {
+        address ep07 = EP07;
         assembly ("memory-safe") {
-            if iszero(eq(caller(), EP07)) { revert(codesize(), 0x00) }
+            if iszero(eq(caller(), ep07)) { revert(codesize(), codesize()) }
         }
         _;
     }
@@ -122,7 +124,9 @@ contract NEETH is ERC20 {
     /// ======================== CONSTRUCTOR ======================== ///
 
     /// @dev Constructs NEETH.
-    constructor() payable {}
+    constructor(address pool, address weth, address yield) payable {
+        (POOL, WETH, YIELD) = (pool, weth, yield);
+    }
 
     /// ===================== DEPOSIT OPERATIONS ===================== ///
 
@@ -172,11 +176,12 @@ contract NEETH is ERC20 {
 
     /// @dev Fallback `uniswapV3SwapCallback`.
     fallback() external payable virtual {
+        address pool = POOL;
         uint256 amount0Delta;
         int256 amount1Delta;
         bool zeroForOne;
         assembly ("memory-safe") {
-            if iszero(eq(caller(), POOL)) { revert(codesize(), 0x00) }
+            if iszero(eq(caller(), pool)) { revert(codesize(), 0x00) }
             amount0Delta := calldataload(0x4)
             amount1Delta := calldataload(0x24)
             zeroForOne := byte(0, calldataload(0x84))
@@ -191,33 +196,36 @@ contract NEETH is ERC20 {
 
     /// @dev Funds an `amount` of YIELD token (stETH) to pool caller for swap.
     function _transferYieldToken(uint256 amount) internal virtual {
+        address yield = YIELD;
         assembly ("memory-safe") {
             mstore(0x14, caller()) // Store the `pool` argument.
             mstore(0x34, amount) // Store the `amount` argument.
             mstore(0x00, 0xa9059cbb000000000000000000000000) // `transfer(address,uint256)`.
-            pop(call(gas(), YIELD, 0, 0x10, 0x44, codesize(), 0x00))
+            pop(call(gas(), yield, 0, 0x10, 0x44, codesize(), 0x00))
             mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
         }
     }
 
     /// @dev Wraps an `amount` of ETH to WETH and funds pool caller for swap.
     function _wrapETH(uint256 amount) internal virtual {
+        address weth = WETH;
         assembly ("memory-safe") {
-            pop(call(gas(), WETH, amount, codesize(), 0x00, codesize(), 0x00))
+            pop(call(gas(), weth, amount, codesize(), 0x00, codesize(), 0x00))
             mstore(0x14, caller()) // Store the `pool` argument.
             mstore(0x34, amount) // Store the `amount` argument.
             mstore(0x00, 0xa9059cbb000000000000000000000000) // `transfer(address,uint256)`.
-            pop(call(gas(), WETH, 0, 0x10, 0x44, codesize(), 0x00))
+            pop(call(gas(), weth, 0, 0x10, 0x44, codesize(), 0x00))
             mstore(0x34, 0) // Restore the part of the free memory pointer that was overwritten.
         }
     }
 
     /// @dev Unwraps an `amount` of ETH from WETH for return.
     function _unwrapETH(uint256 amount) internal virtual {
+        address weth = WETH;
         assembly ("memory-safe") {
             mstore(0x00, 0x2e1a7d4d) // `withdraw(uint256)`.
             mstore(0x20, amount) // Store the `amount` argument.
-            pop(call(gas(), WETH, 0, 0x1c, 0x24, codesize(), 0x00))
+            pop(call(gas(), weth, 0, 0x1c, 0x24, codesize(), 0x00))
         }
     }
 
@@ -234,8 +242,9 @@ contract NEETH is ERC20 {
     /// @dev ETH receiver fallback.
     /// Only canonical WETH can call.
     receive() external payable virtual {
+        address weth = WETH;
         assembly ("memory-safe") {
-            if iszero(eq(caller(), WETH)) { revert(codesize(), 0x00) }
+            if iszero(eq(caller(), weth)) { revert(codesize(), codesize()) }
         }
     }
 
@@ -247,7 +256,9 @@ contract NEETH is ERC20 {
         bytes32, /*userOpHash*/
         uint256 maxCost
     ) public payable virtual onlyEntryPoint06 returns (bytes memory, uint256) {
-        if (balanceOf(userOp.sender) >= maxCost) return (abi.encode(userOp.sender), 0x00);
+        if (balanceOf(userOp.sender) >= maxCost) {
+            return (abi.encode(userOp.sender), 0x00);
+        }
         return ("", 0x01); // If insufficient NEETH, return fail code and empty context.
     }
 
@@ -257,7 +268,9 @@ contract NEETH is ERC20 {
         bytes32, /*userOpHash*/
         uint256 maxCost
     ) public payable virtual onlyEntryPoint07 returns (bytes memory, uint256) {
-        if (balanceOf(userOp.sender) >= maxCost) return (abi.encode(userOp.sender), 0x00);
+        if (balanceOf(userOp.sender) >= maxCost) {
+            return (abi.encode(userOp.sender), 0x00);
+        }
         return ("", 0x01); // If insufficient NEETH, return fail code and empty context.
     }