@pancakeswap/token-lists 0.0.17 → 0.1.1

package/react/reducerHelpers.ts

@@ -0,0 +1,111 @@
+import { getVersionUpgrade, VersionUpgrade } from '../src/getVersionUpgrade'
+import { TokenList } from '../src/types'
+
+// Mutable state type for reducer operations
+type MutableListsState = {
+  byUrl: {
+    [url: string]: {
+      current: TokenList | null
+      pendingUpdate: TokenList | null
+      loadingRequestId: string | null
+      error: string | null
+    }
+  }
+  lastInitializedDefaultListOfLists?: string[]
+  activeListUrls: string[] | undefined
+}
+
+/**
+ * Core function to set a single list to pending state
+ */
+export const setPendingTokenList = (state: MutableListsState, url: string, requestId: string): void => {
+  const current = state.byUrl[url]?.current ?? null
+  const pendingUpdate = state.byUrl[url]?.pendingUpdate ?? null
+
+  state.byUrl[url] = {
+    current,
+    pendingUpdate,
+    loadingRequestId: requestId,
+    error: null,
+  }
+}
+
+/**
+ * Core function to set a single list to fulfilled state
+ */
+export const setFulfilledTokenList = (
+  state: MutableListsState,
+  url: string,
+  tokenList: TokenList,
+  requestId: string,
+  DEFAULT_ACTIVE_LIST_URLS: string[],
+): boolean => {
+  const current = state.byUrl[url]?.current
+  const loadingRequestId = state.byUrl[url]?.loadingRequestId
+
+  // no-op if update does nothing
+  if (current) {
+    const upgradeType = getVersionUpgrade(current.version, tokenList.version)
+
+    if (upgradeType === VersionUpgrade.NONE) return false
+    if (loadingRequestId === null || loadingRequestId === requestId) {
+      state.byUrl[url] = {
+        ...state.byUrl[url],
+        loadingRequestId: null,
+        error: null,
+        current,
+        pendingUpdate: tokenList,
+      }
+    }
+    return false // not a new list, so no activation needed
+  }
+  // activate if on default active
+  if (DEFAULT_ACTIVE_LIST_URLS.includes(url) && state.activeListUrls && !state.activeListUrls.includes(url)) {
+    state.activeListUrls.push(url)
+  }
+
+  state.byUrl[url] = {
+    ...state.byUrl[url],
+    loadingRequestId: null,
+    error: null,
+    current: tokenList,
+    pendingUpdate: null,
+  }
+  return true // new list, might need activation
+}
+
+/**
+ * Core function to set a single list to rejected state
+ */
+export const setRejectedTokenList = (
+  state: MutableListsState,
+  url: string,
+  requestId: string,
+  errorMessage: string,
+): void => {
+  if (state.byUrl[url]?.loadingRequestId !== requestId) {
+    // no-op since it's not the latest request
+    return
+  }
+
+  state.byUrl[url] = {
+    ...state.byUrl[url],
+    loadingRequestId: null,
+    error: errorMessage,
+    current: null,
+    pendingUpdate: null,
+  }
+}
+
+/**
+ * Batch activate URLs if needed
+ */
+export const batchActivateUrls = (state: MutableListsState, urls: string[]): void => {
+  if (urls.length > 0 && state.activeListUrls) {
+    urls.forEach((url) => {
+      if (!state.activeListUrls!.includes(url)) {
+        state.activeListUrls!.push(url)
+      }
+    })
+  }
+}

package/react/useFetchListCallback.ts

