@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/webSocket/response/candles.d.ts

@@ -0,0 +1,138 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { CandleInterval } from '#types/enums/request';
+import type { KatanaPerpsCandle } from '#types/rest/endpoints/GetCandles';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * - `candles` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Candles
+ *
+ * @see {@link KatanaPerpsSubscriptionEventBase}
+ */
+export interface KatanaPerpsCandleEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.candles;
+    /**
+     * @inheritDoc KatanaPerpsCandleEventData
+     *
+     * @see type {@link KatanaPerpsCandleEventData}
+     */
+    data: KatanaPerpsCandleEventData;
+}
+/**
+ * - Extended {@link KatanaPerpsCandle} which includes additional properties for WebSocket messages:
+ *   - {@link KatanaPerpsCandleEventData.market market},
+ *     {@link KatanaPerpsCandleEventData.time time},
+ *     {@link KatanaPerpsCandleEventData.interval interval},
+ *     {@link KatanaPerpsCandleEventData.end end},
+ *     {@link KatanaPerpsCandleEventData.trades trades}
+ *
+ * @see parent {@link KatanaPerpsCandleEvent}
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Candles
+ */
+export interface KatanaPerpsCandleEventData extends KatanaPerpsCandle {
+    /**
+     * Market symbol
+     */
+    market: string;
+    /**
+     * Timestamp when the statistics were computed, `time` is always
+     * between the {@link start} and {@link close} timestamps
+     * of the interval
+     */
+    time: number;
+    /**
+     * Interval duration of the candle.
+     *
+     * @see enum {@link CandleInterval}
+     */
+    interval: CandleInterval;
+    /**
+     * Timestamp of the end of the {@link interval}
+     */
+    end: number;
+    /**
+     * Number of trades in the {@link interval}
+     */
+    trades: number;
+}
+export interface WebSocketResponseSubscriptionMessageShortCandles extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.candles;
+    data: WebSocketResponseCandleShort;
+}
+/**
+ * @internal
+ *
+ * WebSocket Response Candle - Short (Deflated)
+ *
+ * An extended version used by WebSocket of {@link KatanaPerpsCandle}
+ */
+export interface WebSocketResponseCandleShort {
+    /**
+     * @see inflated {@link KatanaPerpsCandleEventData.market}
+     */
+    m: KatanaPerpsCandleEventData['market'];
+    /**
+     * @see inflated {@link KatanaPerpsCandleEventData.time}
+     */
+    t: KatanaPerpsCandleEventData['time'];
+    /**
+     * @see inflated {@link KatanaPerpsCandleEventData.interval}
+     */
+    i: KatanaPerpsCandleEventData['interval'];
+    /**
+     * @see inflated {@link KatanaPerpsCandleEventData.start}
+     */
+    s: KatanaPerpsCandleEventData['start'];
+    /**
+     * @see inflated {@link KatanaPerpsCandleEventData.end}
+     */
+    e: KatanaPerpsCandleEventData['end'];
+    /**
+     * @see related {@link KatanaPerpsCandle.open}
+     * @see inflated {@link KatanaPerpsCandleEventData.open}
+     */
+    o: KatanaPerpsCandleEventData['open'];
+    /**
+     * @see related {@link KatanaPerpsCandle.high}
+     * @see inflated {@link KatanaPerpsCandleEventData.high}
+     */
+    h: KatanaPerpsCandleEventData['high'];
+    /**
+     * @see related {@link KatanaPerpsCandle.low}
+     * @see inflated {@link KatanaPerpsCandleEventData.low}
+     */
+    l: KatanaPerpsCandleEventData['low'];
+    /**
+     * @see related {@link KatanaPerpsCandle.close}
+     * @see inflated {@link KatanaPerpsCandleEventData.close}
+     */
+    c: KatanaPerpsCandleEventData['close'];
+    /**
+     * @see {@link KatanaPerpsCandle.baseVolume}
+     * @see inflated {@link KatanaPerpsCandleEventData.baseVolume}
+     */
+    v: KatanaPerpsCandleEventData['baseVolume'];
+    /**
+     * @see related {@link KatanaPerpsCandle.quoteVolume}
+     * @see inflated {@link KatanaPerpsCandleEventData.quoteVolume}
+     */
+    q: KatanaPerpsCandleEventData['quoteVolume'];
+    /**
+     * @see related {@link KatanaPerpsCandle.trades}
+     * @see inflated {@link KatanaPerpsCandleEventData.trades}
+     */
+    n: KatanaPerpsCandleEventData['trades'];
+    /**
+     * @see related {@link KatanaPerpsCandle.sequence}
+     * @see inflated {@link KatanaPerpsCandleEventData.sequence}
+     */
+    u: KatanaPerpsCandleEventData['sequence'];
+}
+//# sourceMappingURL=candles.d.ts.map

