feat(COW-163): Update cow-sdk version, add default RPC and run script for Ink (#1307)

* feat: update cow-sdk version, add default RPC and run script for Ink

* fix: update auxUtils/utils records

* fix: add .env.example and update .gitignore

* feat: update token forms

* chore: upgrade cow-sdk to 7.3.1

* fix: fix mapTokensListToBrige ABI function name and Node.js version in README

* chore: update lists for Ink

* Update README.md

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

---------

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

Author: Danziger

.env.example

@@ -0,0 +1 @@
+COINGECKO_API_KEY=

.github/ISSUE_TEMPLATE/1-addTokenForm.yml

@@ -40,6 +40,7 @@ body:
         - LENS
         - LINEA
         - PLASMA
+        - INK
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/2-addImageForm.yml

@@ -32,6 +32,7 @@ body:
         - LENS
         - LINEA
         - PLASMA
+        - INK
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/3-removeTokenForm.yml

@@ -32,6 +32,7 @@ body:
         - LENS
         - LINEA
         - PLASMA
+        - INK
     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, 56, 100, 137, 232, 8453, 9745, 42161, 43114, 59144 ] # all supported chains
+        chainId: [ 1, 56, 100, 137, 232, 8453, 9745, 42161, 43114, 57073, 59144 ] # all supported chains
 
     steps:
       - name: Checkout code

.gitignore

@@ -22,3 +22,8 @@ src/cowFi/TEMP*
 
 # NPM setup
 .npmrc
+
+# Env files:
+.env
+.env.local
+.env.*.local

README.md

@@ -54,7 +54,7 @@ Instructions for setting up and running the various scripts locally
 
 ### Prerequisites
 
-Currently runs on Node.js LTS/Gallium v16.20.2
+Currently runs on Node.js v18 (as this scripts use `fetch`, which was introduced in Node.js 18)
 
 ```bash
 # Install dependencies
@@ -106,4 +106,33 @@ The script generates token list files in `src/public/` for the following network
 - Lens (CoinGecko.232.json, Uniswap.232.json)
 - Linea (CoinGecko.59144.json, Uniswap.59144.json)
 - Plasma (CoinGecko.9745.json, Uniswap.9745.json)
-- Polygon (CoinGecko.137.json, Uniswap.137.json)
+- Ink (CoinGecko.57073.json, Uniswap.57073.json)
+- Polygon (CoinGecko.137.json, Uniswap.137.json)
+
+### Adding a new network
+
+To support a new network (e.g. Ink, chain ID 57073), run these steps in order:
+
+1. **Generate auxiliary token lists** for the new chain (the chain must already be in `COINGECKO_CHAINS` in `src/scripts/auxLists/utils.ts`):
+
+   ```bash
+   COINGECKO_API_KEY=your_key yarn generateAuxLists
+   ```
+
+   This creates `src/public/CoinGecko.<chainId>.json` and `src/public/Uniswap.<chainId>.json` for the new network.
+
+2. **Fetch permit info** for the new chain. The default token list (`CowSwap.json`) will not include tokens for new networks yet if you haven't added any, so you must pass the path to the chain-specific list as the **second** argument:
+
+   ```bash
+   yarn run fetchPermitInfo -- <chainId> CoinGecko.<chainId>.json
+   ```
+
+   Example for Ink:
+
+   ```bash
+   yarn run fetchPermitInfo -- 57073 CoinGecko.57073.json
+   ```
+
+   Without the second argument, the script would use `CowSwap.json` and skip all tokens (they would have the wrong chainId), leaving the permit file empty.
+
+3. **Include only the new network's files in your PR.** The scripts above may have updated files for other networks too; do not include those changes, as they are updated daily by a cron job.

package.json

@@ -32,23 +32,25 @@
     "fetchPermitInfo:lens": "yarn run fetchPermitInfo -- 232",
     "fetchPermitInfo:linea": "yarn run fetchPermitInfo -- 59144",
     "fetchPermitInfo:plasma": "yarn run fetchPermitInfo -- 9745",
+    "fetchPermitInfo:ink": "yarn run fetchPermitInfo -- 57073",
     "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",
     "recheckPermitInfo:bnb": "yarn run fetchPermitInfo -- 56 '' '' true",
     "recheckPermitInfo:lens": "yarn run fetchPermitInfo -- 232 '' '' true",
     "recheckPermitInfo:linea": "yarn run fetchPermitInfo -- 59144 '' '' true",
     "recheckPermitInfo:plasma": "yarn run fetchPermitInfo -- 9745 '' '' true",
+    "recheckPermitInfo:ink": "yarn run fetchPermitInfo -- 57073 '' '' 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": "7.1.0",
+    "@cowprotocol/cow-sdk": "7.3.1",
     "@cowprotocol/permit-utils": "^0.7.0-RC.1",
     "@uniswap/token-lists": "^1.0.0-beta.33",
     "ajv": "^8.17.1",

scripts/processRequest.mjs

@@ -9,6 +9,7 @@ export const NETWORK_CONFIG = {
   GNOSIS_CHAIN: { chainId: 100, blockExplorer: 'gnosisscan.io' },
   LINEA: { chainId: 59144, blockExplorer: 'lineascan.build' },
   PLASMA: { chainId: 9745, blockExplorer: 'plasmascan.to' },
+  INK: { chainId: 57073, blockExplorer: 'explorer.inkonchain.com' },
 }
 
 export const VALIDATION_RULES = {

src/permitInfo/const.ts

@@ -17,6 +17,7 @@ export const DEFAULT_RPC_URLS: Record<SupportedChainId, string> = {
   [SupportedChainId.LENS]: 'https://rpc.lens.xyz',
   [SupportedChainId.LINEA]: 'https://rpc.linea.build',
   [SupportedChainId.PLASMA]: 'https://rpc.plasma.to',
+  [SupportedChainId.INK]: 'https://rpc-ten.inkonchain.com',
 }
 
 export const BASE_PATH = join('..', 'public')