@velocity-exchange/sdk 0.3.0 → 0.4.0

package/lib/node/accounts/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/accounts/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAa,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAClC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,EACvC,OAAO,EAAE,MAAM,GACb,WAAW,CAAC,CAAC,CAAC,CAKhB;AAED,wBAAgB,iCAAiC,CAChD,WAAW,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,EAC7C,WAAW,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,GAC3C;IAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,UAAU,EAAE,CAAA;CAAE,CAiDxD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/accounts/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAa,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,mHAAmH;AACnH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAClC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,EACvC,OAAO,EAAE,MAAM,GACb,WAAW,CAAC,CAAC,CAAC,CAKhB;AAED;;;;;;;;;GASG;AACH,wBAAgB,iCAAiC,CAChD,WAAW,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,EAC7C,WAAW,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,GAC3C;IAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,UAAU,EAAE,CAAA;CAAE,CAiDxD"}

package/lib/node/accounts/utils.js

@@ -3,10 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.findDelistedPerpMarketsAndOracles = exports.assertDataAndSlot = exports.capitalize = void 0;
 const types_1 = require("../types");
 const oracleId_1 = require("../oracles/oracleId");
+/** Capitalizes the first character of `value` (e.g. for building Anchor event/method names from account names). */
 function capitalize(value) {
     return value[0].toUpperCase() + value.slice(1);
 }
 exports.capitalize = capitalize;
+/**
+ * Unwraps a possibly-undefined `DataAndSlot<T>`, throwing if it hasn't loaded. Use this instead
+ * of a bare non-null assertion when a subscriber's cached data must be present by this point.
+ * @param dataAndSlot The cached data/slot pair to check, typically from `AccountSubscriber.dataAndSlot`.
+ * @param message Error message to throw if `dataAndSlot` is undefined.
+ * @returns The same `dataAndSlot`, narrowed to non-undefined.
+ */
 function assertDataAndSlot(dataAndSlot, message) {
     if (!dataAndSlot) {
         throw new Error(message);
@@ -14,6 +22,16 @@ function assertDataAndSlot(dataAndSlot, message) {
     return dataAndSlot;
 }
 exports.assertDataAndSlot = assertDataAndSlot;
+/**
+ * Scans cached perp/spot market data for perp markets with `status: delisted` and identifies
+ * both the delisted market indexes and their oracles, excluding any oracle still in use by a
+ * spot market or a non-delisted perp market (so a shared oracle isn't dropped out from under a
+ * still-live market). Used by `VelocityClientAccountSubscriber` implementations to drive
+ * `DelistedMarketSetting` (unsubscribe/discard) handling.
+ * @param perpMarkets Currently cached perp market data/slots (entries with missing `data` are skipped).
+ * @param spotMarkets Currently cached spot market data/slots, checked to avoid dropping oracles they still reference.
+ * @returns `perpMarketIndexes` of delisted perp markets and `oracles` safe to stop tracking.
+ */
 function findDelistedPerpMarketsAndOracles(perpMarkets, spotMarkets) {
     const delistedPerpMarketIndexes = [];
     const delistedOracles = [];
@@ -29,25 +47,23 @@ function findDelistedPerpMarketsAndOracles(perpMarkets, spotMarkets) {
             });
         }
     }
