Skip to content

Feat/add avalanche polygon #921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cowdan merged 20 commits into from
May 23, 2025
Merged

Feat/add avalanche polygon #921

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
29d6db8
chore: update `cow-sdk` and README
cowdan May 15, 2025
6be2e73
fix: error if the `build` folder doesn't exist
cowdan May 15, 2025
b0c4487
chore: refactor `downloadImages` to make it more robust
cowdan May 15, 2025
742b7ae
chore: update README
cowdan May 16, 2025
3881986
chore: update `.gitignore`
cowdan May 16, 2025
80d6911
feat: add new networks
cowdan May 20, 2025
8e4c406
chore: update Readme
cowdan May 20, 2025
ea82d35
Merge remote-tracking branch 'origin/main' into feat/add-avalanche-po…
cowdan May 20, 2025
ac19de0
Update README.md
cowdan May 20, 2025
3e8cc09
fix: update `tokenListsByNetwork`
cowdan May 20, 2025
79ee878
feat: update issue templates with new networks
cowdan May 21, 2025
eef7c88
feat: update `fetchPermitInfo` scripts and add new networks
cowdan May 21, 2025
ea7b683
chore: improve logging
cowdan May 21, 2025
38746f1
Merge remote-tracking branch 'origin/main' into feat/add-avalanche-po…
cowdan May 21, 2025
1730fd1
chore: add new networks to `processRequest`
cowdan May 22, 2025
aaad1c0
chore: sync `CoinGecko` json files with `main`
cowdan May 22, 2025
5aed520
Merge remote-tracking branch 'origin/main' into feat/add-avalanche-po…
cowdan May 22, 2025
bb6b13c
fix: remove old logs context
cowdan May 22, 2025
d94d390
Update src/permitInfo/fetchAllPermitInfo.ts
cowdan May 23, 2025
399345e
Merge remote-tracking branch 'origin/main' into feat/add-avalanche-po…
cowdan May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/1-addTokenForm.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ body:
- GNOSIS_CHAIN
- ARBITRUM_ONE
- BASE
- POLYGON
- AVALANCHE
validations:
required: true
- type: input
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/2-addImageForm.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ body:
- GNOSIS_CHAIN
- ARBITRUM_ONE
- BASE
- POLYGON
- AVALANCHE
validations:
required: true
- type: input
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/3-removeTokenForm.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ body:
- GNOSIS_CHAIN
- ARBITRUM_ONE
- BASE
- POLYGON
- AVALANCHE
validations:
required: true
- type: input
Expand Down
11 changes: 10 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`

Expand Down Expand Up @@ -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)
7 changes: 4 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
},
"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",
Expand All @@ -47,7 +47,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"
Copy link
Collaborator

@alfetopito alfetopito May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious why the choice of winston?
Or why the need for a dedicated logging lib.

Anyway, we use pino logger in other nodejs apps (watch tower, bff), but you probably have not dealt with them yet to know this.

Copy link
Contributor Author

@cowdan cowdan May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kind of well used library, I can change it to pino logger if needed

},
"devDependencies": {
"@types/node": "^20.8.7",
Expand All @@ -56,4 +57,4 @@
"prettier": "^3.0.3",
"typescript": "^5.2.2"
}
}
}
2 changes: 2 additions & 0 deletions src/permitInfo/const.ts
View file
Open in desktop
Copy link
Collaborator

@alfetopito alfetopito May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you run the permit script to fetch some permit info for the new networks?

Also, do you plan to add new scripts for them?
image

I know this will get too big and unmaintainable if we keep doing this, I'm open to suggestions to improve it.

Copy link
Contributor Author

@cowdan cowdan May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done some refactor

Original file line number Diff line number Diff line change
Expand Up @@ -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')
25 changes: 25 additions & 0 deletions src/permitInfo/fetchAllPermitInfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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))

Comment on lines +8 to +12
Copy link
Contributor

@coderabbitai coderabbitai bot May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider preserving the original working directory.

The script changes the working directory but doesn't restore it after execution, which could affect subsequent operations.

async function fetchAllPermitInfo() {
  const [, scriptPath] = argv
+  const originalDir = process.cwd()
  
  chdir(path.dirname(scriptPath))
+  
+  try {

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In src/permitInfo/fetchAllPermitInfo.ts around lines 7 to 11, the code changes
the working directory using chdir but does not restore the original directory
afterward. To fix this, save the current working directory before calling chdir,
and after the operations that require the directory change are complete, restore
the original working directory by calling chdir again with the saved path.

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()
2 changes: 2 additions & 0 deletions src/permitInfo/utils/getTokensFromTokenList.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading