fix(permit): improve permittable detection (#3226)

* chore: return `false` only when it's a known failure * refactor: add return type * chore: improve permit detection logging * chore: update every package related to @web3-react/walletconnect-v2 - Removed @web3-react/walletconnect - Added @walletconnect/ethereum-provider as it's a dependency of @web3-react/walletconnect-v2 - Moved @web3-react/types to dev deps * chore: add more logging to permit utils creation * fix: lib @walletconnect/ethereum-provider path changed * fix: remove aliases no longer needed * fix: update async connector provider on network changes from wallet * chore: reduce some logging --------- Co-authored-by: Alexandr Kazachenko <[email protected]>
cowprotocol · Oct 16, 2023 · 79cb48a · 79cb48a
1 parent 99df6d2
commit 79cb48a
Show file tree

Hide file tree

Showing 8 changed files with 185 additions and 538 deletions.
diff --git a/apps/cowswap-frontend/src/modules/permit/utils/checkIsTokenPermittable.ts b/apps/cowswap-frontend/src/modules/permit/utils/checkIsTokenPermittable.ts
@@ -61,9 +61,17 @@ async function actuallyCheckTokenIsPermittable(params: CheckIsTokenPermittablePa
   try {
     nonce = await eip2612PermitUtils.getTokenNonce(tokenAddress, owner)
   } catch (e) {
+    if (e === 'nonce not supported' || e.message === 'nonce is NaN') {
+      console.debug(`[checkTokenIsPermittable] Not a permittable token ${tokenAddress}`, e?.message || e)
+      // Here we know it's not supported, return false
+      // See https://github.com/1inch/permit-signed-approvals-utils/blob/b190197a45c3289867ee4e6da93f10dea51ef276/src/eip-2612-permit.utils.ts#L309
+      // and https://github.com/1inch/permit-signed-approvals-utils/blob/b190197a45c3289867ee4e6da93f10dea51ef276/src/eip-2612-permit.utils.ts#L325
+      return false
+    }
     console.debug(`[checkTokenIsPermittable] Failed to get nonce for ${tokenAddress}`, e)
 
-    return false
+    // Otherwise, it might have been a network issue or another temporary failure, return error
+    return { error: e.message || e.toString() }
   }
 
   const baseParams: BaseParams = {
@@ -81,10 +89,12 @@ async function actuallyCheckTokenIsPermittable(params: CheckIsTokenPermittablePa
     return await estimateTokenPermit({ ...baseParams, type: 'eip-2612', provider })
   } catch (e) {
     // Not eip-2612, try dai-like
+    console.debug(`[checkTokenIsPermittable] Failed to estimate eip-2612 permit for ${tokenAddress}`, e)
     try {
       return await estimateTokenPermit({ ...baseParams, type: 'dai-like', provider })
     } catch (e) {
       // Not dai-like either, return error
+      console.debug(`[checkTokenIsPermittable] Failed to estimate dai-like permit for ${tokenAddress}`, e)
       return { error: e.message || e.toString() }
     }
   }
@@ -105,7 +115,7 @@ type EstimateParams = BaseParams & {
   provider: Web3Provider
 }
 
-async function estimateTokenPermit(params: EstimateParams) {
+async function estimateTokenPermit(params: EstimateParams): Promise<EstimatePermitResult> {
   const { provider, chainId, walletAddress, tokenAddress, type } = params
 
   const getCallDataFn = type === 'eip-2612' ? getEip2612CallData : getDaiLikeCallData

diff --git a/apps/cowswap-frontend/src/modules/permit/utils/getPermitUtilsInstance.ts b/apps/cowswap-frontend/src/modules/permit/utils/getPermitUtilsInstance.ts
@@ -14,7 +14,7 @@ const CHAIN_UTILS_CACHE = new Map<number, Eip2612PermitUtils>()
 /**
  * Cache by provider. Here we cache per provider as each account should have its own instance
  */
-const PROVIDER_UTILS_CACHE = new Map<Web3Provider, Eip2612PermitUtils>()
+const PROVIDER_UTILS_CACHE = new Map<string, Eip2612PermitUtils>()
 
 export function getPermitUtilsInstance(
   chainId: SupportedChainId,
@@ -26,7 +26,8 @@ export function getPermitUtilsInstance(
   if (!account && chainCache) {
     return chainCache
   }
-  const providerCache = PROVIDER_UTILS_CACHE.get(provider)
+  const providerCacheKey = `${chainId}-${account}`
+  const providerCache = PROVIDER_UTILS_CACHE.get(providerCacheKey)
 
   if (providerCache) {
     return providerCache
@@ -36,9 +37,14 @@ export function getPermitUtilsInstance(
   const eip2612PermitUtils = new Eip2612PermitUtils(web3ProviderConnector)
 
   if (!account) {
+    console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${chainId}`, eip2612PermitUtils)
     CHAIN_UTILS_CACHE.set(chainId, eip2612PermitUtils)
   } else {
-    PROVIDER_UTILS_CACHE.set(provider, eip2612PermitUtils)
+    console.log(
+      `[getPermitUtilsInstance] Set cached provider utils for chain ${chainId}-${account}`,
+      eip2612PermitUtils
+    )
+    PROVIDER_UTILS_CACHE.set(providerCacheKey, eip2612PermitUtils)
   }
 
   return eip2612PermitUtils

diff --git a/apps/cowswap-frontend/vite.config.ts b/apps/cowswap-frontend/vite.config.ts
@@ -10,8 +10,6 @@ import { VitePWA } from 'vite-plugin-pwa'
 import svgr from 'vite-plugin-svgr'
 import viteTsConfigPaths from 'vite-tsconfig-paths'
 
-import * as path from 'path'
-
 import { getReactProcessEnv } from '../../tools/getReactProcessEnv'
 
 // eslint-disable-next-line no-restricted-imports
@@ -102,18 +100,6 @@ export default defineConfig(({ mode }) => {
     resolve: {
       alias: {
         'node-fetch': 'isomorphic-fetch',
-        /**
-         * Temporary fix for walletconnect
-         * https://github.com/Uniswap/web3-react/issues/861
-         */
-        '@walletconnect/ethereum-provider': path.resolve(
-          __dirname,
-          '../../node_modules/@walletconnect/ethereum-provider/dist/umd/index.min.js'
-        ),
-        '@walletconnect/universal-provider': path.resolve(
-          __dirname,
-          '../../node_modules/@walletconnect/universal-provider/dist/index.cjs.js'
-        ),
       },
     },
 

diff --git a/libs/wallet/src/web3-react/connection/asyncConnector.ts b/libs/wallet/src/web3-react/connection/asyncConnector.ts
@@ -11,6 +11,11 @@ function initCustomProvider(self: AsyncConnector, connector: Connector, chainId:
   }
 
   self.events.emit(ASYNC_CUSTOM_PROVIDER_EVENT, self.customProvider)
+
+  // Update provider when network is changed on wallet side
+  connector.provider?.on('chainChanged', (chainIdHex: string) => {
+    initCustomProvider(self, connector, +chainIdHex)
+  })
 }
 
 /**

diff --git a/package.json b/package.json
@@ -88,17 +88,16 @@
     "@uniswap/sdk-core": "^3.0.1",
     "@uniswap/token-lists": "^1.0.0-beta.30",
     "@use-gesture/react": "^10.2.23",
-    "@web3-react/coinbase-wallet": "^8.2.0",
-    "@web3-react/core": "^8.2.0",
-    "@web3-react/eip1193": "^8.2.0",
-    "@web3-react/empty": "^8.2.0",
-    "@web3-react/gnosis-safe": "^8.2.0",
-    "@web3-react/metamask": "^8.2.1",
-    "@web3-react/network": "^8.2.0",
-    "@web3-react/types": "^8.2.0",
-    "@web3-react/url": "^8.2.0",
-    "@web3-react/walletconnect": "^8.2.0",
-    "@web3-react/walletconnect-v2": "^8.3.7",
+    "@walletconnect/ethereum-provider": "^2.10.2",
+    "@web3-react/coinbase-wallet": "^8.2.3",
+    "@web3-react/core": "^8.2.3",
+    "@web3-react/eip1193": "^8.2.3",
+    "@web3-react/empty": "^8.2.3",
+    "@web3-react/gnosis-safe": "^8.2.4",
+    "@web3-react/metamask": "^8.2.4",
+    "@web3-react/network": "^8.2.3",
+    "@web3-react/url": "^8.2.3",
+    "@web3-react/walletconnect-v2": "^8.5.1",
     "bnc-sdk": "^4.6.0",
     "buffer": "^6.0.3",
     "cids": "^1.0.0",
@@ -214,6 +213,7 @@
     "@vitejs/plugin-react-swc": "^3.3.2",
     "@vitest/coverage-c8": "~0.32.0",
     "@vitest/ui": "~0.32.0",
+    "@web3-react/types": "^8.2.3",
     "babel-jest": "^29.6.2",
     "babel-plugin-styled-components": "2.1.4",
     "babel-plugin-transform-import-meta": "^2.2.0",

diff --git a/patches/@walletconnect+universal-provider+2.9.2.patch b/patches/@walletconnect+universal-provider+2.9.2.patch
diff --git a/patches/@web3-react+walletconnect-v2+8.3.7.patch b/patches/@web3-react+walletconnect-v2+8.3.7.patch