Feat/add avalanche polygon

.github/ISSUE_TEMPLATE/1-addTokenForm.yml

@@ -34,6 +34,8 @@ body:
         - GNOSIS_CHAIN
         - ARBITRUM_ONE
         - BASE
+        - POLYGON
+        - AVALANCHE
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/2-addImageForm.yml

@@ -26,6 +26,8 @@ body:
         - GNOSIS_CHAIN
         - ARBITRUM_ONE
         - BASE
+        - POLYGON
+        - AVALANCHE
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/3-removeTokenForm.yml

@@ -26,6 +26,8 @@ body:
         - GNOSIS_CHAIN
         - ARBITRUM_ONE
         - BASE
+        - POLYGON
+        - AVALANCHE
     validations:
       required: true
   - type: input

.github/workflows/updatePermitInfo.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false # continue parallel jobs even if individual parts fail
       matrix:
-        chainId: [1, 100, 8453, 42161] # all supported chains
+        chainId: [1, 100, 8453, 42161, 137, 43114] # all supported chains
 
     steps:
       - name: Checkout code

.gitignore

@@ -1,12 +1,21 @@
 node_modules
 build
+
 # MacOS
 .DS_Store
+
 # Intellij
 .idea
+
 # Vscode
 .vscode
+
 # yalc
 .yalc
 yalc.lock
-src/cowFi/TEMP*
+
+# Temporary files
+src/cowFi/TEMP*
+
+# logs
+*.log

README.md

@@ -52,6 +52,10 @@ Instructions for setting up and running the various scripts locally
 
 ### Setup
 
+### Prerequisites
+
+Currently runs on Node.js LTS/Gallium v16.20.2
+
 ```bash
 # Install dependencies
 yarn
@@ -60,7 +64,7 @@ yarn
 yarn coingecko
 ```
 
-### Download images
+### Download images (deprecated)
 
 There's a script that will fetch all images form the CowSwap list and store them in `src/public/images/<chainId>/<address>.png`
 
@@ -95,5 +99,7 @@ The script generates token list files in `src/public/` for the following network
 
 - Ethereum (CoinGecko.1.json)
 - Arbitrum (CoinGecko.42161.json, Uniswap.42161.json)
+- Avalanche (Coingecko.43114.json, Uniswap.43114.json)
 - Base (CoinGecko.8453.json, Uniswap.8453.json)
 - Gnosis Chain (CoinGecko.100.json, Uniswap.100.json)
+- Polygon (CoinGecko.137.json, Uniswap.137.json)

package.json

@@ -19,23 +19,28 @@
     "public": "copyfiles src/public/*.json build/lists -f",
     "workflowHelper": "python3 src/scripts/workflow_helper.py",
     "validate": "ajv -s node_modules/@uniswap/token-lists/dist/tokenlist.schema.json -d src/public/CowSwap.json -c ajv-formats --errors text",
-    "fetchPermitInfo": "yarn run-script src/permitInfo/fetchPermitInfo.ts",
+    "fetchAllPermitInfo": "yarn run-script src/permitInfo/fetchAllPermitInfo.ts",
+    "fetchPermitInfo": "yarn run-script src/permitInfo/fetchPermitInfoByChain.ts",
     "fetchPermitInfo:mainnet": "yarn run fetchPermitInfo -- 1",
     "fetchPermitInfo:arb1": "yarn run fetchPermitInfo -- 42161",
     "fetchPermitInfo:base": "yarn run fetchPermitInfo -- 8453",
     "fetchPermitInfo:gnosis": "yarn run fetchPermitInfo -- 100",
     "fetchPermitInfo:sepolia": "yarn run fetchPermitInfo -- 11155111",
