uniswap-v2-loader 4.0.2 → 5.0.1

package/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test Uniswap V2 loader
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '22'
+        cache: 'npm'
+
+    - name: Global install package CLI version
+      run: npm i -g .
+
+    - name: Load first 4 pairs from Uniswap V2 using 2 workers
+      run: uniswap-v2-loader --to=4 --multicall_size=2 --workers=2

package/README.md

@@ -1,4 +1,4 @@
-# <picture><source media="(prefers-color-scheme: dark)" srcset="./calp-dark.svg"><img alt="calp.pro icon" src="./calp-light.svg" height="32" align="absmiddle"></picture>&nbsp;&nbsp;&nbsp;uniswap-v2-loader
+# <picture><source media="(prefers-color-scheme: dark)" srcset="./logo-dark.svg"><img alt="calp.pro icon" src="./logo-light.svg" height="32" align="absmiddle"></picture>&nbsp;&nbsp;&nbsp;uniswap-v2-loader
 
 <br>
 
@@ -42,8 +42,8 @@ High-performance parallel fetcher for liquidity pairs. Efficiently synchronizes
 | `from` | `number` | Start loading from this pair index. | `0` |
 | `to` | `number` | End index (exclusive). Required for range loading. | `undefined` |
 | `filename` | `string` | Local CSV cache path. Supports OS-standard locations. | *Auto-detected* |
-| `factory` | `string` | Smart contract factory address. | `Uniswap V2` |
-| `key` | `string` | Alchemy/RPC API Key (priority over ENV). | `process.env.KEY` |
+| `factory` | `string` | Smart contract factory address. | `0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f` |
+| `key` | `string` | Alchemy/RPC API Key (priority over ENV). | `FZBvlPrOxtgaKBBkry3SH0W1IqH4Y5tu` |
 | `multicall_size` | `number` | RPC batch size per multicall request. | `50` |
 | `workers` | `number` | Number of parallel worker threads. | `CPU - 1` |
 | `progress` | `function` | Progress callback: `(current, total) => {}`. | `undefined` |
@@ -74,7 +74,7 @@ Cache files are named following the pattern `${package_name}_{factory_address}.c
 
 ---
 
-### `onupdate(callback, params)`
+### `subscribe(callback, params)`
 Continuous synchronization engine. Performs initial load and subsequently polls for new pairs.
 
 **Parameters**
@@ -102,7 +102,7 @@ Standardized liquidity pool object.
 
 ## Usage Example
 ```javascript
-const { load, onupdate } = require('uniswap-v2-loader')
+const { load, subscribe } = require('uniswap-v2-loader')
 const rl = require('readline')
 
 

package/default_cache_filename.js

@@ -1,19 +1,24 @@
 const path = require('path')
-const env = process.env
+const {GITHUB_ACTIONS, XDG_CACHE_HOME, LOCALAPPDATA, APPDATA} = process.env
+const fs = require('fs')
 const os = require('os')
 const home = os.homedir()
 const pkg = require('./package.json')
 
