feat(tokens): tokens and token lists library

apps/cowswap-frontend/tsconfig.json

@@ -15,6 +15,7 @@
       "@cowprotocol/widget-lib": ["../../../libs/widget-lib/src/index.ts"],
       "@cowprotocol/widget-react": ["../../../libs/widget-react/src/index.ts"],
       "@cowprotocol/snackbars": ["../../../libs/snackbars/src/index.ts"],
+      "@cowprotocol/tokens": ["../../../libs/tokens/src/index.ts"],
       "@cowprotocol/wallet": ["../../../libs/wallet/src/index.ts"],
       "@cowprotocol/assets/*": ["../../../libs/assets/src/*"],
       "@cowprotocol/common-const": ["../../../libs/common-const/src/index.ts"],

libs/tokens/.babelrc

@@ -0,0 +1,20 @@
+{
+  "presets": [
+    [
+      "@nx/react/babel",
+      {
+        "runtime": "automatic",
+        "useBuiltIns": "usage"
+      }
+    ]
+  ],
+  "plugins": [
+    [
+      "styled-components",
+      {
+        "pure": true,
+        "ssr": true
+      }
+    ]
+  ]
+}

libs/tokens/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["plugin:@nx/react", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/tokens/README.md

@@ -0,0 +1 @@
+# Tokens

libs/tokens/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'tokens',
+  preset: '../../jest.preset.js',
+  transform: {
+    '^(?!.*\\.(js|jsx|ts|tsx|css|json)$)': '@nx/react/plugins/jest',
+    '^.+\\.[tj]sx?$': ['babel-jest', { presets: ['@nx/react/babel'] }],
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/libs/tokens',
+}

libs/tokens/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@cowprotocol/tokens",
+  "version": "0.0.1",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  }
+}

libs/tokens/project.json

@@ -0,0 +1,46 @@
+{
+  "name": "@cowprotocol/tokens",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/tokens/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/tokens/**/*.{ts,tsx,js,jsx}"]
+      }
+    },
+    "build": {
+      "executor": "@nx/vite:build",
+      "outputs": ["{options.outputPath}"],
+      "defaultConfiguration": "production",
+      "options": {
+        "outputPath": "dist/libs/tokens"
+      },
+      "configurations": {
+        "development": {
+          "mode": "development"
+        },
+        "production": {
+          "mode": "production"
+        }
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/tokens/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    }
+  }
+}

libs/tokens/src/const/tokensList.json

@@ -0,0 +1,93 @@
+{
+  "1": [
+    {
+      "id": "hc_zMahDEXc_WMKgPAUpK",
+      "priority": 1,
+      "enabledByDefault": true,
+      "url": "https://files.cow.fi/tokens/CowSwap.json"
+    },
+    {
+      "id": "yi4K5DrkWkF3oiWweRjt3",
+      "priority": 2,
+      "enabledByDefault": true,
+      "url": "https://files.cow.fi/tokens/CoinGecko.json"
+    },
+    {
+      "id": "uJcgDR4A3MLQTrDsO34bA",
+      "priority": 3,
+      "url": "https://raw.githubusercontent.com/compound-finance/token-list/master/compound.tokenlist.json"
+    },
+    {
+      "id": "ePv0T2u5t0omW7HjPxGCL",
+      "priority": 4,
+      "ensName": "tokenlist.aave.eth"
+    },
+    {
+      "id": "vcO-K1VshU97uUeao5p_i",
+      "priority": 5,
+      "ensName": "synths.snx.eth"
+    },
+    {
+      "id": "pBJ4ZL5jeZ0DcLw4S-_85",
+      "priority": 6,
+      "ensName": "wrapped.tokensoft.eth"
+    },
+    {
+      "id": "4nKiWPc0hM6NgkZgTUnsy",
+      "priority": 7,
+      "url": "https://raw.githubusercontent.com/SetProtocol/uniswap-tokenlist/main/set.tokenlist.json"
+    },
+    {
+      "id": "5anQfdMTp5WyI2jklNvFB",
+      "priority": 8,
+      "url": "https://raw.githubusercontent.com/opynfinance/opyn-tokenlist/master/opyn-squeeth-tokenlist.json"
+    },
+    {
+      "id": "YBalvtWm1YVzQoe8J2AJa",
+      "priority": 9,
+      "url": "https://app.tryroll.com/tokens.json"
+    },
+    {
+      "id": "Pl-AdOGqGki43XDf7EoGV",
+      "priority": 10,
+      "ensName": "defi.cmc.eth"
+    },
+    {
+      "id": "JXGSqoOJDDY9hsY0Zn-Ue",
+      "priority": 11,
+      "ensName": "stablecoin.cmc.eth"
+    },
+    {
+      "id": "bffPi82n3c4zBzAbUQiV7",
+      "priority": 12,
+      "ensName": "t2crtokens.eth"
+    }
+  ],
+  "5": [
+    {
+      "id": "VZ--hetNymtoeZ5QUVhRT",
+      "priority": 1,
+      "enabledByDefault": true,
+      "url": "https://raw.githubusercontent.com/cowprotocol/token-lists/main/src/public/CowSwapGoerli.json"
+    },
+    {
+      "id": "uJcgDR4A3MLQTrDsO34bA",
+      "priority": 2,
+      "url": "https://raw.githubusercontent.com/compound-finance/token-list/master/compound.tokenlist.json"
+    }
+  ],
+  "100": [
+    {
+      "id": "hc_zMahDEXc_WMKgPAUpK",
+      "priority": 1,
+      "enabledByDefault": true,
+      "url": "https://files.cow.fi/tokens/CowSwap.json"
+    },
+    {
+      "id": "hMVOQpr3d-b-lCpYDDyIM",
+      "priority": 2,
+      "enabledByDefault": true,
+      "url": "https://tokens.honeyswap.org"
+    }
+  ]
+}

