shibaswap-dump 1.0.0 → 1.0.3

package/.github/workflows/update.yml

@@ -0,0 +1,60 @@
+name: Update dump binary files and publish to NPM
+
+on:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: '0 * * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update-data:
+
+    permissions:
+      contents: write
+      id-token: write  # Required for OIDC
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v6
+      with:
+        node-version: '24'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Update npm
+      run: npm install -g npm@latest
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run update
+      run: npm start
+
+    - name: Commit and push changes
+      id: commit
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        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_*.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
+
+    - name: Publish to NPM
+      if: steps.commit.outputs.can_publish == 'true'
+      run: npm publish

package/README.md

@@ -6,15 +6,24 @@ Static set of addresses (ShibaSwap 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>
 via [uniswap-v2-loader](https://github.com/calp-pro/uniswap-v2-loader)
 
-Data: `dump.csv` 135Kb+ 
+Data:
+- `dump_pairs.bin` 21 Kb+ 
+- `dump_tokens.bin` 17 Kb+
+- `dump_p2tt.bin` 6 Kb+
 
-CSV schema: `id,pair,token0,token1`
-
-## Example:
-```
-...
-10,0x4200b824d4b1118e290767a9f255d53af21fabca,0x6b175474e89094c44da98b954eedeac495271d0f,0x9813037ee2218799597d83d4a5b6f3b6778218d9
-...
+## Output format
+`load` and subscribe` methods return collection of pools/pairs.
+```js
+[
+    ...
+    {
+        id: 10,
+        pair: '0x4200b824d4b1118e290767a9f255d53af21fabca',
+        token0: '0x6b175474e89094c44da98b954eedeac495271d0f',
+        token1: '0x9813037ee2218799597d83d4a5b6f3b6778218d9'
+    },
+    ...
+]
 ```
 where:
 - `10`

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: '0x115934131916c8b277dd010ee02de363c09d037c',
-    filename: dump_csv,
+    filename: dump,
+    csv: false,
     ...params
 })
 
@@ -11,7 +12,8 @@ module.exports.subscribe = (callback, params = {}) => loader.subscribe(
     callback,
     {
         factory: '0x115934131916c8b277dd010ee02de363c09d037c',
-        filename: dump_csv,
+        filename: dump,
+        csv: false,
         ...params
     }
-)
+)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shibaswap-dump",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Static set of addresses (ShibaSwap Ethereum mainnet)",
   "keywords": [
     "ShibaSwap",
@@ -22,6 +22,9 @@
     "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
   }
 }

package/.gitattributes

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