Merge branch 'main' of https://github.com/zkemail/zk-email-wallet

package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "test": "yarn workspaces -pt run test",
     "dev-setup": "yarn workspace @email-wallet/circom dev-setup",
-    "prettier": "prettier --write \"packages/contracts/**/*.{js,jsx,ts,tsx,json,sol}\""
+    "prettier": "prettier --write \"packages/contracts/**/*.{js,jsx,ts,tsx,sol}\""
   },
   "workspaces": [
     "packages/*"

packages/circuits/package.json

@@ -3,7 +3,13 @@
   "license": "MIT",
   "version": "1.0.0",
   "scripts": {
-    "build": "mkdir -p build && circom src/account_creation.circom --r1cs --wasm --sym -l ../../node_modules -o ./build && circom src/account_init.circom --r1cs --wasm --sym -l ../../node_modules -o ./build && circom src/account_transport.circom --r1cs --wasm --sym -l ../../node_modules -o ./build && circom src/claim.circom --r1cs --wasm --sym -l ../../node_modules -o ./build && circom src/email_sender.circom --r1cs --wasm --sym -l ../../node_modules -o ./build && circom src/announcement.circom --r1cs --wasm --sym -l ../../node_modules -o ./build",
+    "build": "mkdir -p build && yarn build-account-creation && yarn build-account-init && yarn build-account-transport && yarn build-claim && yarn build-email-sender",
+    "build-account-creation": "mkdir -p build/account_creation && circom src/account_creation.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/account_creation",
+    "build-account-init": "mkdir -p build/account_init && circom src/account_init.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/account_init",
+    "build-account-transport": "mkdir -p build/account_transport && circom src/account_transport.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/account_transport",
+    "build-claim": "mkdir -p build/claim && circom src/claim.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/claim",
+    "build-email-sender": "mkdir -p build/email_sender && circom src/email_sender.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/email_sender",
+    "build-announcement": "mkdir -p build/announcement && circom src/announcement.circom --r1cs --wasm --sym -l ../../node_modules -o ./build/announcement",
     "dev-setup": "NODE_OPTIONS=--max_old_space_size=8192 npx ts-node scripts/dev-setup.ts --output ./build",
     "gen-account-creation-input": "NODE_OPTIONS=--max_old_space_size=8192 npx ts-node scripts/account_creation.ts",
     "gen-account-init-input": "NODE_OPTIONS=--max_old_space_size=8192 npx ts-node scripts/account_init.ts",
@@ -52,4 +58,4 @@
       ]
     ]
   }
-}
+}

packages/contracts/script/DeployEmailWallet.s.sol

@@ -113,12 +113,35 @@ contract Deploy is Script {
             address(core),
             tokenRegistry,
             uniswapV3Router,
-            0x1F98431c8aD98523631AE4a59f267346ea31F984	
+            0x1F98431c8aD98523631AE4a59f267346ea31F984
         );
         uniswapExtTemplates[0] = ["Swap", "{tokenAmount}", "to", "{string}"];
         uniswapExtTemplates[1] = ["Swap", "{tokenAmount}", "to", "{string}", "with", "{amount}", "slippage"];
-        uniswapExtTemplates[2] = ["Swap", "{tokenAmount}", "to", "{string}", "under", "{uint}", "sqrt", "price", "limit"];
-        uniswapExtTemplates[3] = ["Swap", "{tokenAmount}", "to", "{string}", "with", "{amount}", "slippage", "under", "{uint}", "sqrt", "price", "limit"];
+        uniswapExtTemplates[2] = [
+            "Swap",
+            "{tokenAmount}",
+            "to",
+            "{string}",
+            "under",
+            "{uint}",
+            "sqrt",
+            "price",
+            "limit"
+        ];
+        uniswapExtTemplates[3] = [
+            "Swap",
+            "{tokenAmount}",
+            "to",
+            "{string}",
+            "with",
+            "{amount}",
+            "slippage",
+            "under",
+            "{uint}",
+            "sqrt",
+            "price",
+            "limit"
+        ];
 
         defaultExtensions[1] = abi.encode("UniswapExtension", address(uniExt), uniswapExtTemplates, 0.001 ether); // TODO: Check max exec gas
 

packages/contracts/script/SetChainOfTokenRegistry.s.sol

@@ -13,7 +13,7 @@ contract Deploy is Script {
             return;
         }
         address _tokenRegistry = vm.envAddress("TOKEN_REGISTRY");