libs/tokens/src/const/tokensLists.ts

@@ -0,0 +1,4 @@
+import { TokenListsByNetwork } from '../types'
+import tokensList from './tokensList.json'
+
+export const DEFAULT_TOKENS_LISTS: TokenListsByNetwork = tokensList

libs/tokens/src/hooks/useActiveTokenListsIds.ts

@@ -0,0 +1,6 @@
+import { useAtomValue } from 'jotai'
+import { activeTokenListsMapAtom } from '../state/tokenLists/tokenListsStateAtom'
+
+export function useActiveTokenListsIds() {
+  return useAtomValue(activeTokenListsMapAtom)
+}

libs/tokens/src/hooks/useAddCustomTokenLists.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { addTokenListAtom } from '../state/tokenLists/tokenListsActionsAtom'
+
+export function useAddCustomTokenLists() {
+  return useSetAtom(addTokenListAtom)
+}

libs/tokens/src/hooks/useAddUnsupportedToken.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { addUnsupportedTokenAtom } from '../state/tokens/unsupportedTokensAtom'
+
+export function useAddUnsupportedToken() {
+  return useSetAtom(addUnsupportedTokenAtom)
+}

libs/tokens/src/hooks/useAllTokenListsInfo.ts

@@ -0,0 +1,7 @@
+import { useAtomValue } from 'jotai'
+import { allTokenListsInfoAtom } from '../state/tokenLists/tokenListsStateAtom'
+import { TokenListInfo } from '../types'
+
+export function useAllTokenListsInfo(): TokenListInfo[] {
+  return useAtomValue(allTokenListsInfoAtom)
+}

libs/tokens/src/hooks/useAllTokens.ts

@@ -0,0 +1,8 @@
+import { useAtomValue } from 'jotai'
+import { activeTokensAtom } from '../state/tokens/tokensAtom'
+
+import { TokenWithLogo } from '@cowprotocol/common-const'
+
+export function useAllTokens(): TokenWithLogo[] {
+  return useAtomValue(activeTokensAtom)
+}

libs/tokens/src/hooks/useAreThereTokensWithSameSymbol.ts

@@ -0,0 +1,18 @@
+import { useAtomValue } from 'jotai'
+import { useCallback } from 'react'
+
+import { isAddress } from '@cowprotocol/common-utils'
+import { tokensBySymbolAtom } from '../state/tokens/tokensAtom'
+
+export function useAreThereTokensWithSameSymbol(): (tokenAddressOrSymbol: string | null | undefined) => boolean {
+  const tokensBySymbol = useAtomValue(tokensBySymbolAtom)
+
+  return useCallback(
+    (tokenAddressOrSymbol: string | null | undefined) => {
+      if (!tokenAddressOrSymbol || isAddress(tokenAddressOrSymbol)) return false
+
+      return tokensBySymbol[tokenAddressOrSymbol.toLowerCase()]?.length > 1
+    },
+    [tokensBySymbol]
+  )
+}

libs/tokens/src/hooks/useFavouriteTokens.ts

@@ -0,0 +1,7 @@
+import { useAtomValue } from 'jotai'
+import { favouriteTokensListAtom } from '../state/tokens/favouriteTokensAtom'
+import { TokenWithLogo } from '@cowprotocol/common-const'
+
+export function useFavouriteTokens(): TokenWithLogo[] {
+  return useAtomValue(favouriteTokensListAtom)
+}

