Feat/add avalanche polygon (#921)

* chore: update `cow-sdk` and README

* fix: error if the `build` folder doesn't exist

* chore: refactor `downloadImages` to make it more robust

* chore: update README

* chore: update `.gitignore`

* feat: add new networks
- add `Avalanche` and `Polygon` networks
- add `winston` logger

* chore: update Readme

* Update README.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: update `tokenListsByNetwork`

* feat: update issue templates with new networks

* feat: update `fetchPermitInfo` scripts and add new networks

* chore: improve logging

* chore: add new networks to `processRequest`

* chore: sync `CoinGecko` json files with `main`

* fix: remove old logs context

* Update src/permitInfo/fetchAllPermitInfo.ts

Co-authored-by: Leandro <alfetopito@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Leandro <alfetopito@users.noreply.github.com>

Author: 3 people

.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/processRequest.yml

@@ -21,7 +21,7 @@ name: ProcessRequest
 
 on:
   issues:
-    types: [ opened ]
+    types: [opened]
 
 env:
   # Matches labels from field forms to extract data
@@ -85,6 +85,12 @@ jobs:
             } else if (values.network === 'BASE') {
               values.chainId = 8453
               values.blockExplorer = 'basescan.org'
+            } else if (values.network === 'AVALANCHE') {
+              values.chainId = 43114
+              values.blockExplorer = 'snowtrace.io'
+            } else if (values.network === 'POLYGON'){
+              values.chainId = 137
+              values.blockExplorer = 'polygonscan.com'
             } else {
               values.chainId = 100
               values.blockExplorer = 'gnosisscan.io'
@@ -109,7 +115,6 @@ jobs:
           # force failure for testing
           # exit 1
 
-
   validateInput:
     runs-on: ubuntu-latest
     needs: extractInfoFromIssue
@@ -154,15 +159,15 @@ jobs:
             Make sure all the required fields are provided and submit a new issue
 
   optimizeImage:
-    needs: [ extractInfoFromIssue, validateInput ]
+    needs: [extractInfoFromIssue, validateInput]
     uses: ./.github/workflows/optimizeImage.yml
     if: ${{ contains(github.event.issue.labels.*.name, 'addImage') || contains(github.event.issue.labels.*.name, 'addToken') }}
     with:
       url: ${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).url }}
       address: ${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).address }}
 
   addToken:
-    needs: [ extractInfoFromIssue, optimizeImage ]
+    needs: [extractInfoFromIssue, optimizeImage]
     uses: ./.github/workflows/executeAction.yml
     if: ${{ contains(github.event.issue.labels.*.name, 'addToken') }}
     secrets: inherit
@@ -171,7 +176,7 @@ jobs:
       issueInfo: ${{ needs.extractInfoFromIssue.outputs.issueInfo }}
       # Custom per type
       operation: addToken
-      prTitle: "[addToken] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).symbol }}` to `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`"
+      prTitle: '[addToken] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).symbol }}` to `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`'
       prBody: |
         Adding token `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).symbol }}` on network `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`
 
@@ -191,14 +196,14 @@ jobs:
         ```
 
   removeToken:
-    needs: [ extractInfoFromIssue, validateInput ]
+    needs: [extractInfoFromIssue, validateInput]
     uses: ./.github/workflows/executeAction.yml
     if: ${{ contains(github.event.issue.labels.*.name, 'removeToken') }}
     secrets: inherit
     with:
       issueInfo: ${{ needs.extractInfoFromIssue.outputs.issueInfo }}
       operation: removeToken
-      prTitle: "[removeToken] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).address }}` from `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`"
+      prTitle: '[removeToken] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).address }}` from `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`'
       prBody: |
         Removing token from network `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`
 
@@ -213,14 +218,14 @@ jobs:
         ```
 
   addImage:
-    needs: [ extractInfoFromIssue, optimizeImage ]
+    needs: [extractInfoFromIssue, optimizeImage]
     uses: ./.github/workflows/executeAction.yml
     if: ${{ contains(github.event.issue.labels.*.name, 'addImage') }}
     secrets: inherit
     with:
       issueInfo: ${{ needs.extractInfoFromIssue.outputs.issueInfo }}
       operation: addImage
-      prTitle: "[addImage] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).address }}` to `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`"
+      prTitle: '[addImage] `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).address }}` to `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`'
       prBody: |
         Adding image to network `${{ fromJSON(needs.extractInfoFromIssue.outputs.issueInfo).network }}`
 

.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,34 @@
+import path from 'path'
+import { argv, chdir } from 'node:process'
+
+import { SupportedChainId } from '@cowprotocol/cow-sdk'
+import { fetchPermitInfo } from './fetchPermitInfo'
+import { getLogger, removeOldLogs } from 'scripts/auxLists/utils'
+
+async function fetchAllPermitInfo() {
+  const [, scriptPath] = argv
+
+  chdir(path.dirname(scriptPath))
+
+  removeOldLogs('fetch-permit')
+
+  const logger = getLogger('fetch-permit')
+
+  for (const chainId in SupportedChainId) {
+    if (!isNaN(Number(chainId))) {
+      try {
+        await fetchPermitInfo({
+          chainId: +chainId as SupportedChainId,
+          tokenListPath: undefined,
+          rpcUrl: undefined,
+          recheckUnsupported: false,
+          forceRecheck: false,
+        })
+      } catch (error) {
+        logger.error(`Error fetching permit info for chain ${chainId}:`, error)
+      }
+    }
+  }
+}
+
+fetchAllPermitInfo()