feat(tokens): tokens and token lists library #3189

shoom3301 · 2023-10-10T07:06:44Z

Summary

The new tokens lib serves to provide a relevant list of tokens.
Globally, there are two groups of entities: lists and tokens.

The source of everything is libs/tokens/src/const/tokensList.json, it contains urls/ensNames of lists with priority and enabledByDefault flags. The content of the json file is stored into defaultListsSourcesAtom.
There is also userAddedListsSourcesAtom with the same data added by user.
It looks like:

TokensListsUpdater fetches lists sources once in 6 hours and stores results into listsStatesByChainAtom.
Example of the state inside:

To detect if a list is enabled we check isEnabled value in the list state, if it's not set, then we fallback to enabledByDefault in the list source. See more in listsEnabledStateAtom
Now we split tokens into two groups: active and inactive, depending on is a list enabled (see the previous point). In the "Select a token" modal we display only tokens from active lists by default. We use tokens from inactive lists only to search for a token. Splitting into active/inactive is concentrated in tokensStateAtom.
We also have user-added tokens and favorite tokens. Those entities are represented as CRUD atoms: userAddedTokensAtom and favouriteTokensAtom. We add then into general active tokens list as well (activeTokensAtom).
The lib also provides a component to display a token logo - TokenLogo. The main goal of the component is to find a valid URL for a logo. A token from some list might have an invalid URL or even don't have it, in this case we try other sources of images. See details below.
One of the most complex things in the lib is useSearchToken. The hook is searching into 4 sources: active lists, inactive lists, external API, and blockchain. useSWR is widely used inside to cache search results.
Any entity collection contains sets of data per network. I've chosen jotai style to derive data for a current network. It has one huge advantage - caching. If we use react hooks to derive data for a current network, it means we will calculate data on every subscription. On the other side, jotai calculates it once. To not spoil the lib dependencies I've added environmentAtom that actually contains only one property - chainId. The value is persisted from TokensListsUpdater.

Details

1. `TokensListsUpdater`

2. `TokenLogo`

3. `Lists and tokens state`

4. `Token search`

To Test

Please, test everything in #3201

vercel · 2023-10-10T07:06:48Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
swap-dev	✅ Ready (Inspect)	Visit Preview	Oct 27, 2023 11:53am

🌃 Cosmos ↗︎

alfetopito

Some comments.
Obviously did not test ;)

libs/tokens/src/const/tokensList.json

libs/tokens/src/hooks/tokens/unsupported/useIsUnsupportedToken.ts

libs/tokens/src/hooks/tokens/unsupported/useIsUnsupportedTokens.ts

libs/tokens/src/hooks/tokens/useSearchToken.ts

libs/tokens/src/index.ts

libs/tokens/src/updaters/TokensListsUpdater/index.ts

libs/tokens/src/utils/fetchTokenFromBlockchain.ts

libs/tokens/src/utils/getTokenLogoUrls.ts

libs/tokens/src/utils/tokenWithLogoFromToken.ts

libs/tokens/src/utils/validateTokenList.ts

anxolin

This PR is remarkable! This is really a great job.
I need to still review it a bit more, but here are some small initial comments.

The first impression of the lib API and state looks great to me!

libs/tokens/src/const/tokensLists.ts

libs/tokens/src/const/tokensList.json

libs/tokens/src/state/tokens/allTokensAtom.ts

libs/tokens/src/utils/tokenMapToList.ts

libs/tokens/src/hooks/tokens/useSearchToken.ts

anxolin · 2023-10-18T11:00:08Z

libs/tokens/src/index.ts

+
+// Types
+export * from './types'
+export type { TokensByAddress, TokensBySymbol } from './state/tokens/allTokensAtom'


nit: I would say, these types belong to th types.ts if they are part of the interface.
Then, it just happens that you actually also use them in the atom because in this case you made the persistance to match the interface

anxolin

SOFT APPROVE!
I really like the changes. The interface is super good!

One question. If i disable all lists, shouldn't i have zero tokens? I've disabled it, but I still have a lot of tokens:

… refactor/tokens-lib

socket-security · 2023-10-23T06:48:12Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

… refactor/tokens-lib

…cowswap into refactor/tokens-lib

