@velocity-exchange/sdk 0.3.0 → 0.4.0

package/lib/node/priorityFee/solanaPriorityFeeMethod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"solanaPriorityFeeMethod.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/solanaPriorityFeeMethod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,wBAAsB,sBAAsB,CAC3C,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAAC,CAsBlD"}
+{"version":3,"file":"solanaPriorityFeeMethod.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/solanaPriorityFeeMethod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,8DAA8D;AAC9D,MAAM,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,iBAAiB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC3C,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,yBAAyB,EAAE,GAAG,SAAS,CAAC,CAsBlD"}

package/lib/node/priorityFee/solanaPriorityFeeMethod.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchSolanaPriorityFee = void 0;
+/**
+ * Fetches recent prioritization fees for `addresses` via the Solana RPC
+ * `getRecentPrioritizationFees` method, then filters to the most recent
+ * `lookbackDistance` slots (relative to the newest returned slot, not the
+ * current chain tip) and sorts descending by slot.
+ * @param connection RPC connection.
+ * @param lookbackDistance Number of slots back from the newest sample to retain.
+ * @param addresses Account keys to scope the fee lookup to (accounts the transaction will write-lock).
+ * @returns Filtered, slot-descending samples; `undefined` if the RPC returned zero results; an empty array if the RPC call itself threw (error is logged, not thrown).
+ */
 async function fetchSolanaPriorityFee(connection, lookbackDistance, addresses) {
     try {
         // @ts-ignore

package/lib/node/priorityFee/types.d.ts

@@ -2,33 +2,65 @@ import { Connection, PublicKey } from '@solana/web3.js';
 import { SolanaPriorityFeeResponse } from './solanaPriorityFeeMethod';
 import { HeliusPriorityFeeResponse } from './heliusPriorityFeeMethod';
 import { VelocityMarketInfo, VelocityPriorityFeeResponse } from './velocityPriorityFeeMethod';
+/** Default poll interval (ms) for `PriorityFeeSubscriber`/`PriorityFeeSubscriberMap` when `frequencyMs` is not configured. */
 export declare const DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS = 10000;
+/**
+ * A pluggable priority-fee aggregation function. `PriorityFeeSubscriber`
+ * calls `calculate` after each poll to derive `getCustomStrategyResult()`.
+ * Built-in implementations: `AverageStrategy`/`AverageOverSlotsStrategy`,
+ * `EwmaStrategy`, `MaxStrategy`/`MaxOverSlotsStrategy`.
+ */
 export interface PriorityFeeStrategy {
+    /**
+     * @param samples Fee samples from whichever `priorityFeeMethod` is active — `SolanaPriorityFeeResponse[]` for SOLANA (expected sorted descending by slot), a single `HeliusPriorityFeeResponse` for HELIUS, or `VelocityPriorityFeeResponse` for VELOCITY.
+     * @returns A priority fee estimate in micro-lamports per compute unit.
+     */
     calculate(samples: SolanaPriorityFeeResponse[] | HeliusPriorityFeeResponse | VelocityPriorityFeeResponse): number;
 }
+/** Which upstream API `PriorityFeeSubscriber` queries for priority-fee samples. */
 export declare enum PriorityFeeMethod {
+    /** Solana RPC `getRecentPrioritizationFees`. Requires `connection`. */
     SOLANA = "solana",
+    /** Helius `getPriorityFeeEstimate`. Requires `heliusRpcUrl` or a Helius `connection`. */
     HELIUS = "helius",
+    /** Velocity-hosted priority fee cache, scoped by market. Requires `velocityPriorityFeeEndpoint` and `velocityMarkets`. */
     VELOCITY = "velocity"
 }
+/** Configuration for `PriorityFeeSubscriber`. Which fields are required depends on `priorityFeeMethod` — see `PriorityFeeMethod`. */
 export type PriorityFeeSubscriberConfig = {
+    /** RPC connection used for SOLANA sampling (and as a Helius URL source for HELIUS if `heliusRpcUrl` is omitted); optional only when `priorityFeeMethod` is `HELIUS` or `VELOCITY`. */
     connection?: Connection;
+    /** Poll interval in milliseconds for `load()`; defaults to `DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS` (10s). */
     frequencyMs?: number;
+    /** Account keys the transaction will write-lock; scopes SOLANA/HELIUS fee sampling to congestion on these accounts specifically. */
     addresses?: PublicKey[];
+    /** Markets to query when `priorityFeeMethod` is `VELOCITY`; can also be supplied later via `updateMarketTypeAndIndex`. */
     velocityMarkets?: VelocityMarketInfo[];
+    /** `PriorityFeeStrategy` backing `getCustomStrategyResult()`; defaults to `AverageOverSlotsStrategy`. */
     customStrategy?: PriorityFeeStrategy;
+    /** Which upstream API to sample from; defaults to `PriorityFeeMethod.SOLANA`. */
     priorityFeeMethod?: PriorityFeeMethod;
+    /** Number of recent slots to consider when computing fee estimates; defaults to 50. */
     slotsToCheck?: number;
+    /** Helius RPC URL; required for `PriorityFeeMethod.HELIUS` unless `connection`'s endpoint already points at Helius. */
     heliusRpcUrl?: string;
+    /** Base URL of the Velocity-hosted priority fee service; required for `PriorityFeeMethod.VELOCITY`. */
     velocityPriorityFeeEndpoint?: string;
+    /** Upper bound (micro-lamports per compute unit) applied to every `get*StrategyResult`/`getHeliusPriorityFeeLevel` return value, after `priorityFeeMultiplier`. Unset (`undefined`) means no clamp. */
     maxFeeMicroLamports?: number;
+    /** Multiplier applied to the raw strategy result before `maxFeeMicroLamports` clamping; defaults to `1.0`. */
     priorityFeeMultiplier?: number;
 };
+/** Base config for `PriorityFeeSubscriberMap`, which only supports `PriorityFeeMethod.VELOCITY` (batched per-market fee lookups via `/batchPriorityFees`). */
 type PriorityFeeSubscriberMapConfigBase = {
+    /** Poll interval in milliseconds for `load()`; defaults to `DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS` (10s). */
     frequencyMs?: number;
+    /** Markets to fetch fees for; can also be supplied later via `updateMarketTypeAndIndex`. */
     velocityMarkets?: VelocityMarketInfo[];
 };
+/** Configuration for `PriorityFeeSubscriberMap`. */
 export type PriorityFeeSubscriberMapConfig = PriorityFeeSubscriberMapConfigBase & {
+    /** Base URL of the Velocity-hosted priority fee service (queried via `/batchPriorityFees`). */
     velocityPriorityFeeEndpoint: string;
 };
 export {};

package/lib/node/priorityFee/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EACN,kBAAkB,EAClB,2BAA2B,EAC3B,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,qCAAqC,QAAS,CAAC;AAE5D,MAAM,WAAW,mBAAmB;IAGnC,SAAS,CACR,OAAO,EACJ,yBAAyB,EAAE,GAC3B,yBAAyB,GACzB,2BAA2B,GAC5B,MAAM,CAAC;CACV;AAED,oBAAY,iBAAiB;IAC5B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACrB;AAED,MAAM,MAAM,2BAA2B,GAAG;IAEzC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IAExB,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAEvC,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEtC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,KAAK,kCAAkC,GAAG;IAEzC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACvC,CAAC;AAGF,MAAM,MAAM,8BAA8B,GACzC,kCAAkC,GAAG;IACpC,2BAA2B,EAAE,MAAM,CAAC;CACpC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EACN,kBAAkB,EAClB,2BAA2B,EAC3B,MAAM,6BAA6B,CAAC;AAErC,8HAA8H;AAC9H,eAAO,MAAM,qCAAqC,QAAS,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAGnC;;;OAGG;IACH,SAAS,CACR,OAAO,EACJ,yBAAyB,EAAE,GAC3B,yBAAyB,GACzB,2BAA2B,GAC5B,MAAM,CAAC;CACV;AAED,mFAAmF;AACnF,oBAAY,iBAAiB;IAC5B,uEAAuE;IACvE,MAAM,WAAW;IACjB,yFAAyF;IACzF,MAAM,WAAW;IACjB,0HAA0H;IAC1H,QAAQ,aAAa;CACrB;AAED,qIAAqI;AACrI,MAAM,MAAM,2BAA2B,GAAG;IACzC,sLAAsL;IACtL,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oIAAoI;IACpI,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC;IACxB,0HAA0H;IAC1H,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACvC,yGAAyG;IACzG,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,iFAAiF;IACjF,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,uFAAuF;IACvF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uHAAuH;IACvH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uGAAuG;IACvG,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,uMAAuM;IACvM,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,8GAA8G;IAC9G,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,8JAA8J;AAC9J,KAAK,kCAAkC,GAAG;IACzC,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4FAA4F;IAC5F,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACvC,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,8BAA8B,GACzC,kCAAkC,GAAG;IACpC,+FAA+F;IAC/F,2BAA2B,EAAE,MAAM,CAAC;CACpC,CAAC"}

package/lib/node/priorityFee/types.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PriorityFeeMethod = exports.DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS = void 0;
+/** Default poll interval (ms) for `PriorityFeeSubscriber`/`PriorityFeeSubscriberMap` when `frequencyMs` is not configured. */
 exports.DEFAULT_PRIORITY_FEE_MAP_FREQUENCY_MS = 10000;
+/** Which upstream API `PriorityFeeSubscriber` queries for priority-fee samples. */
 var PriorityFeeMethod;
 (function (PriorityFeeMethod) {
+    /** Solana RPC `getRecentPrioritizationFees`. Requires `connection`. */
     PriorityFeeMethod["SOLANA"] = "solana";
+    /** Helius `getPriorityFeeEstimate`. Requires `heliusRpcUrl` or a Helius `connection`. */
     PriorityFeeMethod["HELIUS"] = "helius";
+    /** Velocity-hosted priority fee cache, scoped by market. Requires `velocityPriorityFeeEndpoint` and `velocityMarkets`. */
     PriorityFeeMethod["VELOCITY"] = "velocity";
 })(PriorityFeeMethod || (exports.PriorityFeeMethod = PriorityFeeMethod = {}));

package/lib/node/priorityFee/velocityPriorityFeeMethod.d.ts

@@ -1,14 +1,25 @@
 import { HeliusPriorityLevel } from './heliusPriorityFeeMethod';
+/** Identifies a market to fetch/track priority fees for. */
 export type VelocityMarketInfo = {
     marketType: string;
     marketIndex: number;
 };
+/** Per-percentile priority fee (micro-lamports/CU, same buckets as `HeliusPriorityLevel`) for one market, as returned by the Velocity priority fee endpoint. */
 export type VelocityPriorityFeeLevels = {
     [key in HeliusPriorityLevel]: number;
 } & {
     marketType: 'perp' | 'spot';
     marketIndex: number;
 };
+/** One `VelocityPriorityFeeLevels` entry per requested market. */
 export type VelocityPriorityFeeResponse = VelocityPriorityFeeLevels[];
+/**
+ * Fetches per-market priority fee levels from the Velocity-hosted
+ * `/batchPriorityFees` endpoint.
+ * @param url Base URL of the Velocity priority fee service.
+ * @param marketTypes Market types to query, parallel-indexed to `marketIndexes` (e.g. `['perp', 'perp', 'spot']`).
+ * @param marketIndexes Market indexes to query, parallel-indexed to `marketTypes`.
+ * @returns One `VelocityPriorityFeeLevels` per requested market; an empty array if the request failed (error is logged, not thrown) or returned a non-OK HTTP status.
+ */
 export declare function fetchVelocityPriorityFee(url: string, marketTypes: string[], marketIndexes: number[]): Promise<VelocityPriorityFeeResponse>;
 //# sourceMappingURL=velocityPriorityFeeMethod.d.ts.map

package/lib/node/priorityFee/velocityPriorityFeeMethod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"velocityPriorityFeeMethod.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/velocityPriorityFeeMethod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,MAAM,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;KACtC,GAAG,IAAI,mBAAmB,GAAG,MAAM;CACpC,GAAG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,yBAAyB,EAAE,CAAC;AAEtE,wBAAsB,wBAAwB,CAC7C,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,EAAE,EACrB,aAAa,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,2BAA2B,CAAC,CAoBtC"}
+{"version":3,"file":"velocityPriorityFeeMethod.d.ts","sourceRoot":"","sources":["../../../src/priorityFee/velocityPriorityFeeMethod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,gKAAgK;AAChK,MAAM,MAAM,yBAAyB,GAAG;KACtC,GAAG,IAAI,mBAAmB,GAAG,MAAM;CACpC,GAAG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,2BAA2B,GAAG,yBAAyB,EAAE,CAAC;AAEtE;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC7C,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,EAAE,EACrB,aAAa,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,2BAA2B,CAAC,CAoBtC"}

package/lib/node/priorityFee/velocityPriorityFeeMethod.js

@@ -5,6 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchVelocityPriorityFee = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
+/**
+ * Fetches per-market priority fee levels from the Velocity-hosted
+ * `/batchPriorityFees` endpoint.
+ * @param url Base URL of the Velocity priority fee service.
+ * @param marketTypes Market types to query, parallel-indexed to `marketIndexes` (e.g. `['perp', 'perp', 'spot']`).
+ * @param marketIndexes Market indexes to query, parallel-indexed to `marketTypes`.
+ * @returns One `VelocityPriorityFeeLevels` per requested market; an empty array if the request failed (error is logged, not thrown) or returned a non-OK HTTP status.
+ */
 async function fetchVelocityPriorityFee(url, marketTypes, marketIndexes) {
     try {
         const response = await (0, node_fetch_1.default)(`${url}/batchPriorityFees?marketType=${marketTypes.join(',')}&marketIndex=${marketIndexes.join(',')}`);

package/lib/node/slot/SlotSubscriber.d.ts

@@ -5,9 +5,17 @@ import StrictEventEmitter from 'strict-event-emitter-types/types/src';
 type SlotSubscriberConfig = {
     resubTimeoutMs?: number;
 };
+/** Events emitted on `SlotSubscriber.eventEmitter`. */
 export interface SlotSubscriberEvents {
+    /** Fired whenever a new, strictly-greater slot is observed (including the initial slot fetched by `subscribe()`). */
     newSlot: (newSlot: number) => void;
 }
+/**
+ * SlotSubscriber — tracks the current slot via `connection.onSlotChange`,
+ * with an optional stall-detection resubscribe. Slot updates that are not
+ * strictly greater than the currently tracked slot are ignored (protects
+ * against out-of-order delivery).
+ */
 export declare class SlotSubscriber {
     private connection;
     currentSlot: number;
@@ -17,11 +25,21 @@ export declare class SlotSubscriber {
     resubTimeoutMs?: number;
     isUnsubscribing: boolean;
     receivingData: boolean;
+    /**
+     * @param connection RPC connection to subscribe on.
+     * @param config.resubTimeoutMs If set to a positive value, resubscribe when no slot update arrives for this many ms; `0` (or unset) disables the resubscribe watchdog. Positive values below 1000ms log a warning (too aggressive) but are still honored.
+     */
     constructor(connection: Connection, config?: SlotSubscriberConfig);
+    /** Fetches the current slot once via RPC, then subscribes to `onSlotChange` for live updates. Idempotent while already subscribed. */
     subscribe(): Promise<void>;
     private updateCurrentSlot;
     private setTimeout;
+    /** @returns The most recently observed slot, or `0` if `subscribe()` hasn't completed yet. */
     getSlot(): number;
+    /**
+     * Removes the `onSlotChange` listener and cancels the resub timeout.
+     * @param onResub Internal flag used when unsubscribing as part of an automatic resubscribe cycle; when `false` (a caller-initiated unsubscribe), also permanently disables future auto-resubscribe by clearing `resubTimeoutMs`.
+     */
     unsubscribe(onResub?: boolean): Promise<void>;
 }
 export {};

package/lib/node/slot/SlotSubscriber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SlotSubscriber.d.ts","sourceRoot":"","sources":["../../../src/slot/SlotSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,kBAAkB,MAAM,sCAAsC,CAAC;AAGtE,KAAK,oBAAoB,GAAG;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC;AAED,qBAAa,cAAc;IAYzB,OAAO,CAAC,UAAU;IAXnB,WAAW,SAAK;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;IAGrE,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,UAAS;IACxB,aAAa,UAAS;gBAGb,UAAU,EAAE,UAAU,EAC9B,MAAM,CAAC,EAAE,oBAAoB;IAWjB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BvC,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,UAAU;IAkBX,OAAO,IAAI,MAAM;IAIX,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxD"}
+{"version":3,"file":"SlotSubscriber.d.ts","sourceRoot":"","sources":["../../../src/slot/SlotSubscriber.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,kBAAkB,MAAM,sCAAsC,CAAC;AAGtE,KAAK,oBAAoB,GAAG;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACpC,qHAAqH;IACrH,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC;AAED;;;;;GAKG;AACH,qBAAa,cAAc;IAgBzB,OAAO,CAAC,UAAU;IAfnB,WAAW,SAAK;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,kBAAkB,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;IAGrE,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,UAAS;IACxB,aAAa,UAAS;IAEtB;;;OAGG;gBAEM,UAAU,EAAE,UAAU,EAC9B,MAAM,CAAC,EAAE,oBAAoB;IAW9B,sIAAsI;IACzH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BvC,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,UAAU;IAkBlB,8FAA8F;IACvF,OAAO,IAAI,MAAM;IAIxB;;;OAGG;IACU,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxD"}

package/lib/node/slot/SlotSubscriber.js

@@ -2,7 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SlotSubscriber = void 0;
 const events_1 = require("events");
+/**
+ * SlotSubscriber — tracks the current slot via `connection.onSlotChange`,
+ * with an optional stall-detection resubscribe. Slot updates that are not
+ * strictly greater than the currently tracked slot are ignored (protects
+ * against out-of-order delivery).
+ */
 class SlotSubscriber {
+    /**
+     * @param connection RPC connection to subscribe on.
+     * @param config.resubTimeoutMs If set to a positive value, resubscribe when no slot update arrives for this many ms; `0` (or unset) disables the resubscribe watchdog. Positive values below 1000ms log a warning (too aggressive) but are still honored.
+     */
     constructor(connection, config) {
         this.connection = connection;
         this.currentSlot = 0;
@@ -14,6 +24,7 @@ class SlotSubscriber {
             console.log('resubTimeoutMs should be at least 1000ms to avoid spamming resub');
         }
     }
+    /** Fetches the current slot once via RPC, then subscribes to `onSlotChange` for live updates. Idempotent while already subscribed. */
     async subscribe() {
         if (this.subscriptionId != null) {
             return;
@@ -54,9 +65,14 @@ class SlotSubscriber {
             }
         }, this.resubTimeoutMs);
     }
+    /** @returns The most recently observed slot, or `0` if `subscribe()` hasn't completed yet. */
     getSlot() {
         return this.currentSlot;
     }
+    /**
+     * Removes the `onSlotChange` listener and cancels the resub timeout.
+     * @param onResub Internal flag used when unsubscribing as part of an automatic resubscribe cycle; when `false` (a caller-initiated unsubscribe), also permanently disables future auto-resubscribe by clearing `resubTimeoutMs`.
+     */
     async unsubscribe(onResub = false) {
         if (!onResub) {
             this.resubTimeoutMs = undefined;

package/lib/node/slot/SlothashSubscriber.d.ts

@@ -3,10 +3,18 @@ type SlothashSubscriberConfig = {
     resubTimeoutMs?: number;
     commitment?: Commitment;
 };
+/** A slot and its corresponding blockhash, decoded from the `SysvarS1otHashes111111111111111111111111111` account. */
 export type Slothash = {
     slot: number;
+    /** Base58-encoded blockhash for that slot. */
     hash: string;
 };
+/**
+ * SlothashSubscriber — tracks the most recent entry of the `SlotHashes`
+ * sysvar via `connection.onAccountChange`, with an optional stall-detection
+ * resubscribe. Updates whose slot is not strictly greater than the currently
+ * tracked one are ignored.
+ */
 export declare class SlothashSubscriber {
     private connection;
     private _currentSlothash?;
@@ -17,10 +25,28 @@ export declare class SlothashSubscriber {
     resubTimeoutMs?: number;
     isUnsubscribing: boolean;
     receivingData: boolean;
+    /**
+     * @param connection RPC connection to subscribe on.
+     * @param config.commitment Commitment for both the initial fetch and the account-change subscription; defaults to `'processed'`.
+     * @param config.resubTimeoutMs If set to a positive value, resubscribe when no update arrives for this many ms; `0` (or unset) disables the resubscribe watchdog. Positive values below 1000ms log a warning but are still honored.
+     */
     constructor(connection: Connection, config?: SlothashSubscriberConfig);
+    /**
+     * Fetches the `SlotHashes` sysvar once via RPC, then subscribes to
+     * `onAccountChange` for live updates. Idempotent while already subscribed.
+     * @throws If the sysvar account can't be fetched on the initial load.
+     */
     subscribe(): Promise<void>;
     private setTimeout;
+    /**
+     * @returns The most recently observed `Slothash`.
+     * @throws If called before `subscribe()` has completed its initial fetch.
+     */
     getSlothash(): Slothash;
+    /**
+     * Removes the `onAccountChange` listener and cancels the resub timeout.
+     * @param onResub Internal flag used when unsubscribing as part of an automatic resubscribe cycle; when `false`, also permanently disables future auto-resubscribe by clearing `resubTimeoutMs`.
+     */
     unsubscribe(onResub?: boolean): Promise<void>;
 }
 export {};

package/lib/node/slot/SlothashSubscriber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SlothashSubscriber.d.ts","sourceRoot":"","sources":["../../../src/slot/SlothashSubscriber.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,UAAU,EACV,UAAU,EAEV,MAAM,iBAAiB,CAAC;AAKzB,KAAK,wBAAwB,GAAG;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,qBAAa,kBAAkB;IAoB7B,OAAO,CAAC,UAAU;IAnBnB,OAAO,CAAC,gBAAgB,CAAC,CAAW;IACpC,OAAO,KAAK,eAAe,GAO1B;IACD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,UAAU,CAAC;IAGvB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,UAAS;IACxB,aAAa,UAAS;gBAGb,UAAU,EAAE,UAAU,EAC9B,MAAM,CAAC,EAAE,wBAAwB;IAWrB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAsCvC,OAAO,CAAC,UAAU;IAkBX,WAAW,IAAI,QAAQ;IAIjB,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxD"}
+{"version":3,"file":"SlothashSubscriber.d.ts","sourceRoot":"","sources":["../../../src/slot/SlothashSubscriber.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,UAAU,EACV,UAAU,EAEV,MAAM,iBAAiB,CAAC;AAKzB,KAAK,wBAAwB,GAAG;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF,sHAAsH;AACtH,MAAM,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,kBAAkB;IAyB7B,OAAO,CAAC,UAAU;IAxBnB,OAAO,CAAC,gBAAgB,CAAC,CAAW;IACpC,OAAO,KAAK,eAAe,GAO1B;IACD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,UAAU,CAAC;IAGvB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,UAAS;IACxB,aAAa,UAAS;IAEtB;;;;OAIG;gBAEM,UAAU,EAAE,UAAU,EAC9B,MAAM,CAAC,EAAE,wBAAwB;IAWlC;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAsCvC,OAAO,CAAC,UAAU;IAkBlB;;;OAGG;IACI,WAAW,IAAI,QAAQ;IAI9B;;;OAGG;IACU,WAAW,CAAC,OAAO,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBxD"}

package/lib/node/slot/SlothashSubscriber.js

@@ -7,6 +7,12 @@ exports.SlothashSubscriber = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const bs58_1 = __importDefault(require("bs58"));
 const anchor_1 = require("../isomorphic/anchor");
+/**
+ * SlothashSubscriber — tracks the most recent entry of the `SlotHashes`
+ * sysvar via `connection.onAccountChange`, with an optional stall-detection
+ * resubscribe. Updates whose slot is not strictly greater than the currently
+ * tracked one are ignored.
+ */
 class SlothashSubscriber {
     get currentSlothash() {
         if (!this._currentSlothash) {
@@ -14,6 +20,11 @@ class SlothashSubscriber {
         }
         return this._currentSlothash;
     }
+    /**
+     * @param connection RPC connection to subscribe on.
+     * @param config.commitment Commitment for both the initial fetch and the account-change subscription; defaults to `'processed'`.
+     * @param config.resubTimeoutMs If set to a positive value, resubscribe when no update arrives for this many ms; `0` (or unset) disables the resubscribe watchdog. Positive values below 1000ms log a warning but are still honored.
+     */
     constructor(connection, config) {
         var _a;
         this.connection = connection;
@@ -25,6 +36,11 @@ class SlothashSubscriber {
             console.log('resubTimeoutMs should be at least 1000ms to avoid spamming resub');
         }
     }
+    /**
+     * Fetches the `SlotHashes` sysvar once via RPC, then subscribes to
+     * `onAccountChange` for live updates. Idempotent while already subscribed.
+     * @throws If the sysvar account can't be fetched on the initial load.
+     */
     async subscribe() {
         if (this.subscriptionId != null) {
             return;
@@ -64,9 +80,17 @@ class SlothashSubscriber {
             }
         }, this.resubTimeoutMs);
     }
+    /**
+     * @returns The most recently observed `Slothash`.
+     * @throws If called before `subscribe()` has completed its initial fetch.
+     */
     getSlothash() {
         return this.currentSlothash;
     }
+    /**
+     * Removes the `onAccountChange` listener and cancels the resub timeout.
+     * @param onResub Internal flag used when unsubscribing as part of an automatic resubscribe cycle; when `false`, also permanently disables future auto-resubscribe by clearing `resubTimeoutMs`.
+     */
     async unsubscribe(onResub = false) {
         if (!onResub) {
             this.resubTimeoutMs = undefined;
@@ -75,7 +99,7 @@ class SlothashSubscriber {
         clearTimeout(this.timeoutId);
         this.timeoutId = undefined;
         if (this.subscriptionId != null) {
-            await this.connection.removeSlotChangeListener(this.subscriptionId);
+            await this.connection.removeAccountChangeListener(this.subscriptionId);
             this.subscriptionId = undefined;
             this.isUnsubscribing = false;
         }

package/lib/node/tx/baseTxSender.d.ts

@@ -5,24 +5,57 @@ import { Commitment, ConfirmOptions, RpcResponseAndContext, Signer, SignatureRes
 import { TxHandler } from './txHandler';
 import { IWallet } from '../types';
 import NodeCache from 'node-cache';
+/**
+ * Shared base for all `TxSender` implementations (`RetryTxSender`, `WhileValidTxSender`,
+ * `FastSingleTxSender`, `ForwardOnlyTxSender`). Provides signing/serialization via `TxHandler`,
+ * confirmation via websocket subscription and/or polling (per `ConfirmationStrategy`),
+ * timeout/land-rate bookkeeping, and fan-out to `additionalConnections`. Subclasses are expected
+ * to implement `sendRawTransaction` with their specific retry/broadcast behavior — the base
+ * implementation always throws.
+ */
 export declare abstract class BaseTxSender implements TxSender {
     connection: Connection;
     wallet: IWallet;
     opts: ConfirmOptions;
+    /** Confirmation timeout in milliseconds, applied to both websocket and polling confirmation. */
     timeout: number;
+    /** Extra RPC connections a raw transaction is also broadcast to (best-effort, errors logged not thrown), for redundancy. */
     additionalConnections: Connection[];
+    /** Count of `confirmTransactionWebSocket`/`confirmTransactionPolling` calls that hit `timeout` without a definitive result. */
     timeoutCount: number;
     confirmationStrategy: ConfirmationStrategy;
+    /** Callbacks invoked with the base58-encoded raw transaction alongside `additionalConnections` broadcasts, e.g. for logging/mempool submission. */
     additionalTxSenderCallbacks?: ((base58EncodedTx: string) => void)[];
     txHandler: TxHandler;
+    /** Whether to record each sent signature (via `txSigCache`) to compute `getTxLandRate()`. */
     trackTxLandRate?: boolean;
+    /** Whether `confirmTransactionWebSocket`/`confirmTransactionPolling` throw `TxSendError` on timeout (`true`) or return `undefined` (`false`). */
     throwOnTimeoutError: boolean;
+    /** Whether `checkConfirmationResultForError` throws the resolved on-chain error, or is a no-op. */
     throwOnTransactionError: boolean;
+    /** Lookback window, in seconds, over which `txSigCache` entries expire for the land-rate calculation. */
     lookbackWindowMinutes: number;
+    /** TTL cache of `txSig -> landed?` used to compute `getTxLandRate()` when `trackTxLandRate` is set. */
     txSigCache?: NodeCache;
     txLandRate: number;
     lastPriorityFeeSuggestion: number;
+    /** Maps a land rate (0-1) to a priority-fee multiplier; defaults to `defaultLandRateToFeeFunc`. */
     landRateToFeeFunc: (landRate: number) => number;
+    /**
+     * @param props.connection - Primary RPC connection used for sending and confirming transactions.
+     * @param props.wallet - Wallet used to sign transactions that aren't already `preSigned`.
+     * @param props.opts - Default `ConfirmOptions` used when a call site doesn't pass its own; defaults to `DEFAULT_CONFIRMATION_OPTS` (`'confirmed'`).
+     * @param props.timeout - Confirmation timeout in milliseconds; defaults to 35000 (35s).
+     * @param props.additionalConnections - Extra connections to also broadcast raw transactions to.
+     * @param props.confirmationStrategy - How to wait for confirmation; defaults to `ConfirmationStrategy.Combo`.
+     * @param props.additionalTxSenderCallbacks - Callbacks invoked with each sent transaction's base58 encoding.
+     * @param props.trackTxLandRate - Enables land-rate tracking (backs `getTxLandRate()`/`getSuggestedPriorityFeeMultiplier()`).
+     * @param props.txHandler - Custom `TxHandler` for signing/building transactions; defaults to one constructed from `connection`/`wallet`/`opts`.
+     * @param props.txLandRateLookbackWindowMinutes - Rolling window, in minutes, of sent signatures kept for the land-rate calculation; defaults to 10.
+     * @param props.landRateToFeeFunc - Custom mapping from land rate to priority-fee multiplier; defaults to `defaultLandRateToFeeFunc`.
+     * @param props.throwOnTimeoutError - Whether confirmation timeouts throw `TxSendError` instead of returning `undefined`; defaults to `true`.
+     * @param props.throwOnTransactionError - Whether a failed on-chain result throws the resolved program error; defaults to `true`.
+     */
     constructor({ connection, wallet, opts, timeout, additionalConnections, confirmationStrategy, additionalTxSenderCallbacks, trackTxLandRate, txHandler, txLandRateLookbackWindowMinutes, landRateToFeeFunc, throwOnTimeoutError, throwOnTransactionError, }: {
         connection: Connection;
         wallet: IWallet;
@@ -38,23 +71,153 @@ export declare abstract class BaseTxSender implements TxSender {
         throwOnTimeoutError?: boolean;
         throwOnTransactionError?: boolean;
     });
+    /**
+     * Signs (via `prepareTx`, unless `preSigned`) and sends a legacy `Transaction`.
+     * @param tx - Transaction to send.
+     * @param additionalSigners - Extra signers to co-sign alongside the wallet; defaults to none.
+     * @param opts - Confirmation options; defaults to `this.opts`.
+     * @param preSigned - If `true`, skip wallet signing.
+     * @returns The result of `sendRawTransaction` on the serialized, signed transaction.
+     */
     send(tx: Transaction, additionalSigners?: Array<Signer>, opts?: ConfirmOptions, preSigned?: boolean): Promise<TxSigAndSlot>;
+    /**
+     * Delegates to `TxHandler.prepareTx` to attach a recent blockhash, fee payer, and signatures.
+     * @param tx - Transaction to prepare.
+     * @param additionalSigners - Extra signers to co-sign alongside the wallet.
+     * @param opts - Confirmation options (affects blockhash commitment).
+     * @param preSigned - If `true`, skip wallet signing.
+     * @returns The prepared (blockhash-populated, signed unless `preSigned`) transaction.
+     */
     prepareTx(tx: Transaction, additionalSigners: Array<Signer>, opts: ConfirmOptions, preSigned?: boolean): Promise<Transaction>;
+    /**
+     * Builds (but does not send) a `VersionedTransaction` from raw instructions via
+     * `TxHandler.generateVersionedTransaction`.
+     * @param ixs - Instructions to include, in order.
+     * @param lookupTableAccounts - Address lookup tables to compile the message against.
+     * @param _additionalSigners - Unused by this implementation.
+     * @param opts - Unused by this implementation (present for `TxSender` interface compatibility).
+     * @param blockhash - Blockhash to use; if omitted, fetched fresh via `connection.getLatestBlockhash()`.
+     * @returns The compiled `VersionedTransaction` (not yet signed by additional signers beyond the wallet).
+     */
     getVersionedTransaction(ixs: TransactionInstruction[], lookupTableAccounts: AddressLookupTableAccount[], _additionalSigners?: Array<Signer>, opts?: ConfirmOptions, blockhash?: BlockhashWithExpiryBlockHeight): Promise<VersionedTransaction>;
+    /**
+     * Signs (unless `preSigned`) and sends a `VersionedTransaction`. When the wallet exposes a
+     * `payer` `Keypair` directly, signs in-place with `tx.sign(...)`; otherwise delegates to
+     * `TxHandler.signVersionedTx` (needed for wallet adapters without direct keypair access).
+     * @param tx - Transaction to send.
+     * @param additionalSigners - Extra signers to co-sign alongside the wallet.
+     * @param opts - Confirmation options; defaults to `this.opts`.
+     * @param preSigned - If `true`, skip signing entirely.
+     * @returns The result of `sendRawTransaction` on the serialized, signed transaction.
+     */
     sendVersionedTransaction(tx: VersionedTransaction, additionalSigners?: Array<Signer>, opts?: ConfirmOptions, preSigned?: boolean): Promise<TxSigAndSlot>;
+    /**
+     * Sends and confirms an already-serialized, already-signed transaction. `BaseTxSender` itself
+     * has no broadcast/retry strategy — every concrete sender (`RetryTxSender`,
+     * `WhileValidTxSender`, `FastSingleTxSender`, `ForwardOnlyTxSender`) must override this.
+     * @throws Error always, if not overridden by a subclass.
+     */
     sendRawTransaction(rawTransaction: Buffer | Uint8Array, opts: ConfirmOptions): Promise<TxSigAndSlot>;
+    /**
+     * Simulates a transaction via `connection.simulateTransaction` without sending it, swallowing
+     * both simulation errors and RPC-call failures into a `false` result (logged to `console.error`).
+     * @param tx - Transaction to simulate.
+     * @returns `true` if simulation succeeded with no error, `false` otherwise.
+     */
     simulateTransaction(tx: VersionedTransaction): Promise<boolean>;
+    /**
+     * Waits for a transaction to confirm by subscribing to `onSignature` on `connection` and every
+     * `additionalConnections` entry simultaneously, resolving on whichever responds first. If no
+     * connection confirms within `this.timeout` and `confirmationStrategy` is `Combo`, falls back
+     * to a one-shot `getSignatureStatuses` check before giving up.
+     * @param signature - Base58-encoded transaction signature to confirm.
+     * @param commitment - Commitment level for the subscription; defaults to `this.opts.commitment`.
+     * @returns The confirmation result, or `undefined` if it timed out and `throwOnTimeoutError` is `false`.
+     * @throws Error if `signature` isn't valid base58 or isn't 64 bytes decoded. `TxSendError`
+     * (code `NOT_CONFIRMED_ERROR_CODE`) on timeout if `throwOnTimeoutError` is `true` (the default) —
+     * in that case the transaction's actual outcome is unknown, not necessarily failed.
+     */
     confirmTransactionWebSocket(signature: TransactionSignature, commitment?: Commitment): Promise<RpcResponseAndContext<SignatureResult> | undefined>;
+    /**
+     * Waits for a transaction to confirm by polling `getSignatureStatuses` with exponential
+     * backoff, starting at 400ms and capping at 5000ms, until `commitment` is reached or
+     * `this.timeout` elapses.
+     * @param signature - Base58-encoded transaction signature to confirm.
+     * @param commitment - Commitment level to wait for; defaults to `'finalized'`.
+     * @returns The confirmation result (`{ err: null }` on success), or `undefined` if it timed out and `throwOnTimeoutError` is `false`.
+     * @throws TxSendError (code `NOT_CONFIRMED_ERROR_CODE`) on timeout if `throwOnTimeoutError` is
+     * `true` (the default) — in that case the transaction's actual outcome is unknown, not
+     * necessarily failed.
+     */
     confirmTransactionPolling(signature: TransactionSignature, commitment?: Commitment): Promise<RpcResponseAndContext<SignatureResult> | undefined>;
+    /**
+     * Confirms a transaction using whichever strategy `this.confirmationStrategy` selects:
+     * `WebSocket`/`Combo` route to `confirmTransactionWebSocket`, `Polling` to `confirmTransactionPolling`.
+     * @param signature - Base58-encoded transaction signature to confirm.
+     * @param commitment - Commitment level to wait for.
+     * @returns The confirmation result, or `undefined` on timeout if `throwOnTimeoutError` is `false`.
+     * @throws TxSendError on timeout if `throwOnTimeoutError` is `true` (see `confirmTransactionWebSocket`/`confirmTransactionPolling`).
+     */
     confirmTransaction(signature: TransactionSignature, commitment?: Commitment): Promise<RpcResponseAndContext<SignatureResult> | undefined>;
+    /** Current time in milliseconds since epoch (thin wrapper over `Date.now()`, overridable in tests). */
     getTimestamp(): number;
+    /**
+     * Races an array of promises against a timeout, resolving to `null` (rather than rejecting) if
+     * none settle in time. Unlike `../util/promiseTimeout`, this accepts multiple promises (used to
+     * race confirmation across `connection` plus every `additionalConnections` entry).
+     * @param promises - Promises to race.
+     * @param timeoutMs - Timeout in milliseconds.
+     * @returns The first promise's resolved value, or `null` if none settled before `timeoutMs`.
+     */
     promiseTimeout<T>(promises: Promise<T>[], timeoutMs: number): Promise<T | null>;
+    /**
+     * Best-effort broadcasts a raw transaction to every `additionalConnections` entry and invokes
+     * `additionalTxSenderCallbacks` with its base58 encoding. Failures are logged, not thrown or
+     * awaited by the caller — this never affects whether the primary send/confirm succeeds.
+     * @param rawTx - Serialized, signed transaction bytes.
+     * @param opts - Options passed through to each connection's `sendRawTransaction`.
+     */
     sendToAdditionalConnections(rawTx: Buffer | Uint8Array, opts: ConfirmOptions): void;
+    /**
+     * Adds an extra RPC connection to broadcast future transactions to, unless a connection with
+     * the same RPC endpoint is already registered.
+     * @param newConnection - Connection to add to `additionalConnections`.
+     */
     addAdditionalConnection(newConnection: Connection): void;
+    /** @returns The number of confirmation attempts that have timed out so far. */
     getTimeoutCount(): number;
+    /**
+     * Inspects a confirmed signature's result and, if it recorded an on-chain error, resolves the
+     * detailed program error via `throwTransactionError` and throws it. Note this check runs
+     * whenever `result.err` is set, independent of the `throwOnTransactionError` field — callers
+     * that want to suppress transaction-error throwing should avoid calling this method rather
+     * than rely on that flag here.
+     * @param txSig - Transaction signature to look up the detailed error for.
+     * @param result - The `SignatureResult` returned by confirmation.
+     * @throws Error the resolved on-chain program error, if `result.err` is set.
+     */
     checkConfirmationResultForError(txSig: string, result: SignatureResult): Promise<void>;
+    /**
+     * Computes the fraction of recently sent transactions (within `lookbackWindowMinutes`) that
+     * landed, from `txSigCache`'s current entries. Returns the last computed `txLandRate` (default
+     * 0) if `trackTxLandRate` is disabled or the cache is empty, rather than recomputing.
+     * @returns The land rate as a fraction between 0 and 1.
+     */
     getTxLandRate(): number;
+    /**
+     * Default `landRateToFeeFunc`: returns `1` (no boost) if the land rate is already at/above
+     * `BASELINE_TX_LAND_RATE` (0.9) or fewer than 3 samples have been recorded yet (too little data
+     * to react); otherwise returns a multiplier that grows logarithmically as the land rate falls
+     * further below baseline, capped at `10`.
+     * @param txLandRate - Recent land rate, 0-1 (see `getTxLandRate`).
+     * @returns A priority-fee multiplier between 1 and 10.
+     */
     private defaultLandRateToFeeFunc;
+    /**
+     * Suggests a multiplier to apply to a base priority fee, based on recent land rate — intended
+     * for callers to scale up their compute-unit price when transactions have been landing poorly.
+     * @returns `1` (no change) if `trackTxLandRate` is disabled; otherwise `landRateToFeeFunc(getTxLandRate())`.
+     */
     getSuggestedPriorityFeeMultiplier(): number;
 }
 //# sourceMappingURL=baseTxSender.d.ts.map

package/lib/node/tx/baseTxSender.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseTxSender.d.ts","sourceRoot":"","sources":["../../../src/tx/baseTxSender.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,oBAAoB,EACpB,QAAQ,EAER,YAAY,EACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,UAAU,EACV,cAAc,EAEd,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,8BAA8B,EAC9B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,SAAS,MAAM,YAAY,CAAC;AASnC,8BAAsB,YAAa,YAAW,QAAQ;IACrD,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB,EAAE,UAAU,EAAE,CAAC;IACpC,YAAY,SAAK;IACjB,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,2BAA2B,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC;IACpE,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,uBAAuB,EAAE,OAAO,CAAC;IAGjC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,UAAU,SAAK;IACf,yBAAyB,SAAK;IAC9B,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;gBAE7B,EAClB,UAAU,EACV,MAAM,EACN,IAAgC,EAChC,OAAyB,EACzB,qBAA+C,EAC/C,oBAAiD,EACjD,2BAA2B,EAC3B,eAAe,EACf,SAAS,EACT,+BAA8E,EAC9E,iBAAiB,EACjB,mBAA0B,EAC1B,uBAA8B,GAC9B,EAAE;QACF,UAAU,EAAE,UAAU,CAAC;QACvB,MAAM,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,cAAc,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,qBAAqB,CAAC,EAAE,UAAU,EAAE,CAAC;QACrC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;QAC5C,2BAA2B,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC;QACpE,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,+BAA+B,CAAC,EAAE,MAAM,CAAC;QACzC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;QACjD,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,uBAAuB,CAAC,EAAE,OAAO,CAAC;KAClC;IA6BK,IAAI,CACT,EAAE,EAAE,WAAW,EACf,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACjC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,YAAY,CAAC;IAkBlB,SAAS,CACd,EAAE,EAAE,WAAW,EACf,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,EAChC,IAAI,EAAE,cAAc,EACpB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,WAAW,CAAC;IAUjB,uBAAuB,CAC5B,GAAG,EAAE,sBAAsB,EAAE,EAC7B,mBAAmB,EAAE,yBAAyB,EAAE,EAChD,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAClC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,8BAA8B,GACxC,OAAO,CAAC,oBAAoB,CAAC;IAS1B,wBAAwB,CAC7B,EAAE,EAAE,oBAAoB,EACxB,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACjC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,YAAY,CAAC;IA0BlB,kBAAkB,CAEvB,cAAc,EAAE,MAAM,GAAG,UAAU,EAEnC,IAAI,EAAE,cAAc,GAClB,OAAO,CAAC,YAAY,CAAC;IAKlB,mBAAmB,CAAC,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAc/D,2BAA2B,CAChC,SAAS,EAAE,oBAAoB,EAC/B,UAAU,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAmFxD,yBAAyB,CAC9B,SAAS,EAAE,oBAAoB,EAC/B,UAAU,GAAE,UAAwB,GAClC,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAuCxD,kBAAkB,CACvB,SAAS,EAAE,oBAAoB,EAC/B,UAAU,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAW9D,YAAY,IAAI,MAAM;IAItB,cAAc,CAAC,CAAC,EACf,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EACtB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAcpB,2BAA2B,CAC1B,KAAK,EAAE,MAAM,GAAG,UAAU,EAC1B,IAAI,EAAE,cAAc,GAClB,IAAI;IAeA,uBAAuB,CAAC,aAAa,EAAE,UAAU,GAAG,IAAI;IAYxD,eAAe,IAAI,MAAM;IAInB,+BAA+B,CAC3C,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,eAAe,GACrB,OAAO,CAAC,IAAI,CAAC;IAYT,aAAa,IAAI,MAAM;IAoB9B,OAAO,CAAC,wBAAwB;IAYzB,iCAAiC,IAAI,MAAM;CAMlD"}
+{"version":3,"file":"baseTxSender.d.ts","sourceRoot":"","sources":["../../../src/tx/baseTxSender.ts"],"names":[],"mappings":";;AAAA,OAAO,EACN,oBAAoB,EACpB,QAAQ,EAER,YAAY,EACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,UAAU,EACV,cAAc,EAEd,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EACzB,8BAA8B,EAC9B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,SAAS,MAAM,YAAY,CAAC;AASnC;;;;;;;GAOG;AACH,8BAAsB,YAAa,YAAW,QAAQ;IACrD,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,cAAc,CAAC;IACrB,gGAAgG;IAChG,OAAO,EAAE,MAAM,CAAC;IAChB,4HAA4H;IAC5H,qBAAqB,EAAE,UAAU,EAAE,CAAC;IACpC,+HAA+H;IAC/H,YAAY,SAAK;IACjB,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,mJAAmJ;IACnJ,2BAA2B,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC;IACpE,SAAS,EAAE,SAAS,CAAC;IACrB,6FAA6F;IAC7F,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iJAAiJ;IACjJ,mBAAmB,EAAE,OAAO,CAAC;IAC7B,mGAAmG;IACnG,uBAAuB,EAAE,OAAO,CAAC;IAGjC,yGAAyG;IACzG,qBAAqB,EAAE,MAAM,CAAC;IAC9B,uGAAuG;IACvG,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,UAAU,SAAK;IACf,yBAAyB,SAAK;IAC9B,mGAAmG;IACnG,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IAEhD;;;;;;;;;;;;;;OAcG;gBACgB,EAClB,UAAU,EACV,MAAM,EACN,IAAgC,EAChC,OAAyB,EACzB,qBAA+C,EAC/C,oBAAiD,EACjD,2BAA2B,EAC3B,eAAe,EACf,SAAS,EACT,+BAA8E,EAC9E,iBAAiB,EACjB,mBAA0B,EAC1B,uBAA8B,GAC9B,EAAE;QACF,UAAU,EAAE,UAAU,CAAC;QACvB,MAAM,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,cAAc,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,qBAAqB,CAAC,EAAE,UAAU,EAAE,CAAC;QACrC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;QAC5C,2BAA2B,CAAC,EAAE,CAAC,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC;QACpE,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,+BAA+B,CAAC,EAAE,MAAM,CAAC;QACzC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;QACjD,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,uBAAuB,CAAC,EAAE,OAAO,CAAC;KAClC;IA6BD;;;;;;;OAOG;IACG,IAAI,CACT,EAAE,EAAE,WAAW,EACf,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACjC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,YAAY,CAAC;IAkBxB;;;;;;;OAOG;IACG,SAAS,CACd,EAAE,EAAE,WAAW,EACf,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,EAChC,IAAI,EAAE,cAAc,EACpB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,WAAW,CAAC;IAUvB;;;;;;;;;OASG;IACG,uBAAuB,CAC5B,GAAG,EAAE,sBAAsB,EAAE,EAC7B,mBAAmB,EAAE,yBAAyB,EAAE,EAChD,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAClC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,8BAA8B,GACxC,OAAO,CAAC,oBAAoB,CAAC;IAShC;;;;;;;;;OASG;IACG,wBAAwB,CAC7B,EAAE,EAAE,oBAAoB,EACxB,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACjC,IAAI,CAAC,EAAE,cAAc,EACrB,SAAS,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,YAAY,CAAC;IA0BxB;;;;;OAKG;IACG,kBAAkB,CAEvB,cAAc,EAAE,MAAM,GAAG,UAAU,EAEnC,IAAI,EAAE,cAAc,GAClB,OAAO,CAAC,YAAY,CAAC;IAIxB;;;;;OAKG;IACG,mBAAmB,CAAC,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAcrE;;;;;;;;;;;OAWG;IACG,2BAA2B,CAChC,SAAS,EAAE,oBAAoB,EAC/B,UAAU,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAyF9D;;;;;;;;;;OAUG;IACG,yBAAyB,CAC9B,SAAS,EAAE,oBAAoB,EAC/B,UAAU,GAAE,UAAwB,GAClC,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAmD9D;;;;;;;OAOG;IACG,kBAAkB,CACvB,SAAS,EAAE,oBAAoB,EAC/B,UAAU,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAW9D,uGAAuG;IACvG,YAAY,IAAI,MAAM;IAItB;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,EACf,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EACtB,SAAS,EAAE,MAAM,GACf,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAcpB;;;;;;OAMG;IACH,2BAA2B,CAC1B,KAAK,EAAE,MAAM,GAAG,UAAU,EAC1B,IAAI,EAAE,cAAc,GAClB,IAAI;IAeP;;;;OAIG;IACI,uBAAuB,CAAC,aAAa,EAAE,UAAU,GAAG,IAAI;IAY/D,+EAA+E;IACxE,eAAe,IAAI,MAAM;IAIhC;;;;;;;;;OASG;IACU,+BAA+B,CAC3C,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,eAAe,GACrB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;OAKG;IACI,aAAa,IAAI,MAAM;IAoB9B;;;;;;;OAOG;IACH,OAAO,CAAC,wBAAwB;IAYhC;;;;OAIG;IACI,iCAAiC,IAAI,MAAM;CAMlD"}