Gasless flow Permit2Proxy (v1.0.0) [Permit2Proxy v1.0.0]

.gitmodules

@@ -22,3 +22,6 @@
 [submodule "lib/solady"]
 	path = lib/solady
 	url = https://github.com/Vectorized/solady
+[submodule "lib/Permit2"]
+	path = lib/Permit2
+	url = https://github.com/Uniswap/Permit2

audit/auditLog.json

@@ -34,19 +34,29 @@
       "auditorGitHandle": "sujithsomraaj",
       "auditReportPath": "./audit/reports/2024.11.05_EmergencyPauseFacet_ReAudit.pdf",
       "auditCommitHash": "da61880ba3847c07c35b64a78b957ff845ec18ac"
+    },
+    "audit20241122": {
+      "auditCompletedOn": "22.11.2024",
+      "auditedBy": "Sujith Somraaj (individual security researcher)",
+      "auditorGitHandle": "sujithsomraaj",
+      "auditReportPath": "./audit/reports/2024.11.22_Permit2Proxy.pdf",
+      "auditCommitHash": "0e3debb78abcdf9a9f934115338b611e16b039a0"
     }
   },
   "auditedContracts": {
-    "EmergencyPauseFacet": {
-      "1.0.0": ["audit20240913"],
-      "1.0.1": ["audit20241105"]
-    },
     "AcrossFacetV3": {
       "1.0.0": ["audit20241007"]
     },
     "AcrossFacetPackedV3": {
       "1.0.0": ["audit20241007"]
     },
+    "EmergencyPauseFacet": {
+      "1.0.0": ["audit20240913"],
+      "1.0.1": ["audit20241105"]
+    },
+    "Permit2Proxy": {
+      "1.0.0": ["audit20241122"]
+    },
     "ReceiverAcrossV3": {
       "1.0.0": ["audit20241007"]
     },

config/permit2Proxy.json

@@ -0,0 +1,31 @@
+{
+  "mainnet": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "arbitrum": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "aurora": "",
+  "avalanche": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "base": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "blast": "0x000000000022d473030f116ddee9f6b43ac78ba3",
+  "boba": "",
+  "bsc": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "celo": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "fantom": "",
+  "fraxtal": "",
+  "fuse": "",
+  "gnosis": "",
+  "gravity": "",
+  "immutablezkevm": "",
+  "linea": "",
+  "mantle": "",
+  "metis": "",
+  "mode": "",
+  "moonbeam": "",
+  "moonriver": "",
+  "optimism": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "polygon": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
+  "polygonzkevm": "",
+  "rootstock": "",
+  "scroll": "",
+  "sei": "",
+  "taiko": "",
+  "zksync": "0x0000000000225e31d15943971f47ad3022f714fa"
+}

deployments/_deployments_log_file.json

@@ -24602,5 +24602,73 @@
         ]
       }
     }