-    // make sure oracle isn't used by spot market
-    const filteredDelistedOracles = [];
-    for (const delistedOracle of delistedOracles) {
-        let isUsedBySpotMarket = false;
-        for (const spotMarket of spotMarkets) {
-            if (!spotMarket || !spotMarket.data) {
-                continue;
-            }
-            const delistedOracleId = (0, oracleId_1.getOracleId)(delistedOracle.publicKey, delistedOracle.source);
-            const spotMarketOracleId = (0, oracleId_1.getOracleId)(spotMarket.data.oracle, spotMarket.data.oracleSource);
-            if (spotMarketOracleId === delistedOracleId) {
-                isUsedBySpotMarket = true;
-                break;
-            }
+    // make sure oracle isn't still used by a spot market or a live perp market
+    const liveOracleIds = new Set();
+    for (const spotMarket of spotMarkets) {
+        if (!spotMarket || !spotMarket.data) {
+            continue;
+        }
+        liveOracleIds.add((0, oracleId_1.getOracleId)(spotMarket.data.oracle, spotMarket.data.oracleSource));
+    }
+    for (const perpMarket of perpMarkets) {
+        if (!perpMarket || !perpMarket.data) {
+            continue;
         }
-        if (!isUsedBySpotMarket) {
-            filteredDelistedOracles.push(delistedOracle);
+        if (!(0, types_1.isVariant)(perpMarket.data.status, 'delisted')) {
+            liveOracleIds.add((0, oracleId_1.getOracleId)(perpMarket.data.oracle, perpMarket.data.oracleSource));
         }
     }
+    const filteredDelistedOracles = delistedOracles.filter((delistedOracle) => !liveOracleIds.has((0, oracleId_1.getOracleId)(delistedOracle.publicKey, delistedOracle.source)));
     return {
         perpMarketIndexes: delistedPerpMarketIndexes,
         oracles: filteredDelistedOracles,

package/lib/node/accounts/webSocketAccountSubscriber.d.ts

@@ -3,6 +3,16 @@
 import { DataAndSlot, BufferAndSlot, AccountSubscriber, ResubOpts } from './types';
 import { AccountInfo, Commitment, Context, PublicKey } from '@solana/web3.js';
 import { VelocityProgram } from '../config';
+/**
+ * Default `AccountSubscriber` implementation: tracks a single account via
+ * `connection.onAccountChange`, decoding each notification with either a supplied
+ * `decodeBuffer` function or the program's Anchor coder for `accountName`. Updates are applied
+ * only when the notification's slot is not older than the last-seen slot and the raw buffer
+ * actually changed, so `onChange` never fires twice for the same bytes. If `resubOpts.resubTimeoutMs`
+ * is set, a watchdog timer resubscribes to the WebSocket whenever no notification arrives within
+ * that window — see `ResubOpts` for tuning. This is the base class extended by
+ * `grpcAccountSubscriber` for gRPC Geyser-backed tracking.
+ */
 export declare class WebSocketAccountSubscriber<T> implements AccountSubscriber<T> {
     dataAndSlot?: DataAndSlot<T>;
     bufferAndSlot?: BufferAndSlot;
@@ -20,13 +30,44 @@ export declare class WebSocketAccountSubscriber<T> implements AccountSubscriber<
     isUnsubscribing: boolean;
     timeoutId?: ReturnType<typeof setTimeout>;
     receivingData: boolean;
+    /**
+     * @param accountName Anchor account type name (used for logging and, absent `decodeBuffer`, for decoding via the program coder).
+     * @param program Anchor program providing the connection and coder.
+     * @param accountPublicKey Address of the account to track.
+     * @param decodeBuffer Optional custom decode function; defaults to `program.coder.accounts.decode(accountName, buffer)`.
+     * @param resubOpts Resubscription watchdog options; omit to disable the inactivity timer.
+     * @param commitment Commitment for both the initial fetch and the `onAccountChange` subscription; defaults to the provider's configured commitment.
+     */
     constructor(accountName: string, program: VelocityProgram, accountPublicKey: PublicKey, decodeBuffer?: (buffer: Buffer) => T, resubOpts?: ResubOpts, commitment?: Commitment);
+    /**
+     * Seeds `dataAndSlot` with an initial `fetch()` (if not already set via `setData`) and then
+     * attaches the `onAccountChange` WebSocket listener. Returning early (no-op) if already
+     * subscribed or mid-unsubscribe.
+     * @param onChange Invoked with the newly decoded account data on each accepted update.
+     */
     subscribe(onChange: (data: T) => void): Promise<void>;
+    /**
+     * Seeds or overwrites `dataAndSlot` directly, bypassing RPC. A no-op if the currently cached
+     * slot is already newer than `slot`.
+     * @param data Decoded account data to store.
+     * @param slot Slot the data was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     setData(data: T, slot?: number): void;
     protected setTimeout(): void;
+    /** Fetches the account once via `getAccountInfoAndContext` and routes the result through `handleRpcResponse`, applying it if newer than the cached slot. */
     fetch(): Promise<void>;
+    /**
+     * Applies a raw RPC/WS response: decodes and stores it (updating `bufferAndSlot`/`dataAndSlot`
+     * and invoking `onChange`) only if the slot is not older than the cached one and the buffer's
+     * bytes actually changed (or this is the first observation).
+     */
     handleRpcResponse(context: Context, accountInfo?: AccountInfo<Buffer>): void;
+    /** Decodes a raw account buffer using the constructor-supplied `decodeBufferFn`, or the program's Anchor coder for `accountName` if none was supplied. */
     decodeBuffer(buffer: Buffer): T;
+    /**
+     * Tears down the WebSocket listener and cancels any pending resub timeout.
+     * @param onResub Internal flag set to `true` when called as part of an automatic resubscribe cycle, which preserves `resubOpts.resubTimeoutMs` instead of clearing it. Callers should omit this.
+     */
     unsubscribe(onResub?: boolean): Promise<void>;
 }
 //# sourceMappingURL=webSocketAccountSubscriber.d.ts.map

package/lib/node/accounts/webSocketAccountSubscriber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webSocketAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketAccountSubscriber.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAG5C,qBAAa,0BAA0B,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IACzE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAKhC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAEvC;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,UAAS;IAExB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAE1C,aAAa,EAAE,OAAO,CAAC;gBAGtB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,SAAS,EAC3B,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS,EACrB,UAAU,CAAC,EAAE,UAAU;IAqBlB,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3D,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrC,SAAS,CAAC,UAAU,IAAI,IAAI;IA0CtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI;IA0C5E,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAQ/B,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CA2C3C"}
+{"version":3,"file":"webSocketAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketAccountSubscriber.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAG5C;;;;;;;;;GASG;AACH,qBAAa,0BAA0B,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IACzE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAKhC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAEvC;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,UAAS;IAExB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAE1C,aAAa,EAAE,OAAO,CAAC;IAEvB;;;;;;;OAOG;gBAEF,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,SAAS,EAC3B,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS,EACrB,UAAU,CAAC,EAAE,UAAU;IAqBxB;;;;;OAKG;IACG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC3D;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrC,SAAS,CAAC,UAAU,IAAI,IAAI;IA0C5B,4JAA4J;IACtJ,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;;;OAIG;IACH,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI;IA0C5E,0JAA0J;IAC1J,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAQ/B;;;OAGG;IACH,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CA2C3C"}

package/lib/node/accounts/webSocketAccountSubscriber.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebSocketAccountSubscriber = void 0;
+/**
+ * Default `AccountSubscriber` implementation: tracks a single account via
+ * `connection.onAccountChange`, decoding each notification with either a supplied
+ * `decodeBuffer` function or the program's Anchor coder for `accountName`. Updates are applied
+ * only when the notification's slot is not older than the last-seen slot and the raw buffer
+ * actually changed, so `onChange` never fires twice for the same bytes. If `resubOpts.resubTimeoutMs`
+ * is set, a watchdog timer resubscribes to the WebSocket whenever no notification arrives within
+ * that window — see `ResubOpts` for tuning. This is the base class extended by
+ * `grpcAccountSubscriber` for gRPC Geyser-backed tracking.
+ */
 class WebSocketAccountSubscriber {
     get onChange() {
         if (!this._onChange) {
@@ -11,6 +21,14 @@ class WebSocketAccountSubscriber {
     set onChange(onChange) {
         this._onChange = onChange;
     }
+    /**
+     * @param accountName Anchor account type name (used for logging and, absent `decodeBuffer`, for decoding via the program coder).
+     * @param program Anchor program providing the connection and coder.
+     * @param accountPublicKey Address of the account to track.
+     * @param decodeBuffer Optional custom decode function; defaults to `program.coder.accounts.decode(accountName, buffer)`.
+     * @param resubOpts Resubscription watchdog options; omit to disable the inactivity timer.
+     * @param commitment Commitment for both the initial fetch and the `onAccountChange` subscription; defaults to the provider's configured commitment.
+     */
     constructor(accountName, program, accountPublicKey, decodeBuffer, resubOpts, commitment) {
         var _a;
         this.isUnsubscribing = false;
@@ -28,6 +46,12 @@ class WebSocketAccountSubscriber {
         this.commitment =
             commitment !== null && commitment !== void 0 ? commitment : this.program.provider.opts.commitment;
     }
+    /**
+     * Seeds `dataAndSlot` with an initial `fetch()` (if not already set via `setData`) and then
+     * attaches the `onAccountChange` WebSocket listener. Returning early (no-op) if already
+     * subscribed or mid-unsubscribe.
+     * @param onChange Invoked with the newly decoded account data on each accepted update.
+     */
     async subscribe(onChange) {
         var _a, _b;
         if (this.listenerId != null || this.isUnsubscribing) {
@@ -57,6 +81,12 @@ class WebSocketAccountSubscriber {
             this.setTimeout();
         }
     }
+    /**
+     * Seeds or overwrites `dataAndSlot` directly, bypassing RPC. A no-op if the currently cached
+     * slot is already newer than `slot`.
+     * @param data Decoded account data to store.
+     * @param slot Slot the data was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     setData(data, slot) {
         const newSlot = slot || 0;
         if (this.dataAndSlot && this.dataAndSlot.slot > newSlot) {
@@ -99,11 +129,17 @@ class WebSocketAccountSubscriber {
             }
         }, (_a = this.resubOpts) === null || _a === void 0 ? void 0 : _a.resubTimeoutMs);
     }
+    /** Fetches the account once via `getAccountInfoAndContext` and routes the result through `handleRpcResponse`, applying it if newer than the cached slot. */
     async fetch() {
         var _a;
         const rpcResponse = await this.program.provider.connection.getAccountInfoAndContext(this.accountPublicKey, this.program.provider.opts.commitment);
         this.handleRpcResponse(rpcResponse.context, (_a = rpcResponse === null || rpcResponse === void 0 ? void 0 : rpcResponse.value) !== null && _a !== void 0 ? _a : undefined);
     }
+    /**
+     * Applies a raw RPC/WS response: decodes and stores it (updating `bufferAndSlot`/`dataAndSlot`
+     * and invoking `onChange`) only if the slot is not older than the cached one and the buffer's
+     * bytes actually changed (or this is the first observation).
+     */
     handleRpcResponse(context, accountInfo) {
         const newSlot = context.slot;
         let newBuffer = undefined;
@@ -142,6 +178,7 @@ class WebSocketAccountSubscriber {
             this.onChange(account);
         }
     }
+    /** Decodes a raw account buffer using the constructor-supplied `decodeBufferFn`, or the program's Anchor coder for `accountName` if none was supplied. */
     decodeBuffer(buffer) {
         if (this.decodeBufferFn) {
             return this.decodeBufferFn(buffer);
@@ -150,6 +187,10 @@ class WebSocketAccountSubscriber {
             return this.program.coder.accounts.decode(this.accountName, buffer);
         }
     }
+    /**
+     * Tears down the WebSocket listener and cancels any pending resub timeout.
+     * @param onResub Internal flag set to `true` when called as part of an automatic resubscribe cycle, which preserves `resubOpts.resubTimeoutMs` instead of clearing it. Callers should omit this.
+     */
     unsubscribe(onResub = false) {
         if (!onResub && this.resubOpts) {
             this.resubOpts.resubTimeoutMs = undefined;

package/lib/node/accounts/webSocketAccountSubscriberV2.d.ts

@@ -88,8 +88,28 @@ export declare class WebSocketAccountSubscriberV2<T> implements AccountSubscribe
      */
     constructor(accountName: string, program: VelocityProgram, accountPublicKey: PublicKey, decodeBuffer?: (buffer: Buffer) => T, resubOpts?: ResubOpts, commitment?: Commitment, rpcSubscriptions?: RpcSubscriptions<SolanaRpcSubscriptionsApi> & string, rpc?: Rpc<any>);
     private handleNotificationLoop;
+    /**
+     * Seeds `dataAndSlot` with an initial `fetch()` (if not already set via `setData`), then opens
+     * the `gill` `accountNotifications` WebSocket subscription and, if `resubOpts.resubTimeoutMs`
+     * is set, arms the inactivity watchdog (`setTimeout`). Idempotent: a no-op if already
+     * subscribed or mid-unsubscribe.
+     * @param onChange Invoked with the newly decoded account data on each accepted update.
+     * @throws Error if `accountPublicKey` is not a valid address per `gill`'s `isAddress`.
+     */
     subscribe(onChange: (data: T) => void): Promise<void>;
+    /**
+     * Seeds or overwrites `dataAndSlot` directly, bypassing RPC. A no-op if the currently cached
+     * slot is already newer than `slot`.
+     * @param data Decoded account data to store.
+     * @param slot Slot the data was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     setData(data: T, slot?: number): void;
+    /**
+     * Arms the inactivity watchdog: if no WS notification resets this timeout within
+     * `resubOpts.resubTimeoutMs`, either starts the polling fallback (`usePollingInsteadOfResub`)
+     * or tears down and recreates the WS subscription. Throws if `onChange` was never set (i.e.
+     * called outside `subscribe()`'s flow).
+     */
     protected setTimeout(): void;
     /**
      * Start the polling loop (single-account).
@@ -103,10 +123,21 @@ export declare class WebSocketAccountSubscriberV2<T> implements AccountSubscribe
      * decoding and update pathway as WS notifications.
      */
     fetch(): Promise<void>;
+    /**
+     * Applies a raw `gill` RPC/WS response: decodes (base58 or base64) and stores it (updating
+     * `bufferAndSlot`/`dataAndSlot` and invoking `onChange`) only if the slot is not older than
+     * the cached one and the buffer's bytes actually changed (or this is the first observation).
+     */
     handleRpcResponse(context: {
         slot: bigint;
     }, accountInfo?: AccountInfoBase & (AccountInfoWithBase58EncodedData | AccountInfoWithBase64EncodedData)): void;
+    /** Decodes a raw account buffer using the constructor-supplied `decodeBufferFn`, or the program's Anchor coder for `accountName` if none was supplied. */
     decodeBuffer(buffer: Buffer): T;
+    /**
+     * Tears down the WebSocket subscription (via `abortController`) and cancels any pending resub
+     * timeout and in-progress polling.
+     * @param onResub Internal flag set to `true` when called as part of an automatic resubscribe cycle, which preserves `resubOpts.resubTimeoutMs` instead of clearing it. Callers should omit this.
+     */
     unsubscribe(onResub?: boolean): Promise<void>;
 }
 //# sourceMappingURL=webSocketAccountSubscriberV2.d.ts.map

package/lib/node/accounts/webSocketAccountSubscriberV2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webSocketAccountSubscriberV2.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketAccountSubscriberV2.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,aAAa,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACN,eAAe,EACf,gCAAgC,EAChC,gCAAgC,EAGhC,GAAG,EACH,gBAAgB,EAChB,yBAAyB,EAEzB,UAAU,EACV,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,4BAA4B,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAC3E,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAKhC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAEvC;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,SAAS,CAAC;IAErB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,UAAS;IAExB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,gBAAgB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAEjD,aAAa,EAAE,OAAO,CAAC;IAGvB,OAAO,CAAC,GAAG,CAA+C;IAC1D,OAAO,CAAC,gBAAgB,CAEF;IACtB,OAAO,CAAC,eAAe,CAAC,CAAkB;IAE1C;;;;;;;;;;;;OAYG;gBAEF,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,SAAS,EAC3B,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS,EACrB,UAAU,CAAC,EAAE,UAAU,EACvB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC,GAAG,MAAM,EACvE,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;YA4DD,sBAAsB;IAsB9B,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0D3D,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrC,SAAS,CAAC,UAAU,IAAI,IAAI;IAuD5B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAuDpB,OAAO,CAAC,WAAW;IAOnB;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuB5B,iBAAiB,CAChB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EACzB,WAAW,CAAC,EAAE,eAAe,GAC5B,CAAC,gCAAgC,GAAG,gCAAgC,CAAC,GACpE,IAAI;IA0DP,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAQ/B,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CA2B3C"}
+{"version":3,"file":"webSocketAccountSubscriberV2.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketAccountSubscriberV2.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,aAAa,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACN,eAAe,EACf,gCAAgC,EAChC,gCAAgC,EAGhC,GAAG,EACH,gBAAgB,EAChB,yBAAyB,EAEzB,UAAU,EACV,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,4BAA4B,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAC3E,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,CAAoB;IACtC,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAKhC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAEvC;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,SAAS,CAAC;IAErB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,UAAS;IAExB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,gBAAgB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAEjD,aAAa,EAAE,OAAO,CAAC;IAGvB,OAAO,CAAC,GAAG,CAA+C;IAC1D,OAAO,CAAC,gBAAgB,CAEF;IACtB,OAAO,CAAC,eAAe,CAAC,CAAkB;IAE1C;;;;;;;;;;;;OAYG;gBAEF,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,SAAS,EAC3B,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS,EACrB,UAAU,CAAC,EAAE,UAAU,EACvB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,yBAAyB,CAAC,GAAG,MAAM,EACvE,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;YA4DD,sBAAsB;IAsBpC;;;;;;;OAOG;IACG,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C3D;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrC;;;;;OAKG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAkD5B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAuDpB,OAAO,CAAC,WAAW;IAOnB;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuB5B;;;;OAIG;IACH,iBAAiB,CAChB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EACzB,WAAW,CAAC,EAAE,eAAe,GAC5B,CAAC,gCAAgC,GAAG,gCAAgC,CAAC,GACpE,IAAI;IA0DP,0JAA0J;IAC1J,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC;IAQ/B;;;;OAIG;IACH,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAsB3C"}

package/lib/node/accounts/webSocketAccountSubscriberV2.js

@@ -138,20 +138,15 @@ class WebSocketAccountSubscriberV2 {
             this.setTimeout();
         }
     }
+    /**
+     * Seeds `dataAndSlot` with an initial `fetch()` (if not already set via `setData`), then opens
+     * the `gill` `accountNotifications` WebSocket subscription and, if `resubOpts.resubTimeoutMs`
+     * is set, arms the inactivity watchdog (`setTimeout`). Idempotent: a no-op if already
+     * subscribed or mid-unsubscribe.
+     * @param onChange Invoked with the newly decoded account data on each accepted update.
+     * @throws Error if `accountPublicKey` is not a valid address per `gill`'s `isAddress`.
+     */
     async subscribe(onChange) {
-        /**
-         * Start the WebSocket subscription and (optionally) setup inactivity
-         * fallback.
-         *
-         * Flow
-         * - If we do not have initial state, perform a one-time `fetch()` to seed
-         *   internal buffers and emit current data.
-         * - Subscribe to account notifications via WS.
-         * - If `resubOpts.resubTimeoutMs` is set, schedule an inactivity timeout.
-         *   When it fires:
-         *   - if `usePollingInsteadOfResub` is true, start polling loop;
-         *   - otherwise, resubscribe to WS immediately.
-         */
         if (this.listenerId != null || this.isUnsubscribing) {
             if (this.resubOpts.logResubMessages) {
                 console.log(`[${this.logAccountName}] Subscribe returning early - listenerId=${this.listenerId}, isUnsubscribing=${this.isUnsubscribing}`);
@@ -188,6 +183,12 @@ class WebSocketAccountSubscriberV2 {
             throw new Error('Invalid account public key');
         }
     }
+    /**
+     * Seeds or overwrites `dataAndSlot` directly, bypassing RPC. A no-op if the currently cached
+     * slot is already newer than `slot`.
+     * @param data Decoded account data to store.
+     * @param slot Slot the data was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     setData(data, slot) {
         const newSlot = slot || 0;
         if (this.dataAndSlot && this.dataAndSlot.slot > newSlot) {
@@ -198,12 +199,13 @@ class WebSocketAccountSubscriberV2 {
             slot: newSlot,
         };
     }
+    /**
+     * Arms the inactivity watchdog: if no WS notification resets this timeout within
+     * `resubOpts.resubTimeoutMs`, either starts the polling fallback (`usePollingInsteadOfResub`)
+     * or tears down and recreates the WS subscription. Throws if `onChange` was never set (i.e.
+     * called outside `subscribe()`'s flow).
+     */
     setTimeout() {
-        /**
-         * Schedule inactivity handling. If WS is quiet for
-         * `resubOpts.resubTimeoutMs` and `receivingData` is true, trigger either
-         * a polling loop or a resubscribe depending on options.
-         */
         if (!this._onChange) {
             throw new Error('onChange callback function must be set');
         }
@@ -317,6 +319,11 @@ class WebSocketAccountSubscriberV2 {
         const accountInfo = rpcResponse.value;
         this.handleRpcResponse({ slot: BigInt(context.slot) }, accountInfo !== null && accountInfo !== void 0 ? accountInfo : undefined);
     }
+    /**
+     * Applies a raw `gill` RPC/WS response: decodes (base58 or base64) and stores it (updating
+     * `bufferAndSlot`/`dataAndSlot` and invoking `onChange`) only if the slot is not older than
+     * the cached one and the buffer's bytes actually changed (or this is the first observation).
+     */
     handleRpcResponse(context, accountInfo) {
         const newSlot = context.slot;
         let newBuffer = undefined;
@@ -370,6 +377,7 @@ class WebSocketAccountSubscriberV2 {
             this.onChange(account);
         }
     }
+    /** Decodes a raw account buffer using the constructor-supplied `decodeBufferFn`, or the program's Anchor coder for `accountName` if none was supplied. */
     decodeBuffer(buffer) {
         if (this.decodeBufferFn) {
             return this.decodeBufferFn(buffer);
@@ -378,12 +386,12 @@ class WebSocketAccountSubscriberV2 {
             return this.program.coder.accounts.decode(this.accountName, buffer);
         }
     }
+    /**
+     * Tears down the WebSocket subscription (via `abortController`) and cancels any pending resub
+     * timeout and in-progress polling.
+     * @param onResub Internal flag set to `true` when called as part of an automatic resubscribe cycle, which preserves `resubOpts.resubTimeoutMs` instead of clearing it. Callers should omit this.
+     */
     unsubscribe(onResub = false) {
-        /**
-         * Stop timers, polling, and WS subscription.
-         * - When called during a resubscribe (`onResub=true`), we preserve
-         *   `resubOpts.resubTimeoutMs` for the restarted subscription.
-         */
         if (!onResub && this.resubOpts) {
             this.resubOpts.resubTimeoutMs = undefined;
         }

package/lib/node/accounts/webSocketInsuranceFundStakeAccountSubscriber.d.ts

@@ -5,6 +5,12 @@ import { EventEmitter } from 'events';
 import { Commitment, PublicKey } from '@solana/web3.js';
 import { InsuranceFundStake } from '../types';
 import { VelocityProgram } from '../config';
+/**
+ * Default `InsuranceFundStakeAccountSubscriber` implementation: wraps a single
+ * `WebSocketAccountSubscriber` for the `InsuranceFundStake` account, mirroring
+ * `WebSocketUserAccountSubscriber`. `insuranceFundStakeDataAccountSubscriber` throws if accessed
+ * before `subscribe()` has run.
+ */
 export declare class WebSocketInsuranceFundStakeAccountSubscriber implements InsuranceFundStakeAccountSubscriber {
     isSubscribed: boolean;
     resubTimeoutMs?: number;
@@ -15,12 +21,33 @@ export declare class WebSocketInsuranceFundStakeAccountSubscriber implements Ins
     private _insuranceFundStakeDataAccountSubscriber?;
     get insuranceFundStakeDataAccountSubscriber(): AccountSubscriber<InsuranceFundStake>;
     set insuranceFundStakeDataAccountSubscriber(subscriber: AccountSubscriber<InsuranceFundStake>);
+    /**
+     * @param program Anchor program providing the connection and coder.
+     * @param insuranceFundStakeAccountPublicKey Address of the `InsuranceFundStake` account to track.
+     * @param resubTimeoutMs Resub watchdog timeout (ms) passed through as `ResubOpts.resubTimeoutMs` to the underlying `WebSocketAccountSubscriber`. Unlike other subscribers here, only this single option is exposed (not the full `ResubOpts` shape).
+     * @param commitment Commitment for the underlying subscription; defaults to the provider's configured commitment.
+     */
     constructor(program: VelocityProgram, insuranceFundStakeAccountPublicKey: PublicKey, resubTimeoutMs?: number, commitment?: Commitment);
+    /**
+     * Creates the underlying `WebSocketAccountSubscriber` and subscribes it. Idempotent: a no-op
+     * (returns `true`) if already subscribed.
+     * @param insuranceFundStakeAccount Optional pre-fetched account data to seed the subscriber with, skipping the initial RPC fetch.
+     */
     subscribe(insuranceFundStakeAccount?: InsuranceFundStake): Promise<boolean>;
+    /** Fetches the account once via the underlying `WebSocketAccountSubscriber`. */
     fetch(): Promise<void>;
+    /** Tears down the underlying WebSocket subscription. A no-op if not subscribed. */
     unsubscribe(): Promise<void>;
+    /** Throws `NotSubscribedError` if `subscribe()` has not been called. */
     assertIsSubscribed(): void;
+    /** Throws `NotSubscribedError` if not subscribed. Returns undefined only if subscribed but no data has loaded yet. */
     getInsuranceFundStakeAccountAndSlot(): DataAndSlot<InsuranceFundStake> | undefined;
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot.
+     * @param insuranceFundStake Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(insuranceFundStake: InsuranceFundStake, slot: number): void;
 }
 //# sourceMappingURL=webSocketInsuranceFundStakeAccountSubscriber.d.ts.map

package/lib/node/accounts/webSocketInsuranceFundStakeAccountSubscriber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webSocketInsuranceFundStakeAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketInsuranceFundStakeAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,WAAW,EACX,iBAAiB,EAEjB,+BAA+B,EAC/B,mCAAmC,EACnC,MAAM,SAAS,CAAC;AACjB,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,qBAAa,4CACZ,YAAW,mCAAmC;IAE9C,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,EAAE,eAAe,CAAC;IACzB,YAAY,EAAE,kBAAkB,CAC/B,YAAY,EACZ,+BAA+B,CAC/B,CAAC;IACF,kCAAkC,EAAE,SAAS,CAAC;IAE9C,OAAO,CAAC,wCAAwC,CAAC,CAAwC;IACzF,IAAI,uCAAuC,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAOnF;IACD,IAAI,uCAAuC,CAC1C,UAAU,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,EAGjD;gBAGA,OAAO,EAAE,eAAe,EACxB,kCAAkC,EAAE,SAAS,EAC7C,cAAc,CAAC,EAAE,MAAM,EACvB,UAAU,CAAC,EAAE,UAAU;IAWlB,SAAS,CACd,yBAAyB,CAAC,EAAE,kBAAkB,GAC5C,OAAO,CAAC,OAAO,CAAC;IAmCb,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAYlC,kBAAkB,IAAI,IAAI;IAQnB,mCAAmC,IACvC,WAAW,CAAC,kBAAkB,CAAC,GAC/B,SAAS;IAKL,UAAU,CAChB,kBAAkB,EAAE,kBAAkB,EACtC,IAAI,EAAE,MAAM,GACV,IAAI;CAeP"}
+{"version":3,"file":"webSocketInsuranceFundStakeAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketInsuranceFundStakeAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,WAAW,EACX,iBAAiB,EAEjB,+BAA+B,EAC/B,mCAAmC,EACnC,MAAM,SAAS,CAAC;AACjB,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C;;;;;GAKG;AACH,qBAAa,4CACZ,YAAW,mCAAmC;IAE9C,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,EAAE,eAAe,CAAC;IACzB,YAAY,EAAE,kBAAkB,CAC/B,YAAY,EACZ,+BAA+B,CAC/B,CAAC;IACF,kCAAkC,EAAE,SAAS,CAAC;IAE9C,OAAO,CAAC,wCAAwC,CAAC,CAAwC;IACzF,IAAI,uCAAuC,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAOnF;IACD,IAAI,uCAAuC,CAC1C,UAAU,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,EAGjD;IAED;;;;;OAKG;gBAEF,OAAO,EAAE,eAAe,EACxB,kCAAkC,EAAE,SAAS,EAC7C,cAAc,CAAC,EAAE,MAAM,EACvB,UAAU,CAAC,EAAE,UAAU;IAWxB;;;;OAIG;IACG,SAAS,CACd,yBAAyB,CAAC,EAAE,kBAAkB,GAC5C,OAAO,CAAC,OAAO,CAAC;IAmCnB,gFAAgF;IAC1E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,mFAAmF;IAC7E,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAYlC,wEAAwE;IACxE,kBAAkB,IAAI,IAAI;IAQ1B,sHAAsH;IAC/G,mCAAmC,IACvC,WAAW,CAAC,kBAAkB,CAAC,GAC/B,SAAS;IAKZ;;;;;OAKG;IACI,UAAU,CAChB,kBAAkB,EAAE,kBAAkB,EACtC,IAAI,EAAE,MAAM,GACV,IAAI;CAeP"}

package/lib/node/accounts/webSocketInsuranceFundStakeAccountSubscriber.js

@@ -4,6 +4,12 @@ exports.WebSocketInsuranceFundStakeAccountSubscriber = void 0;
 const types_1 = require("./types");
 const events_1 = require("events");
 const webSocketAccountSubscriber_1 = require("./webSocketAccountSubscriber");
+/**
+ * Default `InsuranceFundStakeAccountSubscriber` implementation: wraps a single
+ * `WebSocketAccountSubscriber` for the `InsuranceFundStake` account, mirroring
+ * `WebSocketUserAccountSubscriber`. `insuranceFundStakeDataAccountSubscriber` throws if accessed
+ * before `subscribe()` has run.
+ */
 class WebSocketInsuranceFundStakeAccountSubscriber {
     get insuranceFundStakeDataAccountSubscriber() {
         if (!this._insuranceFundStakeDataAccountSubscriber) {
@@ -14,6 +20,12 @@ class WebSocketInsuranceFundStakeAccountSubscriber {
     set insuranceFundStakeDataAccountSubscriber(subscriber) {
         this._insuranceFundStakeDataAccountSubscriber = subscriber;
     }
+    /**
+     * @param program Anchor program providing the connection and coder.
+     * @param insuranceFundStakeAccountPublicKey Address of the `InsuranceFundStake` account to track.
+     * @param resubTimeoutMs Resub watchdog timeout (ms) passed through as `ResubOpts.resubTimeoutMs` to the underlying `WebSocketAccountSubscriber`. Unlike other subscribers here, only this single option is exposed (not the full `ResubOpts` shape).
+     * @param commitment Commitment for the underlying subscription; defaults to the provider's configured commitment.
+     */
     constructor(program, insuranceFundStakeAccountPublicKey, resubTimeoutMs, commitment) {
         this.isSubscribed = false;
         this.program = program;
@@ -23,6 +35,11 @@ class WebSocketInsuranceFundStakeAccountSubscriber {
         this.resubTimeoutMs = resubTimeoutMs;
         this.commitment = commitment;
     }
+    /**
+     * Creates the underlying `WebSocketAccountSubscriber` and subscribes it. Idempotent: a no-op
+     * (returns `true`) if already subscribed.
+     * @param insuranceFundStakeAccount Optional pre-fetched account data to seed the subscriber with, skipping the initial RPC fetch.
+     */
     async subscribe(insuranceFundStakeAccount) {
         if (this.isSubscribed) {
             return true;
@@ -42,9 +59,11 @@ class WebSocketInsuranceFundStakeAccountSubscriber {
         this.isSubscribed = true;
         return true;
     }
+    /** Fetches the account once via the underlying `WebSocketAccountSubscriber`. */
     async fetch() {
         await Promise.all([this.insuranceFundStakeDataAccountSubscriber.fetch()]);
     }
+    /** Tears down the underlying WebSocket subscription. A no-op if not subscribed. */
     async unsubscribe() {
         if (!this.isSubscribed) {
             return;
@@ -54,15 +73,23 @@ class WebSocketInsuranceFundStakeAccountSubscriber {
         ]);
         this.isSubscribed = false;
     }
+    /** Throws `NotSubscribedError` if `subscribe()` has not been called. */
     assertIsSubscribed() {
         if (!this.isSubscribed) {
             throw new types_1.NotSubscribedError('You must call `subscribe` before using this function');
         }
     }
+    /** Throws `NotSubscribedError` if not subscribed. Returns undefined only if subscribed but no data has loaded yet. */
     getInsuranceFundStakeAccountAndSlot() {
         this.assertIsSubscribed();
         return this.insuranceFundStakeDataAccountSubscriber.dataAndSlot;
     }
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot.
+     * @param insuranceFundStake Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(insuranceFundStake, slot) {
         var _a;
         const currentDataSlot = ((_a = this.insuranceFundStakeDataAccountSubscriber.dataAndSlot) === null || _a === void 0 ? void 0 : _a.slot) || 0;

package/lib/node/accounts/webSocketProgramAccountSubscriber.d.ts

@@ -3,6 +3,18 @@
 import { BufferAndSlot, ProgramAccountSubscriber, ResubOpts } from './types';
 import { Commitment, Context, KeyedAccountInfo, MemcmpFilter, PublicKey } from '@solana/web3.js';
 import { VelocityProgram } from '../config';
+/**
+ * Default `ProgramAccountSubscriber` implementation: tracks every account owned by the program
+ * (optionally narrowed by `options.filters`) via `connection.onProgramAccountChange`, decoding
+ * each notification with `decodeBufferFn`. Maintains a per-account (not single, unlike
+ * `WebSocketAccountSubscriber`) `bufferAndSlotMap`, since one program subscription covers many
+ * accounts; updates are applied per-account only when the notification's slot is not older than
+ * that account's last-seen slot and its buffer actually changed. If `resubOpts.resubTimeoutMs`
+ * is set, a watchdog timer resubscribes the whole program subscription whenever no notification
+ * (for *any* account) arrives within that window. This is the base class extended by
+ * `grpcProgramAccountSubscriber` and `LaserstreamProgramAccountSubscriber` for gRPC Geyser-backed
+ * tracking.
+ */
 export declare class WebSocketProgramAccountSubscriber<T> implements ProgramAccountSubscriber<T> {
     subscriptionName: string;
     accountDiscriminator: string;
@@ -22,13 +34,37 @@ export declare class WebSocketProgramAccountSubscriber<T> implements ProgramAcco
         commitment?: Commitment;
     };
     receivingData: boolean;
+    /**
+     * @param subscriptionName Human-readable name for logging.
+     * @param accountDiscriminator Anchor account type name passed to `decodeBufferFn` for each update.
+     * @param program Anchor program whose accounts to watch (filtered to `program.programId` as owner).
+     * @param decodeBufferFn Decode function for each account's raw buffer.
+     * @param options `filters` narrowing which program accounts are watched (empty watches every account owned by the program); `commitment` for the subscription, defaulting to the provider's configured commitment.
+     * @param resubOpts Resubscription watchdog options; omit to disable the inactivity timer.
+     */
     constructor(subscriptionName: string, accountDiscriminator: string, program: VelocityProgram, decodeBufferFn: (accountName: string, ix: Buffer) => T, options?: {
         filters: MemcmpFilter[];
         commitment?: Commitment;
     }, resubOpts?: ResubOpts);
+    /**
+     * Attaches the `onProgramAccountChange` WebSocket listener. Idempotent: a no-op if already
+     * subscribed or mid-unsubscribe. Does not perform an initial fetch of matching accounts — the
+     * caller must fetch any pre-existing accounts separately if needed.
+     * @param onChange Invoked once per changed account with its pubkey, decoded data, the notification's `Context`, and the raw buffer.
+     */
     subscribe(onChange: (accountId: PublicKey, data: T, context: Context, buffer: Buffer) => void): Promise<void>;
     protected setTimeout(): void;
+    /**
+     * Applies a raw notification for one account within the program subscription: decodes and
+     * stores it (updating that account's entry in `bufferAndSlotMap` and invoking `onChange`) only
+     * if the slot is not older than the cached one for that specific account and the buffer's
+     * bytes actually changed (or this is the first observation of that account).
+     */
     handleRpcResponse(context: Context, keyedAccountInfo: KeyedAccountInfo): void;
+    /**
+     * Tears down the `onProgramAccountChange` listener and cancels any pending resub timeout.
+     * @param onResub Internal flag set to `true` when called as part of an automatic resubscribe cycle, which preserves `resubOpts.resubTimeoutMs` instead of clearing it. Callers should omit this.
+     */
     unsubscribe(onResub?: boolean): Promise<void>;
 }
 //# sourceMappingURL=webSocketProgramAccountSubscriber.d.ts.map

package/lib/node/accounts/webSocketProgramAccountSubscriber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webSocketProgramAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketProgramAccountSubscriber.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EACN,UAAU,EACV,OAAO,EACP,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAG5C,qBAAa,iCAAiC,CAAC,CAAC,CAC/C,YAAW,wBAAwB,CAAC,CAAC,CAAC;IAEtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAa;IACzD,OAAO,EAAE,eAAe,CAAC;IACzB,YAAY,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,CAAC,CAAC;IACrD,OAAO,CAAC,SAAS,CAAC,CAKR;IACV,IAAI,QAAQ,IAAI,CACf,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,CAKR;IACD,IAAI,QAAQ,CACX,QAAQ,EAAE,CACT,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,EAGT;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,UAAS;IACxB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,OAAO,EAAE;QAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,UAAU,CAAA;KAAE,CAAC;IAE9D,aAAa,UAAS;gBAGrB,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,eAAe,EACxB,cAAc,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,CAAC,EACtD,OAAO,GAAE;QAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,UAAU,CAAA;KAE1D,EACD,SAAS,CAAC,EAAE,SAAS;IAmBhB,SAAS,CACd,QAAQ,EAAE,CACT,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,GACP,OAAO,CAAC,IAAI,CAAC;IA8BhB,SAAS,CAAC,UAAU,IAAI,IAAI;IA0B5B,iBAAiB,CAChB,OAAO,EAAE,OAAO,EAChB,gBAAgB,EAAE,gBAAgB,GAChC,IAAI;IAqCP,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB3C"}
+{"version":3,"file":"webSocketProgramAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/webSocketProgramAccountSubscriber.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EACN,UAAU,EACV,OAAO,EACP,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAG5C;;;;;;;;;;;GAWG;AACH,qBAAa,iCAAiC,CAAC,CAAC,CAC/C,YAAW,wBAAwB,CAAC,CAAC,CAAC;IAEtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAa;IACzD,OAAO,EAAE,eAAe,CAAC;IACzB,YAAY,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,CAAC,CAAC;IACrD,OAAO,CAAC,SAAS,CAAC,CAKR;IACV,IAAI,QAAQ,IAAI,CACf,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,CAKR;IACD,IAAI,QAAQ,CACX,QAAQ,EAAE,CACT,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,EAGT;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,eAAe,UAAS;IACxB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,OAAO,EAAE;QAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,UAAU,CAAA;KAAE,CAAC;IAE9D,aAAa,UAAS;IAEtB;;;;;;;OAOG;gBAEF,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,eAAe,EACxB,cAAc,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,CAAC,EACtD,OAAO,GAAE;QAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,UAAU,CAAA;KAE1D,EACD,SAAS,CAAC,EAAE,SAAS;IAmBtB;;;;;OAKG;IACG,SAAS,CACd,QAAQ,EAAE,CACT,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,KACV,IAAI,GACP,OAAO,CAAC,IAAI,CAAC;IA8BhB,SAAS,CAAC,UAAU,IAAI,IAAI;IA0B5B;;;;;OAKG;IACH,iBAAiB,CAChB,OAAO,EAAE,OAAO,EAChB,gBAAgB,EAAE,gBAAgB,GAChC,IAAI;IAqCP;;;OAGG;IACH,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB3C"}