-    "recheckPermitInfo:mainnet": "yarn run fetchPermitInfo -- 1 '' '' true",
-    "recheckPermitInfo:arb1": "yarn run fetchPermitInfo -- 42161 '' '' true",
-    "recheckPermitInfo:base": "yarn run fetchPermitInfo -- 8453 '' '' true",
-    "recheckPermitInfo:gnosis": "yarn run fetchPermitInfo -- 100 '' '' true",
-    "recheckPermitInfo:sepolia": "yarn run fetchPermitInfo -- 11155111 '' '' true",
+    "fetchPermitInfo:avalanche": "yarn run fetchPermitInfo -- 43114",
+    "fetchPermitInfo:polygon": "yarn run fetchPermitInfo -- 137",
+    "recheckPermitInfo:mainnet": "yarn run fetchPermitInfo -- 1 true",
+    "recheckPermitInfo:arb1": "yarn run fetchPermitInfo -- 42161 true",
+    "recheckPermitInfo:base": "yarn run fetchPermitInfo -- 8453  true",
+    "recheckPermitInfo:gnosis": "yarn run fetchPermitInfo -- 100 true",
+    "recheckPermitInfo:sepolia": "yarn run fetchPermitInfo -- 11155111 true",
+    "recheckPermitInfo:avalanche": "yarn run fetchPermitInfo -- 43114 true",
+    "recheckPermitInfo:polygon": "yarn run fetchPermitInfo -- 137 true",
     "run-script": "node --loader ts-node/esm --experimental-json-modules --experimental-specifier-resolution=node",
     "test": "node --test"
   },
   "license": "(MIT OR Apache-2.0)",
   "dependencies": {
-    "@cowprotocol/cow-sdk": "^5.7.0-RC.0",
+    "@cowprotocol/cow-sdk": "^5.11.0-RC.0",
     "@cowprotocol/permit-utils": "^0.4.0",
     "@uniswap/token-lists": "^1.0.0-beta.33",
     "ajv": "^8.12.0",
@@ -47,7 +52,8 @@
     "lodash": "^4.17.21",
     "p-retry": "^6.1.0",
     "p-throttle": "^5.1.0",
-    "ts-node": "^10.9.1"
+    "ts-node": "^10.9.1",
+    "winston": "^3.17.0"
   },
   "devDependencies": {
     "@types/node": "^20.8.7",
@@ -56,4 +62,4 @@
     "prettier": "^3.0.3",
     "typescript": "^5.2.2"
   }
-}
+}

src/permitInfo/const.ts

@@ -11,6 +11,8 @@ export const DEFAULT_RPC_URLS: Record<SupportedChainId, string> = {
   [SupportedChainId.BASE]: 'https://mainnet.base.org',
   [SupportedChainId.GNOSIS_CHAIN]: 'https://rpc.gnosischain.com',
   [SupportedChainId.SEPOLIA]: 'https://ethereum-sepolia.publicnode.com',
+  [SupportedChainId.AVALANCHE]: 'https://api.avax.network/ext/bc/C/rpc',
+  [SupportedChainId.POLYGON]: 'https://polygon-rpc.com',
 }
 
 export const BASE_PATH = join('..', 'public')

src/permitInfo/fetchAllPermitInfo.ts

@@ -0,0 +1,25 @@
+import path from 'path'
+import { argv, chdir } from 'node:process'
+
+import { SupportedChainId } from '@cowprotocol/cow-sdk'
+import { fetchPermitInfo } from './fetchPermitInfo'
+
+async function fetchAllPermitInfo() {
+  const [, scriptPath] = argv
+
+  chdir(path.dirname(scriptPath))
+
+  for (const chainId in SupportedChainId) {
+    if (!isNaN(Number(chainId))) {
+      await fetchPermitInfo({
+        chainId: chainId as unknown as SupportedChainId,
+        tokenListPath: undefined,
+        rpcUrl: undefined,
+        recheckUnsupported: false,
+        forceRecheck: false,
+      })
+    }
+  }
+}
+
+fetchAllPermitInfo()

src/permitInfo/fetchPermitInfo.ts