* feat(tokens): tokens list, search and management ui (#3191) * refactor(tokens): remove excessive types and consts (#3196) * refactor(tokens): integrate TokenLogo component (#3197) * refactor(tokens): wire up components to new hooks (#3198) * refactor(tokens): remove Uniswap currency entities usage (#3199) * refactor(tokens): use new tokens UI and logic by default (#3200) * fix(tokens): fix e2e tests for tokens updates (#3193) * refactor(tokens): remove legacy code (#3194) * fix(tokens): fix tokens list loading state (#3201)

… refactor/tokens-lib # Conflicts: # apps/cowswap-frontend/src/common/pure/CurrencyLogo/index.tsx # apps/cowswap-frontend/src/common/updaters/ListsUpdater.ts # apps/cowswap-frontend/src/legacy/components/SearchModal/CommonBases/CommonBasesMod.tsx # apps/cowswap-frontend/src/legacy/components/SearchModal/CommonBases/index.ts # apps/cowswap-frontend/src/modules/tokensList/pure/TokenLogo/index.tsx # apps/cowswap-frontend/src/modules/tokensList/pure/TokenSourceTitle/index.tsx # apps/widget-configurator/src/app/configurator/index.tsx # libs/tokens/src/utils/validateTokenList.ts # package.json # yarn.lock

socket-security · 2023-10-26T12:51:47Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@tanstack/react-virtual	3.0.0-beta.68	None	`+1`	611 kB	tannerlinsley

🚮 Removed packages: @types/[email protected], @uniswap/[email protected], [email protected], [email protected], [email protected]

… refactor/tokens-lib # Conflicts: # apps/cowswap-frontend/src/modules/swap/containers/SwapWidget/index.tsx

feat(tokens): tokens and token lists library

c11771f

shoom3301 changed the title ~~feat(tokens): tokens and token lists library~~ [1] feat(tokens): tokens and token lists library Oct 10, 2023

vercel bot deployed to Preview October 10, 2023 07:11 View deployment

shoom3301 self-assigned this Oct 10, 2023

shoom3301 added the Tokens label Oct 10, 2023

refactor: refactor tokens state

98f4db7

vercel bot deployed to Preview October 11, 2023 06:13 View deployment

refactor: refactor tokens lib structure

64827ee

vercel bot deployed to Preview October 11, 2023 09:43 View deployment

chore: fix import

cc5e617

vercel bot deployed to Preview October 11, 2023 09:52 View deployment

shoom3301 requested a review from a team October 11, 2023 11:53

shoom3301 marked this pull request as ready for review October 11, 2023 11:53

shoom3301 mentioned this pull request Oct 11, 2023

[4.2] refactor(tokens): integrate TokenLogo component #3197

Merged

alfetopito approved these changes Oct 11, 2023

View reviewed changes

anxolin reviewed Oct 16, 2023

View reviewed changes

anxolin reviewed Oct 18, 2023

View reviewed changes

shoom3301 added 2 commits October 23, 2023 12:39

Merge branch 'develop' of https://github.com/cowprotocol/cowswap into…

7ebbbc8

… refactor/tokens-lib

chore: refactor tokens lib

ce75acf

vercel bot deployed to Preview October 23, 2023 06:50 View deployment

shoom3301 added 3 commits October 23, 2023 13:22

Merge branch 'develop' of https://github.com/cowprotocol/cowswap into…

24628e8

… refactor/tokens-lib

Merge branch 'refactor/tokens-lib' of https://github.com/cowprotocol/…

c913b78

…cowswap into refactor/tokens-lib

chore: fix build

d51a60d

vercel bot deployed to Preview October 23, 2023 07:26 View deployment

shoom3301 changed the title ~~[1] feat(tokens): tokens and token lists library~~ feat(tokens): tokens and token lists library Oct 26, 2023

chore: update yarn lock

0c10ee0

vercel bot deployed to Preview October 26, 2023 12:54 View deployment

shoom3301 added 2 commits October 27, 2023 17:47

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

d999cca

Merge branch 'develop' of https://github.com/cowprotocol/cowswap into…

a0358ef

… refactor/tokens-lib # Conflicts: # apps/cowswap-frontend/src/modules/swap/containers/SwapWidget/index.tsx

vercel bot deployed to Preview October 27, 2023 11:53 View deployment

shoom3301 merged commit 4880bdc into develop Oct 27, 2023
6 checks passed

github-actions bot locked and limited conversation to collaborators Oct 27, 2023

alfetopito deleted the refactor/tokens-lib branch October 31, 2023 10:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tokens): tokens and token lists library #3189

feat(tokens): tokens and token lists library #3189

shoom3301 commented Oct 10, 2023 •

edited

Loading

vercel bot commented Oct 10, 2023 •

edited by github-actions bot

Loading

alfetopito left a comment

anxolin left a comment

anxolin Oct 18, 2023

anxolin left a comment •

edited

Loading

socket-security bot commented Oct 23, 2023 •

edited

Loading

socket-security bot commented Oct 26, 2023

feat(tokens): tokens and token lists library #3189

feat(tokens): tokens and token lists library #3189

Conversation

shoom3301 commented Oct 10, 2023 • edited Loading

Summary

Details

1. TokensListsUpdater

2. TokenLogo

3. Lists and tokens state

4. Token search

To Test

vercel bot commented Oct 10, 2023 • edited by github-actions bot Loading

alfetopito left a comment

Choose a reason for hiding this comment

anxolin left a comment

Choose a reason for hiding this comment

anxolin Oct 18, 2023

Choose a reason for hiding this comment

anxolin left a comment • edited Loading

Choose a reason for hiding this comment

socket-security bot commented Oct 23, 2023 • edited Loading

socket-security bot commented Oct 26, 2023

shoom3301 commented Oct 10, 2023 •

edited

Loading

1. `TokensListsUpdater`

2. `TokenLogo`

3. `Lists and tokens state`

4. `Token search`

vercel bot commented Oct 10, 2023 •

edited by github-actions bot

Loading

anxolin left a comment •

edited

Loading

socket-security bot commented Oct 23, 2023 •

edited

Loading