@velocity-exchange/sdk 0.2.5 → 0.4.0

package/lib/browser/wallet.d.ts

@@ -1,16 +1,53 @@
 import { Keypair, PublicKey, Transaction, VersionedTransaction } from '@solana/web3.js';
 import { IWallet, IVersionedWallet } from './types';
+/**
+ * Local-keypair implementation of `IWallet`/`IVersionedWallet` that signs directly with an
+ * in-memory `Keypair` (no external wallet/RPC round-trip). Suitable for keeper bots, scripts, and
+ * tests; not for browser dapps holding user funds.
+ */
 export declare class Wallet implements IWallet, IVersionedWallet {
     readonly payer: Keypair;
     constructor(payer: Keypair);
+    /**
+     * Partially signs a legacy `Transaction` with this wallet's keypair, leaving any other
+     * required signatures untouched.
+     * @param tx - Transaction to sign; mutated in place.
+     * @returns The same transaction instance, now signed by `payer`.
+     */
     signTransaction(tx: Transaction): Promise<Transaction>;
+    /**
+     * Signs a `VersionedTransaction` with this wallet's keypair.
+     * @param tx - Transaction to sign; mutated in place.
+     * @returns The same transaction instance, now signed by `payer`.
+     */
     signVersionedTransaction(tx: VersionedTransaction): Promise<VersionedTransaction>;
+    /**
+     * Partially signs a batch of legacy `Transaction`s with this wallet's keypair.
+     * @param txs - Transactions to sign; each is mutated in place.
+     * @returns The same transaction instances, now signed by `payer`.
+     */
     signAllTransactions(txs: Transaction[]): Promise<Transaction[]>;
+    /**
+     * Signs a batch of `VersionedTransaction`s with this wallet's keypair.
+     * @param txs - Transactions to sign; each is mutated in place.
+     * @returns The same transaction instances, now signed by `payer`.
+     */
     signAllVersionedTransactions(txs: VersionedTransaction[]): Promise<VersionedTransaction[]>;
+    /** The wallet's public key, i.e. `payer.publicKey`. */
     get publicKey(): PublicKey;
 }
+/**
+ * `Wallet` variant that additionally supports raw message signing (`signMessage`), needed for
+ * flows like swift/signed-message orders that sign an ed25519 payload outside of a transaction.
+ */
 export declare class WalletV2 extends Wallet {
     readonly payer: Keypair;
     constructor(payer: Keypair);
+    /**
+     * Signs an arbitrary message with this wallet's ed25519 secret key (detached signature, not a
+     * transaction).
+     * @param message - Raw bytes to sign.
+     * @returns The 64-byte detached ed25519 signature.
+     */
     signMessage(message: Uint8Array): Promise<Uint8Array>;
 }

package/lib/browser/wallet.js

@@ -5,40 +5,77 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletV2 = exports.Wallet = void 0;
 const tweetnacl_1 = __importDefault(require("tweetnacl"));
+/**
+ * Local-keypair implementation of `IWallet`/`IVersionedWallet` that signs directly with an
+ * in-memory `Keypair` (no external wallet/RPC round-trip). Suitable for keeper bots, scripts, and
+ * tests; not for browser dapps holding user funds.
+ */
 class Wallet {
     constructor(payer) {
         this.payer = payer;
     }
+    /**
+     * Partially signs a legacy `Transaction` with this wallet's keypair, leaving any other
+     * required signatures untouched.
+     * @param tx - Transaction to sign; mutated in place.
+     * @returns The same transaction instance, now signed by `payer`.
+     */
     async signTransaction(tx) {
         tx.partialSign(this.payer);
         return tx;
     }
+    /**
+     * Signs a `VersionedTransaction` with this wallet's keypair.
+     * @param tx - Transaction to sign; mutated in place.
+     * @returns The same transaction instance, now signed by `payer`.
+     */
     async signVersionedTransaction(tx) {
         tx.sign([this.payer]);
         return tx;
     }
+    /**
+     * Partially signs a batch of legacy `Transaction`s with this wallet's keypair.
+     * @param txs - Transactions to sign; each is mutated in place.
+     * @returns The same transaction instances, now signed by `payer`.
+     */
     async signAllTransactions(txs) {
         return txs.map((t) => {
             t.partialSign(this.payer);
             return t;
         });
     }
+    /**
+     * Signs a batch of `VersionedTransaction`s with this wallet's keypair.
+     * @param txs - Transactions to sign; each is mutated in place.
+     * @returns The same transaction instances, now signed by `payer`.
+     */
     async signAllVersionedTransactions(txs) {
         return txs.map((t) => {
             t.sign([this.payer]);
             return t;
         });
     }
+    /** The wallet's public key, i.e. `payer.publicKey`. */
     get publicKey() {
         return this.payer.publicKey;
     }
 }
 exports.Wallet = Wallet;
