@pancakeswap/token-lists 0.0.14 → 0.0.16

package/react/getTokenList.ts

@@ -1,61 +1,44 @@
 /* eslint-disable no-continue */
 /* eslint-disable no-await-in-loop */
-import { TokenList, TokenInfo } from '@pancakeswap/token-lists'
 import uriToHttp from '@pancakeswap/utils/uriToHttp'
-import remove from 'lodash/remove'
-import Ajv from 'ajv'
 import schema from '../schema/pancakeswap.json'
-
-export const tokenListValidator = new Ajv({ allErrors: true }).compile(schema)
+import { TokenList } from '../src/types'
 
 /**
  * Contains the logic for resolving a list URL to a validated token list
  * @param listUrl list url
  */
-export default async function getTokenList(listUrl: string): Promise<TokenList> {
+export async function getTokenList(listUrl: string): Promise<TokenList | undefined> {
   const urls: string[] = uriToHttp(listUrl)
+  const { default: Ajv } = await import('ajv')
+  const validator = new Ajv({ allErrors: true }).compile(schema)
 
-  for (let i = 0; i < urls.length; i++) {
-    const url = urls[i]
-    const isLast = i === urls.length - 1
-    let response
+  for (const [i, url] of urls.entries()) {
     try {
-      response = await fetch(url)
+      const json = await fetchJson(url)
+      if (!validator(json)) {
+        const preFilterErrors = validator.errors
+        json.tokens = json.tokens.filter((token: any) => validator({ ...json, tokens: [token] }))
+        if (!validator(json)) {
+          const errors = validator.errors
+          throw new Error(`Validation failed after filtering: ${JSON.stringify(errors)}`)
+        }
+        console.warn(`Pre-filter validation errors: ${JSON.stringify(preFilterErrors)}`)
+      }
+      return json as TokenList
     } catch (error) {
-      console.error('Failed to fetch list', listUrl, error)
-      if (isLast) throw new Error(`Failed to download list ${listUrl}`)
-      continue
-    }
+      // if (i === urls.length - 1) {
+      // throw new Error(`Failed to download list ${listUrl}`)
+      // }
 
-    if (!response.ok) {
-      if (isLast) throw new Error(`Failed to download list ${listUrl}`)
-      continue
+      return undefined
     }
-
-    const json = await response.json()
-    if (!tokenListValidator(json)) {
-      const preFilterValidationErrors: string =
-        tokenListValidator.errors?.reduce<string>((memo, error) => {
-          const add = `${(error as any).dataPath} ${error.message ?? ''}`
-          return memo.length > 0 ? `${memo}; ${add}` : `${add}`
-        }, '') ?? 'unknown error'
-      if (json.tokens) {
-        remove<TokenInfo>(json.tokens, (token) => {
-          return !tokenListValidator({ ...json, tokens: [token] })
-        })
-      }
-      if (!tokenListValidator(json)) {
-        const validationErrors: string =
-          tokenListValidator.errors?.reduce<string>((memo, error) => {
-            const add = `${(error as any).dataPath} ${error.message ?? ''}`
-            return memo.length > 0 ? `${memo}; ${add}` : `${add}`
-          }, '') ?? 'unknown error'
-        throw new Error(`Token list ${url} failed validation: ${validationErrors}`)
-      } else {
-        console.warn(`Token list ${url} validation failed before token filtering: ${preFilterValidationErrors}`)
-      }
-    }
-    return json as TokenList
   }
   throw new Error('Unrecognized list URL protocol.')
 }
+
+async function fetchJson(url: string): Promise<any> {
+  const res = await fetch(url)
+  if (!res.ok) throw new Error(`Failed to fetch: ${url}`)
+  return res.json()
+}

package/react/index.test.ts

@@ -4,8 +4,6 @@ import * as exports from './index'
 test('exports', () => {
   expect(Object.keys(exports)).toMatchInlineSnapshot(`
     [
-      "NEW_LIST_STATE",
-      "createTokenListReducer",
       "fetchTokenList",
       "addList",
       "removeList",
@@ -14,7 +12,12 @@ test('exports', () => {
       "acceptListUpdate",
       "rejectVersionUpdate",
       "updateListVersion",
+      "getTokenList",
+      "findTokenByAddress",
+      "findTokenBySymbol",
       "createListsAtom",
+      "NEW_LIST_STATE",
+      "createTokenListReducer",
       "useFetchListCallback",
     ]
   `)

package/react/index.ts

@@ -1,4 +1,5 @@
-export * from './reducer'
 export * from './actions'
+export * from './getTokenList'
 export * from './lists'
+export * from './reducer'
 export { default as useFetchListCallback } from './useFetchListCallback'

package/react/lists.ts

@@ -1,7 +1,10 @@
+import { nanoid } from '@reduxjs/toolkit'
 import { atom, useAtom, useAtomValue } from 'jotai'
-import { atomWithStorage, loadable } from 'jotai/utils'
+import { atomFamily, atomWithStorage, loadable } from 'jotai/utils'
 import { type AsyncStorage } from 'jotai/vanilla/utils/atomWithStorage'
 import localForage from 'localforage'
+import { fetchTokenList } from './actions'
+import { getTokenList } from './getTokenList'
 import { ListsState } from './reducer'
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -16,6 +19,26 @@ const noopStorage: AsyncStorage<any> = {
 // eslint-disable-next-line symbol-description
 const EMPTY = Symbol()
 
+export function findTokenByAddress(state: ListsState, chainId: number, address: string) {
+  const urls = state.activeListUrls ?? Object.keys(state.byUrl)
+  for (const url of urls) {
+    const list = state.byUrl[url]?.current
+    const token = list?.tokens.find((t) => t.chainId === chainId && t.address.toLowerCase() === address.toLowerCase())
+    if (token) return token
+  }
+  return undefined
+}
+
+export function findTokenBySymbol(state: ListsState, chainId: number, symbol: string) {
+  const urls = state.activeListUrls ?? Object.keys(state.byUrl)
+  for (const url of urls) {
+    const list = state.byUrl[url]?.current
+    const token = list?.tokens.find((t) => t.chainId === chainId && t.symbol.toLowerCase() === symbol.toLowerCase())
+    if (token) return token
+  }
+  return undefined
+}
+
 export const createListsAtom = (storeName: string, reducer: any, initialState: any) => {
   /**
    * Persist you redux state using IndexedDB
@@ -62,6 +85,32 @@ export const createListsAtom = (storeName: string, reducer: any, initialState: a
 
   const isReadyAtom = loadable(listsStorageAtom)
 
+  const tokenAtom = atomFamily((key: { chainId: number; address: string }) =>
+    atom((get) => findTokenByAddress(get(defaultStateAtom), key.chainId, key.address)),
+  )
+
+  const tokenBySymbolAtom = atomFamily((key: { chainId: number; symbol: string }) =>
+    atom((get) => findTokenBySymbol(get(defaultStateAtom), key.chainId, key.symbol)),
+  )
+
+  const fetchListAtom = atom<null, [string], Promise<void>>(null, async (get, set, url) => {
+    const state = get(defaultStateAtom)
+    const listState = state.byUrl[url]
+    if (listState?.current || listState?.loadingRequestId) {
+      return
+    }
+
+    const requestId = nanoid()
+    set(defaultStateAtom, fetchTokenList.pending({ url, requestId }))
+
+    try {
+      const tokenList = await getTokenList(url)
+      set(defaultStateAtom, fetchTokenList.fulfilled({ url, tokenList: tokenList!, requestId }))
+    } catch (error: any) {
+      set(defaultStateAtom, fetchTokenList.rejected({ url, requestId, errorMessage: error.message }))
+    }
+  })
+
   function useListState() {
     return useAtom(defaultStateAtom)
   }
@@ -73,6 +122,9 @@ export const createListsAtom = (storeName: string, reducer: any, initialState: a
 
   return {
     listsAtom: defaultStateAtom,
+    tokenAtom,
+    tokenBySymbolAtom,
+    fetchListAtom,
     useListStateReady,
     useListState,
   }

package/react/useFetchListCallback.ts

@@ -1,7 +1,8 @@
 import { nanoid } from '@reduxjs/toolkit'
 import { useCallback } from 'react'
-import { fetchTokenList } from './actions'
 import { TokenList } from '../src/types'
+import { fetchTokenList } from './actions'
+import { getTokenList } from './getTokenList'
 
 function useFetchListCallback(
   dispatch: (action?: unknown) => void,
@@ -13,10 +14,12 @@ function useFetchListCallback(
       if (sendDispatch) {
         dispatch(fetchTokenList.pending({ requestId, url: listUrl }))
       }
-      // lazy load avj and token list schema
-      const getTokenList = (await import('./getTokenList')).default
       return getTokenList(listUrl)
         .then((tokenList) => {
+          if (!tokenList) {
+            throw new Error('Token list not found')
+          }
+
           if (sendDispatch) {
             dispatch(fetchTokenList.fulfilled({ url: listUrl, tokenList, requestId }))
           }

package/dist/chunk-2L3ZO4UM.mjs

@@ -1,41 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-export { __async, __spreadProps, __spreadValues };

package/dist/chunk-4TPCCB4K.js

@@ -1,45 +0,0 @@
-'use strict';
-
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-exports.__async = __async;
-exports.__spreadProps = __spreadProps;
-exports.__spreadValues = __spreadValues;