sushiswap-dump 1.0.3 → 1.0.6

package/.gitattributes

@@ -1 +0,0 @@
-dump.csv filter=lfs diff=lfs merge=lfs -text

package/.github/workflows/update.yml

@@ -1,4 +1,4 @@
-name: Update dump.csv
+name: Update dump binary files and publish to NPM
 
 on:
   push:
@@ -22,14 +22,12 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        lfs: true
+      uses: actions/checkout@v6
 
     - name: Setup Node.js
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v6
       with:
-        node-version: '22'
+        node-version: '24'
         registry-url: 'https://registry.npmjs.org'
 
     - name: Update npm
@@ -46,11 +44,13 @@ jobs:
       run: |
         git config --global user.name "github-actions[bot]"
         git config --global user.email "github-actions[bot]@users.noreply.github.com"
-        git add dump.csv
+        git add dump_pairs.bin dump_tokens.bin dump_p2tt.bin
         if ! git diff --cached --quiet; then
-          npm version patch --force -m "chore: update dump.csv to %s [skip ci]"
+          npm version patch --force -m "chore: update dump_*.bin to %s [skip ci]"
           git push --follow-tags
           echo "can_publish=true" >> $GITHUB_OUTPUT
+        elif [ "${{ github.event_name }}" != "schedule" ]; then
+          echo "can_publish=true" >> $GITHUB_OUTPUT
         else
           echo "No changes"
         fi

package/README.md

@@ -3,18 +3,28 @@
 <br>
 
 Static set of addresses (SushiSwap Ethereum mainnet).<br>
-New pairs updates happen every hour at GitHub Action [update.yml](https://github.com/calp-pro/uniswap-v2-dump/actions/workflows/update.yml)<br>
+New pairs updates happen **every hour** at GitHub Action [update.yml](https://github.com/calp-pro/uniswap-v2-dump/actions/workflows/update.yml)<br>
 via [uniswap-v2-loader](https://github.com/calp-pro/uniswap-v2-loader)
 
-Data: `dump.csv` 209Kb+ 
+Data:
+- `dump_pairs.bin` 90 Kb+ 
+- `dump_tokens.bin` 76 Kb+
+- `dump_p2tt.bin` 27 Kb+
 
-CSV schema: `id,pair,token0,token1`
 
-## Example:
-```
-...
-1,0x06da0fd433c1a5d7a4faa01111c044910a184553,0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2,0xdac17f958d2ee523a2206206994597c13d831ec7
-...
+## Output format
+`load` and subscribe` methods return collection of pools/pairs.
+```js
+[
+    ...
+    {
+        id: 1,
+        pair: '0x06da0fd433c1a5d7a4faa01111c044910a184553',
+        token0: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+        token1: '0xdac17f958d2ee523a2206206994597c13d831ec7'
+    },
+    ...
+]
 ```
 where:
 - `1`
@@ -29,7 +39,7 @@ where:
 ## API
 Same implementation as other Uniswap v2 based protocols.<br>
 Base API reference: [uniswap-v2-loader](https://github.com/calp-pro/uniswap-v2-loader?tab=readme-ov-file#api-reference).<br>
-Predefined `filename` with value `dump.csv`.
+Predefined `filename` with value `dump` & `csv: false`.
 
 ## Usage CLI/API:
 ```bash

package/index.d.ts

@@ -22,6 +22,8 @@ export interface load_params {
   factory?: string
   /** Path to the cache file. Set to null to disable caching. */
   filename?: string | null
+  /** Switch cache between CSV and binary mode. */
+  csv?: boolean
   /** Number of pairs to fetch in a single multicall. */
   multicall_size?: number
   /** Start loading from this index. */
@@ -56,4 +58,4 @@ export function load(params?: load_params): Promise<pair[]>
 export function subscribe(
   callback: (pairs: pair[]) => void,
   params?: load_params
-): () => void
+): () => void

package/index.js

@@ -1,9 +1,10 @@
 const loader = require('uniswap-v2-loader')
-const dump_csv = require('path').join(__dirname, 'dump.csv')
+const dump = require('path').join(__dirname, 'dump')
 
 module.exports.load = (params = {}) => loader.load({
     factory: '0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac',
-    filename: dump_csv,
+    filename: dump,
+    csv: false,
     ...params
 })
 
@@ -11,7 +12,8 @@ module.exports.subscribe = (callback, params = {}) => loader.subscribe(
     callback,
     {
         factory: '0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac',
-        filename: dump_csv,
+        filename: dump,
+        csv: false,
         ...params
     }
 )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sushiswap-dump",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "Static set of addresses (SushiSwap Ethereum mainnet)",
   "keywords": [
     "SushiSwap",
@@ -22,7 +22,7 @@
     "start": "node -e \"require('./index.js').load({workers: 0})\""
   },
   "dependencies": {
-    "uniswap-v2-loader": "^5.0.20"
+    "uniswap-v2-loader": "^6.1.3"
   },
   "publishConfig": {
     "provenance": true