@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/webSocket/request/request.d.ts

@@ -0,0 +1,137 @@
+import type { WebSocketRequestMethod, SubscriptionNameAuthenticated, SubscriptionNamePublic } from '#types/enums/index';
+import type { WebSocketRequestUnsubscribeSubscription, KatanaPerpsSubscribeTypeAuthenticated, KatanaPerpsSubscribeTypePublic, KatanaPerpsSubscribeType } from '#types/webSocket/index';
+/**
+ * [[include:base.md]]
+ *
+ * @category Base Types
+ */
+interface WebSocketRequestBase {
+    /**
+     * The request that is being made matching the enum {@link WebSocketRequestMethod}
+     */
+    method: WebSocketRequestMethod;
+    /**
+     * Requests may optionally provide a `cid` parameter to identify the request a response should be associated with.
+     *
+     * - When provided, the `onResponse` callback object will include the provided `cid` as a property.
+     */
+    cid?: string;
+    /**
+     * A top-level `markets` array can be used to allow multiple subscriptions to inherit this array without having define them themselves.
+     *
+     * - When a subscription does not define the `markets` parameter, it will inherit the top-level
+     *   `markets` array provided here.
+     */
+    markets?: string[];
+}
+/**
+ * The base type which is a superset of all possible parameters and subscriptions that can
+ * be made to the WebSocket API.
+ *
+ * @see related {@link WebSocketRequestSubscribeStrictWithTopLevelMarkets}
+ * @see related {@link WebSocketRequestSubscribeStrictWithoutTopLevelMarkets}
+ *
+ * @category WebSocket - Subscribe
+ */
+export interface WebSocketRequestSubscribe extends WebSocketRequestBase {
+    /**
+     * The `subscribe` method is used to subscribe to a list of {@link subscriptions} based on
+     * your provided parameters.
+     */
+    method: typeof WebSocketRequestMethod.subscribe;
+    token?: string;
+    /**
+     * - **When top-level markets is provided:**
+     *   - we can accept string subscription names or full subscriptions
+     *     and the subscriptions markets parameter is optional.
+     *   - `candles` may never be provided as a name-string as it has a
+     *     required `interval` parameter.
+     * - **when top level markets property is not provided:**
+     *   - all unauthenticated subscriptions require the markets array so may not be defined only
+     *     by their name.
+     *   - authenticated subscriptions may still be defined by name
+     */
+    subscriptions: KatanaPerpsSubscribeType[];
+}
+/**
+ * When providing a top-level {@link markets} parameter, we can accept subscriptions using a short-hand
+ * of the subscription name only.
+ *
+ * - If a subscription does not provide its own `markets` parameter, it will inherit the top-level
+ *   markets array provided.
+ *
+ * @see base    {@link WebSocketRequestSubscribe}
+ * @see related {@link WebSocketRequestSubscribeStrictWithoutTopLevelMarkets}
+ *
+ * @category WebSocket - Subscribe
+ */
+export interface WebSocketRequestSubscribeStrictWithTopLevelMarkets extends WebSocketRequestSubscribe {
+    /**
+     * @inheritDoc
+     */
+    markets: string[];
+}
+/**
+ * When providing a top-level {@link markets} parameter, we can accept subscriptions using a short-hand
+ * of the subscription name only.
+ *
+ * - If a subscription does not provide its own `markets` parameter, it will inherit the top-level
+ *   markets array provided.
+ *
+ * @see base    {@link WebSocketRequestSubscribe}
+ * @see related {@link WebSocketRequestSubscribeStrictWithTopLevelMarkets}
+ *
+ * @category WebSocket - Subscribe
+ */
+export interface WebSocketRequestSubscribeStrictWithoutTopLevelMarkets extends WebSocketRequestSubscribe {
+    markets?: undefined;
+    /**
+     * @inheritDoc
+     */
+    subscriptions: ((KatanaPerpsSubscribeTypePublic & {
+        /**
+         * - When a top-level markets is not provided, all public subscriptions require a markets
+         *   array.
+         */
+        markets: string[];
+    }) | KatanaPerpsSubscribeTypeAuthenticated)[];
+}
+/**
+ * @see union {@link WebSocketRequestSubscribeStrictWithTopLevelMarkets}
+ * @see union {@link WebSocketRequestSubscribeStrictWithoutTopLevelMarkets}
+ */
+export type WebSocketRequestSubscribeStrict = WebSocketRequestSubscribeStrictWithTopLevelMarkets | WebSocketRequestSubscribeStrictWithoutTopLevelMarkets;
+/**
+ * UnsubscribeRequest
+ *
+ * - When removing a subscription, you need only provide the `name` of the subscription
+ *   rather than a complete subscription object.
+ *
+ * @category WebSocket - Unsubscribe
+ */
+export interface WebSocketRequestUnsubscribe extends WebSocketRequestBase {
+    /**
+     * @inheritDoc
+     */
+    method: typeof WebSocketRequestMethod.unsubscribe;
+    /**
+     * An array of subscription objects to unsubscribe from
+     */
+    subscriptions?: (WebSocketRequestUnsubscribeSubscription | SubscriptionNamePublic | SubscriptionNameAuthenticated)[];
+}
+/**
+ * Requests all current subscriptions active on the WebSocket session.
+ */
+export interface WebSocketRequestSubscriptionsList extends WebSocketRequestBase {
+    /**
+     * A `subscriptions` request will provide a response with a list of all current subscriptions for the client.
+     */
+    method: typeof WebSocketRequestMethod.subscriptions;
+}
+export type WebSocketRequestStrict = WebSocketRequestSubscribeStrict | WebSocketRequestSubscriptionsList | WebSocketRequestUnsubscribe;
+/**
+ * A type representing all current requests that can be made to the WebSocket API.
+ */
+export type WebSocketRequest = WebSocketRequestSubscribe | WebSocketRequestSubscriptionsList | WebSocketRequestUnsubscribe;
+export {};
+//# sourceMappingURL=request.d.ts.map