package/dist/types/webSocket/response/candles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"candles.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/candles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;;;;GAQG;AACH,MAAM,WAAW,sBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,OAAO,CAAC;IACtC;;;;OAIG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,cAAc,CAAC;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,OAAO,CAAC;IACtC,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IACxC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACtC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACvC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACrC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACtC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACtC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACrC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACvC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;IAC5C;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAC7C;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IACxC;;;OAGG;IACH,CAAC,EAAE,0BAA0B,CAAC,UAAU,CAAC,CAAC;CAC3C"}

package/dist/types/webSocket/response/candles.js

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

package/dist/types/webSocket/response/deposits.d.ts

@@ -0,0 +1,80 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsDeposit } from '#types/rest/endpoints/GetDeposits';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * - `deposits` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Deposits
+ *
+ * @see data {@link KatanaPerpsDepositEventData}
+ */
+export interface KatanaPerpsDepositEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.deposits;
+    /**
+     * @inheritDoc KatanaPerpsDepositEventData
+     *
+     * @see type {@link KatanaPerpsDepositEventData}
+     */
+    data: KatanaPerpsDepositEventData;
+}
+/**
+ * `deposits` events provide a specialized `data` property which is similar to {@link KatanaPerpsDeposit} with the following changes:
+ *
+ * - `depositId`, `quantity`, `asset`, and `time` are provided from the {@link KatanaPerpsDeposit} interface.
+ * - WebSocket `deposits` events include additional exclusive properties:
+ *   - {@link KatanaPerpsDepositEventData.wallet wallet}, {@link KatanaPerpsDepositEventData.quoteBalance quoteBalance}
+ *
+ * @see parent {@link KatanaPerpsDepositEvent}
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Deposits
+ */
+export interface KatanaPerpsDepositEventData extends Pick<KatanaPerpsDeposit, 'depositId' | 'quantity' | 'asset' | 'time'> {
+    /**
+     * Wallet address associated with the deposit message.
+     */
+    wallet: string;
+    /**
+     * Quote token balance after the deposit
+     */
+    quoteBalance: string;
+}
+export interface WebSocketResponseSubscriptionMessageShortDeposits extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.deposits;
+    data: WebSocketResponseDepositsShort;
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseDepositsShort {
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.wallet}
+     */
+    w: KatanaPerpsDepositEventData['wallet'];
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.depositId}
+     */
+    i: KatanaPerpsDepositEventData['depositId'];
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.asset}
+     */
+    a: KatanaPerpsDepositEventData['asset'];
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.quantity}
+     */
+    q: KatanaPerpsDepositEventData['quantity'];
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.quoteBalance}
+     */
+    qb: KatanaPerpsDepositEventData['quoteBalance'];
+    /**
+     * @see inflated {@link KatanaPerpsDepositEventData.time}
+     */
+    t: KatanaPerpsDepositEventData['time'];
+}
+//# sourceMappingURL=deposits.d.ts.map

package/dist/types/webSocket/response/deposits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deposits.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/deposits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;;;;GAQG;AACH,MAAM,WAAW,uBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACvC;;;;OAIG;IACH,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,2BACf,SAAQ,IAAI,CACV,kBAAkB,EAClB,WAAW,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,CAC5C;IACD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACvC,IAAI,EAAE,8BAA8B,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,CAAC,EAAE,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IACzC;;OAEG;IACH,CAAC,EAAE,2BAA2B,CAAC,WAAW,CAAC,CAAC;IAC5C;;OAEG;IACH,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAC;IACxC;;OAEG;IACH,CAAC,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAC;IAC3C;;OAEG;IACH,EAAE,EAAE,2BAA2B,CAAC,cAAc,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,2BAA2B,CAAC,MAAM,CAAC,CAAC;CACxC"}

