fix: reduce infura requests (#3479)

* fix: increase block polling interval * fix: patch balance `stateSyncer` out of WC * fix: upgrade `bnc-onboard` + patch `web3-provider-engine` * fix: cleanup patch * fix: cleanup patch * fix: exchange patch for custom WC module instead
5afe · Feb 11, 2022 · 400b52e · 400b52e
1 parent 5faefb7
commit 400b52e
Show file tree

Hide file tree

Showing 4 changed files with 221 additions and 101 deletions.
diff --git a/package.json b/package.json
@@ -100,7 +100,7 @@
     "abi-decoder": "^2.4.0",
     "axios": "0.21.4",
     "bignumber.js": "9.0.1",
-    "bnc-onboard": "~1.35.3",
+    "bnc-onboard": "^1.37.3",
     "classnames": "^2.2.6",
     "currency-flags": "3.2.1",
     "date-fns": "^2.20.2",

diff --git a/src/logic/wallets/patchedWalletConnect.ts b/src/logic/wallets/patchedWalletConnect.ts
@@ -0,0 +1,105 @@
+import WalletConnectProvider from '@walletconnect/web3-provider'
+import { IRPCMap } from '@walletconnect/types'
+import { WalletModule, Helpers } from 'bnc-onboard/dist/src/interfaces'
+
+import { getRpcServiceUrl } from 'src/config'
+import { getChains } from 'src/config/cache/chains'
+import { INFURA_TOKEN } from 'src/utils/constants'
+import { ChainId } from 'src/config/chain'
+
+// TODO: When desktop pairing is merged, import these into there
+export const WC_BRIDGE = 'https://safe-walletconnect.gnosis.io/'
+
+// Modified version of the built in WC module in Onboard v1.35.5, including:
+// https://github.com/blocknative/onboard/blob/release/1.35.5/src/modules/select/wallets/wallet-connect.ts
+
+// - No `balance` subscription as `eth_getBalance` is otherwise constantly requested
+//   but we do not request the balance from anywhere and is therefore not needed
+// - A high polling interval to prevent unnecessary `eth_getBlockByNumber` polling
+//   https://github.com/WalletConnect/walletconnect-monorepo/issues/357#issuecomment-789663540
+
+const walletConnectIcon = `
+  <svg 
+    height="25" 
+    viewBox="0 0 40 25" 
+    width="40" 
+    xmlns="http://www.w3.org/2000/svg"
+  >
+  <path d="m8.19180572 4.83416816c6.52149658-6.38508884 17.09493158-6.38508884 23.61642788 0l.7848727.76845565c.3260748.31925442.3260748.83686816 0 1.15612272l-2.6848927 2.62873374c-.1630375.15962734-.4273733.15962734-.5904108 0l-1.0800779-1.05748639c-4.5495589-4.45439756-11.9258514-4.45439756-16.4754105 0l-1.1566741 1.13248068c-.1630376.15962721-.4273735.15962721-.5904108 0l-2.68489263-2.62873375c-.32607483-.31925456-.32607483-.83686829 0-1.15612272zm29.16903948 5.43649934 2.3895596 2.3395862c.3260732.319253.3260751.8368636.0000041 1.1561187l-10.7746894 10.5494845c-.3260726.3192568-.8547443.3192604-1.1808214.0000083-.0000013-.0000013-.0000029-.0000029-.0000042-.0000043l-7.6472191-7.4872762c-.0815187-.0798136-.2136867-.0798136-.2952053 0-.0000006.0000005-.000001.000001-.0000015.0000014l-7.6470562 7.4872708c-.3260715.3192576-.8547434.319263-1.1808215.0000116-.0000019-.0000018-.0000039-.0000037-.0000059-.0000058l-10.7749893-10.5496247c-.32607469-.3192544-.32607469-.8368682 0-1.1561226l2.38956395-2.3395823c.3260747-.31925446.85474652-.31925446 1.18082136 0l7.64733029 7.4873809c.0815188.0798136.2136866.0798136.2952054 0 .0000012-.0000012.0000023-.0000023.0000035-.0000032l7.6469471-7.4873777c.3260673-.31926181.8547392-.31927378 1.1808214-.0000267.0000046.0000045.0000091.000009.0000135.0000135l7.6473203 7.4873909c.0815186.0798135.2136866.0798135.2952053 0l7.6471967-7.4872433c.3260748-.31925458.8547465-.31925458 1.1808213 0z" 
+        fill="#3b99fc"/>
+  </svg>
+`
+
+export const getRpcMap = (): IRPCMap => {
+  return getChains().reduce((map, { chainId, rpcUri }) => {
+    return {
+      ...map,
+      [parseInt(chainId, 10)]: getRpcServiceUrl(rpcUri),
+    }
+  }, {})
+}
+
+const patchedWalletConnect = (chainId: ChainId): WalletModule => {
+  return {
+    name: 'WalletConnect',
+    svg: walletConnectIcon,
+    wallet: async ({ resetWalletState }: Helpers) => {
+      const provider = new WalletConnectProvider({
+        infuraId: INFURA_TOKEN,
+        rpc: getRpcMap(),
+        chainId: parseInt(chainId, 10),
+        bridge: WC_BRIDGE,
+        // Prevent `eth_getBlockByNumber` polling every 4 seconds
+        pollingInterval: 60_000 * 60, // 1 hour
+      })
+
+      provider.autoRefreshOnNetworkChange = false
+
+      provider.wc.on('disconnect', () => {
+        resetWalletState({ disconnected: true, walletName: 'WalletConnect' })
+      })
+
+      return {
+        provider,
+        interface: {
+          name: 'WalletConnect',
+          connect: () =>
+            new Promise((resolve, reject) => {
+              provider
+                .enable()
+                .then(resolve)
+                .catch(() =>
+                  reject({
+                    message: 'This dapp needs access to your account information.',
+                  }),
+                )
+            }),
+          address: {
+            onChange: (func) => {
+              provider.send('eth_accounts').then((accounts: string[]) => accounts[0] && func(accounts[0]))
+              provider.on('accountsChanged', (accounts: string[]) => func(accounts[0]))
+            },
+          },
+          network: {
+            onChange: (func) => {
+              provider.send('eth_chainId').then(func)
+              provider.on('chainChanged', func)
+            },
+          },
+          // Prevent continuous `eth_getBalance` requests
+          balance: {},
+          disconnect: () => {
+            provider.wc.killSession()
+            provider.stop()
+          },
+        },
+      }
+    },
+    type: 'sdk',
+    desktop: true,
+    mobile: true,
+    preferred: true,
+  }
+}
+
+export default patchedWalletConnect
diff --git a/src/logic/wallets/utils/walletList.ts b/src/logic/wallets/utils/walletList.ts
@@ -1,8 +1,9 @@
-import { WalletInitOptions } from 'bnc-onboard/dist/src/interfaces'
+import { WalletInitOptions, WalletSelectModuleOptions } from 'bnc-onboard/dist/src/interfaces'
 
 import { getRpcServiceUrl, getDisabledWallets, getChainById } from 'src/config'
 import { ChainId, WALLETS } from 'src/config/chain.d'
 import { FORTMATIC_KEY, PORTIS_ID } from 'src/utils/constants'
+import patchedWalletConnect from '../patchedWalletConnect'
 
 type Wallet = WalletInitOptions & {
   desktop: boolean
@@ -16,14 +17,8 @@ const wallets = (chainId: ChainId): Wallet[] => {
 
   return [
     { walletName: WALLETS.METAMASK, preferred: true, desktop: false },
-    {
-      walletName: WALLETS.WALLET_CONNECT,
-      preferred: true,
-      // `infuraKey` is not mandatory if rpc is provided
-      rpc: { [chainId]: rpcUrl },
-      desktop: true,
-      bridge: 'https://safe-walletconnect.gnosis.io/',
-    },
+    // A patched version of WalletConnect is spliced in at this index
+    // { preferred: true, desktop: true }
     {
       walletName: WALLETS.TREZOR,
       appUrl: 'gnosis-safe.io',
@@ -71,7 +66,7 @@ const wallets = (chainId: ChainId): Wallet[] => {
   ]
 }
 
-export const getSupportedWallets = (chainId: ChainId): WalletInitOptions[] => {
+const getPlatformSupportedWallets = (chainId: ChainId): WalletInitOptions[] => {
   if (window.isDesktop) {
     return wallets(chainId)
       .filter(({ desktop }) => desktop)
@@ -82,3 +77,15 @@ export const getSupportedWallets = (chainId: ChainId): WalletInitOptions[] => {
     .map(({ desktop, ...rest }) => rest)
     .filter(({ walletName }) => !getDisabledWallets().includes(walletName))
 }
+
+export const getSupportedWallets = (chainId: ChainId): WalletSelectModuleOptions['wallets'] => {
+  const wallets: WalletSelectModuleOptions['wallets'] = getPlatformSupportedWallets(chainId)
+
+  if (!getDisabledWallets().includes(WALLETS.WALLET_CONNECT)) {
+    const wc = patchedWalletConnect(chainId)
+    // Inset patched WC module at index 1
+    wallets.splice(1, 0, wc)
+  }
+
+  return wallets
+}