package/dist/types/webSocket/request/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/request/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,6BAA6B,EAC7B,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,uCAAuC,EACvC,qCAAqC,EACrC,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAEhC;;;;GAIG;AACH,UAAU,oBAAoB;IAC5B;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE;;;OAGG;IACH,MAAM,EAAE,OAAO,sBAAsB,CAAC,SAAS,CAAC;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,aAAa,EAAE,wBAAwB,EAAE,CAAC;CAC3C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kDACf,SAAQ,yBAAyB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qDACf,SAAQ,yBAAyB;IACjC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,CACX,CAAC,8BAA8B,GAAG;QAChC;;;WAGG;QACH,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC,GACF,qCAAqC,CACxC,EAAE,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GACvC,kDAAkD,GAClD,qDAAqD,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;IACvE;;OAEG;IACH,MAAM,EAAE,OAAO,sBAAsB,CAAC,WAAW,CAAC;IAClD;;OAEG;IACH,aAAa,CAAC,EAAE,CACZ,uCAAuC,GACvC,sBAAsB,GACtB,6BAA6B,CAChC,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,iCACf,SAAQ,oBAAoB;IAC5B;;OAEG;IACH,MAAM,EAAE,OAAO,sBAAsB,CAAC,aAAa,CAAC;CACrD;AAED,MAAM,MAAM,sBAAsB,GAC9B,+BAA+B,GAC/B,iCAAiC,GACjC,2BAA2B,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,yBAAyB,GACzB,iCAAiC,GACjC,2BAA2B,CAAC"}

package/dist/types/webSocket/request/request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/request/subscriptions.d.ts

