@pancakeswap/token-lists 0.0.2

package/schema/uniswap.json

@@ -0,0 +1,302 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://uniswap.org/tokenlist.schema.json",
+  "title": "Uniswap Token List",
+  "description": "Schema for lists of tokens compatible with the Uniswap Interface",
+  "definitions": {
+    "Version": {
+      "type": "object",
+      "description": "The version of the list, used in change detection",
+      "examples": [
+        {
+          "major": 1,
+          "minor": 0,
+          "patch": 0
+        }
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "major": {
+          "type": "integer",
+          "description": "The major version of the list. Must be incremented when tokens are removed from the list or token addresses are changed.",
+          "minimum": 0,
+          "examples": [1, 2]
+        },
+        "minor": {
+          "type": "integer",
+          "description": "The minor version of the list. Must be incremented when tokens are added to the list.",
+          "minimum": 0,
+          "examples": [0, 1]
+        },
+        "patch": {
+          "type": "integer",
+          "description": "The patch version of the list. Must be incremented for any changes to the list.",
+          "minimum": 0,
+          "examples": [0, 1]
+        }
+      },
+      "required": ["major", "minor", "patch"]
+    },
+    "TagIdentifier": {
+      "type": "string",
+      "description": "The unique identifier of a tag",
+      "minLength": 1,
+      "maxLength": 10,
+      "pattern": "^[\\w]+$",
+      "examples": ["compound", "stablecoin"]
+    },
+    "ExtensionIdentifier": {
+      "type": "string",
+      "description": "The name of a token extension property",
+      "minLength": 1,
+      "maxLength": 40,
+      "pattern": "^[\\w]+$",
+      "examples": ["color", "is_fee_on_transfer", "aliases"]
+    },
+    "ExtensionMap": {
+      "type": "object",
+      "description": "An object containing any arbitrary or vendor-specific token metadata",
+      "maxProperties": 10,
+      "propertyNames": {
+        "$ref": "#/definitions/ExtensionIdentifier"
+      },
+      "additionalProperties": {
+        "$ref": "#/definitions/ExtensionValue"
+      },
+      "examples": [
+        {
+          "color": "#000000",
+          "is_verified_by_me": true
+        },
+        {
+          "x-bridged-addresses-by-chain": {
+            "1": {
+              "bridgeAddress": "0x4200000000000000000000000000000000000010",
+              "tokenAddress": "0x4200000000000000000000000000000000000010"
+            }
+          }
+        }
+      ]
+    },
+    "ExtensionPrimitiveValue": {
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 42,
+          "examples": ["#00000"]
+        },
+        {
+          "type": "boolean",
+          "examples": [true]
+        },
+        {
+          "type": "number",
+          "examples": [15]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "ExtensionValue": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ExtensionPrimitiveValue"
+        },
+        {
+          "type": "object",
+          "maxProperties": 10,
+          "propertyNames": {
+            "$ref": "#/definitions/ExtensionIdentifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/definitions/ExtensionValueInner0"
+          }
+        }
+      ]
+    },
+    "ExtensionValueInner0": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ExtensionPrimitiveValue"
+        },
+        {
+          "type": "object",
+          "maxProperties": 10,
+          "propertyNames": {
+            "$ref": "#/definitions/ExtensionIdentifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/definitions/ExtensionValueInner1"
+          }
+        }
+      ]
+    },
+    "ExtensionValueInner1": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ExtensionPrimitiveValue"
+        }
+      ]
+    },
+    "TagDefinition": {
+      "type": "object",
+      "description": "Definition of a tag that can be associated with a token via its identifier",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the tag",
+          "pattern": "^[ \\w]+$",
+          "minLength": 1,
+          "maxLength": 20
+        },
+        "description": {
+          "type": "string",
+          "description": "A user-friendly description of the tag",
+          "pattern": "^[ \\w\\.,:]+$",
+          "minLength": 1,
+          "maxLength": 200
+        }
+      },
+      "required": ["name", "description"],
+      "examples": [
+        {
+          "name": "Stablecoin",
+          "description": "A token with value pegged to another asset"
+        }
+      ]
+    },
+    "TokenInfo": {
+      "type": "object",
+      "description": "Metadata for a single token in a token list",
+      "additionalProperties": false,
+      "properties": {
+        "chainId": {
+          "type": "integer",
+          "description": "The chain ID of the Ethereum network where this token is deployed",
+          "minimum": 1,
+          "examples": [1, 42]
+        },
+        "address": {
+          "type": "string",
+          "description": "The checksummed address of the token on the specified chain ID",
+          "pattern": "^0x[a-fA-F0-9]{40}$",
+          "examples": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"]
+        },
+        "decimals": {
+          "type": "integer",
+          "description": "The number of decimals for the token balance",
+          "minimum": 0,
+          "maximum": 255,
+          "examples": [18]
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the token",
+          "minLength": 1,
+          "maxLength": 40,
+          "pattern": "^[ \\w.'+\\-%/À-ÖØ-öø-ÿ:&\\[\\]\\(\\)]+$",
+          "examples": ["USD Coin"]
+        },
+        "symbol": {
+          "type": "string",
+          "description": "The symbol for the token; must be alphanumeric",
+          "pattern": "^[a-zA-Z0-9+\\-%/$.]+$",
+          "minLength": 1,
+          "maxLength": 20,
+          "examples": ["USDC"]
+        },
+        "logoURI": {
+          "type": "string",
+          "description": "A URI to the token logo asset; if not set, interface will attempt to find a logo based on the token address; suggest SVG or PNG of size 64x64",
+          "format": "uri",
+          "examples": ["ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"]
+        },
+        "tags": {
+          "type": "array",
+          "description": "An array of tag identifiers associated with the token; tags are defined at the list level",
+          "items": {
+            "$ref": "#/definitions/TagIdentifier"
+          },
+          "maxItems": 10,
+          "examples": ["stablecoin", "compound"]
+        },
+        "extensions": {
+          "$ref": "#/definitions/ExtensionMap"
+        }
+      },
+      "required": ["chainId", "address", "decimals", "name", "symbol"]
+    }
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the token list",
+      "minLength": 1,
+      "maxLength": 30,
+      "pattern": "^[\\w ]+$",
+      "examples": ["My Token List"]
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The timestamp of this list version; i.e. when this immutable version of the list was created"
+    },
+    "version": {
+      "$ref": "#/definitions/Version"
+    },
+    "tokens": {
+      "type": "array",
+      "description": "The list of tokens included in the list",
+      "items": {
+        "$ref": "#/definitions/TokenInfo"
+      },
+      "minItems": 1,
+      "maxItems": 10000
+    },
+    "keywords": {
+      "type": "array",
+      "description": "Keywords associated with the contents of the list; may be used in list discoverability",
+      "items": {
+        "type": "string",
+        "description": "A keyword to describe the contents of the list",
+        "minLength": 1,
+        "maxLength": 20,
+        "pattern": "^[\\w ]+$",
+        "examples": ["compound", "lending", "personal tokens"]
+      },
+      "maxItems": 20,
+      "uniqueItems": true
+    },
+    "tags": {
+      "type": "object",
+      "description": "A mapping of tag identifiers to their name and description",
+      "propertyNames": {
+        "$ref": "#/definitions/TagIdentifier"
+      },
+      "additionalProperties": {
+        "$ref": "#/definitions/TagDefinition"
+      },
+      "maxProperties": 20,
+      "examples": [
+        {
+          "stablecoin": {
+            "name": "Stablecoin",
+            "description": "A token with value pegged to another asset"
+          }
+        }
+      ]
+    },
+    "logoURI": {
+      "type": "string",
+      "description": "A URI for the logo of the token list; prefer SVG or PNG of size 256x256",
+      "format": "uri",
+      "examples": ["ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"]
+    }
+  },
+  "required": ["name", "timestamp", "version", "tokens"]
+}