libs/tokens/src/hooks/useImportTokenCallback.ts

@@ -0,0 +1,7 @@
+import { TokenWithLogo } from '@cowprotocol/common-const'
+import { useSetAtom } from 'jotai'
+import { addUserTokenAtom } from '../state/tokens/userAddedTokensAtom'
+
+export function useImportTokenCallback(): (tokens: TokenWithLogo[]) => void {
+  return useSetAtom(addUserTokenAtom)
+}

libs/tokens/src/hooks/useIsTradeUnsupported.ts

@@ -0,0 +1,13 @@
+import { Currency } from '@uniswap/sdk-core'
+import { useIsUnsupportedToken } from './useIsUnsupportedToken'
+
+export function useIsTradeUnsupported(
+  inputCurrency: Currency | null | undefined,
+  outputCurrency: Currency | null | undefined
+): boolean {
+  const isUnsupportedToken = useIsUnsupportedToken()
+  const isInputCurrencyUnsupported = inputCurrency?.isNative ? false : !!isUnsupportedToken(inputCurrency?.address)
+  const isOutputCurrencyUnsupported = outputCurrency?.isNative ? false : !!isUnsupportedToken(outputCurrency?.address)
+
+  return isInputCurrencyUnsupported || isOutputCurrencyUnsupported
+}

libs/tokens/src/hooks/useIsUnsupportedToken.ts

@@ -0,0 +1,21 @@
+import { useUnsupportedTokens } from './useUnsupportedTokens'
+import { useCallback } from 'react'
+
+export function useIsUnsupportedToken() {
+  const unsupportedTokens = useUnsupportedTokens()
+
+  return useCallback(
+    (address?: string) => {
+      const state = address && unsupportedTokens[address.toLowerCase()]
+
+      if (state) {
+        return {
+          ...state,
+          address,
+        }
+      }
+      return false
+    },
+    [unsupportedTokens]
+  )
+}

libs/tokens/src/hooks/useIsUnsupportedTokens.ts

@@ -0,0 +1,18 @@
+import { useUnsupportedTokens } from './useUnsupportedTokens'
+import { useCallback } from 'react'
+
+export function useIsUnsupportedTokens() {
+  const unsupportedTokens = useUnsupportedTokens()
+
+  return useCallback(
+    ({ sellToken, buyToken }: { sellToken: string | null | undefined; buyToken: string | null | undefined }) => {
+      if (!unsupportedTokens) return false
+
+      return !!(
+        (sellToken && unsupportedTokens[sellToken.toLowerCase()]) ||
+        (buyToken && unsupportedTokens[buyToken.toLowerCase()])
+      )
+    },
+    [unsupportedTokens]
+  )
+}

libs/tokens/src/hooks/useRemoveTokenCallback.ts

@@ -0,0 +1,11 @@
+import { TokenWithLogo } from '@cowprotocol/common-const'
+import { useSetAtom } from 'jotai'
+import { removeUserTokenAtom } from '../state/tokens/userAddedTokensAtom'
+
+export function useRemoveTokenCallback(): (token: TokenWithLogo) => void {
+  const removeUserToken = useSetAtom(removeUserTokenAtom)
+
+  return (token: TokenWithLogo) => {
+    removeUserToken(token)
+  }
+}

libs/tokens/src/hooks/useRemoveTokenList.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { removeTokenListAtom } from '../state/tokenLists/tokenListsActionsAtom'
+
+export function useRemoveTokenList() {
+  return useSetAtom(removeTokenListAtom)
+}

libs/tokens/src/hooks/useRemoveUnsupportedToken.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { removeUnsupportedTokenAtom } from '../state/tokens/unsupportedTokensAtom'
+
+export function useRemoveUnsupportedToken() {
+  return useSetAtom(removeUnsupportedTokenAtom)
+}

libs/tokens/src/hooks/useResetFavouriteTokens.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { resetFavouriteTokensAtom } from '../state/tokens/favouriteTokensAtom'
+
+export function useResetFavouriteTokens() {
+  return useSetAtom(resetFavouriteTokensAtom)
+}

libs/tokens/src/hooks/useResetUserTokensCallback.ts

@@ -0,0 +1,6 @@
+import { useSetAtom } from 'jotai'
+import { resetUserTokenAtom } from '../state/tokens/userAddedTokensAtom'
+
+export function useResetUserTokensCallback(): () => void {
+  return useSetAtom(resetUserTokenAtom)
+}