+/**
+ * `Wallet` variant that additionally supports raw message signing (`signMessage`), needed for
+ * flows like swift/signed-message orders that sign an ed25519 payload outside of a transaction.
+ */
 class WalletV2 extends Wallet {
     constructor(payer) {
         super(payer);
         this.payer = payer;
     }
+    /**
+     * Signs an arbitrary message with this wallet's ed25519 secret key (detached signature, not a
+     * transaction).
+     * @param message - Raw bytes to sign.
+     * @returns The 64-byte detached ed25519 signature.
+     */
     async signMessage(message) {
         return Buffer.from(tweetnacl_1.default.sign.detached(message, this.payer.secretKey));
     }

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

@@ -15,16 +15,34 @@ export declare class BasicUserAccountSubscriber implements UserAccountSubscriber
     callbackId?: string;
     errorCallbackId?: string;
     user?: DataAndSlot<UserAccount>;
+    /**
+     * @param userAccountPublicKey Address of the `UserAccount` this subscriber represents (not fetched — used only for identity).
+     * @param data Optional decoded account data to seed with; if omitted, `getUserAccountAndSlot()` returns undefined until `updateData` is called.
+     * @param slot Slot `data` was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     constructor(userAccountPublicKey: PublicKey, data?: UserAccount, slot?: number);
+    /** No-op; this subscriber never performs network I/O. Always resolves `true` since `isSubscribed` is already `true` from construction. */
     subscribe(_userAccount?: UserAccount): Promise<boolean>;
     addToAccountLoader(): Promise<void>;
+    /** No-op; this subscriber never fetches. Data only changes via `updateData`. */
     fetch(): Promise<void>;
+    /** Type predicate: true once `user` has been seeded or set via `updateData`, narrowing `this.user` to non-undefined. */
     doesAccountExist(): this is {
         user: DataAndSlot<UserAccount>;
     };
+    /** No-op; there is no live subscription to tear down. */
     unsubscribe(): Promise<void>;
+    /** No-op; this subscriber is always considered subscribed and never throws `NotSubscribedError`. */
     assertIsSubscribed(): void;
+    /** Returns the currently cached data/slot, or undefined if never seeded/updated. Never throws (unlike other implementations, this subscriber has no "not subscribed" state). */
     getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined;
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot, emitting `userAccountUpdate`/`update` on acceptance. This is the only way this
+     * subscriber's data changes after construction.
+     * @param userAccount Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(userAccount: UserAccount, slot: number): void;
 }
 //# sourceMappingURL=basicUserAccountSubscriber.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"basicUserAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/basicUserAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;GAGG;AACH,qBAAa,0BAA2B,YAAW,qBAAqB;IACvE,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAClE,oBAAoB,EAAE,SAAS,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;gBAG/B,oBAAoB,EAAE,SAAS,EAC/B,IAAI,CAAC,EAAE,WAAW,EAClB,IAAI,CAAC,EAAE,MAAM;IAUR,SAAS,CAAC,YAAY,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEnC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAE5B,gBAAgB,IAAI,IAAI,IAAI;QAAE,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;KAAE;IAIxD,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC,kBAAkB,IAAI,IAAI;IAEnB,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC,GAAG,SAAS;IAI7D,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAO/D"}
+{"version":3,"file":"basicUserAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/basicUserAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;GAGG;AACH,qBAAa,0BAA2B,YAAW,qBAAqB;IACvE,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IAClE,oBAAoB,EAAE,SAAS,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAEhC;;;;OAIG;gBAEF,oBAAoB,EAAE,SAAS,EAC/B,IAAI,CAAC,EAAE,WAAW,EAClB,IAAI,CAAC,EAAE,MAAM;IAUd,0IAA0I;IACpI,SAAS,CAAC,YAAY,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzC,gFAAgF;IAC1E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAE5B,wHAAwH;IACxH,gBAAgB,IAAI,IAAI,IAAI;QAAE,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;KAAE;IAI9D,yDAAyD;IACnD,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC,oGAAoG;IACpG,kBAAkB,IAAI,IAAI;IAE1B,gLAAgL;IACzK,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC,GAAG,SAAS;IAIpE;;;;;;OAMG;IACI,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAO/D"}

package/lib/node/accounts/basicUserAccountSubscriber.js