@@ -26,7 +26,7 @@ function useFetchListCallback(
           return tokenList
         })
         .catch((error) => {
-          console.error(`Failed to get list at url ${listUrl}`, error)
+          console.warn(`Failed to get list at url ${listUrl}`, error)
           if (sendDispatch) {
             dispatch(fetchTokenList.rejected({ url: listUrl, requestId, errorMessage: error.message }))
           }

package/schema/pancakeswap.json

@@ -11,7 +11,7 @@
         {
           "major": 1,
           "minor": 0,
-          "patch": 0
+          "patch": 1
         }
       ],
       "additionalProperties": false,
@@ -196,17 +196,17 @@
           "type": "string",
           "description": "The name of the token",
           "minLength": 1,
-          "maxLength": 40,
-          "pattern": "^[ \\w.'+\\-%/À-ÖØ-öø-ÿ:&\\[\\]\\(\\)]+$",
-          "examples": ["USD Coin"]
+          "maxLength": 60,
+          "pattern": "^[ \\w.'+\\-%/,\\$À-ÖØ-öø-ÿ:&\\[\\]\\(\\)\\u4e00-\\u9fa5]+$",
+          "examples": ["USD Coin", "币安币"]
         },
         "symbol": {
           "type": "string",
           "description": "The symbol for the token; must be alphanumeric",
-          "pattern": "^[a-zA-Z0-9+\\-%/$.\\s]+$",
+          "pattern": "^[a-zA-Z0-9+\\-%/$.\\s_\\u4e00-\\u9fa5]+$",
           "minLength": 1,
           "maxLength": 20,
-          "examples": ["USDC"]
+          "examples": ["USDC", "币安"]
         },
         "logoURI": {
           "type": "string",
@@ -256,14 +256,14 @@
           "type": "string",
           "description": "The name of the token",
           "minLength": 1,
-          "maxLength": 40,
-          "pattern": "^[ \\w.'+\\-%/À-ÖØ-öø-ÿ:&\\[\\]\\(\\)]+$",
+          "maxLength": 60,
+          "pattern": "^[ \\w.'+\\-%/,\\$À-ÖØ-öø-ÿ:&\\[\\]\\(\\)]+$",
           "examples": ["USD Coin"]
         },
         "symbol": {
           "type": "string",
           "description": "The symbol for the token; must be alphanumeric",
-          "pattern": "^[a-zA-Z0-9+\\-%/$.]+$",
+          "pattern": "^[a-zA-Z0-9+\\-%/$._]+$",
           "minLength": 1,
           "maxLength": 20,
           "examples": ["USDC"]
@@ -356,6 +356,15 @@
       "description": "A URI for the logo of the token list; prefer SVG or PNG of size 256x256",
       "format": "uri",
       "examples": ["ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"]
+    },
+    "extensions": {
+      "type": "object",
+      "description": "An object containing arbitrary or vendor-specific token list metadata",
+      "propertyNames": {
+        "$ref": "#/definitions/ExtensionIdentifier"
+      },
+      "additionalProperties": true,
+      "maxProperties": 10
     }
   },
   "if": {

package/src/index.test.ts

@@ -9,6 +9,7 @@ test('exports', () => {
       "VersionUpgrade",
       "getVersionUpgrade",
       "createFilterToken",
+      "isScaledUIAmountToken",
     ]
   `)
 })

package/src/index.ts

@@ -2,3 +2,4 @@ export * from './wrappedTokenInfo'
 export * from './types'
 export * from './getVersionUpgrade'
 export * from './filtering'
+export * from './scaledUIAmount'

package/src/scaledUIAmount.ts

@@ -0,0 +1,41 @@
+// Token-list `extensions.scaledUIAmount` metadata for ERC-8056 (Scaled UI Amount) tokens.
+//
+// Curated by the indexer/CMS at ingestion time. The boolean `enabled` flag is the
+// load-bearing FE-side check; other fields are snapshots / hints (the live multiplier
+// is always re-read from chain via the `useScaledUIAmountMetadata` hook).
+//
+// See BNB Chain partner integration doc v1.0 (8 Apr 2026) §8.2.4 for the upstream
+// shape this is modeled after.
+
+import type { TokenInfo } from './types'
+
+/**
+ * Static metadata identifying an ERC-8056 (Scaled UI Amount) token in a token list.
+ * `enabled: true` is the only field FE consumes for routing decisions; everything
+ * else is hint/snapshot data refreshed live from chain.
+ */
+export interface ScaledUIAmountExtension {
+  /** Set to `true` for tokens that implement ERC-8056. The load-bearing FE check. */
+  enabled: boolean
+  /** Optional snapshot of the live multiplier at the time of indexing (18-decimal fixed). */
+  multiplier?: string
+  /** Optional human-readable multiplier (e.g. `"2.0"`). Display hint only. */
+  multiplierFormatted?: string
+  /** ERC-165 interface IDs the contract claims to support. */
+  interfaceIds?: string[]
+}
+
+/**
+ * Returns true if a token-list entry is flagged as ERC-8056 enabled by the indexer.
+ * Tokens lacking the extension or with `enabled: false` are treated as standard ERC-20s
+ * (identity multiplier `1.0×`); the FE never falls into ScaledUI math for these.
+ *
+ * Note: the load-bearing decision lives here, not on the `Token` class. Token
+ * instances stay pure identity objects per the architectural decision in the
+ * implementation doc.
+ */
+export function isScaledUIAmountToken(token: Pick<TokenInfo, 'extensions'>): boolean {
+  const ext = token.extensions?.scaledUIAmount
+  if (!ext || typeof ext !== 'object' || Array.isArray(ext)) return false
+  return (ext as { enabled?: unknown }).enabled === true
+}

package/src/types.ts

@@ -43,4 +43,5 @@ export interface TokenList {
   readonly keywords?: string[]
   readonly tags?: Tags
   readonly logoURI?: string
+  readonly extensions?: Record<string, unknown>
 }

package/src/wrappedTokenInfo.ts

@@ -17,9 +17,17 @@ export interface SerializedWrappedToken extends SerializedToken {
 export class WrappedTokenInfo extends Token {
   public readonly logoURI: string | undefined
 
+  /**
+   * Preserves the token-list `extensions` bag (curator-set metadata like
+   * `bridgeInfo`, `scaledUIAmount.enabled`, etc.). Stored as a readonly reference;
+   * not serialised back out of the class (kept in-memory only).
+   */
+  public readonly extensions: TokenInfo['extensions']
+
   constructor(tokenInfo: TokenInfo) {
     super(tokenInfo.chainId, tokenInfo.address, tokenInfo.decimals, tokenInfo.symbol, tokenInfo.name)
     this.logoURI = tokenInfo.logoURI
+    this.extensions = tokenInfo.extensions
   }
 
   public get serialize(): SerializedWrappedToken {