refactor: local storage keys to appkit + network switch fixes

.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

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: {

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()
     })

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()
     })

packages/adapters/solana/src/client.ts

@@ -140,10 +140,6 @@ 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) {

packages/adapters/wagmi/src/client.ts

@@ -230,10 +230,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) {

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 })
         }

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

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: {

packages/appkit/src/universal-adapter/client.ts

@@ -95,10 +95,6 @@ export class UniversalAdapterClient {
       // @ts-expect-error switchCaipNetwork is async for some adapter but not for this adapter
       switchCaipNetwork: caipNetwork => {
         if (caipNetwork) {
-          SafeLocalStorage.setItem(
-            SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK,
-            JSON.stringify(caipNetwork)
-          )
           try {
             this.switchNetwork(caipNetwork)
           } catch (error) {
@@ -397,32 +393,23 @@ export class UniversalAdapterClient {
         })
 
       const storedCaipNetwork = SafeLocalStorage.getItem(SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK)
+      const activeCaipNetwork = ChainController.state.activeCaipNetwork
 
-      if (storedCaipNetwork) {
-        try {
-          const parsedCaipNetwork = JSON.parse(storedCaipNetwork) as CaipNetwork
-          if (parsedCaipNetwork) {
-            NetworkController.setActiveCaipNetwork(parsedCaipNetwork)
-          }
-        } catch (error) {
-          console.warn('>>> Error setting active caip network', error)
+      try {
+        if (storedCaipNetwork) {
+          NetworkController.setActiveCaipNetwork(storedCaipNetwork)
+        } else if (!activeCaipNetwork) {
+          this.setDefaultNetwork(nameSpaces)
+        } else if (
+          !NetworkController.state.approvedCaipNetworkIds?.includes(activeCaipNetwork.id)
+        ) {
+          this.setDefaultNetwork(nameSpaces)
         }
-      } else if (!ChainController.state.activeCaipNetwork) {
-        this.setDefaultNetwork(nameSpaces)
-      } else if (
-        !NetworkController.state.approvedCaipNetworkIds?.includes(
-          ChainController.state.activeCaipNetwork.id
-        )
-      ) {
-        this.setDefaultNetwork(nameSpaces)
+      } catch (error) {
+        console.warn('>>> Error setting active caip network', error)
       }
     }
 
-    SafeLocalStorage.setItem(
-      SafeLocalStorageKeys.ACTIVE_CAIP_NETWORK,
-      JSON.stringify(this.appKit?.getCaipNetwork())
-    )
-
     this.syncAccount()
     this.watchWalletConnect()
   }

packages/appkit/src/utils/ConstantsUtil.ts

@@ -1,7 +1,4 @@
 export const WcConstantsUtil = {
-  WALLET_ID: '@w3m/wallet_id' as const,
-  WALLET_NAME: '@w3m/wallet_name' as const,
-  ACTIVE_CAIPNETWORK: '@w3m/active_caipnetwork' as const,
   ERROR_CODE_UNRECOGNIZED_CHAIN_ID: 4902,
   ERROR_CODE_DEFAULT: 5000
 }