@@ -7,6 +7,11 @@ const events_1 = require("events");
  * data during initialization and will not fetch or subscribe to updates.
  */
 class BasicUserAccountSubscriber {
+    /**
+     * @param userAccountPublicKey Address of the `UserAccount` this subscriber represents (not fetched — used only for identity).
+     * @param data Optional decoded account data to seed with; if omitted, `getUserAccountAndSlot()` returns undefined until `updateData` is called.
+     * @param slot Slot `data` was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     constructor(userAccountPublicKey, data, slot) {
         this.isSubscribed = true;
         this.eventEmitter = new events_1.EventEmitter();
@@ -15,19 +20,32 @@ class BasicUserAccountSubscriber {
         // slot (0 = oldest-possible sentinel, overwritten by the first real fetch).
         this.user = data ? { data, slot: slot !== null && slot !== void 0 ? slot : 0 } : undefined;
     }
+    /** No-op; this subscriber never performs network I/O. Always resolves `true` since `isSubscribed` is already `true` from construction. */
     async subscribe(_userAccount) {
         return true;
     }
     async addToAccountLoader() { }
+    /** No-op; this subscriber never fetches. Data only changes via `updateData`. */
     async fetch() { }
+    /** Type predicate: true once `user` has been seeded or set via `updateData`, narrowing `this.user` to non-undefined. */
     doesAccountExist() {
         return this.user !== undefined;
     }
+    /** No-op; there is no live subscription to tear down. */
     async unsubscribe() { }
+    /** No-op; this subscriber is always considered subscribed and never throws `NotSubscribedError`. */
     assertIsSubscribed() { }
+    /** Returns the currently cached data/slot, or undefined if never seeded/updated. Never throws (unlike other implementations, this subscriber has no "not subscribed" state). */
     getUserAccountAndSlot() {
         return this.user;
     }
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot, emitting `userAccountUpdate`/`update` on acceptance. This is the only way this
+     * subscriber's data changes after construction.
+     * @param userAccount Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(userAccount, slot) {
         if (!this.user || slot >= this.user.slot) {
             this.user = { data: userAccount, slot };

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

@@ -15,16 +15,34 @@ export declare class BasicUserStatsAccountSubscriber implements UserStatsAccount
     callbackId?: string;
     errorCallbackId?: string;
     userStats?: DataAndSlot<UserStatsAccount>;
+    /**
+     * @param userStatsAccountPublicKey Address of the `UserStatsAccount` this subscriber represents (not fetched — used only for identity).
+     * @param data Optional decoded account data to seed with; if omitted, `getUserStatsAccountAndSlot()` returns undefined until `updateData` is called.
+     * @param slot Slot `data` was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     constructor(userStatsAccountPublicKey: PublicKey, data?: UserStatsAccount, slot?: number);
+    /** No-op; this subscriber never performs network I/O. Always resolves `true` since `isSubscribed` is already `true` from construction. */
     subscribe(_userStatsAccount?: UserStatsAccount): Promise<boolean>;
     addToAccountLoader(): Promise<void>;
+    /** No-op; this subscriber never fetches. Data only changes via `updateData`. */
     fetch(): Promise<void>;
+    /** Type predicate: true once `userStats` has been seeded or set via `updateData`, narrowing `this.userStats` to non-undefined. */
     doesAccountExist(): this is {
         userStats: DataAndSlot<UserStatsAccount>;
     };
+    /** No-op; there is no live subscription to tear down. */
     unsubscribe(): Promise<void>;
+    /** No-op; this subscriber is always considered subscribed and never throws `NotSubscribedError`. */
     assertIsSubscribed(): void;
+    /** Returns the currently cached data/slot, or undefined if never seeded/updated. Never throws (unlike other implementations, this subscriber has no "not subscribed" state). */
     getUserStatsAccountAndSlot(): DataAndSlot<UserStatsAccount> | undefined;
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot, emitting `userStatsAccountUpdate`/`update` on acceptance. This is the only way
+     * this subscriber's data changes after construction.
+     * @param userStatsAccount Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(userStatsAccount: UserStatsAccount, slot: number): void;
 }
 //# sourceMappingURL=basicUserStatsAccountSubscriber.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"basicUserStatsAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/basicUserStatsAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,WAAW,EACX,sBAAsB,EACtB,0BAA0B,EAC1B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;GAGG;AACH,qBAAa,+BACZ,YAAW,0BAA0B;IAErC,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;IACvE,yBAAyB,EAAE,SAAS,CAAC;IAErC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;gBAGzC,yBAAyB,EAAE,SAAS,EACpC,IAAI,CAAC,EAAE,gBAAgB,EACvB,IAAI,CAAC,EAAE,MAAM;IAUR,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjE,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEnC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAE5B,gBAAgB,IAAI,IAAI,IAAI;QAAE,SAAS,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAA;KAAE;IAIlE,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC,kBAAkB,IAAI,IAAI;IAEnB,0BAA0B,IAC9B,WAAW,CAAC,gBAAgB,CAAC,GAC7B,SAAS;IAIL,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAOzE"}
+{"version":3,"file":"basicUserStatsAccountSubscriber.d.ts","sourceRoot":"","sources":["../../../src/accounts/basicUserStatsAccountSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EACN,WAAW,EACX,sBAAsB,EACtB,0BAA0B,EAC1B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;GAGG;AACH,qBAAa,+BACZ,YAAW,0BAA0B;IAErC,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;IACvE,yBAAyB,EAAE,SAAS,CAAC;IAErC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAE1C;;;;OAIG;gBAEF,yBAAyB,EAAE,SAAS,EACpC,IAAI,CAAC,EAAE,gBAAgB,EACvB,IAAI,CAAC,EAAE,MAAM;IAUd,0IAA0I;IACpI,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjE,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzC,gFAAgF;IAC1E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAE5B,kIAAkI;IAClI,gBAAgB,IAAI,IAAI,IAAI;QAAE,SAAS,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAA;KAAE;IAIxE,yDAAyD;IACnD,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAElC,oGAAoG;IACpG,kBAAkB,IAAI,IAAI;IAE1B,gLAAgL;IACzK,0BAA0B,IAC9B,WAAW,CAAC,gBAAgB,CAAC,GAC7B,SAAS;IAIZ;;;;;;OAMG;IACI,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAOzE"}

package/lib/node/accounts/basicUserStatsAccountSubscriber.js

@@ -7,6 +7,11 @@ const events_1 = require("events");
  * data during initialization and will not fetch or subscribe to updates.
  */
 class BasicUserStatsAccountSubscriber {
+    /**
+     * @param userStatsAccountPublicKey Address of the `UserStatsAccount` this subscriber represents (not fetched — used only for identity).
+     * @param data Optional decoded account data to seed with; if omitted, `getUserStatsAccountAndSlot()` returns undefined until `updateData` is called.
+     * @param slot Slot `data` was observed at; defaults to 0 (the seeded sentinel) if omitted.
+     */
     constructor(userStatsAccountPublicKey, data, slot) {
         this.isSubscribed = true;
         this.eventEmitter = new events_1.EventEmitter();
@@ -15,19 +20,32 @@ class BasicUserStatsAccountSubscriber {
         // slot (0 = oldest-possible sentinel, overwritten by the first real fetch).
         this.userStats = data ? { data, slot: slot !== null && slot !== void 0 ? slot : 0 } : undefined;
     }
+    /** No-op; this subscriber never performs network I/O. Always resolves `true` since `isSubscribed` is already `true` from construction. */
     async subscribe(_userStatsAccount) {
         return true;
     }
     async addToAccountLoader() { }
+    /** No-op; this subscriber never fetches. Data only changes via `updateData`. */
     async fetch() { }
+    /** Type predicate: true once `userStats` has been seeded or set via `updateData`, narrowing `this.userStats` to non-undefined. */
     doesAccountExist() {
         return this.userStats !== undefined;
     }
+    /** No-op; there is no live subscription to tear down. */
     async unsubscribe() { }
+    /** No-op; this subscriber is always considered subscribed and never throws `NotSubscribedError`. */
     assertIsSubscribed() { }
+    /** Returns the currently cached data/slot, or undefined if never seeded/updated. Never throws (unlike other implementations, this subscriber has no "not subscribed" state). */
     getUserStatsAccountAndSlot() {
         return this.userStats;
     }
+    /**
+     * Applies an externally-obtained account update if `slot` is not older than the currently
+     * cached slot, emitting `userStatsAccountUpdate`/`update` on acceptance. This is the only way
+     * this subscriber's data changes after construction.
+     * @param userStatsAccount Decoded account data to apply.
+     * @param slot Slot the data was observed at.
+     */
     updateData(userStatsAccount, slot) {
         if (!this.userStats || slot >= this.userStats.slot) {
             this.userStats = { data: userStatsAccount, slot };

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

@@ -3,10 +3,22 @@
 import { Commitment, PublicKey } from '@solana/web3.js';
 import { BufferAndSlot } from './types';
 import { Connection } from '../bankrun/bankrunConnection';
+/** An account registered with a `BulkAccountLoader`, along with every callback subscribed to its updates (keyed by callback id). */
 export type AccountToLoad = {
     publicKey: PublicKey;
     callbacks: Map<string, (buffer: Buffer, slot: number) => void>;
 };
+/**
+ * Batches many accounts behind a single periodic `getMultipleAccounts` RPC poll instead of one
+ * WebSocket subscription per account. Multiple independent callbacks (e.g. from different
+ * `PollingUserAccountSubscriber`/`PollingVelocityClientAccountSubscriber` instances) can register
+ * against the same `publicKey`; polling starts automatically on the first `addAccount` and stops
+ * when the last callback for the last account is removed. A buffer is only re-delivered to
+ * callbacks when its slot is not older than the last-seen slot for that account and its bytes
+ * actually changed, so a callback never observes a stale or duplicate update. `load()` calls are
+ * coalesced: concurrent callers share one in-flight RPC batch rather than issuing redundant
+ * requests.
+ */
 export declare class BulkAccountLoader {
     connection: Connection;
     commitment: Commitment;
@@ -19,20 +31,60 @@ export declare class BulkAccountLoader {
     private loadPromiseResolver;
     lastTimeLoadingPromiseCleared: number;
     mostRecentSlot: number;
+    /**
+     * @param connection Connection (or bankrun-compatible shim) used for the batched `getMultipleAccounts` polls.
+     * @param commitment Commitment level applied to every poll.
+     * @param pollingFrequency Poll interval in ms; `0` disables automatic polling (`startPolling` becomes a no-op), useful when the loader is driven manually via `load()`.
+     */
     constructor(connection: Connection, commitment: Commitment, pollingFrequency: number);
+    /**
+     * Registers a callback to be invoked whenever `publicKey`'s account data changes on a poll.
+     * Multiple callbacks may be registered for the same account. Starts polling automatically if
+     * this is the loader's first account. Awaits any in-flight `load()` before returning so a
+     * caller can immediately follow with its own `load()` without racing the poll interval.
+     * @param publicKey Account to track.
+     * @param callback Invoked with the raw account buffer and the slot it was fetched at whenever the buffer changes at a non-decreasing slot.
+     * @returns A callback id to pass to `removeAccount` later.
+     */
     addAccount(publicKey: PublicKey, callback: (buffer: Buffer, slot: number) => void): Promise<string>;
+    /**
+     * Unregisters a callback previously returned by `addAccount`. Once an account has no
+     * remaining callbacks, its cached buffer/slot is dropped and it stops being polled; if no
+     * accounts remain at all, polling stops entirely. A no-op if `callbackId` is undefined.
+     * @param publicKey Account the callback was registered against.
+     * @param callbackId Id returned by `addAccount`.
+     */
     removeAccount(publicKey: PublicKey, callbackId: string | undefined): void;
+    /**
+     * Registers a callback invoked whenever a `load()` batch throws (e.g. RPC failure or timeout).
+     * The loader continues polling afterward; errors do not stop the interval.
+     * @returns A callback id to pass to `removeErrorCallbacks` later.
+     */
     addErrorCallbacks(callback: (error: Error) => void): string;
+    /** Unregisters an error callback previously returned by `addErrorCallbacks`. A no-op if `callbackId` is undefined. */
     removeErrorCallbacks(callbackId: string | undefined): void;
     chunks<T>(array: readonly T[], size: number): T[][];
+    /**
+     * Fetches every registered account in one or more chunked, concurrent `getMultipleAccounts`
+     * batches (via `loadChunk`) and dispatches changed accounts to their callbacks. Concurrent
+     * calls while a load is already in flight share that same in-flight promise rather than
+     * issuing a duplicate RPC batch, unless the previous load has been running for over a minute
+     * (treated as stuck and restarted). On failure, invokes every registered error callback
+     * instead of throwing.
+     */
     load(): Promise<void>;
     loadChunk(accountsToLoadChunks: AccountToLoad[][]): Promise<void>;
     handleAccountCallbacks(accountToLoad: AccountToLoad, buffer: Buffer | undefined, slot: number): void;
+    /** Returns the last-fetched raw buffer/slot for `publicKey`, or undefined if it has never been loaded. */
     getBufferAndSlot(publicKey: PublicKey): BufferAndSlot | undefined;
+    /** Returns the highest slot number observed across any account fetched by this loader so far. */
     getSlot(): number;
+    /** Starts the polling interval if not already running and `pollingFrequency !== 0`. Called automatically by `addAccount`. */
     startPolling(): void;
+    /** Stops the polling interval, if running. Called automatically by `removeAccount` once no accounts remain. */
     stopPolling(): void;
     log(msg: string): void;
+    /** Restarts polling at a new interval (ms), preserving all registered accounts and callbacks. */
     updatePollingFrequency(pollingFrequency: number): void;
 }
 //# sourceMappingURL=bulkAccountLoader.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"bulkAccountLoader.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkAccountLoader.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAG1D,MAAM,MAAM,aAAa,GAAG;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;CAC/D,CAAC;AAIF,qBAAa,iBAAiB;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,6BAAoC;IAClD,gBAAgB,6BAAoC;IACpD,cAAc,kBAAuB,KAAK,KAAK,IAAI,EAAI;IACvD,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAE3C,WAAW,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,CAAC,mBAAmB,CAAwB;IACnD,6BAA6B,SAAc;IAC3C,cAAc,SAAK;gBAGlB,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,MAAM;IAOZ,UAAU,CACtB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAC9C,OAAO,CAAC,MAAM,CAAC;IAkCX,aAAa,CACnB,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,GAAG,SAAS,GAC5B,IAAI;IAkBA,iBAAiB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM;IAM3D,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAOjE,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE;IAOtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA0C5B,SAAS,CAAC,oBAAoB,EAAE,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsFvE,sBAAsB,CACrB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,IAAI,EAAE,MAAM,GACV,IAAI;IAmBA,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS;IAIjE,OAAO,IAAI,MAAM;IAIjB,YAAY,IAAI,IAAI;IAYpB,WAAW,IAAI,IAAI;IAOnB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAItB,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;CAO7D"}
+{"version":3,"file":"bulkAccountLoader.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkAccountLoader.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAG1D,oIAAoI;AACpI,MAAM,MAAM,aAAa,GAAG;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;CAC/D,CAAC;AAIF;;;;;;;;;;GAUG;AACH,qBAAa,iBAAiB;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,6BAAoC;IAClD,gBAAgB,6BAAoC;IACpD,cAAc,kBAAuB,KAAK,KAAK,IAAI,EAAI;IACvD,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAE3C,WAAW,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,CAAC,mBAAmB,CAAwB;IACnD,6BAA6B,SAAc;IAC3C,cAAc,SAAK;IAEnB;;;;OAIG;gBAEF,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,MAAM;IAOzB;;;;;;;;OAQG;IACU,UAAU,CACtB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAC9C,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;OAMG;IACI,aAAa,CACnB,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,GAAG,SAAS,GAC5B,IAAI;IAkBP;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM;IAMlE,sHAAsH;IAC/G,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAOjE,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE;IAOnD;;;;;;;OAOG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA0C5B,SAAS,CAAC,oBAAoB,EAAE,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsFvE,sBAAsB,CACrB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,IAAI,EAAE,MAAM,GACV,IAAI;IAmBP,0GAA0G;IACnG,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS;IAIxE,iGAAiG;IAC1F,OAAO,IAAI,MAAM;IAIxB,6HAA6H;IACtH,YAAY,IAAI,IAAI;IAY3B,+GAA+G;IACxG,WAAW,IAAI,IAAI;IAOnB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI7B,iGAAiG;IAC1F,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;CAO7D"}

package/lib/node/accounts/bulkAccountLoader.js

@@ -5,7 +5,23 @@ const uuid_1 = require("uuid");
 const promiseTimeout_1 = require("../util/promiseTimeout");
 const numericConstants_1 = require("../constants/numericConstants");
 const oneMinute = 60 * 1000;
+/**
+ * Batches many accounts behind a single periodic `getMultipleAccounts` RPC poll instead of one
+ * WebSocket subscription per account. Multiple independent callbacks (e.g. from different
+ * `PollingUserAccountSubscriber`/`PollingVelocityClientAccountSubscriber` instances) can register
+ * against the same `publicKey`; polling starts automatically on the first `addAccount` and stops
+ * when the last callback for the last account is removed. A buffer is only re-delivered to
+ * callbacks when its slot is not older than the last-seen slot for that account and its bytes
+ * actually changed, so a callback never observes a stale or duplicate update. `load()` calls are
+ * coalesced: concurrent callers share one in-flight RPC batch rather than issuing redundant
+ * requests.
+ */
 class BulkAccountLoader {
+    /**
+     * @param connection Connection (or bankrun-compatible shim) used for the batched `getMultipleAccounts` polls.
+     * @param commitment Commitment level applied to every poll.
+     * @param pollingFrequency Poll interval in ms; `0` disables automatic polling (`startPolling` becomes a no-op), useful when the loader is driven manually via `load()`.
+     */
     constructor(connection, commitment, pollingFrequency) {
         this.accountsToLoad = new Map();
         this.bufferAndSlotMap = new Map();
@@ -17,6 +33,15 @@ class BulkAccountLoader {
         this.commitment = commitment;
         this.pollingFrequency = pollingFrequency;
     }
+    /**
+     * Registers a callback to be invoked whenever `publicKey`'s account data changes on a poll.
+     * Multiple callbacks may be registered for the same account. Starts polling automatically if
+     * this is the loader's first account. Awaits any in-flight `load()` before returning so a
+     * caller can immediately follow with its own `load()` without racing the poll interval.
+     * @param publicKey Account to track.
+     * @param callback Invoked with the raw account buffer and the slot it was fetched at whenever the buffer changes at a non-decreasing slot.
+     * @returns A callback id to pass to `removeAccount` later.
+     */
     async addAccount(publicKey, callback) {
         if (!publicKey) {
             console.trace(`Caught adding blank publickey to bulkAccountLoader`);
@@ -43,6 +68,13 @@ class BulkAccountLoader {
         await this.loadPromise;
         return callbackId;
     }
+    /**
+     * Unregisters a callback previously returned by `addAccount`. Once an account has no
+     * remaining callbacks, its cached buffer/slot is dropped and it stops being polled; if no
+     * accounts remain at all, polling stops entirely. A no-op if `callbackId` is undefined.
+     * @param publicKey Account the callback was registered against.
+     * @param callbackId Id returned by `addAccount`.
+     */
     removeAccount(publicKey, callbackId) {
         if (callbackId === undefined) {
             return;
@@ -59,11 +91,17 @@ class BulkAccountLoader {
             this.stopPolling();
         }
     }
+    /**
+     * Registers a callback invoked whenever a `load()` batch throws (e.g. RPC failure or timeout).
+     * The loader continues polling afterward; errors do not stop the interval.
+     * @returns A callback id to pass to `removeErrorCallbacks` later.
+     */
     addErrorCallbacks(callback) {
         const callbackId = (0, uuid_1.v4)();
         this.errorCallbacks.set(callbackId, callback);
         return callbackId;
     }
+    /** Unregisters an error callback previously returned by `addErrorCallbacks`. A no-op if `callbackId` is undefined. */
     removeErrorCallbacks(callbackId) {
         if (callbackId === undefined) {
             return;
@@ -76,6 +114,14 @@ class BulkAccountLoader {
             .map((_, index) => index * size)
             .map((begin) => array.slice(begin, begin + size));
     }
+    /**
+     * Fetches every registered account in one or more chunked, concurrent `getMultipleAccounts`
+     * batches (via `loadChunk`) and dispatches changed accounts to their callbacks. Concurrent
+     * calls while a load is already in flight share that same in-flight promise rather than
+     * issuing a duplicate RPC batch, unless the previous load has been running for over a minute
+     * (treated as stuck and restarted). On failure, invokes every registered error callback
+     * instead of throwing.
+     */
     async load() {
         if (this.loadPromise) {
             const now = Date.now();
@@ -200,12 +246,15 @@ class BulkAccountLoader {
             }
         }
     }
+    /** Returns the last-fetched raw buffer/slot for `publicKey`, or undefined if it has never been loaded. */
     getBufferAndSlot(publicKey) {
         return this.bufferAndSlotMap.get(publicKey.toString());
     }
+    /** Returns the highest slot number observed across any account fetched by this loader so far. */
     getSlot() {
         return this.mostRecentSlot;
     }
+    /** Starts the polling interval if not already running and `pollingFrequency !== 0`. Called automatically by `addAccount`. */
     startPolling() {
         if (this.intervalId) {
             return;
@@ -213,6 +262,7 @@ class BulkAccountLoader {
         if (this.pollingFrequency !== 0)
             this.intervalId = setInterval(this.load.bind(this), this.pollingFrequency);
     }
+    /** Stops the polling interval, if running. Called automatically by `removeAccount` once no accounts remain. */
     stopPolling() {
         if (this.intervalId) {
             clearInterval(this.intervalId);
@@ -222,6 +272,7 @@ class BulkAccountLoader {
     log(msg) {
         console.log(msg);
     }
+    /** Restarts polling at a new interval (ms), preserving all registered accounts and callbacks. */
     updatePollingFrequency(pollingFrequency) {
         this.stopPolling();
         this.pollingFrequency = pollingFrequency;

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

@@ -1,8 +1,15 @@
 import { UserStats } from '../userStats';
 import { BulkAccountLoader } from './bulkAccountLoader';
 /**
- * @param userStats
- * @param accountLoader
+ * Subscribes many `UserStats`s that share a single `BulkAccountLoader` in one batched round trip,
+ * instead of each `UserStats.subscribe()` triggering its own `addAccount`/`load()`. Registers
+ * every account's `PollingUserStatsAccountSubscriber` with the loader first, issues one `load()`
+ * to seed all of them from a single batched `getMultipleAccounts` call, and only then calls
+ * `userStat.subscribe()` (which becomes a fast no-op fetch since data is already cached). If
+ * `userStats` is empty, still calls `accountLoader.load()` so any other accounts already
+ * registered on the loader get polled.
+ * @param userStats `UserStats` instances to subscribe; each must already be constructed with a `PollingUserStatsAccountSubscriber`.
+ * @param accountLoader Shared `BulkAccountLoader` batching the underlying RPC polls.
  */
 export declare function bulkPollingUserStatsSubscribe(userStats: UserStats[], accountLoader: BulkAccountLoader): Promise<void>;
 //# sourceMappingURL=bulkUserStatsSubscription.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"bulkUserStatsSubscription.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkUserStatsSubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;GAGG;AACH,wBAAsB,6BAA6B,CAClD,SAAS,EAAE,SAAS,EAAE,EACtB,aAAa,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAqBf"}
+{"version":3,"file":"bulkUserStatsSubscription.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkUserStatsSubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;;;;;;;;GAUG;AACH,wBAAsB,6BAA6B,CAClD,SAAS,EAAE,SAAS,EAAE,EACtB,aAAa,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAqBf"}

package/lib/node/accounts/bulkUserStatsSubscription.js

@@ -2,8 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bulkPollingUserStatsSubscribe = void 0;
 /**
- * @param userStats
- * @param accountLoader
+ * Subscribes many `UserStats`s that share a single `BulkAccountLoader` in one batched round trip,
+ * instead of each `UserStats.subscribe()` triggering its own `addAccount`/`load()`. Registers
+ * every account's `PollingUserStatsAccountSubscriber` with the loader first, issues one `load()`
+ * to seed all of them from a single batched `getMultipleAccounts` call, and only then calls
+ * `userStat.subscribe()` (which becomes a fast no-op fetch since data is already cached). If
+ * `userStats` is empty, still calls `accountLoader.load()` so any other accounts already
+ * registered on the loader get polled.
+ * @param userStats `UserStats` instances to subscribe; each must already be constructed with a `PollingUserStatsAccountSubscriber`.
+ * @param accountLoader Shared `BulkAccountLoader` batching the underlying RPC polls.
  */
 async function bulkPollingUserStatsSubscribe(userStats, accountLoader) {
     if (userStats.length === 0) {

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

@@ -1,8 +1,14 @@
 import { User } from '../user';
 import { BulkAccountLoader } from './bulkAccountLoader';
 /**
- * @param users
- * @param accountLoader
+ * Subscribes many `User`s that share a single `BulkAccountLoader` in one batched round trip,
+ * instead of each `User.subscribe()` triggering its own `addAccount`/`load()`. Registers every
+ * user's `PollingUserAccountSubscriber` with the loader first, issues one `load()` to seed all of
+ * them from a single batched `getMultipleAccounts` call, and only then calls `user.subscribe()`
+ * (which becomes a fast no-op fetch since data is already cached). If `users` is empty, still
+ * calls `accountLoader.load()` so any other accounts already registered on the loader get polled.
+ * @param users Users to subscribe; each must already be constructed with a `PollingUserAccountSubscriber`.
+ * @param accountLoader Shared `BulkAccountLoader` batching the underlying RPC polls.
  */
 export declare function bulkPollingUserSubscribe(users: User[], accountLoader: BulkAccountLoader): Promise<void>;
 //# sourceMappingURL=bulkUserSubscription.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"bulkUserSubscription.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkUserSubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;GAGG;AACH,wBAAsB,wBAAwB,CAC7C,KAAK,EAAE,IAAI,EAAE,EACb,aAAa,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAqBf"}
+{"version":3,"file":"bulkUserSubscription.d.ts","sourceRoot":"","sources":["../../../src/accounts/bulkUserSubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAC7C,KAAK,EAAE,IAAI,EAAE,EACb,aAAa,EAAE,iBAAiB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAqBf"}

package/lib/node/accounts/bulkUserSubscription.js

@@ -2,8 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bulkPollingUserSubscribe = void 0;
 /**
- * @param users
- * @param accountLoader
+ * Subscribes many `User`s that share a single `BulkAccountLoader` in one batched round trip,
+ * instead of each `User.subscribe()` triggering its own `addAccount`/`load()`. Registers every
+ * user's `PollingUserAccountSubscriber` with the loader first, issues one `load()` to seed all of
+ * them from a single batched `getMultipleAccounts` call, and only then calls `user.subscribe()`
+ * (which becomes a fast no-op fetch since data is already cached). If `users` is empty, still
+ * calls `accountLoader.load()` so any other accounts already registered on the loader get polled.
+ * @param users Users to subscribe; each must already be constructed with a `PollingUserAccountSubscriber`.
+ * @param accountLoader Shared `BulkAccountLoader` batching the underlying RPC polls.
  */
 async function bulkPollingUserSubscribe(users, accountLoader) {
     if (users.length === 0) {