uniswap-v2-loader 4.0.1 → 5.0.0

package/README.md

@@ -1,8 +1,5 @@
-# <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="./calp-dark.svg">
-  <img alt="calp.pro icon" src="./calp-light.svg" height="32" style="vertical-align: middle;">
-</picture> uniswap-v2-loader
-<br>
+# <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>
 
 **Fast DeFi AMM pools loader.** Optimized for **Multi-core CPUs** with **viem** multicall and smart **disk-cache**.
@@ -45,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` |
@@ -77,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**
@@ -105,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/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

@@ -7,7 +7,7 @@ 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 {
@@ -110,9 +110,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 +122,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniswap-v2-loader",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "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": {