feat(permit): fetch token name from chain #3374

alfetopito · 2023-11-09T18:39:56Z

Summary

Fetching token name from the contracts rather than relying on what comes from the token lists

Also, this PR changes the schema in 2 important ways:

The fetched name is now stored
No longer storing false values for unsupported. Instead, it'll have the type unsupported

A new version of the @cowprotocol/permit-utils should be published from these changes, so it can be used on token-lists repo.

To Test

Test the regular permit stuff

Should work as it is, showing permit flags

Import a permittable token not in any list, such as 0x0001a500a6b18995b03f44bb040a5ffc28e45cb0 on mainnet

Should be recognized and be tradeable with permit as expected

vercel · 2023-11-09T18:40:03Z

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

Name	Status	Preview	Comments	Updated (UTC)
cosmos	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 17, 2023 9:18am
swap-dev	✅ Ready (Inspect)	Visit Preview		Nov 17, 2023 9:18am
widget-configurator	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 17, 2023 9:18am

alfetopito · 2023-11-09T18:44:47Z

apps/cowswap-frontend/src/modules/permit/hooks/usePreGeneratedPermitInfo.ts

+type OldPermitInfo = PermitInfo | false
+
+const UNSUPPORTED: PermitInfo = { type: 'unsupported' }
+
+/**
+ * Handles data migration from former way of storing unsupported tokens to the new one
+ */
+function migrateData(data: Record<string, OldPermitInfo>): Record<string, PermitInfo> {
+  const migrated: Record<string, PermitInfo> = {}
+
+  for (const [k, v] of Object.entries(data)) {
+    if (v === false) {
+      migrated[k] = UNSUPPORTED
+    } else {
+      migrated[k] = v
+    }
+  }
+
+  return migrated
+}


This should only be needed until this hits prod and the token-lists preGenerated version is not updated.

alfetopito · 2023-11-09T18:45:15Z

apps/cowswap-frontend/src/modules/permit/state/permittableTokensAtom.ts

