feat(tokens): migrate user added data from legacy state

libs/tokens/src/const/defaultFavouriteTokens.ts

@@ -28,6 +28,7 @@ const tokensListToMap = (list: TokenWithLogo[]) =>
     }
     return acc
   }, {})
+
 export const DEFAULT_FAVOURITE_TOKENS: Record<SupportedChainId, TokensMap> = {
   [SupportedChainId.MAINNET]: tokensListToMap([
     DAI,

libs/tokens/src/hooks/tokens/useSearchNonExistentToken.ts

@@ -2,7 +2,7 @@ import { useAtomValue } from 'jotai'
 import { useMemo } from 'react'
 
 import { TokenWithLogo } from '@cowprotocol/common-const'
-import { isTruthy } from '@cowprotocol/common-utils'
+import { doesTokenMatchSymbolOrAddress } from '@cowprotocol/common-utils'
 
 import { tokenListsUpdatingAtom } from '../../state/tokenLists/tokenListsStateAtom'
 import { useSearchToken } from './useSearchToken'
@@ -23,7 +23,7 @@ export function useSearchNonExistentToken(tokenId: string | null): TokenWithLogo
     return (
       [foundToken.inactiveListsResult, foundToken.externalApiResult, foundToken.blockchainResult]
         .flat()
-        .filter(isTruthy)[0] || null
+        .filter((token) => !!token && doesTokenMatchSymbolOrAddress(token, inputTokenToSearch))[0] || null
     )
   }, [inputTokenToSearch, foundToken])
 }

libs/tokens/src/index.ts

@@ -1,3 +1,9 @@
+import { tokensLegacyStateMigration } from './migrations/tokensLegacyStateMigration'
+
+// Run migrations first of all
+// TODO: remove it after 30.01.2024
+tokensLegacyStateMigration()
+
 // Updaters
 export { TokensListsUpdater } from './updaters/TokensListsUpdater'
 export { UnsupportedTokensUpdater } from './updaters/UnsupportedTokensUpdater'

libs/tokens/src/migrations/tokensLegacyStateMigration.ts

@@ -0,0 +1,101 @@
+import { ListsSourcesByNetwork, TokenListsState } from '../types'
+import { SupportedChainId } from '@cowprotocol/cow-sdk'
+import { DEFAULT_TOKENS_LISTS } from '../const/tokensLists'
+
+const MIGRATION_KEY = 'TOKENS_REFACTORING_MIGRATED'
+
+export function tokensLegacyStateMigration() {
+  // Run migration only once
+  if (localStorage.getItem(MIGRATION_KEY)) return
+
+  try {
+    migrateLegacyTokensInUserState()
+  } catch (error) {
+    console.error('Cannot migrate LegacyTokensInUserState', error)
+  }
+
+  try {
+    migrateLegacyTokenLists()
+  } catch (error) {
+    console.error('Cannot migrate LegacyTokenLists', error)
+  }
+
+  localStorage.setItem(MIGRATION_KEY, '1')
+}
+
+// Move user-added tokens from legacy redux store (UserState) to a new atom (userAddedTokensAtom)
+// And purge the irrelevant localStorage state
+function migrateLegacyTokensInUserState() {
+  const userStateRaw = localStorage.getItem('redux_localstorage_simple_user')
+
+  if (!userStateRaw) return
+
+  const userState = JSON.parse(userStateRaw)
+
+  if (userState?.tokens && Object.keys(userState.tokens).length > 0) {
+    localStorage.setItem('userAddedTokensAtom:v1', JSON.stringify(userState.tokens))
+  }
+
+  // Cleanup legacy redux store (UserState)
+  delete userState.favouriteTokens
+  delete userState.tokens
+  delete userState.pairs
+
+  localStorage.setItem('redux_localstorage_simple_user', JSON.stringify(userState))
+}
+
+// Copy user-added lists from the legacy state to a new atom (userAddedListsSourcesAtom + listsStatesByChainAtom)
+// And purge the irrelevant localStorage state
+function migrateLegacyTokenLists() {
+  const listsStateRaw = localStorage.getItem('redux_localstorage_simple_lists')
+
+  if (!listsStateRaw) return
+
+  const listsState = JSON.parse(listsStateRaw)
+
+  const userAddedListsSources: ListsSourcesByNetwork = {
+    [SupportedChainId.MAINNET]: [],
+    [SupportedChainId.GNOSIS_CHAIN]: [],
+    [SupportedChainId.GOERLI]: [],
+  }
+
+  const tokenListsState: TokenListsState = {
+    [SupportedChainId.MAINNET]: {},
+    [SupportedChainId.GNOSIS_CHAIN]: {},
+    [SupportedChainId.GOERLI]: {},
+  }
+
+  Object.keys(listsState).forEach((chainIdStr) => {
+    const networkLists = listsState[chainIdStr]
+
+    if (!networkLists.byUrl) return
+
+    const chainId = +chainIdStr as SupportedChainId
+    const defaultLists = DEFAULT_TOKENS_LISTS[chainId]
+
+    Object.keys(networkLists.byUrl).forEach((listSource) => {
+      const list = networkLists.byUrl[listSource]
+
+      if (!list || !list.current) return
+
+      const isListInDefaults = defaultLists.find((defaultList) => defaultList.source === listSource)
+
+      if (isListInDefaults) return
+
+      userAddedListsSources[chainId].push({
+        source: listSource,
+      })
+
+      tokenListsState[chainId][listSource] = {
+        source: listSource,
+        list: list.current,
+        isEnabled: !!networkLists.activeListUrls?.includes(listSource),
+      }
+    })
+  })
+
+  localStorage.setItem('userAddedTokenListsAtom:v2', JSON.stringify(userAddedListsSources))
+  localStorage.setItem('allTokenListsInfoAtom:v2', JSON.stringify(tokenListsState))
+
+  localStorage.removeItem('redux_localstorage_simple_lists')
+}

libs/tokens/src/state/tokenLists/tokenListsStateAtom.ts

@@ -2,12 +2,10 @@ import { atom } from 'jotai'
 import { atomWithStorage } from 'jotai/utils'
 import { SupportedChainId } from '@cowprotocol/cow-sdk'
 
-import { ListsSourcesByNetwork, ListState } from '../../types'
+import { ListsSourcesByNetwork, TokenListsState } from '../../types'
 import { DEFAULT_TOKENS_LISTS } from '../../const/tokensLists'
 import { environmentAtom } from '../environmentAtom'
 
-type TokenListsState = Record<SupportedChainId, { [source: string]: ListState }>
-
 export const userAddedListsSourcesAtom = atomWithStorage<ListsSourcesByNetwork>('userAddedTokenListsAtom:v2', {
   [SupportedChainId.MAINNET]: [],
   [SupportedChainId.GNOSIS_CHAIN]: [],

libs/tokens/src/types.ts

@@ -7,7 +7,7 @@ export type ListSourceConfig = {
   source: string
 }
 
-export type ListsSourcesByNetwork = Record<SupportedChainId, ReadonlyArray<ListSourceConfig>>
+export type ListsSourcesByNetwork = Record<SupportedChainId, Array<ListSourceConfig>>
 
 export type TokensMap = { [address: string]: TokenInfo }
 
@@ -21,3 +21,5 @@ export interface ListState {
   priority?: number
   isEnabled?: boolean
 }
+
+export type TokenListsState = Record<SupportedChainId, { [source: string]: ListState }>