+  },
+  "Permit2Proxy": {
+    "arbitrum": {
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x6FC01BC9Ff6Cdab694Ec8Ca41B21a2F04C8c37E5",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-10-21 09:31:13",
+            "CONSTRUCTOR_ARGS": "0x000000000000000000000000d3b2b0ac0afdd0d166a495f5e9fca4ecc715a782000000000000000000000000000000000022d473030f116ddee9f6b43ac78ba30000000000000000000000009e606d0d2bba344b911e2f4eab95d9235a83fe15",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      },
+      "production": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-10-14 06:57:18",
+            "CONSTRUCTOR_ARGS": "0x0000000000000000000000001231deb6f5749ef6ce6943a275a1d3e7486f4eae000000000000000000000000000000000022d473030f116ddee9f6b43ac78ba30000000000000000000000009e606d0d2bba344b911e2f4eab95d9235a83fe15",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    },
+    "polygon": {
+      "production": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-10-14 06:55:51",
+            "CONSTRUCTOR_ARGS": "0x0000000000000000000000001231deb6f5749ef6ce6943a275a1d3e7486f4eae000000000000000000000000000000000022d473030f116ddee9f6b43ac78ba30000000000000000000000008bcc385948c73736423d38cc567cfede0f1826a3",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      },
+      "staging": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x6FC01BC9Ff6Cdab694Ec8Ca41B21a2F04C8c37E5",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-10-21 09:32:45",
+            "CONSTRUCTOR_ARGS": "0x000000000000000000000000d3b2b0ac0afdd0d166a495f5e9fca4ecc715a782000000000000000000000000000000000022d473030f116ddee9f6b43ac78ba30000000000000000000000008bcc385948c73736423d38cc567cfede0f1826a3",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    },
+    "optimism": {
+      "production": {
+        "1.0.0": [
+          {
+            "ADDRESS": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE",
+            "OPTIMIZER_RUNS": "1000000",
+            "TIMESTAMP": "2024-10-14 06:58:45",
+            "CONSTRUCTOR_ARGS": "0x0000000000000000000000001231deb6f5749ef6ce6943a275a1d3e7486f4eae000000000000000000000000000000000022d473030f116ddee9f6b43ac78ba3000000000000000000000000a8892ea3fddef2aa8afb1e3643a3284f978a5114",
+            "SALT": "",
+            "VERIFIED": "true"
+          }
+        ]
+      }
+    }
   }
 }

deployments/arbitrum.diamond.json

@@ -159,4 +159,4 @@
       "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d"
     }
   }
-}
+}

deployments/arbitrum.json

@@ -48,6 +48,7 @@
   "StargateFacetV2": "0x6e378C84e657C57b2a8d183CFf30ee5CC8989b61",
   "ReceiverStargateV2": "0x1493e7B8d4DfADe0a178dAD9335470337A3a219A",
   "LiFiDEXAggregator": "0x6140b987d6B51Fd75b66C3B07733Beb5167c42fc",
+  "Permit2Proxy": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE",
   "EmergencyPauseFacet": "0x6F2baA7cd5F156CA1B132F7FF11E0fa2aD775F61",
   "AcrossFacetV3": "0x6e00e0a7685Ca22c288d56D9E7924746B5043Ee7",
   "ReceiverAcrossV3": "0xB9CEc304899037E661F49DdFa7f64943b5920072",

deployments/arbitrum.staging.json

@@ -46,6 +46,7 @@
   "LiFuelFeeCollector": "0x94EA56D8049e93E0308B9c7d1418Baf6A7C68280",
   "TokenWrapper": "0xF63b27AE2Dc887b88f82E2Cc597d07fBB2E78E70",
   "EmergencyPauseFacet": "0x17Bb203F42d8e404ac7E8dB6ff972B7E8473850b",
+  "Permit2Proxy": "0x6FC01BC9Ff6Cdab694Ec8Ca41B21a2F04C8c37E5",
   "AcrossFacetV3": "0x6124C65B6264bE13f059b7C3A891a5b77DA8Bd95",
   "ReceiverAcrossV3": "0x3877f47B560819E96BBD7e7700a02dfACe36D696",
   "AcrossFacetPackedV3": "0x4352459F6BE1C7D1278F8c34Bb598b0feeB50f8b"

deployments/optimism.diamond.json

@@ -156,7 +156,8 @@
       "ReceiverAcrossV3": "0xB9CEc304899037E661F49DdFa7f64943b5920072",
       "ReceiverStargateV2": "0x1493e7B8d4DfADe0a178dAD9335470337A3a219A",
       "RelayerCelerIM": "0x6a8b11bF29C0546991DEcD6E0Db8cC7Fda22bA97",
-      "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d"
+      "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d",
+      "Permit2Proxy": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE"
     }
   }
-}
+}

deployments/optimism.json

@@ -47,6 +47,7 @@
   "StargateFacetV2": "0x6e378C84e657C57b2a8d183CFf30ee5CC8989b61",
   "ReceiverStargateV2": "0x1493e7B8d4DfADe0a178dAD9335470337A3a219A",
   "LiFiDEXAggregator": "0x6140b987d6B51Fd75b66C3B07733Beb5167c42fc",