-        if(_tokenRegistry == address(0)) {
+        if (_tokenRegistry == address(0)) {
             console.log("TOKEN_REGISTRY env var not set");
             return;
         }

packages/contracts/script/SetTokenOfNFTExtension.sol

@@ -13,7 +13,7 @@ contract Deploy is Script {
             return;
         }
         address _nftExtension = vm.envAddress("NFT_EXTENSION");
-        if(_nftExtension == address(0)) {
+        if (_nftExtension == address(0)) {
             console.log("NFT_EXTENSION env var not set");
             return;
         }
@@ -23,6 +23,5 @@ contract Deploy is Script {
         NFTExtension nftExtension = NFTExtension(_nftExtension);
         nftExtension.setNFTAddress(tokenName, tokenAddr);
         vm.stopBroadcast();
-
     }
 }

packages/contracts/script/SetTokenOfTokenRegistry.s.sol

@@ -13,7 +13,7 @@ contract Deploy is Script {
             return;
         }
         address _tokenRegistry = vm.envAddress("TOKEN_REGISTRY");
-        if(_tokenRegistry == address(0)) {
+        if (_tokenRegistry == address(0)) {
             console.log("TOKEN_REGISTRY env var not set");
             return;
         }

packages/contracts/src/EmailWalletCore.sol

@@ -232,7 +232,10 @@ contract EmailWalletCore {
         }
         // Return whatever ETH was sent in case unclaimed fund/state registration didnt happen
         else {
-            require(currContext.registeredUnclaimId == 0, "registeredUnclaimId must be zero if no unclaimed fund/state is registered");
+            require(
+                currContext.registeredUnclaimId == 0,
+                "registeredUnclaimId must be zero if no unclaimed fund/state is registered"
+            );
             payable(msg.sender).transfer(msg.value);
         }
 
@@ -246,7 +249,7 @@ contract EmailWalletCore {
 
         if (feeAmountInToken > 0) {
             address feeToken = tokenRegistry.getTokenAddress(emailOp.feeTokenName);
-            
+
             (bool transferSuccess, bytes memory transferErr) = _transferERC20FromUserWallet(
                 currContext.walletAddr,
                 msg.sender,
@@ -265,7 +268,15 @@ contract EmailWalletCore {
         currContext.registeredUnclaimId = 0;
         delete currContext.tokenAllowances;
 
-        emit EmailWalletEvents.EmailOpHandled(success, registeredUnclaimId, emailOp.emailNullifier, emailOp.emailAddrPointer, emailOp.recipientEmailAddrCommit, emailOp.recipientETHAddr, err);
+        emit EmailWalletEvents.EmailOpHandled(
+            success,
+            registeredUnclaimId,
+            emailOp.emailNullifier,
+            emailOp.emailAddrPointer,
+            emailOp.recipientEmailAddrCommit,
+            emailOp.recipientETHAddr,
+            err
+        );
     }
 
     /// For extension in context to register Unclaimed State during handleEmailOp

packages/contracts/src/extensions/PoolFinder.sol

@@ -11,18 +11,25 @@ contract PoolFinder {
         factory = _factory;
     }
 
-    function getPoolSlot0(address tokenA, address tokenB, uint24 fee) external view returns (
-        uint160 sqrtPriceX96,
-        int24 tick,
-        uint16 observationIndex,
-        uint16 observationCardinality,
-        uint16 observationCardinalityNext,
-        uint8 feeProtocol,
-        bool unlocked
-    ) {
+    function getPoolSlot0(
+        address tokenA,
+        address tokenB,
+        uint24 fee
+    )
+        external
+        view
+        returns (
+            uint160 sqrtPriceX96,
+            int24 tick,
+            uint16 observationIndex,
+            uint16 observationCardinality,
+            uint16 observationCardinalityNext,
+            uint8 feeProtocol,
+            bool unlocked
+        )
+    {
         address poolAddress = factory.getPool(tokenA, tokenB, fee);
         require(poolAddress != address(0), "Pool not found");
         return IUniswapV3Pool(poolAddress).slot0();
     }
-
 }

packages/contracts/src/extensions/UniswapExtension.sol

@@ -37,7 +37,20 @@ contract UniswapExtension is Extension {
         templates[0] = ["Swap", "{tokenAmount}", "to", "{string}"];
         templates[1] = ["Swap", "{tokenAmount}", "to", "{string}", "with", "{amount}", "slippage"];
         templates[2] = ["Swap", "{tokenAmount}", "to", "{string}", "under", "{uint}", "sqrt", "price", "limit"];
-        templates[3] = ["Swap", "{tokenAmount}", "to", "{string}", "with", "{amount}", "slippage", "under", "{uint}", "sqrt", "price", "limit"];
+        templates[3] = [
+            "Swap",
+            "{tokenAmount}",
+            "to",
+            "{string}",
+            "with",
+            "{amount}",
+            "slippage",
+            "under",
+            "{uint}",
+            "sqrt",
+            "price",
+            "limit"
+        ];
         poolFinder = new PoolFinder(IUniswapV3Factory(_factory));
     }
 
@@ -74,12 +87,12 @@ contract UniswapExtension is Extension {
             slippagePoints = defaultSlippagePoints;
 
             sqrtPriceLimitX96 = 0;
-        } 
+        }
 
         if (templateIndex == 1) {
             uint256 slippagePoints256 = abi.decode(subjectParams[2], (uint256));
             // This value is user input * 10^18, we need to revert it as (user input * 10^2).
-            slippagePoints256 = slippagePoints256 / 10**16; 
+            slippagePoints256 = slippagePoints256 / 10 ** 16;
             require(slippagePoints256 <= type(uint24).max, "slippagePoints256 argument overflow detected");
             slippagePoints = uint24(slippagePoints256);
 
@@ -98,7 +111,7 @@ contract UniswapExtension is Extension {
         if (templateIndex == 3) {
             uint256 slippagePoints256 = abi.decode(subjectParams[2], (uint256));
             // This value is user input * 10^18, we need to revert it as (user input * 10^2).
-            slippagePoints256 = slippagePoints256 / 10**16; 
+            slippagePoints256 = slippagePoints256 / 10 ** 16;
             require(slippagePoints256 <= type(uint24).max, "slippagePoints256 argument overflow detected");
             slippagePoints = uint24(slippagePoints256);
 
@@ -146,11 +159,7 @@ contract UniswapExtension is Extension {
                 deadline: block.timestamp,
                 amountIn: wethAmount,
                 amountOutMinimum: 0,
-                sqrtPriceLimitX96: getSqrtPriceLimitX96(
-                    wethAddr, 
-                    tokenOutAddr, 
-                    slippagePoints, 
-                    sqrtPriceLimitX96)
+                sqrtPriceLimitX96: getSqrtPriceLimitX96(wethAddr, tokenOutAddr, slippagePoints, sqrtPriceLimitX96)
             });
             router.exactInputSingle(swapParams2);
         } else {
@@ -162,11 +171,7 @@ contract UniswapExtension is Extension {
                 deadline: block.timestamp,
                 amountIn: tokenInAmount,
                 amountOutMinimum: 0,
-                sqrtPriceLimitX96: getSqrtPriceLimitX96(
-                    tokenInAddr, 
-                    tokenOutAddr, 
-                    slippagePoints, 
-                    sqrtPriceLimitX96)
+                sqrtPriceLimitX96: getSqrtPriceLimitX96(tokenInAddr, tokenOutAddr, slippagePoints, sqrtPriceLimitX96)
             });
             router.exactInputSingle(swapParams);
         }
@@ -189,7 +194,7 @@ contract UniswapExtension is Extension {
         bool zeroForOne = tokenIn < tokenOut;
 
         (uint160 sqrtPriceX96, , , , , , ) = poolFinder.getPoolSlot0(tokenIn, tokenOut, poolFee);
-        
+
         if (sqrtPriceLimitX96 == 0) {
             sqrtPriceLimitX96 = sqrtPriceX96;
         }

packages/contracts/src/handlers/AccountHandler.sol

@@ -101,6 +101,7 @@ contract AccountHandler is Ownable {
     /// @param emailAddrPointer hash(relayerRand, emailAddr)
     /// @param emailDomain domain name of the sender's email
     /// @param emailNullifier nullifier of the email used for proof generation
+    /// @param dkimPublicKeyHash DKIM public key hash of the email domain used in the proof generation
     /// @param proof ZK proof as required by the verifier
     function initializeAccount(
         bytes32 emailAddrPointer,

packages/contracts/src/handlers/UnclaimsHandler.sol

@@ -99,8 +99,17 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         });
 
         unclaimedFundOfId[fund.id] = fund;
-        numUnclaimedFunds ++;
-        emit EmailWalletEvents.UnclaimedFundRegistered(fund.id, emailAddrCommit, tokenAddr, amount, sender, expiryTime, 0, "");
+        numUnclaimedFunds++;
+        emit EmailWalletEvents.UnclaimedFundRegistered(
+            fund.id,
+            emailAddrCommit,
+            tokenAddr,
+            amount,
+            sender,
+            expiryTime,
+            0,
+            ""
+        );
         return fund.id;
     }
 
@@ -146,7 +155,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         });
 
         unclaimedFundOfId[fund.id] = fund;
-        numUnclaimedFunds ++;
+        numUnclaimedFunds++;
         emit EmailWalletEvents.UnclaimedFundRegistered(
             fund.id,
             emailAddrCommit,
@@ -200,7 +209,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
             ),
             "invalid proof"
         );
-        
+
         address recipientAddr = accountHandler.getWalletOfSalt(
             accountHandler.getInfoOfAccountKeyCommit(accountKeyCommit).walletSalt
         );
@@ -213,7 +222,13 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         // Transfer claim fee to the sender (relayer)
         payable(msg.sender).transfer(unclaimedFundClaimGas * maxFeePerGas);
 
-        emit EmailWalletEvents.UnclaimedFundClaimed(id, fund.emailAddrCommit, fund.tokenAddr, fund.amount, recipientAddr);
+        emit EmailWalletEvents.UnclaimedFundClaimed(
+            id,
+            fund.emailAddrCommit,
+            fund.tokenAddr,
+            fund.amount,
+            recipientAddr
+        );
     }
 
     /// @notice Return unclaimed fund after expiry time