-export const permittableTokensAtom = atomWithStorage<PermittableTokens>('permittableTokens:v1', {
+export const permittableTokensAtom = atomWithStorage<PermittableTokens>('permittableTokens:v2', {


Bumping the version to not use the old formats anymore

alfetopito · 2023-11-09T18:46:35Z

libs/permit-utils/src/abi/erc20.json

+[
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  }
+]


It's a duplication, I know, but I want to have just the minimal ABI possible.
Also, if I would use the one from the abis lib, it would create an inner dependency and I don't want that for this lib

alfetopito · 2023-11-09T18:47:56Z

libs/permit-utils/src/types.ts

+export type PermitType = 'dai-like' | 'eip-2612' | 'unsupported'

-export type SupportedPermitInfo = {
+export type PermitInfo = {
  type: PermitType
-  version: string | undefined // Some tokens have it different than `1`, and won't work without it
+  // TODO: make it not optional once token-lists is migrated
+  name?: string
+  version?: string | undefined // Some tokens have it different than `1`, and won't work without it
 }
-type UnsupportedPermitInfo = false
-export type PermitInfo = SupportedPermitInfo | UnsupportedPermitInfo


Biggest change:

Remove false version in favor of unsupported type

Add name

libs/permit-utils/src/utils/getTokenName.ts

socket-security · 2023-11-10T16:48:54Z

No top level dependency changes detected. Learn more about Socket for GitHub ↗︎

anxolin

is it expected to not get the gass-free message?

apps/cowswap-frontend/src/modules/permit/utils/handlePermit.ts

alfetopito · 2023-11-13T18:22:47Z

is it expected to not get the gass-free message?

It should be. At least after it has been imported.
Did you try before or after importing it?

anxolin · 2023-11-14T09:05:31Z

Did you try before or after importing it?

Both, the picture is after importing

alfetopito · 2023-11-14T10:46:50Z

Did you try before or after importing it?

Both, the picture is after importing

Hmm, not able to reproduce it.

I imported it via the address, and with this method I can see 2 ways if importing it.
And both show the right flag after imported.
Importing it by symbol also has the same behaviour.

Can you share the contents of your permittableTokens:v2 localStorage key?

It might be that your local check has failed and it cached the failure.

…d error

alfetopito self-assigned this Nov 9, 2023

alfetopito added the permit label Nov 9, 2023

alfetopito requested a review from a team November 9, 2023 18:40

vercel bot deployed to Preview – widget-configurator November 9, 2023 18:41 View deployment

vercel bot deployed to Preview – cosmos November 9, 2023 18:41 View deployment

vercel bot deployed to Preview – swap-dev November 9, 2023 18:41 View deployment

alfetopito commented Nov 9, 2023

View reviewed changes

shoom3301 reviewed Nov 10, 2023

View reviewed changes

libs/permit-utils/src/utils/getTokenName.ts Show resolved Hide resolved

alfetopito mentioned this pull request Nov 10, 2023

feat(permit): with token name cowprotocol/token-lists#312

Merged

alfetopito force-pushed the permit/fetch-name-from-chain branch from 7fee0c2 to eb1011f Compare November 10, 2023 16:44

vercel bot deployed to Preview – widget-configurator November 10, 2023 16:48 View deployment

vercel bot deployed to Preview – cosmos November 10, 2023 16:48 View deployment

vercel bot deployed to Preview – swap-dev November 10, 2023 16:49 View deployment

alfetopito force-pushed the permit/fetch-name-from-chain branch from eb1011f to d8ee7d3 Compare November 13, 2023 09:27

vercel bot deployed to Preview – widget-configurator November 13, 2023 09:31 View deployment

vercel bot deployed to Preview – cosmos November 13, 2023 09:31 View deployment

vercel bot deployed to Preview – swap-dev November 13, 2023 09:32 View deployment

anxolin reviewed Nov 13, 2023

View reviewed changes

apps/cowswap-frontend/src/modules/permit/utils/handlePermit.ts Show resolved Hide resolved

alfetopito force-pushed the permit/fetch-name-from-chain branch from d8ee7d3 to 0390891 Compare November 14, 2023 11:09

vercel bot deployed to Preview – widget-configurator November 14, 2023 11:11 View deployment

vercel bot deployed to Preview – cosmos November 14, 2023 11:11 View deployment

vercel bot deployed to Preview – swap-dev November 14, 2023 11:12 View deployment

alfetopito requested review from anxolin and shoom3301 November 14, 2023 13:28

vercel bot deployed to Preview – widget-configurator November 14, 2023 17:09 View deployment

alfetopito added 18 commits November 17, 2023 08:55

feat: add utils fn getTokenName

4c8c262

feat: fetch token name when fetching permit info

4a60c99

feat: make tokenName optional on GetTokenPermitInfoParams

b7e7674

feat: migrate preGenerated permit info to new format

c78b001

chore: more tokenName optional changes

7c76c95

chore: add TODOs

227016a

refactor: return error rather than throwing

4e80ac9

chore: bump permit-utils package version

629fac9

chore: bump permittableTokens atom version to v2

4d2d666

refactor: use isSupportedPermitInfo in a few places

39db8a6

chore: do a type guard in the helper fn so there's no need for casting

ec82c5f

chore: return error when name fetching fails due to network issues

d3bf9a2

chore: identify earlier when token is not dai-like and return receive…

d70baf1

…d error

chore: only log debug msg if not dai-like

7dfb0cd

chore: mark some known error types as permanent errors

72f95b7

chore: log also tokenName when possible

f79e97f

chore: use a regex to catch connection issues

4b25698

chore: use const for default obj return to avoid re-renders

77471bf

alfetopito force-pushed the permit/fetch-name-from-chain branch from bbcf125 to 77471bf Compare November 17, 2023 08:58

vercel bot deployed to Preview – widget-configurator November 17, 2023 08:59 View deployment

vercel bot deployed to Preview – cosmos November 17, 2023 09:00 View deployment

vercel bot deployed to Preview – swap-dev November 17, 2023 09:00 View deployment

alfetopito added 2 commits November 17, 2023 09:13

refactor: remove redundant check. It's covered by isSupportedPermitInfo

d8ed59f

chore: set permit-utils version to 0.0.1

35fbc52

vercel bot deployed to Preview – widget-configurator November 17, 2023 09:16 View deployment

vercel bot deployed to Preview – cosmos November 17, 2023 09:17 View deployment

vercel bot deployed to Preview – swap-dev November 17, 2023 09:18 View deployment

alfetopito merged commit 578df82 into develop Nov 17, 2023
9 of 10 checks passed

alfetopito deleted the permit/fetch-name-from-chain branch November 17, 2023 10:25

github-actions bot locked and limited conversation to collaborators Nov 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(permit): fetch token name from chain #3374

feat(permit): fetch token name from chain #3374

alfetopito commented Nov 9, 2023

vercel bot commented Nov 9, 2023 •

edited

Loading

alfetopito Nov 9, 2023

alfetopito Nov 9, 2023

alfetopito Nov 9, 2023

alfetopito Nov 9, 2023

socket-security bot commented Nov 10, 2023 •

edited

Loading

anxolin left a comment •

edited

Loading

alfetopito commented Nov 13, 2023 •

edited

Loading

anxolin commented Nov 14, 2023

alfetopito commented Nov 14, 2023

		export const permittableTokensAtom = atomWithStorage<PermittableTokens>('permittableTokens:v1', {
		export const permittableTokensAtom = atomWithStorage<PermittableTokens>('permittableTokens:v2', {

feat(permit): fetch token name from chain #3374

feat(permit): fetch token name from chain #3374

Conversation

alfetopito commented Nov 9, 2023

Summary

To Test

vercel bot commented Nov 9, 2023 • edited Loading

alfetopito Nov 9, 2023

Choose a reason for hiding this comment

alfetopito Nov 9, 2023

Choose a reason for hiding this comment

alfetopito Nov 9, 2023

Choose a reason for hiding this comment

alfetopito Nov 9, 2023

Choose a reason for hiding this comment

socket-security bot commented Nov 10, 2023 • edited Loading

anxolin left a comment • edited Loading

Choose a reason for hiding this comment

alfetopito commented Nov 13, 2023 • edited Loading

anxolin commented Nov 14, 2023

alfetopito commented Nov 14, 2023

vercel bot commented Nov 9, 2023 •

edited

Loading

socket-security bot commented Nov 10, 2023 •

edited

Loading

anxolin left a comment •

edited

Loading

alfetopito commented Nov 13, 2023 •

edited

Loading