package/dist/types/webSocket/response/deposits.js

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

package/dist/types/webSocket/response/fundingPayments.d.ts

@@ -0,0 +1,78 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsFundingPayment } from '#types/rest/endpoints/GetFundingPayments';
+import type { Expand } from '#types/utils';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * - `fundingPayments` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Funding Payments
+ *
+ * @see data {@link KatanaPerpsFundingPaymentEventData}
+ */
+export interface KatanaPerpsFundingPaymentEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.fundingPayments;
+    /**
+     * - Includes all {@link KatanaPerpsFundingPayment} properties as well as a `wallet` property.
+     *
+     * @see type {@link KatanaPerpsFundingPaymentEventData}
+     */
+    data: Expand<KatanaPerpsFundingPaymentEventData>;
+}
+/**
+ * WebSocket position messages are identical to the REST API response
+ * except they also include the `wallet` property.
+ *
+ * @see parent  {@link KatanaPerpsFundingPaymentEvent}
+ *
+ * @category WebSocket - Message Types
+ */
+export interface KatanaPerpsFundingPaymentEventData extends KatanaPerpsFundingPayment {
+    /**
+     * Wallet address
+     */
+    wallet: string;
+}
+export interface WebSocketResponseSubscriptionMessageShortFundingPayments extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.fundingPayments;
+    data: WebSocketResponseFundingPaymentsShort;
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseFundingPaymentsShort {
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.wallet}
+     */
+    w: KatanaPerpsFundingPaymentEventData['wallet'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.market}
+     */
+    m: KatanaPerpsFundingPaymentEventData['market'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.paymentQuantity}
+     */
+    Q: KatanaPerpsFundingPaymentEventData['paymentQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.positionQuantity}
+     */
+    q: KatanaPerpsFundingPaymentEventData['positionQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.fundingRate}
+     */
+    f: KatanaPerpsFundingPaymentEventData['fundingRate'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.indexPrice}
+     */
+    ip: KatanaPerpsFundingPaymentEventData['indexPrice'];
+    /**
+     * @see inflated {@link KatanaPerpsFundingPaymentEventData.time}
+     */
+    t: KatanaPerpsFundingPaymentEventData['time'];
+}
+//# sourceMappingURL=fundingPayments.d.ts.map

package/dist/types/webSocket/response/fundingPayments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fundingPayments.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/fundingPayments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAC1F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;;;;;GASG;AACH,MAAM,WAAW,8BACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC9C;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC,kCAAkC,CAAC,CAAC;CAClD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kCACf,SAAQ,yBAAyB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC9C,IAAI,EAAE,qCAAqC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,QAAQ,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,QAAQ,CAAC,CAAC;IAChD;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,iBAAiB,CAAC,CAAC;IACzD;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,kBAAkB,CAAC,CAAC;IAC1D;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,aAAa,CAAC,CAAC;IACrD;;OAEG;IACH,EAAE,EAAE,kCAAkC,CAAC,YAAY,CAAC,CAAC;IACrD;;OAEG;IACH,CAAC,EAAE,kCAAkC,CAAC,MAAM,CAAC,CAAC;CAC/C"}

package/dist/types/webSocket/response/fundingPayments.js

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

package/dist/types/webSocket/response/index.d.ts

@@ -0,0 +1,13 @@
+export * from './candles.js';
+export * from './deposits.js';
+export * from './fundingPayments.js';
+export * from './liquidations.js';
+export * from './orderbook.js';
+export * from './ordersFill.js';
+export * from './orders.js';
+export * from './positions.js';
+export * from './tickers.js';
+export * from './trades.js';
+export * from './withdrawals.js';
+export * from './webclient/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/webSocket/response/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}

package/dist/types/webSocket/response/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./candles.js"), exports);
+tslib_1.__exportStar(require("./deposits.js"), exports);
+tslib_1.__exportStar(require("./fundingPayments.js"), exports);
+tslib_1.__exportStar(require("./liquidations.js"), exports);
+tslib_1.__exportStar(require("./orderbook.js"), exports);
+tslib_1.__exportStar(require("./ordersFill.js"), exports);
+tslib_1.__exportStar(require("./orders.js"), exports);
+tslib_1.__exportStar(require("./positions.js"), exports);
+tslib_1.__exportStar(require("./tickers.js"), exports);
+tslib_1.__exportStar(require("./trades.js"), exports);
+tslib_1.__exportStar(require("./withdrawals.js"), exports);
+tslib_1.__exportStar(require("./webclient/index.js"), exports);

package/dist/types/webSocket/response/liquidations.d.ts

@@ -0,0 +1,78 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsLiquidation } from '#types/rest/endpoints/GetLiquidations';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * - `liquidations` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Liquidations
+ *
+ * @see enum {@link MessageEventType}
+ * @see data {@link KatanaPerpsLiquidationEventData}
+ */
+export interface KatanaPerpsLiquidationEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.liquidations;
+    /**
+     * @inheritDoc KatanaPerpsLiquidationEventData
+     *
+     * @see type {@link KatanaPerpsLiquidationEventData}
+     */
+    data: KatanaPerpsLiquidationEventData;
+}
+/**
+ * - Liquidation updates on the WebSocket include all {@link KatanaPerpsLiquidation} properties as well
+ *   as the `market` symbol that corresponds to the liquidation.
+ *
+ * @see parent {@link KatanaPerpsLiquidationEvent}
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Liquidations
+ */
+export interface KatanaPerpsLiquidationEventData extends KatanaPerpsLiquidation {
+    /**
+     * Market symbol
+     */
+    market: string;
+}
+export interface WebSocketResponseSubscriptionMessageShortLiquidations extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.liquidations;
+    data: WebSocketResponseLiquidationsShort;
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseLiquidationsShort {
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.market}
+     */
+    m: KatanaPerpsLiquidationEventData['market'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.fillId}
+     */
+    i: KatanaPerpsLiquidationEventData['fillId'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.price}
+     */
+    p: KatanaPerpsLiquidationEventData['price'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.quantity}
+     */
+    q: KatanaPerpsLiquidationEventData['quantity'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.quoteQuantity}
+     */
+    Q: KatanaPerpsLiquidationEventData['quoteQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.time}
+     */
+    t: KatanaPerpsLiquidationEventData['time'];
+    /**
+     * @see inflated {@link KatanaPerpsLiquidationEventData.liquidationSide}
+     */
+    s: KatanaPerpsLiquidationEventData['liquidationSide'];
+}
+//# sourceMappingURL=liquidations.d.ts.map