@@ -258,7 +273,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         uint256 expiryTime,
         uint256 announceCommitRandomness,
         string calldata announceEmailAddr
-    ) public payable returns (uint256){
+    ) public payable returns (uint256) {
         if (expiryTime == 0) {
             expiryTime = block.timestamp + unclaimsExpiryDuration;
         }
@@ -283,8 +298,8 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         Extension extension = Extension(extensionAddr);
 
         unclaimedStateOfId[us.id] = us;
-        numUnclaimedStates ++;
-    
+        numUnclaimedStates++;
+
         try extension.registerUnclaimedState(us, false) {} catch Error(string memory reason) {
             revert(string.concat("unclaimed state reg err: ", reason));
         } catch {
@@ -318,10 +333,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         bytes calldata state,
         bool isInternal
     ) public onlyOwner returns (uint256) {
-        require(
-            unclaimedStateOfId[numUnclaimedStates].sender == address(0),
-            "unclaimed state exists"
-        );
+        require(unclaimedStateOfId[numUnclaimedStates].sender == address(0), "unclaimed state exists");
         require(state.length > 0, "state cannot be empty");
 
         uint256 expiryTime = block.timestamp + unclaimsExpiryDuration;
@@ -338,7 +350,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         Extension extension = Extension(extensionAddr);
 
         unclaimedStateOfId[us.id] = us;
-        numUnclaimedStates ++;
+        numUnclaimedStates++;
 
         try extension.registerUnclaimedState(us, isInternal) {} catch Error(string memory reason) {
             revert(string.concat("unclaimed state reg err: ", reason));
@@ -410,7 +422,8 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
 
         // Deducated consumed gas + 21k for eth transer from `unclaimedStateClaimGas` + gas to store one value and pass to extension
         uint256 gasForExt = unclaimedStateClaimGas - (initialGas - gasleft()) - ETH_TRANSFER_GAS;
-        require(gasleft() > gasForExt, "insufficient gas left");
+        require(gasleft() * 63 > gasForExt * 64, "insufficient gas left");
+
         // Relayer should get claim fee (gas reimbursement) even if extension call fails
         // Simulation wont work, as extension logic will depend on global variables
         try extension.claimUnclaimedState{gas: gasForExt}(us, recipientAddr) {
@@ -430,9 +443,7 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
 
     /// @notice Return unclaimed state after expiry time
     /// @param id The id of the unclaimed state to claim.
-    function voidUnclaimedState(
-        uint256 id
-    ) public nonReentrant returns (bool success, bytes memory returnData) {
+    function voidUnclaimedState(uint256 id) public nonReentrant returns (bool success, bytes memory returnData) {
         uint256 initialGas = gasleft();
         require(id < numUnclaimedStates, "invalid id");
 
@@ -448,7 +459,8 @@ contract UnclaimsHandler is ReentrancyGuard, Ownable {
         // Gas consumed for verification and next steps is deducated from `unclaimedStateClaimGas`
         // and rest is passed to extension
         uint256 gasForExt = unclaimedStateClaimGas - (initialGas - gasleft()) - ETH_TRANSFER_GAS - WETH_DEPOSIT_GAS;
-        require(gasleft() > gasForExt, "insufficient gas left");
+        require(gasleft() * 63 > gasForExt * 64, "insufficient gas left");
+
         // Callee should get gas reimbursement even if extension call fails
         // Simulation wont work, as extension logic can depend on global variables
         try extension.voidUnclaimedState{gas: gasForExt}(us) {