uniswap-v2-loader 5.0.26 → 6.0.0

package/.github/workflows/test.yml

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

package/README.md

@@ -1,51 +1,121 @@
 # <picture><source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/npm/uniswap-v2-loader@5.0.1/logo-dark.svg"><img alt="calp.pro icon" src="https://cdn.jsdelivr.net/npm/uniswap-v2-loader@5.0.1/logo-light.svg" height="32" align="absmiddle"></picture>&nbsp;&nbsp;uniswap-v2-loader&nbsp;&nbsp;[![Coverage](https://coveralls.io/repos/github/calp-pro/uniswap-v2-loader/badge.svg?branch=main)](https://coveralls.io/github/calp-pro/uniswap-v2-loader)
 
-<br>
-
-**Fast DeFi AMM pools loader.** Optimized for **Multi-core CPUs** with smart **disk-cache**.
+**Fast DeFi AMM pools loader.** Optimized for **Multi-core CPUs** with smart **disk-cache**.<br>
+This package is a loader that allows you to download protocol addresses yourself.<br>
+If you want to instantly get all addresses (pools and their tokens), use the packages from the next section.<br>
+Those packages check for updates every hour and republish the package with updated data.
 
 ## Uniswap V2 based protocols
-| Protocol | Factory Address |
-| :--- | :--- |
-| **Uniswap V2** | `0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f` |
-| **SushiSwap** | `0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac` |
-| **PancakeSwap** | `0x1097053fd2ea711dad45caccc45eff7548fcb362` |
-| **ShibaSwap** | `0x115934131916c8b277dd010ee02de363c09d037c` |
-| **DefiSwap** | `0x9deb29c9a4c7a88a3c0257393b7f3335338d9a9d` |
-| **EtherVista** | `0x9a27cb5ae0b2cee0bb71f9a85c0d60f3920757b4` |
-| **RadioShack** | `0x91fae1bc94a9793708fbc66adcb59087c46dee10` |
-
+- **Uniswap V2**
+  * `0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f` fabric [contract](https://etherscan.io/address/0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f)
+  * pre-loaded CSV dump: [uniswap-v2-dump](https://github.com/calp-pro/uniswap-v2-dump)
+- **SushiSwap**
+  * `0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac` fabric [contract](https://etherscan.io/address/0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac)
+  * pre-loaded CSV dump: [sushiswap-dump](https://github.com/calp-pro/sushiswap-dump)
+- **PancakeSwap**
+  * `0x1097053fd2ea711dad45caccc45eff7548fcb362` fabric [contract](https://etherscan.io/address/0x1097053fd2ea711dad45caccc45eff7548fcb362)
+  * pre-loaded CSV dump: [pancakeswap-dump](https://github.com/calp-pro/pancakeswap-dump)
+- **ShibaSwap**
+  * `0x115934131916c8b277dd010ee02de363c09d037c` fabric [contract](https://etherscan.io/address/0x115934131916c8b277dd010ee02de363c09d037c)
+  * pre-loaded CSV dump: [shibaswap-dump](https://github.com/calp-pro/shibaswap-dump)
+- **DefiSwap**
+  * `0x9deb29c9a4c7a88a3c0257393b7f3335338d9a9d` fabric [contract](https://etherscan.io/address/0x9deb29c9a4c7a88a3c0257393b7f3335338d9a9d)
+  * pre-loaded CSV dump: [defiswap-dump](https://github.com/calp-pro/defiswap-dump)
+- **EtherVista**
+  * `0x9a27cb5ae0b2cee0bb71f9a85c0d60f3920757b4` fabric [contract](https://etherscan.io/address/0x9a27cb5ae0b2cee0bb71f9a85c0d60f3920757b4)
+  * pre-loaded CSV dump: [ethervista-dump](https://github.com/calp-pro/ethervista-dump)
+- **RadioShack**
+  * `0x91fae1bc94a9793708fbc66adcb59087c46dee10` fabric [contract](https://etherscan.io/address/0x91fae1bc94a9793708fbc66adcb59087c46dee10)
+  * pre-loaded CSV dump: [radioshack-dump](https://github.com/calp-pro/radioshack-dump)
+
+## Install
+- CLI
+  * ```
+    npm i -g uniswap-v2-loader
+    ```
+- Node.js API
+  * ```
+    npm i --save uniswap-v2-loader
+    ```
 
 ## CLI
 ```bash
-> npm i -g uniswap-v2-loader
-> uniswap-v2-loader --from=1 --to=3
-
+uniswap-v2-loader --from=1 --to=3
+```
+Output:
+```
 2,0x12ede161c702d1494612d19f05992f43aa6a26fb,0x06af07097c9eeb7fd685c692751d5c66db49c215,0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
 3,0xa478c2975ab1ea89e8196811f51a7b7ade33eb11,0x6b175474e89094c44da98b954eedeac495271d0f,0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
 ```
 
-## API Reference
-
-### `load(params)`
-High-performance parallel fetcher for liquidity pairs. Efficiently synchronizes state with local disk cache and executes multi-threaded RPC requests.
+## API
+Methods:
+- `load(config)`
+  * return `Promise(<Pair>[])`
+- `subscribe(callback, config)`
+  * Continuous synchronization engine. Performs initial load and subsequently polls for new pairs.
+  * return unsubscribe function
+
+<i>where `config` is common `Object` with set of parameters to loader.</i>
+
+`config` is an Object (key/value)
+- `from`
+  * Start index (inclusive).
+  * Type: `number`
+  * Default: `0`
+- `to`
+  * End index (inclusive).
+  * Type: `number`
+  * Default: `undefined`
+- `filename`
+  * CSV cache path.
+  * Type: `string`
+  * Default: *OS cache folder*
+- `factory`
+  * Smart contract factory address.
+  * Type: `string`
+  * Default: `0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f`
+- `key`
+  * Alchemy API Key
+  * Type: `string`
+  *  Default: `FZBvlPrOxtgaKBBkry3SH0W1IqH4Y5tu`
+- `multicall_size`
+  * RPC batch size per multicall request.
+  * Type:`number`
+  * Default: `50`
+- `workers`
+  * Number of parallel worker threads.
+  * Type: `number`
+  * Default: `CPU - 1`
+- `progress`
+  * Each loaded pair execute this callback: `(id, total, pair) => {}`.
+  * Callback arguments:
+    - `id` fabric index of pair contract (int)
+    - `total` total amount of pairs at fabric at current moment
+    - `pair` instance of `Pair`(`{id: number, pair: string, token0: string, token1: string}`)
+  * Type: `function`
+  * Default: `undefined`
+- `abort_signal`
+* Signal to cancel loading and release workers.
+* Type: `AbortSignal`
+* Default: `undefined`
+- `update_timeout`
+* Polling interval in milliseconds. Used only in `subscribe`
+* Type: `number`
+* Default: `5000`
+
+### Schema `Pair`
+Standardized liquidity pool object.
 
-**Parameters**
-| Name | Type | Description | Default |
-| :--- | :--- | :--- | :--- |
-| `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. | `0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f` |
-| `key` | `string` | Alchemy API Key | `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` |
-| `abort_signal` | `AbortSignal` | Signal to cancel loading and release workers. | `undefined` |
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `id` | `number` | Numeric index of the pair in the factory |
+| `pair` | `string` | DEX pair address |
+| `token0` | `string` | Token address |
+| `token1` | `string` | Token address |
 
-**Returns**: `Promise<Pair[]>`
 
-**Example Response**
+**Example `<Pair>[]`**
 ```json
 [
   {
@@ -57,8 +127,6 @@ High-performance parallel fetcher for liquidity pairs. Efficiently synchronizes
 ]
 ```
 
----
-
 ### Smart Cross-Platform Caching
 The loader automatically identifies the optimal persistent storage path for your operating system to ensure zero-configuration caching:
 - **Linux:** `$XDG_CACHE_HOME` or `~/.cache/`
@@ -67,35 +135,8 @@ The loader automatically identifies the optimal persistent storage path for your
 
 Cache files are named following the pattern `${package_name}_{factory_address}.csv`.
 
----
-
-### `subscribe(callback, params)`
-Continuous synchronization engine. Performs initial load and subsequently polls for new pairs.
-
-**Parameters**
-| Name | Type | Description | Default |
-| :--- | :--- | :--- | :--- |
-| `callback` | `function` | Invoked with updated `Pair[]` array. | **Required** |
-| `params` | `object` | All options from `load()` plus `update_timeout`. | - |
-| `update_timeout` | `number` | Polling interval in milliseconds. | `5000` |
-
-**Returns**: `function` (Stop/Unsubscribe function)
-
----
-
-### Schema: `Pair`
-Standardized liquidity pool object.
-
-| Property | Type | Description |
-| :--- | :--- | :--- |
-| `id` | `number` | Global index of the pair in the factory. |
-| `pair` | `string` | Ethereum address of the liquidity pool. |
-| `token0` | `string` | Address of the first asset. |
-| `token1` | `string` | Address of the second asset. |
-
----
 
-## Usage Example
+## API Usage
 ```javascript
 const { load } = require('uniswap-v2-loader')
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniswap-v2-loader",
-  "version": "5.0.26",
+  "version": "6.0.0",
   "description": "Uniswap v2 protocol loader",
   "keywords": [
     "DEFI",

package/src/index.js

@@ -39,12 +39,12 @@ const load = (params = {}) => {
             }, [])
         : []
 
-    if (to >= 0 && pairs.length >= to) {
+    if (to >= 0 && to <= pairs.length - 1) {
         if (progress)
-            for (var i = from; i < to; i++)
+            for (var i = from; i <= to; i++)
                 progress(pairs[i].id, to, pairs[i])
 
-        return Promise.resolve(pairs.slice(0, to))
+        return Promise.resolve(pairs.slice(from, to + 1))
     }
 
     return (to
@@ -61,17 +61,24 @@ const load = (params = {}) => {
             })
         }).then(
             _ => {
-                if (_.ok) return _.json().then(_ => Number(_.result))
+                if (_.ok) return _.json().then(_ => {
+                    const total_pools = Number(_.result)
+                    if (total_pools > 0) {
+                        const last_id = total_pools - 1
+                        return last_id
+                    }
+                    return 0
+                })
                 throw 'fail start'
             },
             _ => {
                 throw 'fetch failed'
             }
         )
-    ).then(all_pairs_length => {
+    ).then(last_id => {
         const start_loading_from = pairs.length
             ? Math.max(from, pairs[pairs.length - 1].id + 1)
-            : 0
+            : from
 
         var next_pair_order = pairs.length
             ? pairs[pairs.length - 1].id + 1
@@ -79,11 +86,11 @@ const load = (params = {}) => {
 
         if (progress)
             for (var i = from; i < start_loading_from; i++)
-                progress(pairs[i].id, all_pairs_length, pairs[i])
+                progress(pairs[i].id, last_id + 1, pairs[i])
         
         const onpair = pair => {
             pairs[pair.id] = pair
-            if (progress) progress(pair.id, all_pairs_length, pair)
+            if (progress && pair.id >= from) progress(pair.id, last_id + 1, pair)
             var _
             while (_ = pairs[next_pair_order]) {
                 fs.appendFileSync(filename, `${_.id},${_.pair},${_.token0},${_.token1}\n`)
@@ -93,15 +100,20 @@ const load = (params = {}) => {
 
         if (!workers) {
             const ids = []
-            for (var i = start_loading_from; i < all_pairs_length; i++)
+            for (var i = start_loading_from; i <= last_id; i++)
                 ids.push(i)
             return require('./loader')({ ids, factory, key, multicall_size, abort_signal }, onpair)
-            .then(() => pairs)
+            .then(() => {
+                if (from && to) return pairs.filter(({id}) => id >= from && id <= to)
+                if (from) return pairs.filter(({id}) => id >= from)
+                if (to) return pairs.filter(({id}) => id <= to)
+                return pairs
+            })
         }
 
         const missed = Array(workers).fill(null).map(() => [])
 
-        for (var i = start_loading_from, iw = 0; i < all_pairs_length; i++)
+        for (var i = start_loading_from, iw = 0; i <= last_id; i++)
             missed[iw++ % workers].push(i)
         
         cluster.setupPrimary({ exec: path.join(__dirname, 'loader.js') })
@@ -121,7 +133,12 @@ const load = (params = {}) => {
                     y()
                 })
             }))
-        ).then(() => pairs)
+        ).then(() => {
+            if (from && to) return pairs.filter(({id}) => id >= from && id <= to)
+            if (from) return pairs.filter(({id}) => id >= from)
+            if (to) return pairs.filter(({id}) => id <= to)
+            return pairs
+        })
     })
     .catch(() => abort_signal?.aborted ? pairs : new Promise(resolve => setTimeout(() => resolve(load(params)), 1000)))
 }
@@ -139,7 +156,7 @@ module.exports.subscribe = (callback, params = {}) => {
         const update = pairs =>
             timeout = setTimeout(
                 () =>
-                    load({...params, pairs, from: pairs.length})
+                    subscribed && load({...params, pairs, from: pairs.length})
                     .then(pairs => {
                         if (!subscribed) return
                         callback(pairs)