@@ -37,7 +37,7 @@ import {
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { readFileSync, writeFileSync } from 'node:fs'
 import * as path from 'node:path'
-import { argv, chdir, env, exit } from 'node:process'
+import { env, exit } from 'node:process'
 import pRetry from 'p-retry'
 import pThrottle from 'p-throttle'
 import { BASE_PATH, SPENDER_ADDRESS } from './const'
@@ -47,25 +47,16 @@ import { getTokensFromTokenList } from './utils/getTokensFromTokenList'
 import { getUnsupportedTokensFromPermitInfo } from './utils/getUnsupportedTokensFromPermitInfo'
 import { sortPermitInfo } from './utils/sortPermitInfo'
 
-// TODO: maybe make the args nicer?
-// Get args from cli: chainId, optional token lists path, optional rpcUrl, optional recheckUnsupported flag
-const [, scriptPath, chainId, tokenListPath, rpcUrl, recheckUnsupported, forceRecheck] = argv
-
-if (!chainId) {
-  console.error('ChainId is missing. Invoke the script with the chainId as the first parameter.')
-  exit(1)
+export type FetchPermitInfoOptions = {
+  chainId: SupportedChainId
+  tokenListPath?: string
+  rpcUrl?: string
+  recheckUnsupported?: boolean
+  forceRecheck?: boolean
 }
 
-// Change to script dir so relative paths work properly
-chdir(path.dirname(scriptPath))
-
-async function fetchPermitInfo(
-  chainId: SupportedChainId,
-  tokenListPath: string | undefined,
-  rpcUrl: string | undefined,
-  recheckUnsupported: boolean = false,
-  forceRecheck: boolean = false,
-): Promise<void> {
+export async function fetchPermitInfo(options: FetchPermitInfoOptions): Promise<void> {
+  const { chainId, tokenListPath, rpcUrl, recheckUnsupported, forceRecheck } = options
   // Load existing permitInfo.json file for given chainId
   const permitInfoPath = path.join(BASE_PATH, `PermitInfo.${chainId}.json`)
 
@@ -99,7 +90,7 @@ async function fetchPermitInfo(
     const existingInfo = allPermitInfo[token.address.toLowerCase()]
 
     return pRetry(
-      async () => _fetchPermitInfo(chainId, provider, token, existingInfo, recheckUnsupported, forceRecheck),
+      async () => _fetchPermitInfo(chainId, provider, token, existingInfo, !!recheckUnsupported, !!forceRecheck),
       {
         retries: 3,
       },
@@ -171,8 +162,3 @@ async function _fetchPermitInfo(
     }
   }
 }
-
-// Execute the script
-fetchPermitInfo(+chainId as SupportedChainId, tokenListPath, rpcUrl, !!recheckUnsupported, !!forceRecheck).then(() =>
-  console.info(`Done 🏁`),
-)

src/permitInfo/fetchPermitInfoByChain.ts

@@ -0,0 +1,28 @@
+import path from "path"
+import { argv, chdir, exit } from 'node:process'
+
+import { SupportedChainId } from '@cowprotocol/cow-sdk'
+import { fetchPermitInfo } from "./fetchPermitInfo"
+
+function fetchPermitInfoByChain() {
+    const [, scriptPath, chainId, forceRecheck] = argv
+
+    if (!chainId) {
+      console.error('ChainId is missing. Invoke the script with the chainId as the first parameter.')
+      exit(1)
+    }
+
+    // Change to script dir so relative paths work properly
+    chdir(path.dirname(scriptPath))
+
+    // Execute the script
+    fetchPermitInfo({
+      chainId: +chainId as SupportedChainId,
+      tokenListPath: undefined,
+      rpcUrl: undefined,
+      recheckUnsupported: false,
+      forceRecheck: forceRecheck === 'true',
+    }).then(() => console.info(`Done 🏁`))
+  }
+
+  fetchPermitInfoByChain()

src/permitInfo/utils/getTokensFromTokenList.ts

@@ -10,6 +10,8 @@ const tokenListsByNetwork: Record<SupportedChainId, string> = {
   [SupportedChainId.BASE]: 'CowSwap.json',
   [SupportedChainId.GNOSIS_CHAIN]: 'CowSwap.json',
   [SupportedChainId.SEPOLIA]: 'CowSwapSepolia.json',
+  [SupportedChainId.POLYGON]: 'CowSwap.json',
+  [SupportedChainId.AVALANCHE]: 'CowSwap.json',
 }
 
 export async function getTokensFromTokenList(