+  "Permit2Proxy": "0x5c6e208468213999CB0Be4bAB6d1492c3139A4EE",
   "EmergencyPauseFacet": "0x6F2baA7cd5F156CA1B132F7FF11E0fa2aD775F61",
   "AcrossFacetV3": "0x6e00e0a7685Ca22c288d56D9E7924746B5043Ee7",
   "ReceiverAcrossV3": "0xB9CEc304899037E661F49DdFa7f64943b5920072",

deployments/polygon.diamond.json

@@ -159,4 +159,4 @@
       "TokenWrapper": "0x5215E9fd223BC909083fbdB2860213873046e45d"
     }
   }
-}
+}

deployments/polygon.diamond.staging.json

@@ -136,4 +136,4 @@
       "TokenWrapper": "0xF63b27AE2Dc887b88f82E2Cc597d07fBB2E78E70"
     }
   }
-}
+}

deployments/polygon.staging.json

@@ -46,5 +46,6 @@
   "CelerCircleBridgeFacet": "0x371E073f6A09DCBEE1D2Ac56E940F878a0Ba9DAE",
   "HopFacetOptimized": "0xf82135385765f1324257ffF74489F16382EBBb8A",
   "SymbiosisFacet": "0x21571D628B0bCBeb954D5933A604eCac35bAF2c7",
-  "AcrossFacetV3": "0xe2e5428F972d9C0a5Ba433e0c402752b472dB248"
+  "AcrossFacetV3": "0xe2e5428F972d9C0a5Ba433e0c402752b472dB248",
+  "Permit2Proxy": "0x6FC01BC9Ff6Cdab694Ec8Ca41B21a2F04C8c37E5"
 }

docs/Permit2Proxy.md