package/dist/types/webSocket/response/liquidations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidations.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/liquidations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;;;;;GASG;AACH,MAAM,WAAW,2BACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,YAAY,CAAC;IAC3C;;;;OAIG;IACH,IAAI,EAAE,+BAA+B,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,+BACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,YAAY,CAAC;IAC3C,IAAI,EAAE,kCAAkC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,QAAQ,CAAC,CAAC;IAC7C;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,QAAQ,CAAC,CAAC;IAC7C;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAC5C;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,UAAU,CAAC,CAAC;IAC/C;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,eAAe,CAAC,CAAC;IACpD;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAC3C;;OAEG;IACH,CAAC,EAAE,+BAA+B,CAAC,iBAAiB,CAAC,CAAC;CACvD"}

package/dist/types/webSocket/response/liquidations.js

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

package/dist/types/webSocket/response/orderbook.d.ts

@@ -0,0 +1,214 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsOrderBook, OrderBookPriceLevel, RestResponseGetOrderBookLevel2 } from '#types/rest/endpoints/GetOrderBook';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * - `l1orderbook` updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get OrderBook
+ *
+ * @see enum {@link MessageEventType}
+ * @see data {@link KatanaPerpsOrderBookLevel1EventData}
+ */
+export interface KatanaPerpsOrderBookLevel1Event extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.l1orderbook;
+    /**
+     * @inheritDoc KatanaPerpsOrderBookLevel1EventData
+     *
+     * @see type {@link KatanaPerpsOrderBookLevel1EventData}
+     */
+    data: KatanaPerpsOrderBookLevel1EventData;
+}
+/**
+ * Level-1 event messages include properties that help indicate what changes
+ * were made that triggered the message event.
+ *
+ * @see parent {@link KatanaPerpsOrderBookLevel1Event}
+ *
+ * @category KatanaPerps - Get OrderBook
+ * @category WebSocket - Message Types
+ */
+export interface KatanaPerpsOrderBookLevel1EventData extends Pick<KatanaPerpsOrderBook, 'markPrice' | 'indexPrice' | 'lastPrice'> {
+    /**
+     * Market symbol
+     */
+    market: string;
+    /**
+     * Timestamp of the order book update
+     */
+    time: number;
+    /**
+     * Best bid price
+     *
+     * @see tuple {@link OrderBookPriceLevel}.price
+     */
+    bidPrice: OrderBookPriceLevel[0];
+    /**
+     * Quantity available at the best bid price
+     *
+     * @see tuple {@link OrderBookPriceLevel}.size
+     */
+    bidQuantity: OrderBookPriceLevel[1];
+    /**
+     * Best ask price
+     *
+     * @see tuple {@link OrderBookPriceLevel}.price
+     */
+    askPrice: OrderBookPriceLevel[0];
+    /**
+     * Quantity available at the best ask price
+     *
+     * @see tuple {@link OrderBookPriceLevel}.size
+     */
+    askQuantity: OrderBookPriceLevel[1];
+}
+/**
+ * - Level-2 updates provided to the message handler when subscribed.
+ *
+ * @inheritDoc KatanaPerpsSubscriptionEventBase
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get OrderBook
+ *
+ * @see data {@link KatanaPerpsOrderBookLevel2EventData}
+ */
+export interface KatanaPerpsOrderBookLevel2Event extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: 'l2orderbook';
+    /**
+     * @inheritDoc KatanaPerpsOrderBookLevel2EventData
+     *
+     * @see type {@link KatanaPerpsOrderBookLevel2EventData}
+     */
+    data: KatanaPerpsOrderBookLevel2EventData;
+}
+/**
+ * - Level-2 OrderBook updates are identical to {@link RestResponseGetOrderBookLevel2}
+ *   but also include a {@link KatanaPerpsOrderBookLevel2EventData.market market} and
+ *   {@link KatanaPerpsOrderBookLevel2EventData.time time} property.
+ *
+ * @see parent {@link KatanaPerpsOrderBookLevel2Event}
+ *
+ * @category KatanaPerps - Get OrderBook
+ * @category WebSocket - Message Types
+ */
+export interface KatanaPerpsOrderBookLevel2EventData extends RestResponseGetOrderBookLevel2 {
+    /**
+     * Market symbol
+     */
+    market: string;
+    /**
+     * Timestamp of the order book update
+     */
+    time: number;
+}
+export interface WebSocketResponseSubscriptionMessageShortL1Orderbook extends KatanaPerpsSubscriptionEventBase {
+    type: 'l1orderbook';
+    data: WebSocketResponseL1OrderBookShort;
+}
+export interface WebSocketResponseSubscriptionMessageShortL2Orderbook extends KatanaPerpsSubscriptionEventBase {
+    type: 'l2orderbook';
+    data: WebSocketResponseL2OrderBookShort;
+}
+/**
+ * @internal
+ *
+ * WebSocket Response Order Book (Level 1) - Short (Deflated)
+ *
+ * An extended version used by WebSocket of {@link RestResponseOrderBookLevel1}
+ */
+export interface WebSocketResponseL1OrderBookShort {
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.market}
+     */
+    m: KatanaPerpsOrderBookLevel1EventData['market'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.time}
+     */
+    t: KatanaPerpsOrderBookLevel1EventData['time'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.bidPrice}
+     */
+    b: KatanaPerpsOrderBookLevel1EventData['bidPrice'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.bidQuantity}
+     */
+    B: KatanaPerpsOrderBookLevel1EventData['bidQuantity'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.askPrice}
+     */
+    a: KatanaPerpsOrderBookLevel1EventData['askPrice'];
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.askQuantity}
+     */
+    A: KatanaPerpsOrderBookLevel1EventData['askQuantity'];
+    /**
+     * @see related {@link RestResponseOrderBook.lastPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.lastPrice}
+     */
+    lp: KatanaPerpsOrderBookLevel1EventData['lastPrice'];
+    /**
+     * @see related {@link RestResponseOrderBook.markPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.markPrice}
+     */
+    mp: KatanaPerpsOrderBookLevel1EventData['markPrice'];
+    /**
+     * @see related {@link RestResponseOrderBook.indexPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel1EventData.indexPrice}
+     */
+    ip: KatanaPerpsOrderBookLevel1EventData['indexPrice'];
+}
+/**
+ * @internal
+ *
+ * WebSocket Response Order Book (Level 2) - Short (Deflated)
+ *
+ * An extended version used by WebSocket of {@link RestResponseGetOrderBookLevel2}
+ */
+export interface WebSocketResponseL2OrderBookShort {
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.market}
+     */
+    m: string;
+    /**
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.time}
+     */
+    t: number;
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.sequence}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.sequence}
+     */
+    u: KatanaPerpsOrderBookLevel2EventData['sequence'];
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.bids}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.bids}
+     */
+    b: KatanaPerpsOrderBookLevel2EventData['bids'];
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.asks}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.asks}
+     */
+    a: KatanaPerpsOrderBookLevel2EventData['asks'];
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.lastPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.lastPrice}
+     */
+    lp: KatanaPerpsOrderBookLevel2EventData['lastPrice'];
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.markPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.markPrice}
+     */
+    mp: KatanaPerpsOrderBookLevel2EventData['markPrice'];
+    /**
+     * @see related {@link RestResponseGetOrderBookLevel2.indexPrice}
+     * @see inflated {@link KatanaPerpsOrderBookLevel2EventData.indexPrice}
+     */
+    ip: KatanaPerpsOrderBookLevel2EventData['indexPrice'];
+}
+//# sourceMappingURL=orderbook.d.ts.map

package/dist/types/webSocket/response/orderbook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orderbook.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/orderbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,8BAA8B,EAC/B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;;;;;;GAUG;AACH,MAAM,WAAW,+BACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC1C;;;;OAIG;IACH,IAAI,EAAE,mCAAmC,CAAC;CAC3C;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,mCACf,SAAQ,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;IAC5E;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IACjC;;;;OAIG;IACH,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IACpC;;;;OAIG;IACH,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IACjC;;;;OAIG;IACH,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,+BACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;;;OAIG;IACH,IAAI,EAAE,mCAAmC,CAAC;CAC3C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,mCACf,SAAQ,8BAA8B;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,iCAAiC,CAAC;CACzC;AAED,MAAM,WAAW,oDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,iCAAiC,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IACjD;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,MAAM,CAAC,CAAC;IAC/C;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,UAAU,CAAC,CAAC;IACnD;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,aAAa,CAAC,CAAC;IACtD;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,UAAU,CAAC,CAAC;IACnD;;OAEG;IACH,CAAC,EAAE,mCAAmC,CAAC,aAAa,CAAC,CAAC;IACtD;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,WAAW,CAAC,CAAC;IACrD;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,WAAW,CAAC,CAAC;IACrD;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,YAAY,CAAC,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;OAGG;IACH,CAAC,EAAE,mCAAmC,CAAC,UAAU,CAAC,CAAC;IACnD;;;OAGG;IACH,CAAC,EAAE,mCAAmC,CAAC,MAAM,CAAC,CAAC;IAC/C;;;OAGG;IACH,CAAC,EAAE,mCAAmC,CAAC,MAAM,CAAC,CAAC;IAC/C;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,WAAW,CAAC,CAAC;IACrD;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,WAAW,CAAC,CAAC;IACrD;;;OAGG;IACH,EAAE,EAAE,mCAAmC,CAAC,YAAY,CAAC,CAAC;CACvD"}

package/dist/types/webSocket/response/orderbook.js

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