refactor: local storage keys to appkit + network switch fixes (#2861)

Co-authored-by: tomiir <[email protected]>
reown-com · Sep 19, 2024 · a181a19 · a181a19
1 parent babb413
commit a181a19
Show file tree

Hide file tree

Showing 23 changed files with 249 additions and 218 deletions.
diff --git a/.changeset/wise-bobcats-hang.md b/.changeset/wise-bobcats-hang.md
@@ -0,0 +1,38 @@
+---
+'@reown/appkit-adapter-ethers5': patch
+'@reown/appkit-adapter-ethers': patch
+'@reown/appkit-utils': patch
+'@reown/appkit': patch
+'@reown/appkit-common': patch
+'@reown/appkit-wallet': patch
+'@reown/appkit-core': patch
+'@apps/demo': patch
+'@apps/gallery': patch
+'@apps/laboratory': patch
+'@examples/html-ethers': patch
+'@examples/html-ethers5': patch
+'@examples/html-wagmi': patch
+'@examples/next-ethers': patch
+'@examples/next-wagmi': patch
+'@examples/react-ethers': patch
+'@examples/react-ethers5': patch
+'@examples/react-solana': patch
+'@examples/react-wagmi': patch
+'@examples/vue-ethers5': patch
+'@examples/vue-solana': patch
+'@examples/vue-wagmi': patch
+'@reown/appkit-adapter-polkadot': patch
+'@reown/appkit-adapter-solana': patch
+'@reown/appkit-adapter-wagmi': patch
+'@reown/appkit-cdn': patch
+'@reown/appkit-ethers': patch
+'@reown/appkit-ethers5': patch
+'@reown/appkit-polyfills': patch
+'@reown/appkit-scaffold-ui': patch
+'@reown/appkit-siwe': patch
+'@reown/appkit-solana': patch
+'@reown/appkit-ui': patch
+'@reown/appkit-wagmi': patch
+---
+
+Updates the localstorage keys
diff --git a/apps/laboratory/src/pages/library/multichain-wagmi-solana.tsx b/apps/laboratory/src/pages/library/multichain-wagmi-solana.tsx
@@ -7,25 +7,21 @@ import { ConstantsUtil } from '../../utils/ConstantsUtil'
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
 import { WagmiProvider } from 'wagmi'
 import {
-  arbitrum,
   mainnet,
   polygon,
-  base,
-  binanceSmartChain,
   solana,
-  solanaTestnet,
-  solanaDevnet,
+  arbitrum,
   optimism,
-  zkSync,
-  sepolia
+  solanaTestnet,
+  solanaDevnet
 } from '@reown/appkit/networks'
 import { AppKitButtons } from '../../components/AppKitButtons'
 import { HuobiWalletAdapter, SolflareWalletAdapter } from '@solana/wallet-adapter-wallets'
 import { MultiChainTestsWagmiSolana } from '../../components/MultiChainTestsWagmiSolana'
 
 const queryClient = new QueryClient()
 
-const networks = [mainnet, optimism, polygon, zkSync, arbitrum, sepolia]
+const networks = [mainnet, polygon, solana, arbitrum, optimism, solanaTestnet, solanaDevnet]
 
 const wagmiAdapter = new WagmiAdapter({
   ssr: true,
@@ -39,16 +35,7 @@ const solanaWeb3JsAdapter = new SolanaAdapter({
 
 const modal = createAppKit({
   adapters: [wagmiAdapter, solanaWeb3JsAdapter],
-  networks: [
-    mainnet,
-    polygon,
-    base,
-    binanceSmartChain,
-    arbitrum,
-    solana,
-    solanaTestnet,
-    solanaDevnet
-  ],
+  networks,
   defaultNetwork: mainnet,
   projectId: ConstantsUtil.ProjectId,
   features: {

diff --git a/apps/laboratory/tests/multichain/multichain-wagmi-solana.spec.ts b/apps/laboratory/tests/multichain/multichain-wagmi-solana.spec.ts
@@ -48,7 +48,7 @@ test.skip('it should show disabled networks', async () => {
   await modalPage.closeModal()
 })
 
-test('it should switch networks and sign', async () => {
+test.only('it should switch networks and sign', async () => {
   const chains = ['Polygon', 'Solana']
 
   async function processChain(index: number) {

diff --git a/apps/laboratory/tests/shared/utils/validation.ts b/apps/laboratory/tests/shared/utils/validation.ts
@@ -8,6 +8,6 @@ export async function expectConnection(
   await modalValidator.expectConnected()
   await walletValidator.expectConnected()
   await modalValidator.page.evaluate(
-    `window.localStorage.setItem('WALLETCONNECT_DEEPLINK_CHOICE', '')`
+    `window.localStorage.setItem('@appkit/deeplink_choice', JSON.stringify({ href: '', name: '' }))`
   )
 }
diff --git a/apps/laboratory/tests/shared/validators/ModalValidator.ts b/apps/laboratory/tests/shared/validators/ModalValidator.ts
@@ -96,6 +96,10 @@ export class ModalValidator {
   async expectRejectedSign() {
     // We use Chakra Toast and it's not quite straightforward to set the `data-testid` attribute on the toast element.
     await expect(this.page.getByText(ConstantsUtil.SigningFailedToastTitle)).toBeVisible()
+    const closeButton = this.page.locator('#toast-close-button')
+
+    await expect(closeButton).toBeVisible()
+    await closeButton.click()
   }
 
   async expectSwitchedNetwork(network: string) {

diff --git a/packages/adapters/ethers/src/tests/client.test.ts b/packages/adapters/ethers/src/tests/client.test.ts
@@ -9,8 +9,8 @@ import { EthersHelpersUtil, type ProviderId, type ProviderType } from '@reown/ap
 import { ConstantsUtil } from '@reown/appkit-utils'
 import { arbitrum, mainnet, polygon } from '@reown/appkit/networks'
 import { ProviderUtil } from '@reown/appkit/store'
-import { SafeLocalStorage } from '@reown/appkit-common'
-import { WcConstantsUtil, type BlockchainApiLookupEnsName } from '@reown/appkit'
+import { SafeLocalStorage, SafeLocalStorageKeys } from '@reown/appkit-common'
+import { type BlockchainApiLookupEnsName } from '@reown/appkit'
 import { InfuraProvider, JsonRpcProvider } from 'ethers'
 
 import type { CaipNetwork, ChainNamespace } from '@reown/appkit-common'
@@ -519,8 +519,14 @@ describe('EthersAdapter', () => {
       const mockProvider = { request: vi.fn() }
       await client['setProvider'](mockProvider as any, 'injected', 'MetaMask')
 
-      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID, 'injected')
-      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_NAME, 'MetaMask')
+      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(
+        SafeLocalStorageKeys.WALLET_ID,
+        'injected'
+      )
+      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(
+        SafeLocalStorageKeys.WALLET_NAME,
+        'MetaMask'
+      )
       expect(mockAppKit.setCaipNetwork).toHaveBeenCalled()
       expect(mockAppKit.setCaipAddress).toHaveBeenCalled()
       expect(ProviderUtil.setProviderId).toHaveBeenCalledWith('eip155', 'injected')
@@ -557,7 +563,7 @@ describe('EthersAdapter', () => {
       )[1]
       await disconnectHandler()
 
-      expect(SafeLocalStorage.removeItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.removeItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(mockProvider.removeListener).toHaveBeenCalledTimes(3)
     })
 
@@ -595,9 +601,9 @@ describe('EthersAdapter', () => {
       }
 
       vi.spyOn(SafeLocalStorage, 'getItem').mockImplementation(key => {
-        if (key === WcConstantsUtil.WALLET_ID) return ConstantsUtil.INJECTED_CONNECTOR_ID
-        if (key === WcConstantsUtil.WALLET_NAME) return 'MetaMask'
-        return null
+        if (key === SafeLocalStorageKeys.WALLET_ID) return ConstantsUtil.INJECTED_CONNECTOR_ID
+        if (key === SafeLocalStorageKeys.WALLET_NAME) return 'MetaMask'
+        return undefined
       })
 
       vi.spyOn(client as any, 'setProvider').mockImplementation(() => Promise.resolve())
@@ -613,7 +619,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).toHaveBeenCalledWith(
         mockInjectedProvider,
         ConstantsUtil.INJECTED_CONNECTOR_ID
@@ -625,7 +631,7 @@ describe('EthersAdapter', () => {
     })
 
     it('should not set provider when wallet ID is not found', () => {
-      vi.spyOn(SafeLocalStorage, 'getItem').mockReturnValue(null)
+      vi.spyOn(SafeLocalStorage, 'getItem').mockReturnValue(undefined)
 
       const mockConfig = {
         injected: mockInjectedProvider,
@@ -635,7 +641,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).not.toHaveBeenCalled()
       expect(client['setupProviderListeners']).not.toHaveBeenCalled()
     })
@@ -649,7 +655,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).not.toHaveBeenCalled()
       expect(client['setupProviderListeners']).not.toHaveBeenCalled()
     })

diff --git a/packages/adapters/ethers5/src/tests/client.test.ts b/packages/adapters/ethers5/src/tests/client.test.ts
@@ -9,8 +9,8 @@ import { EthersHelpersUtil, type ProviderId, type ProviderType } from '@reown/ap
 import { ConstantsUtil } from '@reown/appkit-utils'
 import { arbitrum, mainnet, polygon } from '@reown/appkit/networks'
 import { ProviderUtil } from '@reown/appkit/store'
-import { SafeLocalStorage } from '@reown/appkit-common'
-import { WcConstantsUtil, type BlockchainApiLookupEnsName } from '@reown/appkit'
+import { SafeLocalStorage, SafeLocalStorageKeys } from '@reown/appkit-common'
+import { type BlockchainApiLookupEnsName } from '@reown/appkit'
 import { ethers } from 'ethers5'
 import type { CaipNetwork, ChainNamespace } from '@reown/appkit-common'
 
@@ -524,8 +524,14 @@ describe('EthersAdapter', () => {
       const mockProvider = { request: vi.fn() }
       await client['setProvider'](mockProvider as any, 'injected', 'MetaMask')
 
-      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID, 'injected')
-      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_NAME, 'MetaMask')
+      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(
+        SafeLocalStorageKeys.WALLET_ID,
+        'injected'
+      )
+      expect(SafeLocalStorage.setItem).toHaveBeenCalledWith(
+        SafeLocalStorageKeys.WALLET_NAME,
+        'MetaMask'
+      )
       expect(mockAppKit.setCaipNetwork).toHaveBeenCalled()
       expect(ProviderUtil.setProviderId).toHaveBeenCalledWith('eip155', 'injected')
       expect(ProviderUtil.setProvider).toHaveBeenCalledWith('eip155', mockProvider)
@@ -561,7 +567,7 @@ describe('EthersAdapter', () => {
       )[1]
       await disconnectHandler()
 
-      expect(SafeLocalStorage.removeItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.removeItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(mockProvider.removeListener).toHaveBeenCalledTimes(3)
     })
 
@@ -599,9 +605,9 @@ describe('EthersAdapter', () => {
       }
 
       vi.spyOn(SafeLocalStorage, 'getItem').mockImplementation(key => {
-        if (key === WcConstantsUtil.WALLET_ID) return ConstantsUtil.INJECTED_CONNECTOR_ID
-        if (key === WcConstantsUtil.WALLET_NAME) return 'MetaMask'
-        return null
+        if (key === SafeLocalStorageKeys.WALLET_ID) return ConstantsUtil.INJECTED_CONNECTOR_ID
+        if (key === SafeLocalStorageKeys.WALLET_NAME) return 'MetaMask'
+        return undefined
       })
 
       vi.spyOn(client as any, 'setProvider').mockImplementation(() => Promise.resolve())
@@ -617,7 +623,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).toHaveBeenCalledWith(
         mockInjectedProvider,
         ConstantsUtil.INJECTED_CONNECTOR_ID
@@ -629,7 +635,7 @@ describe('EthersAdapter', () => {
     })
 
     it('should not set provider when wallet ID is not found', () => {
-      vi.spyOn(SafeLocalStorage, 'getItem').mockReturnValue(null)
+      vi.spyOn(SafeLocalStorage, 'getItem').mockReturnValue(undefined)
 
       const mockConfig = {
         injected: mockInjectedProvider,
@@ -639,7 +645,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).not.toHaveBeenCalled()
       expect(client['setupProviderListeners']).not.toHaveBeenCalled()
     })
@@ -653,7 +659,7 @@ describe('EthersAdapter', () => {
 
       client['checkActiveProviders'](mockConfig as ProviderType)
 
-      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(WcConstantsUtil.WALLET_ID)
+      expect(SafeLocalStorage.getItem).toHaveBeenCalledWith(SafeLocalStorageKeys.WALLET_ID)
       expect(client['setProvider']).not.toHaveBeenCalled()
       expect(client['setupProviderListeners']).not.toHaveBeenCalled()
     })

diff --git a/packages/adapters/solana/src/client.ts b/packages/adapters/solana/src/client.ts
@@ -141,14 +141,10 @@ export class SolanaAdapter implements ChainAdapter {
     this.networkControllerClient = {
       switchCaipNetwork: async caipNetwork => {
         if (caipNetwork) {
-          SafeLocalStorage.setItem(
-            SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK,
-            JSON.stringify(caipNetwork)
-          )
           try {
             await this.switchNetwork(caipNetwork)
           } catch (error) {
-            // SolStoreUtil.setError(error)
+            console.warn('Error switching network', error)
           }
         }
       },

diff --git a/packages/adapters/solana/src/providers/AuthProvider.ts b/packages/adapters/solana/src/providers/AuthProvider.ts
@@ -57,8 +57,8 @@ export class AuthProvider extends ProviderEventEmitter implements Provider, Prov
 
   get publicKey(): PublicKey | undefined {
     const session = this.getSession()
-
-    if (session) {
+    const namespace = this.getActiveNamespace()
+    if (session && namespace === 'solana') {
       return new PublicKey(session.address)
     }
 
@@ -201,7 +201,8 @@ export class AuthProvider extends ProviderEventEmitter implements Provider, Prov
     required?: Required
   ): Required extends true ? PublicKey : PublicKey | undefined {
     const session = this.getSession()
-    if (!session) {
+    const namespace = this.getActiveNamespace()
+    if (!session || namespace !== 'solana') {
       if (required) {
         throw new Error('Account is required')
       }

diff --git a/packages/adapters/wagmi/src/client.ts b/packages/adapters/wagmi/src/client.ts
@@ -234,10 +234,6 @@ export class WagmiAdapter implements ChainAdapter {
 
     this.networkControllerClient = {
       switchCaipNetwork: async caipNetwork => {
-        SafeLocalStorage.setItem(
-          SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK,
-          JSON.stringify(caipNetwork)
-        )
         const chainId = Number(NetworkUtil.caipNetworkIdToNumber(caipNetwork?.id))
 
         if (chainId && this.wagmiConfig) {
@@ -607,7 +603,7 @@ export class WagmiAdapter implements ChainAdapter {
   >) {
     const isConnected = ChainController.state.activeCaipAddress
 
-    if (status === 'disconnected' && isConnected) {
+    if (status === 'disconnected' && !isConnected) {
       this.appKit?.resetAccount(this.chainNamespace)
       this.appKit?.resetWcConnection()
       this.appKit?.resetNetwork()

diff --git a/packages/adapters/wagmi/src/connectors/UniversalConnector.ts b/packages/adapters/wagmi/src/connectors/UniversalConnector.ts
@@ -22,7 +22,7 @@ import { WcHelpersUtil } from '@reown/appkit'
 import type { AppKitOptions } from '@reown/appkit'
 import type { AppKit } from '@reown/appkit'
 import { convertToAppKitChains } from '../utils/helpers.js'
-import { SafeLocalStorage, SafeLocalStorageKeys, type CaipNetwork } from '@reown/appkit-common'
+import { SafeLocalStorage, SafeLocalStorageKeys } from '@reown/appkit-common'
 
 type UniversalConnector = Connector & {
   onDisplayUri(uri: string): void
@@ -232,11 +232,8 @@ export function walletConnect(parameters: AppKitOptionsParams, appKit: AppKit) {
 
       if (chainId && currentChainId !== chainId) {
         const storedCaipNetwork = SafeLocalStorage.getItem(SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK)
-        if (storedCaipNetwork) {
-          const parsedCaipNetwork = JSON.parse(storedCaipNetwork) as CaipNetwork
-          if (parsedCaipNetwork.chainNamespace === 'eip155') {
-            await this.switchChain?.({ chainId: Number(parsedCaipNetwork.chainId) })
-          }
+        if (storedCaipNetwork && storedCaipNetwork.chainNamespace === 'eip155') {
+          await this.switchChain?.({ chainId: Number(storedCaipNetwork.chainId) })
         } else {
           await this.switchChain?.({ chainId })
         }

diff --git a/packages/appkit-utils/src/ethers/EthersConstantsUtil.ts b/packages/appkit-utils/src/ethers/EthersConstantsUtil.ts
@@ -1,5 +1,4 @@
 export const EthersConstantsUtil = {
-  WALLET_ID: '@w3m/wallet_id',
   ERROR_CODE_UNRECOGNIZED_CHAIN_ID: 4902,
   ERROR_CODE_DEFAULT: 5000
 } as const
diff --git a/packages/appkit-utils/src/solana/SolanaConstantsUtil.ts b/packages/appkit-utils/src/solana/SolanaConstantsUtil.ts
@@ -19,8 +19,6 @@ export const SolConstantsUtil = {
   /**
    * Mainnet program ID
    */
-  WALLET_ID: '@w3m/solana_wallet',
-  CAIP_CHAIN_ID: '@w3m/solana_caip_chain',
   ERROR_CODE_UNRECOGNIZED_CHAIN_ID: 4902,
   ERROR_CODE_DEFAULT: 5000,
   DEFAULT_CHAIN: {