lpsignal 0.6.0 → 0.7.0

package/README.md

@@ -28,7 +28,7 @@ try {
 | Method | Endpoint | Key |
 |---|---|---|
 | `health()` · `chains()` | `/v1/health` · `/v1/chains` | – |
-| `pools({ chain, class, window, minTvlUsd, limit, offset, sort, order })` | `GET /v1/pools` — `sort`: `netApr` (default) · `feeApr` · `ilApr` · `inRange` · `emissionApr` · `tvl` · `fee`; `order`: `desc` (default) · `asc`; the page carries `total` | – |
+| `pools({ chain, class, window, minTvlUsd, limit, offset, sort, order })` | `GET /v1/pools` — `sort`: `netApr` (default) · `feeApr` · `ilApr` · `inRange` · `emissionApr` · `tvl` · `fee` · `volume24h` · `fees24h`; `order`: `desc` (default) · `asc`; the page carries `total`; each pool carries `volume24hUsd`, `fees24hUsd` (an estimate: volume × the current fee rate) and `best.net24h` | – |
 | `iteratePools({ …, sort, order })` | every page, in that order (best effort: none twice; one whose place changes meanwhile may be missed) | – |
 | `pool(chain, address)` · `poolHours(chain, address, { hours })` | `GET /v1/pools/:chain/:address[/hours]` | – |
 | `backtest(chain, address, { rangePct, days })` | `GET …/backtest` | – |
@@ -36,7 +36,7 @@ try {
 | `signalStats({ days })` | `GET /v1/signals/stats` — the public track record | – |
 | `iterateSignals({ kind })` | every page, newest first | optional |
 | `signalsAfter(id)` | everything newer than `id`, oldest first | optional |
-| `smartLps({ windowDays, chain, limit, offset, sort, order })` | `GET /v1/smart-lps` — `sort`: `rank` (default, = pnl rank) · `pnl` · `return` · `capital` · `closes` · `wins`; `rank` stays the pnl rank whatever the sort; `total` | optional |
+| `smartLps({ windowDays, chain, limit, offset, sort, order })` | `GET /v1/smart-lps` — `sort`: `rank` (default, = pnl rank) · `pnl` · `return` · `capital` · `closes` · `wins` · `apr` · `winRate`; `rank` stays the pnl rank whatever the sort; `total`; each wallet carries `aprVsHold` (annualised vs holding), `winRate`, `avgHoldH` | optional |
 | `iterateSmartLps({ …, sort, order })` | every wallet on the board, in that order | optional |
 | `walletPositions(owner, { limit, openOffset, openSort, openOrder, closedOffset, closedSort, closedOrder })` | `GET /v1/smart-lps/:owner/positions` — each list pages and sorts on its own (`openSort`: `lastEvent` · `openedAt` · `entryUsd`; `closedSort`: `closedAt` · `openedAt` · `capitalUsd` · `pnlUsd`); `openTotal` / `closedTotal` | Pro |
 | `follows()` · `follow(owner)` · `unfollow(owner)` | `/v1/me/follows` | Pro |

package/dist/types.d.ts

@@ -42,6 +42,8 @@ export interface BestRange {
     /** Slipstream: gauge emissions if staked instead (fees forgone, not backtested); 0 = not applicable */
     stakedEmissionApr: number;
     asOf: string;
+    /** pools list only: the same range's net APR over the last 24h (null = not computed) */
+    net24h?: number | null;
 }
 export interface RankedPool {
     chain: Chain;
@@ -55,11 +57,17 @@ export interface RankedPool {
     /** v4 pools: liquidity within ±2% of price, since v4 has no per-pool balances */
     tvlUsd: number;
     tvlAt: string | null;
+    /**
+     * the last 24h in USD at the latest prices; null = no price yet. fees = an ESTIMATE of the swap fees paid: volume ×
+     * the pool's current fee rate, before protocol cuts (dynamic-fee pools: approximate) — not what LPs were paid
+     */
+    volume24hUsd: number | null;
+    fees24hUsd: number | null;
     best: BestRange;
 }
 export type Order = 'asc' | 'desc';
 /** what `pools` can sort by: the best range's figures, the pool's TVL or fee tier */
-export type PoolSort = 'netApr' | 'feeApr' | 'ilApr' | 'inRange' | 'emissionApr' | 'tvl' | 'fee';
+export type PoolSort = 'netApr' | 'feeApr' | 'ilApr' | 'inRange' | 'emissionApr' | 'tvl' | 'fee' | 'volume24h' | 'fees24h';
 /** what `signals` can sort by: time (newest first, cursor), return (APR at firing), outcome (realised result) */
 export type SignalSort = 'time' | 'return' | 'outcome';
 export interface PoolsPage {
@@ -268,6 +276,12 @@ export interface LeaderboardWallet {
     pnlUsd: number;
     returnPct: number;
     chains: Chain[];
+    /** annualised return vs holding over the capital × time deployed; null = no close with a known opening */
+    aprVsHold: number | null;
+    /** closes with a positive pnl / closes */
+    winRate: number;
+    /** capital-weighted hours a position was held */
+    avgHoldH: number | null;
 }
 export interface Leaderboard {
     windowDays: 30 | 90;
@@ -282,7 +296,7 @@ export interface Leaderboard {
     order: Order;
 }
 /** what `smartLps` can sort by; `rank` (the pnl rank) stays the wallet's rank whatever the sort */
-export type BoardSort = 'rank' | 'pnl' | 'return' | 'capital' | 'closes' | 'wins';
+export type BoardSort = 'rank' | 'pnl' | 'return' | 'capital' | 'closes' | 'wins' | 'apr' | 'winRate';
 interface PositionPool {
     chain: Chain;
     pool: string;
@@ -297,6 +311,8 @@ export interface OpenPosition extends PositionPool {
     openedAt: string | null;
     staked: boolean;
     entryUsd: number | null;
+    /** the pool's tick now (its latest hourly close): in range when tickLower <= poolTick < tickUpper; null = unknown */
+    poolTick: number | null;
 }
 export interface ClosedPosition extends PositionPool {
     tokenId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lpsignal",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Official LPSignal SDK: net-of-IL APR signals for concentrated-liquidity pools, a WebSocket stream that never misses a signal, webhook verification and the REST API.",
   "type": "module",
   "main": "./dist/index.js",