@@ -0,0 +1,498 @@
+import type { CandleInterval, SubscriptionNameAuthenticated, SubscriptionNamePublic, MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsEventBase } from '#types/webSocket/base';
+import type * as ResponseTypes from '#types/webSocket/response/index';
+/**
+ * All the messages which may result from the corresponding WebSocket subscription.
+ */
+export type KatanaPerpsSubscriptionEvent = ResponseTypes.KatanaPerpsTickerEvent | ResponseTypes.KatanaPerpsTradeEvent | ResponseTypes.KatanaPerpsLiquidationEvent | ResponseTypes.KatanaPerpsCandleEvent | ResponseTypes.KatanaPerpsOrderBookLevel1Event | ResponseTypes.KatanaPerpsOrderBookLevel2Event | ResponseTypes.KatanaPerpsOrderEvent | ResponseTypes.KatanaPerpsDepositEvent | ResponseTypes.KatanaPerpsWithdrawalEvent | ResponseTypes.KatanaPerpsPositionEvent | ResponseTypes.KatanaPerpsFundingPaymentEvent | ResponseTypes.KatanaPerpsWebClientEvent;
+/**
+ * @internal
+ *
+ * Short-hand response payloads
+ */
+export type WebSocketResponseSubscriptionMessageShort = ResponseTypes.WebSocketResponseSubscriptionMessageShortTickers | ResponseTypes.WebSocketResponseSubscriptionMessageShortTrades | ResponseTypes.WebSocketResponseSubscriptionMessageShortLiquidations | ResponseTypes.WebSocketResponseSubscriptionMessageShortCandles | ResponseTypes.WebSocketResponseSubscriptionMessageShortL1Orderbook | ResponseTypes.WebSocketResponseSubscriptionMessageShortL2Orderbook | ResponseTypes.WebSocketResponseSubscriptionMessageShortOrders | ResponseTypes.WebSocketResponseSubscriptionMessageShortDeposits | ResponseTypes.WebSocketResponseSubscriptionMessageShortWithdrawals | ResponseTypes.WebSocketResponseSubscriptionMessageShortPositions | ResponseTypes.WebSocketResponseSubscriptionMessageShortFundingPayments | ResponseTypes.WebSocketResponseSubscriptionMessageShortWebClient;
+/**
+ * When an error occurs during evaluation by the WebSocket Server, this
+ * error message will be provided to the message handler.
+ */
+export interface KatanaPerpsErrorEvent extends KatanaPerpsEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.error;
+    /**
+     * @inheritDoc
+     */
+    data: {
+        /**
+         * error short code
+         */
+        code: string;
+        /**
+         * human readable error message
+         */
+        message: string;
+    };
+}
+/**
+ * Subscriptions Response
+ */
+export interface KatanaPerpsSubscriptionsListEvent extends KatanaPerpsEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.subscriptions;
+    data?: undefined;
+    /**
+     * @inheritDoc
+     *
+     * @see type {@link KatanaPerpsSubscribeType}
+     */
+    subscriptions: KatanaPerpsSubscribeType[];
+}
+/**
+ * The possible WebSocket messages that should be handled by the WebSocketClient's `onMessage` handler.
+ *
+ * @see related {@link KatanaPerpsErrorEvent}
+ * @see related {@link KatanaPerpsSubscriptionsListEvent}
+ * @see related {@link KatanaPerpsSubscriptionEvent}
+ */
+export type KatanaPerpsMessageEvent = KatanaPerpsErrorEvent | KatanaPerpsSubscriptionsListEvent | KatanaPerpsSubscriptionEvent;
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * - All WebSocket subscriptions are based upon this interface, which provides for
+ *   appropriate type narrowing based on the subscription being requested.
+ *
+ * @see docs [WebSocket API Docs](https://api-docs-v1-perps.katana.network/#websocket-api-interaction)
+ *
+ * @category Base Types
+ */
+interface KatanaPerpsSubscribeBase {
+    /**
+     * Subscription to subscribe to.
+     *
+     * @see related {@link SubscriptionNamePublic}
+     * @see related {@link SubscriptionNameAuthenticated}
+     */
+    name: SubscriptionNamePublic | SubscriptionNameAuthenticated;
+    /**
+     * Array of Market Symbols
+     *
+     * - Overrides the markets array at the top-level subscription object, if provided.
+     * - Required if the top-level subscription does not define `markets`
+     *   and the request is a {@link KatanaPerpsSubscribeTypePublic public subscription}
+     */
+    markets?: string[] | undefined;
+    /**
+     * Candle Interval to subscribe to
+     *
+     * - Only applicable for {@link SubscriptionNamePublic.candles candles} subscription
+     *
+     * @see enum {@link CandleInterval}
+     */
+    interval?: CandleInterval;
+}
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * A Base type that all authenticated WebSocket subscriptions extend upon.
+ *
+ * @see names   {@link SubscriptionNameAuthenticated}
+ * @see related {@link KatanaPerpsSubscribeTypeAuthenticated}
+ *
+ * @category Base Types
+ */
+export interface KatanaPerpsSubscribeAuthenticatedBase extends KatanaPerpsSubscribeBase {
+    /**
+     * @inheritDoc
+     */
+    name: SubscriptionNameAuthenticated;
+    markets?: undefined;
+    interval?: undefined;
+}
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * A Base type that all public WebSocket subscriptions extend upon.
+ *
+ * @see names   {@link SubscriptionNamePublic}
+ * @see related {@link KatanaPerpsSubscribeTypePublic}
+ *
+ * @category Base Types
+ */
+export interface KatanaPerpsSubscribePublicBase extends KatanaPerpsSubscribeBase {
+    /**
+     * @inheritDoc
+     */
+    name: SubscriptionNamePublic;
+    /**
+     * @inheritDoc
+     */
+    markets?: string[];
+    /**
+     * @inheritDoc
+     */
+    interval?: CandleInterval;
+}
+/**
+ * Provides ticker data updates for a market.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.tickers tickers}
+ * > - **Authentication:**     **None**
+ * > - **Update Speed:**       1 second
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets}
+ * ---
+ *
+ * @see docs [Tickers Subscription API Documentation](https://api-docs-v1-perps.katana.network/#tickers)
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Tickers
+ */
+export interface KatanaPerpsSubscribeTickers extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.tickers;
+    interval?: undefined;
+}
+/**
+ * Provides candle (OHLCV) data updates for a market.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.candles candles}
+ * > - **Authentication:**     None
+ * > - **Update Speed:**       1 second
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets},
+ *   {@link CandleInterval interval}
+ * ---
+ *
+ * @see docs [Candles Subscription API Documentation](https://api-docs-v1-perps.katana.network/#candles)
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Candles
+ */
+export interface KatanaPerpsSubscribeCandles extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.candles;
+    /**
+     * @inheritDoc
+     */
+    interval: CandleInterval;
+}
+/**
+ * Provides real-time 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 authenticated API account.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.trades trades}
+ * > - **Authentication:**     None
+ * > - **Update Speed:**       Real-time
+ * >  - updates on new trades
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets}
+ * ---
+ *
+ * @see docs [Trades Subscription API Documentation](https://api-docs-v1-perps.katana.network/#trades)
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Trades
+ */
+export interface KatanaPerpsSubscribeTrades extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.trades;
+    interval?: undefined;
+}
+/**
+ * Provides real-time liquidation data for a market.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.liquidations liquidations}
+ * > - **Authentication:**     None
+ * > - **Update Speed:**       Real-time
+ * >   - updates on new liquidations
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets}
+ * ---
+ *
+ * @see docs [Liquidations Subscription API Documentation](https://api-docs-v1-perps.katana.network/#liquidations)
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Liquidations
+ */
+export interface KatanaPerpsSubscribeLiquidations extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.liquidations;
+    interval?: undefined;
+}
+/**
+ * Provides real-time **Level-1** order book data for a market.
+ *
+ * - {@link KatanaPerpsSubscribeOrderBookLevel1 Level-1} order book data is limited to the best bid and ask
+ *   for a market.
+ * - {@link KatanaPerpsSubscribeOrderBookLevel2 Level-2} order book data includes `price` and `quantity` information
+ *   for all limit order price levels in the order book.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.l1orderbook l1orderbook}
+ * > - **Authentication:**     None
+ * > - **Update Speed:**       Real-time
+ * >   - updates on new best ask, best bid, or related quantities
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets}
+ * ---
+ *
+ * @see docs    [OrderBook Level 1 Subscription API Documentation](https://api-docs-v1-perps.katana.network/#l1-order-book)
+ * @see related {@link KatanaPerpsSubscribeOrderBookLevel2}
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface KatanaPerpsSubscribeOrderBookLevel1 extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.l1orderbook;
+    interval?: undefined;
+}
+/**
+ * Provides real-time **Level-2** order book data for a market.
+ *
+ * - {@link KatanaPerpsSubscribeOrderBookLevel1 Level-1} order book data is limited to the best `bid` and `ask`
+ *   for a market.
+ * - {@link KatanaPerpsSubscribeOrderBookLevel2 Level-2} order book data includes `price` and `quantity` information
+ *   for all limit order price levels in the order book.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNamePublic.l2orderbook l2orderbook}
+ * > - **Authentication:**     None
+ * > - **Update Speed:**       Real-time
+ * >   - updates on any order book change
+ * > - **Required Parameters:**
+ *   {@link KatanaPerpsSubscribePublicBase.markets markets}
+ * ---
+ *
+ * @see docs    [OrderBook Level 2 Subscription API Documentation](https://api-docs-v1-perps.katana.network/#l2-order-book)
+ * @see related {@link KatanaPerpsSubscribeOrderBookLevel1}
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get OrderBook
+ */
+export interface KatanaPerpsSubscribeOrderBookLevel2 extends KatanaPerpsSubscribePublicBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNamePublic.l2orderbook;
+    interval?: undefined;
+}
+/**
+ * @internal
+ */
+export interface KatanaPerpsSubscribeWebClient extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.webclient;
+}
+/**
+ * Provides real-time updates on orders issued by a wallet.
+ *
+ * - Detailed order execution information is only available to the placing wallet.
+ * - This subscription includes granular updates for all order-related
+ *   activity, including placement, cancelation, fills and stop triggers.
+ * - 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.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNameAuthenticated.orders orders}
+ * > - **Authentication:**     **Authenticated**
+ * > - **Update Speed:**       Real-time
+ * >   - updates on any state change of an order placed by the wallet
+ * > - **Request Parameters:** None
+ * ---
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Orders
+ */
+export interface KatanaPerpsSubscribeOrders extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.orders;
+}
+/**
+ * Provides real-time `deposit` information for a wallet.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNameAuthenticated.deposits deposits}
+ * > - **Authentication:**     **Authenticated**
+ * > - **Update Speed:**       Real-time
+ * >   - updates sent on deposit confirmation
+ * > - **Request Parameters:** None
+ * ---
+ *
+ * @see related {@link KatanaPerpsSubscribePositions}
+ * @see related {@link KatanaPerpsSubscribeWithdrawals}
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Deposits
+ */
+export interface KatanaPerpsSubscribeDeposits extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.deposits;
+}
+/**
+ * Provides real-time `withdrawal` information for a wallet.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNameAuthenticated.withdrawals withdrawals}
+ * > - **Authentication:**     **Authenticated**
+ * > - **Update Speed:**       Real-time
+ * >   - updates sent on user withdrawal
+ * > - **Request Parameters:** None
+ * ---
+ *
+ * @see related {@link KatanaPerpsSubscribeDeposits}
+ * @see related {@link KatanaPerpsSubscribePositions}
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Withdrawals
+ */
+export interface KatanaPerpsSubscribeWithdrawals extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.withdrawals;
+}
+/**
+ * Provides real-time `position` information for a wallet.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNameAuthenticated.positions positions}
+ * > - **Authentication:**     **Authenticated**
+ * > - **Update Speed:**       Real-time
+ * >   - updates on any position change of the wallet
+ * > - **Request Parameters:** None
+ * ---
+ *
+ * @see related {@link KatanaPerpsSubscribeDeposits}
+ * @see related {@link KatanaPerpsSubscribeWithdrawals}
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Positions
+ */
+export interface KatanaPerpsSubscribePositions extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.positions;
+}
+/**
+ * Provides real-time `funding payments` information for a wallet.
+ *
+ * ---
+ * **Subscription Parameters**
+ *
+ * > - **Subscription:**       {@link SubscriptionNameAuthenticated.fundingPayments fundingPayments}
+ * > - **Authentication:**     **Authenticated**
+ * > - **Update Speed:**       Real-time
+ * >   - updates on updated funding payments data
+ * > - **Request Parameters:** None
+ * ---
+ *
+ * @category WebSocket - Subscribe
+ * @category KatanaPerps - Get Funding Payments
+ */
+export interface KatanaPerpsSubscribeFundingPayments extends KatanaPerpsSubscribeAuthenticatedBase {
+    /**
+     * @inheritDoc
+     */
+    name: typeof SubscriptionNameAuthenticated.fundingPayments;
+}
+/**
+ * All WebSocket Subscribe types as a union.
+ *
+ * @see related {@link KatanaPerpsSubscribeTypeAuthenticated}
+ * @see related {@link KatanaPerpsSubscribeTypePublic}
+ *
+ * @category WebSocket - Subscribe
+ */
+export type KatanaPerpsSubscribeType = KatanaPerpsSubscribeTypeAuthenticated | KatanaPerpsSubscribeTypePublic;
+/**
+ * - Subscribing to these requires the {@link WebSocketClient} to be constructed with the
+ *   `auth` object.
+ *
+ * @see related {@link KatanaPerpsSubscribeType}
+ * @see related {@link KatanaPerpsSubscribeTypePublic}
+ *
+ * @category WebSocket - Subscribe
+ */
+export type KatanaPerpsSubscribeTypeAuthenticated = KatanaPerpsSubscribeOrders | KatanaPerpsSubscribeDeposits | KatanaPerpsSubscribeWithdrawals | KatanaPerpsSubscribePositions | KatanaPerpsSubscribeFundingPayments | KatanaPerpsSubscribeWebClient;
+/**
+ * All WebSocket Subscribe types which are public and do not require
+ * authentication to subscribe to.
+ *
+ * @see related {@link KatanaPerpsSubscribeType}
+ * @see related {@link KatanaPerpsSubscribeTypeAuthenticated}
+ *
+ * @category WebSocket - Subscribe
+ */
+export type KatanaPerpsSubscribeTypePublic = KatanaPerpsSubscribeTickers | KatanaPerpsSubscribeTrades | KatanaPerpsSubscribeLiquidations | KatanaPerpsSubscribeOrderBookLevel1 | KatanaPerpsSubscribeOrderBookLevel2 | KatanaPerpsSubscribeCandles | KatanaPerpsSubscribeWebClient;
+/**
+ * @category WebSocket - Unsubscribe
+ */
+export type WebSocketRequestUnsubscribeShortNames = SubscriptionNamePublic | SubscriptionNameAuthenticated;
+/**
+ * - Subscription Objects in unsubscribe must have name but all other properties are
+ *   considered optional
+ *
+ * @category WebSocket - Unsubscribe
+ */
+export type WebSocketRequestUnsubscribeSubscription = Partial<KatanaPerpsSubscribeTypePublic | KatanaPerpsSubscribeTypeAuthenticated> & {
+    name: WebSocketRequestUnsubscribeShortNames;
+};
+export {};
+//# sourceMappingURL=subscriptions.d.ts.map

