lpsignal 0.3.0 → 0.4.1

package/dist/types.d.ts

@@ -11,7 +11,7 @@
 /** Chains scanned today. The API may add more, so any string is accepted. */
 export type Chain = 'ethereum' | 'bsc' | 'base' | 'arbitrum' | 'optimism' | 'polygon' | (string & {});
 export type PairClass = 'stable' | 'correlated' | 'volatile';
-export type WindowHours = 3 | 24 | 168 | 720;
+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 interface Health {
@@ -190,17 +190,19 @@ export interface NetAprSignal extends SignalBase {
     stakedEmissionApr?: number;
 }
 /**
- * A short-term opportunity: a very high net APR over the last `windowHours` (3) that is still earning in the latest
- * hour. Noisier than `net_apr`; scored on the 24 hours after it fires. Pushed only to accounts subscribed to `burst`.
+ * A short-term opportunity: a very high net APR over the last `windowHours` (1) on real trading (`swaps` in the window).
+ * Noisier than `net_apr`; scored on the 24 hours after it fires. Pushed only to accounts subscribed to `burst`.
+ * The figures are for the window, whatever its length.
  */
 export interface BurstSignal extends SignalBase {
     kind: 'burst';
     tvlUsd: number;
     windowHours: number;
-    net3h: number;
-    fee3h: number;
-    il3h: number;
-    inRange3h: number;
+    swaps: number;
+    netApr: number;
+    feeApr: number;
+    ilApr: number;
+    inRangeRatio: number;
     /** context, exact values only (null when not exact) */
     net24h: number | null;
     net7d: number | null;
@@ -406,10 +408,13 @@ export interface BillingStatus {
         tier: string;
         until: string | null;
     };
+    /** `until`: when access ends (the period end, or the grace end while a renewal is unpaid); `cancelAtPeriodEnd`: the
+     *  subscription behind `tier`/`until` ends then instead of renewing (auto-renewal off in the billing portal) */
     stripe: {
         tier: string | null;
         until: string | null;
         status: string | null;
+        cancelAtPeriodEnd: boolean;
         invoiceUnpaidSince: string | null;
         syncedAt: string | null;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lpsignal",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "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",