uniswap-v2-loader 5.0.17 → 5.0.19

package/.github/workflows/test.yml

@@ -35,7 +35,7 @@ jobs:
 
       run: npm i -g .
 
-    - name: CLI Load first 4 pairs from Uniswap V2 using 2 workers
+    - name: Test CLI load first 4 pairs from Uniswap V2 using 2 workers
       run: uniswap-v2-loader --to=4 --multicall_size=2 --workers=2
 
     - name: Run ESM tests

package/README.md

@@ -41,6 +41,7 @@ High-performance parallel fetcher for liquidity pairs. Efficiently synchronizes
 | `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` |
+| `abort_signal` | `AbortSignal` | Signal to cancel loading and release workers. | `undefined` |
 
 **Returns**: `Promise<Pair[]>`
 

package/index.d.ts

@@ -36,6 +36,8 @@ export interface load_params {
   pairs?: pair[]
   /** Timeout between updates in milliseconds. */
   update_timeout?: number
+  /** Signal to abort the loading process. */
+  abort_signal?: AbortSignal
 }
 
 /**

package/index.js

@@ -16,9 +16,11 @@ const load = (params = {}) => {
         from = 0,
         to,
         progress,
+        abort_signal,
         workers = max_workers,
         pairs,
     } = params
+
     filename ??= default_cache_filename(factory)
     workers = Math.min(workers, max_workers)
 
@@ -44,10 +46,11 @@ const load = (params = {}) => {
 
         return Promise.resolve(pairs.slice(0, to))
     }
-    
+
     return (to
         ? Promise.resolve(to)
         : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+            signal: abort_signal,
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({
@@ -92,7 +95,7 @@ const load = (params = {}) => {
             const ids = []
             for (var i = start_loading_from; i < all_pairs_length; i++)
                 ids.push(i)
-            return require('./loader')({ ids, factory, key, multicall_size }, onpair)
+            return require('./loader')({ ids, factory, key, multicall_size, abort_signal }, onpair)
             .then(() => pairs)
         }
 
@@ -112,13 +115,14 @@ const load = (params = {}) => {
             .filter(_ => _.length)
             .map((ids, i) => new Promise(y => {
                 const w = cluster.fork()
+                abort_signal?.addEventListener('abort', () => w.send('abort'))
                 w.send({ ids, factory, key, multicall_size })
                 w.on('message', onpair)
                 w.on('exit', y)
             }))
         ).then(() => pairs)
     })
-    .catch(() => new Promise(resolve => setTimeout(() => resolve(load(params)), 1000)))
+    .catch(() => abort_signal?.aborted ? pairs : new Promise(resolve => setTimeout(() => resolve(load(params)), 1000)))
 }
 
 module.exports.load = (params = {}) =>

package/loader.js

@@ -1,6 +1,7 @@
-const get_pairs_addresses = (key, factory, ids) => ids.length == 0
+const get_pairs_addresses = (key, factory, ids, abort_signal) => ids.length == 0
     ? Promise.resolve([])
     : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+        signal: abort_signal,
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
         body: JSON.stringify(ids.map((id, i) => ({
@@ -30,14 +31,15 @@ const get_pairs_addresses = (key, factory, ids) => ids.length == 0
         return failed_ids.length == 0
             ? addresses
             : new Promise(resolve => setTimeout(() => resolve(
-                get_pairs_addresses(key, factory, failed_ids).then(retried => [...addresses, ...retried])
+                get_pairs_addresses(key, factory, failed_ids, abort_signal).then(retried => [...addresses, ...retried])
             ), 10000))
     })
-    .catch(() => new Promise(resolve => setTimeout(() => resolve(get_pairs_addresses(key, factory, ids)), 10000)))
+    .catch(() => abort_signal?.aborted ? [] : new Promise(resolve => setTimeout(() => resolve(get_pairs_addresses(key, factory, ids, abort_signal)), 10000)))
 
-const get_tokens = (key, addresses) => addresses.length == 0
+const get_tokens = (key, addresses, abort_signal) => addresses.length == 0
     ? Promise.resolve({})
     : fetch('https://eth-mainnet.g.alchemy.com/v2/' + key, {
+        signal: abort_signal,
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
         body: JSON.stringify(addresses.flatMap((address, i) => [
@@ -83,20 +85,20 @@ const get_tokens = (key, addresses) => addresses.length == 0
         return failed_addresses.length == 0
             ? tokens
             : new Promise(resolve => setTimeout(() => resolve(
-                get_tokens(key, failed_addresses).then(retried => ({ ...tokens, ...retried }))
+                get_tokens(key, failed_addresses, abort_signal).then(retried => ({ ...tokens, ...retried }))
             ), 10000))
     })
-    .catch(() => new Promise(resolve => setTimeout(() => resolve(get_tokens(key, addresses)), 10000)))
+    .catch(() => abort_signal?.aborted ? {} : new Promise(resolve => setTimeout(() => resolve(get_tokens(key, addresses, abort_signal)), 10000)))
 
-const main = ({ids, factory, key, multicall_size}, onpair) => {
+const main = ({ids, factory, key, multicall_size, abort_signal}, 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(key, factory, ids).then(pairs_addresses =>
-                get_tokens(key, pairs_addresses).then(tokens =>
+            get_pairs_addresses(key, factory, ids, abort_signal).then(pairs_addresses =>
+                get_tokens(key, pairs_addresses, abort_signal).then(tokens =>
                     ids.forEach((id, i) =>
                         onpair({
                             id,
@@ -113,12 +115,20 @@ const main = ({ids, factory, key, multicall_size}, onpair) => {
 }
 
 
-if (require.main != module)
+if (require.main != module) {
     module.exports = main
-else
+} else {
+    const abort_controller = new AbortController()
+    const abort_signal = abort_controller.signal
+
     process.on(
         'message',
-        message =>
-            main(message, pair => process.send(pair))
-            .then(() => process.exit())
+        message => {
+            if (message == 'abort')
+                abort_controller.abort()
+            else
+                main({...message, abort_signal}, pair => process.send(pair))
+                .finally(() => process.exit())
+        }
     )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniswap-v2-loader",
-  "version": "5.0.17",
+  "version": "5.0.19",
   "description": "Uniswap v2 protocol loader",
   "keywords": [
     "uniswap-v2",

package/test-cache.js

@@ -1,111 +0,0 @@
-const fs = require('fs')
-const { describe, before, after, it } = require('node:test')
-const assert = require('node:assert/strict')
-const {load, subscribe} = require('./index')
-const default_cache_filename = require('./default_cache_filename')
-const uniswap_v2_factory = '0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f'
-
-describe('Cache OS filename at win32', () => {
-    const platform = process.platform
-    const os = require('os')
-    const path = require('path')
-    
-    before(() => {
-        process.env.GITHUB_ACTIONS = ''
-        Object.defineProperty(process, 'platform', {value: 'win32', configurable: true})
-    })
-    
-    it('win32', () => {
-        const expected = path.join(os.homedir(), 'AppData', 'Local', `uniswap-v2-loader_${uniswap_v2_factory}.csv`)
-        assert.equal(default_cache_filename(uniswap_v2_factory), expected)
-    })
-    it('win32 & APPDATA', () => {
-        process.env.APPDATA = 'cache'
-        assert.equal(
-            default_cache_filename(uniswap_v2_factory),
-            'cache/uniswap-v2-loader_0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f.csv'
-        )
-    })
-    it('win32 & LOCALAPPDATA', () => {
-        process.env.LOCALAPPDATA = 'cache'
-        assert.equal(
-            default_cache_filename(uniswap_v2_factory),
-            'cache/uniswap-v2-loader_0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f.csv'
-        )
-    })
-
-    it('linux .cache', () => {
-        const exists_sync = fs.existsSync
-        fs.existsSync = p => p.endsWith('.cache')
-        Object.defineProperty(process, 'platform', {value: 'linux', configurable: true})
-        process.env.XDG_CACHE_HOME = ''
-        const expected = path.join(os.homedir(), '.cache', `uniswap-v2-loader_${uniswap_v2_factory}.csv`)
-        assert.equal(default_cache_filename(uniswap_v2_factory), expected)
-        fs.existsSync = exists_sync
-    })
-
-    it('os.tmpdir()', () => {
-        const exists_sync = fs.existsSync
-        fs.existsSync = path => false
-        Object.defineProperty(process, 'platform', {value: 'linux', configurable: true})
-        process.env.XDG_CACHE_HOME = ''
-        
-        const expected = path.join(os.tmpdir(), `uniswap-v2-loader_${uniswap_v2_factory}.csv`)
-        assert.equal(default_cache_filename(uniswap_v2_factory), expected)
-        fs.existsSync = exists_sync
-    })
-    
-    after(() => {
-        process.env.GITHUB_ACTIONS = 1
-        Object.defineProperty(process, 'platform', {value: platform})
-    })
-})
-
-describe('Cache OS filename at darwin', () => {
-    const platform = process.platform
-    const os = require('os')
-    const path = require('path')
-
-    before(() => {
-        process.env.GITHUB_ACTIONS = ''
-        Object.defineProperty(process, 'platform', {value: 'darwin', configurable: true})
-    })
-    
-    it('darwin', () => {
-        const expected = path.join(os.homedir(), 'Library', 'Caches', `uniswap-v2-loader_${uniswap_v2_factory}.csv`)
-        assert.equal(default_cache_filename(uniswap_v2_factory), expected)
-    })
-    
-    after(() => {
-        process.env.GITHUB_ACTIONS = 1
-        Object.defineProperty(process, 'platform', {value: platform})
-    })
-})
-
-describe('Cache OS filename at linux', () => {
-    const platform = process.platform
-    const XDG_CACHE_HOME = process.env.XDG_CACHE_HOME
-    const os = require('os')
-    const path = require('path')
-
-    before(() => {
-        process.env.GITHUB_ACTIONS = ''
-        Object.defineProperty(process, 'platform', {value: 'linux', configurable: true})
-    })
-    
-    it('linux XDG_CACHE_HOME', () => {
-        const exists_sync = fs.existsSync
-        const cache_dir = path.join(os.homedir(), '.cache')
-        fs.existsSync = p => p === cache_dir
-        process.env.XDG_CACHE_HOME = cache_dir
-        const expected = path.join(cache_dir, `uniswap-v2-loader_${uniswap_v2_factory}.csv`)
-        assert.equal(default_cache_filename(uniswap_v2_factory), expected)
-        fs.existsSync = exists_sync
-    })
-    
-    after(() => {
-        process.env.GITHUB_ACTIONS = 1
-        process.env.XDG_CACHE_HOME = XDG_CACHE_HOME
-        Object.defineProperty(process, 'platform', {value: platform})
-    })
-})