package/dist/types/webSocket/request/subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/request/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,6BAA6B,EAC7B,sBAAsB,EACtB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,KAAK,aAAa,MAAM,iCAAiC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,aAAa,CAAC,sBAAsB,GACpC,aAAa,CAAC,qBAAqB,GACnC,aAAa,CAAC,2BAA2B,GACzC,aAAa,CAAC,sBAAsB,GACpC,aAAa,CAAC,+BAA+B,GAC7C,aAAa,CAAC,+BAA+B,GAC7C,aAAa,CAAC,qBAAqB,GACnC,aAAa,CAAC,uBAAuB,GACrC,aAAa,CAAC,0BAA0B,GACxC,aAAa,CAAC,wBAAwB,GACtC,aAAa,CAAC,8BAA8B,GAC5C,aAAa,CAAC,yBAAyB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GACjD,aAAa,CAAC,gDAAgD,GAC9D,aAAa,CAAC,+CAA+C,GAC7D,aAAa,CAAC,qDAAqD,GACnE,aAAa,CAAC,gDAAgD,GAC9D,aAAa,CAAC,oDAAoD,GAClE,aAAa,CAAC,oDAAoD,GAClE,aAAa,CAAC,+CAA+C,GAC7D,aAAa,CAAC,iDAAiD,GAC/D,aAAa,CAAC,oDAAoD,GAClE,aAAa,CAAC,kDAAkD,GAChE,aAAa,CAAC,wDAAwD,GACtE,aAAa,CAAC,kDAAkD,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,KAAK,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iCACf,SAAQ,oBAAoB;IAC5B;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,aAAa,CAAC;IAC5C,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;;OAIG;IACH,aAAa,EAAE,wBAAwB,EAAE,CAAC;CAC3C;AAED;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAC/B,qBAAqB,GACrB,iCAAiC,GACjC,4BAA4B,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,UAAU,wBAAwB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,sBAAsB,GAAG,6BAA6B,CAAC;IAE7D;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC/B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qCACf,SAAQ,wBAAwB;IAChC;;OAEG;IACH,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,8BACf,SAAQ,wBAAwB;IAChC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,2BACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,OAAO,CAAC;IAC5C,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,2BACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,OAAO,CAAC;IAC5C;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,0BACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,MAAM,CAAC;IAC3C,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gCACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,YAAY,CAAC;IACjD,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,mCACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,WAAW,CAAC;IAChD,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,mCACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,IAAI,EAAE,OAAO,sBAAsB,CAAC,WAAW,CAAC;IAChD,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,6BACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,SAAS,CAAC;CACtD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,0BACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,MAAM,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,4BACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,QAAQ,CAAC;CACrD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,+BACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,WAAW,CAAC;CACxD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,6BACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,SAAS,CAAC;CACtD;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mCACf,SAAQ,qCAAqC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAO,6BAA6B,CAAC,eAAe,CAAC;CAC5D;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,wBAAwB,GAChC,qCAAqC,GACrC,8BAA8B,CAAC;AAEnC;;;;;;;;GAQG;AACH,MAAM,MAAM,qCAAqC,GAC7C,0BAA0B,GAC1B,4BAA4B,GAC5B,+BAA+B,GAC/B,6BAA6B,GAC7B,mCAAmC,GACnC,6BAA6B,CAAC;AAElC;;;;;;;;GAQG;AACH,MAAM,MAAM,8BAA8B,GACtC,2BAA2B,GAC3B,0BAA0B,GAC1B,gCAAgC,GAChC,mCAAmC,GACnC,mCAAmC,GACnC,2BAA2B,GAC3B,6BAA6B,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC7C,sBAAsB,GACtB,6BAA6B,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,uCAAuC,GAAG,OAAO,CAC3D,8BAA8B,GAAG,qCAAqC,CACvE,GAAG;IAAE,IAAI,EAAE,qCAAqC,CAAA;CAAE,CAAC"}

package/dist/types/webSocket/request/subscriptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });