@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/client/rest/public.js

@@ -0,0 +1,502 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadExchangeResponseFromApiIfNeeded = exports.RestPublicClient = void 0;
+const tslib_1 = require("tslib");
+const http = tslib_1.__importStar(require("http"));
+const https = tslib_1.__importStar(require("https"));
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const _constants_1 = require("#constants");
+const _utils_1 = require("#utils");
+/**
+ * The {@link RestPublicClient} is used to make public requests to the Katana Perps API.  It does not require
+ * any special options to access.
+ *
+ * - An {@link RestPublicClientOptions.apiKey apiKey} can be provided
+ *   to increase rate limits.
+ * - Optionally, a {@link RestPublicClientOptions.sandbox sandbox} option can
+ *   be set to `true` in order to point to the Katana Perps Sandbox API.
+ *
+ * @example
+ * ```typescript
+ * import { RestPublicClient } from '@katanaperps/katana-perps-sdk';
+ *
+ * // works without any options
+ * // const publicClient = new RestPublicClient();
+ *
+ * const publicClient = new RestPublicClient({
+ *   sandbox: true,
+ *   // Optionally provide an API key to increase rate limits
+ *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ * });
+ *
+ * const tickers = await publicClient.getTickers('ETH-USD');
+ * console.log('Tickers: ', tickers);
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html)
+ * @see options  {@link RestPublicClientOptions}
+ *
+ * @category API Clients
+ * @category KatanaPerps - Get Time
+ * @category KatanaPerps - Get Ping
+ * @category KatanaPerps - Get Exchange
+ * @category KatanaPerps - Get Gas Fees
+ * @category KatanaPerps - Get Markets
+ * @category KatanaPerps - Get Tickers
+ * @category KatanaPerps - Get Candles
+ * @category KatanaPerps - Get Trades
+ * @category KatanaPerps - Get OrderBook
+ * @category KatanaPerps - Get Liquidations
+ * @category KatanaPerps - Get Funding Rates
+ */
+class RestPublicClient {
+    /**
+     * The {@link RestPublicClient} is used to make public requests to the Katana Perps API.  It does not require
+     * any special options to access.
+     *
+     * - An {@link RestPublicClientOptions.apiKey apiKey} can be provided
+     *   to increase rate limits.
+     * - Optionally, a {@link RestPublicClientOptions.sandbox sandbox} option can
+     *   be set to `true` in order to point to the Katana Perps Sandbox API.
+     *
+     * @param options
+     *  Options for configuring the RestPublicClient
+     *
+     * @example
+     * ```typescript
+     * import { RestPublicClient } from '@katanaperps/katana-perps-sdk';
+     *
+     * // works without any options
+     * // const publicClient = new RestPublicClient();
+     *
+     * const publicClient = new RestPublicClient({
+     *   sandbox: true,
+     *   // Optionally provide an API key to increase rate limits
+     *   apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+     * });
+     *
+     * const tickers = await publicClient.getTickers('ETH-USD');
+     * console.log('Tickers: ', tickers);
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html)
+     * @see options  {@link RestPublicClientOptions}
+     *
+     * @category Constructor
+     */
+    constructor(options = {}) {
+        const { sandbox = false } = options;
+        const baseURL = (0, _utils_1.deriveBaseURL)({
+            sandbox,
+            api: 'rest',
+            overrideBaseURL: options.baseURL ?? options.axiosConfig?.baseURL,
+        });
+        if (!baseURL) {
+            throw new Error(`Invalid configuration, baseURL could not be derived (sandbox? ${String(sandbox)})`);
+        }
+        this.#axiosConfig = Object.freeze({
+            paramsSerializer(params) {
+                return (0, _utils_1.sanitizeSearchParams)(params ?? {}).toString();
+            },
+            ...(_utils_1.isNode ?
+                {
+                    httpAgent: options.axiosConfig?.httpAgent ??
+                        new http.Agent({ keepAlive: true }),
+                    httpsAgent: options.axiosConfig?.httpsAgent ??
+                        new https.Agent({ keepAlive: true }),
+                }
+                : {}),
+            ...(options.axiosConfig ?? {}),
+            baseURL,
+            headers: {
+                ...(options.apiKey ?
+                    {
+                        [_constants_1.REST_API_KEY_HEADER]: options.apiKey,
+                    }
+                    : {}),
+                ...(options.axiosConfig?.headers ?? {}),
+            },
+        });
+        this.axios = axios_1.default.create(this.#axiosConfig);
+    }
+    #realtime = false;
+    /**
+     * Tests connectivity to the REST API
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/ping`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#ping)
+     * @see response {@link katanaperps.RestResponseGetPing RestResponseGetPing}
+     *
+     * @category Utility
+     */
+    async ping() {
+        return this.get('/ping');
+    }
+    /**
+     * Returns the current server time
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/time`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getServerTime)
+     * @see response {@link katanaperps.RestResponseGetTime RestResponseGetTime}
+     *
+     * @returns An object with the current server time in `UTC`
+     *
+     * @category Utility
+     */
+    async getServerTime() {
+        return this.get('/time');
+    }
+    /**
+     * Returns basic information about the exchange.
+     *
+     * - Some of the returned parmeters can be used to configure contract calls
+     *   required for other methods.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/exchange`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @returns
+     * > An object matching {@link katanaperps.KatanaPerpsExchange KatanaPerpsExchange} providing properties relating
+     * to the exchange.
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getExchange)
+     * @see response {@link katanaperps.RestResponseGetExchange RestResponseGetExchange}
+     *
+     * @category Exchange Data
+     */
+    async getExchange() {
+        return this.get('/exchange');
+    }
+    /**
+     * Returns estimated gas fees by bridge and target chain
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/gasFees`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getGasFees)
+     * @see response {@link katanaperps.RestResponseGetGasFees RestResponseGetGasFees}
+     * @see type     {@link katanaperps.KatanaPerpsGasFees KatanaPerpsGasFees}
+     *
+     * @category Exchange Data
+     */
+    async getGasFees() {
+        return this.get('/gasFees');
+    }
+    /**
+     * Returns information about the currently listed markets
+     *
+     * - Optionally filter for a specific market by providing a `market` request
+     *   parameter.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/markets`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getMarkets)
+     * @see request  {@link katanaperps.RestRequestGetMarkets RestRequestGetMarkets}
+     * @see response {@link katanaperps.RestResponseGetMarkets RestResponseGetMarkets}
+     * @see type     {@link katanaperps.KatanaPerpsMarket KatanaPerpsMarket}
+     *
+     * @category Exchange Data
+     */
+    async getMarkets(params) {
+        return this.get('/markets', params);
+    }
+    // Market Data Endpoints
+    /**
+     * Returns market statistics for the trailing 24-hour period
+     *
+     * - **TIP:** Automatic ticker updates are avilable via the WebSocket API tickers subscription,
+     *   which is both faster and more efficient than polling this endpoint!
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/tickers`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getTickers)
+     * @see request  {@link katanaperps.RestRequestGetTickers RestRequestGetTickers}
+     * @see response {@link katanaperps.RestResponseGetTickers RestResponseGetTickers}
+     * @see type     {@link katanaperps.KatanaPerpsTicker KatanaPerpsTicker}
+     *
+     * @category Exchange Data
+     */
+    async getTickers(params) {
+        return this.get('/tickers', params);
+    }
+    /**
+     * Returns candle (OHLCV) data for a market
+     *
+     * - For autocompletion and inline documentation, use the {@link katanaperps.CandleInterval CandleInterval} enum
+     *   when specifying the `interval` property (see example)
+     * - **TIP:** Automatic candle updates are avilable via the WebSocket API candles subscription,
+     *   which is both faster and more efficient than polling this endpoint!
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/candles`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPagination.start start},
+     * > {@link katanaperps.RestRequestPagination.end end},
+     * > {@link katanaperps.RestRequestPagination.limit limit}
+     * ---
+     *
+     * @example
+     * ```typescript
+     * import { RestPublicClient, CandleInterval } from '@katanaperps/katana-perps-sdk';
+     *
+     * const client = new RestPublicClient();
+     *
+     * const candles = await client.getCandles({
+     *  market: 'ETH-USD',
+     *  interval: CandleInterval.ONE_MINUTE
+     * })
+     * ```
+     *
+     * <br />
+     *
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getCandles)
+     * @see request  {@link katanaperps.RestRequestGetCandles RestRequestGetCandles}
+     * @see response {@link katanaperps.RestResponseGetCandles RestResponseGetCandles}
+     * @see type     {@link katanaperps.KatanaPerpsCandle KatanaPerpsCandle}
+     *
+     * @category Exchange Data
+     */
+    async getCandles(params) {
+        return this.get('/candles', params);
+    }
+    /**
+     * Returns trade data for a market. In this documentation, "trades" refers to public information about trades, whereas "fills" refers to detailed non-public information about trades resulting from orders placed by the API account.
+     *
+     * - **TIP:** Automatic trades updates are available via the WebSocket API trades subscription,
+     *   which is both faster and more efficient than polling this endpoint!
+     * - **TIP:** There is also a call on the authenticated client {@link katanaPerps.RestAuthenticatedClient.getFills RestAuthenticatedClient.getFills}
+     *   which includes the {@link katanaperps.KatanaPerpsFill KatanaPerpsFill} properties, if required.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/trades`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getTrades)
+     * @see request  {@link katanaperps.RestRequestGetTrades RestRequestGetTrades}
+     * @see response {@link katanaperps.RestResponseGetTrades RestResponseGetTrades}
+     * @see type     {@link katanaperps.KatanaPerpsTrade KatanaPerpsTrade}
+     * @see related  {@link katanaPerps.RestAuthenticatedClient.getFills RestAuthenticatedClient.getFills}
+     *
+     * @category Exchange Data
+     */
+    async getTrades(params) {
+        return this.get('/trades', params);
+    }
+    /**
+     * Returns a level-1 order book of a market.
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/orderbook`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPagination.limit limit},
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getOrderBookLevel1)
+     * @see request  {@link katanaperps.RestRequestGetOrderBookLevel1 RestRequestGetOrderBookLevel1}
+     * @see response {@link katanaperps.RestResponseGetOrderBookLevel1 RestResponseGetOrderBookLevel1}
+     * @see related  {@link getOrderBookLevel2 client.getOrderBookLevel2}
+     *
+     * @category Exchange Data
+     */
+    async getOrderBookLevel1(params) {
+        return this.get('/orderbook', {
+            ...params,
+            level: 1,
+        });
+    }
+    /**
+     * Get current order book price levels for a market
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/orderbook`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPagination.limit limit},
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getOrderBookLevel2)
+     * @see request  {@link katanaperps.RestRequestGetOrderBookLevel2 RestRequestGetOrderBookLevel2}
+     * @see response {@link katanaperps.RestResponseGetOrderBookLevel2 RestResponseGetOrderBookLevel2}
+     * @see related  {@link getOrderBookLevel1 client.getOrderBookLevel1}
+     *
+     * @category Exchange Data
+     */
+    async getOrderBookLevel2(params) {
+        return this.get('/orderbook', {
+            ...params,
+            level: 2,
+        });
+    }
+    /**
+     * Get liquidations for a market
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/liquidations`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.fromId fromId}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getLiquidations)
+     * @see request  {@link katanaperps.RestRequestGetLiquidations RestRequestGetLiquidations}
+     * @see response {@link katanaperps.RestResponseGetLiquidations RestResponseGetLiquidations}
+     * @see type     {@link katanaperps.KatanaPerpsLiquidation KatanaPerpsLiquidation}
+     *
+     * @category Exchange Data
+     */
+    async getLiquidations(params) {
+        return this.get('/liquidations', params);
+    }
+    /**
+     * Get Funding Rates
+     *
+     * ---
+     * **Endpoint Parameters**
+     *
+     * > - **HTTP Request**:      `GET /v1/fundingRates`
+     * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
+     * > - **API Key Scope:**     [None](https://api-docs-v1-perps.katana.network/#api-keys)
+     * > - **Pagination:**
+     * > {@link katanaperps.RestRequestPaginationWithFromId.start start},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.end end},
+     * > {@link katanaperps.RestRequestPaginationWithFromId.limit limit}
+     * ---
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/RestPublicClient.html#getFundingRates)
+     * @see request  {@link katanaperps.RestRequestGetFundingRates RestRequestGetFundingRates}
+     * @see response {@link katanaperps.RestResponseGetFundingRates RestResponseGetFundingRates}
+     * @see type     {@link katanaperps.KatanaPerpsFundingRate KatanaPerpsFundingRate}
+     *
+     * @category Exchange Data
+     */
+    async getFundingRates(params) {
+        return this.get('/fundingRates', params);
+    }
+    /**
+     * - All requests within the internal symbol are undocumented internal methods which may change or be removed without notice.
+     * - API handling of the parameters used within these methods is likely to change without notice without changes to the SDK to match.
+     * - These methods or parameters may require additional permissions to use and result in errors or blocking of your request if used.
+     * - If you need to use these methods for your use case, please contact support to discuss your requirements before using them.
+     *
+     * @internal
+     */
+    [_utils_1.INTERNAL_SYMBOL] = Object.freeze({
+        realtime: () => {
+            this.#realtime = true;
+        },
+    });
+    // Internal methods exposed for advanced usage.
+    async get(endpoint, params, axiosConfig = {}) {
+        return (await this.request(endpoint, {
+            ...axiosConfig,
+            method: 'GET',
+            url: endpoint,
+            params: new URLSearchParams(params),
+        })).data;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    request(endpoint, config) {
+        const request = {
+            ...config,
+            headers: config.headers ?? {},
+            url: endpoint,
+        };
+        if (this.#realtime && !request.headers['KP-Web-Client']) {
+            request.headers['KP-Web-Client'] = 'realtime-sdk';
+        }
+        return this.axios(request);
+    }
+    axios;
+    #axiosConfig;
+}
+exports.RestPublicClient = RestPublicClient;
+const EXCHANGE_RESPONSE_CACHE_DURATION_MS = 300_000;
+let cachedExchangeResponse;
+let exchangeResponseCachedAt = 0;
+async function loadExchangeResponseFromApiIfNeeded(opts) {
+    const client = new RestPublicClient(opts);
+    const now = Date.now();
+    const cachedValueIsStale = now - exchangeResponseCachedAt > EXCHANGE_RESPONSE_CACHE_DURATION_MS;
+    const exchange = !cachedExchangeResponse || cachedValueIsStale ?
+        await client.getExchange()
+        : cachedExchangeResponse;
+    cachedExchangeResponse = exchange;
+    exchangeResponseCachedAt =
+        cachedValueIsStale ? now : exchangeResponseCachedAt;
+    return [exchange, client];
+}
+exports.loadExchangeResponseFromApiIfNeeded = loadExchangeResponseFromApiIfNeeded;

package/dist/client/webSocket/guards.d.ts

@@ -0,0 +1,15 @@
+import { type KatanaPerpsSubscribeTypeAuthenticated, type KatanaPerpsSubscribeTypePublic, type KatanaPerpsSubscribeType, type WebSocketClientOptionsPublicOnly, type WebSocketClientOptionsWithAPIKey, type WebSocketClientOptionsWithFetch, type WebSocketClientOptionsBase, type WebSocketSubscriptionShortNameAuthenticated, type WebSocketSubscriptionShortNamePublic } from '#types/webSocket/index';
+/**
+ * @internal
+ *
+ * A type guard that checks if a given value is a subscription object which represents
+ * an authenticated subscription. These subscriptions require the `wallet` property
+ * (local to katana-perps-sdk only) and require that the `WebSocketClient` was created
+ * with the `websocketAuthTokenFetch` function provided.
+ */
+export declare function isWebSocketAuthenticatedSubscription(subscription: KatanaPerpsSubscribeType | WebSocketSubscriptionShortNameAuthenticated | WebSocketSubscriptionShortNamePublic, walletAuthAvailable?: boolean): subscription is KatanaPerpsSubscribeTypeAuthenticated;
+export declare function isWebSocketPublicSubscription(subscription: KatanaPerpsSubscribeType | WebSocketSubscriptionShortNamePublic | WebSocketSubscriptionShortNameAuthenticated): subscription is KatanaPerpsSubscribeTypePublic;
+export declare function isWebSocketOptionsPublicOnly(options: WebSocketClientOptionsBase): options is WebSocketClientOptionsPublicOnly;
+export declare function isWebSocketOptionsAutoFetch(options: WebSocketClientOptionsBase): options is WebSocketClientOptionsWithAPIKey;
+export declare function isWebSocketOptionsCustomFetch(options: WebSocketClientOptionsBase): options is WebSocketClientOptionsWithFetch;
+//# sourceMappingURL=guards.d.ts.map

package/dist/client/webSocket/guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../../src/client/webSocket/guards.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,qCAAqC,EAC1C,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACrC,KAAK,gCAAgC,EACrC,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,2CAA2C,EAChD,KAAK,oCAAoC,EAG1C,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;GAOG;AACH,wBAAgB,oCAAoC,CAClD,YAAY,EACR,wBAAwB,GACxB,2CAA2C,GAC3C,oCAAoC,EACxC,mBAAmB,GAAE,OAAe,GACnC,YAAY,IAAI,qCAAqC,CAWvD;AAED,wBAAgB,6BAA6B,CAC3C,YAAY,EACR,wBAAwB,GACxB,oCAAoC,GACpC,2CAA2C,GAC9C,YAAY,IAAI,8BAA8B,CAOhD;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,0BAA0B,GAClC,OAAO,IAAI,gCAAgC,CAE7C;AAED,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,0BAA0B,GAClC,OAAO,IAAI,gCAAgC,CAE7C;AAED,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,0BAA0B,GAClC,OAAO,IAAI,+BAA+B,CAE5C"}

package/dist/client/webSocket/guards.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWebSocketOptionsCustomFetch = exports.isWebSocketOptionsAutoFetch = exports.isWebSocketOptionsPublicOnly = exports.isWebSocketPublicSubscription = exports.isWebSocketAuthenticatedSubscription = void 0;
+const index_1 = require("#types/webSocket/index");
+/**
+ * @internal
+ *
+ * A type guard that checks if a given value is a subscription object which represents
+ * an authenticated subscription. These subscriptions require the `wallet` property
+ * (local to katana-perps-sdk only) and require that the `WebSocketClient` was created
+ * with the `websocketAuthTokenFetch` function provided.
+ */
+function isWebSocketAuthenticatedSubscription(subscription, walletAuthAvailable = false) {
+    const name = typeof subscription === 'string' ? subscription : subscription?.name;
+    if (name === 'webclient') {
+        return walletAuthAvailable;
+    }
+    return index_1.WebSocketSubscriptionShortNamesAuthenticated.includes(name);
+}
+exports.isWebSocketAuthenticatedSubscription = isWebSocketAuthenticatedSubscription;
+function isWebSocketPublicSubscription(subscription) {
+    const name = typeof subscription === 'string' ? subscription : subscription?.name;
+    return index_1.WebSocketSubscriptionShortNamesPublic.includes(name);
+}
+exports.isWebSocketPublicSubscription = isWebSocketPublicSubscription;
+function isWebSocketOptionsPublicOnly(options) {
+    return !options.auth && !options.wallet && !options.websocketAuthTokenFetch;
+}
+exports.isWebSocketOptionsPublicOnly = isWebSocketOptionsPublicOnly;
+function isWebSocketOptionsAutoFetch(options) {
+    return !!options.auth && !options.websocketAuthTokenFetch;
+}
+exports.isWebSocketOptionsAutoFetch = isWebSocketOptionsAutoFetch;
+function isWebSocketOptionsCustomFetch(options) {
+    return !!options.websocketAuthTokenFetch && !options.auth && !!options.wallet;
+}
+exports.isWebSocketOptionsCustomFetch = isWebSocketOptionsCustomFetch;