lpsignal 0.8.0 → 0.9.0

package/dist/client.d.ts

@@ -170,7 +170,7 @@ export declare class LPSignal {
     deleteRule(id: string): Promise<void>;
     /**
      * The kinds of global signal pushed to you on Telegram, webhook and WebSocket (core events by default; add 'burst'
-     * for short-term opportunities). Custom-rule matches always arrive.
+     * for short-term opportunities, 'hot_pool' for high-yield pools). Custom-rule matches always arrive.
      */
     setSubscriptions(kinds: SignalKind[]): Promise<{
         subscriptions: SignalKind[];

package/dist/client.js

@@ -226,7 +226,7 @@ export class LPSignal {
     }
     /**
      * The kinds of global signal pushed to you on Telegram, webhook and WebSocket (core events by default; add 'burst'
-     * for short-term opportunities). Custom-rule matches always arrive.
+     * for short-term opportunities, 'hot_pool' for high-yield pools). Custom-rule matches always arrive.
      */
     setSubscriptions(kinds) {
         return this.request('PUT', '/v1/me/subscriptions', { body: { kinds } });

package/dist/types.d.ts

@@ -13,7 +13,7 @@ export type Chain = 'ethereum' | 'bsc' | 'base' | 'arbitrum' | 'optimism' | 'pol
 export type PairClass = 'stable' | 'correlated' | 'volatile';
 export type WindowHours = 1 | 24 | 168 | 720;
 export type Tier = 'free' | 'basic' | 'pro';
-export type SignalKind = 'net_apr' | 'burst' | 'tvl_outflow' | 'depeg' | 'smart_lp';
+export type SignalKind = 'net_apr' | 'burst' | 'hot_pool' | 'tvl_outflow' | 'depeg' | 'smart_lp';
 export interface Health {
     ok: boolean;
 }
@@ -226,6 +226,24 @@ export interface BurstSignal extends SignalBase {
     net7d: number | null;
     stakedEmissionApr?: number;
 }
+/**
+ * High yield, high risk: a big pool (TVL $500k+) whose pool-level 24h fee APR — estimated 24h fees / TVL x 365, as DEX
+ * sites show it — reached 50%+ and at least twice its own 7-day average. A pool-level figure, not a recommended
+ * position (`tickLower`/`tickUpper` are 0), never scored (`outcome` stays null). Impermanent loss can exceed the fees:
+ * `bestNet24h` is what the best range netted over the same day (fees − IL; `bestRangeBp` says which), null without a
+ * 24h backtest. Pushed only to accounts subscribed to `hot_pool`.
+ */
+export interface HotPoolSignal extends SignalBase {
+    kind: 'hot_pool';
+    tvlUsd: number;
+    poolApr24h: number;
+    poolApr7d: number;
+    volume24hUsd: number;
+    fees24hUsd: number;
+    bestNet24h: number | null;
+    bestRangeBp: number | null;
+    risk: 'high';
+}
 /** Liquidity fell by `drop` within `windowHours`, valued at current prices. */
 export interface TvlOutflowSignal extends SignalBase {
     kind: 'tvl_outflow';
@@ -256,7 +274,7 @@ export interface SmartLpSignal extends SignalBase {
         returnPct: number;
     } | null;
 }
-export type Signal = NetAprSignal | BurstSignal | TvlOutflowSignal | DepegSignal | SmartLpSignal;
+export type Signal = NetAprSignal | BurstSignal | HotPoolSignal | TvlOutflowSignal | DepegSignal | SmartLpSignal;
 export interface SignalsPage {
     signals: Signal[];
     /** pass as `before` for the next (older) page; null on the last page (and always when sorted) */
@@ -351,7 +369,7 @@ export interface Me {
     hasApiKey: boolean;
     /**
      * kinds of global signal pushed to this account (Telegram, webhook, WebSocket without `kinds`): the core events
-     * net_apr, tvl_outflow, depeg, smart_lp by default; burst only when added. Custom-rule matches always arrive.
+     * net_apr, tvl_outflow, depeg, smart_lp by default; burst and hot_pool only when added. Custom-rule matches always arrive.
      */
     subscriptions: SignalKind[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lpsignal",
-  "version": "0.8.0",
+  "version": "0.9.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",