-module.exports = (factory) => path.join(
-  ...(process.platform === 'win32'
-      ? (env.LOCALAPPDATA || env.APPDATA)
-        ? [env.LOCALAPPDATA || env.APPDATA]
-        : [home, 'AppData', 'Local']
-      : process.platform === 'darwin'
-        ? [home, 'Library', 'Caches']
-        : (env.XDG_CACHE_HOME && path.isAbsolute(env.XDG_CACHE_HOME))
-          ? [env.XDG_CACHE_HOME]
-          : [home, '.cache']
-  ),
-  `${pkg.name}_${factory.toLowerCase()}.csv`
+module.exports = factory => path.join(
+    ...(GITHUB_ACTIONS
+        ? ['.']
+        : process.platform == 'win32'
+            ? LOCALAPPDATA || APPDATA
+                ? [LOCALAPPDATA || APPDATA]
+                : [home, 'AppData', 'Local']
+            : process.platform == 'darwin'
+                ? [home, 'Library', 'Caches']
+                : XDG_CACHE_HOME && path.isAbsolute(XDG_CACHE_HOME) && fs.existsSync(XDG_CACHE_HOME)
+                    ? [XDG_CACHE_HOME]
+                    : fs.existsSync(path.join(home, '.cache'))
+                        ? [home, '.cache']
+                        : [os.tmpdir()]
+    ),
+    `${pkg.name}_${factory.toLowerCase()}.csv`
 )

package/index.d.ts

@@ -47,11 +47,11 @@ export function load(params?: load_params): Promise<pair[]>
 
 /**
  * Subscribes to new pairs being added to the factory.
- * @param callback Called whenever new pairs are loaded.
+ * @param callback Called with total available data first and then whenever new pairs added to factory.
  * @param params Loading configuration.
  * @returns An unsubscribe function.
  */
-export function onupdate(
+export function subscribe(
   callback: (pairs: pair[]) => void,
   params?: load_params
 ): () => void

package/index.js

@@ -2,12 +2,10 @@ const cluster = require('cluster')
 const fs = require('fs')
 const os = require('os')
 const path = require('path')
-const { parseAbiItem, createPublicClient, http } = require('viem')
-const { mainnet } = require('viem/chains')
 const default_cache_filename = require('./default_cache_filename')
 const max_workers = os.cpus().length - 1
 const debug_key = process.env.KEY || 'FZBvlPrOxtgaKBBkry3SH0W1IqH4Y5tu'
-const uniswap_v2_factory = '0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f'
+const uniswap_v2_factory = '0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f'
 
 const load = (params = {}) => {
     var {
@@ -22,10 +20,6 @@ const load = (params = {}) => {
         pairs,
     } = params
     filename ??= default_cache_filename(factory)
-    const client = createPublicClient({
-        chain: mainnet,
-        transport: http('https://eth-mainnet.g.alchemy.com/v2/' + key)
-    })
 
     pairs ??= fs.existsSync(filename)
         ? fs.readFileSync(filename).toString().trim().split('\n')
@@ -47,11 +41,16 @@ const load = (params = {}) => {
 
     return (to
         ? Promise.resolve(to)
-        : client.readContract({
-            address: factory,
-            abi: [parseAbiItem('function allPairsLength() view returns (uint256)')],
-            functionName: 'allPairsLength'
-        }).then(_ => Number(_))
+        : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                jsonrpc: '2.0',
+                id: 1,
+                method: 'eth_call',
+                params: [{ to: factory, data: '0x574f2ba3' }, 'latest']
+            })
+        }).then(_ => _.json()).then(_ => Number(_.result))
     ).then(all_pairs_length => {
         const start_loading_from = pairs.length
             ? Math.max(from || 0, pairs[pairs.length - 1].id + 1)
@@ -110,9 +109,9 @@ const load = (params = {}) => {
 module.exports.load = (params = {}) =>
     load(params)
 
-module.exports.onupdate = function onupdate(callback, params = {}) {
+module.exports.subscribe = (callback, params = {}) => {
     params.update_timeout ??= 5000
-    var subscribe = true, timeout
+    var subscribed = true, timeout
     load(params)
     .then(pairs => {
         callback(pairs)
@@ -122,22 +121,22 @@ module.exports.onupdate = function onupdate(callback, params = {}) {
                 () =>
                     load({...params, pairs, from: pairs.length})
                     .then(pairs => {
-                        if (!subscribe) return
+                        if (!subscribed) return
                         callback(pairs)
-                        if (!subscribe) return
+                        if (!subscribed) return
                         if (params.to && pairs[pairs.length - 1].id >= params.to) return
                         update(pairs)
                     }),
                 params.update_timeout
             )
 
-        if (!subscribe) return
+        if (!subscribed) return
         if (params.to && pairs[pairs.length - 1].id >= params.to) return
         update(pairs)
     })
 
     return () => {
-        subscribe = false
+        subscribed = false
         if (timeout) clearTimeout(timeout)
     }
 }

package/loader.js

@@ -1,44 +1,49 @@
-const { parseAbiItem, createPublicClient, http } = require('viem')
-const { mainnet } = require('viem/chains')
-
-const get_pairs_addresses = (client, factory, ids) => ids.length == 0
+const get_pairs_addresses = (key, factory, ids) => ids.length == 0
     ? Promise.resolve([])
-    : client.multicall({
-        contracts: ids.map(id => ({
-            address: factory,
-            abi: [parseAbiItem('function allPairs(uint256) view returns (address)')],
-            functionName: 'allPairs',
-            args: [BigInt(id)]
-        }))
-    }).then(responds => {
+    : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(ids.map((id, i) => ({
+            jsonrpc: '2.0',
+            id: i,
+            method: 'eth_call',
+            params: [{ to: factory, data: '0x1e3dd18b' + id.toString(16).padStart(64, '0') }, 'latest']
+        })))
+    }).then(_ => _.json()).then(responds => {
+        responds.sort((a, b) => a.id - b.id)
         const addresses = []
         const failed_ids = []
         for (var i = 0; i < responds.length; i++)
-            responds[i].status == 'success'
-                ? addresses.push(responds[i].result)
-                : failed_ids.push(i)
+            responds[i].result
+                ? addresses.push('0x' + responds[i].result.slice(-40))
+                : failed_ids.push(ids[i])
 
-        return get_pairs_addresses(client, factory, failed_ids).then(retried_addresses =>
-            [...addresses, ...retried_addresses]
-        )
+        return failed_ids.length == 0
+            ? addresses
+            : get_pairs_addresses(key, factory, failed_ids).then(retried => [...addresses, ...retried])
     })
 
-const get_tokens = (client, addresses) => addresses.length == 0
+const get_tokens = (key, addresses) => addresses.length == 0
     ? Promise.resolve({})
-    : client.multicall({
-        contracts: addresses.flatMap(address => [
+    : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(addresses.flatMap((address, i) => [
             {
-                address,
-                abi: [parseAbiItem('function token0() view returns (address)')],
-                functionName: 'token0'
+                jsonrpc: '2.0',
+                id: i * 2,
+                method: 'eth_call',
+                params: [{ to: address, data: '0x0dfe1681' }, 'latest']
             },
             {
-                address,
-                abi: [parseAbiItem('function token1() view returns (address)')],
-                functionName: 'token1'
+                jsonrpc: '2.0',
+                id: i * 2 + 1,
+                method: 'eth_call',
+                params: [{ to: address, data: '0xd21220a7' }, 'latest']
             }
-        ])
-    }).then(responds => {
+        ]))
+    }).then(_ => _.json()).then(responds => {
+        responds.sort((a, b) => a.id - b.id)
         const tokens = {}
         const failed_addresses = []
 
@@ -46,35 +51,29 @@ const get_tokens = (client, addresses) => addresses.length == 0
             const token0_respond = responds[i * 2]
             const token1_respond = responds[i * 2 + 1]
 
-            if (
-                token0_respond.status == 'success' &&
-                token1_respond.status == 'success'
-            )
-                tokens[addresses[i]] = [token0_respond.result, token1_respond.result]
+            if (token0_respond.result && token1_respond.result)
+                tokens[addresses[i]] = [
+                    '0x' + token0_respond.result.slice(-40),
+                    '0x' + token1_respond.result.slice(-40)
+                ]
             else
                 failed_addresses.push(addresses[i])
         }
-    
-        return get_tokens(client, failed_addresses).then(retried_tokens => ({
-            ...tokens,
-            ...retried_tokens
-        }))
-    })
 
-const main = ({ids, factory, key, multicall_size}, onpair) => {
-    const client = createPublicClient({
-        chain: mainnet,
-        transport: http(`https://eth-mainnet.g.alchemy.com/v2/${key}`)
+        return failed_addresses.length == 0
+            ? tokens
+            : get_tokens(key, failed_addresses).then(retried => ({ ...tokens, ...retried }))
     })
 
+const main = ({ids, factory, key, multicall_size}, onpair) => {
     const chunks = []
     for (let i = 0; i < ids.length; i += multicall_size)
         chunks.push(ids.slice(i, i + multicall_size))
 
     return chunks.reduce((p, ids, ic) =>
         p.then(() =>
-            get_pairs_addresses(client, factory, ids).then(pairs_addresses =>
-                get_tokens(client, pairs_addresses).then(tokens =>
+            get_pairs_addresses(key, factory, ids).then(pairs_addresses =>
+                get_tokens(key, pairs_addresses).then(tokens =>
                     ids.forEach((id, i) =>
                         onpair({
                             id,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniswap-v2-loader",
-  "version": "4.0.2",
+  "version": "5.0.1",
   "description": "Uniswap v2 protocol loader",
   "keywords": [
     "uniswap-v2",
@@ -10,7 +10,10 @@
     "ethereum",
     "defi",
     "sushiswap",
-    "pancakeswap"
+    "pancakeswap",
+    "shibaswap",
+    "dex",
+    "exchange"
   ],
   "homepage": "https://github.com/calp-pro/uniswap-v2-loader#readme",
   "bugs": {
@@ -30,8 +33,5 @@
   },
   "bin": {
     "uniswap-v2-loader": "./bin/uniswap-v2-loader"
-  },
-  "dependencies": {
-    "viem": "^2.46.2"
   }
 }