@@ -0,0 +1,126 @@
+# Permit2 Proxy
+
+## Description
+
+Periphery contract which enables gasless and semi-gasless transaction flows
+enabled through ERC20 Permit and Uniswap's Permit2
+
+## How To Use
+
+The contract has a number of methods for making gasless and semi-gasless calls
+as well as a few helpful utility methods.
+
+The following methods are available:
+
+This method is used to execute a transaction where the approval is granted
+using an ERC20 Permit signature. It can only be called by the signer in order
+to prevent front-running attacks.
+
+```solidity
+/// @notice Allows to bridge tokens through a LI.FI diamond contract using
+/// an EIP2612 gasless permit (only works with tokenAddresses that
+/// implement EIP2612) (in contrast to Permit2, calldata and diamondAddress
+/// are not signed by the user and could therefore be replaced by the user)
+/// Can only be called by the permit signer to prevent front-running.
+/// @param tokenAddress Address of the token to be bridged
+/// @param amount Amount of tokens to be bridged
+/// @param deadline Transaction must be completed before this timestamp
+/// @param v User signature (recovery ID)
+/// @param r User signature (ECDSA output)
+/// @param s User signature (ECDSA output)
+/// @param diamondCalldata Address of the token to be bridged
+function callDiamondWithEIP2612Signature(
+    address tokenAddress,
+    uint256 amount,
+    uint256 deadline,
+    uint8 v,
+    bytes32 r,
+    bytes32 s,
+    bytes calldata diamondCalldata
+) public payable 
+````
+
+This method is used to execute a transaction where the approval is granted via
+Uniswap's Permit2 contract. It can only be called by the signer in order to
+prevent front-running attacks.
+
+```solidity
+/// @notice Allows to bridge tokens of one type through a LI.FI diamond
+///         contract using Uniswap's Permit2 contract and a user signature
+///         that verifies allowance. The calldata can be changed by the
+///         user. Can only be called by the permit signer to prevent
+///         front-running.
+/// @param _diamondCalldata the calldata to execute
+/// @param _permit the Uniswap Permit2 parameters
+/// @param _signature the signature giving approval to transfer tokens
+function callDiamondWithPermit2(
+    bytes calldata _diamondCalldata,
+    ISignatureTransfer.PermitTransferFrom calldata _permit,
+    bytes calldata _signature
+) external payable
+```
+
+This method enables a gasless flow by allowing a user to sign a Uniswap Permit2
+message hash which includes a "witness" type. This extra type restricts which
+calldata can be called during execution and cannot be changed. Anyone with the
+signature can execute the transaction on behalf of the signer.
+
+```solidity
+/// @notice Allows to bridge tokens of one type through a LI.FI diamond
+///         contract using Uniswap's Permit2 contract and a user signature
+///         that verifies allowance, diamondAddress and diamondCalldata
+/// @param _diamondCalldata the calldata to execute
+/// @param _signer the signer giving permission to transfer tokens
+/// @param _permit the Uniswap Permit2 parameters
+/// @param _signature the signature giving approval to transfer tokens
+function callDiamondWithPermit2Witness(
+    bytes calldata _diamondCalldata,
+    address _signer,
+    ISignatureTransfer.PermitTransferFrom calldata _permit,
+    bytes calldata _signature
+) external payable
+```
+
+There are a few utility methods to make it easier to generate the necessary
+signature for the gasless flow.
+
+Calling this method will return a valid message hash that can then be signed
+in order to be executed later by another wallet.
+
+```solidity
+/// @notice utitlity method for constructing a valid Permit2 message hash
+/// @param _diamondCalldata the calldata to execute
+/// @param _assetId the address of the token to approve
+/// @param _amount amount of tokens to approve
+/// @param _nonce the nonce to use
+/// @param _deadline the expiration deadline
+function getPermit2MsgHash(
+    bytes calldata _diamondCalldata,
+    address _assetId,
+    uint256 _amount,
+    uint256 _nonce,
+    uint256 _deadline
+) external view returns (bytes32 msgHash)
+```
+
+Permit2 nonces are non-sequential and are a bit complicated to work with. The
+following utility methods allow you to fetch the next valid nonce or sequence
+of nonces for use when generating Permit2 signatures.
+
+```solidity
+/// @notice Finds the next valid nonce for a user, starting from 0.
+/// @param owner The owner of the nonces
+/// @return nonce The first valid nonce starting from 0
+function nextNonce(address owner) external view returns (uint256 nonce)
+
+/// @notice Finds the next valid nonce for a user, after from a given nonce.
+/// @dev This can be helpful if you're signing multiple nonces in a row and 
+///      need the next nonce to sign but the start one is still valid.
+/// @param owner The owner of the nonces
+/// @param start The nonce to start from
+/// @return nonce The first valid nonce after the given nonce
+function nextNonceAfter(
+    address owner,
+    uint256 start
+) external view returns (uint256 nonce)
+```

docs/README.md

@@ -61,3 +61,4 @@
 - [Receiver](./Receiver.md)
 - [ReceiverStargateV2](./ReceiverStargateV2.md)
 - [RelayerCelerIM](./RelayerCelerIM.md)
+- [Permit2Proxy](./Permit2Proxy.md)

package.json

@@ -95,6 +95,7 @@
     "@safe-global/safe-apps-sdk": "^9.0.0",
     "@safe-global/safe-core-sdk-types": "^4.1.0",
     "@uma/sdk": "^0.22.1",
+    "@uniswap/permit2-sdk": "^1.3.0",
     "@uniswap/sdk": "^3.0.3",
     "chalk": "4.1.2",
     "citty": "^0.1.6",

remappings.txt

@@ -9,7 +9,7 @@ celer-network/=lib/sgn-v2-contracts/
 create3-factory/=lib/create3-factory/src/
 solmate/=lib/solmate/src/
 solady/=lib/solady/src/
-
+permit2/=lib/Permit2/src/
 ds-test/=lib/ds-test/src/
 forge-std/=lib/forge-std/src/