package/src/getVersionUpgrade.ts

@@ -0,0 +1,33 @@
+/**
+ * Enum describing types of version differences
+ */
+import { Version } from './types'
+
+export enum VersionUpgrade {
+  NONE,
+  PATCH,
+  MINOR,
+  MAJOR,
+}
+
+/**
+ * Return the upgrade type from the base version to the update version.
+ * Note that downgrades and equivalent versions are both treated as `NONE`.
+ * @param base base list
+ * @param update update to the list
+ */
+export function getVersionUpgrade(base: Version, update: Version): VersionUpgrade {
+  if (update.major > base.major) {
+    return VersionUpgrade.MAJOR
+  }
+  if (update.major < base.major) {
+    return VersionUpgrade.NONE
+  }
+  if (update.minor > base.minor) {
+    return VersionUpgrade.MINOR
+  }
+  if (update.minor < base.minor) {
+    return VersionUpgrade.NONE
+  }
+  return update.patch > base.patch ? VersionUpgrade.PATCH : VersionUpgrade.NONE
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './wrappedTokenInfo'
+export * from './types'
+export * from './getVersionUpgrade'

package/src/types.ts

@@ -0,0 +1,45 @@
+type ExtensionValue = string | number | boolean | null | undefined
+
+export interface TokenInfo {
+  readonly chainId: number
+  readonly address: string
+  readonly name: string
+  readonly decimals: number
+  readonly symbol: string
+  readonly logoURI?: string
+  readonly tags?: string[]
+  readonly extensions?: {
+    readonly [key: string]:
+      | {
+          [key: string]:
+            | {
+                [key: string]: ExtensionValue
+              }
+            | ExtensionValue
+        }
+      | ExtensionValue
+  }
+}
+
+export interface Version {
+  readonly major: number
+  readonly minor: number
+  readonly patch: number
+}
+
+export interface Tags {
+  readonly [tagId: string]: {
+    readonly name: string
+    readonly description: string
+  }
+}
+
+export interface TokenList {
+  readonly name: string
+  readonly timestamp: string
+  readonly version: Version
+  readonly tokens: TokenInfo[]
+  readonly keywords?: string[]
+  readonly tags?: Tags
+  readonly logoURI?: string
+}

package/src/validator.ts

@@ -0,0 +1,4 @@
+import Ajv from 'ajv'
+import schema from './schema/pancakeswap.json'
+
+export const tokenListValidator = new Ajv({ allErrors: true }).compile(schema)

package/src/wrappedTokenInfo.ts

@@ -0,0 +1,63 @@
+import { SerializedToken, Token } from '@pancakeswap/swap-sdk-core'
+import { TokenInfo, TokenList } from './types'
+
+export interface SerializedWrappedToken extends SerializedToken {
+  chainId: number
+  address: string
+  decimals: number
+  symbol: string
+  name?: string
+  projectLink?: string
+  logoURI?: string
+}
+
+/**
+ * Token instances created from token info.
+ */
+export class WrappedTokenInfo extends Token {
+  public readonly logoURI: string | undefined
+
+  constructor(tokenInfo: TokenInfo) {
+    super(tokenInfo.chainId, tokenInfo.address, tokenInfo.decimals, tokenInfo.symbol, tokenInfo.name)
+    this.logoURI = tokenInfo.logoURI
+  }
+
+  public get serialize(): SerializedWrappedToken {
+    return {
+      address: this.address,
+      chainId: this.chainId,
+      decimals: this.decimals,
+      symbol: this.symbol,
+      name: this.name,
+      projectLink: this.projectLink,
+      logoURI: this.logoURI,
+    }
+  }
+}
+
+export type TokenAddressMap<TChainId extends number> = Readonly<{
+  [chainId in TChainId]: Readonly<{
+    [tokenAddress: string]: { token: WrappedTokenInfo; list: TokenList }
+  }>
+}>
+
+export function deserializeToken(serializedToken: SerializedWrappedToken): Token {
+  if (serializedToken.logoURI) {
+    return new WrappedTokenInfo({
+      chainId: serializedToken.chainId,
+      address: serializedToken.address,
+      decimals: serializedToken.decimals,
+      symbol: serializedToken.symbol || 'Unknown',
+      name: serializedToken.name || 'Unknown',
+      logoURI: serializedToken.logoURI,
+    })
+  }
+  return new Token(
+    serializedToken.chainId,
+    serializedToken.address,
+    serializedToken.decimals,
+    serializedToken.symbol,
+    serializedToken.name,
+    serializedToken.projectLink,
+  )
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "tsconfig/react-library",
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "skipLibCheck": true
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: {
+    index: './src/index.ts',
+    react: './react/index.ts',
+  },
+  format: ['esm', 'cjs'],
+  dts: true,
+})